Post departed charge

POST

/v1/actions/hospitality.action.post_departed_charge/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.post_departed_charge/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "lines": [ { "amount": { "amount": "example", "currency": "example" }, "bucket": "rooms", "description": "example", "movement_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ], "note": "example", "reason": "minibar" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.stay" } }'

• Production API

Post charges found after the guest left — OPERA’s Delayed Charges — to the departed stay’s bill, inside the house’s post-stay window (set_post_stay_charging). Each line posts as an ordinary charge on today’s business date, through the house’s sole outlet in the line’s bucket, with the house’s tax rules for that bucket; the bill is reopened first (reopen_folio, reason late_charge) when check-out closed it. A line naming the floor’s uncharged minibar consumption (movement_id) is joined to the charge it became (charge_for_stock_movement), and a consumption already posted is skipped, so the same lines posted twice post once. Refused for a stay still in house, when the house has the window off, after the window closed, and when the bill has been invoiced (correct a sealed bill with open_rebate_folio). Taking the money is the card rail’s (POST /v1/stays/{id}/post-stay-charges/collection). Emits post_stay_charge.posted with the bill’s new balance.

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

Authorizations

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

lines

required

What was found: description, amount, bucket, and the minibar movement it bills

Array<object>

object

amount

required

object

amount

required

string format: decimal

currency

required

string format: iso-4217

bucket

required

string

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

description

required

string

movement_id

string format: uuid

note

What the desk wants the bill's reopening to say

string

reason

required

minibar, damage, laundry or other

string

Allowed values: minibar damage laundry other

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

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.charge_for_service_item hospitality.link.charge_has_tax_application hospitality.link.charge_for_stock_movement

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: modified created

object_type

required

Allowed values: hospitality.folio hospitality.charge 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": "modified",
      "object_type": "hospitality.folio"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.