TDV Adapter for QuickBooks

Build 22.0.8462

BillPaymentChecksAppliedTo

Create, update, delete, and query QuickBooks Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied.

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 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 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 BillPaymentChecksAppliedTo WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a BillPaymentCheck entry, specify the Payee and BankAccount fields. The Payee must match the Vendor associated with the Bill you are adding a payment for. All AppliedTo columns can be used to explicitly identify the Bills being paid. For example, the following will insert a new BillPaymentCheck with two AppliedTo entries:

INSERT INTO BillPaymentChecksAppliedTo#TEMP (PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount) VALUES ('Vu Contracting', 'Checking', '178C1-1450221347', 20.00)
INSERT INTO BillPaymentChecksAppliedTo#TEMP (PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount) VALUES ('Vu Contracting', 'Checking', '881-933371709', 51.25)
INSERT INTO BillPaymentChecksAppliedTo (PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount) SELECT PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount FROM BillPaymentChecksAppliedTo#TEMP

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 in the format BillPaymentId|AppliedToId.

BillPaymentId String False

BillPaymentChecks.ID

255

The Id of the bill payment transaction.

PayeeName String False 1000

A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. This must match the Vendor associated with the Bill being paid when inserting.

PayeeId String False

Vendors.ID

255

A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. This must match the Vendor associated with the Bill being paid when inserting.

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.

AccountsPayable String False 1000

Reference to the accounts-payable account.

AccountsPayableId String False 255

Reference to the accounts-payable account Id.

BankAccountId String False 255

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

BankAccountName String False 1000

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

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.

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.

AppliedToRefId String False 255

The applied-to reference identifier. This is a reference to a bill Id, which can be found in the Bills table.

AppliedToAmount Decimal False

The amount to be applied.

AppliedToBalanceRemaining Decimal True

The balance remaining to be applied.

AppliedToCreditAmount Decimal False

The amount of the credit to be applied.

AppliedToCreditMemoId String False 255

The Id of the credit memo to be applied.

AppliedToDiscountAccountId String False 255

The discount account Id to be applied.

AppliedToDiscountAccountName String False 1000

The discount account name to be applied.

AppliedToDiscountAmount Decimal False

The discount amount to be applied.

AppliedToPaymentAmount Decimal False

The payment amount to be applied.

AppliedToReferenceNumber String True 21

The ref number to be applied.

AppliedToTxnDate Date True

The transaction date to be applied.

AppliedToTxnType String True 100

The transaction type that was applied.

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
AppliedToCreditAppliedAmount String

The credit applied amount to be applied.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462