F&B receipt

POST

/v1/functions/hospitality.function.fnb_receipt/invoke

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

• Production API

A settled check’s receipt as it was issued — the document’s own snapshot, never re-read from the check: its number (R-{outlet}-{000001}) and series, the check it was issued for and that check’s number, outlet, order kind, table, covers and server, the business date, the time of supply (settled_at) and issued_at; the totals (subtotal, tax_total, total_due, paid_total, tip_total, change_total, strings in currency); vat per rate (code, rate, net, tax, gross — VAT Notice 700 §16.6.1); the printed lines (description, quantity, unit price, line total, modifier, comped); the payments (tender, amount, tip, cash tendered and change; a room charge’s room and the name of the guest who signed — never card data); the supplier (supplier_name, and issuer: legal name, address lines, VAT number and scheme); and content_hash / previous_hash, its place on the property’s document chain. What the till previews and the printer renders. The target is the receipt, 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_receipt: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.check_receipt

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

business_date

required

string format: date

change_total

required

string

check_id

string format: uuid

check_number

required

string

content_hash

required

string

covers

integer

currency

required

string

id

required

string format: uuid

issued_at

required

string format: date-time

issuer

object

address_lines

required

Array<string>

legal_name

required

string

tax_registration_number

string

tax_registration_scheme

required

string

lines

required

Array<object>

object

comped

required

boolean

description

required

string

line_total

required

string

modifier

required

boolean

quantity

required

integer

unit_price

required

string

number

required

string

order_kind

required

string

Allowed values: dine_in takeaway room_service delivery

outlet_name

required

string

paid_total

required

string

payments

required

Array<object>

object

amount

required

string

change_given

string

guest_name

string

room_number

string

tender

required

string

Allowed values: room_charge cash card comp external charge_to_key

tendered

string

tip

required

string

previous_hash

string

sequence_value

required

integer

series

required

string

server_name

string

settled_at

required

string format: date-time

simplified

required

boolean

subtotal

required

string

supplier_name

required

string

table_label

string

tax_total

required

string

time_of_supply

required

string

tip_total

required

string

total_due

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": {
    "order_kind": "dine_in",
    "payments": [
      {
        "tender": "room_charge"
      }
    ]
  }
}

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.