What-if Define maintenance plan (rollup delta)

POST

/v1/actions/hospitality.action.define_maintenance_plan/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_maintenance_plan/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cadence": "fixed", "category": "hvac", "description": "example", "first_due_on": "2026-04-15", "interval_days": 1, "severity": "cosmetic", "title": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.room" } }'

• Production API

What-if projection of apply_hospitality_action_define_maintenance_plan — 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_maintenance_plan: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

asset_id

The equipment the plan looks after (same house, not retired); each raised order is for it too, and retiring it retires the plan

string format: uuid

cadence

required

fixed (to the calendar) or floating (from the last completion)

string

Allowed values: fixed floating

category

required

Work order category

string

Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other

description

Detail carried onto each raised work order

string

first_due_on

required

The first due date

string format: date

interval_days

required

Days between occurrences (1 to 3650)

integer

severity

required

Work order severity

string

Allowed values: cosmetic minor major blocking safety

title

required

What each raised work order says to do

string

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.room

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.