BillPaymentLineItems
Captures line-level details of bill payments, showing how each payment applies to one or multiple bills and reflecting discounts or credits used.
Table Specific Information
BillPayments may be inserted or queried via the BillPayments or BillPaymentLineItems tables. BillPayments may be deleted by using the BillPayments table.
Select
All filterable columns support the following operators:
- =
- !=
- >=
- <=
- >
- <
- IN
- LIKE
- CONTAINS
The driver processes other filters client-side within the driver.
Insert
To add a BillPayment, specify the Vendor, PayType, TxnDate (transaction date), and TotalAmt columns and at least one Line Item, as well as either CreditCardPayment or CheckPayment. You must enter an amount for each Line Item up to but not exceeding the total amount remaining to be paid for each Bill.
The following shows an example of inserting multiple Bills, each with a single line. To insert a BillPayment with multiple lines, see the example on the BillPayments table.
INSERT INTO BillPaymentLineItems#TEMP (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt) VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.01, '313', 'Bill', 0.03)
INSERT INTO BillPaymentLineItems#TEMP (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt) VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.02, '312', 'Bill', 0.03)
INSERT INTO BillPaymentLineItems (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt) SELECT VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt FROM BillPaymentLineItems#TEMP
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| LineId [KEY] | String | True | False | False |
The identifier (Id) of the line item within the bill payment. This Id uniquely links the line item to its parent bill payment. | |
| BillPaymentId [KEY] | String | False |
BillPayments.Id | True | True |
The Id of the bill payment that is associated with the line item. This Id connects the line item to the correct bill payment transaction. |
| SyncToken | String | True | False | False |
The version number that is assigned to the bill payment line-item object. The sync token locks the object for one application at a time, and QuickBooks Online increments it after each modification. An update or delete operation using an older sync token fails, ensuring that only the latest version of the object is maintained. | |
| MetaData_CreateTime | Datetime | True | True | True |
The date and time when the bill payment line-item record was originally created in QuickBooks Online. The CreateTime value provides a reference point for auditing and synchronization. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the bill payment line-item record was last updated in QuickBooks Online. The LastUpdatedTime value helps track changes and identify the most recent version of the record. | |
| DocNumber | String | False | True | True |
The document number that is associated with this transaction. If this document number is not provided when a line is created, QuickBooks business logic assigns the next sequential number automatically. | |
| TxnDate | Date | False | True | True |
The date that is entered by the user for when this transaction occurred. This date determines the posting date that is used in reports and financial statements. | |
| PrivateNote | String | False | False | False |
A private, internal note about the transaction. This private note does not appear on printed or shared transaction records. | |
| DepartmentRef | String | False |
Departments.Id | False | False |
The Id of the department that is associated with this transaction. The department stores the location or division of the transaction as defined by using location tracking in QuickBooks Online. |
| DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department that is associated with this transaction. This name is the human-readable counterpart to the DepartmentRef Id. |
| Line_LinkedTxn_TxnId | String | False |
Bills.Id | False | False |
The Id of the transaction that is linked to this line item. This Id connects the line item to related QuickBooks transactions such as bills, credits, or payments. |
| Line_Amount | Decimal | False | False | False |
The monetary amount of this line item. This column shows the portion of the total bill payment applied to this line. | |
| Line_LinkedTxn_TxnType | String | False | False | False |
The type of the transaction that is linked to this line item (for example, BillPayment or VendorCredit). The transaction type identifies how the linked transaction relates to the bill payment. | |
| Line_LinkedTxn_TxnLineId | String | False | False | False |
The Id of the line within the linked transaction that is required for Deposit and Bill entities. This Id uniquely identifies which line from the linked transaction is connected to the bill payment. | |
| VendorRef | String | False |
Vendors.Id | True | True |
The Id of the vendor that is associated with this transaction. This Id links the bill payment to the supplier providing the goods or services. |
| VendorRef_Name | String | True |
Vendors.DisplayName | False | False |
The name of the vendor that is associated with this transaction. This name is the human-readable counterpart to the VendorRef Id. |
| APAccountRef | String | False |
Accounts.Id | True | True |
The Id of the accounts-payable account that the vendor credit is credited to. This Id must point to a Liability account whose subtype is Payables. If the company has a single accounts-payable account, this account is implied. |
| APAccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the accounts-payable account to which the vendor credit is credited. This name is the human-readable counterpart to the APAccountRef Id and must be a Liability-type account whose subtype is Payables. |
| PayType | String | False | False | False |
The payment type that is used for this bill payment. The payment type identifies whether the payment was made by check, credit card, or another method. The allowed values are Check, CreditCard. | |
| CheckPayment_BankAccountRef | String | False |
Accounts.Id | False | False |
The Id of the bank account that is used to issue the check. This Id links the bill payment to the source bank account. |
| CheckPayment_BankAccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the bank account that is used to issue the check. This name is the human-readable counterpart to the CheckPayment_BankAccountRef Id. |
| CheckPayment_PrintStatus | String | False | False | False |
The print status of the check payment. The print status applies only to checks and is ignored for credit-card charges and refunds. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NeedToPrint. | |
| CreditCardPayment_CCAccountRef | String | False |
Accounts.Id | False | False |
The Id of the credit-card account that is used for this bill payment. This Id links the payment to the credit card account on file. |
| CreditCardPayment_CCAccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the credit-card account that is used for this bill payment. This name is the human-readable counterpart to the CreditCardPayment_CCAccountRef Id. |
| TotalAmt | Decimal | False | True | True |
The total monetary amount of the bill payment. This total is determined by summing all line items in the bill payment. | |
| ProcessBillPayment | Boolean | False | False | False |
Indicates that the payment should be processed by the merchant account service. The ProcessBillPayment flag is available only for companies with credit-card processing that is enabled in QuickBooks Online. | |
| CurrencyRef | String | False | False | False |
The Id of the currency that is used in this transaction. This currency reference is relevant when the multicurrency feature is enabled in the company file. | |
| CurrencyRef_Name | String | True | False | False |
The name of the currency that is used in this transaction. This name is the human-readable counterpart to the CurrencyRef Id. | |
| ExchangeRate | Decimal | False | False | False |
The exchange rate that is applied to convert one unit of the bill payment's currency into the home currency. The exchange rate is valid only when the multicurrency feature is enabled. In QuickBooks Online, exchange rates are recorded as the number of home currency units that are required to equal one foreign currency unit. This field is available only in the UK, AU, and CA editions. |