Settle check

POST

/v1/actions/hospitality.action.settle_check/apply

const url = 'https://api.aerandil.com/v1/actions/hospitality.action.settle_check/apply';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"authorised_by":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","credential_token":"example","folio_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","gratuity":{"amount":"example","currency":"example"},"guest_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","override_reason":"example","reservation_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","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.guest_check"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.settle_check/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "authorised_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "credential_token": "example", "folio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "gratuity": { "amount": "example", "currency": "example" }, "guest_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "override_reason": "example", "reservation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "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.guest_check" } }'

Close an open check by paying its whole balance with one tender — the convenience over add_check_payment, which it records one payment through: amount = the check’s balance_due, gratuity the payment’s tip, settlement_reference its psp_reference, settled_at its paid_at, and folio_id, reservation_id, guest_id and credential_token bound exactly as add_check_payment binds them — a room charge names its reservation here too, and a charge-to-key its tapped key — and a room charge consumes the stay’s package allowance exactly as add_check_payment’s does. Every line must be fulfilled, voided, or comped. A check with nothing due (everything voided / comped, or already paid by earlier payments) settles with no tender and no payment. The gratuity rides any tender here — it is the check’s discretionary service charge collected with the tender, which a replayed history carries on cash too. A seated table flips to dirty. A room charge or charge-to-key is held to the stay’s posting rules, with a signed-in manager’s override (override_reason), exactly as add_check_payment holds it. Re-settling an already-settled check is a no-op.

Effects: create hospitality.check_payment; link hospitality.link.check_payment_on_check; link hospitality.link.check_payment_to_folio; modify hospitality.guest_check; create hospitality.charge; create hospitality.tax_application; link hospitality.link.folio_has_charge; link hospitality.link.charge_at_outlet; link hospitality.link.charge_has_tax_application; link hospitality.link.check_payment_posted_charge; link hospitality.link.check_settled_to_folio; link hospitality.link.charge_via_credential; modify hospitality.folio; modify hospitality.service_table; create hospitality.check_receipt; link hospitality.link.receipt_for_check; create hospitality.package_component_consumption; modify hospitality.package_sale; link hospitality.link.package_sale_has_consumption; link hospitality.link.consumption_for_charge; link hospitality.link.charge_attributed_to_package_sale; link hospitality.link.charge_attributed_to_package_component; link hospitality.link.consumption_for_check_payment.

Authorizations

aerandil_oauth
actions:apply
aerandil_oauth
actions:hospitality.action.settle_check:apply

Request Body^required

application/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

authorised_by

Confirms the overriding manager (optional; with override_reason): must be the staff member signed in — the override's authoriser is always the session's own, never one named here

string format: uuid

credential_token

The tapped room key's token (required for charge_to_key)

string

folio_id

Folio to receive the room charge (required for room_charge)

string format: uuid

gratuity

Gratuity — the payment's tip

object

amount

required

string format: decimal

currency

required

string format: iso-4217

guest_id

The guest who signed for a room charge — the reservation's guest

string format: uuid

override_reason

Override the stay's no-post or credit refusal, and why (room_charge and charge_to_key) — taken under a manager's own session: an F&B manager, a front-office supervisor, the manager on duty, the general manager or the owner, active at the check's house

string

reservation_id

The reservation the room-charge folio is a window of (required for room_charge)

string format: uuid

settled_at

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

string format: date-time

settlement_reference

The processor's reference for the tender (the payment's psp_reference)

string

tender

Settlement tender (required unless nothing is due)

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

required

string format: uuid

object_type

required

Allowed value: hospitality.guest_check

Responses

200

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

application/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.check_payment_on_check hospitality.link.check_payment_to_folio hospitality.link.folio_has_charge hospitality.link.charge_at_outlet hospitality.link.charge_has_tax_application hospitality.link.check_payment_posted_charge hospitality.link.check_settled_to_folio hospitality.link.charge_via_credential hospitality.link.receipt_for_check hospitality.link.package_sale_has_consumption hospitality.link.consumption_for_charge hospitality.link.charge_attributed_to_package_sale hospitality.link.charge_attributed_to_package_component hospitality.link.consumption_for_check_payment

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

required

string format: uuid

kind

required

Allowed values: created modified

object_type

required

Allowed values: hospitality.check_payment hospitality.guest_check hospitality.charge hospitality.tax_application hospitality.folio hospitality.service_table hospitality.check_receipt hospitality.package_component_consumption hospitality.package_sale

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.check_payment_on_check"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.check_payment"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.

Settle check

Authorizations

Request Bodyrequired

Responses

200

Example

409

422

Request Body^required