v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Ledger Account Category

post/ledger_account_categories

Request body

namestring required

The name of the ledger account category. Maximum of 1000 characters allowed.

descriptionstring

An optional free-form description for internal use. Maximum of 1000 characters allowed.

normal_balancestring required

currencystring required

All accounts in the category must have this currency.

currency_exponentinteger

If a non-ISO currency is provided, currency_exponent denotes how many decimal places should be displayed for this currency. The currency_exponent cannot exceed 30.

ledger_idstring required

metadatastring json

ledger_account_category_idsstring[]

The array of parent ledger account category IDs to which this ledger account category will be added on creation. This is performed atomically, and all associations must be valid and succeed for the ledger account to be successfully created.

external_idstring

An optional user-defined 180 character unique identifier

Response

201

idstring

objectstring

live_modeboolean

namestring

ledger_idstring

{"stackTrail":"paths:/ledger_account_categories:post:responses:201:content:application/json:schema:properties:description","oasType":"schema","type":"unknown"}

normal_balancestring

metadataobject

{"stackTrail":"paths:/ledger_account_categories:post:responses:201: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"
}