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

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

For code examples, see the Tool calling guide and Provider examples.

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

Action Response

data
objectRequired
error
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
is_splittable
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Accounting GL Account

Description

Tool to delete a general ledger account from Ramp. Use when you need to remove a GL account from the accounting system.

Action Parameters

gl_account_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Accounting Connection

Description

Tool to disconnect the current active API-based accounting connection. Use when you need to disable the accounting integration. This action will clear associated accounting settings including Custom Fields, GL Accounts, and Vendors. Only API-based connections can be disconnected via this endpoint.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Custom Accounting Field

Description

Tool to delete a custom accounting field from Ramp. Use when you need to remove a custom accounting field from the system. Note: Fields are read-only and cannot be deleted when a direct accounting connection is enabled.

Action Parameters

field_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Accounting Vendor

Description

Tool to delete an accounting vendor from Ramp. Use when you need to remove a vendor from the accounting system.

Action Parameters

vendor_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Fetch General Ledger Account

Description

Tool to fetch a specific general ledger account by ID from Ramp. Use when you need to retrieve detailed information about a single GL account.

Action Parameters

accounting_connection_id
gl_account_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Fetch Accounting Vendor

Description

Tool to fetch a specific accounting vendor by ID from Ramp. Use when you need to retrieve detailed information about a single accounting vendor for coding transactions, reimbursements, bills, or purchase orders.

Action Parameters

accounting_connection_id
vendor_id
stringRequired

Action Response

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

Tool Name: List General Ledger Accounts

Description

Tool to list general ledger accounts from Ramp. Use when you need to retrieve GL accounts for accounting integration or transaction categorization.

Action Parameters

code
is_active
is_synced
page_size
Defaults to 20
remote_id
start

Action Response

data
arrayRequired
error
page
successful
booleanRequired

Tool Name: Fetch All Accounting Connections

Description

Tool to fetch all accounting connections for the current Ramp business. Use when you need to view all accounting integrations, including both active and inactive connections.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Accounting Connection

Description

Tool to fetch the current active accounting connection for a Ramp account. Use when you need to check the status, type, or configuration of the active accounting integration with providers like QuickBooks or NetSuite.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Custom Accounting Fields

Description

Tool to list custom accounting fields for coding transactions. Use when you need to retrieve custom accounting fields that can be leveraged to code transactions, reimbursements, and bills.

Action Parameters

page_size
Defaults to 20
start

Action Response

data
arrayRequired
error
page
successful
booleanRequired

Tool Name: List Accounting Vendors

Description

Tool to list accounting vendors from Ramp. Use when you need to retrieve vendor data for transaction coding, reimbursements, bills, or purchase orders in the accounting system.

Action Parameters

cursor
page_size
Defaults to 20

Action Response

data
arrayRequired
error
page
successful
booleanRequired

Tool Name: Get All Transactions

Description

Get all the transactions.

Action Parameters

accounting_field_selection_id
approval_status
awaiting_approval_by_user_id
card_id
department_id
entity_id
from_date
has_no_sync_commits
include_merchant_data
limit_id
location_id
max_amount
merchant_id
min_amount
order_by_amount_asc
order_by_amount_desc
order_by_date_asc
order_by_date_desc
page_size
Defaults to 20
requires_memo
sk_category_id
spend_program_id
start
state
statement_id
sync_ready
sync_status
synced_after
to_date
trip_id
user_id

Action Response

data
arrayRequired
error
page
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
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
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
page_size
integerDefaults to 50
page_token
state

Action Response

data
arrayRequired
error
page
objectRequired
successful
booleanRequired

Tool Name: Get My Transactions

Description

Get my transactions.

Action Parameters

accounting_field_selection_id
approval_status
awaiting_approval_by_user_id
card_id
department_id
entity_id
from_date
has_no_sync_commits
include_merchant_data
limit_id
location_id
max_amount
merchant_id
min_amount
order_by_amount_asc
order_by_amount_desc
order_by_date_asc
order_by_date_desc
page_size
Defaults to 20
requires_memo
sk_category_id
spend_program_id
start
state
statement_id
sync_ready
sync_status
synced_after
to_date
trip_id
user_id

