Skip to content
aerandil.com
GitHub

What-if Post external charge (rollup delta)

POST
/v1/actions/hospitality.action.post_external_charge/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.post_external_charge/whatif \
  --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", "external_ref": "example", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "posted_at": "2026-04-15T12:00:00Z", "reservation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reservation_room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "system_charge_kind": "room_night", "window_number": 1 }, "return_modified": false }'

What-if projection of apply_hospitality_action_post_external_charge — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.post_external_charge:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
external_ref
Source-system key (makes the post replay-safe)
string
outlet_id
Outlet (omit to resolve the property's sole outlet in `bucket`)
string format: uuid
posted_at
Posting instant in the source system (defaults to now)
string format: date-time
reservation_id
required
Reservation whose stay folio receives the charge
string format: uuid
reservation_room_id
Leg whose stay folio receives the charge (required when the reservation has more than one stay)
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
window_number
Folio window (defaults to 1)
integer
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

Responses

Section titled “Responses”

200

Section titled “200”

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json
object
daily_rooms
required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>
object
business_date
required
string format: date
currency

ISO 4217, when the fold observed one.

string
property_id
required
string format: uuid
rooms_revenue_net_delta
required

Decimal, net rooms revenue delta.

string
rooms_sold_delta
required
integer format: int64
total_revenue_net_delta
required

Decimal, net total revenue delta.

string
Examplegenerated
{
  "daily_rooms": [
    {
      "business_date": "2026-04-15",
      "currency": "example",
      "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rooms_revenue_net_delta": "example",
      "rooms_sold_delta": 1,
      "total_revenue_net_delta": "example"
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Section titled “422”

Validation error — the apply would be rejected.