JDBC Driver for QuickBooks Online

Build 25.0.9434

InvoiceLinkedTransactions

Tracks relationships between invoices and related transactions, such as payments or sales receipts, to help trace how invoices are settled and linked within the sales process.

Columns

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

The identifier (Id) of the linked transaction line item on the invoice.

InvoiceId [KEY] String False

Invoices.Id

True True

The Id of the invoice.

SyncToken String True False False

Specifies the version number of the object. It is used to lock an object for use by one app at a time. When 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.

MetaData_CreateTime Datetime True True True

The time when the record was created.

MetaData_LastUpdatedTime Datetime True True True

The time when the record was last updated.

CustomFieldAggregate String False False False

An XML aggregate of custom field information related to the invoice.

DocNumber String False True True

The reference number for the transaction.

TxnDate Date False True True

The date entered by the user when this transaction occurred.

PrivateNote String False False False

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

LinkedTxn_TxnId String False False False

The Id of the linked transaction.

LinkedTxn_TxnType String False False False

The type of the linked transaction.

LinkedTxn_TxnLineId String False False False

The line item Id of the linked transaction line item.

LineAggregate String False False False

An XML aggregate of all line items that are associated with the transaction. This value contains detailed information for each line item, including item references, descriptions, quantities, amounts, and tax codes, which can be parsed programmatically to reconstruct the full list of lines in the transaction.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

Specifies the tax code that is applied to the entire transaction. This value determines which tax rules, rates, and reporting categories QuickBooks Online uses to calculate taxes for the transaction and to classify it correctly on tax reports.

TxnTaxDetail_TotalTax String False False False

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

TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate that contains all individual tax line items that are associated with the transaction. Each tax line item can include the specific tax type, rate, amount, and jurisdiction. This value allows developers to parse or reconstruct the complete tax breakdown applied to the transaction for reporting or auditing purposes.

CustomerRef String False

Customers.Id

True False

The unique Id of the customer linked to the transaction. This value is used to associate the transaction with the correct customer record in QuickBooks Online for reporting, history, and follow-up actions.

CustomerRef_Name String True

Customers.DisplayName

False False

The full name of the customer that is linked to the transaction. This value reflects the name stored in QuickBooks Online for the referenced customer record and is displayed in reports and the UI for easy identification.

CustomerMemo String False False False

The message to the customer, which appears in the invoice and the printed 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.

BillAddr_Line1 String False False False

The first line of the billing address.

BillAddr_Line2 String False False False

The second line of the billing address.

BillAddr_Line3 String False False False

The third line of the billing address.

BillAddr_Line4 String False False False

The fourth line of the billing address.

BillAddr_Line5 String False False False

The fifth line of the billing address.

BillAddr_City String False False False

The city name of the billing address.

BillAddr_Country String False False False

The country name of the billing address.

BillAddr_CountrySubDivisionCode String False False False

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

BillAddr_PostalCode String False False False

Specifies the postal code of the billing address. For example, this value is the ZIP code for the USA or postal code Canada.

BillAddr_Lat String False False False

The latitude coordinate of the geocoded billing address.

BillAddr_Long String False False False

The longitude coordinate of the geocoded billing address.

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.

ShipAddr_Line1 String False False False

The first line of the shipping address.

ShipAddr_Line2 String False False False

The second line of the shipping address.

ShipAddr_Line3 String False False False

The third line of the shipping address.

ShipAddr_Line4 String False False False

The fourth line of the shipping address.

ShipAddr_Line5 String False False False

The fifth line of the shipping address.

ShipAddr_City String False False False

The city name of the shipping address.

ShipAddr_Country String False False False

The country name of the shipping address.

ShipAddr_CountrySubDivisionCode String False False False

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

ShipAddr_PostalCode String False False False

Specifies the postal code of the shipping address. For example, this value is the ZIP code for the USA or postal code Canada.

ShipAddr_Lat String False False False

The latitude coordinate of the geocoded shipping address.

ShipAddr_Long String False False False

The longitude coordinate of the geocoded shipping address.

ClassRef String False

Class.Id

True False

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

ClassRef_Name String True

Class.FullyQualifiedName

False False

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

SalesTermRef String False

Terms.Id

False False

The Id of the sales terms that are associated with the transaction.

SalesTermRef_Name String True

Terms.Name

False False

The name of the sales terms that are associated with the transaction.

DueDate Date False True False

Specifies 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.

ShipMethodRef String False False False

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

ShipMethodRef_Name String True False False

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

ShipDate Date False False False

The scheduled date on which the goods or services in the transaction are to be shipped or delivered to the customer. This value is used by QuickBooks Online to track fulfillment timelines, manage delivery commitments, and align invoices or estimates with the actual delivery date for reporting and audit purposes.

TrackingNum String False False False

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

TotalAmt Decimal True True True

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

PrintStatus String False False False

The print status of the invoice.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

EmailStatus String False False False

The email status of the invoice.

The allowed values are NotSet, NeedToSend, EmailSent.

The default value is NotSet.

BillEmail_Address String False False False

Specifies the email address where the invoice is sent. If the value of the EmailStatus attribute is NeedToSend, the billing email address (BillEmail) is required.

Balance Decimal False False False

Indicates whether the transaction is a finance charge.

DepartmentRef String False

Departments.Id

False False

The Id of the department that is used to store the location of the transaction as defined using location tracking in QuickBooks Online.

DepartmentRef_Name String True

Departments.Name

False False

The name of the department that is used to store the location of the transaction as defined using location tracking in QuickBooks Online.

AllowOnlineCreditCardPayment Boolean False False False

Specifies whether online credit-card payments are allowed for this invoice and corresponds to the Cards online-payment check box on the QuickBooks user interface.

ApplyTaxAfterDiscount Boolean False False False

Specifies whether discounts are applied before the tax is calculated.

CurrencyRef String False False False

The Id of the currency that is used in the transaction.

CurrencyRef_Name String True False False

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

ExchangeRate Decimal False False False

Specifies the currency exchange rate. This field is valid only when the company file is set up to use the 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, and CA editions.

GlobalTaxCalculation String False False False

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

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

HomeTotalAmt Decimal True False False

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

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