What-if Open check (rollup delta)

POST

/v1/actions/hospitality.action.open_check/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.open_check/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "covers": 1, "daypart": "breakfast", "external_ref": "example", "opened_at": "2026-04-15T12:00:00Z", "order_kind": "dine_in", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "promised_at": "2026-04-15T12:00:00Z", "server_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stay_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

• Production API

What-if projection of apply_hospitality_action_open_check — 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.open_check: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

covers

Covers seated

integer

daypart

Meal period the check rings in (the daypart a price row may be narrowed to)

string

Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day

external_ref

Source-system key for replayed / connector-landed checks (replay key)

string

opened_at

When the check opened — business time, not record time (defaults to now)

string format: date-time

order_kind

required

How the order reaches the guest

string

Allowed values: dine_in takeaway room_service delivery

outlet_id

required

Outlet the check trades under

string format: uuid

promised_at

When the in-room order is promised at the room (room_service only)

string format: date-time

server_id

Owning server

string format: uuid

stay_id

In-house stay the check is for (required on room_service, optional otherwise)

string format: uuid

table_id

Table to seat (dine-in only)

string format: uuid

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.