Read Guest check as of a watermark

GET

/v1/object-types/hospitality.guest_check/objects/{id}/as-of

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

Time-travel read: the instance as it stood at the at watermark, reconstructed by folding its structural events. Property values that were marking-redacted or truncated in the event log surface as sentinel objects, not values.

The order/check entity: opened against a service table (or takeaway / room service) in a meal period on a business date, owned by a server, open until its payments (check_payment) cover what is due — the payment that brings balance_due to zero settles it and marks the table dirty (Simphony model). Carries its running totals, kept by every action that moves them: subtotal (live lines, modifier lines included, voided and comped out), tax_total, total_due (subtotal plus add-on tax), paid_total (tips excluded), tip_total and balance_due. Mutates only through the fnb actions.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.guest_check:read

Parameters

Path Parameters

required

string format: uuid

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

Query Parameters

required

string

The watermark: an event seq (integer, canonical — the /v1/events cursor namespace) or an RFC3339 timestamp (resolved to the latest seq at or before it in the tenant’s stream).

Responses

200

The reconstructed as-of state.

application/json

object

required

string

events_applied

required

integer

required

string format: uuid

last_event_seq

required

integer

last_event_ts

required

string format: date-time

object_type

required

Allowed value: hospitality.guest_check

properties

required

Log-shaped folded bag: each entry is a typed {kind, value} object, a {redacted: [markings]} sentinel, or a {truncated_bytes: n} sentinel.

object

key

additional properties

any

Example

{
  "object_type": "hospitality.guest_check"
}

404

Object did not exist at the watermark (not yet created, or already deleted).

422

Malformed at, or the object’s history predates structural event images and cannot back a faithful reconstruction.