Skip to content
aerandil.com
GitHub

Read Banquet event order

GET
/v1/object-types/hospitality.banquet_event_order/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.banquet_event_order/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

The banquet event order (function sheet) for one function event: the resources the departments set, cook and serve — its lines — with the setup, service and billing notes, issued to the house under a revision number and re-issued when a line changes after distribution. Once the event is actual, post_banquet_event_charges posts every line at the billable count to the order’s folio or the block’s master folio and freezes the order as posted.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.banquet_event_order
properties
required
object
av_notes
Audiovisual: equipment, technicians, rehearsal
string
billing_instructions
How the client pays — master account, deposits, what the guests settle
string
currency
required
Currency every line is priced in
string format: iso-4217
issued_at
When the current revision went to the departments
string format: date-time
number
required
BEO number
string
posted_at
When the charges were posted
string format: date-time
revision
required
How many times the order has been issued
integer
service_charge_rate
Service charge applied to food and beverage lines at posting (0.125 = 12.5%)
string format: decimal
service_notes
Service: the run of show, course timings, bar hours
string
setup_notes
Setup: tables, linen, staging, signage
string
status
required
Order status
string
Allowed values: draft issued revised posted cancelled
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.banquet_event_order",
  "properties": {
    "status": "draft"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).