Conductor Docs

Documentation

QBD API 2.0 (alpha)

Help

Get started

Support

Community

Dashboard

Timeouts

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 security and data retention policies.

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

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

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 directly to the specified integration connection (e.g., QuickBooks Desktop) on behalf of the end-user.

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

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

List all bill check payments

A bill credit card payment records a payment made via credit card to pay off one or more vendor bills. It reduces accounts payable and increases the credit card 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 Credit Card Payment object

Create a bill credit card payment

Retrieves a bill credit card payment by ID.

Retrieve a bill credit card payment

Returns a list of bill credit card payments.

Use the `cursor` parameter to paginate through the results.

List all bill credit card payments

A bill represents an obligation to pay a vendor for goods or services received. It records the amount owed, due date, and payment terms, and increases accounts payable. Bills can be partially paid over time and may be linked to purchase orders or item receipts.

The Bill object

Create a bill

Update a bill

Retrieve a bill

Returns a list of bills.

Use the `cursor` parameter to paginate through the results.

List all bills

A check represents a payment made from a bank account, typically via paper check. It records the withdrawal of funds paid to a vendor, employee, or other payee. The transaction reduces the balance of the specified bank account and can be linked to bills or other transactions being paid.

The Check object

Create a check

Update a check

Retrieve a check

Returns a list of checks.

Use the `cursor` parameter to paginate through the results.

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

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

Returns a list of credit card charges.

Use the `cursor` parameter to paginate through the results.

List all credit card charges

A credit card credit represents a credit or refund received from a vendor for returned merchandise, billing adjustment, or other credit. It reduces the balance owed on the credit card account.

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

Returns a list of credit card credits.

Use the `cursor` parameter to paginate through the results.

List all credit card credits

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 estimate is a formal proposal sent to a current or prospective customer detailing costs and terms for goods or services. An estimate might also be called a “bid” or a “proposal”. In QuickBooks, estimates and invoices use similar fields, and an estimate can be converted into an invoice after the customer accepts the estimate. As a non-posting transaction, it serves as a planning tool without impacting financial statements until converted to a sale.

The Estimate object

Create an estimate

Update an estimate

Retrieve an estimate

Returns a list of estimates.

Use the `cursor` parameter to paginate through the results.

List all estimates

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.

Use the `cursor` parameter to paginate through the results.

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

Returns a list of inventory items.

Use the `cursor` parameter to paginate through the results.

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

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

An invoice is a commercial document issued to customers that itemizes and records a transaction between buyer and seller. It lists the products or services provided, their quantities, prices, payment terms, and the total amount due. In QuickBooks, invoices are used to track accounts receivable and record sales transactions where payment was not made in full at the time of purchase.

The Invoice object

Create an invoice

Update an invoice

Retrieve an invoice

Returns a list of invoices.

Use the `cursor` parameter to paginate through the results.

List all invoices

A journal entry is a direct way to record financial transactions by their debit and credit impacts on accounts, typically used for recording depreciation, adjusting entries, or other transactions that can't be entered through standard forms like bills or invoices.

The Journal Entry object

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

Returns a list of non-inventory items.

Use the `cursor` parameter to paginate through the results.

List all non-inventory items

A purchase order represents a formal request for goods or services sent to a vendor. Since it is a non-posting transaction, it serves as a commitment to purchase but does not impact the company's financial statements.

The Purchase Order object

Create a purchase order

Update a purchase order

Retrieve a purchase order

Returns a list of purchase orders.

Use the `cursor` parameter to paginate through the results.

List all purchase orders

A receive-payment records when a payment is received from a customer *not* at the time of sale. It can be used for one or more of these purposes: (1) record a customer's payment against one or more invoices, (2) set a discount (e.g., for early payment), or (3) set a credit (e.g., from returned merchandise). Note: If full payment is received at the time of sale, use a sales receipt instead.

The Receive-Payment object

Create a receive-payment

Update a receive-payment

Retrieve a receive-payment

Returns a list of receive-payments.

Use the `cursor` parameter to paginate through the results.

Getting Started

Usage

QuickBooks Desktop

QuickBooks Desktop API Examples

Core Resources API Reference

Timeouts