Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage customer data and related payment plan operations. Specifically, the Customer - Search All operation allows users to search for customers by email or by partial matches on first and last names. This is useful in scenarios where you want to quickly find customer records based on a query string, such as looking up a customer by their email address or searching customers whose names contain certain keywords.

Practical examples include:

  • Searching for a customer by entering their full or partial email address.
  • Finding customers whose first or last names partially match a given string, useful for fuzzy searches or autocomplete features.
  • Limiting the number of returned results to avoid overwhelming outputs.

Properties

Name Meaning
Search Query The search string used to find customers. If it contains an @ symbol, the search targets email addresses; otherwise, it performs a partial match on first and last names.
Limit The maximum number of customer results to return. Must be between 1 and 100.

Output

The output is a JSON array where each element represents a customer object retrieved from the Partially API matching the search criteria. Each customer object typically includes fields such as customer ID, email, first name, last name, and other customer-related details as provided by the API.

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Partially Payment Plans API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The node uses an internal helper function to make HTTP requests to the API endpoints.

Troubleshooting

  • Empty Results: If no customers are returned, verify that the search query is correct and matches existing customer data. Remember that if the query contains @, it searches emails exactly; otherwise, it does partial matching on names.
  • API Authentication Errors: Ensure the API key or authentication token is correctly set up in n8n credentials. Invalid or missing credentials will cause request failures.
  • Limit Exceeded: The "Limit" property must be between 1 and 100. Setting values outside this range may cause errors or unexpected behavior.
  • Network Issues: Connectivity problems with the Partially API endpoint can cause timeouts or failed requests. Check network access and API availability.

Links and References

Discussion