What-if Execute management agreement (rollup delta)

POST

/v1/actions/hospitality.action.execute_management_agreement/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.execute_management_agreement/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "accounting_fee_monthly": { "amount": "example", "currency": "example" }, "base_fee_pct_revenue": "example", "budget_aggregate_flex_pct": "example", "budget_line_flex_pct": "example", "capex_approval_threshold": { "amount": "example", "currency": "example" }, "code": "example", "commenced_on": "2026-04-15", "contract_approval_threshold": { "amount": "example", "currency": "example" }, "cure_window_months": 1, "external_ref": "example", "incentive_kind": "pct_agop_over_priority", "incentive_pct": "example", "initial_term_years": 1, "name": "example", "noi_budget_floor_pct": "example", "owner_priority_return_pct": "example", "radius_miles": "example", "revenue_management_fee_monthly": { "amount": "example", "currency": "example" }, "revpar_index_floor_pct": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.company" } }'

• Production API

What-if projection of apply_hospitality_action_execute_management_agreement — 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.execute_management_agreement: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

accounting_fee_monthly

Centralised-accounting charge per month

object

amount

required

string format: decimal

currency

required

string format: iso-4217

base_fee_pct_revenue

required

Base fee as a fraction of total operating revenue

string format: decimal

budget_aggregate_flex_pct

Aggregate overspend ceiling

string format: decimal

budget_line_flex_pct

Per-line-item overspend delegation

string format: decimal

capex_approval_threshold

Owner-approval threshold for capital spend

object

amount

required

string format: decimal

currency

required

string format: iso-4217

code

required

Agreement code

string

commenced_on

required

Commencement date

string format: date

contract_approval_threshold

Owner-approval threshold for contract value

object

amount

required

string format: decimal

currency

required

string format: iso-4217

cure_window_months

Cure window after a performance failure (months)

integer

external_ref

Provisioning idempotency anchor

string

incentive_kind

required

Incentive-fee structure

string

Allowed values: pct_agop_over_priority pct_noi_attainment none

incentive_pct

Incentive fee fraction (per incentive_kind)

string format: decimal

initial_term_years

required

Initial term (years)

integer

name

required

Agreement name

string

noi_budget_floor_pct

Performance test: minimum actual/budgeted NOI

string format: decimal

owner_priority_return_pct

Owner-priority hurdle fraction (pct_agop_over_priority only)

string format: decimal

radius_miles

Area-of-protection radius (miles)

string format: decimal

revenue_management_fee_monthly

Centralised revenue-management charge per month

object

amount

required

string format: decimal

currency

required

string format: iso-4217

revpar_index_floor_pct

Performance test: minimum RevPAR index vs prior year

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

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.