v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Get Ledger Account Category

get/ledger_account_categories/{id}

Path parameters

idstring required

The ID of the ledger account category

Query parameters

balancesstring

For example, if you want the balances as of a particular time (ISO8601), the encoded query string would be balances%5Beffective_at%5D=2000-12-31T12:00:00Z. The balances as of a time are inclusive of entries with that exact time, but with respect to the ledger accounts that are currently present in the category.

Response

200

idstring

objectstring

live_modeboolean

namestring

ledger_idstring

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

normal_balancestring

metadataobject

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

created_atstring

updated_atstring

Example response

{
  "id": "ac665222-02ef-47da-a7bd-376ba0e882ed",
  "object": "ledger_account_category",
  "name": "Customer Accounts",
  "ledger_id": "fe96565f-4b9c-4871-8fb0-e6f02683458e",
  "normal_balance": "credit",
  "balances": {
    "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-01T21:34:13Z",
  "updated_at": "2022-11-01T21:34:13Z"
}