Actions17
Overview
This node interacts with the Zoho Books API to manage customer payments, specifically supporting the "Get Many" operation for the "Customer Payment" resource. It retrieves multiple customer payment records from Zoho Books, optionally filtered, paginated, or sorted using additional parameters.
Common scenarios where this node is beneficial include:
- Fetching a list of all customer payments within a specific date range.
- Retrieving payments filtered by status or other criteria.
- Integrating Zoho Books payment data into reporting or accounting workflows.
- Synchronizing payment records with other systems.
For example, a user might use this node to get all customer payments made in the last month to generate a financial report or to update a CRM system with recent payment information.
Properties
| Name | Meaning |
|---|---|
| Additional Get All Parameters (JSON) | JSON object containing extra parameters for filtering, pagination, and sorting the results when retrieving many customer payments. For example, you can specify page number, page size, filters on dates, or sort order. |
Output
The output is an array of JSON objects representing customer payment records retrieved from Zoho Books. Each item corresponds to one customer payment and includes fields as returned by the Zoho Books API under the customer_payments key.
Typical fields in each payment record may include:
- Payment ID
- Customer ID
- Amount paid
- Payment date
- Payment mode (e.g., Cash, Cheque, Bank Transfer)
- Description
- Applied invoices and amounts
If the operation fails for any input item and "Continue On Fail" is enabled, the output will contain an error object describing the failure for that item.
The node does not output binary data.
Dependencies
- Requires an OAuth2 API credential configured for Zoho Books with access to the organization.
- The credential must include the Zoho Books Organization ID.
- The node uses the Zoho Books API endpoint corresponding to the domain specified in the credentials.
- No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
- Missing Organization ID: If the organization ID is not set in the credentials, the node will throw an error indicating it is required.
- Invalid JSON in Additional Parameters: If the "Additional Get All Parameters" property contains invalid JSON, the node will throw an error specifying the JSON must be valid.
- API Errors: Errors returned by Zoho Books API will be parsed and shown with their code and message if available. Common issues include invalid filters, unauthorized access, or rate limits.
- Required Parameter Missing: For "Get Many" operation, no mandatory parameters besides credentials are needed, but if used incorrectly with other operations, missing IDs or emails will cause errors.
- Network Issues: Connectivity problems or incorrect credentials will result in request failures.
To resolve errors:
- Ensure the OAuth2 credential is correctly set up with the organization ID.
- Validate JSON inputs carefully.
- Check API permissions and network connectivity.
- Use "Continue On Fail" to handle partial failures gracefully.