Get the general ledger of an account

Select codes explicitly with account_code_prefix (literal, including % and _) and/or inclusive account_code_from/account_code_to in code sort order, instead of account/account_id. Accounts with no code never match them. Empty and inverted ranges are refused; the five-account and line caps still apply. Returns the general ledger of an account over start_date to end_date (default this month; an end_date alone starts on the first day of its month): the opening balance, each journal line with date, transaction type, details, reference, debit, credit and running balance, and the period debit, credit, net movement and closing balance, in the base currency (debit positive). Name the account by account_id (a string, like every chart of accounts id), or by account: an exact code, else part of its name (at most 5 accounts may match; more is a 422). Lines are paged across the accounts with page (at most 100000) and per_page (default 50, at most 200; truncated is true while more lines follow on later pages): every line keeps the period's running balance, and each account carries page_opening_balance (its balance before the page's first line) and page_closing_balance; the opening and closing balances always cover the whole period. Every page reads the whole period, so a period holding more than 5,000 lines for the accounts is refused with a 422 on start_date: narrow the date range or pick fewer accounts. An unknown account, a range that ends before it starts and a page size over 200 are 422 field errors. Read only. Requires the reports:read OAuth scope with view_reports.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null

Account code (e.g. "2100") or part of its name; up to 5 accounts may match

string | null
^[1-9][0-9]*$

Chart of accounts id, instead of account

string
length ≤ 150

Literal code prefix; % and _ match themselves. At most five accounts.

string
length ≤ 150

Inclusive code range using the chart code sort order. Either end may be omitted.

string
length ≤ 150

Inclusive upper account code in database sort order.

date

Period start, YYYY-MM-DD. Default: the first day of end_date's month, else of this month

date

Period end, YYYY-MM-DD. Default: last day of this month

integer
1 to 100000

Page of journal lines. Default: 1, max: 100000

integer
1 to 200

Journal lines per page, across the accounts. Default: 50, max: 200

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*