List Invoices
invoice_listSearch and filter invoices by status, client, amount, or date range. Returns detailed invoice data including line items and payment state for dashboards and automated workflows.
Instructions
Search and filter invoices. Optional filters: status ("draft"|"sent"|"viewed"|"paid"|"overdue"|"cancelled"|"refunded"), client_id, min_amount, max_amount, date_from/date_to (ISO dates), overdue_only (boolean). Pagination via limit (default 50, max 200) and offset. Returns {total, invoices[]} where each invoice includes full line_items and payment state. Use this to build dashboards or drive invoice_remind/invoice_risk workflows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size, 1–100. Defaults to 20. | |
| offset | No | Number of results to skip for pagination. Defaults to 0. | |
| status | No | Restrict to one lifecycle state: draft, sent, viewed, paid, overdue, cancelled, refunded. | |
| to_date | No | Filter to invoices with issue_date ≤ this ISO-8601 datetime. | |
| client_id | No | Restrict to invoices billed to this client UUID. | |
| from_date | No | Filter to invoices with issue_date ≥ this ISO-8601 datetime. | |
| max_amount | No | Inclusive upper bound on total amount. | |
| min_amount | No | Inclusive lower bound on total amount (any currency, no FX conversion). | |
| overdue_only | No | When true, returns only invoices whose due_date is past and status is not paid/cancelled/refunded. Defaults to false. |