Reports

Retrieves income statement report

Changed on

Returns an income statement (profit and loss) report for the specified date range.

get/reports/income-statement

Request

Query parameters

from_datestring date required

Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD).

to_datestring date required

End date for the report period. Uses ISO-8601 format (YYYY-MM-DD).

subsidiary_idstring uuid

Subsidiary to be used when filtering data

breakdown_by'SUBSIDIARY' | 'CUSTOM_FIELD'

How to break down the report columns. If not specified, returns a single total column.

custom_field_idstring uuid

The ID of the custom field to break down by. Required when breakdown_by is CUSTOM_FIELD.

book_idstring uuid nullable

Book ID to report on. Primary books return primary-only figures; adjustment-overlay books return the combined primary and adjustment view.

Response

OK

currencystring required

Currency code following ISO-4217

Changes