CData Python Connector for QuickBooks Online

Build 25.0.9454

RecurringInvoiceTransactions

Stores recurring invoice templates that automate billing for subscriptions, retainers, or repeat sales, improving cash-flow management.

Table Specific Information

We can perform Select and Insert operations on RecurringInvoiceTransactions table.

Select

Invoice_Id, Invoice_MetaData_CreateTime, Invoice_MetaData_LastUpdatedTime can be used for server side filter. The driver processes other filters client-side within the driver. 

SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_Id = 25529
SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_Id IN (25528, 25531, 25530)
SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_MetaData_CreateTime = '2020-03-19 19:49:51.0'
SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_MetaData_LastUpdatedTime = '2021-01-03 14:46:13'

Insert

To add a RecurringInvoiceTransactions following fields needs to be added:

  • A RecurringInvoiceTransactions object must have at least one line that describes an item.
  • A RecurringInvoiceTransactions object must have a RecurringInfo.

INSERT INTO RecurringInvoiceTransactions (Invoice_Id, Invoice_CustomerRef,  Invoice_RecurringInfo_Name, Invoice_RecurringInfo_RecurType, Invoice_RecurringInfo_Active, Invoice_RecurringInfo_ScheduleInfo_IntervalType, Invoice_RecurringInfo_ScheduleInfo_NumInterval, Invoice_RecurringInfo_ScheduleInfo_DayOfWeek, Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth, Invoice_RecurringInfo_ScheduleInfo_StartDate, Invoice_RecurringInfo_ScheduleInfo_NextDate, Invoice_RecurringInfo_ScheduleInfo_PreviousDate, Invoice_LineAggregate) VALUES (49, 2, 'TestingA11', 'Reminded', false,  'Weekly', 2,  'Tuesday', 3, '2021-12-08', '2021-12-15', '2021-09-01', '<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line><Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>')

Columns

Name Type ReadOnly References Filterable Sortable Description
Invoice_Id [KEY] String False

RecurringInvoiceTransactions.Invoice_Id

True True

The unique identifier (Id) of the recurring invoice transaction.

Invoice_SyncToken String True False False

The version number of the object that is used to lock the invoice for use by one application at a time. As soon as an application modifies an object, its sync token is incremented. Attempts to modify an object specifying an older sync token fail. Only the latest version of the object is maintained by QuickBooks Online.

Invoice_MetaData_CreateTime Datetime True True True

The date and time when the recurring invoice record was created in QuickBooks Online.

Invoice_MetaData_LastUpdatedTime Datetime True True True

The date and time when the recurring invoice record was last updated in QuickBooks Online.

Invoice_DocNumber String False True True

The reference number that is assigned to the recurring invoice transaction.

Invoice_TxnDate Date False True True

The date entered by the user when this recurring invoice transaction occurred.

Invoice_PrivateNote String False False False

A private note for the recurring invoice transaction that does not appear on the transaction records.

Invoice_TxnStatus String False False False

The status of the recurring invoice transaction.

The allowed values are Accepted, Closed, Pending, Rejected.

Invoice_LinkedTxnAggregate String False False False

An XML aggregate of all transactions that are linked to the recurring invoice.

Invoice_LineAggregate String False False False

An XML aggregate of all line items that are included in the recurring invoice transaction.

Invoice_TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

The unique Id of the tax code that is applied to the recurring invoice transaction.

Invoice_TxnTaxDetail_TotalTax String False False False

The total tax calculated for the recurring invoice transaction, excluding any tax lines manually inserted into the transaction line list.

Invoice_TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate of all tax line items that are associated with the recurring invoice transaction.

Invoice_RecurDataRef String False False False

The unique Id of the recurrence data reference that identifies the recurring invoice template or schedule.

Invoice_RecurDataRef_Name String True False False

The name of the recurrence data reference that identifies the recurring invoice template or schedule.

Invoice_RecurringInfo_Name String False False False

The descriptive name of the recurring invoice schedule or template.

Invoice_RecurringInfo_RecurType String False False False

The recurring type of the invoice schedule, such as scheduled, reminder, or unscheduled.

The allowed values are Automated, Reminded, UnScheduled.

Invoice_RecurringInfo_Active Boolean False False False

Indicates whether the recurring invoice schedule is active or inactive.

