Ledger Report

The Ledger for a period, as the report page prints it: for each account, Balance Before, every transaction with its running balance, and the Subtotal, then the grand total.

Mirrors /owner/reports/journal_transactions?report_type=transaction&group_by=account&currency=-1.

rows is flat, one per displayed transaction, grouped by account in the page's order; accounts carries each account's opening, period and closing; totals is keyed by currency. The running balance is net: either a debit or a credit, the other side is 0. Figures are raw numbers; credit subtotals and totals are rounded to 5 places as the page does, the rest to 8.

A date range is required (date_from or date_to): the page prints nothing without one.

Not paginated. More than 7000 rows, or (with currency=-1) more than 500 accounts, is answered 400 rather than truncated; narrow the rows with a shorter range, journal_cat_id or journal_account_id, and the accounts with journal_cat_id, journal_account_id or display_all_accounts=0. The refusal carries an empty validation_errors ({}).

Requires the Accounting plugin and the View all journals permission, 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

curl --location '/api2/reports/ledger?date_from=2025-01-01&date_to=2025-01-31&journal_cat_id=&journal_account_id=&display_all_accounts=&cost_center_id=&fy_id=&staff_id=&currency=&journals_branch_id=&accounts_branch=&tags=&tags_match=' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json'

{ "result": "successful", "code": 200, "data": { "report": { "key": "ledger", "title": "string", "currency": "string" }, "filters": { "property1": "string", "property2": "string" }, "columns": { "staff": true, "tags": true, "cost_center": true, "custom_fields": [ { "key": "string", "label": "string" } ] }, "accounts": [ { "currency": "string", "account_id": 0, "code": "string", "name": "string", "title": "string", "opening": { "debit": 0, "credit": 0 }, "period": { "debit": 0, "credit": 0 }, "closing": { "debit": 0, "credit": 0 }, "rows": 0, "cost_center": { "debit": 0, "credit": 0 } } ], "rows": [ { "currency": "string", "account_id": 0, "account_code": "string", "line": 0, "journal_id": 0, "journal_number": "string", "transaction_id": 0, "date": "2019-08-24", "description": "string", "debit": 0, "credit": 0, "balance": { "debit": 0, "credit": 0 }, "staff_id": 0, "staff": "string", "tags": "string", "cost_center": { "debit": 0, "credit": 0, "allocation": "string" }, "custom_fields": { "property1": "string", "property2": "string" } } ], "totals": { "property1": { "debit": 0, "credit": 0, "balance": { "debit": 0, "credit": 0 }, "cost_center": { "debit": 0, "credit": 0 } }, "property2": { "debit": 0, "credit": 0, "balance": { "debit": 0, "credit": 0 }, "cost_center": { "debit": 0, "credit": 0 } } }, "meta": { "account_count": 0, "row_count": 0 } } }

Request

Responses