BillPaymentChecksAppliedTo
Tracks the bill transactions to which Bill Payments are applied, with support for creating, updating, deleting, and querying 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 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 |
A unique identifier for the applied-to entry, formatted as BillPaymentId|AppliedToId. | |
BillPaymentId | String | False | 255 |
The unique identifier for the bill payment transaction associated with this applied-to entry. | |
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 and must match the vendor associated with the bill being paid 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 and must match the vendor associated with the bill being paid 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. | ||
AccountsPayable | String | False | 1000 |
The name of the accounts payable account associated with this transaction. | |
AccountsPayableId | String | False | 255 |
The unique identifier for the accounts payable account associated with this transaction. | |
BankAccountId | String | False | 255 |
The unique identifier for the bank account from which funds are drawn for this bill payment. Applicable only for the check payment method. | |
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. | |
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. | |
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. | ||
AppliedToRefId | String | False | 255 |
The unique identifier for the bill to which this payment is being applied. Found in the Bills table. | |
AppliedToAmount | Decimal | False |
The amount of the payment being applied to the bill. | ||
AppliedToBalanceRemaining | Decimal | True |
The remaining balance of the bill after this payment is applied. | ||
AppliedToCreditAmount | Decimal | False |
The amount of credit being applied to the bill. | ||
AppliedToCreditMemoId | String | False | 255 |
The unique identifier for the credit memo being applied to the bill. | |
AppliedToDiscountAccountId | String | False | 255 |
The unique identifier for the discount account being applied to the bill. | |
AppliedToDiscountAccountName | String | False | 1000 |
The name of the discount account being applied to the bill. | |
AppliedToDiscountAmount | Decimal | False |
The discount amount being applied to the bill. | ||
AppliedToPaymentAmount | Decimal | False |
The specific payment amount being applied to the bill. | ||
AppliedToReferenceNumber | String | True | 21 |
The reference number associated with the bill being paid. | |
AppliedToTxnDate | Date | True |
The date of the transaction being applied. | ||
AppliedToTxnType | String | True | 100 |
The type of transaction being applied, such as Bill or CreditMemo. | |
TimeModified | Datetime | True |
The timestamp of the last modification made to the bill payment. | ||
TimeCreated | Datetime | True |
The timestamp of when the 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.
Name | Type | Description |
AppliedToCreditAppliedAmount | String |
The amount of credit applied to the bill during this transaction. |