Xero

Learn how to use Xero with Composio

Overview

SLUG: XERO

Description

Xero is a cloud-based accounting software for small businesses, providing invoicing, bank reconciliation, bookkeeping, and financial reporting in real time

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.xero.com/connectionsRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to accounting.transactions.read accounting.transactions offline_access
bearer_token
string

Connecting to Xero

Create an auth config

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

1

Select App

Navigate to Xero.

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 Xero Auth Config”. 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
4xero_auth_config_id = "ac_YOUR_XERO_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 Xero: {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, xero_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 Xero 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=["XERO"])
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: Get Connections

Description

Tool to list active xero connections. use when you need to retrieve all current tenant connections for the authenticated user.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts

Description

Tool to retrieve a list of contacts. use when you need up-to-date contact information with filtering, paging, or incremental updates.

Action Parameters

ContactID
string
IDs
array
If-Modified-Since
string
includeArchived
boolean
order
string
page
integer
pageSize
integer
searchTerm
string
summaryOnly
boolean
where
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Quotes

Description

Tool to retrieve a list of quotes. use when you need to list, filter, or page through sales quotes. use after obtaining the tenant id via connections.

Action Parameters

ContactID
string
DateFrom
string
DateTo
string
ExpiryDateFrom
string
ExpiryDateTo
string
If-Modified-Since
string
QuoteNumber
string
Status
string
order
string
page
integer
xero-tenant-id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Invoice

Description

Tool to update an existing invoice. use when you need to modify the details of an invoice after it's been created.

Action Parameters

InvoiceID
string
InvoiceNumber
string
Invoices
arrayRequired
unitdp
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired