PaymentLineItems
Captures the line-level allocations of customer payments, showing how each payment applies to invoices, credit memos, or other receivables.
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 unique identifier (Id) of the line item on the payment. | |
| PaymentId [KEY] | String | False |
Payments.Id | True | True |
The unique Id of the payment that is linked to this line item. |
| SyncToken | String | True | False | False |
Specifies the version number of the object. It is used to lock an object for use by one application at a time. As soon as an application modifies an object, its sync token is incremented. Attempts to modify an object with an older sync token fail. Only the latest version of the object is maintained by QuickBooks Online. | |
| MetaData_CreateTime | Datetime | True | True | True |
The date and time when the record was created in QuickBooks Online. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the record was last updated in QuickBooks Online. | |
| TxnDate | Date | False | True | False |
The date that was entered by the user when this transaction occurred. | |
| PrivateNote | String | False | False | False |
A private note about the transaction. This note does not appear on the transaction records by default. | |
| Line_LinkedTxn_TxnId | String | False | False | False |
The unique Id of a transaction that is linked to this line item, such as an invoice or sales receipt. | |
| Line_Amount | Decimal | False | False | False |
Specifies the monetary amount of the line item. This value represents the portion of the payment that is applied to the linked transaction or unapplied payment held in this line. | |
| Line_LinkedTxn_TxnType | String | False | False | False |
The type of the transaction that is linked to the line item, such as an invoice or credit memo. | |
| Line_LinkedTxn_TxnLineId | String | False | False | False |
The Id of the specific line item on the linked transaction. | |
| CustomerRef | String | False |
Customers.Id | True | False |
The unique Id of the customer that is linked to this payment line item. |
| CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
The name of the customer that is linked to this payment line item. |
| DepositToAccountRef | String | False |
Accounts.Id | False | False |
An optional asset account specification that designates the account to which the payment money is deposited. |
| DepositToAccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the optional asset account that designates the account to which the payment money is deposited. |
| PaymentMethodRef | String | False | False | False |
The unique Id of the payment method that is used for this payment line item. | |
| PaymentMethodRef_Name | String | True |
PaymentMethods.Name | False | False |
The name of the payment method that is used for this payment line item, such as cash, check, or credit card. The allowed values are Cash, Check, CreditCard, Other. |
| PaymentRefNum | String | False | True | True |
The reference number for the payment received, such as a check number or transaction reference. | |
| CreditCardPayment_CreditChargeInfo | String | False | False | False |
Holds the credit card information that is used to request a credit-card payment from a merchant account service. It does not contain any response or authorization information from the merchant account service provider. | |
| CreditCardPayment_NameOnAcct | String | False | False | False |
The name of the credit-card account holder, as printed on the card. | |
| CreditCardPayment_CcExpiryMonth | Integer | False | False | False |
The expiration month on the credit card. | |
| CreditCardPayment_CcExpiryYear | Integer | False | False | False |
The four-digit expiration year on the credit card. | |
| CreditCardPayment_BillAddrStreet | String | False | False | False |
The street portion of the billing address for the credit card account. | |
| CreditCardPayment_PostalCode | String | False | False | False |
The postal code portion of the billing address for the credit card account. | |
| TotalAmt | Decimal | False | True | True |
Specifies the total monetary amount of the payment entity. This value includes all line items and reflects the full sum of the payment that is recorded in QuickBooks Online. | |
| UnappliedAmt | Decimal | False | False | False |
Specifies the portion of the payment that has not yet been applied to outstanding sales transactions. This value represents unapplied credit that can be allocated to invoices or other receivables later. | |
| ProcessPayment | Boolean | False | False | False |
Indicates that the payment should be processed by the merchant account service. This field is valid only for QuickBooks Online companies with credit card processing enabled. | |
| CurrencyRef | String | False | False | False |
The unique Id of the currency that is used in the transaction. | |
| CurrencyRef_Name | String | True | False | False |
The name of the currency that is used in the transaction. | |
| ExchangeRate | Decimal | False | False | False |
Specifies the currency exchange rate. This field is valid only when 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, and CA editions. |