Zoho Books icon

Zoho Books

Interact with Zoho Books API (OAuth2)
Join our community

Actions17

Overview

This node interacts with the Zoho Books API to manage invoices, specifically supporting the "Get Many" operation for invoices. It allows users to retrieve multiple invoice records from their Zoho Books organization, optionally applying filters, pagination, and sorting through additional JSON parameters.

Common scenarios where this node is beneficial include:

  • Fetching a list of invoices for reporting or analysis.
  • Synchronizing invoice data between Zoho Books and other systems.
  • Automating workflows that require bulk invoice data retrieval.

For example, a user might configure this node to get all invoices issued in the last month or filter invoices by status using the additional JSON parameters.

Properties

Name Meaning
Additional Get All Parameters (JSON) JSON object containing extra parameters for filtering, pagination, and sorting the results when retrieving many invoices.

Example value for "Additional Get All Parameters (JSON)":

{
  "status": "paid",
  "page": 2,
  "per_page": 50,
  "sort_column": "date",
  "sort_order": "desc"
}

Output

The output is an array of JSON objects representing invoices retrieved from Zoho Books. Each item corresponds to one invoice record as returned by the Zoho Books API.

The structure of each invoice JSON object depends on Zoho Books' API response but typically includes fields such as:

  • Invoice ID
  • Customer ID
  • Invoice date
  • Due date
  • Invoice number
  • Line items
  • Amounts (discount, shipping charge, adjustment)
  • Notes and terms
  • Status and other metadata

If the operation fails for any input item and "Continue On Fail" is enabled, the output will contain an error object with an error message instead of invoice data for that item.

No binary data is output by this node.

Dependencies

  • Requires an OAuth2 API credential configured for Zoho Books with access to the target organization.
  • The credential must include the Zoho Books Organization ID.
  • The node makes HTTP requests to the Zoho Books API endpoint corresponding to the user's Zoho domain.
  • Proper permissions in Zoho Books are necessary to read invoice data.

Troubleshooting

  • Missing Organization ID: If the organization ID is not set in credentials, the node throws an error indicating it is required.
  • Invalid JSON in Additional Parameters: If the "Additional Get All Parameters" JSON is malformed, the node throws an error specifying the JSON must be valid.
  • API Errors: Errors returned by Zoho Books API are parsed and presented with code and message if available. Common causes include invalid filters, permission issues, or rate limits.
  • Required Parameters Missing: For other operations (not relevant here), missing IDs cause errors; ensure correct parameters are provided.
  • Network Issues: Connectivity problems or incorrect domain settings can cause request failures.

To resolve errors:

  • Verify the OAuth2 credential and organization ID.
  • Validate JSON inputs carefully.
  • Check Zoho Books API documentation for allowed query parameters.
  • Enable "Continue On Fail" to handle partial failures gracefully.

Links and References

Discussion