Skip to content

What-if Record work order entry (rollup delta)

POST
/v1/actions/hospitality.action.record_work_order_entry/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_work_order_entry/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "delegated_to_role": "front_office_agent", "kind": "note", "materials": [ { "description": "example", "material_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": "example", "store_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "unit": "example" } ], "minutes_spent": 1, "recorded_at": "2026-04-15T12:00:00Z", "text": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.work_order" } }'

What-if projection of apply_hospitality_action_record_work_order_entry — 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_work_order_entry:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

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
delegated_to_role
The role the order is handed to (required for a delegation)
string
Allowed values: front_office_agent front_office_supervisor concierge bell housekeeper housekeeping_supervisor engineer food_beverage_server food_beverage_manager chef spa_therapist spa_manager reservations_agent revenue_manager sales_manager manager_on_duty general_manager owner other runner
kind
required
note, work, material, or delegation
string
Allowed values: note work material delegation
materials
Materials
Array<object>
object
description
string
material_id
string format: uuid
quantity
required
string format: decimal
store_id
string format: uuid
unit
string
minutes_spent
Time spent, in minutes (required for a work line; 0 to 10080)
integer
recorded_at
When the line was written (defaults to now; a handset queueing offline sends its own time; refused when more than five minutes ahead of the kernel's clock)
string format: date-time
text
The words on the line (required for a note)
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.work_order

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"
}
]
}
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

Validation error — the apply would be rejected.