JDBC Driver for QuickBooks

Build 21.0.7867

BillPaymentChecks

Create, update, delete, and query QuickBooks Bill Payment Checks. QBXMLVersion must be set to 6.0 or higher to update a BillPaymentCheck.

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 transaction.

PayeeName String False

Vendors.Name

1000

A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required.

PayeeId String False

Vendors.ID

255

A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required.

ReferenceNumber String False 21

The transaction reference number.

TxnNumber Int True

The transaction number.

Date Date False

The date of the 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. This is calculated by QuickBooks based on the line items or expense line items.

AccountsPayable String False

Accounts.FullName

1000

Reference to the accounts-payable account.

AccountsPayableId String False

Accounts.ID

255

Reference to the accounts-payable account Id.

BankAccountName String False

Accounts.FullName

1000

Refers to the Account funds are being drawn from for this bill payment. This property is only applicable to the check payment method.

BankAccountId String False

Accounts.ID

255

Refers to the Account funds are being drawn from for this bill payment. This property is only applicable to the check payment ethod.

IsToBePrinted Boolean False

Indicates whether or not the transaction is to be printed. If set to true, the 'To Be Printed' box in the QuickBooks user interface will be checked.

The default value is false.

Memo String False 5000

A memo to appear on internal reports.

AppliedToAggregate String False 5000

An aggregate of the applied-to data which can be used for adding a bill payment check and its applied-to data.

ExchangeRate Double False

Currency exchange rate for this Bill Payment.

AmountInHomeCurrency Double True

Amount in units of the home currency.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

TimeModified Datetime True

When the bill payment was last modified.

TimeCreated Datetime True

When the bill payment 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
AppliedTo* String

All applied-to-specific columns may be used in insertions.

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