Skip to content
aerandil.com
GitHub

Validate Settle check (dry-run)

POST
/v1/actions/hospitality.action.settle_check/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.settle_check/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "authorised_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "credential_token": "example", "folio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "gratuity": { "amount": "example", "currency": "example" }, "guest_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "override_reason": "example", "reservation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "settled_at": "2026-04-15T12:00:00Z", "settlement_reference": "example", "tender": "room_charge" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.guest_check" } }'

Dry-run of apply_hospitality_action_settle_check’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

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
authorised_by
Confirms the overriding manager (optional; with override_reason): must be the staff member signed in — the override's authoriser is always the session's own, never one named here
string format: uuid
credential_token
The tapped room key's token (required for charge_to_key)
string
folio_id
Folio to receive the room charge (required for room_charge)
string format: uuid
gratuity
Gratuity — the payment's tip
object
amount
required
string format: decimal
currency
required
string format: iso-4217
guest_id
The guest who signed for a room charge — the reservation's guest
string format: uuid
override_reason
Override the stay's no-post or credit refusal, and why (room_charge and charge_to_key) — taken under a manager's own session: an F&B manager, a front-office supervisor, the manager on duty, the general manager or the owner, active at the check's house
string
reservation_id
The reservation the room-charge folio is a window of (required for room_charge)
string format: uuid
settled_at
When the check settled — business time, not record time (defaults to now)
string format: date-time
settlement_reference
The processor's reference for the tender (the payment's psp_reference)
string
tender
Settlement tender (required unless nothing is due)
string
Allowed values: room_charge cash card comp external charge_to_key
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.guest_check

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}