Retrieve a vendor
Retrieves a vendor by ID.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Path Parameters
The QuickBooks-assigned unique identifier of the vendor to retrieve.
Response
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.
Additional alternate contacts for this vendor.
Additional notes about this vendor.
The name of a alternate contact person for this vendor.
The vendor's alternate telephone number.
The current balance owed to this vendor, represented as a decimal string. A positive number indicates money owed to the vendor.
The vendor's billing address.
The vendor's billing rate, used to override service item rates in time tracking transactions.
An email address to carbon copy (CC) on communications with this vendor.
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.
The name of the company associated with this vendor. This name is used on invoices, checks, and other forms.
The name of the primary contact person for this vendor.
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.
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.
The vendor's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
Additional custom contact fields for this vendor, such as phone numbers or email addresses.
The custom fields for the vendor object, added as user-defined data extensions, not included in the standard QuickBooks object.
The expense accounts to prefill when entering bills for this vendor.
The vendor's email address.
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.
The vendor's fax number.
The first name of the contact person for this vendor.
The unique identifier assigned by QuickBooks to this vendor. This ID is unique across all vendors but not across different QuickBooks object types.
Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true
.
Indicates whether tax is charged on top of tax for this vendor, for use in Canada or the UK.
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.
Indicates whether this vendor is a sales tax agency.
Indicates whether tax is tracked on purchases for this vendor, for use in Canada or the UK.
Indicates whether tax is tracked on sales for this vendor, for use in Canada or the UK.
The job title of the contact person for this vendor.
The last name of the contact person for this vendor.
The middle name of the contact person for this vendor.
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.
The vendor's name as it should appear on checks issued to this vendor.
A note or comment about this vendor.
The type of object. This value is always "qbd_vendor"
.
"qbd_vendor"
The vendor's primary telephone number.
The account used for tracking taxes on purchases for this vendor, for use in Canada or the UK.
The vendor's tax reporting period, for use in Canada or the UK.
monthly
, quarterly
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.
The account used for tracking taxes on sales for this vendor, for use in Canada or the UK.
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.
The country for which sales tax is collected for this vendor.
australia
, canada
, uk
, us
The vendor's sales tax return information, used for tracking and reporting sales tax liabilities.
The formal salutation title that precedes the name of the contact person for this vendor, such as "Mr.", "Ms.", or "Dr.".
The vendor's shipping address.
The vendor's tax identification number (e.g., EIN or SSN).
The vendor's tax registration number, for use in Canada or the UK.
The vendor's payment terms, defining when payment is due and any applicable discounts.
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.
The vendor's type, used for categorizing vendors into meaningful segments, such as industry or region.