Read Package component consumption

GET

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

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

Read an existing instance.

Append-only ledger row tying a charge to a package_sale + package_component on a specific business date. Opera’s package_profit / package_loss reconciliation pattern, made queryable: per-night per-component the operator can see what was allowed, what was consumed, and the reconciliation outcome. Mutation of this row after insert is rejected — it is event-shaped, mirroring the event log’s append-only contract.

Authorizations

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

properties

required

object

allowance_amount

Package component consumption allowance amount

What the package allotted

object

amount

required

string format: decimal

currency

required

string format: iso-4217

business_date

required

Business date

string format: date

consumed_amount

required

Package component consumption consumed amount

What the guest actually consumed

object

amount

required

string format: decimal

currency

required

string format: iso-4217

covers

Covers this consumption fed

How many of the stay’s entitled covers this row accounts for — the breakfast roster’s tick-off, or the covers of the check a room charge consumed it from. What the roster counts as taken. Absent on rows that are not a meal.

integer

required

Consumption id

string

reconciliation_kind

required

Reconciliation outcome

string

Allowed values: consumed profit loss refunded

recorded_at

required

When the consumption was recorded

string format: date-time

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.package_component_consumption",
  "properties": {
    "reconciliation_kind": "consumed"
  },
  "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).