What-if Set rates (rollup delta)

POST

/v1/actions/hospitality.action.set_rates/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_rates/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "bar_anchor_amount": { "amount": "example", "currency": "example" }, "days_of_week": [ "monday" ], "end_date": "2026-04-15", "inclusive_of_tax": true, "occupancy": 1, "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "start_date": "2026-04-15" }, "return_modified": false }'

• Production API

What-if projection of apply_hospitality_action_set_rates — 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_rates: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

amount

required

Amount per night

object

amount

required

string format: decimal

currency

required

string format: iso-4217

bar_anchor_amount

BAR anchor (required for bar_grid rate plans)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

days_of_week

Days of week the pattern applies to (defaults to all seven)

Array<string>

Allowed values: monday tuesday wednesday thursday friday saturday sunday

end_date

required

End date (inclusive)

string format: date

inclusive_of_tax

Amount is inclusive of tax

boolean

occupancy

required

Occupancy (adult count this price applies to)

integer

property_id

required

Property the priced rows are scoped to (plans and room types can be brand-standard; prices are always per-property)

string format: uuid

rate_plan_id

required

Rate plan

string format: uuid

room_type_id

required

Room type

string format: uuid

start_date

required

Start date

string format: date

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

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.