Skip to content

What-if Record checkpoint (rollup delta)

POST
/v1/actions/hospitality.action.record_checkpoint/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_checkpoint/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "completed_at": "2026-04-15T12:00:00Z", "items": [ { "code": "example", "ok": true, "text": "example", "value": "example" } ], "observations": "example", "position": 1, "raise_fault": { "area_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "category": "hvac", "description": "example", "room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "severity": "cosmetic", "title": "example" }, "result_id": "example", "started_at": "2026-04-15T12:00:00Z" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.inspection_round" } }'

What-if projection of apply_hospitality_action_record_checkpoint — 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_checkpoint: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
completed_at
When the checkpoint was finished (defaults to now)
string format: date-time
items
required
Checkpoint answers
Array<object>
object
code
required
string
ok
boolean
text
string
value
string format: decimal
observations
What the walker noticed at the checkpoint
string
position
required
The checkpoint's position in the round
integer
raise_fault
Checkpoint fault
object
area_id
string format: uuid
category
required
string
Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other
description
string
room_id
string format: uuid
severity
required
string
Allowed values: cosmetic minor major blocking safety
title
required
string
result_id
The result's id, minted by the walker (a v4 or v7 UUID)
string
started_at
When the walker began the checkpoint
string format: date-time
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.inspection_round

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.