invoices_list
Read-onlyIdempotent
List invoices (filter by customer, status, text; outstanding totals per currency), or id for one with lines, charges and amount paid. With id: payments (ledger), creditNotes, or recurring (its repeat schedule).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Matches number and customer. | |
| id | No | Invoice id. Returns that one invoice. | |
| limit | No | Default 100. | |
| offset | No | ||
| status | No | draft | issued | partially_paid | paid | void | |
| payments | No | With id: return the payment ledger (incl. reversed payments). | |
| companyId | No | ||
| contactId | No | ||
| recurring | No | With id: its repeat schedule (null if none). | |
| creditNotes | No | With id: its credit notes. | |
| outstanding | No | Only invoices with money still owed. |