API Docs / Operations / Invoices / List sales invoices

List sales invoices

GET /tenants/{tenant}/sales-invoices

Lists the tenant's sales invoices (issued to a customer), without lines. Filter by contact and by the year and month of dateField (Date, the invoice date, by default; DueDate; PaidDate; PaidTaxMonthEnding, the CIS tax month, 6th to 5th, it was paid in); sort by date (default), number, contact or reference.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

dateField query enum

Date DueDate PaidDate PaidTaxMonthEnding

Date DueDate PaidDate PaidTaxMonthEnding

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.

Date Number Contact YourReference TheirReference

Field to sort by. Valid values depend on the resource.

Date Number Contact YourReference TheirReference

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

contact query string

Only invoices of the contact with this code. Omitted: every contact.

Only invoices of the contact with this code. Omitted: every contact.

year query integer

Only invoices whose date field falls in this year. Omitted: every year.

Only invoices whose date field falls in this year. Omitted: every year.

month query integer

Only invoices whose date field falls in this month (1 to 12) of the year. Omitted or 0: the whole year.

Only invoices whose date field falls in this month (1 to 12) of the year. Omitted or 0: the whole year.

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json