Account types
The vocabulary an account is typed with. Every statement section and every totals row is built from these names, so a caller reads them before it maps an account.
The endpoint
| Method | Path | Answers |
|---|---|---|
| GET | /api/v1/account-types | Every system account type |
Needs a bearer token and the reference.read scope.
What it answers
{
"data": [
{ "name": "BANK", "class": "ASSET", "normal_side": "debit", "statement": "balance_sheet" },
{ "name": "REVENUE", "class": "REVENUE", "normal_side": "credit", "statement": "profit_loss" },
{ "name": "OTHER EXPENSE", "class": "EXPENSE", "normal_side": "debit", "statement": "profit_loss" }
],
"page": 1, "per_page": 50, "total": 22, "has_more": false
}
| Field | What it says |
|---|---|
name | The type, as an account states it. It is the list a write accepts. |
class | The type's class: ASSET, LIABILITY,
EQUITY, REVENUE or EXPENSE. The consolidation-only
NCI ALLOCATION type carries its own class name, and is answered like the rest because a
caller may map an account to it. |
normal_side | debit or credit: the side a positive
balance sits on. An expense account is debit; a revenue account is
credit. |
statement | profit_loss or balance_sheet: the statement
the type is reported in. |