Search Check receipt

POST

/v1/object-types/hospitality.check_receipt/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.check_receipt/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"number","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

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/object-types/hospitality.check_receipt/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "number", "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.

The guest’s receipt for a settled check — issued when the check’s balance reaches zero, numbered from the outlet’s receipt series (R-{outlet}-{000001}) and chained by hash onto the property’s issued documents, invoices and credit notes included. A snapshot of what a UK simplified invoice needs (VAT Notice 700 §16.6.1: supplier name, address and VAT number, time of supply, what was supplied, per-rate VAT-inclusive totals and rates) plus the check number, outlet, server, business date, lines, tenders, tips and change. Not a VAT invoice: no recipient. A room charge prints as charged to the room, with the guest’s name and no card detail. Never edited after issue.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.check_receipt:read

Request Body^required

application/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: number

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 number series sequence_value check_number outlet_name order_kind table_label covers server_name business_date settled_at time_of_supply issued_at supplier_name content_hash previous_hash

Responses

200

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

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.check_receipt

properties

required

object

business_date

required

Business date

The check’s business date — the hotel date it opened on.

string format: date

change_total

required

Check receipt change total

Cash handed back across the payments.

object

amount

required

string format: decimal

currency

required

string format: iso-4217

check_number

required

Check number

The check’s own number, the one the server says aloud.

string

content_hash

required

Content hash

SHA-256 over the receipt’s canonical fields (the invoice’s field list: issuer tax reference, series, number, business date, kind receipt, tax, total) and previous_hash.

string

covers

Covers

integer

currency

required

Currency

string format: iso-4217

issued_at

required

Issued at

The instant the receipt was issued.

string format: date-time

issuer

Check receipt issuer

The supplier’s legal identity as it printed — the property’s legal name, address and VAT number from its billing identity; its own name and address under scheme none when it has no billing identity; absent when it has neither (a till never refuses a guest their slip over back-office configuration).

object

address

required

object

city

required

string

country

required

string

line1

required

string

line2

string

postal_code

string

region

string

bank_account

object

account_name

string

account_number

string

bic

string

iban

string

sort_code

string

company_registration_number

string

contact_email

string

contact_phone

string

legal_name

required

string

tax_registration_number

string

tax_registration_scheme

required

string

lines

required

Check receipt lines

What was supplied, in the order it rang: each fulfilled or comped line with its modifier lines after it (modifier: true). Voided lines were never made and are not printed; a comped line prints at its price, marked.

Array<object>

object

comped

required

boolean

description

required

string

line_total

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

modifier

required

boolean

quantity

required

integer

unit_price

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

number

required

Receipt number

R-{outlet code}-{000001} — drawn from the outlet’s dense receipt series inside the settling transaction and never reissued.

string

order_kind

required

How the order reached the guest

string

Allowed values: dine_in takeaway room_service delivery

outlet_name

required

Outlet

string

paid_total

required

Check receipt paid total

What the payments applied to the check, tips out.

object

amount

required

string format: decimal

currency

required

string format: iso-4217

payments

Check receipt payments

Each tender in the order it was taken: amount, tip, cash tendered and change; a room charge with its room and the name of the guest who signed — never card data.

Array<object>

object

amount

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

change_given

object

amount

required

string format: decimal

currency

required

string format: iso-4217

guest_name

string

room_number

string

tender

required

string

Allowed values: room_charge cash card comp external charge_to_key

tendered

object

amount

required

string format: decimal

currency

required

string format: iso-4217

tip

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

previous_hash

Previous content hash

The property’s previous issued document’s content_hash — invoice, credit note or receipt: one chain per property. Absent only on the property’s first document.

string

sequence_value

required

Sequence value

The bare counter value number was rendered from, so a gap is detectable without parsing the number.

integer

series

required

Number series

The sequence the number came from — {property_id}:receipt:{outlet_id}: one run per outlet (a till prints its own), dense, and kept apart from the property’s invoice and credit-note runs.

string

server_name

Server

The owning server’s given name, as it printed.

string

settled_at

required

Time of supply

When the check settled — the time of supply the receipt prints (Notice 700 §16.6.1).

string format: date-time

simplified

required

Simplified

Always true: a till receipt is the retailer’s simplified invoice, issued without the customer’s details.

boolean

subtotal

required

Check receipt subtotal

The live lines’ gross — comps and voids out, inclusive VAT in.

object

amount

required

string format: decimal

currency

required

string format: iso-4217

supplier_name

required

Supplier

The house’s name as the slip heads it.

string

table_label

Table

string

tax_total

required

Check receipt tax total

VAT

object

amount

required

string format: decimal

currency

required

string format: iso-4217

time_of_supply

required

Time of supply, as printed

settled_at in the house’s own time zone, as the slip prints it (2026-11-02 19:42; UTC appended when the property names no zone) — snapshotted so a render needs no clock and no zone database.

string

tip_total

required

Check receipt tip total

Tips taken with the payments — outside the scope of VAT.

object

amount

required

string format: decimal

currency

required

string format: iso-4217

total_due

required

Check receipt total due

What the guest owed: subtotal plus any add-on tax.

object

amount

required

string format: decimal

currency

required

string format: iso-4217

vat

required

Check receipt vat

Per tax rule and rate over the live lines: the code, the rate, and the net, tax and VAT-inclusive gross — the per-rate figures Notice 700 §16.6.1 asks a simplified invoice to show.

Array<object>

object

code

required

string

gross

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

net

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

rate

required

string format: decimal

tax

required

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

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_receipt",
      "properties": {
        "order_kind": "dine_in",
        "payments": [
          {
            "tender": "room_charge"
          }
        ]
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Check receipt

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required