paywise icon

paywise

Consume paywise API
Join our community

Actions20

Overview

This node integrates with the Paywise API, specifically allowing management of debtors through the Case Management API. The "List" operation for the Debtor resource retrieves a paginated list of debtor records. This is useful in scenarios where you need to fetch and process multiple debtor entries, such as generating reports, syncing debtor data with other systems, or performing batch operations on debtor accounts.

For example, you might use this node to:

  • Retrieve the first 10 debtors to display in a dashboard.
  • Skip a certain number of debtors and fetch the next set for pagination.
  • Act on behalf of a client company by specifying a user ID, enabling multi-tenant or delegated access scenarios.

Properties

Name Meaning
Limit Number of debtors to return (pagination size).
Offset Number of debtors to skip before starting to return results (pagination offset).
Act on Behalf of Client Boolean flag indicating whether to act on behalf of a client company when making the request.
User ID ID of the user to act on behalf of (required if acting on behalf of a client).

Output

The node outputs an array of JSON objects, each representing a debtor record retrieved from the Paywise API. Each item in the output corresponds to one debtor's data as returned by the API.

The json field contains the debtor details such as identifiers, names, contact information, and any other debtor-specific attributes provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Paywise API.
  • The node depends on the Paywise Case Management API being accessible and properly configured.
  • Network connectivity to the Paywise API endpoint is necessary.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid or empty User ID while acting on behalf of a client will result in errors.
    • Exceeding API rate limits may cause request throttling or temporary failures.
    • Using unsupported or unimplemented resource-operation combinations will throw errors.

  • Error messages:

    • "Resource \"debtor\" is not implemented": Indicates the selected resource is not supported by the node; verify the resource name.
    • "Operation \"list\" for resource \"debtor\" is not implemented": Means the operation is not available for the resource; check the operation name.
    • Authentication errors typically indicate invalid or missing API keys; ensure credentials are correctly configured.
    • Validation errors related to User ID occur if acting on behalf of a client but no valid user ID is provided.

Links and References

Discussion