Quickstart

Go from zero to your first QuickBooks API call in under 10 minutes.

Prerequisites

You need a Windows machine with QuickBooks Desktop installed and a company file open. The QuickBooks Web Connector (QWC) must also be installed — it ships with QuickBooks 2002 and later.

Setup Walkthrough

1

Create your nXus account

Sign up for a free account. You’ll land on the dashboard where you can manage connections and API keys.

2

Create an API key

In the dashboard, go to Settings → API Keys and click Create Key. Give it a name (e.g. “Development”).

Your key starts with sk_test_ for development or sk_live_ for production. Copy it now — it’s only shown once.

3

Connect your QuickBooks company file

Follow the QWC Setup guide to:

  • Create a connection
  • Download your .qwc file
  • Generate a password
  • Install the connector in QuickBooks

Once the Web Connector syncs once, your company file is live.

4

Make your first API call

Use your API key in the Authorization header as a Bearer token, and include X-Connection-ID to choose which connected QuickBooks company file the request should run against.

index.ts
123456789101112131415161718
import { NxusClient, NxusApiError } from 'nxus-qbd';


const apiKey = process.env.NXUS_API_KEY;
if (!apiKey) throw new Error("Set NXUS_API_KEY");
const nxus = new NxusClient({ apiKey });

try {
  const result = await nxus.vendors.list({
  "limit": 50
}, { connectionId: "YOUR_CONNECTION_ID" });
  console.log(result.data);
} catch (err) {
  if (!(err instanceof NxusApiError)) throw err;
  console.error(err.userMessage);
  console.error({ code: err.code, status: err.status, requestId: err.requestId });
  if (err.isValidationError) console.error(err.validationErrors);
}
5

Explore the API

Browse the Interactive API Reference for all 60+ QuickBooks resources including Vendors, Bills, Invoices, Customers, Accounts, and more.

What’s next?

  • API Keys — Learn about key types, rotation, and scopes
  • QWC Setup — Detailed walkthrough for the QuickBooks connector
  • API Reference — Full endpoint docs with live code samples