latestOpenAPI 3.0.22026-08-1010030.9 KB

e4ceb0dc32d4

reports

Retrieve a profit and loss report

Returns the entity's profit and loss for the period between startDate and endDate (inclusive), on the basis given by ledgerBasis. Each section carries its total and its account lines, already flattened out of the nested report groups.

get/platform/v1/entities/{entityId}/reports/profit-and-loss

Path parameters

entityIdstring uuid required

Query parameters

startDatestring required
endDatestring required
ledgerBasis'cash' | 'accruals'
groupBy'total' | 'week' | 'month' | 'quarter' | 'year'

Response

200