List invoices
list_invoicesReturns the organisation's sales invoices ordered by due date, earliest first, up to 100 per page. Defaults to unpaid invoices; filter by contact, status, due date range or search text. Use search with status all to find an invoice by number whether or not it is paid. Deleted invoices are never returned. Read only.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"organisationId": "<organisationId>"
},
"name": "list_invoices"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of records to return | |
| cursor | No | Opaque cursor from a previous response's nextCursor. Omit to start from the most recent record. | |
| search | No | Case insensitive partial match on the invoice number, reference or contact name. The status filter still applies | |
| status | No | unpaid: approved invoices with a balance owing. overdue: unpaid invoices whose due date has passed in the organisation's timezone. paid: fully paid invoices. all: unpaid and paid invoices. | unpaid |
| dueAfter | No | Only invoices due on or after this date (YYYY-MM-DD) | |
| contactId | No | Only invoices for this contact | |
| dueBefore | No | Only invoices due on or before this date (YYYY-MM-DD) | |
| organisationId | Yes | Id of the organisation to act on, from list_organisations |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| nextCursor | No | Pass as the cursor query parameter to fetch the next page. Absent on the last page. |