Add check line
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.add_check_line/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"course_number":1,"external_ref":"example","fulfilled_at":"2026-04-15T12:00:00Z","menu_item_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","modifiers":[{"option_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","prefix":"no","quantity":1}],"notes":"example","quantity":1,"seat_number":1,"variant_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.guest_check"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aerandil.com/v1/actions/hospitality.action.add_check_line/apply \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "course_number": 1, "external_ref": "example", "fulfilled_at": "2026-04-15T12:00:00Z", "menu_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "modifiers": [ { "option_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "prefix": "no", "quantity": 1 } ], "notes": "example", "quantity": 1, "seat_number": 1, "variant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.guest_check" } }'Order one item onto an open check. The line rings a variant — the one named, else the item’s only or default variant — at the most specific item_price in force for the check’s outlet, order kind and daypart on the check’s business date, and snapshots that price, the item class’s revenue category and the VAT: every tax rule in force for the class (its takeaway class off the premises), rounded per rule to the penny half away from zero, never down. An item with no class, no price in force, two equally specific prices, or a tax class with no rule refuses to ring. The snapshot is the financial record, so menu and rate edits never rewrite a rung sale. Course defaults to the item’s course_default, then its class’s, then 1. modifiers are the options chosen, each from a group the item uses: every group’s bounds hold (the item’s own override on the link beats the group’s), and a required group (min above zero) must be answered. An option that adds a variant rings as its own line under this one (check_line_modifies_line) — at the option’s price, else the variant’s own, free under the no prefix — with that item’s VAT and revenue category, quantity times this line’s; an option with no variant, and any no / light / side prefix, joins this line’s kitchen instructions. A present fulfilled_at lands the line already delivered, for feeds that record completed service rather than drive it (a POS export’s lines carry no kitchen lifecycle to replay); live ordering omits it and the line lands entered for fire_course to pick up. A present external_ref routes the create through the check_line_external_ref business key, making a crashed-pass retry a replay instead of a duplicate line. The check’s totals move with the line. Emits fnb.line_added for the line and each modifier line.
Effects: create hospitality.check_line; link hospitality.link.check_line_on_check; link hospitality.link.check_line_for_menu_item; link hospitality.link.check_line_for_variant; link hospitality.link.check_line_modifies_line; modify hospitality.guest_check.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
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).
object
object
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.
object
Responses
Section titled “Responses”Action applied. modified_objects and modified_links populated when return_modified: true was supplied.
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
Per-invocation correlation id; matches events.correlation_id for every event this action appended.
Links established or removed by this invocation. Empty when the caller did not request return_modified.
object
Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.
object
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.
object
Human-readable summary, suitable for logging or operator-UI surfacing.
Object type the warning was raised against.
Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.
Stable kebab-case rule identifier (e.g. comp-authority-over-limit).
Example
{ "modified_links": [ { "kind": "linked", "link_type": "hospitality.link.check_line_on_check" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.check_line" } ]}Conflict — concurrent modification or unique constraint violation.
Validation error — parameter validation or business-rule violation.