accounting_payments_list
Retrieve a filtered list of accounting payments using criteria like date range, status, customer, or amount, with pagination support.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Comma-delimited payment IDs (max 50) | |
| page | No | Page number (starts at 1) | |
| sort | No | Sort: Field (default), +Field (asc), or -Field (desc). Fields: Id, CreatedOn, ModifiedOn, PaidOn, Total | |
| batchId | No | Batch ID | |
| pageSize | No | Records per page (default 50) | |
| statuses | No | Payment statuses | |
| totalLess | No | Maximum total amount | |
| customerId | No | Customer ID | |
| batchNumber | No | Batch number | |
| paidOnAfter | No | Paid date on or after RFC3339 date-time | |
| includeTotal | No | Include total count in response | |
| paidOnBefore | No | Paid date on or before RFC3339 date-time | |
| totalGreater | No | Minimum total amount | |
| createdBefore | No | ||
| modifiedBefore | No | ||
| businessUnitIds | No | Comma-delimited business unit IDs | |
| transactionType | No | Transaction type | |
| createdOnOrAfter | No | ||
| customFieldFields | No | Custom field name/value filters | |
| modifiedOnOrAfter | No | ||
| appliedToInvoiceIds | No | Comma-delimited invoice IDs applied to | |
| customFieldOperator | No | Operator for custom field filters | |
| appliedToReferenceNumber | No | Applied reference number |