List invoices
list_invoicesFetch invoices for a date range, filtered by status, client, project, or invoice type, with optional line items.
Instructions
Invoices dated in a range (POST /invoices, 'Get invoices'; a POST that changes nothing): number, status, dates, client, project, task, worker, currency, net, tax and total, and optionally the line items. invoice_type picks client invoices (default), client credit notes, self-billing invoices or self-billing credit notes (sent as invoiceReportType, whose spec description reads 'Deprecated - (only used by /invoices/ POST endpoint)'). Other filters sent as documented: invoiceStatusFilters (empty returns every status, Draft included), clientCode, costCentreCode, chargeCodeGroupCodes, exportedFilter, modifiedAfter. Self-billing invoices are contractor pay: their amounts only with include_contact_details (any invoice returned for a self-billing type is treated as self-billing, whatever its invoiceSelfBilling flag says). Probably counts against the report limits (24 per hour); the endpoint documents no paging, so at most max_results invoices are shown.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | Invoice date on or before, YYYY-MM-DD (at most 366 days after start_date) | |
| exported | No | Filter on export status (exportedFilter) | |
| statuses | No | Invoice statuses to include; empty for all, Draft included | |
| start_date | Yes | Invoice date on or after, YYYY-MM-DD | |
| client_code | No | ||
| max_results | No | Most invoices to return in this call (default 100); the answer says how many were left out | |
| invoice_type | No | ClientInvoices | |
| include_items | No | Include each invoice's line items | |
| project_codes | No | Only these projects (branches), sent as chargeCodeGroupCodes | |
| modified_after | No | Only invoices modified after this date/time (modifiedAfter) | |
| cost_centre_code | No | ||
| include_contact_details | No | Include self-billing (contractor pay) amounts, and stop redacting email addresses, phone numbers, national insurance numbers and UK postcodes typed into names and other text (bank and card numbers are always removed) |