Overview

This node integrates with the ZapSign API to manage partnership-related operations, specifically allowing users to update the payment status of a client account within their partner network. The "Update Payment Status" operation lets partners programmatically set whether a client account is up to date with payments or in default.

Common scenarios:

• Automatically marking client accounts as paid or delinquent based on external billing system events.
• Synchronizing payment status between your CRM or accounting software and ZapSign partner accounts.
• Triggering workflows that depend on the payment status of partner clients.

Practical example:
You have an automated billing system that detects when a client has missed a payment. Using this node's "Update Payment Status" operation, you can update the client's payment status in ZapSign to "Inadimplente (Default)" to reflect the overdue payment, which might restrict access or trigger notifications.

Properties

Output

The node outputs a JSON array where each element corresponds to the result of processing an input item. For the "Update Payment Status" operation, the output JSON contains the response from the ZapSign API confirming the updated payment status or error details if the update failed.

No binary data output is produced by this operation.

Dependencies

• Requires an API authentication token credential to authenticate requests to the ZapSign API.
• Uses environment variables to determine the base URL for the API:
  • ZAPSIGN_API_BASE_URL_SANDBOX for sandbox environment (optional).
  • ZAPSIGN_API_BASE_URL for production environment (default fallback).
• Relies on HTTP POST requests with JSON payloads to the ZapSign partner API endpoint /api/v1/partner/update-payment-status/.

Troubleshooting

Common Issues

• Invalid Client API Token: If the token format is incorrect or expired, the API will reject the request.
• Invalid Payment Status Value: Only "adimplente" or "inadimplente" are accepted; other values cause errors.
• Missing Required Fields: Both the client API token and payment status must be provided.

Error Messages and Resolutions

• 400 Bad Request:

  • Indicates invalid input parameters.
  • Check that the client API token is correctly formatted.
  • Verify the payment status value is one of the allowed options.
  • Ensure all required fields are filled.

• 403 Forbidden:

  • Indicates lack of permissions or invalid authentication.
  • Confirm that your account has partner permissions enabled.
  • Verify that the client account belongs to your partner network.
  • Check that your authentication token is valid and has not expired.

If errors occur, review the detailed error message returned by the node, which includes technical details such as the API endpoint, status code, and parameter values.

Links and References

• ZapSign API Documentation (general reference for API endpoints and parameters)
• ZapSign Partner API section (for managing partner accounts and payment statuses)

Summary of execute() logic for Partnership - Update Payment Status

• Retrieves the clientApiToken and paymentStatus input parameters.
• Constructs a POST request to the endpoint /api/v1/partner/update-payment-status/ with JSON body containing these parameters.
• Sends the request to the appropriate ZapSign API base URL depending on environment (sandbox or production).
• Handles API responses:
  • On success, pushes the API response to the output array.
  • On failure, throws an error with detailed messages including common causes and troubleshooting tips.
• Supports multiple input items processed sequentially.
• Returns the collected results as JSON output.