v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Get Ledger Entry

get/ledger_entries/{id}

Path parameters

idstring required

The ID of the ledger entry.

Query parameters

show_balancesboolean

If true, response will include the balances attached to the ledger entry. If there is no balance available, null will be returned instead.

Response

200

idstring

objectstring

live_modeboolean

amountinteger

directionstring

statusstring

ledger_account_idstring

ledger_account_currencystring

ledger_account_currency_exponentinteger

ledger_account_lock_versioninteger

ledger_transaction_idstring

{"stackTrail":"paths:/ledger_entries/{id}:get:responses:200:content:application/json:schema:properties:resulting_ledger_account_balances","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/ledger_entries/{id}:get:responses:200:content:application/json:schema:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "a3c45984-aa05-4554-8c7d-eee9a8053fac",
  "object": "ledger_entry",
  "amount": 100,
  "direction": "credit",
  "status": "pending",
  "ledger_account_id": "641e4d45-7fff-4e7e-ae05-1db2614b4a1e",
  "ledger_account_currency": "USD",
  "ledger_account_currency_exponent": 2,
  "ledger_account_lock_version": 3,
  "ledger_transaction_id": "7f973ee9-597c-46e3-bcf1-359e0115d560",
  "created_at": "2022-11-01T21:29:56Z",
  "updated_at": "2022-11-01T21:29:56Z"
}