QuickBooks: Read a vendorcredit — response body — Vendor Credit

API reference · Contract 2026-10-20

SDK schema: Read a vendorcredit — response body — Vendor Credit

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.
Balance	JSON	Optional	The current amount of the vendor credit reflecting any adjustments to the original credit amount. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
Balance (anyOf 1)	JSON	Alternative
Balance (anyOf 1) (anyOf 1)	number	Alternative
Balance (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Balance (anyOf 2)	string	Alternative
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. 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. Throws an error when duplicate DocNumber is sent in the request. 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.
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 . Not applicable to US companies; required for non-US companies. Conditionally required
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 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.
PrivateNote	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the transaction to the vendor. This field maps to the Memo field on the transaction form.
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 VendorCredit was created from. 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 credit amount, determined by taking the total of all all lines of the transaction. This includes all charges, allowances, discounts, 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.
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 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 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, Read an item — response body — Item Class Ref