Check out

POST

/v1/actions/hospitality.action.check_out/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.check_out/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allow_open_balance": true, "departure_actual": "2026-04-15T12:00:00Z", "reservation_room_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.reservation" } }'

• Production API

Mark departing guests as checked out and close each departing stay’s open folio windows (closed_at is the actual departure — business time). The whole party departs by default; pass reservation_room_ids for a staggered departure’s subset — the reservation completes only when no leg remains in house, and never-arrived legs cancel at that moment with their unslept nights released back to inventory. Refuses a non-zero folio balance unless allow_open_balance is set: front-desk flows settle first, while a connector mirroring a vendor’s already-departed guest records the fact and lets the charges / payments streams settle the folio in their own passes. Replay-iff-identical per leg: re-applying with the departure_actual a leg’s stay already carries skips that leg. Every pending card hold the departure leaves is decided (payment.hold_decision, payment.hold_decided): released, taken for what a bill still owes, or — with the house’s post-stay window on (set_post_stay_charging) — the stay’s largest kept until the window’s end, the stay stamped post_stay_window = open. The card rail carries the decision out at the processor after commit.

Effects: modify hospitality.reservation; modify hospitality.availability_day; modify hospitality.reservation_room; modify hospitality.stay; modify hospitality.folio; modify hospitality.access_credential; modify hospitality.room; modify hospitality.room_discrepancy; modify hospitality.share_group; unlink hospitality.link.reservation_in_share_group; modify hospitality.payment; modify hospitality.payment_request.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.check_out: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

allow_open_balance

Close out even if the folio balance is non-zero (vendor-mirror loads)

boolean

departure_actual

required

Actual departure

string format: date-time

reservation_room_ids

Legs to check out (default: every leg — the whole party)

Array<string>

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.reservation

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: unlinked end_dated

link_type

required

Allowed values: hospitality.link.reservation_in_share_group

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

object_type

required

Allowed values: hospitality.reservation hospitality.availability_day hospitality.reservation_room hospitality.stay hospitality.folio hospitality.access_credential hospitality.room hospitality.room_discrepancy hospitality.share_group hospitality.payment hospitality.payment_request

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": "unlinked",
      "link_type": "hospitality.link.reservation_in_share_group"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.reservation"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.