Intuit

The Intuit auth provider enables tools and agents to call the Intuit QuickBooks Online API  on behalf of a user, using OAuth 2.0.

What’s documented here

This page describes how to use and configure Intuit (QuickBooks) auth with Arcade.

This auth provider is used by:

• Your app code that needs to call Intuit/QuickBooks APIs
• Or, your custom tools that need to call Intuit/QuickBooks APIs

Arcade offers a default Intuit auth provider for getting started quickly. In production you will most likely want to use your own Intuit app credentials, so your users see your application’s name on the consent screen.

Scopes

Intuit splits its scopes into the QuickBooks API scopes and the OpenID Connect scopes. Request only the scopes your tools need.

Configuring Intuit auth

Before configuring your Intuit credentials in Arcade, create an app on the Intuit Developer portal.

Create an Intuit app

Configuring your own Intuit Auth Provider in Arcade

Using Intuit auth in app code

Use the Intuit auth provider in your own agents and AI apps to get a user token for the Intuit/QuickBooks API. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a user token for the Intuit API:

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "{arcade_user_id}"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="intuit",
    scopes=["com.intuit.quickbooks.accounting", "openid", "profile", "email"],
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# Do something interesting with the token...

import { Arcade } from "@arcadeai/arcadejs";
 
const client = new Arcade();
 
const userId = "{arcade_user_id}";
 
// Start the authorization process
const authResponse = await client.auth.start(userId, "intuit", {
  scopes: ["com.intuit.quickbooks.accounting", "openid", "profile", "email"],
});
 
if (authResponse.status !== "completed") {
  console.log("Please complete the authorization challenge in your browser:");
  console.log(authResponse.url);
}
 
// Wait for the authorization to complete
authResponse = await client.auth.waitForCompletion(authResponse);
 
const token = authResponse.context.token;
// Do something interesting with the token...

Using Intuit auth in custom tools

You can author your own custom tools that interact with the Intuit/QuickBooks API.

Use the Intuit() auth class to specify that a tool requires authorization with Intuit. The context.authorization.token field will be automatically populated with the user’s Intuit token. The user’s QuickBooks company (realm) id is returned on the authorization context and is required for most accounting API calls:

from typing import Annotated
 
import httpx
 
from arcade_tdk import ToolContext, tool
from arcade_tdk.auth import Intuit
 
 
@tool(
    requires_auth=Intuit(
        scopes=["com.intuit.quickbooks.accounting"],
    )
)
async def get_company_info(
    context: ToolContext,
    realm_id: Annotated[str, "The QuickBooks company (realm) id to query."],
) -> Annotated[dict, "The QuickBooks CompanyInfo resource"]:
    """Get the authenticated user's QuickBooks company information."""
    url = f"https://quickbooks.api.intuit.com/v3/company/{realm_id}/companyinfo/{realm_id}"
    headers = {
        "Authorization": f"Bearer {context.authorization.token}",
        "Accept": "application/json",
    }
 
    async with httpx.AsyncClient() as client:
        response = await client.get(url, headers=headers)
        response.raise_for_status()
        return response.json()