Skip to main content
GET
General ledger

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Query Parameters

from
string

Inclusive period start (YYYY-MM-DD). Defaults to the start of the current year.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

Inclusive period end (YYYY-MM-DD). Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$
accountId
integer

Scope to entries touching one ledger account — this is also the P&L drill-down.

Required range: x > 0

Free-text match on entry id, description, or account names.

sources
string

Comma-separated entry sources to include: BANK_FEED, MANUAL, ACCRUAL, SYSTEM, INTEGRATION, OPENING, RECONCILIATION. Defaults to every source.

sort
enum<string>

Order entries by effective date (default) or by the entry's total debits.

Available options:
date,
amount
order
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc
limit
integer
Required range: 0 < x <= 500
offset
integer | null
Required range: x >= 0
projectId
integer

Scope the P&L to entries attributed to this project.

Required range: x > 0
projectGroupId
integer

Scope to every project in this group.

Required range: x > 0
unassigned
enum<string>

When true, scope to entries with no project. Mutually exclusive with the other project filters.

Available options:
true,
false

Response

200 - application/json

The matching journal entries

report
object
required