Actions14
Payment → Get Many
AI-generatedSummary
Retrieve multiple payments with optional filtering by member ID, company ID, date ranges (created, due, issued, modified), document type, status, location, and document number, with pagination support and limit control.
Inputs
- Member ID — Filter payments by the member ID.
- Company ID — Filter payments by the company ID.
- Additional Options — Advanced filtering options including various date filters for created, due, issued, and modified dates, document type (Credit Note, Invoice, Overpayment, Payment Charge), status filters (e.g., Paid, Draft, Failed), location filter by location ID or name, document number, and a limit on the maximum number of results returned.
- Limit (required) — Maximum number of payment results to return.
Output shape
a list of payment objects
The output is paginated, automatically retrieving multiple pages up to the specified limit. Each payment object is returned inside a 'results' property in the API response, and the operation consolidates these objects into the returned list. Optional filters can narrow the results by various criteria.