paywise icon

paywise

Consume paywise API
Join our community

Actions20

Overview

This node integrates with the Paywise Partner API to manage companies. Specifically, the "List" operation under the "Company" resource retrieves a list of companies from the Paywise system. It supports filtering by company ID or name and allows pagination through limit and offset parameters.

Typical use cases include:

  • Fetching a subset of companies for display or further processing.
  • Filtering companies based on specific criteria such as their ID or name.
  • Implementing pagination when dealing with large sets of company data.

For example, you might use this node to retrieve the first 10 companies whose names contain a certain keyword or to skip the first 20 companies and fetch the next batch.

Properties

Name Meaning
Filters Collection of filters to narrow down the list of companies. Options:
- ID: Filter by company ID (string).
- Name: Filter by company name (string).
Limit Number of companies to return (number). Optional; defaults to 10 if not set.
Offset Number of companies to skip before starting to collect the result set (number). Optional; defaults to 0 if not set.

Output

The output is an array of JSON objects, each representing a company matching the specified filters and pagination settings. Each item in the output array contains the company's details as returned by the Paywise Partner API.

If the API supports binary data related to companies (e.g., documents or images), it would be included in the binary output field, but based on the provided code and properties, this node primarily outputs JSON data about companies.

Dependencies

  • Requires an active connection to the Paywise API via an API key credential configured in n8n.
  • The node depends on the Paywise Partner API being accessible and properly authenticated.
  • No additional external dependencies are indicated beyond the Paywise API credentials.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported filter values or invalid pagination numbers may result in errors or empty results.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Resource "company" is not implemented": This indicates a misconfiguration or internal error where the company resource handler is missing.
    • "Operation "list" for resource "company" is not implemented": Indicates that the requested operation is not available for the company resource.

    To resolve these, ensure the node is correctly configured with the right resource and operation, and that the node version supports them.

Links and References

Discussion