Invoice_RecurringInfo_ScheduleInfo_IntervalType String False False False

The interval type of the recurring invoice schedule that defines how often the invoice recurs (for example, weekly, monthly, or yearly).

The allowed values are Yearly, Monthly, Weekly, Daily.

Invoice_RecurringInfo_ScheduleInfo_NumInterval Integer False False False

The number of intervals for the recurring invoice schedule. This value determines how frequently the invoice recurs based on the interval type.

Invoice_RecurringInfo_ScheduleInfo_DayOfWeek String False False False

The day of the week on which the recurring invoice is scheduled to occur when the interval type is weekly.

Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth String False False False

The week of the month on which the recurring invoice is scheduled to occur when the interval type is monthly.

Invoice_RecurringInfo_ScheduleInfo_MaxOccurrences String False False False

The maximum number of occurrences allowed for the recurring invoice schedule.

Invoice_RecurringInfo_ScheduleInfo_RemindDays String False False False

The number of days before the start date on which a reminder for the recurring invoice should be sent.

Invoice_RecurringInfo_ScheduleInfo_MonthOfYear String False False False

The month of the year on which the recurring invoice is scheduled to occur when the interval type is yearly.

Invoice_RecurringInfo_ScheduleInfo_DaysBefore String False False False

The number of days before the scheduled date on which the recurring invoice is processed or triggered.

Invoice_RecurringInfo_ScheduleInfo_DayOfMonth String False False False

The day of the month on which the recurring invoice is scheduled to occur.

Invoice_RecurringInfo_ScheduleInfo_StartDate Datetime False False False

The start date of the recurring invoice schedule that is associated with the recurrence template.

Invoice_RecurringInfo_ScheduleInfo_NextDate Datetime False False False

The next scheduled date for the recurring invoice to occur.

Invoice_RecurringInfo_ScheduleInfo_EndDate Datetime False False False

The end date of the recurring invoice schedule when no further occurrences are generated.

Invoice_RecurringInfo_ScheduleInfo_PreviousDate Datetime False False False

The previous scheduled date on which the recurring invoice occurred.

Invoice_CustomerRef String False

Customers.Id

True False

The unique Id of the customer that is associated with the recurring invoice transaction.

Invoice_CustomerRef_Name String True

Customers.DisplayName

False False

The name of the customer that is associated with the recurring invoice transaction.

Invoice_CustomerMemo String False False False

A message to the customer that appears on the invoice and on the printed invoice.

Invoice_BillAddr_Id String False False False

The unique Id of the entity for the billing address, mainly used for modifying the address. This value is assigned by the data service.

Invoice_BillAddr_Line1 String False False False

First line of the billing address.

Invoice_BillAddr_Line2 String False False False

Second line of the billing address.

Invoice_BillAddr_Line3 String False False False

Third line of the billing address.

Invoice_BillAddr_Line4 String False False False

Fourth line of the billing address.

Invoice_BillAddr_Line5 String False False False

Fifth line of the billing address.

Invoice_BillAddr_City String False False False

City name of the billing address.

Invoice_BillAddr_Country String False False False

Country name of the billing address.

Invoice_BillAddr_CountrySubDivisionCode String False False False

Region within a country for the billing address. For example, this value is the state name for the USA or the province name for Canada.

Invoice_BillAddr_PostalCode String False False False

Postal code for the billing address. For example, this value is the ZIP code for the USA and the postal code for Canada.

Invoice_BillAddr_Note String False False False

Note for the customer included with the billing address.

Invoice_BillAddr_Lat String False False False

The latitude coordinate of the geocoded billing address.

Invoice_BillAddr_Long String False False False

The longitude coordinate of the geocoded billing address.

Invoice_ShipAddr_Id String False False False

The unique Id of the entity for the shipping address, mainly used for modifying the address. This value is assigned by the data service.

Invoice_ShipAddr_Line1 String False False False

First line of the shipping address.

Invoice_ShipAddr_Line2 String False False False

Second line of the shipping address.

Invoice_ShipAddr_Line3 String False False False

Third line of the shipping address.

Invoice_ShipAddr_Line4 String False False False

Fourth line of the shipping address.

Invoice_ShipAddr_Line5 String False False False

Fifth line of the shipping address.

