F&B open checks

POST

/v1/functions/hospitality.function.fnb_open_checks/invoke

curl --request POST \
  --url https://api.aerandil.com/v1/functions/hospitality.function.fnb_open_checks/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "params": {}, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.outlet" } }'

• Production API

An outlet’s open checks, oldest first — the till’s check list: each check’s id and number, order kind, the label of the table it is seated at (null off the floor), covers, when it opened, its total_due and balance_due with their currency, and its owner (server_id, and opened_by, the principal that opened it), its business_date (the hotel date it opened on) and carried — true once the night audit has closed that day and the check rode over the roll (the house’s fnb_open_checks_at_roll = carry). Narrowed to open checks in the store, so the read never ships the outlet’s settled history. The target is the outlet. Read-only.

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.fnb_open_checks:invoke

Request Body^required

Media typeapplication/json

object

params

required

object

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.outlet

Responses

200

Function invoked. The body carries the typed return_value shaped by the function’s declared return_type.

Media typeapplication/json

InvokeFunctionResponse

Envelope returned by the Aerandil function engine. correlation_id is the per-invocation id for trace stitching; return_value is the typed value the function computed (shape declared by the function’s return_type).

object

correlation_id

required

Per-invocation correlation id; appears on log/trace records this function emitted.

string format: uuid

return_value

required

object

checks

required

Array<object>

object

balance_due

string

business_date

string format: date

carried

required

boolean

cleared_at

string format: date-time

covers

integer

currency

string

delivered_at

string format: date-time

delivery_status

string

Allowed values: taken dispatched delivered cleared

dispatched_at

string format: date-time

id

required

string format: uuid

number

required

string

opened_at

required

string format: date-time

order_kind

required

string

Allowed values: dine_in takeaway room_service delivery

owner

required

object

opened_by

required

string

server_id

string format: uuid

promised_at

string format: date-time

room

string

table_label

string

total_due

string

outlet_id

required

string format: uuid

Example

{
  "return_value": {
    "checks": [
      {
        "delivery_status": "taken",
        "order_kind": "dine_in"
      }
    ]
  }
}

Headers

Cache-Control

string

Always no-store — function results are time-sensitive and never cacheable.

404

Function or target object not found.

422

Parameter validation or domain-rule violation.