Read Banquet order line

GET

/v1/object-types/hospitality.banquet_order_line/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.banquet_order_line/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

One resource on a banquet event order — a menu, a coffee break, the room, a screen. quantity_basis says whether it bills per person (times the event’s billable count) or as a fixed quantity; unit_price is in the order’s currency. Posting links the line to the charge it became.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.banquet_order_line:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.banquet_order_line

properties

required

object

category

required

Section of the sheet the line belongs to

string

Allowed values: room_rental food beverage audio_visual equipment labour decor entertainment other

description

required

What the line is

string

required

Line id

string

notes

Dietary, presentation, placement

string

quantity

required

Fixed quantity, or units per person

integer

quantity_basis

required

Per person, or a fixed quantity

string

Allowed values: per_person fixed

sequence

required

Order of the line on the sheet

integer

serve_at

When the line is served or set

string format: date-time

unit_price

Banquet order line unit price

Price per unit

object

amount

required

string format: decimal

currency

required

string format: iso-4217

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_order_line",
  "properties": {
    "category": "room_rental",
    "quantity_basis": "per_person"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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