Post charge

POST

/v1/actions/hospitality.action.post_charge/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.post_charge/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "bucket": "rooms", "description": "example", "gratuity": { "amount": "example", "currency": "example" }, "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "service_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "system_charge_kind": "room_night", "tax_lines": [ { "amount": { "amount": "example", "currency": "example" }, "basis_amount": { "amount": "example", "currency": "example" }, "code": "example", "inclusive": true, "jurisdiction": "example", "rate": "example" } ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.folio" } }'

• Production API

Post a charge line to a folio. amount is the charge’s base amount — inclusive taxes (VAT-style) ride inside it, while exclusive tax lines and gratuity add on top, so the folio debit is amount + Σ(exclusive tax) + gratuity. Each tax_lines entry lands as a linked tax_application row for fiscal / OTA disclosure; the charge’s aggregate tax is the sum of every line regardless of inclusivity.

Effects: create hospitality.charge; create hospitality.tax_application; link hospitality.link.folio_has_charge; link hospitality.link.charge_has_tax_application; link hospitality.link.charge_for_service_item; link hospitality.link.charge_at_outlet; modify hospitality.folio.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.post_charge: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

amount

required

Amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

bucket

required

USALI 12 department

string

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

description

required

Description

string

gratuity

Gratuity / service charge added on top of the amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

outlet_id

required

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

string format: uuid

service_item_id

Service item

string format: uuid

system_charge_kind

System-generated charge kind

string

Allowed values: room_night day_use tax service_charge gratuity adjustment package_discount forfeited_deposit no_show_fee cancellation_fee no_show_revenue

tax_lines

Per-jurisdiction tax decomposition (each lands as a tax_application)

Array<object>

object

amount

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

basis_amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

code

required

string

inclusive

required

boolean

jurisdiction

required

string

rate

required

string format: decimal

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.folio

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.folio_has_charge hospitality.link.charge_has_tax_application hospitality.link.charge_for_service_item 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.charge hospitality.tax_application hospitality.folio

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.folio_has_charge"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.charge"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.