Skip to main content
GET
/
api
/
accounts
/
types
Retrieves the account types.
curl --request GET \
  --url https://api.example.com/api/accounts/types \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
[
  {
    "label": "Cash",
    "key": "cash",
    "normal": "debit",
    "parentType": "current-asset",
    "rootType": "asset",
    "multiCurrency": true,
    "balanceSheet": true,
    "incomeSheet": false
  }
]

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The account types have been successfully retrieved.

​
label
string
required

The display label for the account type

Example:

"Cash"

​
key
string
required

The unique key for the account type

Example:

"cash"

​
normal
string
required

The normal balance type for the account

Example:

"debit"

​
parentType
string
required

The parent type of the account

Example:

"current-asset"

​
rootType
string
required

The root type of the account

Example:

"asset"

​
multiCurrency
boolean
required

Whether the account type supports multiple currencies

Example:

true

​
balanceSheet
boolean
required

Whether the account type appears on the balance sheet

Example:

true

​
incomeSheet
boolean
required

Whether the account type appears on the income sheet

Example:

false