Search Check payment

POST

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.check_payment/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"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"}'
};

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_payment/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 tender taken against a guest check (check_payment_on_check) — the kernel is the system of record for a check’s payments. amount is what it applied to the check, tip rides beside it and stays out of what was paid; cash may be tendered above the balance and gives change_given. A card payment carries the terminal’s references (psp_reference, terminal_transaction_id, poiid), never card data. A room charge or charge-to-key posts to its folio (check_payment_to_folio) one charge per revenue category and the tip as a gratuity charge (check_payment_posted_charge). allocation records the payment’s share of each revenue category and its VAT, so a check paid in parts sums exactly. Written only by add_check_payment / settle_check.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.check_payment: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: 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 tender psp_reference terminal_transaction_id poiid paid_at recorded_by external_ref override_kind override_reason

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_payment

properties

required

object

allocation

required

Check payment allocation

Per revenue category, what of amount paid it and the tax inside that share, per rule — apportioned by largest remainder over what the earlier payments left, so a check’s payments sum exactly to its categories and its VAT. A room charge posts these shares to the folio.

Array<object>

object

amount

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

revenue_category

required

string

Allowed values: food non_alcoholic_beverage alcoholic_beverage other

tax

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

tax_lines

required

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

allowance_applied

Check payment allowance applied

What of the payment the stay’s package allowance covered — the food and soft-drink share, capped at what the day’s allowance had left, never the tip. The folio carries that part as the package’s balance-neutral consumption line and only the rest as charges the guest owes; the consumption row names this payment (consumption_for_check_payment). Absent when nothing was covered.

object

amount

required

string format: decimal

currency

required

string format: iso-4217

amount

required

Check payment amount

Applied to the check (tip excluded)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

authorised_by

The manager whose say-so overrode the stay's posting rules — the staff member signed in when the payment was taken

string format: uuid

change_given

Check payment change given

Change handed back (cash only)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

external_ref

Source-system key for replayed / connector-landed payments

string

guest_id

The guest who signed

The guest the server confirmed for a room charge — the reservation’s guest (a sharer signs on their own booking). Carried onto the folio charges as signed_by.

string format: uuid

required

Payment id

string

override_kind

What a manager's override let through: the stay's no-post flag (no_post) or its credit (no_credit)

string

Allowed values: no_post no_credit

override_reason

Why the manager overrode the stay's posting rules

string

paid_at

required

When the payment was taken — business time

string format: date-time

poiid

The terminal (point of interaction) the card was taken on

string

psp_reference

The processor's reference for the card payment (Adyen pspReference) — an identifier, not a credential

string

recorded_by

required

Principal::stable_id() of the principal that took the payment

string

reservation_id

The reservation a room charge posted to

The booking whose bill a room charge or charge-to-key posted to — the folio belongs to it (a stay’s window or the booking’s own account). OHIP posts to a reservation, never to a room.

string format: uuid

staff_member_id

The staff member who took the payment, when the session is one

string format: uuid

tender

required

Tender

string

Allowed values: room_charge cash card comp external charge_to_key

tendered

Check payment tendered

Cash handed over (cash only)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

terminal_transaction_id

The terminal's own transaction id for the card payment

string

tip

required

Check payment tip

The tip taken with the payment — a pass-through to the staff under the Employment (Allocation of Tips) Act 2023, never revenue and never in paid_total. Zero when none.

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_payment",
      "properties": {
        "allocation": [
          {
            "revenue_category": "food"
          }
        ],
        "override_kind": "no_post",
        "tender": "room_charge"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Check payment

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required