nXus Documentation
A modern REST API for QuickBooks Desktop. Read and write QuickBooks data from any language or platform — without installing the QB SDK.
New here?
What is nXus?
How it works
-
Your app sends a REST request to the nXus API (e.g.
GET /api/v1/Vendors). - nXus translates that request into the QuickBooks Desktop format and routes it through your connected QuickBooks Web Connector flow.
- QuickBooks Desktop processes the request against the selected company file on the local machine.
- The response is normalized back into JSON and returned to your app without persisting production QuickBooks data on nXus servers.
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);
}