Skip to main content
GET
JavaScript

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the vendor to retrieve.

Maximum string length: 36
Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified vendor.

​
id
string
required

The unique identifier assigned by QuickBooks to this vendor. This ID is unique across all vendors but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

The type of object. This value is always "qbd_vendor".

Allowed value: "qbd_vendor"
Example:

"qbd_vendor"

​
createdAt
string
required

The date and time when this vendor was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
required

The date and time when this vendor was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this vendor object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

​
name
string
required

The case-insensitive unique name of this vendor, unique across all vendors.

NOTE: Vendors do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Example:

"Acme Supplies Inc."

​
isActive
boolean
required

Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
class
object | null
required

The vendor's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

Example:
​
companyName
string | null
required

The name of the company associated with this vendor. This name is used on invoices, checks, and other forms.

Example:

"Acme Corporation"

​
salutation
string | null
required

The formal salutation title that precedes the name of the contact person for this vendor, such as "Mr.", "Ms.", or "Dr.".

Example:

"Dr."

​
firstName
string | null
required

The first name of the contact person for this vendor.

Example:

"John"

​
middleName
string | null
required

The middle name of the contact person for this vendor.

Example:

"A."

​
lastName
string | null
required

The last name of the contact person for this vendor.

Example:

"Doe"

​
jobTitle
string | null
required

The job title of the contact person for this vendor.

Example:

"Purchasing Manager"

​
billingAddress
The Address object · object | null
required

The vendor's billing address.

​
shippingAddress
The Address object · object | null
required

The vendor's shipping address.

​
phone
string | null
required

The vendor's primary telephone number.

Example:

"+1-555-123-4567"

​
alternatePhone
string | null
required

The vendor's alternate telephone number.

Example:

"+1-555-987-6543"

​
fax
string | null
required

The vendor's fax number.

Example:

"+1-555-555-1212"

​
email
string | null
required

The vendor's email address.

Example:

"vendor@example.com"

​
ccEmail
string | null
required

An email address to carbon copy (CC) on communications with this vendor.

Example:

"manager@example.com"

​
contact
string | null
required

The name of the primary contact person for this vendor.

Example:

"Jane Smith"

​
alternateContact
string | null
required

The name of a alternate contact person for this vendor.

Example:

"Bob Johnson"

​
customContactFields
The Custom Contact Field object · object[]
required

Additional custom contact fields for this vendor, such as phone numbers or email addresses.

​
additionalContacts
The Contact object · object[]
required

Additional alternate contacts for this vendor.

​
nameOnCheck
string | null
required

The vendor's name as it should appear on checks issued to this vendor.

Example:

"Acme Supplies Ltd."

​
accountNumber
string | null
required

The vendor's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.

Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.

Example:

"1010"

​
note
string | null
required

A note or comment about this vendor.

Example:

"Preferred vendor for office supplies."

​
additionalNotes
The Note object · object[]
required

Additional notes about this vendor.

​
vendorType
object | null
required

The vendor's type, used for categorizing vendors into meaningful segments, such as industry or region.

Example:
​
terms
object | null
required

The vendor's payment terms, defining when payment is due and any applicable discounts.

Example:
​
creditLimit
string | null
required

The vendor's credit limit, represented as a decimal string. This is the maximum amount of money that can be spent being before billed by this vendor. If null, there is no credit limit.

Example:

"5000.00"

​
taxIdentificationNumber
string | null
required

The vendor's tax identification number (e.g., EIN or SSN).

Example:

"12-3456789"

​
isEligibleFor1099
boolean | null
required

Indicates whether this vendor is eligible to receive a 1099 form for tax reporting purposes. When true, then the fields taxId and billingAddress are required.

Example:

true

​
balance
string | null
required

The current balance owed to this vendor, represented as a decimal string. A positive number indicates money owed to the vendor.

Example:

"1000.00"

​
billingRate
object | null
required

The vendor's billing rate, used to override service item rates in time tracking activities.

Example:
​
externalId
string | null
required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
salesTaxCode
object | null
required

The default sales-tax code for transactions with this vendor, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Example:
​
salesTaxCountry
string | null
required

The country for which sales tax is collected for this vendor.

Example:

"us"

​
isSalesTaxAgency
boolean | null
required

Indicates whether this vendor is a sales tax agency.

Example:

false

​
salesTaxReturn
object | null
required

The vendor's sales tax return information, used for tracking and reporting sales tax liabilities.

Example:
​
taxRegistrationNumber
string | null
required

The vendor's tax registration number, for use in Canada or the UK.

Example:

"GB123456789"

​
reportingPeriod
enum<string> | null
required

The vendor's tax reporting period, for use in Canada or the UK.

Available options:
monthly,
quarterly,
annual
Example:

"quarterly"

​
isTrackingPurchaseTax
boolean | null
required

Indicates whether tax is tracked on purchases for this vendor, for use in Canada or the UK.

Example:

true

​
purchaseTaxAccount
object | null
required

The account used for tracking taxes on purchases for this vendor, for use in Canada or the UK.

Example:
​
isTrackingSalesTax
boolean | null
required

Indicates whether tax is tracked on sales for this vendor, for use in Canada or the UK.

Example:

true

​
salesTaxAccount
object | null
required

The account used for tracking taxes on sales for this vendor, for use in Canada or the UK.

Example:
​
isCompoundingTax
boolean | null
required

Indicates whether tax is charged on top of tax for this vendor, for use in Canada or the UK.

Example:

false

​
defaultExpenseAccounts
object[]
required

The expense accounts to prefill when entering bills for this vendor.

Example:
​
currency
object | null
required

The vendor's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Example:
​
customFields
The Custom Field object · object[]
required

The custom fields for the vendor object, added as user-defined data extensions, not included in the standard QuickBooks object.