Skip to main content

List Journals (V2)

GET 
/api/xero/v2/journals

Paginated list of Xero general-ledger journal lines.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Each row is one flattened GL journal line pulled from Xero's immutable Journals feed (GET /Journals) — the provider side of the daily inventory reconciliation. Distinct from Manual Journals (/api/xero/v2/manual-journals), which are user-authored journals.

Authentication: Requires Bearer token.

Pagination: page (default 1), per_page (default 15).

Sorting (sort, prefix with - for DESC). Default: -journal_number (newest journals first, lines of the same journal kept adjacent). Allowed: id, journal_number, journal_date, account_code, account_name, source_type, net_amount, gross_amount, tax_amount, created_at, updated_at.

Search (filter[search]): partial match across account_code, account_name, source_type, source_id, journal_id (and exact id / journal_number when numeric).

Advanced filters (base64 filter_groups tree OR flat filter[<col>][<op>]=v). Numeric: id, journal_number, net_amount, gross_amount, tax_amount. Text: journal_id, account_code, account_name, source_type, source_id. Date: journal_date.

net_amount is signed: positive = debit, negative = credit.

account_local_id: the local XeroAccount id this line's account resolves to (account_id GUID first, account_code second). Use it to deep-link the account columns to /v2/integrations/xero/accounts/{id}. null when the account is not synced locally.

Request​

Responses​

OK

Response Headers
    Content-Type