Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API, enabling automation and management of various payment-related resources such as customers, payment plans, offers, payments, installments, refunds, disputes, and more. Specifically, for the Installment resource with the List operation, the node retrieves a list of installment records filtered optionally by customer ID and/or payment schedule ID.

Common scenarios where this node is beneficial include:

  • Retrieving all installments associated with a specific customer to track payment progress.
  • Listing installments under a particular payment schedule to monitor scheduled payments.
  • Automating financial reporting or reconciliation processes by fetching installment data programmatically.

Practical example:

  • A business wants to fetch all installments for a customer to display their payment history in a CRM dashboard.
  • An accounting system automatically lists installments linked to a payment schedule to verify upcoming payments.

Properties

Name Meaning
Customer ID (Optional) Filter installments by the unique identifier of a customer.
Payment Schedule ID (Optional) Filter installments by the unique identifier of a payment schedule.

These properties allow narrowing down the list of installments returned by specifying either or both filters.

Output

The node outputs an array of JSON objects representing installments. Each installment object typically includes details such as installment ID, amount, due date, status, and related metadata as provided by the Partially API.

If binary data were involved (e.g., documents or signatures), it would be included in a separate binary output field, but for the Installment List operation, only JSON data is returned.

Dependencies

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

Troubleshooting

  • Empty results: If no installments are returned, verify that the Customer ID and Payment Schedule ID filters are correct and correspond to existing records.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Date format issues: Although not directly applicable here, other operations involving dates require ISO 8601 format; incorrect formats may cause errors.
  • API rate limits: Frequent calls might hit API rate limits; consider adding delays or batching requests.

Links and References

Discussion