Read Platform ledger line

GET

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

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

Read an existing instance.

One balance transaction on the platform’s own processor balance (Stripe’s txn_…) that belongs to a hotel’s merchant account: the platform charge a destination payment was made with (and Stripe’s processing fee on it), the transfer that carried the hotel’s share, the application fee the platform earned, a refund and the reversal that recovered it, a chargeback’s withdrawal and what was passed back. Filed at the house the account is for, matched when it resolves to a ledger payment or case. Append-only; a line read again may gain a match it could not make before. The platform’s lines no hotel owns (its own payouts, Stripe’s fees on the platform and the tax on them, a reserve, a charge for an account no merchant account holds) are filed at the tenant scope of the operator’s own tenant, with no merchant account, never matched, their day the processor’s UTC day.

Authorizations

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

properties

required

object

amount

required

Platform ledger line amount

Gross on the platform’s balance, as the processor states it (negative for money out — a transfer to the hotel, a chargeback)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

available_on

The day the line's money became available on the platform's balance

string format: date

dispute_id

The chargeback the line moved money for (its object id) — the platform_ledger_line_for_dispute edge's target

string

dispute_leg

What the line did for its chargeback: the network's withdrawal or reinstatement, the amount or fee recovered from the hotel, money returned to the hotel after a late win

string

Allowed values: withdrawal reinstatement amount_recovered fee_recovered returned_to_hotel

fee

Platform ledger line fee

The processor’s fee on the line, charged to the platform

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Platform ledger line id

string

line_type

The processor's own transaction type (`charge`, `transfer`, `application_fee`, `transfer_refund`, `adjustment`, …)

string

matched

required

Whether the line resolved to a ledger payment or chargeback

boolean

merchant_account_id

The hotel's merchant account the line was for (its object id) — the platform_ledger_line_for_merchant_account edge's target; absent on the platform's own line, which no hotel owns

string

net

Platform ledger line net

Gross less fee — what the line did to the platform’s balance

object

amount

required

string format: decimal

currency

required

string format: iso-4217

occurred_at

required

When the processor created the balance transaction

string format: date-time

occurred_on

required

The house's calendar day the line counts in — the processor's creation instant in the house's own timezone, the close's rule for a card payment's day; computed when the line is recorded

string format: date

payment_id

The ledger payment the line came from (its object id) — the platform_ledger_line_for_payment edge's target

string

processor_account_reference

On the platform's own line: the connected account (`acct_…`) the processor named for it when no merchant account on the ledger holds that account — what the operator looks up to place it

string

property_id

The house the account is for (its object id); absent on the platform's own line

string

psp_reference

required

The processor's id for the balance transaction on the platform's balance (Stripe `txn_…`) — the replay key

string

reporting_category

required

The processor's reporting category for the line, verbatim (`platform_earning` is an application fee; `other` when the processor named one this ledger does not know)

string

Allowed values: charge refund partial_capture_reversal dispute dispute_reversal transfer transfer_reversal platform_earning platform_earning_refund fee connect_reserved_funds connect_collection_transfer payout payout_reversal other_adjustment other tax risk_reserved_funds refund_failure topup topup_reversal

source_reference

The processor object the money moved for (`ch_…`, `tr_…`, `trr_…`, `fee_…`, `fr_…`, `re_…`, `du_…`, `py_…`)

string

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.platform_ledger_line",
  "properties": {
    "dispute_leg": "withdrawal",
    "reporting_category": "charge"
  },
  "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).