List Clients Needing Authorisations
Lists the clients whose active or proposed services require one of the requested HMRC authorisation types, one row per client, with an entry for each type that client needs. A type a client does not need simply has no entry. Filtering by status selects which clients appear, not which of their authorisations are returned, so a row always shows everything the client needs rather than only the part that matched. Filtering by HMRC verification result works the same way, and reads a client that cannot be checked as missing details whatever result is stored against it.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| search | query string | |
| authorisationTypes | query array | |
| statuses | query array | |
| verificationResults | query array | |
| 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 string | Field to sort by. |
Field to sort by. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||