Skip to content
aerandil.com
GitHub

Search Check line

POST
/v1/object-types/hospitality.check_line/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.check_line/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id status quantity course_number seat_number revenue_category tax_class modifier_prefix notes void_reason comp_reason fired_at fulfilled_at external_ref

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.check_line",
      "properties": {
        "modifier_prefix": "no",
        "revenue_category": "food",
        "status": "entered",
        "void_reason": "guest_changed_mind"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.