Get ledger by ID

Returns a single ledger.

get/api/ledgers/{id}

Request

Base URL: http://localhost:4100
URL: http://localhost:4100/api/ledgers/{id}
Auth: none required

Path parameters

idstring uuid required

Ledger ID

Response

Ledger

account_holder_idstring uuid required

currencystring required

ISO 4217 three-letter currency code (e.g. USD). Authoritative for the entire ledger hierarchy.

idstring uuid

inserted_atstring date-time

ledger_numberstring nullable

Opaque external SoE identifier (upsert identity)

status'active' | 'closed' nullable

tenant_idstring uuid

updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "currency": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "ledger_number": "",
  "status": "active",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.