RecurringInvoiceTransactions
Last updated
Last updated
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_CustomFieldAggregate
String
False
false
false
Am XML aggregate of custom field information.
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.