JDBC Driver for QuickBooks Online

Build 22.0.8675

RecurringInvoiceTransactions

Create and query QuickBooks Recurring Transaction for Invoice.

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 Id of the Recurring Transaction.

Invoice_SyncToken String True False False

The Version number of the object.

Invoice_MetaData_CreateTime Datetime True True True

The time the record was created.

Invoice_MetaData_LastUpdatedTime Datetime True True True

The time the record was last updated.

Invoice_DocNumber String False True True

The reference number for the transaction.

Invoice_TxnDate Date False True True

The date entered by the user when this transaction occurred.

Invoice_PrivateNote String False False False

A private note for the transaction, which does not appear on the transaction records.

Invoice_TxnStatus String False False False

The status of the transaction.

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

Invoice_LinkedTxnAggregate String False False False

An XML aggregate of transactions linked to the estimate.

Invoice_LineAggregate String False False False

An XML aggregate of the line items of a transaction.

Invoice_TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

The tax code for the transaction.

Invoice_TxnTaxDetail_TotalTax String False False False

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

Invoice_TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate of tax line items.

Invoice_RecurDataRef String False False False

The Recurrence Data reference.

Invoice_RecurDataRef_Name String True False False

An identifying name for the object.

Invoice_RecurringInfo_Name String False False False

The Recurring Info name.

Invoice_RecurringInfo_RecurType String False False False

The Recurring Info recurring type.

The allowed values are Automated, Reminded, UnScheduled.

Invoice_RecurringInfo_Active Boolean False False False

The Recurring Info is active or not.

Invoice_RecurringInfo_ScheduleInfo_IntervalType String False False False

The Recurring Info interval type.

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

Invoice_RecurringInfo_ScheduleInfo_NumInterval Integer False False False

The Recurring Info num interval.

Invoice_RecurringInfo_ScheduleInfo_DayOfWeek String False False False

The Recurring Info day of week.

Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth String False False False

The Recurring Info week of month.

Invoice_RecurringInfo_ScheduleInfo_MaxOccurrences String False False False

The max number of recurring occurrences.

Invoice_RecurringInfo_ScheduleInfo_RemindDays String False False False

The days before start date for a reminded RecurType.

Invoice_RecurringInfo_ScheduleInfo_MonthOfYear String False False False

The month of the year.

Invoice_RecurringInfo_ScheduleInfo_DaysBefore String False False False

The days before the scheduled date.

Invoice_RecurringInfo_ScheduleInfo_DayOfMonth String False False False

The day of the month.

Invoice_RecurringInfo_ScheduleInfo_StartDate Datetime False False False

The Recurring Info start date.

Invoice_RecurringInfo_ScheduleInfo_NextDate Datetime False False False

The Recurring Info next date.

Invoice_RecurringInfo_ScheduleInfo_EndDate Datetime False False False

The end date for the recurring schedule.

Invoice_RecurringInfo_ScheduleInfo_PreviousDate Datetime False False False

The Recurring Info previous date.

Invoice_CustomerRef String False

Customers.Id

True False

The Id of the customer.

Invoice_CustomerRef_Name String True

Customers.DisplayName

False False

The name of the customer.

Invoice_CustomerMemo String False False False

The message to the customer, which appears in the invoice and the printed invoice.

Invoice_BillAddr_Id String False False False

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

Invoice_BillAddr_Line1 String False False False

First line of the address.

Invoice_BillAddr_Line2 String False False False

Second line of the address.

Invoice_BillAddr_Line3 String False False False

Third line of the address.

Invoice_BillAddr_Line4 String False False False

Fourth line of the address.

Invoice_BillAddr_Line5 String False False False

Fifth line of the address.

Invoice_BillAddr_City String False False False

City name.

Invoice_BillAddr_Country String False False False

Country name.

Invoice_BillAddr_CountrySubDivisionCode String False False False

Region within a country. For example, the state name for the USA or the province name for Canada.

Invoice_BillAddr_PostalCode String False False False

Postal code. For example, the zip code for the USA and Canada.

Invoice_BillAddr_Note String False False False

Note for the customer.

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 Id of the entity for the shipping address, mainly used for modifying the address. This field is assigned by the data service.

Invoice_ShipAddr_Line1 String False False False

First line of the address.

Invoice_ShipAddr_Line2 String False False False

Second line of the address.

Invoice_ShipAddr_Line3 String False False False

Third line of the address.

Invoice_ShipAddr_Line4 String False False False

Fourth line of the address.

Invoice_ShipAddr_Line5 String False False False

Fifth line of the address.

Invoice_ShipAddr_City String False False False

City name.

Invoice_ShipAddr_Country String False False False

Country name.

Invoice_ShipAddr_CountrySubDivisionCode String False False False

Region within a country. For example, the state name for the USA and the province name for Canada.

Invoice_ShipAddr_PostalCode String False False False

Postal code. For example, the zip code for the USA and Canada.

Invoice_ShipAddr_Note String False False False

Note for the customer.

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 associated with the transaction.

Invoice_ClassRef_Name String True

Class.FullyQualifiedName

False False

The name of the class associated with the transaction.

Invoice_SalesTermRef String False

Terms.Id

False False

The Id of the sales terms associated with the transaction.

Invoice_SalesTermRef_Name String True

Terms.Name

False False

The name of the sales terms associated with the transaction.

Invoice_DueDate Date False True False

The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.

Invoice_ShipMethodRef String False False False

The Id of the shipping method associated with the transaction.

Invoice_ShipMethodRef_Name String True False False

The name of the shipping method associated with the transaction.

Invoice_ShipDate Date False False False

The date for delivery of goods or services.

Invoice_TrackingNum String False False False

The tracking number for the shipping provider for the delivery of the goods associated with the transaction.

Invoice_TotalAmt Decimal True True True

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

Invoice_PrintStatus String False False False

The print status of the invoice.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

Invoice_EmailStatus String False False False

The email status of the invoice.

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 EmailStatus is NeedToSend, BillEmail is a required input.

Invoice_Balance Decimal True True True

This field indicates whether the transaction is a finance charge.

Invoice_DepartmentRef String False

Departments.Id

False False

The Id of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online.

Invoice_DepartmentRef_Name String True

Departments.Name

False False

The name of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online.

Invoice_AllowOnlineCreditCardPayment Boolean False False False

It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.

Invoice_ApplyTaxAfterDiscount Boolean False False False

This field sets whether discounts are applied before the tax is calculated.

Invoice_CurrencyRef String False False False

The Id of the currency used in the transaction.

Invoice_CurrencyRef_Name String True False False

The name of the currency used in the transaction.

Invoice_ExchangeRate Decimal False False False

The currency exchange rate. Valid only if the company file is set up to use multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available for only the UK, AU, IN, and CA editions.

Invoice_GlobalTaxCalculation String False False False

The method in which tax is applied. This field is valid in the UK, AU, IN, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Invoice_HomeTotalAmt Decimal True False False

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

Invoice_AllowOnlineCreditCardPayment Boolean True False False

To allow Online Credit Card Payment or not.

Invoice_AllowOnlineACHPayment Boolean True False False

To allow Online ACH Payment or not.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8675