Skip to content
aerandil.com
GitHub

What-if Set incidental hold policy (rollup delta)

POST
/v1/actions/hospitality.action.set_incidental_hold_policy/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_incidental_hold_policy/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "active": true, "allowance": { "amount": "example", "currency": "example" }, "basis": "per_night", "code": "example", "description": "example", "guarantee": "none", "percent": "example", "rate_plan_ref": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_ref": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source": "direct_web" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

What-if projection of apply_hospitality_action_set_incidental_hold_policy — 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.set_incidental_hold_policy: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
active
Whether check-ins draw on the rule (default true)
boolean
allowance
required
The per-night allowance, or the flat amount (non-negative)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
basis
required
How the suggested hold computes
string
Allowed values: per_night room_and_per_night room_plus_flat flat room room_and_per_person_night per_person_night room_plus_percent
code
required
Policy code — the rule's identity within the property
string
description
Operator-facing description
string
guarantee
The reservation guarantee the rule is for; omit for any
string
Allowed values: none hold credit_card deposit prepaid corporate_billed voucher
percent
For room_plus_percent: the percentage of the room total added (10 = 10%)
string format: decimal
rate_plan_ref
The rate plan the rule is for; omit for any
string format: uuid
room_type_ref
The room type the rule is for; omit for any
string format: uuid
source
The booking source the rule is for; omit for any
string
Allowed values: direct_web direct_call property_direct ota gds wholesale corporate walk_in group_block agent loyalty
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.property

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.