ODBC Driver for Zoho Books

Build 25.0.9434

RecurringInvoiceDetails

To list, add, update and delete details of a recurring invoice.

Table Specific Information

Select

The driver uses the Zoho Books API to process WHERE clause conditions built with the following column and operator:

  • RecurringInvoiceId supports the '=' and IN operators.

NOTE: RecurringInvoiceId is required to query RecurringInvoiceDetails.

The rest of the filter is executed client-side in the driver.

For example: 

    SELECT * FROM RecurringInvoiceDetails WHERE RecurringInvoiceId = '1895453000000042244'
	SELECT * FROM RecurringInvoiceDetails WHERE RecurringInvoiceId IN (SELECT RecurringInvoiceId FROM RecurringInvoices)
	SELECT * FROM RecurringInvoiceDetails WHERE RecurringInvoiceId IN ('1895453000000042244','1895453000000042245')

Insert

INSERT can be executed by specifying the RecurrenceName, CustomerId, RecurrenceFrequency, and LineItems columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table. 

INSERT INTO RecurringInvoiceLineItems#TEMP (Name, itemid, rate, quantity) VALUES ('Cloth-Jeans', '3285934000000104097', '1700', '1')

INSERT INTO RecurringInvoiceDetails (RecurrenceName, CustomerId, RecurrenceFrequency, LineItems) VALUES ('MonthlyInvoice', '3285934000000104002', 'weeks', RecurringInvoiceLineItems#TEMP )

INSERT can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to insert using JSON array into this table. 

INSERT INTO RecurringInvoiceDetails (RecurrenceName, CustomerId, RecurrenceFrequency, LineItems) VALUES ('MonthlyInvoice', '3285934000000104023', 'weeks', '[{"Name":"Cloth-Jeans3", "ItemId":"3285934000000104097", "Rate":"1700", "Quantity":"1"}]')

Update

UPDATE can be executed by specifying the RECURRINGINVOICEID in the WHERE Clause. The columns that are not read-only can be updated. For example: 

INSERT INTO RecurringInvoiceLineItems#TEMP (Name,itemid,rate,quantity) VALUES ('Cloth-Jeans','3285934000000104097','1700','1')

UPDATE RecurringInvoiceDetails SET RecurrenceName = 'MonthlyInvoice', CustomerId = '3285934000000104002', RecurrenceFrequency = 'weeks', LineItems = 'RecurringInvoiceLineItems#TEMP' WHERE RECURRINGINVOICEID = '3285934000000268005'

UPDATE can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to update using JSON array into this table. 

UPDATE RecurringInvoiceDetails SET RecurrenceName = 'MonthlyInvoice', CustomerId = '3285934000000104002', RecurrenceFrequency = 'weeks', LineItems = '[{"Name":"Cloth-Jeans", "ItemId":"3285934000000104097", "Rate":"1700", "Quantity":"1"}]' WHERE RecurringInvoiceId = '3285934000000268005'

Delete

DELETE can be executed by specifying the RECURRINGINVOICEID in the WHERE Clause For example: 

DELETE FROM RecurringInvoiceDetails WHERE RECURRINGINVOICEID = '3285934000000268005'

Columns

Name Type ReadOnly References SupportedOperators Description
RecurringInvoiceId [KEY] String True

RecurringInvoices.RecurringInvoiceId

Id of a recurring invoice.

ActualChildInvoicesCount Integer True

Count total number of actual child invoices.

Adjustment Decimal False

Adjustments made to the recurring invoices.

AdjustmentDescription String False

Description of adjustments made to the recurring invoices.

AllowPartialPayments Boolean True

Check if the recurring invoice can allow partial payments.

AvataxUseCode String False

Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.

AvataxTaxCode String False

A tax code is a unique label used to group items together.

AvataxExemptNo String False

Exemption certificate number of the customer.

BcyAdjustment Decimal True

Adjustment of base currency.

BcyDiscountTotal Decimal True

Total discount applied in base currency.

BcyShippingCharge Decimal True

Shipping charge applied in base currency.

BcySubTotal Decimal True

Sub total of base currency.

BcyTaxTotal Decimal True

Tax total of base currency.

BcyTotal Decimal True

Total Base Currency.

BillingAddress String False

Billing address of a recurring invoice.

BillingAddressAttention String False

Name of a person in billing address.

BillingAddressCity String False

City of a billing address.

BillingAddressCountry String False

Country of a billing address.

BillingAddressFax String False

Fax of a billing address.

BillingAddressPhone String False

Phone number of a billing address.

BillingAddressState String False

State of a billing address.

BillingAddressStreet2 String False

Street two of a billing address.

BillingAddressZip String False

ZIP code of a billing address.

ChildEntityType String True

Entity type of a child in recurring invoice.

Comments String True

Comments.

CompanyName String True

Name of the company.

ContactCategory String True

Category of the contact.

ContactPersons String False

Contact persons of a contact.

CreatedById String True

Users.UserId

Id of a user who has created recurring invoice.

CreatedTime Datetime True

Time at which the recurring invoice was created.

CurrencyCode String True

Currency code of the customer's currency.

CurrencyId String False

Currencies.CurrencyId

Currency Id of the customer's currency.

CurrencySymbol String True

Symbol of the currency.

CustomerEmail String True

Email address of the customer.

CustomerMobilePhone String True

Mobile phone number of customer.

CustomerId String False

Contacts.ContactId

Id of the customer or vendor.

CustomerName String True

Name of the customer or vendor.

CustomerPhone String True

Phone number of a customer.

Discount String False

Discount given to specific item in recurring invoice.

DiscountAppliedOnAmount Decimal True

Amount from which discount was applied.

DiscountPercent Double True

Percentage of discount applied.

DiscountTotal Decimal True

Total amount get on discount.

DiscountType String False

Type to get discount in recurring invoice.

DispatchFromAddress String False

Dispatch from address details for the recurring invoice.

Email String False

Email address of the customer.

EndDate Date False

End date for the recurring invoice.

ExchangeRate Decimal False

Exchange rate of the currency.

IsAutoBillEnabled Boolean True

Check if autobill is enabled.

IsDiscountBeforeTax Boolean False

Check if the recurring invoice is discounted before tax.

IsInclusiveTax Boolean False

Check if the expense is inclusive tax.

IsPreGst Boolean True

Check if pre GST is applied.

LastModifiedById String True

Users.UserId

Id of the user last modified.

LastModifiedTime Datetime True

The time of last modification of the recurring invoice

LastSentDate Date True

The date at which the last recurring invoice was sent.

LineItems String False

Line items of an estimate.

ManualChildInvoicesCount Integer True

Count of manual child invoices.

NextInvoiceDate Date True

Date of a next invoice.

Notes String False

Notes for this recurring invoice.

Orientation String True

Orientation of a page.

PlaceOfSupply String False

The place of supply is where a transaction is considered to have occurred for VAT purposes.

PageHeight String True

Height of the page.

PageWidth String True

Width of the page.

PaidInvoicesTotal Decimal True

Total number of paid invoices.

PaymentTerms Integer False

Net payment term for the customer.

PaymentTermsLabel String False

Label for the paymet due details.

PaymentOptionsPaymentGateways String False

Payment Gateway used for payment.

PhotoUrl String True

Photo URL for recurring invoices.

PricePrecision Integer True

The precision for the price.

ProjectDetails String True

Details of project.

RecurrenceFrequency String False

Type of recurrence frequency the invoice is recurring.

RecurrenceName String False

Name of the recurrence.

RecurrencePreferences String False

Recurrence preferences for the recurring invoice.

ReferenceNumber String False

Reference number of a recurring invoice.

RepeatEvery Integer False

Recurrence time of the invoice.

RoundoffValue Decimal True

Rounding off the values to precise number.

SalespersonId String False

Id of a sales person.

SalespersonName String False

Name of a sales person.

ShipmentCharges String True

Shipment charges of recurring invoice.

ShippingAddress String False

Shipment Address.

ShippingAddressAttention String False

Name of a person of shipping address.

ShippingAddressCity String False

City of a shipping address.

ShippingAddressCountry String False

Country of a shipping address.

ShippingAddressFax String False

Fax of a shipping address.

ShippingAddressPhone String False

Phone number of a shipping address.

ShippingAddressState String False

State of a shipping address.

ShippingAddressStreet2 String False

Street two details of a shipping address.

ShippingAddressZip String False

Zip code of a shipping address.

ShippingCharge Decimal False

Shipping charge.

StartDate Date False

Starting date of recurring invoice.

Status String False

Status of the recurring invoice.

SubTotal Decimal True

Sub total of recurring invoices.

SubTotalInclusiveOfTax Decimal True

Subtotal amount which are inclusive of tax.

TaxTotal Decimal True

Total amount for tax.

Taxes String True

Taxes.

TDSSummary String True

TDS summary.

TemplateId String False

Id of a template.

TemplateName String True

Name of a template.

Terms String True

Terms and Conditions apply of a recurring invoice.

Total Decimal True

Total of recurring invoices.

TransactionRoundingType String True

Type of round off used for transaction.

UnpaidChildInvoicesCount Integer True

Count of total number of unpaid child invoices.

UnpaidInvoicesBalance Decimal True

Total amount of unpaid invoices.

VatTreatment String False

VAT treatment for the recurring invoices.

GstNo String False

GST number.

GstTreatment String False

Choose whether the recurring invoice is GST registered/unregistered/consumer/overseas.

TaxTreatment String False

VAT treatment for the recurring invoice.

BcyShippingChargeTax Decimal True

Shipping charge tax in base currency.

BillingAddressStreet String False

Street of the billing address.

CanGenerateEwaybillUsingIrn Boolean True

Indicates if e-waybill can be generated using IRN.

ContactPersonsAssociated String False

Associated contact persons.

CreatedByNames String True

Name of the user who created the invoice.

CurrencyNameFormatted String True

Formatted currency name.

CustomerCustomFieldHash String True

Hash map for customer custom fields.

DiscountAccountId String False

ID of the discount account.

DiscountAccountName String True

Name of the discount account.

IsBackorder Boolean False

Indicates if it's a backorder.

IsLastChildInvoice Boolean True

Indicates if it's the last child invoice.

IsProgressInvoice Boolean False

Indicates if it's a progress invoice.

IsTdsAmountInPercent Boolean False

Indicates if TDS amount is in percentage.

IsGeneralPreference Boolean False

Indicates if general preference is applied.

LockDetails String True

Details about invoice locking.

OfflineCreatedDateWithTime Datetime False

Date and time when invoice was created offline.

ReferenceInvoice String False

Reference invoice details.

SalesChannel String False

Sales channel of the invoice.

SalesorderNumber String True

Sales order number associated with the invoice.

Salesorders String True

Associated sales orders.

ShippingAddressStreet String False

Street of the shipping address.

ShippingChargeAccountId String False

ID of the shipping charge account.

ShippingChargeAccountName String True

Name of the shipping charge account.

ShippingChargeExclusiveOfTax Decimal True

Shipping charge exclusive of tax.

ShippingChargeExclusiveOfTaxFormatted String True

Formatted shipping charge exclusive of tax.

ShippingChargeInclusiveOfTax Decimal True

Shipping charge inclusive of tax.

ShippingChargeInclusiveOfTaxFormatted String True

Formatted shipping charge inclusive of tax.

ShippingChargeTax Decimal True

Shipping charge tax.

ShippingChargeTaxExemptionCode String False

Shipping charge tax exemption code.

ShippingChargeTaxExemptionId String False

Shipping charge tax exemption ID.

ShippingChargeTaxFormatted String True

Formatted shipping charge tax.

ShippingChargeTaxId String False

Shipping charge tax ID.

ShippingChargeTaxName String True

Shipping charge tax name.

ShippingChargeTaxPercentage Decimal True

Shipping charge tax percentage.

ShippingChargeTaxType String True

Shipping charge tax type.

SubStatuses String True

Sub-statuses of the invoice.

SubjectContent String False

Subject content of the invoice email.

SubmittedByEmail String True

Email of the user who submitted the invoice.

SubmittedByName String True

Name of the user who submitted the invoice.

SubmittedByPhotoUrl String True

Photo URL of the user who submitted the invoice.

TaxRounding String False

Tax rounding type.

Taxes String True

Tax details.

TdsAmount Decimal True

TDS amount.

TdsCalculationType String False

TDS calculation type.

TdsOverridePreference String False

TDS override preference.

TdsPercent Decimal False

TDS percentage.

TdsSection String False

TDS section.

TdsSummary String True

TDS summary.

TdsTaxId String False

TDS tax ID.

IsReverseChargeApplied Boolean False

Indicates if reverse charge is applied.

CfdiUsage String False

CFDI usage.

CfdiReferenceType String False

CFDI reference type.

CustomBody String False

Custom body for the invoice email.

CustomSubject String False

Custom subject for the invoice email.

Reason String False

Reason for the action.

TaxAuthorityId String False

Tax authority ID.

TaxExemptionId String False

Tax exemption ID.

TaxId String False

Tax ID.

ExpenseId String False

Expense ID.

IgnoreAutoNumberGeneration Boolean False

Ignore auto number generation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434