Search Charge

POST

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

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

A line item posted to a folio. Carries a USALI 12 bucket (the operated department revenue rolls up to) plus either a charge_for_service_item link (when posted against the service catalog) or a system_charge_kind enum (when the charge is system-generated — a room night, tax line, service charge, gratuity, adjustment, package discount).

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.charge: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 description posted_at bucket system_charge_kind package_attribution_kind external_ref revenue_category

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

properties

required

object

amount

required

Charge amount

Amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

bucket

required

USALI 12 department

string

Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail

description

required

Description

string

device_ref

The device a key-card tap was made at (set by `post_charge_by_credential`)

string format: uuid

external_ref

Source-system key for connector-landed charges

string

gratuity

required

Charge gratuity

Gratuity

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Charge id

string

outlet_id

required

USALI 12 operated department (Schedule 3 or 4) the charge rolls up to. A synthetic `miscellaneous_income`-bucket outlet per property covers genuinely non-department revenue (interest, cancellation fees, lost-key charges).

string format: uuid

package_attribution_kind

Package-attribution kind

string

Allowed values: component_full_price component_allocated_price package_discount_adjustment

posted_at

required

Posted at

string format: date-time

revenue_category

F&B revenue category

What an F&B posting sold (food / soft drinks / alcohol / other), for a charge a room-charged check posted — one per category on the check. Absent on every other charge.

string

Allowed values: food non_alcoholic_beverage alcoholic_beverage other

signed_by

The guest who signed for it

The guest who signed for a posting made at an outlet — the guest the server confirmed on the booking’s bill — so the bill says who signed. Set by a room-charged F&B payment that named its guest; absent otherwise.

string format: uuid

system_charge_kind

System-generated charge kind

string

Allowed values: room_night day_use tax service_charge gratuity adjustment package_discount forfeited_deposit no_show_fee cancellation_fee no_show_revenue

tax

required

Charge tax

Tax

object

amount

required

string format: decimal

currency

required

string format: iso-4217

transferred_from_folio_id

Folio this charge was transferred from, when it did not originate on the folio it currently sits on.

string format: uuid

voided

required

Voided

boolean

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.charge",
      "properties": {
        "bucket": "rooms",
        "package_attribution_kind": "component_full_price",
        "revenue_category": "food",
        "system_charge_kind": "room_night"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Charge

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required