QuickBooks Online

Read and write a company's QuickBooks Online customers, invoices and accounts.

Accounting & Finance
OAuth 2.0
Works on Free plan
Bundled in Kirak
Maintained by Kirak

How to use it

This profile ships with Kirak. Add "integrations" to modules in kirak.json, then name the profile as below. There is nothing to download, and a copy in your project's integrations/ folder is an error.

Environment variables

Variable	Holds
`KIRAK_INTEGRATION_QUICKBOOKS_CLIENT_SECRET`	The OAuth client secret from the vendor's console. Secret: keep it out of kirak.json and out of source control.
`KIRAK_AUTH_ENCRYPTION_KEYS`	Encrypts stored tokens. Shared by every integration; the module refuses to start without it.

The names follow the integration's name in kirak.json (quickbooks here). Name it something else, such as quickbooks_sales, and the variables change to match.

Redirect URL

Register this as the redirect (callback) URL in the vendor's console, with your app's address in place of <your-app> (the base_url in kirak.json):

https://<your-app>/integrations/quickbooks/callback

How to get your keys

Sign in to the Intuit developer portal and create an app for QuickBooks Online and Payments.
Pick the scopes. At least: com.intuit.quickbooks.accounting (Read and write accounting data)
Under Keys & credentials, add https://<your-app>/integrations/quickbooks/callback as a redirect URI. Development and production keys are separate; use the production ones for live companies.
Copy the client ID and the client secret.
Put the client ID in kirak.json as integrations.providers.quickbooks.client_id, and the client secret in the environment as KIRAK_INTEGRATION_QUICKBOOKS_CLIENT_SECRET. Never put the secret in kirak.json.

The vendor's own guide · Instructions out of date? ·Suggest an edit

kirak.json

Scopes com.intuit.quickbooks.accounting Read and write accounting data

{
  "integrations": {
    "providers": {
      "quickbooks": {
        "type": "oauth2",
        "profile": "quickbooks",
        "client_id": "your-client-id",
        "scope": [
          "com.intuit.quickbooks.accounting"
        ]
      }
    }
  }
}

Merged into the profile: scope replaces the profile's default scopes.

Good to know

The company (realm) id arrives on the callback as realmId, not in the token response. It is saved with the connection.
Each refresh returns a new refresh token; the latest one must be kept.
The sandbox host differs from production; this profile uses production.
Not verified against the vendor docs in this session: check the facts before release.

Help improve this profile

Report a problem ·Suggest an edit to profile.json ·Add a profile ·Vendor docs the profile was checked against

Product names and logos are trademarks of their respective owners. Their use does not imply endorsement. To ask for this icon to be removed, email trademark@kirak.io.