Invoice_ShipAddr_City String False False False

City name of the shipping address.

Invoice_ShipAddr_Country String False False False

Country name of the shipping address.

Invoice_ShipAddr_CountrySubDivisionCode String False False False

Region within a country for the shipping address. For example, this value is the state name for the USA or the province name for Canada.

Invoice_ShipAddr_PostalCode String False False False

Postal code for the shipping address. For example, this value is the ZIP code for the USA and the postal code for Canada.

Invoice_ShipAddr_Note String False False False

Note for the customer included with the shipping address.

Invoice_ShipAddr_Lat String False False False

The latitude coordinate of the geocoded shipping address.

Invoice_ShipAddr_Long String False False False

The longitude coordinate of the geocoded shipping address.

Invoice_ClassRef String False

Class.Id

True False

The Id of the class that is associated with the recurring invoice transaction.

Invoice_ClassRef_Name String True

Class.FullyQualifiedName

False False

The name of the class that is associated with the recurring invoice transaction.

Invoice_SalesTermRef String False

Terms.Id

False False

The Id of the sales terms that is associated with the recurring invoice transaction.

Invoice_SalesTermRef_Name String True

Terms.Name

False False

The name of the sales terms that is associated with the recurring invoice transaction.

Invoice_DueDate Date False True False

The date when the invoice is due for payment, excluding any early-payment discount incentives or late-payment penalties. If no date is supplied, the current server date is used.

Invoice_ShipMethodRef String False False False

The Id of the shipping method that is associated with the recurring invoice transaction.

Invoice_ShipMethodRef_Name String True False False

The name of the shipping method that is associated with the recurring invoice transaction.

Invoice_ShipDate Date False False False

The date scheduled for delivery of goods or services that are associated with the recurring invoice transaction.

Invoice_TrackingNum String False False False

The tracking number that is provided by the shipping carrier for the delivery of goods that are associated with the recurring invoice transaction.

Invoice_TotalAmt Decimal True True True

The total monetary amount of the recurring invoice transaction. This amount includes all charges, allowances, and taxes.

Invoice_PrintStatus String False False False

The print status of the recurring invoice transaction.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

Invoice_EmailStatus String False False False

The email status of the recurring invoice transaction.

The allowed values are NotSet, NeedToSend, EmailSent.

The default value is NotSet.

Invoice_BillEmail_Address String False False False

The email address where the invoice is sent. If the value of the EmailStatus attribute is NeedToSend, the billing email address is required.

Invoice_Balance Decimal True True True

Indicates whether the recurring invoice transaction is a finance charge.

Invoice_DepartmentRef String False

Departments.Id

False False

The unique Id of the department or location that stores the recurring invoice transaction as defined by using location tracking in QuickBooks Online.

Invoice_DepartmentRef_Name String True

Departments.Name

False False

Name of the department or location that stores the recurring invoice transaction as defined by using location tracking in QuickBooks Online.

Invoice_AllowOnlineCreditCardPayment Boolean False False False

Indicates whether online credit-card payments are allowed for the recurring invoice transaction. Corresponds to the Cards Online Payment checkbox on the QuickBooks Online user interface.

Invoice_ApplyTaxAfterDiscount Boolean False False False

Sets whether discounts are applied before tax is calculated for the recurring invoice transaction.

Invoice_CurrencyRef String False False False

Id of the currency that is used in the recurring invoice transaction.

Invoice_CurrencyRef_Name String True False False

The name of the currency that is used in the recurring invoice transaction.

Invoice_ExchangeRate Decimal False False False

The currency exchange rate for the recurring invoice transaction. Valid only when the company file is set up to use the multicurrency feature. Exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. Available for the UK, AU, and CA editions.

Invoice_GlobalTaxCalculation String False False False

The method that is used to apply tax for the recurring invoice transaction. This field is valid in the UK, AU, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Invoice_HomeTotalAmt Decimal True False False

The total amount of the recurring invoice transaction expressed in the home currency. This amount includes all charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

Invoice_AllowOnlineCreditCardPayment Boolean True False False

To allow Online Credit Card Payment or not.

Invoice_AllowOnlineACHPayment Boolean True False False

Sets whether to allow online ACH (Automated Clearing House) payment for the recurring invoice transaction.

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