JDBC Driver for QuickBooks Online

Build 20.0.7587

BillPayments

Create, update, delete, and query QuickBooks Bill Payments.

Table Specific Information

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

Insert

To add a BillPayment, specify the Vendor, PayType, TxnDate, and TotalAmt columns, as well as at least one Line Item and 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 LineAggregate column may be used to specify an XML aggregate of Line Item data. The columns that may be used in these aggregates are defined in the BillLineItems table as # columns. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). For example, the following will insert a new BillPayment with two Line Items:

INSERT INTO BillPayments (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, TotalAmt, LineAggregate) 
VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.03 '
<Line><Amount>Repairs</Amount><LinkedTxn><TxnId>312</TxnId><TxnType>Bill</TxnType></LinkedTxn></Line>
<Line><Amount>Removal</Amount><LinkedTxn><TxnId>313</TxnId><TxnType>Bill</TxnType></LinkedTxn></LinkedTxn></Line>
')

Columns

Name Type ReadOnly References Filterable Sortable Description
Id [KEY] String True 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 the transaction. If it is not provided in a create operation, 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. This field is used in the financial statements for posting transactions.

PrivateNote String False false false

A private note about the transaction. This note will not appear on the transaction records by default.

DepartmentRef String False

Departments.Id

false false

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

DepartmentRef_Name String True

Departments.Name

false false

The name of the department.

LineAggregate String False false false

An XML aggregate containing the line items associated with the bill payment.

VendorRef String False

Vendors.Id

true true

The Id of the vendor.

VendorRef_Name String True

Vendors.DisplayName

false false

The name of the vendor.

APAccountRef String False

Accounts.Id

true true

The Id of the accounts-payable account the vendor credit is credited to. If a single accounts-payable account is used, this account is implied. This account 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 uses a single accounts-payable account, this account is implied. This account must be a Liability account and the subtype must be of type Payables.

PayType String False false false

The payment type.

使用できる値は次のとおりです。Check, CreditCard

CheckPayment_BankAccountRef String False

Accounts.Id

false false

The Id of the bank account.

CheckPayment_BankAccountRef_Name String True

Accounts.Name

false false

The name of the bank account.

CheckPayment_PrintStatus String False false false

The print status of the check payment. This field is only applicable for checks. It is ignored for credit card charges or refunds.

使用できる値は次のとおりです。NotSet, NeedToPrint, PrintComplete

デフォルト値は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

A name that identifies the credit card account.

TotalAmt Decimal False true true

This field sets the total amount of the bill. This includes the total of all the payments from the line items of the bill payment.

ProcessBillPayment Boolean False false false

This field sets whether the payment is processed by the merchant account service. This field is valid for QuickBooks Online companies with credit card processing.

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 currency exchange rate. This field is only valid 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