CheckLineItems
Supports management of individual line items within QuickBooks Checks, including creation, updates, deletion, and queries.
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 CheckLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%' SELECT * FROM CheckLineItems WHERE Date >= '2020-01-07' AND Date < '2020-01-10' SELECT * FROM CheckLineItems WHERE [Date] = '2020-01-07'
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 for this line item, formatted as CheckId|ItemLineId, combining the check and line item details. | |
CheckId | String | False |
Checks.ID | 255 |
The unique identifier for the check associated with this line item, obtained from the Checks table. |
ReferenceNumber | String | False | 21 |
The reference number for the check transaction, used for identification and tracking. | |
TxnNumber | Integer | True |
A manually assigned transaction number to identify this check separately from the Quickbooks generated ID. | ||
Account | String | False | 1000 |
The name of the account from which the funds for this check are being drawn. | |
AccountId | String | False |
Accounts.ID | 255 |
The unique identifier of the account from which the funds for this check are being drawn. |
Payee | String | False | 1000 |
The name of the payee associated with this check. | |
PayeeId | String | False |
Vendors.ID | 255 |
The unique identifier of the payee associated with this check. |
Date | Date | False |
The date of the check transaction. | ||
Amount | Decimal | True |
The total amount of the check transaction. | ||
Memo | String | False | 5000 |
A memo providing additional details about this check transaction. | |
Address | String | True |
The full address associated with this check, as returned by QuickBooks. | ||
Line1 | String | False | 500 |
The first line of the address associated with this check. | |
Line2 | String | False | 500 |
The second line of the address associated with this check. | |
Line3 | String | False | 500 |
The third line of the address associated with this check. | |
Line4 | String | False | 500 |
The fourth line of the address associated with this check. | |
Line5 | String | False | 41 |
The fifth line of the address associated with this check. | |
City | String | False | 255 |
The city associated with the address of the check. | |
State | String | False | 255 |
The state associated with the address of the check. | |
PostalCode | String | False | 30 |
The postal code associated with the address of the check. | |
Country | String | False | 255 |
The country associated with the address of the check. | |
Note | String | False | 41 |
A note associated with the address of the check. | |
CustomFields | String | False |
Custom fields returned from QuickBooks, formatted as XML. | ||
ItemLineId | String | True | 255 |
The unique identifier for the specific line item. | |
ItemLineNumber | String | True | 255 |
The line number of this item within the check transaction. | |
ItemName | String | False |
The name of the item listed in this transaction. | ||
ItemId | String | False |
Items.ID |
The unique identifier for the item listed in this transaction. | |
ItemGroup | String | False | 100 |
The name of the item group this line item belongs to, if applicable. | |
ItemGroupId | String | False |
Items.ID | 255 |
The unique identifier for the item group this line item belongs to, if applicable. |
ItemDescription | String | False | 5000 |
A detailed description of the item listed in this transaction. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | ||
ItemUnitOfMeasure | String | False | 31 |
The unit of measure for the item as defined in the company's settings. Requires QBXML Version 7.0 or higher. | |
ItemCost | Double | False |
The cost per unit of the item listed in this transaction. | ||
ItemAmount | Decimal | False |
The total amount for this item line, calculated as quantity multiplied by cost. | ||
ItemBillableStatus | String | False | 13 |
The billing status of the item, such as Billable or Non-Billable. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is EMPTY. | |
ItemCustomer | String | False | 1000 |
The name of the customer associated with this item line. | |
ItemCustomerId | String | False |
Customers.ID | 255 |
The unique identifier of the customer associated with this item line. |
ItemClass | String | False | 1000 |
The name of the class associated with this item, used for categorization. | |
ItemClassId | String | False |
Class.ID | 255 |
The unique identifier of the class associated with this item. |
ItemInventorySiteId | String | False | 31 |
The unique identifier of the inventory site where this item is stored. Requires QBXML Version 10.0 and the Advanced Inventory add-on. | |
ItemInventorySiteName | String | False | 255 |
The name of the inventory site where this item is stored. Requires QBXML Version 10.0 and the Advanced Inventory add-on. | |
ItemInventorySiteLocationId | String | False | 31 |
The unique identifier of the location within the inventory site for this item. Requires QBXML Version 10.0 and the Advanced Inventory add-on. | |
ItemInventorySiteLocationName | String | False | 255 |
The name of the location within the inventory site for this item. Requires QBXML Version 10.0 and the Advanced Inventory add-on. | |
ItemExpirationDateForSerialLotNumber | String | True | 1099 |
The expiration date for the serial or lot number associated with this item. Requires QBXML Version 16.0 or higher. | |
ItemTaxCode | String | False | 3 |
The tax code indicating whether the item is taxable or non-taxable. Available only in international editions of QuickBooks. | |
ItemTaxCodeId | String | False | 255 |
The unique identifier for the tax code associated with this item. Available only in international editions of QuickBooks. | |
ItemCustomFields | String | False |
Custom fields defined for this specific line item. | ||
IsToBePrinted | Boolean | False |
Indicates whether this check transaction is marked as 'To Be Printed' in QuickBooks. If true, the 'To Be Printed' box is checked. The default value is false. | ||
IsTaxIncluded | Boolean | False |
Specifies whether tax is included in the transaction amount. Available only in international editions of QuickBooks. | ||
CurrencyName | String | False | 64 |
The name of the currency used for this check. Requires QBXML Version 8.0 or higher. | |
CurrencyId | String | False |
Currency.ID | 255 |
The unique identifier of the currency used for this check. Requires QBXML Version 8.0 or higher. |
ExchangeRate | Double | False |
The exchange rate used to convert this check's currency to the home currency of the QuickBooks company file. | ||
TimeModified | Datetime | True |
The timestamp of the last modification made to this check transaction. | ||
TimeCreated | Datetime | True |
The timestamp of when this check transaction was originally 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 |
The unique identifier of the transaction (such as a bill) to be paid by this check. Can be used during updates and inserts. |
ApplyCheckToTxnAmount | String |
The amount of the transaction to be paid by this check. Can be used during updates and inserts. |