Checks

Manages QuickBooks Checks, allowing users to create, update, delete, and query check transactions for financial tracking.

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

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 for the check transaction in QuickBooks.
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.
ItemCount	Integer	True			The total number of line items associated with this check.
ItemAggregate	String	False		5000	An aggregate of line item data used to add a check and its line item data in a single operation.
ExpenseItemCount	Integer	True			The total number of expense line items associated with this check.
ExpenseItemAggregate	String	False		5000	An aggregate of expense line item data used to add a check and its expense item data in a single operation.
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. デフォルト値は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.
CustomFields	String	False			Custom fields returned from QuickBooks, formatted as XML.
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.