Actions37
- API Key Info Actions
- Claim Actions
- Claim Document Actions
- Debtor Actions
- Mandate Actions
- Order Actions
- Payment Actions
- Single Mandate Statement Actions
- Statement Actions
Mandate → Get Many
AI-generatedSummary
Retrieve a list of mandates matching specified filters and constraints from the Paywise system.
Inputs
- Return All — Select whether to return all matching mandates or limit the number of results.
- Limit — Set the maximum number of mandates to return when 'Return All' is false; minimum is 1, default is 50.
- Filters — Apply optional filters to narrow the mandates returned, including archived status, creation date range, payment state, processing state, reference number, requests to client status, search text, and last updated timestamp.
Output shape
a list of mandate objects
Returns either all mandates that match the filters or up to the specified limit, depending on 'Return All'. Supports filtering by multiple criteria, including dates, states, and text search.
Examples
Example 1: Return up to 50 active mandates created after a certain date, filtering out archived ones
Return All = false, Limit = 50, Filters = { archived: false, created_after: date }
Example 2: Return all archived mandates that are unpaid and not ended
Return All = true, Filters = { archived: true, payment_state: ['unpaid'], processing_state: ['in_progress', 'paused', 'canceled_by_client', 'canceled_by_service_provider'] }