Skip to content

What-if Bind comp authority policy (rollup delta)

POST
/v1/actions/hospitality.action.bind_comp_authority_policy/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.bind_comp_authority_policy/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "comp_category": "room_night", "limit_per_day": { "amount": "example", "currency": "example" }, "limit_per_incident": { "amount": "example", "currency": "example" }, "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "requires_escalation_above": { "amount": "example", "currency": "example" }, "role": "front_office_agent" }, "return_modified": false }'

What-if projection of apply_hospitality_action_bind_comp_authority_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.bind_comp_authority_policy:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

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
comp_category
required
Comp category
string
Allowed values: room_night food_beverage spa retail parking other
limit_per_day
Limit per day
object
amount
required
string format: decimal
currency
required
string format: iso-4217
limit_per_incident
Limit per incident
object
amount
required
string format: decimal
currency
required
string format: iso-4217
property_id
required
Property
string format: uuid
requires_escalation_above
Soft escalation threshold
object
amount
required
string format: decimal
currency
required
string format: iso-4217
role
required
Role
string
Allowed values: front_office_agent front_office_supervisor concierge bell housekeeper housekeeping_supervisor engineer food_beverage_server food_beverage_manager chef spa_therapist spa_manager reservations_agent revenue_manager sales_manager manager_on_duty general_manager owner other runner
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

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"
}
]
}
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

Validation error — the apply would be rejected.