finov.ioDocumentationHome

List account categories

API Documentation / Resources / Accounts and settings

Finovio chart of accounts showing header and posting accounts with categories and statuses
Header accounts organise active posting accounts into the reporting structure.

List account categories

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/account-categories

Required OAuth scope: accounting:read

Lists the controlled categories used to classify chart-of-account entries.

Statement Purpose
profit_and_loss Revenue, cost, and expense performance accounts.
balance_sheet Asset, liability, and equity position accounts.

normal_balance identifies the balance direction normally expected for the category. Categories are Finovio reference data and are read-only.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose books contain the bank account.
statement query No string: profit_and_loss, balance_sheet
page query No integer
per_page query No integer

Request

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/account-categories HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
200 A page of account categories.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
422 One or more supplied values failed validation.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "code": "REVENUE",
      "name": "Revenue",
      "statement": "profit_and_loss",
      "normal_balance": "credit"
    },
    {
      "code": "EXPENSE",
      "name": "Expense",
      "statement": "profit_and_loss",
      "normal_balance": "debit"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 30,
    "last_page": 1,
    "total": 2
  }
}