listInvoices
listInvoicesRetrieve a paginated list of invoices with filters for customer, status, amounts, dates, and contract details.
Instructions
Retrieve a paginated list of invoices, with options for filtering by customer, status, amounts, due date, creation date, and related customer/contract details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customer_id | No | Filter invoices by a specific customer ID. | |
| customer__external_id | No | Filter invoices by a customer's external ID (nested filter). | |
| status | No | Filter invoices by their status (e.g., 'draft', 'approved', 'paid', 'void', 'partially_paid', 'upcoming'). | |
| status__in | No | Filter invoices by multiple statuses (comma-separated, e.g., 'draft,approved,paid,partially_paid,upcoming,void'). | |
| cursor | No | The cursor for pagination. | |
| limit | No | Maximum number of invoices to return per page (defaults to 10). | |
| contract_id | No | Filter by contract ID. | |
| external_id | No | Filter by invoice external ID. | |
| invoice_total__gte | No | Filter by invoice total greater than or equal to. | |
| invoice_total__lte | No | Filter by invoice total less than or equal to. | |
| amount_due__gte | No | Filter by amount due greater than or equal to. | |
| amount_due__lte | No | Filter by amount due less than or equal to. | |
| due_date__gte | No | Filter by due date greater than or equal to (ISO 8601). | |
| due_date__lte | No | Filter by due date less than or equal to (ISO 8601). | |
| created_at__gte | No | Filter by creation date greater than or equal to (ISO 8601). | |
| created_at__lte | No | Filter by creation date less than or equal to (ISO 8601). | |
| invoice_number__like | No | Partial match for invoice number. | |
| customer__customer_name__ilike | No | Case-insensitive partial match for customer name associated with the invoice. | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |