Actions17
Overview
This node interacts with the Zoho Books API to manage customer payments, specifically allowing you to retrieve a customer payment by its unique ID. It is useful in scenarios where you need to fetch detailed information about a specific payment made by a customer, such as verifying payment status, auditing transactions, or integrating payment data into other workflows.
For example, you might use this node to:
- Retrieve payment details for reconciliation purposes.
- Fetch payment information before issuing a refund.
- Display payment history in a custom dashboard.
Properties
| Name | Meaning |
|---|---|
| Payment ID | The unique identifier of the customer payment to retrieve, update, or delete. |
Output
The output is a JSON object representing the customer payment retrieved from Zoho Books. The structure typically includes fields such as payment ID, customer ID, amount, payment date, payment mode, description, and any invoices the payment was applied to.
If the operation is successful, the output will be an array containing one object with the payment details under the json key.
Example output structure (simplified):
{
"payment_id": "123456789",
"customer_id": "987654321",
"amount": 150.00,
"date": "2023-05-01",
"payment_mode": "Bank Transfer",
"description": "Payment for invoice #1001",
"invoices": [
{
"invoice_id": "1001",
"amount_applied": 150.00
}
]
}
No binary data output is produced by this operation.
Dependencies
- Requires an OAuth2 API authentication credential configured for Zoho Books.
- The credential must include the Zoho Books Organization ID.
- The node makes HTTP requests to the Zoho Books API endpoint, which depends on the domain specified in the credentials.
Troubleshooting
- Missing Payment ID: If the Payment ID property is not provided when performing the "Get by ID" operation, the node will throw an error indicating that the Payment ID is required.
- Invalid Credentials or Missing Organization ID: The node requires a valid organization ID in the credentials; if missing, it will raise an error.
- API Errors: If the Zoho Books API returns an error (e.g., invalid ID, permission issues), the node captures and reports the error message. Check the error details for codes and messages returned by Zoho Books.
- JSON Parsing Errors: Although not typical for this operation, if additional JSON parameters are used elsewhere, ensure they are valid JSON strings.
To resolve errors:
- Verify that the Payment ID is correctly set.
- Confirm that your Zoho Books credentials are valid and include the organization ID.
- Check network connectivity and API access permissions.
- Review the exact error message for clues and consult Zoho Books API documentation if needed.