Consume package component

POST

/v1/actions/hospitality.action.consume_package_component/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.consume_package_component/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allowance_amount": { "amount": "example", "currency": "example" }, "business_date": "2026-04-15", "charge_bucket": "rooms", "charge_description": "example", "component_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "consumed_amount": { "amount": "example", "currency": "example" }, "folio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reconciliation_kind": "consumed" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.package_sale" } }'

• Production API

Record one consumption of a package component on a business date and post the corresponding charge. The reconciliation outcome (consumed / profit / loss / refunded) is derived from the consumed vs. allowance amounts.

Effects: create hospitality.package_component_consumption; create hospitality.charge; modify hospitality.package_sale; link hospitality.link.package_sale_has_consumption; link hospitality.link.consumption_for_charge; link hospitality.link.folio_has_charge; link hospitality.link.charge_attributed_to_package_sale; link hospitality.link.charge_attributed_to_package_component; link hospitality.link.charge_at_outlet.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.consume_package_component:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

allowance_amount

required

Allowance amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

business_date

required

Business date

string format: date

charge_bucket

required

USALI 12 department for the charge

string

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

charge_description

required

Charge description

string

component_id

required

Package component

string format: uuid

consumed_amount

required

Consumed amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

folio_id

required

Folio receiving the charge

string format: uuid

outlet_id

required

USALI 12 outlet the consumption charge rolls up to (proposal 0023)

string format: uuid

reconciliation_kind

required

Reconciliation outcome

string

Allowed values: consumed profit loss refunded

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.package_sale

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.package_sale_has_consumption hospitality.link.consumption_for_charge hospitality.link.folio_has_charge hospitality.link.charge_attributed_to_package_sale hospitality.link.charge_attributed_to_package_component hospitality.link.charge_at_outlet

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created modified

object_type

required

Allowed values: hospitality.package_component_consumption hospitality.charge hospitality.package_sale

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.package_sale_has_consumption"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.package_component_consumption"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.