Skip to main content
GET
Fetch P&L summary

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string
required

The UUID of the business to fetch the profit and loss summary for.

Query Parameters

start_date
string<date-time>

The start of the period (ISO 8601 instant, e.g. 2024-01-01T00:00:00Z). If omitted, defaults to the business activation date.

end_date
string<date-time>

The end of the period (ISO 8601 instant, e.g. 2024-12-31T23:59:59Z). If omitted, defaults to the current time.

reporting_basis
enum<string>

Accounting basis for the report. Defaults to the business default or ACCRUAL if not set.

Available options:
ACCRUAL,
CASH
structure
string

P&L structure template to use.

tag_key
string

Tag key to filter results by (use together with tag_values).

tag_values
string

Comma-separated tag values to filter results by (use together with tag_key).

Response

data
object
required

A profit and loss summary for an arbitrary date range. Unlike MonthlyPnlSummary which represents a single calendar month, this object can represent any time period including all-time when both dates are null.