List customers
invoiced_list_customersRead-only
List customers (accounts receivable debtors): name, number, email, payment terms, currency, autopay and chasing settings, owner. Filter by open balance, saved payment method, update time or any exact-match column. GET /customers.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| sort | No | Sort, "<column> asc|desc", e.g. "date desc". | |
| filter | No | Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0. | |
| metadata | No | Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}. | |
| per_page | No | Results per page, 1-100 (default 25). | |
| open_balance | No | true = only customers with an open balance; false = only those without. | |
| updated_after | No | Only records updated after this date or date-time. | |
| payment_source | No | true = only customers with a saved payment method. |