Skip to content
aerandil.com
GitHub

Validate Submit owner statement (dry-run)

POST
/v1/actions/hospitality.action.submit_owner_statement/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.submit_owner_statement/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "base_fee": { "amount": "example", "currency": "example" }, "due_by": "2026-04-15", "external_ref": "example", "gop": { "amount": "example", "currency": "example" }, "incentive_fee": { "amount": "example", "currency": "example" }, "noi": { "amount": "example", "currency": "example" }, "period_end": "2026-04-15", "period_start": "2026-04-15", "revision": 1, "submitted_at": "2026-04-15T12:00:00Z", "total_revenue": { "amount": "example", "currency": "example" }, "variance_snapshot": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Dry-run of apply_hospitality_action_submit_owner_statement’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
base_fee
required
Base management fee for the period
object
amount
required
string format: decimal
currency
required
string format: iso-4217
due_by
required
Contractual delivery deadline
string format: date
external_ref
Idempotency anchor
string
gop
required
Gross operating profit (pre-management-fee)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
incentive_fee
Incentive fee for the period (accrual or true-up)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
noi
required
Net operating income for the period
object
amount
required
string format: decimal
currency
required
string format: iso-4217
period_end
required
Reporting-period end
string format: date
period_start
required
Reporting-period start
string format: date
revision
Revision number (defaults to 1)
integer
submitted_at
When the operator submitted — business time, not record time (defaults to now)
string format: date-time
total_revenue
required
Total operating revenue for the period
object
amount
required
string format: decimal
currency
required
string format: iso-4217
variance_snapshot
Budget-vs-actual-vs-prior-year comparison, JSON
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"
}