Skip to content
aerandil.com
GitHub

Read Charge

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

Read an existing instance.

A line item posted to a folio. Carries a USALI 12 bucket (the operated department revenue rolls up to) plus either a charge_for_service_item link (when posted against the service catalog) or a system_charge_kind enum (when the charge is system-generated — a room night, tax line, service charge, gratuity, adjustment, package discount).

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.charge
properties
required
object
amount
required
Charge amount

Amount

object
amount
required
string format: decimal
currency
required
string format: iso-4217
bucket
required
USALI 12 department
string
Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail
description
required
Description
string
device_ref
The device a key-card tap was made at (set by `post_charge_by_credential`)
string format: uuid
external_ref
Source-system key for connector-landed charges
string
gratuity
required
Charge gratuity

Gratuity

object
amount
required
string format: decimal
currency
required
string format: iso-4217
id
required
Charge id
string
outlet_id
required
USALI 12 operated department (Schedule 3 or 4) the charge rolls up to. A synthetic `miscellaneous_income`-bucket outlet per property covers genuinely non-department revenue (interest, cancellation fees, lost-key charges).
string format: uuid
package_attribution_kind
Package-attribution kind
string
Allowed values: component_full_price component_allocated_price package_discount_adjustment
posted_at
required
Posted at
string format: date-time
revenue_category
F&B revenue category

What an F&B posting sold (food / soft drinks / alcohol / other), for a charge a room-charged check posted — one per category on the check. Absent on every other charge.

string
Allowed values: food non_alcoholic_beverage alcoholic_beverage other
signed_by
The guest who signed for it

The guest who signed for a posting made at an outlet — the guest the server confirmed on the booking’s bill — so the bill says who signed. Set by a room-charged F&B payment that named its guest; absent otherwise.

string format: uuid
system_charge_kind
System-generated charge kind
string
Allowed values: room_night day_use tax service_charge gratuity adjustment package_discount forfeited_deposit no_show_fee cancellation_fee no_show_revenue
tax
required
Charge tax

Tax

object
amount
required
string format: decimal
currency
required
string format: iso-4217
transferred_from_folio_id
Folio this charge was transferred from, when it did not originate on the folio it currently sits on.
string format: uuid
voided
required
Voided
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.charge",
  "properties": {
    "bucket": "rooms",
    "package_attribution_kind": "component_full_price",
    "revenue_category": "food",
    "system_charge_kind": "room_night"
  },
  "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).