Skip to content

Cancel reservation room

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

Cancel one room of a multi-room reservation before arrival. The room goes the way a cancelled booking’s rooms go (the same leg cascade cancel_reservation runs): status cancelled, its room-nights released to the availability ledger (share-aware), its room assignment cleared. The booking stands with the rest: its guest counts re-derive from the live rooms, it reads modified, an unpaid deposit re-derives, and the other rooms and every folio are untouched. Penalty, per room: the booking’s frozen cancellation terms are split by this room’s share of the booking’s room revenue — the room records its part of the fee in force at cancelled_at, and the booking keeps the rest of every frozen figure — so the policy is never walked again and the two parts always sum to what was frozen. With outlet_id, a non-zero part posts to the booking’s own account as a cancellation fee. Refuses the last live room (cancel the reservation), a room in house or checked out, and a booking already in house, cancelled or no-show. Replay-iff-identical on cancelled_at. Emits reservation_room.cancelled.decided. Guest-impacting and destructive, so agents stage it for human confirmation.

Effects: modify hospitality.reservation_room; modify hospitality.reservation; modify hospitality.availability_day; unlink hospitality.link.reservation_room_assigned_to; link hospitality.link.reservation_for_room_type; unlink hospitality.link.reservation_for_room_type; 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.payment_request.

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
Business date the fee posts on (defaults to the property's day of cancelled_at)
string format: date
cancelled_at
Cancellation instant (defaults to now; must not precede booked_at)
string format: date-time
outlet_id
Outlet to post the room's fee under (miscellaneous income); absent, nothing is charged
string format: uuid
reason
Reason
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_room

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: unlinked end_dated linked
link_type
required
Allowed values: hospitality.link.reservation_room_assigned_to hospitality.link.reservation_for_room_type 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: modified created
object_type
required
Allowed values: hospitality.reservation_room hospitality.reservation hospitality.availability_day hospitality.charge hospitality.tax_application hospitality.folio hospitality.payment_request
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": "unlinked",
"link_type": "hospitality.link.reservation_room_assigned_to"
}
],
"modified_objects": [
{
"kind": "modified",
"object_type": "hospitality.reservation_room"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.