Skip to content

Record breakfast taken

POST
/v1/actions/hospitality.action.record_breakfast_taken/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_breakfast_taken/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "business_date": "2026-04-15", "covers": 1, "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.stay" } }'

The breakfast roster’s tick-off: covers of the target in-house stay took the breakfast their package includes, with no bill. The stay’s breakfast is the first component (by the package’s order) of a live package sale whose frozen daypart is breakfast or brunch, eaten at outlet_id — one of its alternate outlets, or any outlet of the house when it names none — and due on business_date (default: the house’s hotel date): a breakfast is eaten the morning after the night that carries it, so the first morning of a stay has none and the departure morning does. covers is how many of the room have taken it so far that day, at most the covers the package feeds (the room’s adults for a per-adult allowance, everyone in it otherwise): the same number again is a no-op, a lower one is refused, a higher one records the new covers. Each records a package_component_consumption through the one package write consume_package_component uses — consumed equal to the allowance it draws (consumed), the covers’ share of the day’s allowance, the last cover taking what is left — with its balance-neutral package line on the stay’s guest folio at the outlet, and the package ledger’s movements. Refused when the stay has no breakfast that day at this outlet, or when the day’s allowance is already used up (a room charge may have consumed it). Emits fnb.breakfast_taken.

Effects: create hospitality.package_component_consumption; create hospitality.charge; modify hospitality.package_sale; link hospitality.link.package_sale_has_consumption; link hospitality.link.consumption_for_charge; link hospitality.link.folio_has_charge; link hospitality.link.charge_attributed_to_package_sale; link hospitality.link.charge_attributed_to_package_component; link hospitality.link.charge_at_outlet.

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
business_date
Business date of the breakfast (defaults to the house's hotel date)
string format: date
covers
required
How many of the room have taken breakfast so far today
integer
outlet_id
required
Outlet the breakfast was taken at
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
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.stay

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.package_sale_has_consumption hospitality.link.consumption_for_charge hospitality.link.folio_has_charge hospitality.link.charge_attributed_to_package_sale hospitality.link.charge_attributed_to_package_component hospitality.link.charge_at_outlet
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.package_component_consumption hospitality.charge hospitality.package_sale
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.package_sale_has_consumption"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.package_component_consumption"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.