paywise icon

paywise

Submit and track debt collection cases with the paywise API v2

Actions37

Claim Document → Get Many

AI-generated

Summary

Retrieve a list of claim documents associated with a specific claim identified by its Claim ID, with optional pagination controls.

Inputs

  • Claim ID (required) — The unique identifier of the claim for which to fetch associated claim documents.
  • Return All — A boolean flag indicating whether to return all claim documents (true) or limit the number of results (false).
  • Limit — The maximum number of claim documents to return when 'Return All' is false; defaults to 50 and must be at least 1.

Output shape

a list of claim document records associated with the specified claim

If 'Return All' is false, the number of returned claim documents is capped at the 'Limit' value; if true, all associated claim documents are returned. Each document in the list includes metadata describing the document as provided by the Paywise API.

Examples

Example 1: Fetch up to 50 claim documents for a claim

Set 'Claim ID' to the specific claim's ID; leave 'Return All' as false (default); set 'Limit' to desired maximum (default 50).

Example 2: Fetch all claim documents for a claim

Set 'Claim ID' to the specific claim's ID; set 'Return All' to true to ignore the limit and fetch all documents.

Links

Discussion