Read No-show posting rule

GET

/v1/object-types/hospitality.no_show_posting_rule/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.no_show_posting_rule/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

One property’s no-show posting rule for one reservation guarantee (OPERA’s Post Revenue To No Shows): when the night audit marks a booking of that guarantee a no-show, it posts all_nights (every booked night’s rate, as booked), first_night (the first night of every room), deposit_only (forfeits the deposit the house holds, nothing when it holds none) or none. Postings land on the booking’s own account through the posting verbs, attributed to the rule’s outlet_id; a deposit already on that account offsets them. A rule with no guarantee is the house default for every guarantee without a rule of its own; a house with no rule posts nothing. A booking a rule covers is posted by the rule alone — the frozen cancellation-policy fee step (post_no_show_fees) skips it, so one no-show is posted once.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.no_show_posting_rule:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.no_show_posting_rule

properties

required

object

active

required

Whether the night audit applies this rule

boolean

basis

required

What the audit posts for a no-show this rule covers

string

Allowed values: all_nights first_night deposit_only none

description

Operator-facing description

string

guarantee

The reservation guarantee this rule is for; absent = the house default for any guarantee without a rule of its own

string

Allowed values: none hold credit_card deposit prepaid corporate_billed voucher

required

No-show posting rule id

string

outlet_id

The outlet every posting is attributed to (OPERA's single no-show posting transaction code); required unless the basis is `none`

string format: uuid

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.no_show_posting_rule",
  "properties": {
    "basis": "all_nights",
    "guarantee": "none"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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