Partially icon

Partially

Partially Payment Plans API
Join our community

Actions37

Overview

This node integrates with the Partially Payment Plans API, enabling automation around payment schedules and related financial operations. Specifically, for the Payment Schedule resource and the Get Contract PDF operation, it allows users to retrieve the contract PDF associated with a particular payment schedule by its ID.

Common scenarios where this node is beneficial include:

  • Automatically fetching contract documents for payment schedules to archive or send via email.
  • Integrating contract retrieval into workflows that manage customer payments and agreements.
  • Automating compliance or record-keeping processes by programmatically accessing contract PDFs.

Example use case: After creating or updating a payment schedule, you can use this node to get the corresponding contract PDF and attach it to an email sent to the customer.

Properties

Name Meaning
Payment Schedule ID The unique identifier of the payment schedule for which to retrieve the contract PDF.

Output

The node outputs a JSON array containing the response from the API call to fetch the contract PDF for the specified payment schedule ID. The exact structure depends on the API response but typically includes metadata about the contract and a link or encoded content of the PDF document.

If the node supports binary data output (not explicitly shown in the provided code), the binary field would contain the actual PDF file data for further processing or saving.

Dependencies

  • Requires an active connection to the Partially Payment Plans API.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • The node uses internal helper functions to make HTTP requests to the Partially API endpoints.

Troubleshooting

  • Invalid Payment Schedule ID: If the provided ID does not exist or is malformed, the API will likely return an error. Verify the ID correctness.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Network Issues: Connectivity problems may cause request failures; check network access to the Partially API.
  • API Rate Limits: Excessive requests might be throttled; consider adding delays or retries.
  • Missing Required Parameters: The payment_schedule_id is required; omitting it will cause errors.

Links and References

Discussion