A ledger_account_category
is a grouping of Ledger Accounts. Its balance is equal to the sum of the balances of all contained accounts. Ledger Account Categories can also contain other categories, which enables the creation of nested hierarchies.
Related guide: Nesting ledger accounts
Attribute | Description |
---|---|
id string | Unique identifier for the ledger account category. |
name | The name of the ledger account category. |
description | An optional free-form description for internal use. |
ledger_id | The ID of the ledger this category belongs to. |
normal_balance | One of This value is used to calculate the balance amount fields. If the value is |
balances | The pending, posted, and available balances for the ledger account category. See Ledger Balances for more details. |
metadata | Additional data represented as key-value pairs. |
live_mode | This field will be true if this object was created with a production API key or false if created with a test API key. |
external_id | An optional user-defined 180 character unique identifier |
created_at | The datetime that the ledger account category was created. |
updated_at | The datetime of the last update to the ledger account category. |
{
"id": "f1c7e474-e6d5-4741-9f76-04510c8b6d7a",
"object": "ledger_account_category",
"name": "Combined View",
"ledger_id": "a9d970da-207e-43da-b4d6-6e9ae01ba2cc",
"description": null,
"normal_balance": "credit",
"balances": {
"pending_balance": {
"credits": 50000,
"debits": 0,
"amount": 50000,
"currency": "USD",
"currency_exponent": 2
},
"posted_balance": {
"credits": 20000,
"debits": 0,
"amount": 20000,
"currency": "USD",
"currency_exponent": 2
},
"available_balance": {
"credits": 20000,
"debits": 0,
"amount": 20000,
"currency": "USD",
"currency_exponent": 2
}
},
"metadata": {},
"external_id": null,
"live_mode": true,
"created_at": "2020-08-04T16:54:32Z",
"updated_at": "2020-08-04T16:54:32Z"
}