List Returns
Lists the tenant's monthly returns, latest tax period first by default. Filter by the year the tax month ends in and by status (Open, Submitted, Accepted, Error); sort by taxPeriod, status, invoiceCount, contactCount or deductions.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The tenant code (the organisation's URL stub) |
The tenant code (the organisation's URL stub) |
||
| status | query enum | Open Submitted Accepted Error |
Open Submitted Accepted Error |
||
| offset | query integer (int32) | Number of records to skip (default: 0). Use with limit for pagination. |
Number of records to skip (default: 0). Use with limit for pagination. |
||
| limit | query integer (int32) | Maximum number of records to return (default: 10, max: 50) |
Maximum number of records to return (default: 10, max: 50) |
||
| sortBy | query enum | Field to sort by. Valid values depend on the resource. |
Field to sort by. Valid values depend on the resource. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||
| year | query integer | Only returns for tax months ending in this calendar year. Omitted: every year. |
Only returns for tax months ending in this calendar year. Omitted: every year. |
||