Actions17
Overview
This node integrates with the Zoho Books API to create a customer payment record. It allows users to record payments made by customers, specifying details such as the customer ID, payment amount, date, mode, and optionally apply the payment to one or more invoices. This is useful for automating financial workflows, keeping accounting records up-to-date, and reconciling payments against outstanding invoices.
Practical examples:
- Automatically recording a payment received from a customer after an online transaction.
- Applying partial or full payments to multiple invoices in Zoho Books.
- Adding descriptive notes or metadata to payments for better tracking.
Properties
| Name | Meaning |
|---|---|
| Customer ID (for Payment) | The unique identifier of the customer making the payment. |
| Amount | The total amount of the payment being recorded. |
| Payment Date | The date when the payment was made, formatted as YYYY-MM-DD. |
| Payment Mode | The method used for the payment, e.g., Cash, Cheque, Bank Transfer. |
| Description | A textual description or note about the payment. |
| Invoices to Apply Payment | A collection of invoices to which this payment should be applied. Each includes: |
| - Invoice ID: Identifier of the invoice. | |
| - Amount Applied: The portion of the payment amount applied to that invoice. | |
| Additional Payment Data (JSON) | Extra JSON data fields to include when creating the payment; merged with other properties. |
Output
The node outputs an array of JSON objects representing the created customer payment(s). Each output item contains the detailed response from Zoho Books API about the payment, including identifiers, amounts, dates, and any other relevant metadata returned by the API.
If the operation fails, the output may contain an error object describing the issue.
The node does not output binary data.
Dependencies
- Requires an OAuth2 authenticated connection to Zoho Books API.
- The user must provide valid credentials including an organization ID configured in the credentials.
- Network access to Zoho Books API endpoints (
https://www.zohoapis{domain}/books/v3).
Troubleshooting
- Missing Organization ID: The node throws an error if the organization ID is not set in the credentials. Ensure your Zoho Books credentials include this.
- 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.
- Required Fields Missing: For creation, the customer ID is mandatory. Omitting it results in an error.
- Invoice ID Format: When applying payments to invoices, invoice IDs are sanitized to digits only. Ensure correct invoice IDs are provided.
- API Errors: Errors returned by Zoho Books API are parsed and shown with code and message. Check the API documentation for error meanings.
- Continue on Fail: If enabled, errors for individual items do not stop execution but are returned as error objects in output.