Conductor Docs

Documentation

QBD API 2.0 (alpha)

Help

Have any questions?

Community

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

The EndUser object

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.

Authentication 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

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

Request more examples!

Authentication

Request IDs

Timeouts

The ConductorError object

Create an EndUser

Retrieve an EndUser

List all EndUsers

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

This object represents a connection between an end-user and a third-party platform.

The IntegrationConnection object

Retrieves an IntegrationConnection object.

Retrieve an IntegrationConnection

Returns a list of all IntegrationConnections belonging to all of your EndUsers.

List all IntegrationConnections

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 IntegrationConnection authentication flow, create an AuthSession. Pass the returned session’s `authFlowUrl` to the client for your end-user to launch the IntegrationConnection authentication flow.

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 the Conductor's new QuickBooks Desktop API (alpha)

The Account object

Create an account

Retrieve an account

List all accounts

The Bill object

Create a bill

Retrieve a bill

List all bills

The Class object

Create a class

Retrieve a class

List all classes

The Credit Card Charge object

Creates a credit card charge for the specified account.

Create a credit card charge

Retrieve a credit card charge

List all credit card charges

The Customer object

Create a customer

Retrieve a customer

List all customers

The Date-Driven Term object

Retrieve a date-driven term

List all date-driven terms

The Inventory Item object

Create an inventory item

Retrieve an inventory item

List all inventory items

The Invoice object

Create an invoice

Retrieve an invoice

List all invoices

The Non-Inventory Item object

Create a non-inventory item

Retrieve a non-inventory item

List all non-inventory items

The Sales Tax Code object

Retrieve a sales tax code

List all sales tax codes

The Sales Tax Item object

Retrieve a sales tax item

List all sales tax items

The Service Item object

Create a service item

Retrieve a service item

List all service items

The Standard Term object

Retrieve a standard term

List all standard terms

The Vendor object

Create a vendor

Retrieve a vendor

List all vendors

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

QuickBooks Desktop FAQ for end-users

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

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 company files on a single computer

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

Ensure the QuickBooks Web Connector opens at startup

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

Upgrade the QuickBooks Web Connector

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

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

How to disable the QuickBooks Desktop connection

How to set up the QuickBooks Web Connector to connect to QuickBooks Desktop when using Rightworks.

Overview

Usage

QuickBooks Desktop

QuickBooks Desktop API Examples

Core Resources API Reference

The EndUser object