Read Commission agreement

GET

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

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

Read an existing instance.

Time-varying commission contract between a property and a travel agent, tour operator, wholesaler or consortium. Carries the rate, kind and flat amount in effect for the period, plus the minimum the agent will accept a payment for. Only one row per (company, property) may be open at a time; binding a new one closes the last.

Authorizations

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

properties

required

object

commission_flat_amount

Commission agreement commission flat amount

Per-booking flat commission

object

amount

required

string format: decimal

currency

required

string format: iso-4217

commission_kind

required

Commission kind

string

Allowed values: percent_of_revenue per_booking_flat per_booking_plus_percent none

commission_rate

Commission rate (decimal share of commissionable revenue)

string format: decimal

effective_from

required

Effective from

string format: date

effective_to

Effective to (null = currently in effect)

string format: date

required

Agreement id

string

minimum_payment_amount

Commission agreement minimum payment amount

Do not pay this agent below this amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

notes

Contract notes

string

tax_treatment

VAT posture of this agent's commission

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_agreement",
  "properties": {
    "commission_kind": "percent_of_revenue",
    "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).