v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Get Ledger Account

get/ledger_accounts/{id}

Path parameters

idstring required

The ID of the ledger account. Modern Treasury provided IDs or External IDs are accepted.

Query parameters

balances[effective_at_lower_bound]string date-time

Use balances[effective_at_lower_bound] to set the lower bound timestamp for which the retrieved balance is set. The returned balance will be inclusive of the provided timestamp.

balances[effective_at_upper_bound]string date-time

Use balances[effective_at_upper_bound] to set the upper bound timestamp for which the retrieved balance is set. The returned balance will be exclusive of the provided timestamp. Any balances[as_of_date] or balances[effective_at] will be translated into balances[effective_at_upper_bound].

balances[as_of_lock_version]integer

Use balances[as_of_lock_version] to retrieve the balance of the ledger account at the specified lock version. If there is no balance associated with the provided lock version a 422 is returned. Note: You cannot query as of a lock version and with effective_at timestamps.

Response

200

idstring

objectstring

live_modeboolean

namestring

ledger_idstring

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

lock_versioninteger

normal_balancestring

metadataobject

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

created_atstring

updated_atstring

Example response

{
  "id": "690eed62-5b6c-45ee-a474-f54905133866",
  "object": "ledger_account",
  "name": "Operating Bank Account",
  "ledger_id": "fe96565f-4b9c-4871-8fb0-e6f02683458e",
  "normal_balance": "debit",
  "balances": {
    "effective_at_lower_bound": "2020-08-04T16:54:32Z",
    "effective_at_upper_bound": "2021-08-04T16:54:32Z",
    "pending_balance": {
      "currency": "USD",
      "currency_exponent": 2
    },
    "posted_balance": {
      "currency": "USD",
      "currency_exponent": 2
    },
    "available_balance": {
      "currency": "USD",
      "currency_exponent": 2
    }
  },
  "created_at": "2022-11-01T20:57:31Z",
  "updated_at": "2022-11-01T20:57:31Z"
}