API Docs / Operations / Returns / Get Return Breakdown

Get Return Breakdown

GET /tenants/{tenant}/returns/{year}/{month}/breakdown

The return broken down by subcontractor: identity, rate, invoice counts, labour, materials, gross, deduction, net and VAT, with a total row last (isTotal). A subcontractor paid at two rates in the month has a row per rate.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

month* path integer (int32)
year* path integer (int32)

Responses

200 OK
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json