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
12345678910111213141516
import { NxusClient, NxusApiError, type Vendor, type PaginatedPage } from '@nxus/sdk';
const nxus = new NxusClient({ apiKey: process.env.NXUS_API_KEY });
try {
const result: PaginatedPage<Vendor> = await nxus.vendors.list({
connectionId: 'conn_abc123',
limit: 50
});
console.log(result.data);
} catch (err) {
if (err instanceof NxusApiError) {
console.error(`API Error: ${err.userMessage}`);
console.log(err.validationErrors);
}
}