Skip to content
aerandil.com
GitHub

Read Night audit run

GET
/v1/object-types/hospitality.night_audit_run/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.night_audit_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A single execution of the night audit cycle for one business date. Results are immutable on completion; re-runs create a new NightAuditRun. The status enum tracks lifecycle so a stuck or partial run is visible.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.night_audit_run
properties
required
object
block_rooms_released
Group-block room-nights the cutoff sweep returned to the house
integer
business_date
required
Business date
string format: date
commission_details_accrued
Commission rows the run accrued on stays that completed
integer
completed_at
Completed at
string format: date-time
deposit_lapse_cancellations
Lapsed unpaid deposits the sweep auto-cancelled per policy
integer
deposit_lapses_flagged
Deposit lapses recorded for operator disposition
integer
exception_count
Exception count
integer
holds_released
Expired courtesy holds the deposit sweep cancelled
integer
id
required
Run id
string
open_cashier_sessions
Cashier sessions still open at the close (exception, never a gate)
integer
package_adjustments_posted
Unconsumed package allowances the run settled as profit
integer
payment_cards_expired
Cards on file the run marked `expired` — active cards whose expiry month ended before the audited date
integer
payment_requests_expired
Payment requests the run expired — pending requests whose `expires_at` fell on or before the audited date (absent when none)
integer
posted_room_revenue
Night audit run posted room revenue

Posted room revenue

object
amount
required
string format: decimal
currency
required
string format: iso-4217
posted_room_tax
Night audit run posted room tax

Tax the run derived and posted alongside the room charges (inclusive and exclusive lines alike); absent when the posting spanned currencies

object
amount
required
string format: decimal
currency
required
string format: iso-4217
started_at
required
Started at
string format: date-time
status
required
Status
string
Allowed values: in_progress completed failed rolled_back
visitor_keys_stripped
Visitor keys the run stripped from offers, turnaways and reservations whose arrival night was past the property's grace
integer
waitlist_entries_expired
Waitlist entries the run aged out (departure + 2 business days)
integer
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.night_audit_run",
  "properties": {
    "status": "in_progress"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).