Quickstart

1. Create a Conductor account

2. Create an organization

Create an organization in the Conductor dashboard. This should be the name of your company.

3. Select the testing project

In the organization you created, let’s select the “testing” project. An organization can have multiple projects, but we’ll use this one for now.

1. Create an end-user

After selecting the “testing” project in the Conductor dashboard, click the “Create end user” button.

An end-user represents the user or organization within your application for whom we are connecting to their QuickBooks Desktop instance. Each end-user maps to a single QuickBooks Desktop company file because each company file represents an individual legal entity.

2. Complete the authentication flow

After creating an end-user in the dashboard, it will automatically create an auth session. Visit this URL in your browser on the same computer or instance as your QuickBooks Desktop installation. This authentication flow will guide you through connecting your QuickBooks Desktop instance to Conductor.Read every step carefully!

3. Create an API key

In the Conductor dashboard, navigate to the API Keys tab and click the “Create secret key” button. Be sure to save the secret key in a secure location.

4. Get your end-user ID

Navigate to the End Users tab and find your end-user’s ID. You’ll need this in Step 6 to identify the end-user in your requests.

5. Install the Conductor SDK

# npm
npm install conductor-node

# yarn
yarn add conductor-node

# pnpm
pnpm add conductor-node

pip install conductor-py

# Continue to the next step to access our REST API directly via `curl`.

6. Fetch data from QuickBooks Desktop!

Try fetching a list of QBD Customers:

import Conductor from "conductor-node";
const conductor = new Conductor({ apiKey: "{{YOUR_SECRET_KEY}}" });

async function main() {
  const invoices = await conductor.qbd.invoices.list({
    conductorEndUserId: "{{YOUR_END_USER_ID}}",
    limit: 10,
  });
  console.log(invoices.data);
}

main();

from conductor import Conductor

conductor = Conductor(api_key="{{YOUR_SECRET_KEY}}")

invoices = conductor.qbd.invoices.list(
  conductor_end_user_id="{{YOUR_END_USER_ID}}",
)
print(invoices.data)

curl --request GET \
  --url 'https://api.conductor.is/v1/quickbooks-desktop/customers' \
  --header 'Authorization: Bearer {{YOUR_SECRET_KEY}}' \
  --header 'Conductor-End-User-Id: {{YOUR_END_USER_ID}}'

Example QBD response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/customers",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_customer",
      "createdAt": "2024-10-01T17:34:56.000Z",
      "name": "ABC Corporation",
      "isActive": true,
      // ...
    }
    // ...
  ],
  // ...
}

Getting Started

Usage

QuickBooks Desktop

Part 1: Set up your Conductor account

Part 2: Connect to QuickBooks Desktop

​Part 1: Set up your Conductor account

​Part 2: Connect to QuickBooks Desktop

Part 1: Set up your Conductor account

Part 2: Connect to QuickBooks Desktop