Chart of Accounts Directory

Production

GET

/api2/reports/chart_of_accounts

The account directory as the report page prints it: one flat list ordered by code, main accounts (level 1) and sub accounts (level 2) together. Codes are always strings. The page shows no parent column, so none is returned.

Not paginated. More than 3000 accounts (the page's own limit before it diverts to a CSV) is answered 400 with a validation_errors map naming the limit, rather than truncated; narrow with account_level, account_type or display_all_account_except.

Requires the View all journals and View own reports permissions, and the key must be enabled for machine access: stricter than the report screen.

Request

Authorization

OAuth 2.0

Password

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://www.daftra.com/v2/oauth/token

API Key

Add parameter in header

apikey

Example:

apikey: ********************

API Key

Add parameter in cookie

OISystem

Example:

OISystem: ********************

Query Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠400Error400

🟠401Error401

🟠403Error403

🟠404Error404

🟠405Error405

🔴500Error500

🔴503Error503

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api2/reports/chart_of_accounts?account_level=&account_type=&display_all_account_except=&branch_id=&order_by=' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": {
        "report": {
            "key": "chart_of_accounts",
            "title": "string"
        },
        "filters": {
            "account_level": [
                0
            ],
            "account_type": 0,
            "display_all_account_except": [
                "string"
            ],
            "order_by": "string",
            "branch_id": [
                0
            ]
        },
        "columns": [
            {
                "key": "string",
                "label": "string"
            }
        ],
        "rows": [
            {
                "code": "string",
                "name": "string",
                "type": "debit",
                "type_label": "string",
                "level": 1,
                "level_label": "string",
                "cost_centers": "string",
                "branch_ids": [
                    0
                ],
                "branches": "string"
            }
        ],
        "meta": {
            "row_count": 0
        }
    }
}

Journals Report

Expenses Report (Detailed)