paywise icon

paywise

Submit and track debt collection cases with the paywise API v2

Actions37

Debtor → Get Many

AI-generated

Summary

Retrieve multiple debtor records from the Paywise system, optionally filtering the results and controlling the number of returned items.

Inputs

  • Return All — Boolean flag to specify whether to return all debtor records or limit the number returned.
  • Limit — Maximum number of debtor records to return if 'Return All' is false. Minimum value is 1, default is 50.
  • Filters — Optional criteria to filter the debtors retrieved, including 'Debtor Type' (business or consumer), 'Updated Since' (a date/time to return only debtors updated after), and 'Your Reference' (custom string reference to filter debtors).

Output shape

a list of debtor records

The returned list is either complete or limited by the 'Return All' and 'Limit' inputs. Filters narrow the results by debtor type, updated date, or a custom reference string. Errors from the API are returned in standard error format.

Links

Discussion