Zoho Books icon

Zoho Books

Interact with Zoho Books API (OAuth2)

Overview

This node interacts with the Zoho Books API to manage contacts, invoices, and customer payments. Specifically, for the Contact resource with the Get Many operation, it retrieves multiple contact records from Zoho Books. This is useful when you want to fetch a list of contacts for reporting, synchronization, or further processing in your workflows.

Typical use cases include:

  • Retrieving all contacts or filtered subsets based on criteria such as pagination, sorting, or other filters.
  • Integrating Zoho Books contacts into CRM systems or marketing tools.
  • Automating data extraction for analytics or backup purposes.

For example, you could use this node to get all contacts who meet certain conditions (like being active customers) and then send them targeted emails or update their information elsewhere.

Properties

Name Meaning
Additional Get All Parameters (JSON) JSON object containing extra parameters for filtering, pagination, and sorting the results when retrieving many contacts. For example, you can specify page number, page size, or filter criteria here.

Output

The output is an array of JSON objects representing the contacts retrieved from Zoho Books. Each item corresponds to one contact and contains fields as returned by the Zoho Books API under the contact key.

Example structure of each output item’s json field:

{
  "contact_id": "123456789",
  "contact_name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  ...
}

If the operation fails for any input item and "Continue On Fail" is enabled, the output will contain an error object with an error property describing the issue.

No binary data is output by this operation.

Dependencies

  • Requires an OAuth2 authenticated connection to Zoho Books API.
  • The credentials must include a valid organization ID.
  • The node uses the Zoho Books API endpoint specific to the domain configured in the credentials.
  • Proper API permissions are required to read contacts.

Troubleshooting

  • Missing Organization ID: If the organization ID is not set in the credentials, the node will throw an error indicating that the Zoho Books Organization ID is required.
  • Invalid JSON in Additional Parameters: If the "Additional Get All Parameters" JSON is malformed, the node will throw an error specifying that 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 authentication, insufficient permissions, or invalid query parameters.
  • Required Parameters Missing: For other operations (not Get Many), missing required IDs (e.g., Contact ID) will cause errors.
  • To handle intermittent failures, enable "Continue On Fail" to allow the workflow to proceed with other items.

Links and References

Discussion