An inventory site is a location where inventory is stored. For example, a company might have a warehouse, a stockroom, and a showroom, each of which is an inventory site. NOTE: Inventory sites require QuickBooks Enterprise with an Advanced Inventory subscription.

The Inventory Site object

Stockroom

Conductor Docs

Connect to QuickBooks Desktop via a modern API in 5 minutes.

Quickstart

The best QuickBooks Desktop integration on the planet.

What is Conductor?

Conductor's policies on security, data retention, and data processing.

Security and data retention

The key concepts you should know to use Conductor.

Terminology

Enable your users to securely connect their QuickBooks Desktop to your application.

Connect your users via the auth flow

Authenticate every Conductor API request with secret or publishable keys.

API keys

Check an end-user's connection status

Catch and respond to connection errors, invalid requests, data problems, and more.

Error handling

Use Conductor's built-in autocomplete to discover all available APIs, requests parameters, and response fields.

Autocomplete

Create your own QuickBooks Desktop test instance with an AWS WorkSpace.

Create a QuickBooks Desktop test instance

Obtain a free Not-For-Resale (NFR) license to use QuickBooks Desktop indefinitely for development and testing with Conductor. Takes 2 minutes.

Get a free QuickBooks Desktop developer license

How to handle syncing your application's data objects with QuickBooks Desktop objects.

Mapping your app's objects to QuickBooks Desktop

Welcome to Conductor's QuickBooks Desktop API

Conductor's new QuickBooks Desktop API is a massive leap forward and sets the foundation for future integrations.

What's new in API v2

Check out Conductor's official Node.js and Python SDKs for integrating with the QuickBooks Desktop API.

SDKs

How to migrate from the old `conductor-node` package to Conductor's new Node.js SDK and QuickBooks Desktop API v2.

Upgrading to Conductor's new Node.js SDK

Authentication

Learn how to efficiently retrieve large datasets in API v2 from QuickBooks Desktop using cursor-based pagination.

Pagination

Request IDs

Timeouts

The standard error format that the Conductor API returns for all errors.

The Error object

Download and use our OpenAPI specification

OpenAPI

Checks whether the specified QuickBooks Desktop connection is active and can process requests end-to-end. This is useful for showing a "connection status" indicator in your app. If an error occurs, the typical Conductor error response will be returned. As with any request to QuickBooks Desktop, the health check may fail if the application is not running, the wrong company file is open, or if a modal dialog is open. Timeout is 60 seconds.

Health check

Sends a request directly to the specified integration connection (e.g., QuickBooks Desktop) on behalf of the end-user.

Passthrough

Missing QBD types

An FAQ guide written for the end-users of Conductor's QuickBooks Desktop integration.

QuickBooks Desktop FAQ for end-users

Learn how to transfer your QuickBooks Desktop connection to a different computer for the same company file.

Moving your QuickBooks Desktop connection to a different computer

Step-by-step instructions and best practices for connecting several QuickBooks Desktop company files that live on the same Windows machine.

Connecting multiple QuickBooks company files on one computer

Learn how to remove a QuickBooks Desktop connection from the QuickBooks Web Connector.

Removing a QuickBooks Desktop connection

Learn how to use QuickBooks Desktop's built-in utilities to fix and identify data issues in your company file.

Repairing data corruption in QuickBooks Desktop

Conductor will not function properly if multiple versions of QuickBooks Desktop are installed on the same computer.

Ensuring only one version of QuickBooks Desktop is installed

Learn how to upgrade the QuickBooks Web Connector to ensure compatibility with Conductor.

Upgrading the QuickBooks Web Connector

Set up the QuickBooks Web Connector to automatically launch and run in the background whenever you start your computer.

Ensuring the QuickBooks Web Connector opens at startup

How to set up the QuickBooks Web Connector when using Rightworks (formerly Right Networks) to host QuickBooks Desktop.

Connecting to QuickBooks Desktop on Rightworks

Learn how to change which QuickBooks Desktop user a specific Web Connector connection uses.

Changing the QuickBooks Desktop user for a connection

Learn how to change a QuickBooks Web Connector connection's settings so you can modify its access level, automatic login, personal data access, and more.

Changing a Web Connector connection's settings

How to fix: "Your QuickBooks Desktop connection is not active"

How to fix: "Could not start QuickBooks"

How to fix: "QBWC1085: There was a problem with the log file"

How to fix: "Do you want to allow this app to make changes to your device?"

How to fix: "QBWC1039: This application has not accessed this QuickBooks company data file before"

How to fix: "Another update is in progress"

How to fix: "QBWC1039: Unique OwnerID/FileID pair value required"

How to fix: "Unable to cast COM object of type System.__ComObject..."

Product updates

Use API keys to authenticate API requests.

Execute real-time requests for *any* QuickBooks Desktop object type with fully-typed requests and responses.

Node.js / TypeScript for QuickBooks Desktop

Understanding the relationship between customers and jobs in QuickBooks Desktop.

Jobs and customers

Vendors

Invoices

Sales receipts

Bills

Inventory items

Accounts

Refunds

Split your requests into smaller chunks to avoid overwhelming QuickBooks Desktop.

The ConductorError object

An EndUser represents a user of your application. Use it to connect integrations.

The EndUser object

Create an EndUser

Retrieve an EndUser

List all EndUsers

Permanently deletes an EndUser object and all of its connections.

Delete an EndUser

Send a passthrough request to an EndUser's integration connection

Checks whether the specified IntegrationConnection can connect and process requests end-to-end. This is useful for showing a "connection status" indicator in your app.

Ping an EndUser's connection

