Skip to main content
GET
Profit & loss statement

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}$
currency
string

Report currency (ISO-4217). Defaults to the organization's base currency.

Required string length: 3
basis
enum<string>

Accounting basis; cash excludes accrual-sourced entries. Defaults to accrual.

Available options:
accrual,
cash
compare
enum<string>
Available options:
none,
prior_period,
prior_year
coverage
enum<string>

Which entries to count. posted (default) is the attested view, so an organization that has confirmed nothing reads as zero activity. all adds the unconfirmed inbox, the way cash flow always reports.

Available options:
posted,
all
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 P&L report for the requested window

report
object
required