Skip to content
aerandil.com
GitHub

Validate Run night audit (dry-run)

POST
/v1/actions/hospitality.action.run_night_audit/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.run_night_audit/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "accrue_commission": true, "balance_packages": true, "business_date": "2026-04-15", "enforce_deposits": true, "expire_waitlist": true, "open_next": true, "post_no_show_fees": true, "post_room_and_tax": true, "release_block_cutoffs": true, "retire_expired_cards": true, "strip_visitor_keys": true, "sweep_no_shows": true }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Dry-run of apply_hospitality_action_run_night_audit’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
accrue_commission
Accrue travel-agent and channel commission on stays that completed today (defaults to true)
boolean
balance_packages
Settle unconsumed package allowances due on the closing date as profit (defaults to true)
boolean
business_date
required
Business date
string format: date
enforce_deposits
Cancel expired courtesy holds and lapsed wholly-unpaid deposits whose frozen policy says auto-cancel; record other lapses for the operator (defaults to true)
boolean
expire_waitlist
Age out waitlist entries two business days past their requested departure (defaults to true)
boolean
open_next
Open the next business date after closing this one (defaults to true)
boolean
post_no_show_fees
Assess and post the cancellation policy's no-show fee for reservations swept to no_show (defaults to FALSE — posting revenue to no-shows is a policy decision, not a default)
boolean
post_room_and_tax
Post the night's room charges to in-house folios (defaults to true)
boolean
release_block_cutoffs
Release group-block rooms nobody picked up, per each block's cutoff mode (defaults to true)
boolean
retire_expired_cards
Mark cards on file whose expiry month has passed as `expired`, so nothing offers a guarantee the issuer will decline (defaults to true)
boolean
strip_visitor_keys
Strip the visitor key from offers, turnaways and reservations whose arrival night is past the property's grace (defaults to true)
boolean
sweep_no_shows
Sweep unresolved arrivals to no_show (defaults to true)
boolean
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"
}