Finance & Accounting

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
full
stringDefaults to https://api.ramp.com/developer/v1Required
authorizationUrl
stringDefaults to https://app.ramp.com/v1/authorizeRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to transactions:read,cards:read,cards:read_vault,cards:write,users:read,users:write,departments:read,departments:write,vendors:read,receipts:write,limits:read,limits:write,memos:read,memos:write,statements:read,accounting:write,accounting:read
bearer_token
string

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 Ramp.

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 Ramp 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
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: Create Department

Description

Tool for creating a new department in your ramp organization. perfect for setting up organizational structure and expense categorization.

Action Parameters

name
stringRequired
parent_department_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create New Custom Accounting Field

Description

Tool for creating a new custom accounting field. note: this operation requires elevated permissions not available in the demo api.

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: 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: Get Card

Description

Tool for retrieving detailed information about a specific card. returns comprehensive card details including spending limits, cardholder info, and fulfillment status. use this to get complete card profile for analysis or troubleshooting.

Action Parameters

card_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Department

Description

Tool for retrieving detailed information about a specific department. returns comprehensive department details including hierarchy information. use this to get complete department profile for organizational analysis.

Action Parameters

department_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get My Cards

Description

Tool for fetching cards assigned to you, including physical and virtual cards. useful for checking card status, limits, and managing your payment methods.

Action Parameters

card_type
string
limit
integerDefaults to 50
page_token
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get My Transactions

Description

Tool for fetching your recent transactions with flexible filtering options. perfect for expense tracking, receipt matching, and spending analysis.

Action Parameters

card_id
string
end_date
string
limit
integerDefaults to 25
max_amount
number
min_amount
number
page_token
string
start_date
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Statement

Description

Tool for retrieving statement details or downloading statements. supports json, pdf, and csv formats for financial reporting.

Action Parameters

format
stringDefaults to json
statement_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Transaction Details

Description

Tool for retrieving complete details of a specific transaction. includes merchant details, receipts, accounting codes, and dispute information.

Action Parameters

transaction_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Vendor Details

Description

Tool for retrieving detailed information about a specific vendor. returns comprehensive vendor details including spending totals, category, and contact information. use this to get complete vendor profile for analysis or updates.

Action Parameters

vendor_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Issue Virtual Card

Description

Tool for issuing virtual cards to users instantly. creates cards with customizable spending limits and restrictions. returns full card details including card number and cvv.

Action Parameters

card_program_id
string
display_name
string
memo
string
spending_restrictions
object
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Cards

Description

Tool for listing all cards across the organization with optional filters. returns card details including spending limits, cardholder info, and state. use this to analyze card distribution, monitor card states, or find specific cards.

Action Parameters

cardholder_id
string
is_physical
boolean
limit
integerDefaults to 50
start
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Departments

Description

Tool for listing all departments in the organization. returns department details including names, codes, and hierarchy information. use this to analyze organizational structure and department relationships.

Action Parameters

limit
integerDefaults to 50
start
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Statements

Description

Tool for listing all statements with filtering options. perfect for financial reporting and reconciliation workflows.

Action Parameters

end_date
string
limit
integerDefaults to 50
page_token
string
start_date
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Users

Description

Tool for listing users in your ramp organization with flexible filtering. perfect for user audits, access management, and organizational analysis. helps identify inactive users, role distribution, and departmental structures.

Action Parameters

department_id
string
limit
integerDefaults to 50
page_token
string
role
string
search_query
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Vendors

Description

Tool for listing vendors with their spending information. returns vendor details including spending totals, categories, and activity status. use this to analyze vendor relationships and procurement patterns.

Action Parameters

limit
integerDefaults to 50
start
string

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Transactions

Description

Tool for searching transactions across your organization with powerful filters. perfect for finding specific expenses, analyzing spending patterns, or locating transactions for receipts. example: "show me all uber expenses this month" or "find aws charges over $500".

Action Parameters

department_id
string
end_date
string
has_receipts
boolean
limit
integerDefaults to 25
location_id
string
max_amount
number
merchant_category
string
min_amount
number
page_token
string
query
stringRequired
start_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Card Spending Limit

Description

Tool for updating spending limits on a card. note: this returns the limits associated with the card. the actual update might require using the limit id directly via patch /limits/{limit id}.

Action Parameters

amount
integerRequired
card_id
stringRequired
interval
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Department

Description

Tool for updating an existing department in your ramp organization. useful for reorganizing departmental structure or renaming departments.

Action Parameters

code
string
department_id
stringRequired
name
string
parent_department_id
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
objectRequired
error
string
successful
booleanRequired