> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/quickbooks.md).

# Quickbooks

First, you need to set a Quickbooks key and endpoint through the Backoffice in order to provide the Quickbooks components to your customers.

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                     |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Yes.** With production keys any QuickBooks Online company can connect. Development keys work only with sandbox companies.                                                                                               |
| **Vendor review**       | **Required** for production keys: the App Assessment Questionnaire under **Keys and credentials → Production → Compliance**. A QuickBooks App Store listing is a separate, optional review.                               |
| **Review time**         | Not published.                                                                                                                                                                                                            |
| **Users before review** | None in production. Development keys connect only sandbox companies.                                                                                                                                                      |
| **App owner**           | Any Intuit developer account. Production keys also need EULA and privacy policy URLs, the app's host domain, launch, disconnect and connect URLs, and an approved questionnaire.                                          |
| **Regions**             | One app. You declare the regions where the app is hosted. Intuit App Partner Program fees and availability differ by region.                                                                                              |
| **Client secret**       | No expiry documented.                                                                                                                                                                                                     |
| **Rate limits**         | Per company (realm ID): 500 requests per minute, and 10 per second per company and app. The free Builder tier allows 500,000 CorePlus calls (most read operations) per month per workspace; calls above that are blocked. |
| **Checked**             | 2026-11-13                                                                                                                                                                                                                |

**Limitations**

* A refresh token that is not used for 100 days expires, and every refresh token expires 5 years after it was issued. The user then connects the company again.
* On the Builder tier, CorePlus calls stop working for the rest of the month once the 500,000 credits are used. Paid tiers (Silver and up) charge for calls above their credits instead.
* All apps are enrolled in the Intuit App Partner Program; platform fees apply to production apps whether or not they are listed on the App Store.

Sources: [Publish your app](https://developer.intuit.com/app/developer/qbo/docs/go-live/publish-app), [Authorization FAQ](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/faq), [API call limits and throttles](https://developer.intuit.com/app/developer/qbo/docs/learn/limits-and-throttles), [Intuit App Partner Program FAQ](https://developer.intuit.com/app/developer/qbo/docs/get-started/partner-faq). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Register the app

Go to the <https://developer.intuit.com/app/developer/dashboard> to create a new app.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-774fcbd7b737de22c6dc1a6235f5529c5fbb3739%2Fquickbooks-1.png?alt=media" alt=""><figcaption></figcaption></figure>

Select the name and scope:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-8fa1ad5d0555fc6c31bbafd67b896f24e9fa4574%2Fquickbooks-2.png?alt=media" alt=""><figcaption></figcaption></figure>

Then you receive your *clientID* and *clientSecret*.

Intuit issues two separate key pairs: **Development keys** work only with sandbox companies and **Production keys** work only with production companies. Configure the pair that matches the companies your users will connect.

Also add the redirect URL. Example: `https://api.YOUR_SUBDOMAIN.appmixer.cloud/auth/quickbooks/callback`.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-17fd24f52879a2ce4ec6202ae1d7caa50df816c5%2Fquickbooks-3.png?alt=media" alt=""><figcaption></figcaption></figure>

Put the keys into the Backoffice; see [Backoffice configuration](#backoffice-configuration).

## Webhooks

All trigger components (for example `NewInvoice`) use QuickBooks webhooks. In order to use this component(s) in Appmixer, you have to register Appmixer's QuickBooks URI in QuickBooks first and set the webhook key in the Appmixer BackOffice.

Go to <https://developer.intuit.com/app/developer/dashboard> then choose your Appmixer app. Navigate to the "Webhooks" section either for the sandbox or production environment and add a new webhook.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-c37597ccfaa22b1bceb01cf119eea01f97bea336%2Fquickbooks-4.png?alt=media" alt=""><figcaption><p>QuickBooks Webhooks configuration</p></figcaption></figure>

Fill the field **Endpoint URL** with `https://api.acme.appmixer.cloud/plugins/appmixer/quickbooks/webhooks` (replace `acme` with your subdomain).

In **Subscribed events**, select the entities and operations the trigger components consume:

| Entity   | Operations     | Trigger components           |
| -------- | -------------- | ---------------------------- |
| Bill     | Create, Update | NewBill, UpdatedBill         |
| Customer | Create, Update | NewCustomer, UpdatedCustomer |
| Invoice  | Create, Update | NewInvoice, UpdatedInvoice   |

Leave the **Enable cloud event payload format** toggle **off** — the connector processes the classic webhook payload format.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-7536fe9a0dc75a7b849a06dcc9362c62f9a332c4%2Fquickbooks-5.png?alt=media" alt=""><figcaption><p>QuickBooks Webhooks event triggers</p></figcaption></figure>

For detailed steps, see [QuickBooks documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks#endpoints).

Copy the **Verifier Token** and set it in the Backoffice; see [Backoffice configuration](#backoffice-configuration).

## Backoffice configuration

Configuration ID: `appmixer:quickbooks` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `clientId` — Client ID of the QuickBooks app registered above. Not needed when QuickBooks is authenticated through the Appmixer Auth Hub.
* `clientSecret` — Client secret of the same app. Not needed with the Auth Hub.
* `sandbox` — Optional. Set to `true` when `clientId` and `clientSecret` are the **Development (sandbox) keys**. It switches the connector to the sandbox API (`sandbox-quickbooks.api.intuit.com`) and the sandbox OpenID endpoint. Omit it with Production keys; production is the default.
* `webhookVerifierToken` — The **Verifier Token** from the Webhooks section of the app. Required for the trigger components. Several tokens can be set comma-separated.
* `webhookVerifierTokenSandbox` — Optional. Intuit issues a different verifier token for the Development (sandbox) and Production webhook sections, even when both point at the same endpoint. Set the production token in `webhookVerifierToken` and the sandbox token here. Incoming events are verified against every configured token; delivery is routed by the company (`realmId`), so sandbox and production events never mix.
* `requireListenerAccessToken` — Optional. When `true`, the webhook endpoint rejects triggers that register without an access token (triggers of older connector versions). By default such triggers are accepted and a warning is logged.
* `outputFilePrefix` — Optional. File name prefix of the CSV file that **ListAccounts**, **ListClasses**, **ListCustomers**, **ListJournals** and **ListVendors** create when their output is set to a file. Default `quickbooks-export`.
* `prodBaseURL`, `sandboxBaseURL` — Optional. Base URL of the Intuit accounts (OpenID) API. Defaults `https://accounts.platform.intuit.com` and `https://sandbox-accounts.platform.intuit.com`.
* `prodApiUrl`, `sandboxApiURL` — Optional. Base URL of the QuickBooks API. Defaults `https://quickbooks.api.intuit.com` and `https://sandbox-quickbooks.api.intuit.com`.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-2fd2b655b94478b0cf9fa6049fccceee396eaea1%2Fquickbooks-6.png?alt=media" alt=""><figcaption><p>Appmixer BackOffice configuration for QuickBooks Webhooks</p></figcaption></figure>

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:quickbooks -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>",
  "webhookVerifierToken": "<verifier token>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/quickbooks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
