QuickBooks: Read a vendor — response body — Vendor

API reference · Contract 2026-10-20

SDK schema: Read a vendor — response body — Vendor

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
AcctNum	string	Optional	Name or number of the account associated with this vendor.
Active	JSON	Optional	If true, this object is currently enabled for use by QuickBooks.
Active (anyOf 1)	boolean	Alternative
Active (anyOf 2)	string	Alternative	Known values: true, false
AlternatePhone	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
Balance	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create, read-only otherwise. 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
BillAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. 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.
BillRate	JSON	Optional	BillRate can be set to specify this vendor’s hourly billing rate. Decimal string
BillRate (anyOf 1)	JSON	Alternative
BillRate (anyOf 1) (anyOf 1)	number	Alternative
BillRate (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BillRate (anyOf 2)	string	Alternative
CompanyName	string	Optional	The name of the company associated with the person or organization.
CostRate	JSON	Optional	Pay rate of the vendor Decimal string
CostRate (anyOf 1)	JSON	Alternative
CostRate (anyOf 1) (anyOf 1)	number	Alternative
CostRate (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CostRate (anyOf 2)	string	Alternative
CurrencyRef	Model	Optional	Expand Read a bill — response body — Bill Currency Ref Reference to the currency in which all amounts associated with this vendor are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this vendor is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read-only after object is created. Read only: true
DisplayName	string	Optional	The name of the vendor as displayed. Must be unique across all Vendor, Customer, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating vendor name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix .
FamilyName	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
Fax	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
GivenName	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
HasTPAR	JSON	Optional	Indicate if the vendor has TPAR enabled. 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.
HasTPAR (anyOf 1)	boolean	Alternative
HasTPAR (anyOf 2)	string	Alternative	Known values: true, false
Id	string	Optional	Unique identifier for this object. Read only: true
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.
MiddleName	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. Conditionally required
Mobile	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
OtherContactInfo	Model	Optional	Expand Create a vendor — request body — body Other Contact Info List of ContactInfo entities of any contact info type.
PrimaryEmailAddr	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
PrimaryPhone	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
PrintOnCheckName	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName . Cannot be removed with sparse update.
Source	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
Suffix	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required for object create. 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
T4AEligible	JSON	Optional	True if vendor is T4A eligible. Valid for CA locale
T4AEligible (anyOf 1)	boolean	Alternative
T4AEligible (anyOf 2)	string	Alternative	Known values: true, false
T5018Eligible	JSON	Optional	True if vendor is T5018 eligible. Valid for CA locale
T5018Eligible (anyOf 1)	boolean	Alternative
T5018Eligible (anyOf 2)	string	Alternative	Known values: true, false
TaxIdentifier	string	Optional	The tax ID of the Person or Organization. The value is masked in responses, exposing only last four characters. For example, the ID of 123-45-6789 is returned as XXXXXXX6789 .
TermRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a default Term associated with this Vendor object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for TermRef.value and TermRef.name , respectively.
Title	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes are required during create. Conditionally required
Vendor1099	JSON	Optional	This vendor is an independent contractor; someone who is given a 1099-MISC form at the end of the year. A 1099 vendor is paid with regular checks, and taxes are not withheld on their behalf.
Vendor1099 (anyOf 1)	boolean	Alternative
Vendor1099 (anyOf 2)	string	Alternative	Known values: true, false
VendorPaymentBankDetail	Model	Optional	Expand Create a vendor — request body — body Vendor Payment Bank Detail Vendor Payment Bank Detail.
WebAddr	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.

Referenced models: Create a vendor — request body — body Other Contact Info, Read a bill — response body — Bill Currency Ref, Full update companyinfo — request body — body Email, Read a bill — response body — Bill Meta Data, Create a vendor — request body — body Bill Addr, Read an item — response body — Item Class Ref, Create a vendor — request body — body Fax, Create a vendor — request body — body Vendor Payment Bank Detail, Create a vendor — request body — body Web Addr