List payments
in_list_paymentsList Invoice Ninja payments with optional free-text search, client filter, status, sorting, and pagination to locate and review payment records.
Instructions
List payments with optional search/client filter.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "in_list_payments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| sort | No | Sort directive, e.g. 'date|desc'. | |
| filter | No | Free-text search across the entity's searchable columns. | |
| status | No | Record state (default 'active'). 'all' also returns archived and deleted records. | |
| per_page | No | Rows per page (capped server-side, default 20). | |
| client_id | No |