Read Folio routing rule

GET

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

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

Read an existing instance.

Structured contractual logic for routing charges between folios. Encodes ‘route all charges except telephone to the master folio at 50% capped at $500/day’ shapes that every group / corporate / negotiated contract expresses. The folio handler walks active rules at charge post-time and applies the matching one — lowest priority number wins; ties broken by effective_from.

Authorizations

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

properties

required

object

applies_to

required

Applies to

string

Allowed values: all charge_codes charge_categories percentage capped_amount

cap_amount

Folio routing rule cap amount

Cap on routed total (applies_to = capped_amount)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

charge_category_filter

Charge category filter (applies_to = charge_categories)

Array<string>

Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail

charge_code_filter

Charge code filter (applies_to = charge_codes)

Array<string>

effective_from

required

Effective from

string format: date

effective_to

Effective to

string format: date

required

Rule id

string

percentage

Routed fraction (applies_to = percentage)

string format: decimal

priority

required

Rule priority (lower evaluates first)

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_routing_rule",
  "properties": {
    "applies_to": "all",
    "charge_category_filter": [
      "rooms"
    ]
  },
  "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).