Skip to main content
GET
Fetch P&L report

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 for.

Query Parameters

start_date
string<date-time>
required

Start date for the P&L report (ISO 8601 format).

end_date
string<date-time>
required

End date for the P&L report (ISO 8601 format).

reporting_basis
enum<string>

Accounting basis for the report.

Available options:
ACCRUAL,
CASH
structure
string

P&L structure template to use.

tag_filter
string

Filter results by tags.

exclude_uncategorized_transactions_with_suggested_transfer_matches
boolean
default:true

When true (default), uncategorized transactions that have a suggested transfer match are excluded from the uncategorized inflows and outflows totals. Set to false to include those transactions in the uncategorized totals.

Response

Profit and loss report data.

data
object
required