Skip to content
aerandil.com
GitHub

Validate Bind commission agreement (dry-run)

POST
/v1/actions/hospitality.action.bind_commission_agreement/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.bind_commission_agreement/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "commission_flat_amount": { "amount": "example", "currency": "example" }, "commission_kind": "percent_of_revenue", "commission_rate": "example", "company_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "effective_from": "2026-04-15", "minimum_payment_amount": { "amount": "example", "currency": "example" }, "notes": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "tax_treatment": "standard" }, "return_modified": false }'

Dry-run of apply_hospitality_action_bind_commission_agreement’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
commission_flat_amount
Per-booking flat commission
object
amount
required
string format: decimal
currency
required
string format: iso-4217
commission_kind
required
Commission kind
string
Allowed values: percent_of_revenue per_booking_flat per_booking_plus_percent none
commission_rate
Decimal share of commissionable revenue
string format: decimal
company_id
required
The agent, tour operator, wholesaler or consortium
string format: uuid
effective_from
required
First date the terms apply
string format: date
minimum_payment_amount
Do not pay this agent below this amount
object
amount
required
string format: decimal
currency
required
string format: iso-4217
notes
Contract notes
string
property_id
required
Property the terms apply at
string format: uuid
tax_treatment
VAT posture of this agent's commission
string
Allowed values: standard reverse_charge exempt
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"
}