Zoho Books icon

Zoho Books

Interact with Zoho Books API (OAuth2)

Overview

This node integrates with the Zoho Books API to manage customer payments, specifically allowing you to delete a customer payment by its ID. It is useful in scenarios where you need to programmatically remove a payment record from your Zoho Books account, such as correcting mistakes or handling refunds.

For example, if a payment was entered incorrectly or needs to be voided, this node can delete that payment entry based on the provided Payment ID.

Properties

Name Meaning
Payment ID The unique identifier of the customer payment to delete. This is required for deletion.

Output

The output JSON contains an array of objects representing the result of the delete operation. For a successful deletion, the output includes:

  • success: A boolean indicating the operation succeeded (true).
  • message: A string message confirming the resource was deleted successfully (e.g., "Resource deleted successfully.").

Example output JSON:

[
  {
    "success": true,
    "message": "Resource deleted successfully."
  }
]

No binary data is produced by this operation.

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.
  • The node makes HTTP requests to the Zoho Books API endpoint specific to the user's domain and organization.

Troubleshooting

  • Missing Payment ID: If the Payment ID is not provided for the delete operation, the node will throw an error stating that the Payment ID is required.
  • API Errors: Errors returned by the Zoho Books API are parsed and presented with their code and message when available. Common issues include invalid IDs, insufficient permissions, or network problems.
  • Invalid Credentials: Ensure the OAuth2 credentials are valid and have the necessary scopes to delete customer payments.
  • Organization ID Missing: The node requires the organization ID in the credentials; if missing, it will throw an error.

To resolve errors, verify the Payment ID exists and is correct, check API credentials and permissions, and ensure network connectivity.

Links and References

Discussion