MuleSoft Connector for Zoho Books

Build 20.0.7654


Get the details of an invoice.

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.
Note: InvoiceId is required in order to query InvoiceDetails.

  • InvoiceId supports the '=' comparison.
For example:
    SELECT * FROM InvoiceDetails WHERE InvoiceId = '1864543000000078539'


Name Type References SupportedOperators Description
InvoiceId [KEY] String


Id of an invoice.
InvoiceNumber String Number of an invoice.
InvoiceUrl String URL of an invoice.
AchPaymentInitiated Boolean Check if the Automated Clearing House payment is initiated.
AchSupported Boolean Check if Automated Clearing House is supported.
Adjustment Decimal Adjustments made to the invoice.
AdjustmentDescription String Description of adjustments made to the invoice.
AllowPartialPayments Boolean Check if invoice can allow partial payments.
ApproverId String


ID of an approver.
AttachmentName String Name of the attachment.
Balance Decimal The unpaid amount.
BcyAdjustment Decimal Adjustment of base currency.
BcyDiscountTotal Decimal Total discount applied in base currency.
BcyShippingCharge Decimal Shipping charge applied in base currency.
BcySubTotal Decimal Sub total of base currency.
BcyTaxTotal Decimal Tax total of base currency.
BcyTotal Decimal Total Base Currency.
BillingAddress String Billing address of an invoice.
BillingAddressAttention String Name of a person in billing address.
BillingAddressCity String City of a billing address.
BillingAddressCountry String Country of a billing address.
BillingAddressFax String Fax of a billing address.
BillingAddressPhone String Phone number of a billing address.
BillingAddressState String State of a billing address.
BillingAddressStreet2 String Street two of a billing address.
BillingAddressZip String ZIP code of a billing address.
CanSendInMail Boolean Check if invoice can be send in mail.
CanSendInvoiceSms Boolean Check if invoice can be send in SMS.
ClientViewedTime String Last time when client viewed the invoice.
ColorCode String Color code of invoice.
ContactCategory String Category of a contact.
ContactPersonsDetails String Details of a contact person.
CreatedById String


Id of a user who has created invoice.
CreatedTime Datetime Time at which the invoice was created.
CreditsApplied Decimal Applied credits for invoice.
CurrencyCode String Currency code of the customer's currency.
CurrencyId String


Currency ID of the customer's currency.
CurrencySymbol String Symbol of currency.
CurrentSubStatus String Current sub status of an invoice .
CurrentSubStatusId String Current sub status ID of an invoice .
CustomerDefaultBillingAddress String Customer default billing address of an invoice.
CustomerDefaultBillingAddressCity String City of a billing address.
CustomerDefaultBillingAddressCountry String Country of a billing address.
CustomerDefaultBillingAddressFax String Fax of a billing address.
CustomerDefaultBillingAddressPhone String Phone number of a billing address.
CustomerDefaultBillingAddressState String State of a billing address.
CustomerDefaultBillingAddressStateCode String State code of a customer default billing address.
CustomerDefaultBillingAddressStreet2 String Street two of a customer default billing address.
CustomerDefaultBillingAddressZip String ZIP code of a customer default billing address.
CustomerId String


ID of the customer or vendor.
CustomerName String Name of the customer or vendor.
Date Date Date of an invoice.
Discount String Discount given to specific item in invoice.
DiscountAmount Decimal Amount of discount.
DiscountAppliedOnAmount Decimal Discount applied on amount.
DiscountPercent Decimal Percent of discount applied.
DiscountTotal Decimal Total amount get on discount.
DiscountType String Type of discount.
DueDate Date Delivery date of the invoice.
EcommOperatorGstNo String GST number of the ecommerce operator.
EcommOperatorId String ID of the ecommerce operator.
EcommOperatorName String Name of the ecommerce operator.
EstimateId String


