Skip to content
aerandil.com
GitHub

Read Check line

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

Read an existing instance.

One ordered item on a guest check: menu item and variant, quantity, course, seat, unit price, revenue category and VAT snapshotted at order time, the kitchen’s instructions, and the entered → fired → fulfilled lifecycle with the void/comp split: voided = removed BEFORE preparation (no COGS, no sale); comped = delivered but written off (product consumed — carries authority metadata). A modifier option that adds something sellable (add bacon) is a line of its own, linked to the line it modifies by check_line_modifies_line and priced and taxed as its own item; it follows its parent through fire, bump, void and comp and is never voided or comped alone.

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.check_line
properties
required
object
comp_authorised_by
Staff member who authorised the comp — the one signed in when it was comped
string format: uuid
comp_escalation_required
Comp exceeded the authoriser's per-incident limit
boolean
comp_reason
Why the line was comped (required when comped)
string
course_number
required
Course
integer
external_ref
Source-system key for replayed / connector-landed lines
string
fired_at
When the line fired to the kitchen
string format: date-time
fulfilled_at
When the line's ticket bumped (or, for a connector-landed line, when service completed)
string format: date-time
id
required
Line id
string
instructions
Kitchen instructions

What the kitchen must do differently, in the order the modifiers were chosen: an option that adds nothing sellable (Medium rare), and a no / light / side prefix on any option (NO Onion, SIDE Dressing). Options that add something sellable are lines of their own.

Array<string>
modifier_prefix
Prefix the modifier was chosen with (modifier lines only)

On a modifier line, the prefix its option was chosen with — no rings it free, extra another portion, light / side change how it is served. Absent on an item rung on its own, and on a modifier chosen plain.

string
Allowed values: no extra light side
notes
Kitchen-facing note
string
quantity
required
Quantity
integer
revenue_category
required
Revenue category, from the item class at order time
string
Allowed values: food non_alcoholic_beverage alcoholic_beverage other
seat_number
Seat

The seat the item is for, so the runner knows who gets which plate and a split by seat has its key. Absent = the table’s (shared, or not taken).

integer
status
required
Line lifecycle status
string
Allowed values: entered fired fulfilled voided comped
tax_amount
required
Check line tax amount

Total tax on quantity × unit price, each rule rounded to the penny half away from zero (never down — VAT Notice 700 §17.6). Inside the price when the rules are inclusive, on top when they add on.

object
amount
required
string format: decimal
currency
required
string format: iso-4217
tax_class
required
Tax class the line's VAT resolved through (eat-in or takeaway)
string
tax_lines
required
Check line tax lines

One entry per tax rule applied — code, jurisdiction, rate, amount, inclusive — the per-rate figures a VAT receipt totals. Empty only when no rule applied, which a sale never does.

Array<object>
object
amount
required
object
amount
required
string format: decimal
currency
required
string format: iso-4217
code
required
string
inclusive
required
boolean
jurisdiction
required
string
rate
required
string format: decimal
unit_price
required
Check line unit price

Unit price snapshotted from the variant’s price in force at order time

object
amount
required
string format: decimal
currency
required
string format: iso-4217
void_reason
Why the line was voided (required when voided)
string
Allowed values: guest_changed_mind entry_error item_unavailable long_wait duplicate other
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.check_line",
  "properties": {
    "modifier_prefix": "no",
    "revenue_category": "food",
    "status": "entered",
    "void_reason": "guest_changed_mind"
  },
  "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).