Read Commission detail

GET

/v1/object-types/hospitality.commission_detail/objects/{id}

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

Read an existing instance.

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

Parameters

Path Parameters

required

string format: uuid

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

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

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

Example

{
  "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"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).