Checks

Create, update, delete, and query QuickBooks Checks.

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 Desktop 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%'

SELECT * FROM Checks WHERE Date >= '2020-01-07' AND Date < '2020-01-10' 

SELECT * FROM Checks WHERE [Date] = '2020-01-07'

Insert

To add a Check, specify an Account, a Date, and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line or Expense Item data. The columns that may be used in these aggregates are defined in the CheckLineItems and CheckExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new Check with two Line Items:

INSERT INTO Checks (Account, Date, ItemAggregate) VALUES ('Checking', '1/1/2011', 
'<CheckLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</CheckLineItems>')

To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'

Columns

Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	The unique identifier.
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		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		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.
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.
ItemCount	Integer	True			The count of line items.
ItemAggregate	String	False		5000	An aggregate of the line item data which can be used for adding a check and its line item data.
ExpenseItemCount	Integer	True			The count of expense line items.
ExpenseItemAggregate	String	False		5000	An aggregate of the expense item data which can be used for adding a check and its expense item data.
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		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.
CustomFields	String	False			Custom fields returned from QuickBooks and formatted into XML.
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.