An AuthSession is the secure way to programmatically launch the client-side Conductor authentication flow that lets your users connect their accounts to your integration.

The AuthSession object

To launch the authentication flow, create an AuthSession and pass the returned session’s `authFlowUrl` to the client for your end-user to visit in their browser.

Create an AuthSession

Retrieves the details of an AuthSession that has previously been created.

Retrieve an AuthSession

Move your QuickBooks Desktop connection to a different computer

How to connect to multiple QuickBooks Desktop company files on a single computer.

Connect to multiple QuickBooks company files on a single computer

Learn how to disable the QuickBooks Desktop connection in the QuickBooks Web Connector.

How to disable the QuickBooks Desktop connection

Learn how to use the Rebuild and Verify Data utilities to fix and identify data issues in your QuickBooks Desktop company file.

Rebuild and verify Data in QuickBooks Desktop

Ensure only one version of QuickBooks Desktop is installed

Upgrade the QuickBooks Web Connector

Ensure the QuickBooks Web Connector opens at startup

API v2.0 vs v1.0

Learn how to efficiently retrieve large datasets in API v2.0 from QuickBooks Desktop using cursor-based pagination.

An account in QuickBooks Desktop represents a financial account used to track money and transactions. It can be customized with features like hierarchical sub-accounts, account numbers, and opening balances. Accounts form the foundation of the chart of accounts and can represent various types like bank accounts, credit cards, income, expense, and other financial categories.

The Account object

Create an account

Update an account

Retrieve an account

Returns a list of accounts. NOTE: QuickBooks Desktop does not support pagination for accounts; hence, there is no `cursor` parameter. Users typically have few accounts.

List all accounts

A class is a category used to group QuickBooks objects into meaningful categories. For example, classes can be used to classify transactions by department, location, or type of work.

The Class object

Create a class

Update a class

Retrieve a class

Returns a list of classes. NOTE: QuickBooks Desktop does not support pagination for classes; hence, there is no `cursor` parameter. Users typically have few classes.

List all classes

A customer record in QuickBooks Desktop represents either a business or individual who purchases goods or services, or a specific job/project being performed for that customer. Jobs are treated as sub-customers and inherit billing information from their parent customer while allowing for job-specific details to be tracked.

The Customer object

Create a customer

Update a customer

Retrieve a customer

Returns a list of customers. Use the `cursor` parameter to paginate through the results.

List all customers

A date-driven term shows the day of the month by which payment is due and can include a discount for early payment.

The Date-Driven Term object

Create a date-driven term

Retrieve a date-driven term

Returns a list of date-driven terms. NOTE: QuickBooks Desktop does not support pagination for date-driven terms; hence, there is no `cursor` parameter. Users typically have few date-driven terms.

List all date-driven terms

An employee represents a person employed by the company. It stores personal information, employment details, and payroll data used for personnel management and payroll processing.

The Employee object

Create an employee

Update an employee

Retrieve an employee

Returns a list of employees. Use the `cursor` parameter to paginate through the results.

List all employees

Create an inventory site

Update an inventory site

Retrieve an inventory site

Returns a list of inventory sites. NOTE: QuickBooks Desktop does not support pagination for inventory sites; hence, there is no `cursor` parameter. Users typically have few inventory sites.

List all inventory sites

A payroll wage item defines a type of payment scheme in QuickBooks Desktop, such as Regular Pay or Overtime Pay, that specifies how employee wages are calculated and tracked.

The Payroll Wage Item object

Create a payroll wage item

Retrieve a payroll wage item

Returns a list of payroll wage items. Use the `cursor` parameter to paginate through the results.

List all payroll wage items

A sales representative is a person who can be assigned to sales transactions in QuickBooks Desktop. The sales representative corresponds to a separate employee, vendor, or other-name entity in QuickBooks.

The Sales Representative object

Create a sales representative

Updates an existing sales representative.

Update a sales representative

Retrieve a sales representative

Returns a list of sales representatives. NOTE: QuickBooks Desktop does not support pagination for sales representatives; hence, there is no `cursor` parameter. Users typically have few sales representatives.

List all sales representatives

A sales tax code helps categorize items on a sales form as taxable or non-taxable, detailing reasons and associating tax codes with customers, items, or transactions.

The Sales-Tax Code object

Create a sales-tax code

Update a sales-tax code

Retrieve a sales-tax code

Returns a list of sales-tax codes. NOTE: QuickBooks Desktop does not support pagination for sales-tax codes; hence, there is no `cursor` parameter. Users typically have few sales-tax codes.

List all sales-tax codes

A standard term is a payment term that shows the number of days within which payment is due and can include a discount for early payment.

The Standard Term object

Create a standard term

Retrieve a standard term

Returns a list of standard terms. NOTE: QuickBooks Desktop does not support pagination for standard terms; hence, there is no `cursor` parameter. Users typically have few standard terms.

List all standard terms

A vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) A company's vendor list contains information such as account balance and contact information about each vendor.

The Vendor object

Create a vendor

Update a vendor

Retrieve a vendor

Returns a list of vendors. Use the `cursor` parameter to paginate through the results.

List all vendors

A bill check payment records a payment made by check to pay off one or more vendor bills. It reduces accounts payable and decreases the bank account balance. This transaction links the original bill(s) with the payment, allowing QuickBooks to track which bills have been paid and maintain accurate vendor balances.

The Bill Check Payment object

Create a bill check payment

Update a bill check payment

Retrieve a bill check payment

Returns a list of bill check payments. Use the `cursor` parameter to paginate through the results.

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

The Inventory Site object