Ramp

Learn how to use Ramp with Composio

Overview

SLUG: RAMP

Description

Ramp is a platform 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 transactions:read,accounting:write,accounting:read
bearer_token
string
full
stringDefaults to https://api.ramp.com/developer/v1Required

Connecting to Ramp

Create an auth config

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

1

Select App

Navigate to the Ramp 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
4ramp_auth_config_id = "ac_YOUR_RAMP_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 Ramp: {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, ramp_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 Ramp 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=["RAMP"])
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: Accounting Sync

Description

Tool for syncing accounting data.

Action Parameters

failed_syncs
array
idempotency_key
stringRequired
successful_syncs
array
sync_type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create New Custom Accounting Field

Description

Tool for creating a new custom accounting field.

Action Parameters

id
stringRequired
input_type
stringRequired
is_required_for
array
is_splittable
boolean
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Custom Accounting Field

Description

Tool for deleting a custom accounting field.

Action Parameters

field_id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Delete Custom Accounting Field Option

Description

Tool for deleting an option for a given accounting field.

Action Parameters

field_option_id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Fetch Custom Accounting Field

Description

Tool for fetching a custom accounting field.

Action Parameters

field_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Options for Custom Accounting Field

Description

Tool for listing options for a given accounting field.

Action Parameters

field_id
stringRequired

Action Response

data
array
error
string
successful
booleanRequired

Tool Name: Update Accounting Field Option

Description

Tool for updating an option for a given accounting field.

Action Parameters

code
string
display_name
string
field_id
stringRequired
reactivate
boolean
value
string
visibility
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload New Options for Custom Accounting Field

Description

Tool for uploading new options for a given accounting field.

Action Parameters

field_id
stringRequired
options
arrayRequired

Action Response

data
array
error
string
successful
booleanRequired