List credit notes
invoiced_list_credit_notesRead-only
List credit notes: customer, status (draft, open, paid, closed, voided), totals, remaining balance, line items. GET /credit_notes.
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. | |
| end_date | No | Credit notes dated on or before this date (a bare date includes the whole day). | |
| metadata | No | Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}. | |
| per_page | No | Results per page, 1-100 (default 25). | |
| start_date | No | Credit notes dated on or after this date or date-time. | |
| customer_id | No | Only this customer's credit notes. | |
| updated_after | No | Only records updated after this date or date-time. |