Skip to content
Back to search

quickbooks-desktop-node

QuickBooks Desktop API for Node.js (TypeScript or JavaScript)

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/conductor-is/quickbooks-desktop-node with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/conductor-is/quickbooks-desktop-node'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/conductor-is--quickbooks-desktop-node/badge.svg)](/listings/conductor-is--quickbooks-desktop-node)

HTML

<a href="/listings/conductor-is--quickbooks-desktop-node"><img src="/api/listings/conductor-is--quickbooks-desktop-node/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm install conductor-node

> [!IMPORTANT] > If you're migrating from the old `conductor-node` package (v11 or earlier), please see the [upgrade guide](https://docs.conductor.is/qbd-api/upgrade-node).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 461 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <!-- markdownlint-disable MD033 MD041 -->
  2. <div align="center">
  3. <a href="https://conductor.is">
  4. <picture>
  5. <source media="(prefers-color-scheme: dark)" srcset="https://github.com/conductor-is/quickbooks-desktop-api/assets/170023/162ee6a9-75ac-41e9-9f1e-2ecc1d88f841">
  6. <img alt="Conductor logo" src="https://github.com/conductor-is/quickbooks-desktop-api/assets/170023/d67464b8-53a7-4d33-afeb-05a2efde1fa8" width="325">
  7. </picture>
  8. </a>
  9. <h3>QuickBooks Desktop/Enterprise real-time API for Node.js, Python, and REST</h3>
  10. <a href="https://docs.conductor.is/quickstart">Quickstart</a>
  11. <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
  12. <a href="https://conductor.is">Website</a>
  13. <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
  14. <a href="https://docs.conductor.is">Docs</a>
  15. <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
  16. <a href="https://docs.conductor.is/qbd-api">Examples</a>
  17. <br />
  18. <br />
  19. <a href="https://npmjs.com/package/conductor-node"><img src="https://img.shields.io/npm/dm/conductor-node.svg?logo=npm" alt="NPM download count"></a>
  20. <a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="NPM version"></a>
  21. <a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/bundlephobia/minzip/conductor-node" alt="NPM bundle size"></a>
  22. <img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Code coverage">
  23. <a href="LICENSE"><img src="https://img.shields.io/npm/l/conductor-node.svg?color=blue&logo=github" alt="License" /></a>
  24. <hr />
  25. </div>
  26. [Conductor](https://conductor.is) is a real-time, fully-typed API for **QuickBooks Desktop** (sometimes called QuickBooks Enterprise). In just a few lines, get real-time access to fetch, create, or update _any_ QuickBooks Desktop object type and receive a fully-typed response.
  27. ⭐ **Follow our [Quickstart guide](https://docs.conductor.is/quickstart) to get started.**
  28. This repository contains the official Conductor **Node.js** library, which provides convenient access to our QuickBooks Desktop API from any server-side TypeScript or JavaScript application.
  29. - For Python, see [conductor-python](https://github.com/conductor-is/quickbooks-desktop-python).
  30. ## Documentation
  31. The REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/api-ref). The full API of this library can be found in [api.md](api.md).
  32. ## MCP Server
  33. Conductor's hosted MCP server lets Claude (claude.ai, Claude Desktop, mobile, and Cowork), ChatGPT, Claude Code, Codex CLI, Cursor, VS Code, and Microsoft Copilot Studio read and write your QuickBooks Desktop and QuickBooks Enterprise data. Most AI tools add the URL below and sign in to Conductor in the browser, so there is no key to copy.
  34. ```text
  35. https://mcp.conductor.is/
  36. ```
  37. The read-only URL, `https://mcp.conductor.is/read-only`, blocks writes. Microsoft Copilot Studio connects to `https://mcp.conductor.is/mcp` with a Conductor API key. QuickBooks Desktop and the Web Connector must be running on the computer you connected to Conductor. The [MCP setup guide](https://docs.conductor.is/usage/mcp) has the steps for each AI tool.
  38. ## Installation
  39. ```sh
  40. npm install conductor-node
  41. ```
  42. > [!IMPORTANT]
  43. > If you're migrating from the old `conductor-node` package (v11 or earlier), please see the [upgrade guide](https://docs.conductor.is/qbd-api/upgrade-node).
  44. ## Key features
  45. - **Any data type**: Query, create, or update any QuickBooks Desktop data type.
  46. - **Real-time**: Get real-time updates on your QuickBooks Desktop data. No queues, no jobs, no cache layer -- just direct access to the data.
  47. - **Modern API**: JSON-based REST API, replacing the old XML-based SOAP model.
  48. - **Typed client libraries**: Fully typed libraries in Node.js and Python with autocomplete, inline docs, and type validation for endpoints, parameters, and responses.
  49. - **Request handling**: Invisibly manages queues, timeouts, retries, and pagination.
  50. - **Auto-pagination**: Automatically handles paginated responses to retrieve complete datasets.
  51. - **Multi-company support**: Connects to multiple QuickBooks Desktop company files.
  52. - **Validation**: Sanitizes and validates all inputs and outputs.
  53. - **Unified error handling**: Streamlines error handling across the QuickBooks stack.
  54. - **Authentication flow UI**: Simple UI for securely connecting QuickBooks Desktop accounts.
  55. - **Dashboard**: UI to monitor and manage your QuickBooks Desktop connections and data.
  56. - **Error resolution**: Detailed guides and instructions for resolving errors and handling edge cases.
  57. ## Usage
  58. The full API of this library can be found with code samples at [docs.conductor.is/qbd-api](https://docs.conductor.is/api-ref).
  59. <!-- prettier-ignore -->
  60. ```js
  61. import Conductor from 'conductor-node';
  62. const conductor = new Conductor({
  63. apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
  64. });
  65. const page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });
  66. const invoice = page.data[0];
  67. console.log(invoice.id);
  68. ```
  69. ### Request & Response types
  70. This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
  71. <!-- prettier-ignore -->
  72. ```ts
  73. import Conductor from 'conductor-node';
  74. const conductor = new Conductor({
  75. apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
  76. });
  77. const params: Conductor.Qbd.InvoiceListParams = { conductorEndUserId: 'YOUR_END_USER_ID' };
  78. const [invoice]: [Conductor.Qbd.Invoice] = await conductor.qbd.invoices.list(params);
  79. ```
  80. Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
  81. ## Handling errors
  82. When the library is unable to connect to the API,
  83. or if the API returns a non-success status code (i.e., 4xx or 5xx response),
  84. a subclass of `APIError` will be thrown:
  85. <!-- prettier-ignore -->
  86. ```ts
  87. const page = await conductor.qbd.invoices
  88. .list({ conductorEndUserId: 'YOUR_END_USER_ID' })
  89. .catch(async (err) => {
  90. if (err instanceof Conductor.APIError) {
  91. console.log(err.status); // 400
  92. console.log(err.name); // BadRequestError
  93. console.log(err.headers); // {server: 'nginx', ...}
  94. } else {
  95. throw err;
  96. }
  97. });
  98. ```
  99. Error codes are as follows:
  100. | Status Code | Error Type |
  101. | ----------- | -------------------------- |
  102. | 400 | `BadRequestError` |
  103. | 401 | `AuthenticationError` |
  104. | 403 | `PermissionDeniedError` |
  105. | 404 | `NotFoundError` |
  106. | 422 | `UnprocessableEntityError` |
  107. | 429 | `RateLimitError` |
  108. | >=500 | `InternalServerError` |
  109. | N/A | `APIConnectionError` |
  110. ### Retries
  111. Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
  112. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
  113. 429 Rate Limit, and >=500 Internal errors will all be retried by default.
  114. You can use the `maxRetries` option to configure or disable this:
  115. <!-- prettier-ignore -->
  116. ```js
  117. // Configure the default for all requests:
  118. const conductor = new Conductor({
  119. maxRetries: 0, // default is 2
  120. });
  121. // Or, configure per-request:
  122. await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {
  123. maxRetries: 5,
  124. });
  125. ```
  126. ### Timeouts
  127. Requests time out after 2 minutes by default. You can configure this with a `timeout` option:
  128. <!-- prettier-ignore -->
  129. ```ts
  130. // Configure the default for all requests:
  131. const conductor = new Conductor({
  132. timeout: 20 * 1000, // 20 seconds (default is 2 minutes)
  133. });
  134. // Override per-request:
  135. await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {
  136. timeout: 5 * 1000,
  137. });
  138. ```
  139. On timeout, an `APIConnectionTimeoutError` is thrown.
  140. Note that requests which time out will be [retried twice by default](#retries).
  141. ## Auto-pagination
  142. List methods in the Conductor API are paginated.
  143. You can use the `for await … of` syntax to iterate through items across all pages:
  144. ```ts
  145. async function fetchAllInvoices(params) {
  146. const allInvoices = [];
  147. // Automatically fetches more pages as needed.
  148. for await (const invoice of conductor.qbd.invoices.list({
  149. conductorEndUserId: 'YOUR_END_USER_ID',
  150. })) {
  151. allInvoices.push(invoice);
  152. }
  153. return allInvoices;
  154. }
  155. ```
  156. Alternatively, you can request a single page at a time:
  157. ```ts
  158. let page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });
  159. for (const invoice of page.data) {
  160. console.log(invoice);
  161. }
  162. // Convenience methods are provided for manually paginating:
  163. while (page.hasNextPage()) {
  164. page = await page.getNextPage();
  165. // ...
  166. }
  167. ```
  168. ## Advanced Usage
  169. ### Accessing raw Response data (e.g., headers)
  170. The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
  171. This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
  172. You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
  173. Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
  174. <!-- prettier-ignore -->
  175. ```ts
  176. const conductor = new Conductor();
  177. const response = await conductor.qbd.invoices
  178. .list({ conductorEndUserId: 'YOUR_END_USER_ID' })
  179. .asResponse();
  180. console.log(response.headers.get('X-My-Header'));
  181. console.log(response.statusText); // access the underlying Response object
  182. const { data: page, response: raw } = await conductor.qbd.invoices
  183. .list({ conductorEndUserId: 'YOUR_END_USER_ID' })
  184. .withResponse();
  185. console.log(raw.headers.get('X-My-Header'));
  186. for await (const invoice of page) {
  187. console.log(invoice.id);
  188. }
  189. ```
  190. ### Logging
  191. > [!IMPORTANT]
  192. > All log messages are intended for debugging only. The format and content of log messages
  193. > may change between releases.
  194. #### Log levels
  195. The log level can be configured in two ways:
  196. 1. Via the `CONDUCTOR_LOG` environment variable
  197. 2. Using the `logLevel` client option (overrides the environment variable if set)
  198. ```ts
  199. import Conductor from 'conductor-node';
  200. const conductor = new Conductor({
  201. logLevel: 'debug', // Show all log messages
  202. });
  203. ```
  204. Available log levels, from most to least verbose:
  205. - `'debug'` - Show debug messages, info, warnings, and errors
  206. - `'info'` - Show info messages, warnings, and errors
  207. - `'warn'` - Show warnings and errors (default)
  208. - `'error'` - Show only errors
  209. - `'off'` - Disable all logging
  210. At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
  211. Some authentication-related headers are redacted, but sensitive data in request and response bodies
  212. may still be visible.
  213. #### Custom logger
  214. By default, this library logs to `globalThis.console`. You can also provide a custom logger.
  215. Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
  216. When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
  217. below the configured level will not be sent to your logger.
  218. ```ts
  219. import Conductor from 'conductor-node';
  220. import pino from 'pino';
  221. const logger = pino();
  222. const conductor = new Conductor({
  223. logger: logger.child({ name: 'Conductor' }),
  224. logLevel: 'debug', // Send all messages to pino, allowing it to filter
  225. });
  226. ```
  227. ### Making custom/undocumented requests
  228. This library is typed for convenient access to the documented API. If you need to access undocumented
  229. endpoints, params, or response properties, the library can still be used.
  230. #### Undocumented endpoints
  231. To make requests to undocumented endpoints, you can use `conductor.get`, `conductor.post`, and other HTTP verbs.
  232. Options on the client, such as retries, will be respected when making these requests.
  233. ```ts
  234. await conductor.post('/some/path', {
  235. body: { some_prop: 'foo' },
  236. query: { some_query_arg: 'bar' },
  237. });
  238. ```
  239. #### Undocumented request params
  240. To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
  241. parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
  242. send will be sent as-is.
  243. ```ts
  244. conductor.qbd.invoices.list({
  245. // ...
  246. // @ts-expect-error baz is not yet public
  247. baz: 'undocumented option',
  248. });
  249. ```
  250. For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
  251. extra param in the body.
  252. If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
  253. options.
  254. #### Undocumented response properties
  255. To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
  256. the response object, or cast the response object to the requisite type. Like the request params, we do not
  257. validate or strip extra properties from the response from the API.
  258. ### Customizing the fetch client
  259. By default, this library expects a global `fetch` function is defined.
  260. If you want to use a different `fetch` function, you can either polyfill the global:
  261. ```ts
  262. import fetch from 'my-fetch';
  263. globalThis.fetch = fetch;
  264. ```
  265. Or pass it to the client:
  266. ```ts
  267. import Conductor from 'conductor-node';
  268. import fetch from 'my-fetch';
  269. const conductor = new Conductor({ fetch });
  270. ```
  271. ### Fetch options
  272. If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
  273. ```ts
  274. import Conductor from 'conductor-node';
  275. const conductor = new Conductor({
  276. fetchOptions: {
  277. // `RequestInit` options
  278. },
  279. });
  280. ```
  281. #### Configuring proxies
  282. To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
  283. options to requests:
  284. <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
  285. ```ts
  286. import Conductor from 'conductor-node';
  287. import * as undici from 'undici';
  288. const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
  289. const conductor = new Conductor({
  290. fetchOptions: {
  291. dispatcher: proxyAgent,
  292. },
  293. });
  294. ```
  295. <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
  296. ```ts
  297. import Conductor from 'conductor-node';
  298. const conductor = new Conductor({
  299. fetchOptions: {
  300. proxy: 'http://localhost:8888',
  301. },
  302. });
  303. ```
  304. <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
  305. ```ts
  306. import Conductor from 'npm:conductor-node';
  307. const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
  308. const conductor = new Conductor({
  309. fetchOptions: {
  310. client: httpClient,
  311. },
  312. });
  313. ```
  314. ## Frequently Asked Questions
  315. ## Semantic versioning
  316. This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
  317. 1. Changes that only affect static types, without breaking runtime behavior.
  318. 2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
  319. 3. Changes that we do not expect to impact the vast majority of users in practice.
  320. We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
  321. We are keen for your feedback; please open an [issue](https://www.github.com/conductor-is/quickbooks-desktop-node/issues) with questions, bugs, or suggestions.
  322. ## Requirements
  323. TypeScript >= 4.9 is supported.
  324. The following runtimes are supported:
  325. - Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
  326. - Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
  327. - Deno v1.28.0 or higher.
  328. - Bun 1.0 or later.
  329. - Cloudflare Workers.
  330. - Vercel Edge Runtime.
  331. - Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
  332. - Nitro v2.6 or greater.
  333. Note that React Native is not supported at this time.
  334. If you are interested in other runtime environments, please open or upvote an issue on GitHub.
  335. ## Contributing
  336. See [the contributing documentation](./CONTRIBUTING.md).
  337. ## Resources
  338. - [How Conductor compares to unified APIs for QuickBooks Desktop](https://conductor.is/blog/conductor-vs-apideck)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.