# Quickbooks (prebuilt connector)

## Description

**Quickbooks** is a cloud-based accounting solution. &#x20;

## API documentation

API documentation for **Quickbooks** (used to build this connector) can be found via the link below:

{% embed url="<https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account>" %}

## Authentication&#x20;

When adding connector instances for Quickbooks, the following authentication methods are supported:

* [OAuth 2 (authorisation code)](#oauth-2-authorisation-code)

### OAuth 2 (authorisation code)

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **OAuth 2 (authorisation code)** authentication, the credentials below are prompted:

<table><thead><tr><th width="219">Credential</th><th width="150" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Base URL</code></td><td>true</td><td>Enter the URL that you use to access Quickbooks, without the <code>https://</code> prefix. For example: <code>sandbox-quickbooks.api.intuit.com</code></td></tr><tr><td><code>Company Id</code></td><td>true</td><td>Enter your Quickbooks company id (also known as <em>realm id)</em>. This can be found in Quickbooks under the <em>Billing &#x26; Subscription</em> option. For more information please see <a href="https://quickbooks.intuit.com/learn-support/en-us/account-management/how-do-i-find-my-company-id-that-quickbooks-has-assigned-to-me/00/1164977#:~:text=You&#x27;ll%20have%20to%20visit,and%20manage%20your%20subscription%20accordingly.">this Quickbooks help article</a>. </td></tr><tr><td><code>Client ID</code></td><td>true</td><td>Your <code>client id</code> is generated from the Quickbooks dashboard as part of your Patchworks app setup process. For more information please refer to <a href="https://developer.intuit.com/app/developer/qbo/docs/get-started/get-client-id-and-client-secret">this Quickbooks guide</a>.</td></tr><tr><td><code>Client Secret</code></td><td>true</td><td>Your <code>client secret</code> is generated from the Quickbooks dashboard as part of your Patchworks app setup process. For more information please refer to <a href="https://developer.intuit.com/app/developer/qbo/docs/get-started/get-client-id-and-client-secret">this Quickbooks guide</a>.</td></tr><tr><td><code>State length</code> </td><td>true</td><td>If you have been given a state length, enter it here. This is a numeric value which determines the length of a random string generated (behind the scenes) during the OAuth process, for verification purposes.</td></tr><tr><td><code>Scope</code></td><td>true</td><td>Enter the required scope for Patchworks authorisation. For more information about allowed scopes please see <a href="https://developer.intuit.com/app/developer/qbo/docs/learn/scopes">this Quickbooks guide</a>.</td></tr><tr><td><code>Response authentication token key</code></td><td>true</td><td>Leave set to <code>access_token.</code></td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Leave set to <code>authorization_code</code>.</td></tr><tr><td><code>Response type key</code></td><td>true</td><td>Leave set to <code>code</code>.</td></tr><tr><td><code>Refresh grant type)</code></td><td>true</td><td>Leave set to <code>refresh token</code>.</td></tr><tr><td><code>Response refresh token key)</code></td><td>true</td><td>Leave set to <code>refresh token</code>.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/quickbooks-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
