JDBC Driver for QuickBooks Online

Build 22.0.8675

PaymentLineItems

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

Table Specific Information

Payments may be inserted, queried, or updated via the Payments or PaymentLineItems tables. Payments may be deleted by using the Payments 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 Payment, specify a Customer, TotalAmt, and optionally Line Items. The following shows an example of inserting multiple Payments, each with a single line. To insert a Payment with multiple lines, see the example on the Payments table. 

INSERT INTO PaymentLineItems#TEMP (CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt) VALUES ('4', 0.01, 'Invoice', '116', 0.03)
INSERT INTO PaymentLineItems#TEMP (CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt) VALUES ('4', 0.02, 'Invoice', '117', 0.03)
INSERT INTO PaymentLineItems (CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt) SELECT CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt FROM PaymentLineItems#TEMP

Columns

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

The Id of the line item on the payment.

PaymentId [KEY] String False

Payments.Id

True True

The Id of the 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.

TxnDate Date False True False

The date entered by the user when this transaction occurred.

PrivateNote String False False False

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

TxnStatus String False False False

The status of the transaction. For Payment entities, this status is always set to PAID.

Line_LinkedTxn_TxnId String False False False

The Id of a linked transaction in the line item.

Line_Amount Decimal False False False

Amount of the line item.

Line_LinkedTxn_TxnType String False False False

The type of the transaction linked to the line item.

Line_LinkedTxn_TxnLineId String False False False

The description of the line item.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

The transaction tax code.

TxnTaxDetail_TotalTax String False False False

Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate of tax line items.

CustomerRef String False

Customers.Id

True False

The Id of the customer.

CustomerRef_Name String True

Customers.DisplayName

False False

The name of the customer.

RemitToRef String True False False

This field contains the Id of the entity for the party or location that the payment is to be remitted to or sent to.

RemitToRef_Name String True False False

A name that identifies the party or location that the payment is to be remitted to or sent to.

ARAccountRef String False

Accounts.Id

False False

Reference to the Accounts Receivable (Accounts Receivable account) account associated with the transaction. It is strongly recommended to always supply this field, even though it is ignored by QuickBooks Online, because QuickBooks Online has only one accounts receivable account.

ARAccountRef_Name String True

Accounts.Name

False False

Reference to the ARAccount (Accounts Receivable account) associated with the transaction. It is strongly recommended to always supply an ARAccountRef even though it is ignored by QBO, because QBO has only one accounts receivable account.

DepositToAccountRef String False

Accounts.Id

False False

An optional asset account specification to designate the account the payment money needs to be deposited to.

DepositToAccountRef_Name String True

Accounts.Name

False False

The optional asset account specification to designate the account the payment money needs to be deposited to.

PaymentMethodRef String False

PaymentMethods.Id

False False

The Id of the payment method.

PaymentMethodRef_Name String True

PaymentMethods.Name

False False

The name of the payment method.

The allowed values are Cash, Check, CreditCard, Other.

PaymentRefNum String False True True

The reference number for the payment received.

CreditCardPayment_CreditChargeInfo String False False False

Holds credit card information to request a credit card payment from a merchant account service, but not any response or authorization information from the merchant account service provider.

CreditCardPayment_Number String False False False

The credit card account number, as printed on the card. This field must not have white space or formatting characters.

CreditCardPayment_Type String False False False

The type of credit card.

CreditCardPayment_NameOnAcct String False False False

The name of the account holder, as printed on the card.

CreditCardPayment_CcExpiryMonth Integer False False False

The expiration month on the card.

CreditCardPayment_CcExpiryYear Integer False False False

4-digit expiration year on the card.

CreditCardPayment_BillAddrStreet String False False False

The billing address.

CreditCardPayment_PostalCode String False False False

The postal code.

CreditCardPayment_CommercialCardCode String False False False

The code associated with commercial cards such as purchase, corporate, or business cards. Lower transaction fee rates apply for these cards when this field is defined.

CreditCardPayment_CCTxnMode String False False False

Credit card transaction mode used in credit card payment transactions.

The allowed values are CardNotPresent, CardPresent.

CreditCardPayment_CCTxnType String False False False

The type of credit card transaction.

The allowed values are Authorization, Capture, Charge, Refund, VoiceAuthorization.

CreditCardPayment_PrevCCTransId String False False False

Id of the previous payment transaction.

TotalAmt Decimal False True True

This field indicates the total amount of the entity associated. This includes the total of all the payments from the payment details.

UnappliedAmt Decimal False False False

This field indicates the amount that has not been applied to pay amounts owed for sales transactions.

ProcessPayment Boolean False False False

This field indicates that the payment should be processed by 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

Currency exchange rate. This field is valid only if the company file is set up to use 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 for the UK, AU, IN, and CA editions.

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