F&B check detail

POST

/v1/functions/hospitality.function.fnb_check_detail/invoke

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

• Production API

One check as the till and the receipt read it. check: its header — number, status, order kind, daypart, business date, covers, table, outlet, server, when it opened and settled — and every total (subtotal, tax_total, total_due, paid_total, tip_total, balance_due, strings in currency). lines: every line in the order it rang, voided and comped ones included with their reasons, each with its item and variant names, quantity, course, seat, unit price, line total, VAT, revenue category, tax class and kitchen instructions, and its modifier lines nested beneath it as modifiers (each with the prefix its option was chosen with; a modifier line’s quantity already includes its parent’s). tickets: the check’s kitchen tickets, oldest fired first — id, ticket number, status, course, station (none = the unrouted expo ticket), fired and bumped — so a till with no kitchen screen bumps what it fired and the check can close. payments: each tender with its amount, tip, cash tendered and change, the card terminal’s references, the folio a room charge posted to with its reservation and the guest who signed, when it was taken and by whom, and a manager’s override of the stay’s posting rules (override_kind no_post / no_credit, authorised_by — the manager signed in — and override_reason; null when none). vat: per rate over the live lines, the receipt’s figures (VAT Notice 700 §16.6.1) — code, rate, net, tax and gross. receipt: once the check has settled, the receipt it was issued (id, number, content_hash, issued_at — read it whole with fnb_receipt), else null. The target is the check, so a house-bound bearer reads its own house’s — and a till its own outlet’s — only. Read-only.

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.fnb_check_detail: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.guest_check

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

check

required

object

balance_due

string

business_date

string format: date

cleared_at

string format: date-time

conveyance

string

Allowed values: tray trolley

covers

integer

currency

string

daypart

string

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

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

outlet_id

string format: uuid

paid_total

string

promised_at

string format: date-time

room

string

runner_id

string format: uuid

server_id

string format: uuid

settled_at

string format: date-time

status

required

string

Allowed values: open settled

subtotal

string

table_label

string

tax_total

string

tip_total

string

total_due

string

lines

required

Array<object>

object

comp_reason

string

course_number

required

integer

id

required

string format: uuid

instructions

required

Array<string>

line_number

required

string

line_total

required

string

menu_item_id

string format: uuid

modifiers

required

Array<object>

object

comp_reason

string

course_number

required

integer

id

required

string format: uuid

instructions

required

Array<string>

line_number

required

string

line_total

required

string

menu_item_id

string format: uuid

name

string

notes

string

prefix

string

Allowed values: no extra light side

quantity

required

integer

revenue_category

required

string

Allowed values: food non_alcoholic_beverage alcoholic_beverage other

seat_number

integer

status

required

string

Allowed values: entered fired fulfilled voided comped

tax_amount

required

string

tax_class

required

string

unit_price

required

string

variant_id

string format: uuid

variant_name

string

void_reason

string

name

string

notes

string

quantity

required

integer

revenue_category

required

string

Allowed values: food non_alcoholic_beverage alcoholic_beverage other

seat_number

integer

status

required

string

Allowed values: entered fired fulfilled voided comped

tax_amount

required

string

tax_class

required

string

unit_price

required

string

variant_id

string format: uuid

variant_name

string

void_reason

string

payments

required

Array<object>

object

allowance_applied

string

amount

required

string

authorised_by

string format: uuid

change_given

string

consumption_id

string format: uuid

folio_id

string format: uuid

guest_id

string format: uuid

id

required

string format: uuid

override_kind

string

Allowed values: no_post no_credit

override_reason

string

paid_at

required

string format: date-time

poiid

string

psp_reference

string

reservation_id

string format: uuid

staff_member_id

string format: uuid

tender

required

string

Allowed values: room_charge cash card comp external charge_to_key

tendered

string

terminal_transaction_id

string

tip

required

string

receipt

object

content_hash

required

string

id

required

string format: uuid

issued_at

required

string format: date-time

number

required

string

stay

object

folio_id

string format: uuid

guest_id

string format: uuid

guest_names

required

Array<string>

reservation_id

string format: uuid

room

string

stay_id

required

string format: uuid

tickets

required

Array<object>

object

bumped_at

string format: date-time

course_number

required

integer

fired_at

required

string format: date-time

id

required

string format: uuid

station_id

string format: uuid

station_name

string

status

required

string

Allowed values: fired bumped recalled

ticket_number

required

string

vat

required

Array<object>

object

code

required

string

gross

required

string

net

required

string

rate

required

string format: decimal

tax

required

string

Example

{
  "return_value": {
    "check": {
      "conveyance": "tray",
      "daypart": "breakfast",
      "delivery_status": "taken",
      "order_kind": "dine_in",
      "status": "open"
    },
    "lines": [
      {
        "modifiers": [
          {
            "prefix": "no",
            "revenue_category": "food",
            "status": "entered"
          }
        ],
        "revenue_category": "food",
        "status": "entered"
      }
    ],
    "payments": [
      {
        "override_kind": "no_post",
        "tender": "room_charge"
      }
    ],
    "tickets": [
      {
        "status": "fired"
      }
    ]
  }
}

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.