Skip to content
aerandil.com
GitHub

Read Property

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

Read an existing instance.

A single operated site — a hotel or resort, or a non-lodging business run on the same substrate (a standalone day spa). The property is the canonical home of most operational data and the anchor for local timezone, currency, and brand standards.

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.property
properties
required
object
address
Property address

Address

object
city
required
string
country
required
string
line1
required
string
line2
string
postal_code
string
region
string
billing_identity
Property billing identity

Who this property is, legally, on a document it issues. Absent until an operator fills it in, and issue_invoice refuses without it — a tax invoice with no supplier registration number is not one. Snapshotted onto every invoice at issue, so editing this never rewrites a document already handed over.

object
bank_account
object
account_name
string
account_number
string
bic
string
iban
string
sort_code
string
company_registration_number
string
contact_email
string
contact_phone
string
invoice_address
object
city
required
string
country
required
string
line1
required
string
line2
string
postal_code
string
region
string
invoice_issue_deadline_days
integer
invoice_number_prefix
string
payment_terms_days
integer
simplified_invoice_threshold
object
amount
required
string format: decimal
currency
required
string format: iso-4217
tax_registration_number
string
tax_registration_scheme
required
string
Allowed values: vat gst sales_tax none
business_date_opened_at
Open business date opened at

When the open business date was opened. A posting stamped before this instant belongs to an earlier day and is dated by the property-local calendar instead.

string format: date-time
code
required
Property code
string
credit_limit_overage
What the night audit does once a stay's bill reaches what its holds are for: off, hold the excess, or charge (set_credit_limit_overage; off unset)
string
Allowed values: off hold charge
default_currency
required
Default currency (ISO 4217)
string format: iso-4217
description
Description
string
fnb_open_checks_at_roll
What the night audit does with the outlets' checks still open on the day it closes: carry them on their own business date, or refuse the close (set_fnb_open_checks_policy; carry unset)
string
Allowed values: carry refuse
hold_top_up
Whether the night audit tops up an in-house stay's card hold as its bill grows (set_hold_top_up; off unset)
boolean
hold_top_up_interval_minutes
How often, in minutes, the card rail plans the house's in-house stays' top-ups between night audits (60 to 1440; 0 or unset: at the audit and on the desk's press only)
integer
hold_top_up_max_per_stay
The most top-ups the card rail places for one stay
integer
hold_top_up_threshold
Property hold top up threshold

The smallest excess worth a top-up — the bill less what is held plus the rule’s allowance

object
amount
required
string format: decimal
currency
required
string format: iso-4217
kind
required
Property kind
string
Allowed values: hotel resort residences serviced_apartments hostel glamping mixed_use day_spa restaurant
legal_name
Legal name
string
location
Geo location
object
lat
required
number
lon
required
number
name
required
Property name
string
open_business_date
Open business date

The business date this property has open — the hotel date a posting made now is dated to. Written by open_business_date and the night audit’s close; unset while no day is open.

string format: date
opened_on
Opened on
string format: date
payment_request_messaging
Send pay links to the guest

When true, a payment request’s pay link is sent to the booking’s guest — by email, or by SMS when the profile holds no email — as soon as the card rail has minted it. Unset: off, and the desk sends the link itself.

boolean
payment_request_reuse_terms
Pay page card terms

What the pay page tells the guest about keeping their card (Stripe’s submit-button text, at most 1,200 characters): that the house may charge it without them present, for what, when and how often, and how each amount is set — the terms Stripe requires for a merchant-initiated charge. Set with set_payment_request_messaging. Unset: the card rail’s default wording.

string
positioning
Market positioning
string
Allowed values: luxury upper_upscale upscale upper_midscale midscale economy boutique lifestyle
post_stay_charging_days
Post-stay charging window, in days (0 = off)

How many business days after departure a charge found later (the minibar, damage, laundry) may still be posted to the departed stay’s bill and taken from its card. On (1–14), check-out keeps the stay’s largest card hold and releases the rest, and the window closes at the house’s midnight after its last day — 1 is OPERA’s “until the end of the business date”. Off (0 or unset), check-out releases every hold. Set with set_post_stay_charging.

integer
request_soon_minutes
Minutes ahead within which a request reads as soon

How many minutes before its due time a housekeeping request reads as soon on the housekeeping_requests read (and on the handset’s card). Unset: 30. Between 1 and 720. Set through set_request_urgency_window.

integer
room_count
Total rooms
integer
sca_chase
Chase a guest whose bank asks them to confirm

When true, a charge or hold the card rail tried with the guest absent that the issuer will only complete with the cardholder sends the guest a page to confirm it on (email first, else SMS, under the service-message consent gate), reminds them before the deadline, and tells the house when the deadline passes. Unset: off — the state and its deadline are still recorded and the desk sends the page itself. Set with set_sca_chase.

boolean
sca_chase_hours
Hours the guest has to confirm

The house’s deadline for a pending authentication, in hours from the moment the issuer asked (1–168). Unset: 24.

integer
sca_chase_reminders
Reminders before the deadline

How many reminders go to the guest before the deadline, spread evenly across it (0–3; 1 is one at half-time). Unset: 1.

integer
standard_week_hours
Standard work week hours
string format: decimal
star_rating
Star rating
string format: decimal
timezone
required
IANA timezone
string
visitor_key_grace_days
Days past the arrival night a visitor key is kept

How many days past a stay’s arrival night the night audit keeps the booking engine’s visitor key on its offers, turnaways and reservation before stripping it; the records themselves stay. Unset: 30. At most 365.

integer
waitlist_claim_url_base
Where a waitlist claim link points

The start of the link a waitlist offer carries; the offer’s claim token is appended as a path segment. Point it at the kernel’s own claim page (https://<kernel>/v1/waitlist-claims/) or at a booking site that calls the claim route. An https URL ending in /, with no query or fragment (plain http only to a loopback dev host). Unset: the offer goes out without a link and asks the guest to call.

string
waitlist_offer_hold_minutes
Minutes a waitlist offer keeps its room-nights

How many minutes a waitlist offer — the desk’s or the matcher’s — keeps its room-nights before they are given back and offered to the next entry. Unset: 30. Between 1 and 1440 (OPERA’s room-hold range).

integer
waitlist_offer_messaging
Send waitlist offers to the guest

When true, every waitlist offer — the desk’s or the matcher’s — is sent to the guest by SMS (or email when the profile holds no phone), with a link to claim it. Unset: off.

boolean
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.property",
  "properties": {
    "billing_identity": {
      "tax_registration_scheme": "vat"
    },
    "credit_limit_overage": "off",
    "fnb_open_checks_at_roll": "carry",
    "kind": "hotel",
    "positioning": "luxury"
  },
  "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).