Ledger Account Categories

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 string	The name of the ledger account category.
description string	An optional free-form description for internal use.
currency string	The currency in which all associated ledger accounts are denominated, e.g. "usd". Can be an ISO currency code or any user-defined currency name. See Custom Currencies. Defaults to the ledger's currency.
currency_exponent int32	If a non-ISO `currency` is provided, `currency_exponent` denotes how many decimal places should be displayed for this currency.
ledger_id string	The ID of the ledger this category belongs to.
normal_balance string	One of `credit`, `debit`. This value is used to calculate the balance amount fields. If the value is `credit`, then the amount will be equal to `credits` - `debits`. If the value is `debit`, then the amount will be `debits` - `credits`.
balances object	The sum of all pending and posted balances for ledger accounts in this category. The posted balance is the sum of all posted entries on the accounts. The pending balance is the sum of all pending and posted entries on the accounts.
metadata object	Additional data represented as key-value pairs.
live_mode boolean	This field will be true if this object was created with a production API key or false if created with a test API key.

{
    "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"
      },
      "posted_balance": {
        "credits": 20000,
        "debits": 0,
        "amount": 20000,
        "currency": "USD"
      }
    },
    "metadata": {},
    "live_mode": true,
    "created_at": "2020-08-04T16:54:32Z",
    "updated_at": "2020-08-04T16:54:32Z"
}