Actions17
Overview
This node integrates with the Zoho Books API to update an existing customer payment record. It allows users to modify details such as the customer ID associated with the payment, the payment amount, date, mode, and additional custom data. This operation is useful in scenarios where payment information needs correction or updating after initial entry, such as adjusting amounts, changing payment methods, or adding notes.
Practical examples include:
- Correcting a payment amount entered incorrectly.
- Updating the payment date if it was recorded wrong.
- Changing the payment mode from "Cheque" to "Bank Transfer".
- Adding extra metadata to the payment via JSON for internal tracking.
Properties
| Name | Meaning |
|---|---|
| Payment ID | The unique identifier of the customer payment to update. |
| Customer ID (for Payment) | The customer ID associated with the payment. |
| Amount | The payment amount to be updated. |
| Payment Date | The date of the payment in YYYY-MM-DD format. |
| Payment Mode | The mode of payment, e.g., Cash, Cheque, Bank Transfer. |
| Additional Payment Data (JSON) | Additional JSON data to merge with other fields when updating the customer payment. |
Output
The output is a JSON object representing the updated customer payment resource returned by the Zoho Books API. The structure includes all standard fields of a customer payment such as IDs, amounts, dates, modes, and any additional data provided.
If the update operation is successful, the output contains the updated payment details under the key customer_payment. If the operation fails, an error message is returned in the JSON output.
No binary data is produced by this node.
Dependencies
- Requires an OAuth2 API credential configured for Zoho Books with access to the organization.
- The Zoho Books Organization ID must be set in the credentials.
- Network access to Zoho Books API endpoints (
https://www.zohoapis{domain}/books/v3) is required.
Troubleshooting
- Missing Payment ID: The node throws an error if the Payment ID is not provided for the update operation. Ensure the correct Payment ID is supplied.
- Invalid JSON in Additional Payment Data: If the additional payment data JSON is malformed, the node will throw an error. Validate JSON syntax before input.
- Organization ID Missing: The node requires the organization ID in credentials; missing this causes failure.
- API Errors: Errors from Zoho Books API are parsed and presented with code and message. Common issues include invalid IDs, insufficient permissions, or network problems.
- Continue on Fail: If enabled, errors for individual items do not stop execution but return error details in output.