Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage "Offer Items" within the system. Specifically, the Create operation for the Offer Item resource allows users to add new items to an existing offer. This is useful in scenarios where you want to define specific components or discounts as part of a payment plan offer.

For example, if you have an offer representing a bundled product or service, you can create multiple offer items that specify individual parts of the offer, such as fixed discounts or percentage-based adjustments. This enables flexible and detailed configuration of offers tailored to customer needs.

Properties

Name Meaning
Offer ID The identifier of the offer to which this item belongs.
Name The name of the offer item.
Amount Type The type of amount applied by this offer item. Options: Fixed (a fixed amount) or Percentage (calculated based on the payment plan subtotal).
Amount The numeric value of the amount. Using a negative number will reduce the subtotal of the payment plan.

Output

The output is a JSON array containing the response from the Partially API after creating the offer item. This typically includes details of the newly created offer item such as its unique ID, name, amount type, amount, and associated offer ID.

No binary data is output by this node.

Dependencies

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

Troubleshooting

  • Missing Required Fields: Ensure all required properties (Offer ID, Name, Amount Type, and Amount) are provided; otherwise, the API will reject the request.
  • Invalid Amount Type: Only "fixed" or "percentage" are valid values for Amount Type. Using other values may cause errors.
  • API Authentication Errors: Verify that the API key or token credential is correctly set up and has sufficient permissions.
  • Negative Amount Usage: When using a negative amount to reduce the subtotal, ensure this is intended and supported by your business logic.
  • Network Issues: Check connectivity to the Partially API endpoint if requests fail or time out.

Links and References

Discussion