Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage payment schedules among other resources. Specifically, for the Payment Schedule - Update operation, it allows updating details of an existing payment schedule such as the down payment amount, term length, and payment frequency.

Common scenarios where this node is beneficial include:

  • Adjusting payment terms for a customer’s payment schedule after initial creation.
  • Modifying installment plans dynamically based on customer requests or business needs.
  • Automating updates to payment schedules in workflows that respond to external triggers (e.g., changes in contract terms).

Practical example: A business uses this node to update the down payment amount and term of a customer's payment schedule when they renegotiate their payment plan.

Properties

Name Meaning
Payment Schedule ID The unique identifier of the payment schedule to update.
Down Payment Amount The new amount to set as the down payment for the payment schedule.
Term The updated term length (duration) for the payment schedule.
Frequency The updated frequency at which payments are scheduled (e.g., monthly, weekly).

Output

The output is a JSON array containing the updated payment schedule object returned from the Partially API after the update request. This object typically includes all current details of the payment schedule, reflecting the applied changes.

No binary data output is involved in 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 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 return an error. Verify the ID before running the node.
  • Missing Required Fields: Ensure that the "Payment Schedule ID" is always provided since it is required.
  • API Authentication Errors: Check that the API key credential is correctly set up and has sufficient permissions.
  • Invalid Field Values: For numeric fields like down payment amount, term, and frequency, ensure values are valid numbers and within acceptable ranges expected by the API.
  • Network Issues: Connectivity problems can cause request failures; verify network access to the Partially API endpoint.

Links and References

Discussion