Skip to main content
GET
Retrieve the Profit & Loss Report

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Accept
(enum<string> | string)[] | null

The content type of the response

Available options:
application/json,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Path Parameters

business_id
string<biz_string>
required

The ID of the Business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Query Parameters

basis
enum<string>
default:modified_cash

Accrual or cash basis. Defaults to ReportBasis.MODIFIED_CASH.

Available options:
accrual,
modified_cash
start_datetime
string<date-time>
required

The start date (inclusive) in ISO-8601 format.

Example:

"2025-01-01T00:00:00Z"

end_datetime
string<date-time>
required

The end date (inclusive) in ISO-8601 format.

Example:

"2026-01-01T00:00:00Z"

period
enum<string> | null
default:all

The period used to partition the report details.

Available options:
month,
quarter,
year,
all
Example:

"year"

tags
string | null

Filter the report to amounts allocated to the given tags. Comma-separated field:value pairs, e.g. Job:Maple Street Remodel,Job:Downtown Office Rewire. Multiple pairs are OR'd (the report covers any matching tag).

Example:

"Job:Maple Street Remodel,Job:Downtown Office Rewire"

Response

Successful Response

data
PLPeriodReport · object[]
required