Conductor Docs

Documentation

QBD API 2.0 (alpha)

Help

Have any questions?

Community

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

Ensure only one version of QuickBooks Desktop is installed

The best QuickBooks Desktop integration on the planet.

Get started with Conductor

Create your first EndUser and connect to QuickBooks Desktop in 5 minutes.

Quickstart

The key concepts you should know to use Conductor.

Terminology

Conductor's security and data retention policies.

Security and data retention

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

Connect your users via the auth flow

Use API keys to authenticate API requests.

API keys

Check an EndUser'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

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

Node.js / TypeScript for QuickBooks Desktop

If your backend does not use Node.js, you can use the REST API to interface with QuickBooks Desktop directly.

REST API for QuickBooks Desktop

Split your requests into smaller chunks to avoid overwhelming QuickBooks Desktop

Pagination

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

Mapping your app's objects to QuickBooks Desktop

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

Understanding the relationship between customers and jobs in QuickBooks Desktop.

Jobs and customers

Vendors

Invoices

Sales receipts

Bills

Inventory items

Accounts

Refunds

Conductor supports read, create, and update for *every* QuickBooks Desktop object type.

Request more examples!

Authentication

Request IDs

Timeouts

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

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

Send a 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

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

Welcome to Conductor's new QuickBooks Desktop API (alpha)

An account represents a financial account, allowing customization like sub-accounting, account numbering, and initial balance setting.

The Account object

Create an account

Update an account

Retrieve an account

List all accounts

A bill payment check is a transaction that represents a payment by check for a bill.

The Bill Payment Check object

Create a bill payment check

Update a bill payment check

Retrieve a bill payment check

List all bill payment checks

A bill payment credit card is a transaction that represents a payment by credit card for a bill.

The Bill Payment Credit Card object

Create a bill payment credit card

Retrieves a bill payment credit card by ID.

Retrieve a bill payment credit card

Returns a list of bill payment credit cards.

List all bill payment credit cards

A bill is a transaction that represents a request-for-payment from a vendor for goods or services that it has provided.

The Bill object

Create a bill

Update a bill

Retrieve a bill

List all bills

A check is a transaction that represents a paper check.

The Check object

Create a check

Update a check

Retrieve a check

List all checks

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

List all classes

A credit card charge is a general charge incurred when a QuickBooks user makes a purchase using a credit card. Credit card charges for purchases can be tracked as expenses (in expense accounts) or as items.

The Credit Card Charge object

Creates a new credit card charge for the specified account.

Create a credit card charge

Update a credit card charge

Retrieve a credit card charge

List all credit card charges

A credit card credit is a credit card refund issued to a customer.

The Credit Card Credit object

Creates a new credit card credit for the specified account.

Create a credit card credit

Update a credit card credit

Retrieve a credit card credit

List all credit card credits

A customer can refer to either one of the QuickBooks user's customers or an individual job that is being performed for a customer.

The Customer object

Create a customer

Update a customer

Retrieve a customer

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

List all date-driven terms

An inventory assembly item is an item that is assembled or manufactured from inventory items. The items and/or assemblies that make up the assembly are called components.

The Inventory Assembly Item object

Create an inventory assembly item

Updates an existing inventory assembly item.

Update an inventory assembly item

Retrieves an inventory assembly item by ID.

Retrieve an inventory assembly item

Returns a list of inventory assembly items.

List all inventory assembly items

An inventory item is any merchandise or part that a business purchases, tracks as inventory, and then resells.

The Inventory Item object

Create an inventory item

Update an inventory item

Retrieve an inventory item

List all inventory items

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

Create an inventory site

Update an inventory site

Retrieve an inventory site

List all inventory sites

An invoice records the amount owed by a customer who purchased goods or services but did not pay in full at the time of the sale.

The Invoice object

Create an invoice

Update an invoice

Retrieve an invoice

List all invoices

A non-inventory item is any material or part that a business buys but does not keep on hand as inventory.
There are two types of non-inventory items: 1. Materials or parts that are part of the business’s overhead (for example, office supplies) 2. Materials or parts that the business buys to finish a specific job and then charges back to the customer.

The Non-Inventory Item object

Create a non-inventory item

Update a non-inventory item

Retrieve a non-inventory item

List all non-inventory items

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

List all sales-tax codes

A sales-tax item is an item used to calculate a single sales tax that is collected at a specified rate and paid to a single agency.

The Sales-Tax Item object

Create a sales-tax item

Update a sales-tax item

Retrieve a sales-tax item

List all sales-tax items

A service item is an item that refers to services that a business charges for or purchases. Examples include specialized labor, consulting hours, and professional fees.

The Service Item object

Create a service item

Update a service item

Retrieve a service item

List all service items

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

List all standard terms

A transfer is a transaction that moves money from one account to another account.

The Transfer object

Create a transfer

Update a transfer

Retrieve a transfer

List all transfers

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.

FAQ

Guides

Connection errors

Ensure only one version of QuickBooks Desktop is installed