Action Response

data
arrayRequired
error
page
objectRequired
successful
booleanRequired

Tool Name: Get Reimbursement Details

Description

Tool for retrieving complete details of a specific reimbursement. Includes amount, status, user information, accounting details, receipts, and sync status. Use this to get comprehensive reimbursement information for approval workflows or detailed analysis.

Action Parameters

reimbursement_id
stringRequired

Action Response

data
objectRequired
error
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
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
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
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
display_name
memo
spending_restrictions
user_id
stringRequired

Action Response

context
data
error
id
stringRequired
status
stringRequired
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

card_program_id
display_name
entity_id
is_activated
is_terminated
page_size
Defaults to 20
start
user_id

Action Response

data
arrayRequired
error
page
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

page_size
Defaults to 20
start

Action Response

data
arrayRequired
error
page
successful
booleanRequired

Tool Name: List Reimbursements

Description

Tool for listing reimbursements with comprehensive filtering options. Returns reimbursement details including amounts, status, sync information, and associated entities. Use this to analyze reimbursement patterns, track approval workflows, and manage expense reimbursements.

Action Parameters

accounting_field_selection_id
awaiting_approval_by_user_id
direction
entity_id
from_date
from_submitted_at
from_transaction_date
has_no_sync_commits
page_size
Defaults to 20
start
sync_ready
sync_status
synced_after
to_date
to_submitted_at
to_transaction_date
trip_id
updated_after
user_id

Action Response

data
arrayRequired
error
page
successful
booleanRequired

Tool Name: List Statements

Description

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

Action Parameters

from_date
page_size
Defaults to 20
start
to_date

Action Response

data
arrayRequired
error
page
objectRequired
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
email
employee_id
entity_id
location_id
page_size
Defaults to 20
role
start

Action Response

data
arrayRequired
error
page
objectRequired
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

from_created_at
is_active
name
page_size
Defaults to 20
sk_category_ids
start
vendor_owner_id

Action Response

data
arrayRequired
error
page
objectRequired
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
arrayRequired
error
page
successful
booleanRequired

Tool Name: Upload Accounting GL Accounts

Description

Tool to batch upload general ledger accounts to Ramp. Supports up to 500 accounts per call with all-or-nothing validation. Use when you need to create GL accounts in Ramp's accounting system.

Action Parameters

gl_accounts
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Accounting Connection

Description

Tool to register a new API-based accounting connection between Ramp and an accounting provider. Use when establishing a new connection to accounting systems like QuickBooks, NetSuite, or Xero. If a Universal CSV connection exists, it will be upgraded to an API-based connection.

Action Parameters

reactivate
remote_provider_name
stringRequired
settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upload Accounting Vendors

Description

Tool to batch upload vendors to Ramp for coding transactions, bills, and purchase orders. Supports up to 500 vendors per call with all-or-nothing validation. Use when you need to create vendors in Ramp's accounting system.

Action Parameters

vendors
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Reactivate Accounting Connection

Description

Tool to reactivate a previously unlinked accounting connection by changing its status back to linked. This preserves all previous accounting field configurations and settings. Use when you need to restore a disconnected accounting integration. The business must not have any other active accounting connections.

Action Parameters

connection_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Transactions

Description

Search transactions with filters.

Action Parameters

accounting_field_selection_id
approval_status
awaiting_approval_by_user_id
card_id
department_id
entity_id
from_date
has_no_sync_commits
include_merchant_data
limit_id
location_id
max_amount
merchant_id
min_amount
order_by_amount_asc
order_by_amount_desc
order_by_date_asc
order_by_date_desc
page_size
Defaults to 20
query
stringRequired
requires_memo
sk_category_id
spend_program_id
start
state
statement_id
sync_ready
sync_status
synced_after
to_date
trip_id
user_id

Action Response

data
arrayRequired
error
page
objectRequired
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
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
department_id
stringRequired
name
parent_department_id

Action Response

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