Quickbooks

Learn how to use Quickbooks with Composio

Overview

SLUG: QUICKBOOKS

Description

Quickbooks is a cloud-based accounting software that helps you manage your finances, track your income and expenses, and get insights into your business

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to com.intuit.quickbooks.accounting,com.intuit.quickbooks.payment,openid,profile,email,phone,address
bearer_token
string
full
stringDefaults to https://quickbooks.api.intuit.comRequired

Connecting to Quickbooks

Create an auth config

Use the dashboard to create an auth config for the Quickbooks toolkit. This allows you to connect multiple Quickbooks accounts to Composio for agents to use.

1

Select App

Navigate to the Quickbooks toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4quickbooks_auth_config_id = "ac_YOUR_QUICKBOOKS_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Quickbooks: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, quickbooks_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Quickbooks toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["QUICKBOOKS"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Account

Description

Create a new account in quickbooks with the given parameters.

Action Parameters

account_number
string
account_sub_type
string
account_type
string
name
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Create Customer

Description

Create a new customer in quickbooks with the given parameters.

Action Parameters

display_name
string
family_name
string
given_name
string
middle_name
string
suffix
string
title
string

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Create Employee

Description

Create a new employee in quickbooks.

Action Parameters

family_name
string
given_name
string
primary_addr
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Vendor

Description

Create a new vendor in quickbooks with the given details.

Action Parameters

display_name
string
family_name
string
given_name
string
middle_name
string
suffix
string
title
string

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Customer Balance Detail

Description

Generate a balance detail report for a customer in quickbooks with the given customer id.

Action Parameters

aging_method
string
arpaid
string
columns
string
custom1
string
customer_ids
array
department_ids
array
end_duedate
string
report_date
string
shipvia
string
sort_by
string
sort_order
string
start_duedate
string
term_ids
array

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Customer Balance Report

Description

Generate a balance report for a customer in quickbooks with the given customer id.

Action Parameters

accounting_method
string
arpaid
string
customer_ids
array
date_macro
string
department_ids
array
report_date
string
sort_order
string
summarize_column_by
string

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Query Account

Description

Query an account in quickbooks with the given parameters.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Read Account

Description

Read an account in quickbooks with the given account id.

Action Parameters

account_id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Read Customer

Description

Read a customer in quickbooks with the given customer id.

Action Parameters

customer_id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Read Employee

Description

Read an employee's details in quickbooks with the given employee id.

Action Parameters

employee_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Read Vendor

Description

Read a vendor in quickbooks with the given vendor id.

Action Parameters

vendor_id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Vendor Balance Detail

Description

Generate a balance detail report for a vendor in quickbooks with the given vendor id.

Action Parameters

accounting_method
string
appaid
string
date_macro
string
department_ids
array
duedate_macro
string
end_duedate
string
report_date
string
sort_by
string
sort_order
string
start_duedate
string
term_ids
array
vendor_ids
array

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Vendor Balance Report

Description

Get the balance report of a vendor in quickbooks with the given vendor id.

Action Parameters

accounting_method
string
appaid
string
date_macro
string
department_ids
array
qzurl
string
report_date
string
sort_order
string
summarize_column_by
string
vendor_ids
array

Action Response

data
object
error
string
successful
booleanRequired