ID of an estimate.
Ewaybills String Electronic way bills of the invoice.
ExchangeRate Decimal Exchange rate of the currency.
FiledInVatReturnId String VAT return ID of bill which was filed.
FiledInVatReturnName String VAT return name of bill which was filed.
FiledInVatReturnType String VAT return type of bill which was filed.
GstNo String GST number.
GstReturnDetailsReturnPeriod String Return period of GST.
GstReturnDetailsStatus String Status of GST return.
GstTreatment String Choose whether the invoice is GST registered/unregistered/consumer/overseas. .
HasNextInvoice Boolean Check if it has next invoice.
IsAutobillEnabled Boolean Check if the autobill is enabled for this invoice.
IsClientReviewSettingsEnabled Boolean Check if the client review settings is enabled or not.
IsDiscountBeforeTax Boolean Check if the invoice is discounted before tax.
IsEmailed Boolean Check if the invoice can be emailed.
IsEwayBillRequired Boolean Check if the eway bill is required.
IsInclusiveTax Boolean Check if the invoice is inclusive tax.
IsPreGst Boolean Check if pre GST is applied.
IsTaxable Boolean Check if invoice is taxable.
IsViewedByClient Boolean Check if the invoice is viewed by client.
LastModifiedById String


Id of the user last modified.
LastModifiedTime Datetime The time of last modification of the invoice.
LastPaymentDate Date Date when last payment was made.
LastReminderSentDate Date Date when last reminder was sent for an invoice.
MerchantGstNo String GST number of a merchant.
MerchantId String ID of a merchant.
MerchantName String Name of a merchant.
NoOfCopies Integer Total number of copies for invoice.
Notes String Notes for this invoice.
Orientation String Orientation of the page.
PageHeight String Height of the page.
PageWidth String Width of the page.
PaymentDiscount Decimal Discount applied on payment.
PaymentExpectedDate Date Expected date of payment.
PaymentMade Decimal Total amount of payment made.
PaymentReminderEnabled Boolean Check if the payment reminder is enabled for the invoice.
PaymentTerms Integer Net payment term for the customer.
PaymentTermsLabel String Label for the paymet due details.
PlaceOfSupply String The place of supply is where a transaction is considered to have occurred for VAT purposes.
PricePrecision Integer The precision for the price.
ReaderOfflinePaymentInitiated Boolean Check if the payment for offline reader is initiated.
ReasonForDebitNote String Description of having the debit note.
RecurringInvoiceId String


Id of a recurring invoice.
ReferenceNumber String Reference number of invoice.
RemindersSent Integer Total number of reminders sent for this invoice.
ReverseChargeTaxTotal Decimal Total amount of reverse charge tax.
RoundoffValue Decimal Rounding off the values to precise number.
SalesorderId String


ID of a sales order.
SalespersonId String ID of a sales person.
SalespersonName String Name of a sales person.
ScheduleTime String Time scheduled for the invoice.
ShipmentCharges String Charges deducted for shipment.
ShippingAddress String Shipment Address.
ShippingAddressAttention String Name of a person of shipping address.
ShippingAddressCity String City of a shipping address.
ShippingAddressCountry String Country of a shipping address.
ShippingAddressFax String Fax of a shipping address.
ShippingAddressPhone String Phone number of a shipping address.
ShippingAddressState String State of a shipping address.
ShippingAddressStreet2 String Street two details of a shipping address.
ShippingAddressZip String Zip code of a shipping address.
ShippingCharge Decimal Shipping charge of invoice.
ShippingBills String Shipping bills of invoice.
ShowNoOfCopies Boolean Check if the invoice can show number of copies.
Status String Status of the invoice.
StopReminderUntilPaymentExpectedDate Boolean Check if reminder can be stopped untill the payment expected date.
SubTotal Decimal Sub total of the invoice.
SubTotalInclusiveOfTax Decimal Subtotal amount which are inclusive of tax.
SubmittedBy String Detail of the user who has submitted the invoice.
SubmittedDate Date Date when invoice was submitted.
SubmitterId String


Id of the invoice submitter.
TaxAmountWithheld Decimal Amount withheld for tax.
TaxRegNo String Registration number of tax.
TaxSpecification String Working of tax when specifying special tax options and tax methods for earnings codes.
TaxTotal Decimal Total number ot tax applied in the invoice.
TaxTreatment String VAT treatment for the Invoice.
TemplateId String ID of a template.
TemplateName String Name of a template.
TemplateType String Type of a template.
Terms String Terms and Conditions apply of a invoice.
Total Decimal Total of invoices.
TransactionRoundingType String Type of round off used for transaction.
Type String Types of invoice.
UnusedRetainerPayments Decimal Payment of the invoice which is unused.
VatTreatment String VAT treatment for the bills.
WriteOffAmount Decimal Amount to be write off.

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