Profit and Loss

GET/v1/operations/reports.profit_and_loss

The organisation's Profit and Loss (income statement), read live from Xero or QuickBooks. Choose the period with period (this_month, last_month, this_quarter, last_quarter, ytd, last_year), or set period to custom with from and to. To compare, set comparePeriods (1 to 12) and compareBy (month or year): comparePeriods 2 with compareBy year gives this period and the same period in each of the two years before. The response lists the periods once (current first) and every section, group and account with one amount per period, in that order, plus Gross Profit and Net Profit.

Scope: synced.read · reads only
Roles: Super admin, Admin, Submitter, Custom (by default; an admin can change this per operation)
MCP tool: reports_profit_and_loss

Request

Send the token as Authorization: Bearer. A token approved for several organisations also sends Synced-Organisation: {id} (see Organisations).

Query parameters

Name	Type	Description
`period`	string	PeriodA preset period, or custom with from and to. one of `this_month`, `last_month`, `this_quarter`, `last_quarter`, `ytd`, `last_year`, `custom` · default `"this_month"`
`from`	string	FromWith period custom: the first day, yyyy-MM-dd.
`to`	string	ToWith period custom: the last day, yyyy-MM-dd.
`comparePeriods`	integer	Comparison periodsHow many earlier periods to compare with. default `0` · min 0 · max 12
`compareBy`	string	Compare bymonth: each comparison is the month before. year: the same period a year earlier. one of `month`, `year` · default `"month"`

Response

200 with a JSON body. 401 without a valid token, 403 when the scope, role or organisation does not allow it, 429 when rate limited (see Errors and limits).

Name	Type	Description
`report`	string	Report
`organisation`	string	Organisation
`currency`	string	Currency
`period`	string	Period preset
`compareBy`	string	Compared by
`comparePeriods`	integer	Comparison periods
`periods`	object[]	Periods (current first)
`label`	string
`from`	string (date)
`to`	string (date)
`sections`	object[]	Sections
`title`	string
`total`	number[]
`groups`	object[]
`title`	string
`total`	number[]
`accounts`	object[]
`name`	string
`amounts`	number[]
`summary`	object[]	Summary lines
`label`	string
`amounts`	number[]

Example

curl -X GET 'https://api.syncedhq.com/v1/operations/reports.profit_and_loss' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Try it

Sign in to send this request as yourself. You choose the organisations on Synced's consent screen; the token stays in this tab and expires within an hour.

periodstring

A preset period, or custom with from and to.

fromstring

With period custom: the first day, yyyy-MM-dd.

tostring

With period custom: the last day, yyyy-MM-dd.

comparePeriodsinteger

How many earlier periods to compare with.

compareBystring

month: each comparison is the month before. year: the same period a year earlier.

Request

curl -X GET 'https://api.syncedhq.com/v1/operations/reports.profit_and_loss' \
  -H 'Accept: application/json'

Response

Sign in, then send the request.