Read Deposit policy

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.deposit_policy/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.deposit_policy/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One property-authored deposit rule: how much of the stay is due as an advance deposit (flat / percent of stay / percent of first night / nights), when it falls due (days after booking or days before arrival), whether an unpaid deposit auto-cancels the reservation at End of Day, and an effective-date window. Reservation creation derives deposit_required_amount / deposit_due_at from the rule active on the booking date and freezes the ref; rules sharing a code form a non-overlapping succession timeline.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.deposit_policy: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.deposit_policy

properties

required

object

auto_cancel_on_lapse

required

Whether the night audit cancels a reservation whose deposit is still unpaid past the due date (OPERA's reservation-type auto-cancel flag). When false the sweep records the lapse and leaves the booking for the operator

boolean

basis

required

How the required deposit computes

string

Allowed values: flat percent_of_stay percent_of_first_night nights

code

required

Policy code — the rule's identity within the property; rules sharing a code form one succession timeline

string

description

Operator-facing description

string

due_basis

required

Which anchor the due date is measured from

string

Allowed values: days_after_booking days_before_arrival

due_days

required

Day offset from the due anchor (>= 0)

integer

effective_from

required

First booking date the rule applies (inclusive)

string format: date

effective_to

Last booking date the rule applies (inclusive); absent = open-ended

string format: date

flat_amount

Deposit policy flat amount

Amount for the flat basis. Required on flat, forbidden otherwise

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Deposit policy id

string

nights

Night count for the `nights` basis (deposit = that many nights at the quoted rate). Required on nights, forbidden otherwise

integer

rate

Rate for the percent bases (decimal in [0, 1]; 0.50 = 50%). Required on percent bases, forbidden otherwise

string format: decimal

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.deposit_policy",
  "properties": {
    "basis": "flat",
    "due_basis": "days_after_booking"
  },
  "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).