JDBC Driver for QuickBooks Online

Build 22.0.8675

PurchaseLineItems

Create, update, delete, and query QuickBooks Purchase Line Items.

Table Specific Information

Purchases may be inserted, queried, or updated via the Purchases or PurchaseLineItems tables. Purchases may be deleted by using the Purchases table.

Select

All filterable columns support the following operators:

  • =
  • !=
  • >=
  • <=
  • >
  • <
  • IN
  • LIKE
  • CONTAINS

The driver processes other filters client-side within the driver.

Insert

To add a Purchase, specify the AccountRef, PaymentType, and at least one Line Item. The following shows an example of inserting multiple Purchases, each with a single line. To insert a Purchase with multiple lines, see the example on the Purchases table. 

INSERT INTO PurchaseLineItems#TEMP (AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef) VALUES ('41',  'Cash', 0.01, 'ItemBasedExpenseLineDetail', '8')
INSERT INTO PurchaseLineItems#TEMP (AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef) VALUES ('41',  'Cash', 0.02, 'ItemBasedExpenseLineDetail', '8')
INSERT INTO PurchaseLineItems (AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef) SELECT AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef FROM PurchaseLineItems#TEMP

Columns

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

The Id of the line item of the purchase.

PurchaseId [KEY] String False

Purchases.Id

True True

The Id of the purchase.

SyncToken String True False False

Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime Datetime True True True

The time the record was created.

MetaData_LastUpdatedTime Datetime True True True

The time the record was last updated.

DocNumber String False True True

The reference number for the transaction.

TxnDate Date False True True

The date when this transaction occurred.

PrivateNote String False False False

A private note about the transaction. This note will not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard form.

Line_Id String False False False

The Id of the line item.

Line_Description String False False False

A description of the line item that appears in the printed record.

Line_Amount Decimal False False False

The total amount of the charges or discounts for the given line. This field includes the charges and allowances, but it excludes the tax amount.

Line_DetailType String False False False

The type of line in the transaction.

Line_ItemBasedExpenseLineDetail_ItemRef String False

Items.Id

False False

The Id of the item in the line item. When a line item lacks an ItemRef it is treated as documentation and the Line.Amount attribute is ignored.

Line_ItemBasedExpenseLineDetail_ItemRef_Name String True

Items.Name

False False

The name of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.

Line_ItemBasedExpenseLineDetail_ClassRef String False

Class.Id

False False

The Id of the class for the line item.

Line_ItemBasedExpenseLineDetail_ClassRef_Name String True

Class.Name

False False

The name of the class for the line item.

Line_ItemBasedExpenseLineDetail_UnitPrice Decimal False False False

The unit price of the subject item as referenced by ItemRef.

Line_ItemBasedExpenseLineDetail_Qty Double False False False

Number of items for the line.

Line_ItemBasedExpenseLineDetail_RatePercent Double False False False

The amount is expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.

Line_ItemBasedExpenseLineDetail_MarkupInfo_Value Double False False False

Markup value.

Line_ItemBasedExpenseLineDetail_MarkupInfo_Percent Double False False False

Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.

Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef String False False False

The Id of the entity for the price level for the markup.

Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef_Name String True False False

A name that identifies the price level for the markup.

Line_ItemBasedExpenseLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

The sales tax code for this item.

Line_ItemBasedExpenseLineDetail_CustomerRef String False

Customers.Id

False False

The Id of the customer associated with the expense.

Line_ItemBasedExpenseLineDetail_CustomerRef_Name String True

Customers.DisplayName

False False

The name of the customer associated with the expense.

Line_ItemBasedExpenseLineDetail_BillableStatus String False False False

The billable status of the expense.

The allowed values are Billable, NotBillable, HasBeenBilled.

Line_AccountBasedExpenseLineDetail_ClassRef String False

Class.Id

False False

The Id of the class entity of the expense.

Line_AccountBasedExpenseLineDetail_ClassRef_Name String True

Class.Name

False False

The name of the class entity of the expense.

Line_AccountBasedExpenseLineDetail_CustomerRef String False

Customers.Id

False False

The customer id for the expense.

Line_AccountBasedExpenseLineDetail_CustomerRef_Name String True

Customers.DisplayName

False False

The customer name for the expense.

Line_AccountBasedExpenseLineDetail_AccountRef String False

Accounts.Id

False False

The Id of the expense account of the expense.

Line_AccountBasedExpenseLineDetail_AccountRef_Name String True

Accounts.Name

False False

The name of the expense account of the expense.

Line_AccountBasedExpenseLineDetail_BillableStatus String False False False

The billable status of the expense.

The allowed values are Billable, NotBillable, HasBeenBilled.

Line_AccountBasedExpenseLineDetail_MarkupInfo_Value Double False False False

Markup value.

Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent Double False False False

Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.

Line_AccountBasedExpenseLineDetail_MarkupInfo_PriceLevelRef String False False False

The Id of price level for the markup.

Line_AccountBasedExpenseLineDetail_MarkupInfo_PriceLevelRef_Name String True False False

The name of the price level for the markup.

Line_AccountBasedExpenseLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

The type of line in the transaction.

AccountRef String False

Accounts.Id

False False

The Id of the account associated with the transaction.

AccountRef_Name String True

Accounts.Name

False False

A name that identifies the account associated with the transaction. Checks should reference a bank account and CreditCard should reference a credit card account.

PaymentType String False True True

The expense type.

The allowed values are Cash, Check, CreditCard.

EntityRef String False False False

Specifies the party with whom an expense is associated.

EntityRef_Name String True False False

Specifies the party with whom an expense is associated.

Credit Boolean False False False

This field is valid only for the CreditCard payment type.

TotalAmt Decimal True True True

The total amount due, determined the sum of the line items. This includes all charges, allowances, taxes, discounts, etc.

PrintStatus String False False False

The print status of the payment. This field is applicable only for checks. It is ignored for credit card charges or refunds.

DepartmentRef String False

Departments.Id

False False

The Id of the department, which stores the location of the transaction.

DepartmentRef_Name String True

Departments.Name

False False

The name of the department, which stores the location of the transaction.

Status String True False False

The status of the purchase.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

The transaction tax code.

TxnTaxDetail_TotalTax String False False False

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

TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate of tax line items.

CurrencyRef String False False False

The Id of the currency used in the transaction.

CurrencyRef_Name String True False False

The name of the currency used in the transaction.

ExchangeRate Double False False False

The currency exchange rate. This field is 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 the UK, AU, IN, and CA editions.

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.

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