invoiceninja_list_payments
Read-onlyIdempotent
Retrieve payments from Invoice Ninja with filters, sorting, and pagination. Use it to review payment statuses, search by date or client, and get IDs for full payment details.
Instructions
List payments from Invoice Ninja with filtering, sorting and pagination. client_status values: all, pending, cancelled, failed, completed, partially_refunded, refunded, partially_unapplied. extra_filters keys: number, date_range ('YYYY-MM-DD,YYYY-MM-DD'); created_between / updated_between ('YYYY-MM-DD,YYYY-MM-DD'), tag_ids (comma separated), assigned_user_ids. Related names are resolved automatically (client_name). Use invoiceninja_get_payment with an id from this list for the full record.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1 | |
| sort | No | Sort as 'column|asc' or 'column|desc', e.g. 'date|desc' | |
| fields | No | JSON format only: return just these top-level fields (id is always included), e.g. ['number', 'client_name', 'balance', 'due_date'] | |
| filter | No | Free-text search across the main columns (number, name, contacts, notes…) | |
| status | No | Lifecycle filter, comma separated: active, archived, deleted (e.g. 'active' to skip archived and deleted records) | |
| include | No | Extra relations to embed, comma separated (e.g. 'payments,activities') | |
| per_page | No | Records per page (1-100) | |
| client_id | No | Only records of this client (hashed id) | |
| client_status | No | Business status filter, comma separated; one or more of: all, pending, cancelled, failed, completed, partially_refunded, refunded, partially_unapplied | |
| extra_filters | No | Additional API query filters as name -> value (see the tool description) | |
| response_format | No | 'markdown' (default) for a readable summary, 'json' for complete machine-readable data (empty fields removed) | markdown |