F&B breakfast roster

POST

/v1/functions/hospitality.function.fnb_breakfast_roster/invoke

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

• Production API

The breakfast roster at the target outlet on business_date (default: the house’s hotel date): one row per in-house stay whose live package includes a breakfast that day at this outlet — a component with a frozen daypart of breakfast or brunch, eaten the morning after the night that carries it, at one of its alternate outlets (any outlet of the house when it names none) — and per stay that checked out that morning having taken it. Guests without one are not rows; they pay on a check. Per row: the stay, its reservation, the room, the guests’ names, the covers the package feeds (entitled_covers: the room’s adults for a per-adult allowance, everyone in it otherwise), the component, the day’s allowance and what is remaining of it (strings in currency), the covers already taken_covers — by the roster’s tick-off (record_breakfast_taken) or a room charge that consumed it — the latest consumption and the check it came from (null for a tick-off), every consumption that day (consumptions), and the status: expected, partial, taken, or no_show (nothing eaten and the day is over, or the night audit settled it). Ordered by room. The target is the outlet, so a till reads its own outlet’s roster only. Guest names are personal data: a reader not cleared for them gets the rows without them. Read-only.

Authorizations

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

Request Body^required

Media typeapplication/json

object

params

required

object

business_date

Business date of the breakfast (defaults to the house's hotel date)

string format: date

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

business_date

required

string format: date

outlet_id

required

string format: uuid

rows

required

Array<object>

object

allowance

string

check_id

string format: uuid

component_id

string format: uuid

consumption_id

string format: uuid

consumptions

required

Array<object>

object

amount

string

check_id

string format: uuid

consumption_id

required

string format: uuid

covers

integer

recorded_at

string format: date-time

currency

string

entitled_covers

required

integer

guest_names

required

Array<string>

remaining

string

reservation_id

string format: uuid

room

string

status

required

string

Allowed values: expected taken partial no_show

stay_id

required

string format: uuid

taken_covers

required

integer

Example

{
  "return_value": {
    "rows": [
      {
        "status": "expected"
      }
    ]
  }
}

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.