ODBC Driver for QuickBooks Online

Build 20.0.7587

BillPaymentLineItems

Create, update, delete, and query QuickBooks Bill Payment Line Items.

Table Specific Information

BillPayments may be inserted or queried via the BillPayments or BillPaymentLineItems tables. BillPayments may be deleted by using the BillPayments table.

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. All columns denoted with a # are Line Item columns and can be used to create a new BillPayment transaction that has multiple Line Items. For example, the following query will insert a new BillPayment with two Line Items:

INSERT INTO BillPaymentLineItems (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount#1, Line_LinkedTxn_TxnId#1, Line_LinkedTxn_TxnType#1, Line_Amount#2, Line_LinkedTxn_TxnId#2, Line_LinkedTxn_TxnType#2, TotalAmt) VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.01, '313', 'Bill', 0.02, '312', 'Bill', 0.03)

Columns

Name Type ReadOnly References Filterable Sortable Description
LineId [KEY] String True false false

The Id of the line item of the bill payment.

BillPaymentId [KEY] String False

BillPayments.Id

true true

The Id of the bill payment.

SyncToken String True false false

Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime Datetime True true true

The time the record was created.

MetaData_LastUpdatedTime Datetime True true true

The time the record was last updated.

DocNumber String False true true

The document number for this transaction. When creating a line item, if this field is not provided QuickBooks business logic will assign the document number using the next-in-sequence algorithm.

TxnDate Date False true true

The date of the transaction. This field is often the date when the transaction was entered into the system, but it is not required to be. For posting transactions, this is the posting date that affects financial statements

PrivateNote String False false false

A private note about the transaction. By default, this field does not appear on the transaction records.

DepartmentRef String False

Departments.Id

false false

The Id of the department, which stores the location of the transaction.

DepartmentRef_Name String True

Departments.Name

false false

The name of the department.

Line_LinkedTxn_TxnId# String False

Bills.Id

false false

The Id of the transaction linked to the line item.

Line_Amount# Decimal False false false

The amount of the line item.

Line_LinkedTxn_TxnType# String False false false

The type of the transaction linked to the line item.

VendorRef String False

Vendors.Id

true true

The Id of the vendor for this transaction.

VendorRef_Name String True

Vendors.DisplayName

false false

The name of the vendor for this transaction.

APAccountRef String False

Accounts.Id

true true

The Id of the accounts-payable account that the vendor credit is credited to. If the company has a single accounts-payable account, this account is implied. This must be a Liability account and the subtype must be of type Payables.

APAccountRef_Name String True

Accounts.Name

false false

The name of the accounts-payable account the vendor credit is credited to. If the company has a single accounts-payable account, this account is implied. This must be a Liability-type account and the subtype must be of type Payables.

PayType String False false false

The payment type.

The allowed values are Check, CreditCard.

CheckPayment_BankAccountRef String False

Accounts.Id

true true

The Id of the bank account, which issued the check.

CheckPayment_BankAccountRef_Name String True

Accounts.Name

false false

A name that identifies the bank account.

CheckPayment_PrintStatus String False false false

The print status of the check payment. This field is only applicable for checks and 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

true true

The Id of the credit card account.

CreditCardPayment_CCAccountRef_Name String True

Accounts.Name

false false

The name of the credit card account.

TotalAmt Decimal False true true

The total amount of the bill, determined by the sum of all line items in the bill payment.

ProcessBillPayment Boolean False false false

This field indicates that the payment should be processed by the merchant account service. This field is available for companies with credit card processing enabled in QuickBooks Online.

CurrencyRef String False false false

The Id of the currency used in the transaction.

CurrencyRef_Name String True false false

The name of the currency used in the transaction.

ExchangeRate Decimal False false false

The exchange rate for the currency. This field is available only if the company file uses the multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available in only the UK, AU, IN, and CA editions.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587