QuickBooks: Read a billpayment — response body — Bill Payment

API reference · Contract 2026-10-20

SDK schema: Read a billpayment — response body — Bill Payment

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
APAccountRef	Model	Optional	Expand Read an item — response body — Item Class Ref Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
CheckPayment	Model	Optional	Expand Read a billpayment — response body — Bill Payment Check Payment Information about a check payment for the transaction. Not applicable to Estimate and SalesOrder. Used when PayType is Check .
CreditCardPayment	Model	Optional	Expand Read a billpayment — response body — Bill Payment Credit Card Payment Information about a credit card payment for the transaction. Not applicable to Estimate and SalesOrder. Used when PayType is CreditCard .
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
DepartmentRef	Model	Optional	Expand Read an item — response body — Item Class Ref A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
DocNumber	string	Optional	Reference number for the transaction. If not explicitly provided at create time, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default.
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 an Intuit entity (object). Read only: true
Line	array	Optional	Individual line items representing zero or more Bill , VendorCredit , and JournalEntry objects linked to this BillPayment object. Use Line.LinkedTxn.TxnId as the ID in a separate Bill, VendorCredit, or JournalEntry read request to retrieve details of the linked object. LinkedTxnLine:
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 object. The MetaData values are set by Data Services and are read only for all applications.
PayType	string	Optional	The payment type. Valid values include: Check , CreditCard
PrivateNote	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the form.
ProcessBillPayment	JSON	Optional	Indicates that the payment should be processed by merchant account service. Valid for QuickBooks companies with credit card processing.
ProcessBillPayment (anyOf 1)	boolean	Alternative
ProcessBillPayment (anyOf 2)	string	Alternative	Known values: true, false
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
TotalAmt	JSON	Optional	Indicates the total amount associated with this payment. This includes the total of all the payments from the payment line details. If TotalAmt is greater than the total on the lines being paid, the overpayment is treated as a credit and exposed as such on the QuickBooks UI. It cannot be negative. 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.
VendorRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.

Referenced models: Read a billpayment — response body — Bill Payment Check Payment, Read a billpayment — response body — Bill 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