Name |
Type |
ReadOnly |
Filterable |
Description |
Id [KEY] |
string |
true |
true |
The Id of the payment. |
SyncToken |
string |
false |
false |
The sync token. This must be specified when executing an update or delete. |
MetaData_CreateTime |
datetime |
true |
true |
The time the record was created. |
MetaData_LastUpdatedTime |
datetime |
true |
true |
The time the record was last updated. |
TxnDate |
date |
false |
true |
The date entered by the user when this transaction occurred. |
PrivateNote |
string |
false |
false |
A private note about the transaction. This note will not appear on the transaction records by default. |
TxnStatus |
string |
false |
false |
The status of the transaction. For payment entities, this status is always set to PAID. |
Line |
string |
false |
false |
A line item of a transaction. |
TxnTaxDetail_TxnTaxCodeRef |
string |
false |
false |
The transaction tax code. |
TxnTaxDetail_TotalTax |
string |
false |
false |
Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. |
TxnTaxDetail_TaxLine |
string |
false |
false |
A json aggregate of tax line items. |
CustomerRef |
string |
false |
true |
The Id of the customer. |
CustomerRef_Name |
string |
true |
false |
The name of the customer. |
RemitToRef |
string |
true |
false |
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 |
The name of the party or location that the payment is to be remitted to or sent to. |
ARAccountRef |
string |
false |
false |
The Id of the Accounts Receivable account (ARAccount) 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 recievable account. |
ARAccountRef_Name |
string |
true |
false |
The name of the Accounts Receivable account (ARAccount) 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 recievable account. |
DepositToAccountRef |
string |
false |
false |
An optional asset account specification. The Id of the asset account that designates the account the payment money needs to be deposited to. |
DepositToAccountRef_Name |
string |
true |
false |
An optional asset account specification. The name of the account the payment money needs to be deposited to. |
PaymentMethodRef |
string |
false |
false |
The Id of the payment method. |
PaymentMethodRef_Name |
string |
true |
false |
The name of the payment method. |
PaymentRefNum |
string |
false |
true |
The reference number for the payment received. |
CreditCardPayment_CreditChargeInfo |
string |
false |
false |
This field 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 |
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 |
The type of credit card. |
CreditCardPayment_NameOnAcct |
string |
false |
false |
The account holder name as printed on the card. |
CreditCardPayment_CcExpiryMonth |
integer |
false |
false |
The expiration month on the card. |
CreditCardPayment_CcExpiryYear |
integer |
false |
false |
The 4-digit expiration year on the card. |
CreditCardPayment_BillAddrStreet |
string |
false |
false |
The street of the billing address. |
CreditCardPayment_PostalCode |
string |
false |
false |
The postal code. |
CreditCardPayment_CommercialCardCode |
string |
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 |
The credit card transaction mode used in credit card payment transactions. |
CreditCardPayment_CCTxnType |
string |
false |
false |
The type of credit card transaction. |
CreditCardPayment_PrevCCTransId |
string |
false |
false |
The Id of the previous payment transaction. |
TotalAmt |
decimal |
false |
true |
The total amount of the entity associated. This includes the total of all the payments from the payment details. |
UnappliedAmt |
decimal |
false |
false |
The amount that has not been applied to pay amounts owed for sales transactions. |
ProcessPayment |
boolean |
false |
false |
This field indicates that the payment should be processed by merchant account service. This field is valid for companies with credit card processing enabled in QuickBooks Online. |
CurrencyRef |
string |
false |
false |
The Id of the currency used in the transaction. |
CurrencyRef_Name |
string |
true |
false |
The name of the currency used in the transaction. |
ExchangeRate |
decimal |
false |
false |
The 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. |