Skip to content
aerandil.com
GitHub

What-if Register device (rollup delta)

POST
/v1/actions/hospitality.action.register_device/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.register_device/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "code": "example", "kind": "payment_terminal", "name": "example", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "print_secret_hash": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "vendor": "example", "vendor_device_ref": "example" }, "return_modified": false }'

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
code
required
Device code
string
kind
required
Hardware kind
string
Allowed values: payment_terminal key_encoder door_lock kiosk printer handset other
name
required
Device name
string
outlet_id
Revenue center the device serves (payment terminals)
string format: uuid
print_secret_hash
A printer's poll credential: the lowercase hex SHA-256 (64 characters) of the secret its Server Direct Print settings carry — never the secret itself. Printers only.
string
property_id
required
Property where the hardware lives
string format: uuid
vendor
Hardware / acquirer vendor
string
vendor_device_ref
Vendor-side device identifier
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

Responses

Section titled “Responses”

200

Section titled “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
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"
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Section titled “422”

Validation error — the apply would be rejected.