Fetch P&L summary
Returns a profit and loss summary for a single arbitrary date range. Unlike the monthly summaries endpoint which returns per-month breakdowns, this endpoint aggregates the entire specified period into one summary. Both date bounds are optional: omitting start_date uses the business activation date, and omitting end_date uses the current time. Omitting both returns an all-time summary. This endpoint is useful for dashboard cards showing aggregate financial metrics like total revenue, expenses, net profit, and uncategorized transaction counts.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json.
Path Parameters
The UUID of the business to fetch the profit and loss summary for.
Query Parameters
The start of the period (ISO 8601 instant, e.g. 2024-01-01T00:00:00Z). If omitted, defaults to the business activation date.
The end of the period (ISO 8601 instant, e.g. 2024-12-31T23:59:59Z). If omitted, defaults to the current time.
Accounting basis for the report. Defaults to the business default or ACCRUAL if not set.
ACCRUAL, CASH P&L structure template to use.
Tag key to filter results by (use together with tag_values).
Comma-separated tag values to filter results by (use together with tag_key).
Response
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.