Preview Execute management agreement (dry-run)

POST

/v1/actions/hospitality.action.execute_management_agreement/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.execute_management_agreement/preview \
  --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

Scenario preview of apply_hospitality_action_execute_management_agreement — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.execute_management_agreement:apply scope as apply. No Idempotency-Key.

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

Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.management_agreement_with_company

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created

object_type

required

Allowed values: hospitality.management_agreement

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.management_agreement_with_company"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.management_agreement"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — uncommitted live data.

409

Conflict — concurrent modification or unique constraint violation the apply would hit.

422

Validation error — the apply would be rejected.