Actions17
Overview
This node interacts with the Zoho Books API to manage customer payments, specifically allowing retrieval of customer payment details by email address. It is useful in scenarios where you want to fetch payment records associated with a particular customer's email without needing their payment ID. For example, if you have a customer's email and want to quickly look up all payments they have made or verify payment details, this operation provides a direct way to do so.
Practical examples:
- Automatically retrieving payment information for a customer when processing support tickets.
- Integrating with CRM systems to display payment history based on customer email.
- Generating reports or notifications triggered by specific customer payments identified by email.
Properties
| Name | Meaning |
|---|---|
| Email (for Payment Get) | The email address of the customer whose payment information you want to retrieve. This must be provided to perform the "Get by Email" operation on customer payments. |
Output
The output is an array of JSON objects representing customer payment records retrieved from Zoho Books matching the specified email. Each object contains detailed fields about individual payments such as payment amount, date, mode, and related customer information.
If no payments are found, the output will be an empty array.
The node does not output binary data.
Example output structure snippet (simplified):
[
{
"customer_payment_id": "123456789",
"customer_id": "987654321",
"amount": 150.00,
"date": "2023-05-01",
"payment_mode": "Cash",
"reference_number": "Ref123",
"notes": "Payment received",
...
}
]
Dependencies
- Requires an OAuth2 authenticated connection to Zoho Books API.
- The credentials must include a valid organization ID configured in the credential settings.
- Network access to
https://www.zohoapis.{domain}/books/v3where{domain}depends on the Zoho region configured in credentials.
Troubleshooting
- Missing Organization ID: If the organization ID is not set in credentials, the node will throw an error indicating it is required.
- Email Not Provided: For the "Get by Email" operation on customer payments, the email property must be filled; otherwise, an error is thrown.
- Invalid JSON in Additional Parameters: If additional parameters are provided as JSON strings, invalid JSON will cause errors.
- API Errors: Errors returned by Zoho Books API will be surfaced with their code and message if available. Common issues include invalid authentication tokens, insufficient permissions, or incorrect resource identifiers.
- Empty Results: If no payments match the given email, the output will be empty but not an error.
To resolve errors:
- Ensure credentials are correctly configured with a valid organization ID.
- Provide a valid email address for the query.
- Validate any JSON input fields before running the node.
- Check API limits and permissions in Zoho Books.