What-if Record utility cost (rollup delta)

POST

/v1/actions/hospitality.action.record_utility_cost/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_utility_cost/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "business_date": "2026-04-15", "consumption_quantity": "example", "consumption_unit": "kwh", "external_ref": "example", "kind": "electricity", "period_end": "2026-04-15", "period_start": "2026-04-15", "source": "invoice_import" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

What-if projection of apply_hospitality_action_record_utility_cost — 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.record_utility_cost: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

amount

required

Amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

business_date

required

Accrual business date

string format: date

consumption_quantity

Metered consumption quantity (requires consumption_unit)

string format: decimal

consumption_unit

Consumption unit (requires consumption_quantity)

string

Allowed values: kwh mwh therm mmbtu gallon cubic_meter litre kilogram pound ton tonne cubic_yard other

external_ref

Invoice-line id (idempotency anchor)

string

kind

required

USALI Schedule 9 account

string

Allowed values: electricity natural_gas fuel_oil propane steam chilled_water renewable_electricity water sewer waste_landfill waste_recycling waste_organics waste_hazardous contract_services other

period_end

Billing-period end (optional)

string format: date

period_start

Billing-period start (optional)

string format: date

source

Provenance (defaults to `invoice_import`)

string

Allowed values: invoice_import manual

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

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.