Actions37
- Offer Item Actions
- Customer Actions
- Dispute Actions
- Installment Actions
- Line Item Actions
- Offer Actions
- Payment Actions
- Payment Method Actions
- Payment Plan Actions
- Payment Schedule Actions
- Refund Actions
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 Add Contract Signature operation, it allows users to add a contract signature to an existing payment schedule. This is useful in scenarios where a digital signature or approval needs to be recorded against a payment schedule, such as confirming customer agreement on payment terms.
Practical examples include:
- Automatically adding a customer's signed contract data after they approve a payment plan.
- Capturing metadata like IP address and user agent alongside the signature for audit trails.
- Integrating contract signing workflows into broader automation pipelines involving payment plans.
Properties
| Name | Meaning |
|---|---|
| Payment Schedule ID | The unique identifier of the payment schedule to which the contract signature will be added. |
| Contract Signature | The actual contract signature content (likely a string representation of the signature). |
| IP Address | (Optional) The IP address from which the contract signature was submitted. |
| User Agent | (Optional) The user agent string of the client submitting the contract signature. |
Output
The node outputs a JSON object representing the updated payment schedule after the contract signature has been added. This typically includes all details of the payment schedule along with the newly attached contract signature and any associated metadata.
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 an internal helper function to make HTTP POST requests to the endpoint
/payment_schedule/add_contract_signature/{payment_schedule_id}.
Troubleshooting
- Missing Required Fields: Ensure that the "Payment Schedule ID" and "Contract Signature" fields are provided; otherwise, the API call will fail.
- Authentication Errors: If the API key or token is invalid or missing, the request will be rejected. Verify credential configuration.
- Invalid Payment Schedule ID: Providing a non-existent or incorrect payment schedule ID will result in an error from the API indicating the resource was not found.
- Network Issues: Connectivity problems can cause timeouts or failed requests; check network access to the Partially API endpoint.
- API Rate Limits: Excessive calls may trigger rate limiting; implement retries or backoff strategies if needed.
Links and References
- Partially Payment Plans API Documentation (Assumed official docs URL)
- n8n Documentation on Creating Custom Nodes
- General info on Digital Contract Signatures
This summary focuses exclusively on the "Payment Schedule" resource and the "Add Contract Signature" operation as requested.