COconductor-is

Retrieve a vendor

Changed on

Retrieves a vendor by ID.

IMPORTANT: If you need to fetch multiple specific vendors by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/vendors/{id}

Request

Path parameters

idstring required

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

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified vendor.

idstring required

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

objectType'qbd_vendor' required

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

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

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

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

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

isActiveboolean required

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

companyNamestring nullable required

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

salutationstring nullable required

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

firstNamestring nullable required

The first name of the contact person for this vendor.

middleNamestring nullable required

The middle name of the contact person for this vendor.

lastNamestring nullable required

The last name of the contact person for this vendor.

jobTitlestring nullable required

The job title of the contact person for this vendor.

phonestring nullable required

The vendor's primary telephone number.

alternatePhonestring nullable required

The vendor's alternate telephone number.

faxstring nullable required

The vendor's fax number.

emailstring nullable required

The vendor's email address.

ccEmailstring nullable required

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

contactstring nullable required

The name of the primary contact person for this vendor.

alternateContactstring nullable required

The name of a alternate contact person for this vendor.

nameOnCheckstring nullable required

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

accountNumberstring nullable 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.

notestring nullable required

A note or comment about this vendor.

creditLimitstring nullable 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.

taxIdentificationNumberstring nullable required

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

isEligibleFor1099boolean nullable 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.

balancestring nullable required

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

externalIdstring nullable 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.

salesTaxCountrystring nullable required

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

isSalesTaxAgencyboolean nullable required

Indicates whether this vendor is a sales tax agency.

taxRegistrationNumberstring nullable required

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

reportingPeriod'monthly' | 'quarterly' | 'annual' nullable required

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

isTrackingPurchaseTaxboolean nullable required

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

isTrackingSalesTaxboolean nullable required

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

isCompoundingTaxboolean nullable required

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

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_vendor",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Acme Supplies Inc.",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Suppliers"
  },
  "companyName": "Acme Corporation",
  "salutation": "Dr.",
  "firstName": "John",
  "middleName": "A.",
  "lastName": "Doe",
  "jobTitle": "Purchasing Manager",
  "billingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "shippingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "phone": "+1-555-123-4567",
  "alternatePhone": "+1-555-987-6543",
  "fax": "+1-555-555-1212",
  "email": "vendor@example.com",
  "ccEmail": "manager@example.com",
  "contact": "Jane Smith",
  "alternateContact": "Bob Johnson",
  "customContactFields": [
    {
      "name": "Main Phone",
      "value": "555-123-4567"
    }
  ],
  "additionalContacts": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_contact",
      "createdAt": "2025-01-01T12:34:56+00:00",
      "updatedAt": "2025-02-01T12:34:56+00:00",
      "revisionNumber": "1721172183",
      "name": "Jane Smith",
      "salutation": "Dr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "jobTitle": "Purchasing Manager",
      "customContactFields": [
        {
          "name": "Main Phone",
          "value": "555-123-4567"
        }
      ]
    }
  ],
  "nameOnCheck": "Acme Supplies Ltd.",
  "accountNumber": "1010",
  "note": "Preferred vendor for office supplies.",
  "additionalNotes": [
    {
      "id": 1,
      "date": "2024-01-01",
      "note": "This is a fun note."
    }
  ],
  "vendorType": {
    "id": "80000001-1234567890",
    "fullName": "Wholesale Supplier"
  },
  "terms": {
    "id": "80000001-1234567890",
    "fullName": "Net 30"
  },
  "creditLimit": "5000.00",
  "taxIdentificationNumber": "12-3456789",
  "isEligibleFor1099": true,
  "balance": "1000.00",
  "billingRate": {
    "id": "80000001-1234567890",
    "fullName": "Standard Rate"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "salesTaxCountry": "us",
  "salesTaxReturn": {
    "id": "80000001-1234567890",
    "fullName": "Quarterly Sales Tax Return"
  },
  "taxRegistrationNumber": "GB123456789",
  "reportingPeriod": "quarterly",
  "isTrackingPurchaseTax": true,
  "purchaseTaxAccount": {
    "id": "80000001-1234567890",
    "fullName": "GST Paid"
  },
  "isTrackingSalesTax": true,
  "salesTaxAccount": {
    "id": "80000001-1234567890",
    "fullName": "GST Collected"
  },
  "defaultExpenseAccounts": [
    {
      "id": "80000001-1234567890",
      "fullName": "Expenses:Utilities"
    }
  ],
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Changes

  • f5e8ad815f89Revision changes
    • info

      removed the australia enum value from the / response property for the response status

    • info

      removed the canada enum value from the / response property for the response status

    • info

      removed the uk enum value from the / response property for the response status

    • info

      removed the united_arab_emirates enum value from the / response property for the response status

    • info

      removed the us enum value from the / response property for the response status

  • 2b44baac3231Revision changes
    • warning

      added the new united_arab_emirates enum value to the / response property for the response status