Search Commission detail

POST

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

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

What one completed stay owes one payee. settlement_mode says whether this is a payable the hotel initiates (a travel agent) or an expectation to reconcile against an invoice the payee will send us (an agency-model OTA) — the two look identical on a reservation and must never be paid the same way. The rate and policy that produced the amount are frozen on the row, so a later renegotiation cannot restate a historical liability.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.commission_detail: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 status payee_kind settlement_mode accrued_on commission_kind commission_rate policy_ref tax_treatment hold_reason settled_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.commission_detail

properties

required

object

accrued_on

required

Business date the stay completed

string format: date

adjusted_from_amount

Commission detail adjusted from amount

Amount before the operator adjusted it

object

amount

required

string format: decimal

currency

required

string format: iso-4217

commission_amount

Commission detail commission amount

Amount owed to the payee

object

amount

required

string format: decimal

currency

required

string format: iso-4217

commission_kind

required

Commission kind in force at accrual

string

Allowed values: percent_of_revenue per_booking_flat per_booking_plus_percent none

commission_rate

Commission rate in force at accrual

string format: decimal

commissionable_revenue

Commission detail commissionable revenue

Revenue the commission was computed on, in property currency

object

amount

required

string format: decimal

currency

required

string format: iso-4217

hold_reason

Why the row is held back from payment

string

required

Detail id

string

payee_kind

required

Whether the payee is a company or a channel

string

Allowed values: company channel

policy_ref

Agreement or channel period the figures were derived from

string

settled_reason

Why the row settled without a payment

string

settlement_mode

required

Hotel-initiated payable, or an invoice to reconcile

string

Allowed values: payable reconcile

status

required

Detail status

string

Allowed values: accrued held paid reconciled prepaid offset_to_ar voided

tax_treatment

VAT posture of this amount

string

Allowed values: standard reverse_charge exempt

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.commission_detail",
      "properties": {
        "commission_kind": "percent_of_revenue",
        "payee_kind": "company",
        "settlement_mode": "payable",
        "status": "accrued",
        "tax_treatment": "standard"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Commission detail

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required