Ramp | Composio Docs

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

OAuth2

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 accounting:read,accounting:write,bank_accounts:read,bills:read,bills:write,business:read,cards:read,cards:read_vault,cards:write,cashbacks:read,custom_records:read,custom_records:write,departments:read,departments:write,entities:read,item_receipts:read,leads:read,leads:write,limits:read,limits:write,locations:read,locations:write,memos:read,memos:write,merchants:read,purchase_orders:read,receipt_integrations:read,receipt_integrations:write,receipts:read,receipts:write,reimbursements:read,spend_programs:read,spend_programs:write,statements:read,transactions:read,transfers:read,users:read,users:write,vendors:read,vendors:write

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.

Select App

Navigate to Ramp.

Configure Auth Config Settings

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

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

1 from composio import Composio
2 
3 # Replace these with your actual values
4 ramp_auth_config_id = "ac_YOUR_RAMP_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/application
6 
7 composio = Composio()
8 
9 
10 def 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 
25 connection_id = authenticate_toolkit(user_id, ramp_auth_config_id)
26 
27 # You can also verify the connection status using:
28 connected_account = composio.connected_accounts.get(connection_id)
29 print(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

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["RAMP"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def 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 
33 invoke_llm()

Tool List

RAMP_CREATE_DEPARTMENT

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

RAMP_CREATE_NEW_CUSTOM_ACCOUNTING_FIELD

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

stringRequired

input_type

stringRequired

is_required_for

array

is_splittable

boolean

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_FETCH_CUSTOM_ACCOUNTING_FIELD

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

RAMP_GET_ALL_TRANSACTIONS

Tool Name: Get All Transactions

Description

Get all the transactions.

Action Parameters

accounting_field_selection_id

string

approval_status

string

awaiting_approval_by_user_id

string

card_id

string

department_id

string

entity_id

string

from_date

string

has_no_sync_commits

boolean

include_merchant_data

boolean

limit_id

string

location_id

string

max_amount

string

merchant_id

string

min_amount

string

order_by_amount_asc

boolean

order_by_amount_desc

boolean

order_by_date_asc

boolean

order_by_date_desc

boolean

page_size

integerDefaults to 20

requires_memo

boolean

sk_category_id

string

spend_program_id

string

start

string

state

string

statement_id

string

sync_ready

boolean

sync_status

string

synced_after

string

to_date

string

trip_id

string

user_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_GET_CARD

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

RAMP_GET_DEPARTMENT

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

RAMP_GET_MY_CARDS

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

page_size

integerDefaults to 50

page_token

string

state

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_GET_MY_TRANSACTIONS

Tool Name: Get My Transactions

Description

Get my transactions.

Action Parameters

accounting_field_selection_id

string

approval_status

string

awaiting_approval_by_user_id

string

card_id

string

department_id

string

entity_id

string

from_date

string

has_no_sync_commits

boolean

include_merchant_data

boolean

limit_id

string

location_id

string

max_amount

string

merchant_id

string

min_amount

string

order_by_amount_asc

boolean

order_by_amount_desc

boolean

order_by_date_asc

boolean

order_by_date_desc

boolean

page_size

integerDefaults to 20

requires_memo

boolean

sk_category_id

string

spend_program_id

string

start

string

state

string

statement_id

string

sync_ready

boolean

sync_status

string

synced_after

string

to_date

string

trip_id

string

user_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_GET_STATEMENT

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

RAMP_GET_TRANSACTION

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

RAMP_GET_VENDOR

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

RAMP_ISSUE_VIRTUAL_CARD

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

RAMP_LIST_CARDS

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

card_program_id

string

display_name

string

entity_id

string

is_activated

boolean

is_terminated

boolean

page_size

integerDefaults to 20

start

string

user_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_LIST_DEPARTMENTS

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

page_size

integerDefaults to 20

start

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_LIST_STATEMENTS

Tool Name: List Statements

Description

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

Action Parameters

from_date

string

page_size

integerDefaults to 20

start

string

to_date

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_LIST_USERS

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

employee_id

string

entity_id

string

location_id

string

page_size

integerDefaults to 20

role

string

start

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_LIST_VENDORS

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

from_created_at

string

is_active

boolean

name

string

page_size

integerDefaults to 20

sk_category_ids

string

start

string

vendor_owner_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_OPTIONS_FOR_CUSTOM_ACCOUNTING_FIELD

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

RAMP_SEARCH_TRANSACTIONS

Tool Name: Search Transactions

Description

Search transactions with filters.

Action Parameters

accounting_field_selection_id

string

approval_status

string

awaiting_approval_by_user_id

string

card_id

string

department_id

string

entity_id

string

from_date

string

has_no_sync_commits

boolean

include_merchant_data

boolean

limit_id

string

location_id

string

max_amount

string

merchant_id

string

min_amount

string

order_by_amount_asc

boolean

order_by_amount_desc

boolean

order_by_date_asc

boolean

order_by_date_desc

boolean

page_size

integerDefaults to 20

query

stringRequired

requires_memo

boolean

sk_category_id

string

spend_program_id

string

start

string

state

string

statement_id

string

sync_ready

boolean

sync_status

string

synced_after

string

to_date

string

trip_id

string

user_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

RAMP_UPDATE_CARD_LIMIT

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

RAMP_UPDATE_DEPARTMENT

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

RAMP_UPLOAD_NEW_OPTIONS

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