Skip to content
aerandil.com
GitHub

Validate Set deposit policy (dry-run)

POST
/v1/actions/hospitality.action.set_deposit_policy/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_deposit_policy/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "auto_cancel_on_lapse": true, "basis": "flat", "code": "example", "description": "example", "due_basis": "days_after_booking", "due_days": 1, "effective_from": "2026-04-15", "effective_to": "2026-04-15", "flat_amount": { "amount": "example", "currency": "example" }, "nights": 1, "rate": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Dry-run of apply_hospitality_action_set_deposit_policy’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
auto_cancel_on_lapse
required
End of Day cancels an unpaid lapsed booking (true) or only records the lapse (false)
boolean
basis
required
How the required deposit computes
string
Allowed values: flat percent_of_stay percent_of_first_night nights
code
required
Policy code — the rule's identity within the property
string
description
Operator-facing description
string
due_basis
required
Which anchor the due date is measured from
string
Allowed values: days_after_booking days_before_arrival
due_days
required
Day offset from the due anchor (>= 0)
integer
effective_from
required
First booking date the policy applies (inclusive)
string format: date
effective_to
Last booking date the policy applies (inclusive); omit for open-ended
string format: date
flat_amount
Amount for the flat basis
object
amount
required
string format: decimal
currency
required
string format: iso-4217
nights
Night count for the nights basis
integer
rate
Rate for the percent bases (decimal in [0, 1]; 0.50 = 50%)
string format: decimal
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.property

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