QuickBooks: Read a purchase — response body — Purchase

API reference · Contract 2026-10-20

SDK schema: Read a purchase — response body — Purchase

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
AccountRef	Model	Optional	Expand Read an item — response body — Item Class Ref Specifies the account reference to which this purchase is applied based on the PaymentType . A type of Check should have bank account, CreditCard should specify credit card account, etc. 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 AccountRef.value and AccountRef.name , respectively.
Credit	JSON	Optional	False —it represents a charge. True —it represents a refund. Valid only for CreditCard payment type. Validation Rules: Valid only for CreditCard transactions.
Credit (anyOf 1)	boolean	Alternative
Credit (anyOf 2)	string	Alternative	Known values: true, false
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. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . 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, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided; duplicate values are not accepted. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. For Cash/CreditCard transactions, throws an error when duplicate DocNumber is sent in the request. For Check transactions, error is thrown when duplicate DocNumber is sent in the request and Preferences:OtherPrefs:NameValue.Name = WarnDuplicateCheckNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers 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.
EntityRef	Model	Optional	Expand Read an item — response body — Item Class Ref Specifies the party with whom an expense is associated. Can be Customer , Vendor, or Employee. Query the corresponding name list resource of the associated type to determine the appropriate object for this reference. Use the Id and DisplayName values from that object for EntityRef.value and EntityRef.name , respectively. Set EntityRef.type to the type of object associated with this expense. For example, if this object represents a purchase from a vendor, then set EntityRef.type to Vendor and query the Vendor resource for the appropriate object to reference.
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
GlobalTaxCalculation	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable .
Id	string	Optional	Unique identifier for this object. Read only: true
IncludeInAnnualTPAR	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
IncludeInAnnualTPAR (anyOf 1)	boolean	Alternative
IncludeInAnnualTPAR (anyOf 2)	string	Alternative	Known values: true, false
Line	array	Optional	Individual line items of a transaction. Valid Line types include ItemBasedExpenseLine (Available if Preferences.ProductAndServicesPrefs.ForPurchase is set to true ) and AccountBasedExpenseLine
Line[]	JSON	Each item
Line[] (anyOf 1)	Model	Alternative	Expand Read a purchase — response body — Purchase Line item Amount, Custom Extensions, Description, Detail Type, Id, Item Based Expense Line Detail, Line Num, Linked Txn
Line[] (anyOf 2)	Model	Alternative	Expand Read a purchase — response body — Purchase Line item Account Based Expense Line Detail, Amount, Custom Extensions, Description, Detail Type, Id, Line Num
LinkedTxn	array	Optional	Zero or more transactions linked to this object. The LinkedTxn.TxnType can be set to ReimburseCharge . The LinkedTxn.TxnId can be set as the ID of the transaction.
LinkedTxn[]	Model	Each item	Expand Read a bill — response body — Bill Linked Txn 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.
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.
PaymentType	string	Optional	Type can be Cash , Check , or CreditCard .
PrintStatus	string	Optional	PrintStatus is applicable only for Check . Ignored for CreditCard charge or refund. Valid values: NotSet , NeedToPrint , PrintComplete.
PrivateNote	string	Optional	User-entered, organization-private note about the transaction. This field maps to the Memo field on the Expense form in the QuickBooks UI.
PurchaseEx	object	Optional	For internal use. Additional keys: allowed
RecurDataRef	Model	Optional	Expand Read an item — response body — Item Class Ref A reference to the Recurring Transaction. It captures what recurring transaction template the Purchase was created from. Read only: true
RemitToAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address to which the payment should be sent. This attribute is applicable only for Check . Ignored for CreditCard charge or refund. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Read only: true
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 of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
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.
TxnTaxDetail	Model	Optional	Expand Read a bill — response body — Bill Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
CustomField	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
CustomField[]	Model	Each item	Expand Read an invoice — response body — Invoice Custom Field item

Referenced models: Read a purchase — response body — Purchase Line item Account Based Expense Line Detail, Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Read a bill — response body — Bill Currency Ref, Read an invoice — response body — Invoice Custom Field item, Read a purchase — response body — Purchase Line item Amount, Custom Extensions, Description, Detail Type, Id, Item Based Expense Line Detail, Line Num, Linked Txn, Read a bill — response body — Bill Linked Txn item, Read a bill — response body — Bill Meta Data, Create a vendor — request body — body Bill Addr, Read an item — response body — Item Class Ref, Read a bill — response body — Bill Txn Tax Detail