BillPaymentChecks

Manages Bill Payment Checks in QuickBooks, including creating, updating, deleting, and querying checks. Requires QBXML Version 6.0 or higher for updates.

Table Specific Information

BillPaymentChecks may be inserted, queried, or updated via the BillPaymentChecks or BillPaymentChecksAppliedTo tables. BillPaymentChecks may be deleted by using the BillPaymentChecks 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 BillPaymentChecks are Id, Date, ReferenceNumber, PayeeName, PayeeId, AccountsPayable, AccountsPayableId, 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 BillPaymentChecks WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a BillPaymentCheck, specify a Payee and BankAccount. The Payee must match the Vendor associated with the Bill you are adding a payment for. The AppliedToAggregate column may be used to specify an XML aggregate of AppliedTo data. The columns that may be used in these aggregates are defined in the BillPaymentChecksAppliedTo table and it starts with AppliedTo. For example, the following will insert a new BillPaymentCheck with two AppliedTo entries:

INSERT INTO BillPaymentChecks (PayeeName, BankAccountName, AppliedToAggregate) 
VALUES ('Vu Contracting', 'Checking', 
'<BillPaymentChecksAppliedTo>
<Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToAmount>20.00</AppliedToAmount></Row>
<Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToAmount>51.25</AppliedToAmount></Row>
</BillPaymentChecksAppliedTo>')

AppliedToRefId is a reference to a BillId and can be found in Bills, BillLineItems, or BillExpenseItems.

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	The unique identifier for the bill payment transaction in QuickBooks.
PayeeName	String	False		1000	The name of the entity (such as a vendor) to whom the payment is being made. Either PayeeId or PayeeName is required when inserting.
PayeeId	String	False	Vendors.ID	255	The unique identifier for the entity (such as a vendor) to whom the payment is being made. Either PayeeId or PayeeName is required when inserting.
ReferenceNumber	String	False		21	The reference number for the transaction, used for identification and tracking.
TxnNumber	Int	True			A manually assigned transaction number for identifying this payment separately from the Quickbooks generated ID.
Date	Date	False			The date of the transaction. If specified in the WHERE clause of a SELECT query, it overrides the pseudo columns StartDate and EndDate.
Amount	Decimal	True			The total amount of the bill payment. This value is calculated by QuickBooks based on the associated line items or expense line items.
AccountsPayable	String	False		1000	The name of the accounts payable account associated with this transaction.
AccountsPayableId	String	False	Accounts.ID	255	The unique identifier for the accounts payable account associated with this transaction.
BankAccountName	String	False		1000	The name of the bank account from which funds are drawn for this bill payment. Applicable only for the check payment method.
BankAccountId	String	False	Accounts.ID	255	The unique identifier for the bank account from which funds are drawn for this bill payment. Applicable only for the check payment method.
IsToBePrinted	Boolean	False			Indicates whether the transaction is marked as 'To Be Printed' in QuickBooks. If true, the 'To Be Printed' box in the user interface is checked. デフォルト値はfalseです。
Memo	String	False		5000	A memo or note associated with the transaction, visible on internal reports.
AppliedToAggregate	String	False		5000	An aggregate of data showing which bills the payment is applied to. Used for adding a bill payment check and its associated data.
ExchangeRate	Double	False			The currency exchange rate used to convert this payment's currency to the company's home currency.
AmountInHomeCurrency	Double	True			The total amount of the payment converted to the company's home currency.
CustomFields	String	False			Custom fields returned from QuickBooks, formatted as XML.
TimeModified	Datetime	True			The timestamp of the last modification made to this bill payment.
TimeCreated	Datetime	True			The timestamp of when this bill payment 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.