Read Check receipt

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.check_receipt/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.check_receipt/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

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

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.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

Example

{
  "object_type": "hospitality.check_receipt",
  "properties": {
    "order_kind": "dine_in",
    "payments": [
      {
        "tender": "room_charge"
      }
    ]
  },
  "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).