Skip to content
aerandil.com
GitHub

Read Stay

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

Read an existing instance.

The execution of a reservation: the actual arrival, room assignment, in-house period, and departure. Charges and payments hang off the stay’s folio.

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.stay
properties
required
object
arrival_actual
Actual arrival
string format: date-time
credit_limit
Stay credit limit

The most the desk lets the stay’s bill reach, the room still to come included — OPERA’s credit limit set for the guest’s payment method. A till’s posting is held to the greater of this and what the stay’s live card holds hold, less the bills’ balance and the room still due; over it the posting is refused (no_credit) unless a manager overrides. With neither a limit nor a hold, no credit rule applies. Set by the desk with set_posting_rules.

object
amount
required
string format: decimal
currency
required
string format: iso-4217
departure_actual
Actual departure
string format: date-time
green_stay
The guest declined the day's clean for sustainability — while set, generate_housekeeping_tasks mints no stayover clean for the room (a shared room only when every guest in it declined)
boolean
green_stay_set_at
When the green stay was set (present while green_stay is true)
string format: date-time
hold_top_up_attempt
The card rail's open top-up attempt — the id its processor keys are derived from; cleared when the attempt is recorded
string
hold_top_up_attempt_amount
Stay hold top up attempt amount

What the open top-up attempt holds (or, for a credit-limit charge, holds afresh)

object
amount
required
string format: decimal
currency
required
string format: iso-4217
hold_top_up_attempt_capture
Stay hold top up attempt capture

What an open credit-limit charge takes from the holds

object
amount
required
string format: decimal
currency
required
string format: iso-4217
hold_top_up_attempt_holds
The holds the open attempt acts on, largest first: those a credit-limit charge takes, or the hold whose card a top-up goes on
Array<string>
hold_top_up_attempt_kind
top_up (a second hold or an increment) or overage_charge
string
Allowed values: top_up overage_charge
hold_top_up_attempt_opened_at
When the open top-up attempt was written down; past 23 hours it is abandoned and a new one opened
string format: date-time
hold_top_up_last_at
When the last top-up was placed
string format: date-time
hold_top_up_refusal
Why the last top-up took nothing, until one takes something
string
Allowed values: card_declined insufficient_funds authentication_required no_consent no_card max_reached other_currency processor_refused attempt_abandoned
hold_top_up_refusal_balance
Stay hold top up refusal balance

The bill’s balance when that refusal was recorded

object
amount
required
string format: decimal
currency
required
string format: iso-4217
hold_top_up_refusal_detail
The processor's words for that refusal
string
hold_top_up_refused_at
When that refusal was recorded
string format: date-time
hold_top_ups
How many top-ups the card rail has placed for this stay
integer
id
required
Stay id
string
no_post
No outlet may post to the stay's bill

OPERA’s NOPOST: while true, a till’s room charge or charge-to-key to this stay is refused (no_post) unless a manager’s override is recorded on the payment. Set by the desk with set_posting_rules; unset reads as false.

boolean
post_stay_collection_amount
Stay post stay collection amount

What the open collection attempt asks for

object
amount
required
string format: decimal
currency
required
string format: iso-4217
post_stay_collection_attempt
The card rail's open collection attempt — the id its processor keys are derived from; cleared when the attempt is recorded
string
post_stay_refusal
Why the last post-stay collection took nothing, until one takes something
string
Allowed values: window_closed post_stay_charging_off authentication_required declined no_card
post_stay_refusal_balance
Stay post stay refusal balance

The bill’s balance when that refusal was recorded

object
amount
required
string format: decimal
currency
required
string format: iso-4217
post_stay_window
open while charges found after departure may still post; closed after
string
Allowed values: open closed
post_stay_window_closed_at
When the card rail closed the post-stay window
string format: date-time
post_stay_window_until
When the post-stay window closes — the house's midnight after the window's last business day
string format: date-time
room_assignment_status
required
Room assignment status
string
Allowed values: pending assigned occupied released
status
required
Stay state
string
Allowed values: not_arrived in_house checked_out no_show cancelled
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.stay",
  "properties": {
    "hold_top_up_attempt_kind": "top_up",
    "hold_top_up_refusal": "card_declined",
    "post_stay_refusal": "window_closed",
    "post_stay_window": "open",
    "room_assignment_status": "pending",
    "status": "not_arrived"
  },
  "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).