QuickBooks: Read a payment — response body — Payment

API reference · Contract 2026-10-20

SDK schema: Read a payment — response body — Payment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
CreditCardPayment	Model	Optional	Expand Read a payment — response body — Payment Credit Card Payment Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API.
CurrencyRef	Model	Optional	Expand Read a bill — response body — Bill Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
CustomerRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
DepositToAccountRef	Model	Optional	Expand Read an item — response body — Item Class Ref Identifies the account to be used for this payment. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
ExchangeRate	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company Decimal string
ExchangeRate (anyOf 1)	JSON	Alternative
ExchangeRate (anyOf 1) (anyOf 1)	number	Alternative
ExchangeRate (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ExchangeRate (anyOf 2)	string	Alternative
Id	string	Optional	Unique identifier for this object. Read only: true
Line	array	Optional	Zero or more transactions accounting for this payment. Values for Line.LinkedTxn.TxnType can be one of the following: Expense —Payment is reimbursement for expense paid by cash made on behalf of the customer Check —Payment is reimbursement for expense paid by check made on behalf of the customer CreditCardCredit —Payment is reimbursement for a credit card credit made on behalf of the customer JournalEntry —Payment is linked to the representative journal entry CreditMemo —Payment is linked to the credit memo the customer has with the business Invoice —The invoice to which payment is applied Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
Line[]	Model	Each item	Expand Read a payment — response body — Payment Line item
MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
PaymentMethodRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
PaymentRefNum	string	Optional	The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation.
PrivateNote	string	Optional	User entered, organization-private note about the transaction.
ProjectRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the Project ID associated with this transaction. Conditionally required
SyncToken	string	Optional	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. Read only: true
TaxExemptionRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
TotalAmt	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to O. Decimal string
TotalAmt (anyOf 1)	JSON	Alternative
TotalAmt (anyOf 1) (anyOf 1)	number	Alternative
TotalAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalAmt (anyOf 2)	string	Alternative
TxnDate	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
TxnSource	string	Optional	Used internally to specify originating source of a credit card transaction.
UnappliedAmt	JSON	Optional	Indicates the amount that has not been applied to pay amounts owed for sales transactions. Decimal string Read only: true
UnappliedAmt (anyOf 1)	JSON	Alternative
UnappliedAmt (anyOf 1) (anyOf 1)	number	Alternative
UnappliedAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UnappliedAmt (anyOf 2)	string	Alternative

Referenced models: Read a payment — response body — Payment Credit Card Payment, Read a bill — response body — Bill Currency Ref, Read a payment — response body — Payment Line item, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref