MuleSoft Connector for Zoho Books

Build 20.0.7654


Retrieves list of vendor credits.

Table Specific Information


The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

  • VendorCreditNumber supports the '=' comparison.
  • Date supports the '=,<,>' comparisons.
  • LastModifiedTime supports the '=' comparison.
  • ReferenceNumber supports the '=' comparison.
  • Status supports the '=' comparison.
  • Total supports the '=,<,<=,>,>=' comparisons.
  • CustomerId supports the '=' comparison.
  • VendorCreditsFilter supports the '=' comparison.
  • LineItemId supports the '=' comparison.
  • ItemId supports the '=' comparison.
  • TaxId supports the '=' comparison.
  • CustomerName supports the '=' comparison.
  • ItemDescription supports the '=' comparison.
  • Notes supports the '=' comparison.
  • ItemName supports the '=' comparison.
For example:
    SELECT * FROM VendorCredits WHERE Total >= 100 AND Status = 'open'

    SELECT * FROM VendorCredits WHERE VendorCreditNumber = 'CN-00001'


Name Type References SupportedOperators Description
VendorCreditId [KEY] String ID of a vendor credit.
VendorCreditNumber String Number of a vendor credit.
VendorName String Name of the vendor the vendor credit has been made.
Balance Decimal Balance of a vendor credit.
ColorCode String Color code of vendor credit.
CreatedTime Datetime Time at which the vendor credit was created.
CurrencyCode String Currency code of the customer's currency.
CurrencyId String


Currency ID of the customer's currency.
CurrentSubStatus String Current sub status of a vendor credit.
CurrentSubStatusId String Current sub status ID of a vendor credit.
Date Date =,<,> Date of the vendor credit.
HasAttachment Boolean Check if vendor credit has attachment.
LastModifiedTime Datetime Last modfified time of the vendor credit.
ReferenceNumber String Reference number of the vendor credit.
Status String Status of the vendor credit.

The allowed values are open, closed, void.

Total Decimal =,<,<=,>,>= Total of vendor credits. Search by total amount.


Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CustomerId String Id of a customer.
VendorCreditFilter String Filter vendor credits by statuses.

The allowed values are Status.All, Status.Open, Status.Draft, Status.Closed, Status.Void.

LineItemId String Id of a line item.
ItemId String Id of an item.
TaxId String Id of a tax.
CustomerName String Name of the vendor.
ItemDescription String Description of an item.
Notes String Notes of a vendor credit.
ItemName String Name of an item.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654