Open cashier session
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.open_cashier_session/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"cashier_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","notes":"example","opened_at":"2026-04-15T12:00:00Z","opening_float":{"amount":"example","currency":"example"}},"return_modified":false}'};
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.open_cashier_session/apply \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "cashier_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "opened_at": "2026-04-15T12:00:00Z", "opening_float": { "amount": "example", "currency": "example" } }, "return_modified": false }'Open a cash shift against an active cashier with a starting float (zero is legal — a short drawer at close is a variance, never a negative float). One open session per cashier per currency: a multi-currency desk opens one session per currency, decomposing Mews’s per-currency balances. The session’s currency is the float’s; every movement in the shift must match it. Business-time opened_at defaults to now.
Effects: create hospitality.cashier_session; link hospitality.link.cashier_session_for_cashier.
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.
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.cashier_session_for_cashier" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.cashier_session" } ]}Conflict — concurrent modification or unique constraint violation.
Validation error — parameter validation or business-rule violation.