List invoices
list_invoicesLists invoices newest first and filters by status, source, search term, or UTC creation date to find invoices without an ID.
Instructions
Lists invoices newest first, to find invoices when you do not have an id: filter by status, source, a search (invoice id or the start of the reference) and the UTC days they were created. Returns pages: for each store its name, invoices (the same fields as get_invoice) and nextCursor, null on the last page. One page per call; pass nextCursor as cursor together with the same store to get the next page. Without store and with several stores, one page per store. No match gives an empty list, not an error. Use get_invoice for one invoice by id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Invoices per page, 20 by default. | |
| store | No | Store id or exact store name from list_stores. Needed only when several stores are connected. | |
| cursor | No | nextCursor of the previous page, with the same store. | |
| search | No | Invoice id or the start of the reference. | |
| source | No | How the invoice was made: payment_link, woocommerce, edd, whmcs, api_key or not_recorded. | |
| status | No | awaiting_payment, confirming, paid, overpaid, underpaid, paid_late, expired or on_hold. | |
| createdTo | No | Last UTC day, YYYY-MM-DD. | |
| createdFrom | No | First UTC day, YYYY-MM-DD. |