Read Folio

GET

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

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

Read an existing instance.

The accounting ledger for a stay. Holds charges and payments; closes when the guest checks out and the balance is zero.

Authorizations

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

properties

required

object

ar_aging_bucket

A/R aging bucket (projection)

string

Allowed values: current 30_days 60_days 90_days 120_plus

ar_transferred_at

When folio settled to company A/R

string format: date-time

balance

required

Folio balance

Outstanding balance

object

amount

required

string format: decimal

currency

required

string format: iso-4217

balance_forward

Folio balance forward

Balance brought forward onto the ledger

object

amount

required

string format: decimal

currency

required

string format: iso-4217

closed_at

Closed at

string format: date-time

due_at

Payment due at

string format: date-time

external_invoice_number

Operator-facing invoice number

string

kind

required

Folio kind

string

Allowed values: guest master group_master company_ar house comp rebate

number

required

Folio number

string

opened_at

required

Opened at

string format: date-time

reopened_at

Reopened at

string format: date-time

status

required

Folio status

string

Allowed values: open closed void

window_number

required

Window number (1..=8)

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.folio",
  "properties": {
    "ar_aging_bucket": "current",
    "kind": "guest",
    "status": "open"
  },
  "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).