Skip to content
aerandil.com
GitHub

What-if Define material (rollup delta)

POST
/v1/actions/hospitality.action.define_material/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_material/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "code": "example", "description": "example", "family": "spare_part", "name": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sale_price": { "amount": "example", "currency": "example" }, "unit": "each" }, "return_modified": false }'

What-if projection of apply_hospitality_action_define_material — 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.define_material: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
brand_id
The brand's catalogue (exactly one of brand_id / property_id)
string format: uuid
code
required
The catalogue's code for it
string
description
Notes on it
string
family
required
What kind of thing it is
string
Allowed values: spare_part consumable amenity linen minibar_product laundry_item cleaning_product other
name
required
What it is, in words
string
property_id
One house's catalogue (exactly one of brand_id / property_id)
string format: uuid
sale_price
What one unit sells for (a minibar product's charge per unit)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
unit
required
The unit it is counted in
string
Allowed values: each pack pair roll kg l m
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

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.