Settle appointment

POST

/v1/actions/hospitality.action.settle_appointment/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.settle_appointment/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "folio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "gratuity": { "amount": "example", "currency": "example" }, "settled_at": "2026-04-15T12:00:00Z", "settlement_reference": "example", "tender": "room_charge" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.appointment" } }'

• Production API

Resolve the money on a completed appointment — settle_check’s twin. The amount due is the snapshotted price plus gratuity. tender = room_charge requires folio_id and atomically posts one aggregated spa charge to the folio (bucket = the outlet’s usali_department, health_club_spa fallback; charge_at_outlet linked) plus the appointment_settled_to_folio link, emitting charge.posted.recorded — the §9.1 fold input. Other tenders stamp tender + settlement_reference; their revenue reaches the signals tier through the enriched spa.appointment_settled event (outlet, bucket, amount, business day) rather than a folio charge — a walk-in’s card payment clears through the POS/PSP, not a guest ledger, so no folio is minted for day-spa trade. The charge decomposes like post_charge’s: amount is the treatment revenue, gratuity its own figure (a voluntary tip is a pass-through, not department revenue under USALI), and the folio debit is their sum. Business time: settled_at defaults to now; the charge’s posted_at and the business day derive from it. A zero-due appointment (fully comped) settles with tender = comp. Re-settling a settled appointment is a no-op.

Effects: modify hospitality.appointment; create hospitality.charge; link hospitality.link.folio_has_charge; link hospitality.link.charge_at_outlet; link hospitality.link.appointment_settled_to_folio; modify hospitality.folio.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.settle_appointment:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

folio_id

Folio to receive the room charge (required for tender = room_charge)

string format: uuid

gratuity

Gratuity

object

amount

required

string format: decimal

currency

required

string format: iso-4217

settled_at

When the appointment settled — business time, not record time (defaults to now)

string format: date-time

settlement_reference

PSP / drawer / platform reference for non-room tenders

string

tender

Settlement tender (required unless the amount due is zero)

string

Allowed values: room_charge cash card comp external charge_to_key

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.appointment

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.folio_has_charge hospitality.link.charge_at_outlet hospitality.link.appointment_settled_to_folio

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: modified created

object_type

required

Allowed values: hospitality.appointment hospitality.charge hospitality.folio

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.folio_has_charge"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.appointment"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.