Skip to content

Post cancellation fee

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

Charge a cancelled booking what its terms said cancelling would cost. The amount defaults to the figure frozen at booking — the step of the ladder in force when the guest cancelled — so the desk charges what was disclosed rather than a number typed on the day; pass amount only to charge less. Posts under USALI miscellaneous income with system_charge_kind = cancellation_fee, onto the booking’s own account, opened here because a cancelled booking never checks in. Taxed like every retained payment: by the rules the house authored for a cancellation_fee, and not at all where it authored none.

The sibling of the night audit’s no-show fee, and deliberately not the same verb: a no-show is swept automatically at the close of the arrival day, while a cancellation is a decision someone makes. Apaleo splits them the same way, as two folio actions posting the same shape. Collecting the money afterwards is the card rail’s POST /v1/reservations/{id}/cancellation-fee/collection (2026-10-27), which asks the card for what the account still owes after any deposit on it — or the ordinary folio payment surface, since the charge is on an account and an account is billable. Idempotent: a booking whose fee is already posted refuses a second one. A guest who cancelled before any step of the frozen ladder charged anything owes nothing, and is charged only an amount the desk states (cancelled_outside_window otherwise); an amount is capped at the step in force. Refused once the deposit was kept (forfeit_deposit): Keep and Charge are one decision.

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

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
Fee charged
object
amount
required
string format: decimal
currency
required
string format: iso-4217
business_date
required
The business date the charge posts under
string format: date
outlet_id
required
The miscellaneous-income outlet the fee reports under
string format: uuid
reason_code
Why, for the desk and the charge description
string
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.reservation

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

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.