What-if Set deposit policy (rollup delta)

POST

/v1/actions/hospitality.action.set_deposit_policy/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_deposit_policy/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "auto_cancel_on_lapse": true, "basis": "flat", "code": "example", "description": "example", "due_basis": "days_after_booking", "due_days": 1, "effective_from": "2026-04-15", "effective_to": "2026-04-15", "flat_amount": { "amount": "example", "currency": "example" }, "nights": 1, "rate": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

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

Authorizations

• aerandil_oauth

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

auto_cancel_on_lapse

required

End of Day cancels an unpaid lapsed booking (true) or only records the lapse (false)

boolean

basis

required

How the required deposit computes

string

Allowed values: flat percent_of_stay percent_of_first_night nights

code

required

Policy code — the rule's identity within the property

string

description

Operator-facing description

string

due_basis

required

Which anchor the due date is measured from

string

Allowed values: days_after_booking days_before_arrival

due_days

required

Day offset from the due anchor (>= 0)

integer

effective_from

required

First booking date the policy applies (inclusive)

string format: date

effective_to

Last booking date the policy applies (inclusive); omit for open-ended

string format: date

flat_amount

Amount for the flat basis

object

amount

required

string format: decimal

currency

required

string format: iso-4217

nights

Night count for the nights basis

integer

rate

Rate for the percent bases (decimal in [0, 1]; 0.50 = 50%)

string format: decimal

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

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

Example^generated

{
  "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

Cache-Control

string

Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Validation error — the apply would be rejected.