Search invoices
search_invoicesFind invoices by free-text search on invoice number, customer name/email, or line description, or list a client's invoices filtered by status. Returns totals, paid, and due amounts.
Instructions
Find invoices two ways. (1) query: free-text search by displayed invoice number, client name/email or line description (wraps Invoices.search). (2) client_id: list a customer's invoices filtered by status (wraps Invoices.getList; default status 'open'). Provide at least one of query or client_id. Each result includes numeric id, displayed id_code, status, dates, total, paid and due amounts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Result page, starting at 1 | |
| query | No | Free-text search: invoice number (e.g. '1042'), customer name/email, or line item text | |
| status | No | Status filter used with client_id. 'open' = unpaid, 'closed' = paid, 'past_due', 'void', 'draft', 'all', ... | open |
| currency | No | ISO 4217 currency filter (used with client_id) | |
| client_id | No | List invoices belonging to this numeric client ID | |
| invoice_number | No | Exact displayed invoice number filter (used with client_id) |