Zoho Books icon

Zoho Books

Consume Zoho Books API

Actions76

Credit Note → Get Many

AI-generated

Overview

This node operation retrieves multiple credit notes from Zoho Books, a cloud accounting software. It allows users to fetch a list of credit notes with various filtering, sorting, and pagination options. This is useful for scenarios such as generating reports, syncing credit note data with other systems, or monitoring credit note statuses in bulk.

For example, a user might want to get all credit notes created within a specific date range, filter by status (e.g., only "Open" credit notes), or retrieve credit notes related to a particular customer. The node supports returning either all matching results or a limited subset with pagination controls.

Properties

Name Meaning
Return All Whether to return all matching credit notes or limit the number of results returned. If false, the number of results is limited by the "Limit" property.
Limit Maximum number of credit notes to return when "Return All" is false. Must be between 1 and 200.
Filters Collection of filter and sort options to refine the credit notes retrieved:
  Status Filter credit notes by their status. Options: Draft, Sent, Open, Closed, Void.
  From Date Only include credit notes dated on or after this date (format YYYY-MM-DD).
  To Date Only include credit notes dated on or before this date (format YYYY-MM-DD).
  Customer Filter credit notes by a specific customer. The customer can be selected from a dynamically loaded list.
  Updated Since Only return credit notes updated after this ISO-8601 timestamp.
  Search Text Search credit notes containing this text, e.g., credit note number or customer name.
  Sort By Field to sort the credit notes by. Options: Date, Customer Name, Total, Created Time, Last Modified.
  Sort Order Sort order direction. Options: Ascending, Descending.
  Page Page number for pagination (only applies if "Return All" is false).
  Per Page Number of results per page (max 200, only applies if "Return All" is false).

Output

The output is an array of JSON objects representing credit notes. Each item corresponds to one credit note record retrieved from Zoho Books. The structure includes all standard credit note fields as provided by the Zoho Books API, such as ID, date, status, customer details, total amount, and other metadata.

If the node is configured to return multiple items, each credit note is output as a separate item with its JSON data under the json key.

The node does not output binary data.

Dependencies

  • Requires an active connection to Zoho Books via OAuth2 authentication.
  • The node depends on the Zoho Books API being accessible and the credentials having sufficient permissions to read credit notes.
  • No additional environment variables are required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Authentication errors if the OAuth2 token is expired or invalid.
    • API rate limits may cause requests to fail; ensure proper handling or retry logic.
    • Invalid filter values (e.g., incorrect date formats) may result in API errors.
    • Requesting too many records without pagination may lead to timeouts or large payloads.

  • Error messages:

    • "Unsupported resource: creditNote": Indicates the resource is not implemented or incorrectly specified. Should not occur here since creditNote is supported.
    • API errors returned from Zoho Books will be surfaced, such as permission denied or invalid parameters.

  • Resolutions:

    • Refresh or reauthorize the API credentials if authentication fails.
    • Use valid date formats (YYYY-MM-DD for dates, ISO-8601 for timestamps).
    • Use pagination and limits to avoid large data loads.
    • Check that the user account has access rights to view credit notes.

Links and References

Discussion