Read Platform ledger line as of a watermark

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.platform_ledger_line/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.platform_ledger_line/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.

One balance transaction on the platform’s own processor balance (Stripe’s txn_…) that belongs to a hotel’s merchant account: the platform charge a destination payment was made with (and Stripe’s processing fee on it), the transfer that carried the hotel’s share, the application fee the platform earned, a refund and the reversal that recovered it, a chargeback’s withdrawal and what was passed back. Filed at the house the account is for, matched when it resolves to a ledger payment or case. Append-only; a line read again may gain a match it could not make before. The platform’s lines no hotel owns (its own payouts, Stripe’s fees on the platform and the tax on them, a reserve, a charge for an account no merchant account holds) are filed at the tenant scope of the operator’s own tenant, with no merchant account, never matched, their day the processor’s UTC day.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.platform_ledger_line: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.platform_ledger_line

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.platform_ledger_line"
}

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.