ADO.NET Provider for QuickBooks

Build 21.0.7867

CheckLineItems

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

Table Specific Information

Checks may be inserted, queried, or updated via the Checks, CheckExpenseItems, or CheckLineItems tables. Checks may be deleted by using the Checks table.

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Checks are Id, Date, ReferenceNumber, Payee, PayeeId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM Checks WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a Check, specify an Account, a Date, and at least one Expense or Line Item. All Line Item columns can be used for inserting multiple Line Items for a new Check transaction. For example, the following will insert a new Check with two Line Items:

INSERT INTO CheckLineItems#TEMP (Account, Date, ItemName, ItemQuantity) VALUES ('Checking', '1/1/2011', 'Repairs', 1)
INSERT INTO CheckLineItems#TEMP (Account, Date, ItemName, ItemQuantity) VALUES ('Checking', '1/1/2011', 'Removal', 2)
INSERT INTO CheckLineItems (Account, Date, ItemName, ItemQuantity) VALUES Account, Date, ItemName, ItemQuantity FROM CheckLineItems#TEMP

Columns

Name Type ReadOnly References ColumnSize Description
ID [KEY] String True 255

The unique identifier in the format CheckId|ItemLineId.

CheckId String False

Checks.ID

255

The item identifier for the check. This is obtained from the checks table.

ReferenceNumber String False 21

The transaction reference number.

TxnNumber Integer True

The transaction number. An identifying number for the transaction, different from the QuickBooks-generated Id.

Account String False

Accounts.FullName

1000

The name of the account funds are being drawn from.

AccountId String False

Accounts.ID

255

The Id of the account funds are being drawn from.

Payee String False

Vendors.Name

1000

The name of the payee for the check.

PayeeId String False

Vendors.ID

255

The id of the payee for the check.

Date Date False

Date of transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value.

Amount Decimal True

Amount of the transaction.

Memo String False 5000

A memo regarding this transaction.

Address String True

Full address returned by QuickBooks.

Line1 String False 500

First line of the address.

Line2 String False 500

Second line of the address.

Line3 String False 500

Third line of the address.

Line4 String False 500

Fourth line of the address.

Line5 String False 41

Fifth line of the address.

City String False 255

City name for the address of the check.

State String False 255

State name for the address of the check.

PostalCode String False 30

Postal code for the address of the check.

Country String False 255

Country for the address of the check.

Note String False 41

Note for the address of the check.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

ItemLineId String True 255

The line item identifier.

ItemLineNumber String True 255

The line item number.

ItemName String False

Items.FullName

The item name.

ItemId String False

Items.ID

The item Id.

ItemGroup String False

Items.FullName

100

Item group name. Reference to a group of line items this item is part of.

ItemGroupId String False

Items.ID

255

Item group Id. Reference to a group of line items this item is part of.

ItemDescription String False 5000

A description of the item.

ItemQuantity Double False

The quantity of the item or item group specified in this line.

ItemUnitOfMeasure String False

UnitOfMeasure.Name

31

In a transaction line item, the name of the unit of measure is selected from within the item's available units. If the company file is enabled for only a single unit of measure per item, this must be the base unit. Only available in QBXML Version 7.0 and above.

ItemCost Double False

The unit cost for the item.

ItemAmount Decimal False

Total amount for the item.

ItemBillableStatus String False 13

Billing status of the item.

The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED.

The default value is EMPTY.

ItemCustomer String False

Customers.FullName

1000

The name of the customer who ordered the item.

ItemCustomerId String False

Customers.ID

255

The Id of the customer who ordered the item.

ItemClass String False

Class.FullName

1000

The name for the class of the item.

ItemClassId String False

Class.ID

255

The Id for the class of the item.

ItemInventorySiteId String False

InventorySites.ID

31

The inventory site Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteName String False

InventorySites.Name

255

The inventory site name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteLocationId String False 31

The inventory site location Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteLocationName String False 255

The inventory site location name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemTaxCode String False

SalesTaxCodes.Name

3

Sales tax information for this item. Available in only international editions of QuickBooks.

ItemTaxCodeId String False

SalesTaxCodes.ID

255

Sales tax Id information for this item. Available in only international editions of QuickBooks.

ItemCustomFields String False

The custom fields for this lineitem.

IsToBePrinted Boolean False

Whether this transaction is to be printed.

The default value is false.

IsTaxIncluded Boolean False

Determines if tax is included in the transaction amount. Available in only international editions of QuickBooks.

CurrencyName String False

Currency.Name

64

The name of the currency for this customer. A minimum QBXML Version of 8.0 is required for this feature.

CurrencyId String False

Currency.ID

255

The unique Id of the currency for this customer. A minimum QBXML Version of 8.0 is required for this feature.

ExchangeRate Double False

The market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the home currency.

TimeModified Datetime True

When the check was last modified.

TimeCreated Datetime True

When the check was created.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ApplyCheckToTxnId String

Identifies the transaction to be paid by this check. This can be used in updates and inserts.

ApplyCheckToTxnAmount String

The amount of the transaction to be paid by this check. This can be used in updates and inserts.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7867