Skip to content
aerandil.com
GitHub

Validate Post external charge (dry-run)

POST
/v1/actions/hospitality.action.post_external_charge/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.post_external_charge/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "bucket": "rooms", "description": "example", "external_ref": "example", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "posted_at": "2026-04-15T12:00:00Z", "reservation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reservation_room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "system_charge_kind": "room_night", "window_number": 1 }, "return_modified": false }'

Dry-run of apply_hospitality_action_post_external_charge’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
amount
required
Amount
object
amount
required
string format: decimal
currency
required
string format: iso-4217
bucket
required
USALI 12 department
string
Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail
description
required
Description
string
external_ref
Source-system key (makes the post replay-safe)
string
outlet_id
Outlet (omit to resolve the property's sole outlet in `bucket`)
string format: uuid
posted_at
Posting instant in the source system (defaults to now)
string format: date-time
reservation_id
required
Reservation whose stay folio receives the charge
string format: uuid
reservation_room_id
Leg whose stay folio receives the charge (required when the reservation has more than one stay)
string format: uuid
system_charge_kind
System-generated charge kind
string
Allowed values: room_night day_use tax service_charge gratuity adjustment package_discount forfeited_deposit no_show_fee cancellation_fee no_show_revenue
window_number
Folio window (defaults to 1)
integer
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”

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"
}