A client's OWN accounting software: the organisation their record is bound to, and the invoices, contacts, bank accounts and profit and loss inside it. Distinct from the client's customer record in the practice's books, which is what the practice invoices them against. Organisations are always read live from the platform rather than a stored list, one client may be bound to one organisation and one organisation to one client, and platforms that offer no profit and loss report say so with a 400 rather than an empty report.

Get Books Profit And Loss

GET /tenants/{tenant}/clients/{clientCode}/books/profit-and-loss

Runs a profit and loss report over the client's own books for the period given. Name the period as a 'dateRange' (a PresetDateRange), as dateRange=CustomDateRange with 'dateFrom' and 'dateTo' (inclusive), or as bare 'dateFrom' and 'dateTo' with no dateRange at all. Sections come back as the platform grouped them rather than normalised into fixed totals. Some platforms offer no such report and answer with 400 saying so.

Parameters

Name	Type	Description
tenant*	path string	The Tenant.Code
The Tenant.Code
clientCode*	path string
dateFrom	query string (date)
dateRange	query enum	ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange
ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange
dateTo	query string (date)

Responses

200 OK

BooksProfitAndLossDto

400 Bad Request

401 Unauthorized – Invalid or missing API key

404 Not Found

Get Books Profit And Loss

Parameters

Responses

Try it

Related Schemas

BooksProfitAndLossDto