Open check

POST

/v1/actions/hospitality.action.open_check/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.open_check/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "covers": 1, "daypart": "breakfast", "external_ref": "example", "opened_at": "2026-04-15T12:00:00Z", "order_kind": "dine_in", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "promised_at": "2026-04-15T12:00:00Z", "server_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stay_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

• Production API

Open a guest check against an outlet — and, for dine-in, seat a table: the table must be available or reserved and flips to seated. Takeaway / room-service / delivery checks carry no table. Business time: opened_at is when service actually opened the check (defaults to now for live POS use); replayed histories pass it explicitly so the check lands on the business day it happened. The check records its business_date — the property’s hotel date at opened_at — and the meal period it rings in (daypart), which every line’s price and VAT resolve on and a package’s meal allowance matches. Absent on a live check, daypart is the outlet’s period in force on the house’s wall clock (set_outlet_meal_periods; none in a gap or with no hours set); a replay naming opened_at keeps what it says. Its totals start at zero in the property’s default currency. A present external_ref routes the create through the guest_check_external_ref business key, making a crashed-pass retry a replay instead of a duplicate check. In-room dining: a room_service check names the in-house stay_id at the outlet’s house it goes up to (required) and is linked to it (check_for_stay), snapshotting the stay’s room, and starts its dispatch sheet — delivery_status taken, promised_at as quoted, else twenty minutes after opening for a breakfast and thirty for any other meal. Any other kind may name an in-house stay too (the roster’s guest seated in the restaurant): it is linked and its room snapshotted, with no dispatch sheet; only room service quotes a promised_at. Emits fnb.check_opened.

Effects: create hospitality.guest_check; link hospitality.link.check_for_stay; link hospitality.link.check_at_outlet; link hospitality.link.check_opened_at_table; modify hospitality.service_table.

Authorizations

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

covers

Covers seated

integer

daypart

Meal period the check rings in (the daypart a price row may be narrowed to)

string

Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day

external_ref

Source-system key for replayed / connector-landed checks (replay key)

string

opened_at

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

string format: date-time

order_kind

required

How the order reaches the guest

string

Allowed values: dine_in takeaway room_service delivery

outlet_id

required

Outlet the check trades under

string format: uuid

promised_at

When the in-room order is promised at the room (room_service only)

string format: date-time

server_id

Owning server

string format: uuid

stay_id

In-house stay the check is for (required on room_service, optional otherwise)

string format: uuid

table_id

Table to seat (dine-in only)

string format: uuid

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

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.check_for_stay hospitality.link.check_at_outlet hospitality.link.check_opened_at_table

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: created modified

object_type

required

Allowed values: hospitality.guest_check hospitality.service_table

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.