POST
/
quickbooks-desktop
/
vendors

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Body

application/json
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.

Maximum length: 41 characters.

Maximum length: 41
accountNumber
string

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.

additionalContacts
object[]

Additional alternate contacts for this vendor.

additionalNotes
object[]

Additional notes about this vendor.

alternateContact
string

The name of a alternate contact person for this vendor.

alternatePhone
string

The vendor's alternate telephone number.

billingAddress
object

The vendor's billing address.

billingRateId
string

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

ccEmail
string

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

classId
string

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.

companyName
string

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

contact
string

The name of the primary contact person for this vendor.

creditLimit
string

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.

currencyId
string

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

customContactFields
object[]

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

defaultExpenseAccountIds
string[]

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

email
string

The vendor's email address.

externalId
string

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

fax
string

The vendor's fax number.

firstName
string

The first name of the contact person for this vendor.

Maximum length: 25 characters.

Maximum length: 25
isActive
boolean
default:
true

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

isCompoundingTax
boolean

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

isEligibleFor1099
boolean

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.

isSalesTaxAgency
boolean

Indicates whether this vendor is a sales tax agency.

isTrackingPurchaseTax
boolean

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

isTrackingSalesTax
boolean

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

jobTitle
string

The job title of the contact person for this vendor.

lastName
string

The last name of the contact person for this vendor.

Maximum length: 25 characters.

Maximum length: 25
middleName
string

The middle name of the contact person for this vendor.

Maximum length: 5 characters.

Maximum length: 5
nameOnCheck
string

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

note
string

A note or comment about this vendor.

openingBalance
string

The opening balance of this vendor's account, indicating the amount owed to this vendor, represented as a decimal string.

openingBalanceDate
string

The date of the opening balance of this vendor, in ISO 8601 format (YYYY-MM-DD).

phone
string

The vendor's primary telephone number.

purchaseTaxAccountId
string

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

reportingPeriod
enum<string>

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

Available options:
monthly,
quarterly
salesTaxAccountId
string

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

salesTaxCodeId
string

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. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

salesTaxCountry
enum<string>

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

Available options:
australia,
canada,
uk,
us
salesTaxReturnId
string

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

salutation
string

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

shippingAddress
object

The vendor's shipping address.

taxIdentificationNumber
string

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

taxRegistrationNumber
string

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

termsId
string

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

vendorTypeId
string

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

Response

200 - application/json
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.

additionalContacts
object[]
required

Additional alternate contacts for this vendor.

additionalNotes
object[]
required

Additional notes about this vendor.

alternateContact
string | null
required

The name of a alternate contact person for this vendor.

alternatePhone
string | null
required

The vendor's alternate telephone number.

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.

billingAddress
object | null
required

The vendor's billing address.

billingRate
object | null
required

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

ccEmail
string | null
required

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

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.

companyName
string | null
required

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

contact
string | null
required

The name of the primary contact person for this vendor.

createdAt
string
required

The date and time when this vendor was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

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.

currency
object | null
required

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

customContactFields
object[]
required

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

customFields
object[]
required

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

defaultExpenseAccounts
object[]
required

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

email
string | null
required

The vendor's email address.

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.

fax
string | null
required

The vendor's fax number.

firstName
string | null
required

The first name of the contact person for this 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.

isActive
boolean
required

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

isCompoundingTax
boolean | null
required

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

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.

isSalesTaxAgency
boolean | null
required

Indicates whether this vendor is a sales tax agency.

isTrackingPurchaseTax
boolean | null
required

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

isTrackingSalesTax
boolean | null
required

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

jobTitle
string | null
required

The job title of the contact person for this vendor.

lastName
string | null
required

The last name of the contact person for this vendor.

middleName
string | null
required

The middle name of the contact person for this vendor.

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.

nameOnCheck
string | null
required

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

note
string | null
required

A note or comment about this vendor.

objectType
string
required

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

Allowed value: "qbd_vendor"
phone
string | null
required

The vendor's primary telephone number.

purchaseTaxAccount
object | null
required

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

reportingPeriod
enum<string> | null
required

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

Available options:
monthly,
quarterly
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.

salesTaxAccount
object | null
required

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

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. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

salesTaxCountry
enum<string> | null
required

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

Available options:
australia,
canada,
uk,
us
salesTaxReturn
object | null
required

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

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.".

shippingAddress
object | null
required

The vendor's shipping address.

taxIdentificationNumber
string | null
required

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

taxRegistrationNumber
string | null
required

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

terms
object | null
required

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

updatedAt
string
required

The date and time when this vendor was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

vendorType
object | null
required

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