Forfeit deposit

POST

/v1/actions/hospitality.action.forfeit_deposit/apply

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

• Production API

Post a forfeited-deposit charge against the reservation’s folio — the stay’s when there is one, the booking’s own account otherwise, opened here so a cancelled booking’s charge is one a bill can show. The deposit already taken moves onto that folio as the credit the charge consumes, up to the amount forfeited. Posts under USALI miscellaneous_income with system_charge_kind = forfeited_deposit. Idempotent on (reservation, business_date, forfeiture_amount). Tax is derived from the rules the house authored for a forfeited_deposit active on the business date — a UK house taxes it as consideration for the room that was booked, an Austrian one does not — and a house with no such rule posts the charge untaxed. A booking’s tax exemption reaches it. Refused once a cancellation fee is posted on the booking (post_cancellation_fee, 2026-10-27): the deposit on its account already pays toward that fee, and Keep and Charge are one decision.

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

Authorizations

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

business_date

required

Business date

string format: date

forfeiture_amount

required

Forfeiture amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

outlet_id

required

USALI 12 outlet the forfeiture rolls up to — typically the property's `miscellaneous_income` outlet (proposal 0023)

string format: uuid

reason_code

Reason code

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

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_at_outlet hospitality.link.reservation_has_folio hospitality.link.folio_has_payment hospitality.link.charge_has_tax_application

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.reservation hospitality.folio hospitality.payment hospitality.tax_application

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.