The Ramp connector lets your AI agent act in each user's Ramp account. Each user signs in to Ramp once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 114 tools.
- Tools
- 114
- What they doRead · write · destructive
- 71 · 41 · 271 read41 write2 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Ramp app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Ramp connection
In AgentKit > Connections, create a Ramp connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Ramp connections use your own OAuth app. Register one with Ramp and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Ramp connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'ramp'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Ramp:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'ramp_accounting_connection_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "ramp"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Ramp:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="ramp_accounting_connection_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolramp_accounting_connection_listList all accounting system connections for the Ramp business.Read-onlyList Accounting Connections
List all accounting system connections for the Ramp business. Returns the connections with ID, accounting system, status and creation time. Use this to see which ERP is connected, or to get an inactive connection's ID for the accounting_connection_id filter on accounting list tools.
Inputs
This tool takes no inputs.
ramp_accounting_field_listList the custom accounting fields (such as class, department or project) configured in Ramp, filtered by remote ID or active state.Read-onlyList Accounting Fields
List the custom accounting fields (such as class, department or project) configured in Ramp, filtered by remote ID or active state. Returns a page of fields with Ramp ID, remote ID, name, input type and active flag, plus page.next. Use this to find field IDs for coding. Use ramp_accounting_field_option_list for a field's options.
Inputs
accounting_connection_idstring- If this accounting field belongs to an inactive accounting connection, you must specify that accounting connection's ID. Get the ID from ramp_accounting_connection_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
is_activeboolean- Filter by active status. If not provided, returns all custom accounting fields. If true, returns only active fields. If false, returns only inactive fields. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
remote_idstring- Filter by Remote/external ID of custom accounting fields in ERP system. Example: 1001.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_accounting_field_option_listList the options of a custom accounting field, filtered by field, code, remote ID, visibility or active state.Read-onlyList Accounting Field Options
List the options of a custom accounting field, filtered by field, code, remote ID, visibility or active state. Returns a page of options with Ramp ID, remote ID, code, name, visibility and active flag, plus page.next. Use this to pick an option for accounting coding. Set field_id (from ramp_accounting_field_list) or field_remote_id, not both.
Inputs
accounting_connection_idstring- If this custom field option belongs to an inactive accounting connection, you must specify that accounting connection's ID. Get the ID from ramp_accounting_connection_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
codestring- Filter by code of custom accounting field options. Example: 6000.
field_idstring- The ID of the custom accounting field that this custom accounting field option belongs to. This is the ramp_id returned from custom field endpoints. Mutually exclusive with field_remote_id. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
field_remote_idstring- Remote/external ID of the custom accounting field in the ERP system. Mutually exclusive with field_id. Example: class.
is_activeboolean- Filter by active status. If not provided, returns all custom accounting field options. If true, returns only active options. If false, returns only inactive options. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
remote_idstring- Filter by Remote/external ID of custom accounting field options in ERP system. Example: 1001.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
visibilitystring- Filter by visibility of custom accounting field options. If not provided, returns options with any visibility. Example: HIDDEN.one of
HIDDENVISIBLE
ramp_accounting_vendor_listList the vendors synced into Ramp from the connected accounting system (ERP), filtered by code, remote ID, active or sync state.Read-onlyList Accounting Vendors
List the vendors synced into Ramp from the connected accounting system (ERP), filtered by code, remote ID, active or sync state. Returns a page of accounting vendors with Ramp ID, remote ID, code, name and active flag, plus page.next. Use this to link a Ramp vendor to an ERP vendor. Use ramp_vendor_list for Ramp vendors.
Inputs
accounting_connection_idstring- If this object belongs to an inactive accounting connection, you must specify that accounting connection's ID. Get the ID from ramp_accounting_connection_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
codestring- Filter by code. Example: 6000.
is_activeboolean- Filter by active status. If not provided, returns all objects. If true, returns only active objects. If false, returns only inactive objects. Example: true.
is_syncedboolean- Set to true to return only vendors synced from the accounting system, or false for only those that are not. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
remote_idstring- Filter by Remote/external ID. Example: 1001.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_ai_spend_api_key_listList AI provider (OpenAI, Anthropic) API keys tracked by Ramp with their estimated spend for a date range.Read-onlyList AI Spend API Keys
List AI provider (OpenAI, Anthropic) API keys tracked by Ramp with their estimated spend for a date range. Returns a page of API keys sorted by estimated cost, with key ID, provider, status, owner and estimated cost, plus page.next. Use this to see which API keys drive AI cost. Use ramp_ai_spend_team_list for spend by person and ramp_ai_spend_usage_list for daily usage.
Inputs
from_datestringrequired- Start date of the requested period in UTC, inclusive. Must be on or after 2023-01-01. The period can span up to 365 days. Example: 2026-01-01.
to_datestringrequired- End date of the requested period in UTC, exclusive. The period can span up to 365 days. Example: 2026-02-01.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
providersstring- Comma-separated providers to include. Omit to include OpenAI and Anthropic. Example: ANTHROPIC,OPENAI.
startstring- Pagination cursor. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statusesstring- Comma-separated current API key statuses to include. Omit to exclude terminated API keys. Example: active,expired.
ramp_ai_spend_team_listList Ramp users with estimated AI spend (OpenAI, Anthropic, Cursor) in a date range, optionally only anomalous spenders.Read-onlyList AI Spend by User
List Ramp users with estimated AI spend (OpenAI, Anthropic, Cursor) in a date range, optionally only anomalous spenders. Returns a page of users with profile details and estimated AI spend, plus page.next. Use this to see who spends on AI tools. Use ramp_ai_spend_api_key_list for spend by API key.
Inputs
from_datestringrequired- Start date of the requested period in UTC, inclusive. The period can span up to 365 days. Example: 2026-01-01.
to_datestringrequired- End date of the requested period in UTC, exclusive. The period can span up to 365 days. Example: 2026-02-01.
is_anomalousboolean- Filter by whether Ramp detected anomalous AI spend during the requested period. Omit to include all users. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
providersstring- Comma-separated AI providers to include. Omit to include all supported providers. Example: ANTHROPIC,CURSOR.
startstring- Pagination cursor. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_ai_spend_usage_listList daily AI usage and estimated spend grouped by provider, model and product for a date range.Read-onlyList AI Usage
List daily AI usage and estimated spend grouped by provider, model and product for a date range. Returns a page of daily rows with provider, model, product, usage and estimated cost, plus page.next. Use this to analyse AI usage trends. Use ramp_ai_spend_team_list for spend by person.
Inputs
from_datestringrequired- Start date of the requested period in UTC, inclusive. The period can span up to 365 days. Example: 2026-01-01.
to_datestringrequired- End date of the requested period in UTC, exclusive. The period can span up to 365 days. Example: 2026-02-01.
modelsstring- Comma-separated exact provider model names to include. Omit to include all models. Example: gpt-4o,claude-sonnet-4-5.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
productsstring- Comma-separated exact product names reported by providers to include. Omit to include all products. Example: ChatGPT.
providersstring- Comma-separated AI providers to include. Omit to include OpenAI and Anthropic. Example: ANTHROPIC,OPENAI.
startstring- Pagination cursor. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_approval_listGet approval data for a set of Ramp transactions, reimbursements or bills.Read-onlyList Approvals
Get approval data for a set of Ramp transactions, reimbursements or bills. Returns a page of approval records with the approval steps, approvers and their status for each requested item, plus page.next. Use this to see who has approved or still needs to approve spend. Use ramp_transaction_list or ramp_bill_list to find the item IDs first.
Inputs
entity_idsarrayrequired- IDs (UUIDs) of the transactions, reimbursements or bills to get approvals for, all of the type set in entity_type. Sent as repeated entity_ids query parameters. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
entity_typestringrequired- Type of resource under approval. Example: BILL.one of
BILLREIMBURSEMENTTRANSACTION page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_audit_log_event_listList Ramp audit log events, filtered by user, actor type, event type, agent, object or date.Read-onlyList Audit Log Events
List Ramp audit log events, filtered by user, actor type, event type, agent, object or date. Returns a page of events with the event type, actor, affected object and time, plus page.next. Use this to see who changed what in Ramp. Filtering by object_id also needs resource_name.
Inputs
agent_namesstring- Only return events executed by these agents, using their customer-visible labels. Pass several values as a comma-separated list. Example: Policy Agent.
event_actor_typesstring- Filter by audit log events of these actor types. Pass several values as a comma-separated list. Example: user,policy_agent.
event_typesstring- Only return events of these types, using Ramp's event type names (for example Card created). Pass several values as a comma-separated list. Example: Card created,Bill approved.
from_datestring- Filter by audit log events created at or after this date. start_time is accepted as a compatibility alias. Example: 2026-01-15T00:00:00Z.
object_idstring- Filter by audit log events referencing this object ID (e.g. transaction_id, vendor_id, etc.). The resource name must also be provided when filtering by object ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
resource_namestring- Filter by audit log events referencing this resource name. The object ID must also be provided when filtering by resource name. Example: Card.one of
Accounting rule groupApprovalsBill paymentBill templateCardCash Manager recommendationFixed asset classFixed assetForecast custom inputFund requestInvestment accountLegal entityManaged portfolio transferPayment runReimbursementSFTP ConfigurationsSeparation of dutiesSpend allocationSpend eventSpend programTransactionTravel (Booking request)Travel (Trip)Treasury accountUserVendor / MerchantWBX PolicyWBX RequestWallet automation policyWallet transferWorkflow (Base)Workflow startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_datestring- Filter by audit log events created at or before this date. end_time is accepted as a compatibility alias. Example: 2026-01-15T00:00:00Z.
user_idsstring- Filter by audit log events attributed to these user IDs. Pass several values as a comma-separated list. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6,9b2f1c7e-4d3a-4e8b-a1f2-6c5d4e3b2a10.
ramp_bank_account_getGet one of the business's connected bank accounts by ID.Read-onlyGet Bank Account
Get one of the business's connected bank accounts by ID. Returns the account name, last four digits, institution, subtype, connection provider and whether ACH details are on file. Use this when you have a bank account ID. Use ramp_bank_account_list to find accounts.
Inputs
bank_account_idstringrequired- ID of the business bank account (UUID). Get it from ramp_bank_account_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bank_account_listList the business's connected bank accounts, optionally filtered by connection provider.Read-onlyList Bank Accounts
List the business's connected bank accounts, optionally filtered by connection provider. Returns a page of bank accounts with ID, account name, last four digits, institution, subtype and connection provider, plus page.next. Use this to find the bank accounts Ramp pays from. Use ramp_bank_account_get for one account and ramp_vendor_bank_account_list for vendor accounts.
Inputs
connection_providerstring- Filter bank accounts by connection provider. Example: finicity.one of
finicitymanualplaidramp_brokerageramp_walletteller page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_banking_account_balance_history_getGet daily available-balance snapshots for a Ramp banking account, optionally within a date range.Read-onlyGet Banking Account Balance History
Get daily available-balance snapshots for a Ramp banking account, optionally within a date range. Returns a page of daily balance entries, plus page.next. Use this to track a treasury account's balance over time. Get the account ID from ramp_banking_account_list.
Inputs
account_idstringrequired- ID of the Ramp banking account. Get it from ramp_banking_account_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
end_datestring- Shows only account balances on or before this date (ISO8601 format). Example: 2026-01-31.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
start_datestring- Filters for account balances on or after this date (ISO8601 format). Example: 2026-01-01.
ramp_banking_account_listList the business's Ramp banking (treasury) accounts, including checking, brokerage and investment accounts.Read-onlyList Ramp Banking Accounts
List the business's Ramp banking (treasury) accounts, including checking, brokerage and investment accounts. Returns a page of accounts with ID, account type and display name, plus page.next. Use this to find a Ramp banking account. Use ramp_banking_account_balance_history_get for its balances.
Inputs
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_draft_getGet one Ramp draft bill by ID.Read-onlyGet Draft Bill
Get one Ramp draft bill by ID. Returns the draft's vendor, invoice number, amount, line items, accounting coding, dates, memos and status. Use this when you have a draft bill ID. Use ramp_bill_draft_list to find drafts.
Inputs
draft_bill_idstringrequired- ID of the draft bill (UUID). Get it from ramp_bill_draft_list or ramp_bill_draft_create. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_draft_listList draft bills in Ramp, filtered by vendor, entity, invoice number, remote ID, or created, due or issue dates.Read-onlyList Draft Bills
List draft bills in Ramp, filtered by vendor, entity, invoice number, remote ID, or created, due or issue dates. Returns a page of draft bills with ID, vendor, invoice number, amount, dates and status, plus page.next. Use this to find drafts waiting to be submitted. Use ramp_bill_list for submitted bills.
Inputs
entity_idstring- Filter draft bills by entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_created_atstring- Shows only draft bills with a created_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_due_datestring- Shows only draft bills with a due_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_issued_datestring- Shows only draft bills with a issued_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
invoice_numberstring- Filter draft bills by exact invoice number. Example: INV-2026-0042.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
remote_idstring- Filter draft bills by exact remote ID. Example: 1001.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_created_atstring- Shows only draft bills with a created_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_due_datestring- Shows only draft bills with a due_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_issued_datestring- Shows only draft bills with a issued_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
vendor_idstring- Filter draft bills by vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_getGet one Ramp bill by ID.Read-onlyGet Bill
Get one Ramp bill by ID. Returns the bill's vendor, invoice number, amount, line items, accounting coding, dates, approval status, payment details, status summary, attachments and deep link. Use this when you have a bill ID. Use ramp_bill_list to find bills.
Inputs
bill_idstringrequired- ID of the bill (UUID). Get it from ramp_bill_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_listList Ramp bills (accounts payable), filtered by vendor, status, payment status or method, approval, sync state, amount, and created, due, issued, paid or payment dates.Read-onlyList Bills
List Ramp bills (accounts payable), filtered by vendor, status, payment status or method, approval, sync state, amount, and created, due, issued, paid or payment dates. Returns a page of bills with ID, vendor, invoice number, amount, due and issue dates, status summary, approval and payment details, plus page.next. Use this to find bills. Use ramp_bill_get for one bill and ramp_bill_draft_list for draft bills.
Inputs
accounting_field_selection_idstring- Filter bills by its accounting field selection. Bills that are coded with this accounting field will be returned. Get the ID from ramp_accounting_field_option_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
approval_statusstring- List bills of the provided bill approval status. Note that this is separate from the approval status for payment release. Example: APPROVED.one of
APPROVEDINITIALIZEDPENDINGREJECTEDTERMINATED customer_friendly_payment_idstring- Filter bills by exact customer-friendly payment ID. Returns all bills belonging to the same payment or batch payment. Example: PMT-8F3K2.
draft_bill_idstring- Filter bills by exact draft bill ID. Get the ID from ramp_bill_draft_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
entity_idstring- Filter bills by entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_created_atstring- Shows only bills with a created_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_due_datestring- Shows only bills with a due_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_issued_datestring- Shows only bills with a issued_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_paid_atstring- Shows only bills with a paid_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_payment_datestring- Shows only bills with a payment_date on or after this date. Note: this filter is not supported for card payments and `from_due_date` should be used instead, which will be the equivalent as the payment date after support is added. Example: 2026-01-15.
invoice_numberstring- Filter bills by exact invoice number. Example: INV-2026-0042.
is_accounting_sync_enabledboolean- Filter bills by whether they are configured to sync to the ERP. Set to true to return only bills that will sync, or false to return only bills excluded from ERP sync. Example: true.
is_archivedboolean- Show archived (deleted) bills instead of active bills. Defaults to False. Example: true.
is_payment_sync_readyboolean- Filter by payment accounting export readiness, independently of payment_status. Omit to return bills regardless of payment readiness. Example: true.
max_amountnumber- Shows only bills with an amount less than or equal to this value. Example: 5000.
min_amountnumber- Shows only bills with an amount greater than or equal to this value. Example: 100.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
payment_details_missingboolean- Set to true to return only bills that are missing payment details (e.g., vendor bank account, payment method). When not provided or false, no payment-details filter is applied. Example: true.
payment_idstring- Filter bills by payment ID. Returns all bills belonging to the same payment. Get the ID from ramp_bill_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
payment_methodstring- List bills of the provided payment method. Example: ACH.one of
ACHCARDCHECKCRYPTO_WALLET_TRANSFERDOMESTIC_WIREINTERNATIONALLOCAL_BANK_TRANSFERONE_TIME_CARDONE_TIME_CARD_DELIVERYPAID_MANUALLYSWIFT payment_statusstring- List bills of the provided payment status. Example: OPEN.one of
OPENPAID purchase_order_idstring- Filter bills by purchase order. Get the ID from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
remote_idstring- Filter bills by exact remote ID. Example: 1001.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
status_summariesstring- Filter bills by one or more status summaries. Expects a comma-separated list of status summaries. Example: AWAITING_PAYMENT,PAYMENT_SCHEDULED.
sync_readyboolean- Only show bills that are ready to sync to ERP, if set to True. Example: true.
sync_statusstring- List bills of the provided sync status. Example: BILL_AND_PAYMENT_SYNCED.one of
BILL_AND_PAYMENT_SYNCEDBILL_SYNCEDNOT_SYNCED to_created_atstring- Shows only bills with a created_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_due_datestring- Shows only bills with a due_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_issued_datestring- Shows only bills with a issued_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_paid_atstring- Shows only bills with a paid_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_payment_datestring- Shows only bills with a payment_date on or before this date. Note: this filter is not supported for card payments and `to_due_date` should be used instead, which will be the equivalent as the payment date after support is added. Example: 2026-01-15.
vendor_idstring- Filter bills by vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_business_balance_getGet the connected Ramp business's current balances and limits.Read-onlyGet Business Balance
Get the connected Ramp business's current balances and limits. Returns card and flex limits, available card limit, current and statement balances (with and without pending charges) and the previous and next billing dates. Use this to check available spending capacity. Use ramp_business_get for the company profile.
Inputs
This tool takes no inputs.
ramp_business_getGet the connected Ramp business's company profile.Read-onlyGet Business
Get the connected Ramp business's company profile. Returns the business ID, legal name and name on card, billing address, phone, website, creation time, approved limit and settings such as SSO enforcement and whether reimbursements are enabled. Use this to identify which Ramp business is connected. Use ramp_business_balance_get for balances and limits.
Inputs
This tool takes no inputs.
ramp_card_getGet one physical Ramp card by ID.Read-onlyGet Physical Card
Get one physical Ramp card by ID. Returns the card's display name, last four digits, expiration, cardholder, state, suspension flag, linked fund, routing setting and shipping fulfillment details. Use this when you have a physical card ID. Use ramp_card_list to find cards.
Inputs
card_idstringrequired- ID of the physical card (UUID). Get it from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_card_listList physical Ramp cards, optionally filtered by cardholder, display name, activation or termination.Read-onlyList Physical Cards
List physical Ramp cards, optionally filtered by cardholder, display name, activation or termination. Returns a page of cards with ID, display name, last four digits, cardholder, state, suspension flag, fund and fulfillment status, plus page.next. Use this to find a physical card. Use ramp_virtual_card_list for virtual cards and ramp_card_get for one card. Only activated cards are returned unless include_activated_only is false.
Inputs
display_namestring- Filter by display name. Example: Marketing Team Card.
include_activated_onlyboolean- Filter only for activated cards. Defaults to True if not specified. Example: true.
include_terminated_onlyboolean- Filter only for terminated cards. Defaults to False if not specified. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
user_idstring- Filter by card owner. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_cashback_getGet one Ramp cashback payment by ID.Read-onlyGet Cashback Payment
Get one Ramp cashback payment by ID. Returns the cashback's amount, entity, sync status and creation time. Use this when you have a cashback ID. Use ramp_cashback_list to find cashback payments.
Inputs
cashback_idstringrequired- ID of the cashback payment (UUID). Get it from ramp_cashback_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_cashback_listList Ramp cashback payments, filtered by sync status, entity, statement or date.Read-onlyList Cashback Payments
List Ramp cashback payments, filtered by sync status, entity, statement or date. Returns a page of cashback payments with ID, amount, entity, sync status and creation time, plus page.next. Use this to review cashback earned. Use ramp_cashback_get for one payment.
Inputs
entity_idstring- Filter cashbacks by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_datestring- Filter cashbacks that occurred on or after this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statement_idstring- Filter cashbacks included in the specified statement. Get the ID from ramp_statement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
sync_readyboolean- Filter cashbacks that are ready to be synced (no pending syncs and completed). Example: true.
sync_statusstring- Filter by sync status. Supersedes sync_ready if provided. Example: NOT_SYNC_READY.one of
NOT_SYNC_READYSYNCEDSYNC_READY to_datestring- Filter cashbacks that occurred on or before this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
ramp_comment_listList the comments in the discussion thread of a Ramp bill, draft bill, spend request or transaction.Read-onlyList Comments
List the comments in the discussion thread of a Ramp bill, draft bill, spend request or transaction. Returns a page of comments with ID, author user ID, message and creation time, plus page.next. Use this to read a discussion thread. Use ramp_comment_create to post a comment. Needs the read scope of the object's resource, such as bills:read or transactions:read.
Inputs
object_idstringrequired- ID (UUID) of the bill, draft bill, spend request or transaction whose discussion thread to use. Get it from the matching list tool, such as ramp_bill_list or ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
object_typestringrequired- Type of object whose discussion thread to use: bills, draft-bills, spend-requests or transactions. Example: bills.one of
billsdraft-billsspend-requeststransactions page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_department_getGet one Ramp department by ID.Read-onlyGet Department
Get one Ramp department by ID. Returns the department's ID and name. Use this when you have a department ID. Use ramp_department_list to find departments.
Inputs
department_idstringrequired- ID of the department (UUID). Get it from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_department_listList departments in the Ramp business.Read-onlyList Departments
List departments in the Ramp business. Returns a page of departments with ID and name, plus page.next. Use this to find a department ID for users or filters. Use ramp_department_get for one department.
Inputs
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_entity_getGet one Ramp business entity by ID.Read-onlyGet Business Entity
Get one Ramp business entity by ID. Returns the entity's name, currency, primary flag, location IDs, accounts, payment accounts, connected subsidiary and default bill pay account. Use this when you have an entity ID. Use ramp_entity_list to find entities.
Inputs
entity_idstringrequired- ID of the business entity (UUID). Get it from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
hide_inactiveboolean- Hide inactive entities. Defaults to False. Example: true.
include_custom_field_valuesboolean- Include custom record field values in the response. Defaults to False. Example: true.
ramp_entity_listList the business entities (legal entities) in Ramp, filtered by name, currency, primary flag or active state.Read-onlyList Business Entities
List the business entities (legal entities) in Ramp, filtered by name, currency, primary flag or active state. Returns a page of entities with ID, name, currency, primary flag, location IDs, accounts and payment accounts, plus page.next. Use this to find an entity ID for bills, purchase orders and filters. Use ramp_entity_get for one entity.
Inputs
currencystring- Filter by currency of the entity. Example: USD.one of
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEUREURCFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMROPEN_USDPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSDBUSDCUSDGUSDSUIUSDTUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWGZWL entity_namestring- Filter entities by name. Example: Acme Inc. US.
hide_inactiveboolean- Hide inactive entities. Defaults to False. Example: true.
include_custom_field_valuesboolean- Include custom record field values in the response. Defaults to False. Example: true.
is_primaryboolean- Filter to include only primary or non-primary entities. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_fund_getGet one Ramp fund (spend limit) by ID.Read-onlyGet Fund
Get one Ramp fund (spend limit) by ID. Returns the fund's display name, balance, members, linked cards, spend program, permitted spend types, spending restrictions, suspension and state. Use this when you have a fund ID. Use ramp_fund_list to find funds.
Inputs
fund_idstringrequired- ID of the fund (UUID). Get it from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_fund_listList Ramp funds (spend limits), filtered by name, owner, member role, card, spend program, entity, creation date or termination.Read-onlyList Funds
List Ramp funds (spend limits), filtered by name, owner, member role, card, spend program, entity, creation date or termination. Returns a page of funds with ID, display name, balance, members, linked cards, spend program, permitted spend types, spending restrictions and state, plus page.next. Use this to find a fund. Use ramp_fund_get for one fund.
Inputs
card_idstring- Filter for funds linked to the card. Get the ID from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
created_afterstring- Filter for funds created after the specified date. Input needs to be in ISO8601 format, e.g. 2026-01-15T00:00:00Z. Example: 2026-01-15T00:00:00Z.
created_beforestring- Filter for funds created before the specified date. Input needs to be in ISO8601 format, e.g. 2026-01-15T00:00:00Z. Example: 2026-01-15T00:00:00Z.
display_namestring- Filter by display name. Example: Marketing Team Card.
entity_idstring- Filter for funds by associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
is_terminatedboolean- Filter only for terminated funds. Example: true.
member_rolesstring- Only return funds where the user_id has one of these member roles: OWNER, COOWNER or MEMBER. Pass several values as a comma-separated list. Example: OWNER,COOWNER.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
spend_program_idstring- Filter for funds associated with the specified spend program. Get the ID from ramp_spend_program_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
user_idstring- Filter for funds owned by the user. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_gl_account_listList the general ledger accounts synced into Ramp from the connected accounting system, filtered by code, remote ID, active or sync state.Read-onlyList GL Accounts
List the general ledger accounts synced into Ramp from the connected accounting system, filtered by code, remote ID, active or sync state. Returns a page of GL accounts with Ramp ID, remote ID, code, name, classification and active flag, plus page.next. Use this to find GL account IDs for coding. Use ramp_accounting_field_list for other accounting fields.
Inputs
accounting_connection_idstring- If this object belongs to an inactive accounting connection, you must specify that accounting connection's ID. Get the ID from ramp_accounting_connection_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
codestring- Filter by code. Example: 6000.
is_activeboolean- Filter by active status. If not provided, returns all objects. If true, returns only active objects. If false, returns only inactive objects. Example: true.
is_syncedboolean- Set to true to return only accounts synced from the accounting system, or false for only those that are not. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
remote_idstring- Filter by Remote/external ID. Example: 1001.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_item_receipt_getGet one item receipt by ID.Read-onlyGet Item Receipt
Get one item receipt by ID. Returns the item receipt's number, purchase order, received date, line items, documents and memo. Use this when you have an item receipt ID. Use ramp_item_receipt_list to find item receipts.
Inputs
item_receipt_idstringrequired- ID of the item receipt (UUID). Get it from ramp_item_receipt_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_item_receipt_listList item receipts (goods-received records for purchase orders), filtered by entity, purchase order, purchase order line item or archived state.Read-onlyList Item Receipts
List item receipts (goods-received records for purchase orders), filtered by entity, purchase order, purchase order line item or archived state. Returns a page of item receipts with ID, number, purchase order, received date, line items and memo, plus page.next. Use this to check what has been received against a PO. Use ramp_item_receipt_get for one receipt.
Inputs
entity_idstring- Unique identifier for the associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
include_archivedboolean- Whether to include archived item receipts. By default, include_archived is false. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
purchase_order_idstring- Unique identifier for the associated purchase order. Get the ID from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
purchase_order_line_item_idstring- Unique identifier for the associated purchase order line item. Get the ID from ramp_purchase_order_get. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_location_getGet one Ramp location by ID.Read-onlyGet Location
Get one Ramp location by ID. Returns the location's ID, name and entity ID. Use this when you have a location ID. Use ramp_location_list to find locations.
Inputs
location_idstringrequired- ID of the location (UUID). Get it from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_location_listList locations in the Ramp business, optionally filtered by business entity.Read-onlyList Locations
List locations in the Ramp business, optionally filtered by business entity. Returns a page of locations with ID, name and entity ID, plus page.next. Use this to find a location ID for users or filters. Use ramp_location_get for one location.
Inputs
entity_idstring- Filter by associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_memo_getGet the memo on one Ramp transaction.Read-onlyGet Transaction Memo
Get the memo on one Ramp transaction. Returns the transaction ID and its memo text. Use this to read a single transaction's memo. Use ramp_memo_list to browse memos.
Inputs
transaction_idstringrequired- ID of the Ramp card transaction (UUID). Get it from ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_memo_listList transaction memos, filtered by user, card, department, location, manager, merchant or transaction date.Read-onlyList Memos
List transaction memos, filtered by user, card, department, location, manager, merchant or transaction date. Returns a page of memos with the transaction ID and memo text, plus page.next. Use this to review memos across transactions. Use ramp_memo_get for one transaction's memo and ramp_memo_create to add one.
Inputs
card_idstring- Filter memos by card. Get the ID from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
department_idstring- Filter memos by department. Get the ID from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_datestring- Filter memos for transactions after this date. Example: 2026-01-15T00:00:00Z.
location_idstring- Filter memos by location. Get the ID from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
manager_idstring- Filter memos by manager. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
merchant_idstring- Filter memos by merchant. Get the ID from ramp_merchant_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_datestring- Filter memos for transactions before this date. Example: 2026-01-15T00:00:00Z.
user_idstring- Filter memos by user. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_merchant_listList merchants the Ramp business has transacted with, filtered by name prefix, URL or transaction date.Read-onlyList Merchants
List merchants the Ramp business has transacted with, filtered by name prefix, URL or transaction date. Returns a page of merchants with ID, name and category, plus page.next. Use this to find a merchant ID for transaction filters. Use ramp_vendor_list for vendors.
Inputs
merchant_namestring- Only return merchants whose display name starts with this text (case-sensitive). Example: Amazon.
merchant_urlstring- Filter merchants by URL or domain after normalization. Example: aws.amazon.com.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
transaction_from_datestring- Filter merchants by transactions occurring (`user_transaction_time`) on or after this date. Example: 2026-01-15T00:00:00Z.
transaction_to_datestring- Filter merchants by transactions occurring (`user_transaction_time`) on or before this date. Example: 2026-01-15T00:00:00Z.
ramp_purchase_order_getGet one Ramp purchase order by ID.Read-onlyGet Purchase Order
Get one Ramp purchase order by ID. Returns the purchase order's number, name, vendor, owner, amount, line items, accounting coding, linked bills, item receipts and transactions, dates and statuses. Use this when you have a purchase order ID, for example to get line item IDs. Use ramp_purchase_order_list to find purchase orders.
Inputs
purchase_order_idstringrequired- ID of the purchase order (UUID). Get it from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_purchase_order_listList Ramp purchase orders, filtered by creation source, receipt status, entity, spend request, external or remote ID, creation date, three-way match or archived state.Read-onlyList Purchase Orders
List Ramp purchase orders, filtered by creation source, receipt status, entity, spend request, external or remote ID, creation date, three-way match or archived state. Returns a page of purchase orders with ID, number, name, vendor, amount, line items, billing and receipt status, plus page.next. Use this to find purchase orders. Use ramp_purchase_order_get for one purchase order.
Inputs
creation_sourcestring- Creation source of the purchase order. Example: ACCOUNTING_PROVIDER.one of
ACCOUNTING_PROVIDERDEVELOPER_APIEXTERNAL_IMPORTRAMP entity_idstring- Unique identifier for the associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
external_idstring- Filter purchase orders by exact external ID. Example: PO-EXT-1001.
from_created_atstring- Filter for purchase orders that were requested after the given date. Example: 2026-01-15T00:00:00Z.
include_archivedboolean- Whether to include archived purchase orders. By default, include_archived is false. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
receipt_statusstring- Receipt status of the purchase order. Example: FULLY_RECEIVED.one of
FULLY_RECEIVEDNOT_RECEIVEDOVER_RECEIVEDPARTIALLY_RECEIVED remote_idstring- Filter purchase orders by exact remote ID from the connected accounting provider. Example: 1001.
spend_request_idstring- Unique identifier for the spend request associated with the purchase order. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
three_way_match_enabledboolean- Set to true to return only purchase orders with three-way match enabled. Example: true.
to_created_atstring- Filter for purchase orders that were requested before the given date. Example: 2026-01-15T00:00:00Z.
ramp_receipt_getGet one Ramp receipt by ID.Read-onlyGet Receipt
Get one Ramp receipt by ID. Returns the receipt URL, linked transaction or reimbursement, user, creation time and, if requested, OCR data such as currency and line items. Use this when you have a receipt ID. Use ramp_receipt_list to find receipts.
Inputs
receipt_idstringrequired- ID of the receipt (UUID). Get it from ramp_receipt_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
include_ocr_databoolean- Include structured data extracted from receipt OCR, including currency code and line items. Example: true.
ramp_receipt_listList receipts uploaded to Ramp, filtered by transaction, reimbursement, or creation or transaction date.Read-onlyList Receipts
List receipts uploaded to Ramp, filtered by transaction, reimbursement, or creation or transaction date. Returns a page of receipts with ID, receipt URL, linked transaction or reimbursement, user and creation time (plus OCR data if requested), and page.next. Use this to find receipts. Use ramp_receipt_get for one receipt.
Inputs
created_afterstring- Filter receipts created after this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
created_beforestring- Filter receipts created before this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
from_datestring- Filter receipts for transactions with a `user_transaction_time` after this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
include_ocr_databoolean- Include structured data extracted from receipt OCR, including currency code and line items. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
reimbursement_idstring- Filter receipts for a specific reimbursement. Get the ID from ramp_reimbursement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_datestring- Filter receipts for transactions with a `user_transaction_time` before this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
transaction_idstring- Filter receipts for a specific transaction. Get the ID from ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_reimbursement_getGet one Ramp reimbursement by ID.Read-onlyGet Reimbursement
Get one Ramp reimbursement by ID. Returns the reimbursement's user, amounts, merchant, type, state, memo, receipts, line items, mileage details, accounting coding, and payment and sync status. Use this when you have a reimbursement ID. Use ramp_reimbursement_list to find reimbursements.
Inputs
reimbursement_idstringrequired- ID of the reimbursement (UUID). Get it from ramp_reimbursement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_reimbursement_listList Ramp reimbursements, filtered by user, state, direction, approval, sync status, trip, entity, and transaction, created, submitted, synced or updated dates.Read-onlyList Reimbursements
List Ramp reimbursements, filtered by user, state, direction, approval, sync status, trip, entity, and transaction, created, submitted, synced or updated dates. Returns a page of reimbursements with ID, user, amount, merchant, type (out-of-pocket or mileage), state, memo, receipts and accounting coding, plus page.next. Use this to review employee reimbursements. Use ramp_reimbursement_get for one reimbursement. Set direction to USER_TO_BUSINESS for repayments.
Inputs
accounting_field_selection_idstring- Filter reimbursements by accounting field selection. This ID uniquely identifies an accounting field selection on Ramp. Get the ID from ramp_accounting_field_option_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
awaiting_approval_by_user_idstring- Filter for reimbursements awaiting approval by a specific user. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
directionstring- Filter by direction (BUSINESS_TO_USER default, USER_TO_BUSINESS for repayments). Example: BUSINESS_TO_USER.one of
BUSINESS_TO_USERUSER_TO_BUSINESS entity_idstring- Filter reimbursements by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_datestring- Filter reimbursements created after this date. Example: 2026-01-15T00:00:00Z.
from_submitted_atstring- Filter reimbursements submitted after this date. Example: 2026-01-15T00:00:00Z.
from_transaction_datestring- Filter by underlying transaction date (after this date). Example: 2026-01-15T00:00:00Z.
has_been_approvedboolean- Filter for reimbursements that are approved or not approved. If not specified, returns all reimbursements. Example: true.
has_no_sync_commitsboolean- Filter reimbursements that haven't been synced to ERP systems. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statestring- Filter by reimbursement state. Example: APPROVED.one of
APPROVEDAWAITING_EXPORTAWAITING_PAYMENTAWAITING_PUSH_PAYMENTCANCELEDDELETEDDRAFTEXPORTEDEXPORT_FAILEDEXPORT_INITIATEDEXPORT_MARKED_AS_FAILEDEXPORT_SUCCESSFULFAILED_REIMBURSEMENTINITMANUALLY_REIMBURSEDMISSING_ACHPENDINGPROCESSINGPUSH_PAYMENT_FAILEDPUSH_PAYMENT_INITIATEDREIMBURSEDREIMBURSED_VIA_PUSHREJECTED sync_readyboolean- Filter reimbursements that are ready to sync to ERP systems. Example: true.
sync_statusstring- Filter by sync status. Supersedes has_no_sync_commits and sync_ready. Example: NOT_SYNC_READY.one of
NOT_SYNC_READYSYNCEDSYNC_READY synced_afterstring- Filter reimbursements synced after this date. Example: 2026-01-15T00:00:00Z.
to_datestring- Filter reimbursements created before this date. Example: 2026-01-15T00:00:00Z.
to_submitted_atstring- Filter reimbursements submitted before this date. Example: 2026-01-15T00:00:00Z.
to_transaction_datestring- Filter by underlying transaction date (before this date). Example: 2026-01-15T00:00:00Z.
trip_idstring- Filter reimbursements associated with a specific trip. Get the ID from ramp_trip_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
updated_afterstring- Filter reimbursements updated after this date. Example: 2026-01-15T00:00:00Z.
user_idstring- Only return reimbursements for this user (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_repayment_listList repayments (money users paid back to the business), filtered by user, entity, funding method, original transaction, repaid date or sync status.Read-onlyList Repayments
List repayments (money users paid back to the business), filtered by user, entity, funding method, original transaction, repaid date or sync status. Returns a page of repayments sorted newest first, with ID, amount, user, funding method and status, plus page.next. Use this to review employee repayments. Use ramp_reimbursement_list for money paid to users.
Inputs
entity_idstring- Filter for repayments by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_repaid_atstring- Filter for repayments that were repaid after and including the given date. Note: Using this filter will only return repayments that have been completed. Example: 2026-01-15T00:00:00Z.
funding_methodsstring- Filter for repayments by funding method. Multiple values can be provided as a comma-separated list (e.g., 'ach,debit_card'). Example: ach,debit_card.
original_transaction_idstring- Filter for repayments by the UUID of their original transaction. Get the ID from ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
sync_statusstring- Filter repayments by the status of their latest repayment accounting sync. Repayments with no repayment sync are excluded when this filter is provided. Example: IN_PROGRESS.one of
IN_PROGRESSMARKED_CANCELEDNOT_STARTEDSYNC_FAILURESYNC_SUCCESS to_repaid_atstring- Filter for repayments that were repaid before the given date. Note: Using this filter will only return repayments that have been completed. Example: 2026-01-15T00:00:00Z.
user_idstring- UUID of the user to filter repayments by. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_role_listList the custom user roles defined in the Ramp business.Read-onlyList Custom Roles
List the custom user roles defined in the Ramp business. Returns the custom roles with their IDs and names. Use this to see which custom roles exist. Use ramp_user_list to see users' roles.
Inputs
This tool takes no inputs.
ramp_spend_program_getGet one Ramp spend program by ID.Read-onlyGet Spend Program
Get one Ramp spend program by ID. Returns the program's display name, description, icon, sharing and card-issuing settings, permitted spend types, restrictions and line item fields. Use this when you have a spend program ID. Use ramp_spend_program_list to find programs.
Inputs
spend_program_idstringrequired- ID of the spend program (UUID). Get it from ramp_spend_program_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_spend_program_listList Ramp spend programs (templates for funds).Read-onlyList Spend Programs
List Ramp spend programs (templates for funds). Returns a page of spend programs with ID, display name, description, icon, permitted spend types and restrictions, plus page.next. Use this to find a program ID before creating a fund with ramp_fund_create. Use ramp_spend_program_get for one program.
Inputs
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_statement_getGet one Ramp statement by ID.Read-onlyGet Statement
Get one Ramp statement by ID. Returns the statement's dates, opening and ending balances, charges, credits, payments, balance sections, statement lines and statement URL. Use this when you have a statement ID. Use ramp_statement_list to find statements.
Inputs
statement_idstringrequired- ID of the statement (UUID). Get it from ramp_statement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_statement_listList Ramp statements, optionally limited to statements ending in a date range.Read-onlyList Statements
List Ramp statements, optionally limited to statements ending in a date range. Returns a page of statements with ID, start and end dates, opening and ending balances, charges, credits, payments and a statement URL, plus page.next. Use this to find billing statements. Use ramp_statement_get for one statement.
Inputs
from_datestring- Only return statements whose end date is on or after this time (ISO 8601). Leave empty to start from the earliest statement. Example: 2026-01-15T00:00:00Z.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_datestring- Filter statements with end_date on or before this date (ISO8601 format). Defaults to current time. Example: 2026-01-15T00:00:00Z.
ramp_tax_rate_listList the tax rates synced into Ramp from the connected accounting system.Read-onlyList Tax Rates
List the tax rates synced into Ramp from the connected accounting system. Returns a page of tax rates with ID, name, rate and remote ID, plus page.next. Use this to find tax rates for coding bills and transactions.
Inputs
accounting_connection_idstring- If this tax rate belongs to an inactive accounting connection, you must specify that accounting connection's ID. Get the ID from ramp_accounting_connection_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_transaction_getGet one Ramp card transaction by ID.Read-onlyGet Transaction
Get one Ramp card transaction by ID. Returns the transaction's amount, currency, merchant details, card holder, card ID, state, memo, receipts, line items, policy violations, disputes and accounting coding. Use this when you have a transaction ID. Use ramp_transaction_list to find transactions.
Inputs
transaction_idstringrequired- ID of the Ramp card transaction (UUID). Get it from ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
include_merchant_databoolean- Include all purchase data provided by the merchant. Example: true.
ramp_transaction_listList Ramp card transactions, filtered by date, amount, user, card, merchant, department, approval or sync status, and more.Read-onlyList Transactions
List Ramp card transactions, filtered by date, amount, user, card, merchant, department, approval or sync status, and more. Returns a page of transactions with ID, amount, currency, merchant, card holder, card ID, state, memo, receipts and accounting coding, plus page.next for the next page. Use this to search or review card spend. Use ramp_transaction_get for one transaction. Declined transactions are excluded unless state is DECLINED or ALL. Set at most one of the order_by_* options.
Inputs
accounting_field_selection_idstring- Filter transactions by accounting field selection. This ID uniquely identifies an accounting field selection on Ramp. Get the ID from ramp_accounting_field_option_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
all_requirements_met_and_approvedboolean- Filter for transactions that are fully approved and all cardholder requirements met such as receipts, memos, tracking categories. If not specified, returns all transactions. Example: true.
approval_statusstring- Filter by transaction approval status. Example: AWAITING_EMPLOYEE.one of
AWAITING_EMPLOYEEAWAITING_EMPLOYEE_CHANGES_REQUESTEDAWAITING_EMPLOYEE_MISSING_ITEMSAWAITING_EMPLOYEE_REPAYMENT_FAILEDAWAITING_EMPLOYEE_REPAYMENT_REQUESTEDAWAITING_REVIEWERFULLY_APPROVED awaiting_approval_by_user_idstring- Filter for transactions awaiting approval by a specific user. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
card_idstring- Filter by physical card. Get the ID from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
department_idstring- Filter by department. Get the ID from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
entity_idstring- Filter transactions by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_datestring- Filter for transactions with a `user_transaction_time` after the given date, in ISO8601 format. Example: 2026-01-15T00:00:00Z.
has_been_approvedboolean- Filter for transactions that are approved or not approved. If not specified, returns all transactions. Example: true.
has_no_sync_commitsboolean- Filter for transactions that have not been synced to ERP systems yet. Example: true.
has_statementboolean- Filter for transactions that have a statement or do not have a statement. If not specified, returns all transactions. Example: true.
include_merchant_databoolean- Include all purchase data provided by the merchant. Example: true.
limit_idstring- Filter by limit. Get the ID from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
location_idstring- Filter by location. Get the ID from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
max_amountnumber- Filter for transactions that have smaller amount that the given amount. This is a U.S. Dollar denominated amount. Example: 5000.
merchant_idstring- Filter by merchant. Get the ID from ramp_merchant_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
min_amountnumber- Filter for transactions that have larger amount that the given amount. This is a U.S. Dollar denominated amount. Example: 100.
order_by_amount_ascboolean- Sort transactions by amount in ascending order. Example: true.
order_by_amount_descboolean- Sort transactions by amount in descending order. Example: true.
order_by_date_ascboolean- Sort transactions by `user_transaction_date` in ascending order, in ISO8601 format. Example: true.
order_by_date_descboolean- Sort transactions by `user_transaction_date` in descending order, in ISO8601 format. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
requires_memoboolean- Filters for transactions which require a memo, but do not have one. This can only be set to true. Example: true.
sk_category_idinteger- Only return transactions in this Ramp category code (an integer, for example 11). Example: 11.one of
11011121314151617181922021232425262728293303132333435363738394404142434456789 spend_program_idstring- Filter by spend program. Get the ID from ramp_spend_program_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statestring- Filter by transaction state. If set to 'ALL', all transactions including 'DECLINED' will be listed. Example: ALL.one of
ALLCLEAREDCOMPLETIONDECLINEDERRORPENDINGPENDING_INITIATION statement_idstring- Filter by statement. Get the ID from ramp_statement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
sync_statusstring- Filter for transactions by sync status. If set, it supersedes sync_ready and has_no_sync_commits. Example: NOT_SYNC_READY.one of
NOT_SYNC_READYSYNCEDSYNC_READY synced_afterstring- Filter for transactions that have been synced after the given date, in ISO8601 format. Example: 2026-01-15T00:00:00Z.
to_datestring- Filter for transactions with a `user_transaction_time` before the given date, in ISO8601 format. Example: 2026-01-15T00:00:00Z.
trip_idstring- Filter for trip ID. Get the ID from ramp_trip_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
user_idstring- Filter by user. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_transfer_getGet one Ramp transfer payment by ID.Read-onlyGet Transfer Payment
Get one Ramp transfer payment by ID. Returns the transfer's amount, bank account, status, entity, payment ID, sync status and creation time. Use this when you have a transfer ID. Use ramp_transfer_list to find transfers.
Inputs
transfer_idstringrequired- ID of the transfer payment (UUID). Get it from ramp_transfer_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_transfer_listList Ramp transfer payments (payments of the Ramp balance from a bank account), filtered by status, sync status, entity, statement or date.Read-onlyList Transfer Payments
List Ramp transfer payments (payments of the Ramp balance from a bank account), filtered by status, sync status, entity, statement or date. Returns a page of transfers with ID, amount, bank account, status, entity and creation time, plus page.next. Use this to review payments made to Ramp. Use ramp_transfer_get for one transfer.
Inputs
entity_idstring- Filter transfers by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_datestring- Filter transfers that occurred after this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
has_no_sync_commitsboolean- Filter transfers that have not been synced. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statement_idstring- Filter transfers included in the specified statement. Get the ID from ramp_statement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statusstring- Filter by transfer status. See Transfers Guide for definitions. Example: ACH_CONFIRMED.one of
ACH_CONFIRMEDCANCELEDCOMPLETEDERRORINITIATEDNOT_ACKEDNOT_ENOUGH_FUNDSPROCESSING_BY_ODFIREJECTED_BY_ODFIRETURNED_BY_RDFISUBMITTED_TO_FEDSUBMITTED_TO_RDFIUNNECESSARYUPLOADED sync_statusstring- Filter by sync status. Supersedes has_no_sync_commits if both are provided. Example: NOT_SYNC_READY.one of
NOT_SYNC_READYSYNCEDSYNC_READY to_datestring- Filter transfers that occurred before this date (ISO8601 format). Example: 2026-01-15T00:00:00Z.
ramp_trip_getGet one Ramp travel trip by ID.Read-onlyGet Trip
Get one Ramp travel trip by ID. Returns the trip's name, description, traveller, dates, length, status, locations, travel types, spend events and total spend. Use this when you have a trip ID. Use ramp_trip_list to find trips.
Inputs
trip_idstringrequired- ID of the trip (UUID). Get it from ramp_trip_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_trip_listList business travel trips in Ramp, filtered by traveller, status, dates, amount or name.Read-onlyList Trips
List business travel trips in Ramp, filtered by traveller, status, dates, amount or name. Returns a page of trips with ID, name, traveller, start and end dates, status, locations and total spend, plus page.next. Use this to review travel. Use ramp_trip_get for one trip and ramp_transaction_list with trip_id for its spend.
Inputs
from_datestring- Show only trips starting on or after this date. If a trip starts before this date but a to_date is provided, the trip will be included if there is an overlap. Example: 2026-01-15T00:00:00Z.
max_amountnumber- Show only trips with an amount less than or equal to this value. Example: 5000.
min_amountnumber- Show only trips with an amount greater than or equal to this value. Example: 100.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statusstring- Filter trips by status. Example: upcoming.one of
cancelledcompletedongoingupcoming to_datestring- Show only trips starting on or before this date. If a trip starts after this date but a from_date is provided, the trip will be included if there is an overlap. Example: 2026-01-15T00:00:00Z.
trip_namestring- Show only trips with this name. Example: NYC sales offsite.
user_idsstring- Filter trips by specific user IDs. Pass several values as a comma-separated list. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_user_getGet one Ramp user by ID.Read-onlyGet User
Get one Ramp user by ID. Returns the user's name, email, phone, role, status, department, location, entity, manager, employee ID, custom fields and any scheduled invitation or deactivation date. Use this when you have a user ID. Use ramp_user_list to find users.
Inputs
user_idstringrequired- ID of the Ramp user (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_user_invite_status_getGet the status of an asynchronous user invite task.Read-onlyGet User Invite Status
Get the status of an asynchronous user invite task. Returns the task ID, status, and the created user's ID in data once the task succeeds (or error context if it failed). Use this after ramp_user_invite_create to learn whether the invite finished and get the new user ID. Requires the task ID returned by ramp_user_invite_create.
Inputs
task_idstringrequired- ID of the deferred invite task (UUID), returned as id by ramp_user_invite_create. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_user_listList users in the Ramp business, optionally filtered by email, role, status, department, location, entity or employee ID.Read-onlyList Users
List users in the Ramp business, optionally filtered by email, role, status, department, location, entity or employee ID. Returns a page of users with ID, name, email, role, status, department, location, manager and entity, plus page.next. Use this to find a user's ID. Use ramp_user_get for one user. Suspended users are left out unless status is set.
Inputs
department_idstring- Filter by department. Get the ID from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
emailstring- Filter by email. Example: jane.doe@example.com.
employee_idstring- Filter by user employee_id. Example: EMP-1042.
entity_idstring- Filter by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
location_idstring- Filter by location. Get the ID from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
rolestring- Filter by user role. Example: BUSINESS_USER.one of
AUDITORBUSINESS_ADMINBUSINESS_BOOKKEEPERBUSINESS_OWNERBUSINESS_USERGUEST_USERIT_ADMIN startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statusstring- Filter only for users with the given status. Defaults to returning all active and inactive users, but not suspended users. Example: USER_ACTIVE.one of
USER_ACTIVEUSER_DRAFTUSER_INACTIVEUSER_SUSPENDED
ramp_vendor_agreement_getGet one vendor agreement (contract) by ID.Read-onlyGet Vendor Agreement
Get one vendor agreement (contract) by ID. Returns the agreement's name, vendor, owners, dates, last date to terminate, total value, line items, renewal status and action, notification settings and linked purchase orders. Use this when you have an agreement ID. Use ramp_vendor_agreement_list to find agreements.
Inputs
agreement_idstringrequired- ID of the vendor agreement (UUID). Get it from ramp_vendor_agreement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_bank_account_getGet one bank account of a Ramp vendor.Read-onlyGet Vendor Bank Account
Get one bank account of a Ramp vendor. Returns the account nickname, last four digits, currency, payment method and default flag. Use this when you have a vendor bank account ID. Use ramp_vendor_bank_account_list to find accounts.
Inputs
bank_account_idstringrequired- ID of the vendor bank account (UUID). Get it from ramp_vendor_bank_account_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_bank_account_listList the bank accounts on file for a Ramp vendor.Read-onlyList Vendor Bank Accounts
List the bank accounts on file for a Ramp vendor. Returns a page of accounts with ID, nickname, last four digits, currency, payment method and default flag, plus page.next. Use this to find a vendor's payment account, for example to set default_bank_account_id with ramp_vendor_update.
Inputs
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_contact_getGet one contact of a Ramp vendor.Read-onlyGet Vendor Contact
Get one contact of a Ramp vendor. Returns the contact's name, email, phone and default flag. Use this when you have a contact ID. Use ramp_vendor_contact_list to find contacts.
Inputs
vendor_contact_idstringrequired- ID of the vendor contact (UUID). Get it from ramp_vendor_contact_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_contact_listList the contacts of a Ramp vendor.Read-onlyList Vendor Contacts
List the contacts of a Ramp vendor. Returns a page of contacts with ID, name, email, phone and default flag, plus page.next. Use this to find a vendor_contact_id for bills. Use ramp_vendor_contact_create to add a contact.
Inputs
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_credit_getGet one vendor credit by ID, including archived credits.Read-onlyGet Vendor Credit
Get one vendor credit by ID, including archived credits. Returns the credit's vendor, total, applied and remaining amounts, applied bills, line items, accounting coding and dates. Use this when you have a vendor credit ID. Use ramp_vendor_credit_list to find credits.
Inputs
vendor_credit_idstringrequired- ID of the vendor credit (UUID). Get it from ramp_vendor_credit_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_credit_listList vendor credits across all of the business's vendors, filtered by entity, created or accounting date, usage or archived state.Read-onlyList Vendor Credits
List vendor credits across all of the business's vendors, filtered by entity, created or accounting date, usage or archived state. Returns a page of credits with ID, vendor, total, applied and remaining amounts, reference number and dates, plus page.next. Use this to find credits that can offset bills. Use ramp_vendor_credit_get for one credit. Active, not fully used credits are returned by default.
Inputs
entity_idstring- Filter by vendor credits associated with the provided business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
from_accounting_datestring- Filter by vendor credits with an accounting date on or after the provided date. Example: 2026-01-15.
from_created_atstring- Filter by vendor credits with a created_at on or after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
include_fully_usedboolean- Include vendor credits that are marked as fully used. Defaults to false. Example: true.
is_archivedboolean- Show archived vendor credits instead of active vendor credits. Defaults to false. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_accounting_datestring- Filter by vendor credits with an accounting date up to or on the provided date. Example: 2026-01-15.
to_created_atstring- Filter by vendor credits with a created_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
ramp_vendor_getGet one Ramp vendor by ID.Read-onlyGet Vendor
Get one Ramp vendor by ID. Returns the vendor's name, legal name, addresses, contacts, owner, default entity and payment method, payment terms, tax details, category, approval status and spend totals. Use this when you have a vendor ID. Use ramp_vendor_list to find vendors.
Inputs
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_listList Ramp vendors, filtered by name, owner, active state, merchant, external ID, accounting IDs, Ramp category codes, or created and updated dates.Read-onlyList Vendors
List Ramp vendors, filtered by name, owner, active state, merchant, external ID, accounting IDs, Ramp category codes, or created and updated dates. Returns a page of vendors with ID, name, country, owner, contacts, default payment method, category and spend totals, plus page.next. Use this to find a vendor before creating a bill or agreement. Use ramp_vendor_get for one vendor and ramp_accounting_vendor_list for ERP vendors.
Inputs
accounting_vendor_remote_idsstring- Show only vendors whose accounting field remote id matches the passed list. Expects a comma-separated list of strings. Example: 1001,1002.
external_vendor_idstring- Filter by customer-defined external vendor ID. This is independent of accounting system remote IDs. Example: VEND-0091.
from_created_atstring- Show only vendors with created_at after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
from_updated_atstring- Show only vendors with updated_at after this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
include_draftboolean- When true, include vendors that have not yet been fully approved and published: both plain drafts and vendors that were created via POST /developer/v1/vendors but are still waiting on creation approval. Useful for deduplicating by external_vendor_id immediately after creating a vendor. Defaults to false, which matches the historical behavior of this endpoint. Example: true.
include_subsidiaryboolean- When true, include the ERP subsidiary identifiers associated with each vendor, if available. Example: true.
is_activeboolean- Set to true to return only active vendors, or false for only inactive vendors. Example: true.
merchant_idstring- Filter by the unique identifier of a card merchant associated with the vendor. Get the ID from ramp_merchant_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
namestring- Only return vendors with this name. Example: Acme Supplies.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
sk_category_idsstring- Show only vendors whose sk_category_id matches a Ramp category code in the passed list. Expects a comma-separated list of integers. Example: 11,24.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
to_created_atstring- Show only vendors with created_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
to_updated_atstring- Show only vendors with updated_at on or before this date. This parameter should be provided as a datetime string that conforms to ISO 8601. Example: 2026-01-15T00:00:00Z.
vendor_owner_idstring- Unique identifier of the user which owns this vendor. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_tracking_category_option_idsstring- Show only vendors whose accounting field selection id matches the passed list. Expects a comma-separated list of UUIDs. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6,9b2f1c7e-4d3a-4e8b-a1f2-6c5d4e3b2a10.
ramp_virtual_card_getGet one virtual Ramp card by ID.Read-onlyGet Virtual Card
Get one virtual Ramp card by ID. Returns the card's ID, owner user ID, linked fund, creation time and suspension flag. Use this when you have a virtual card ID. Use ramp_virtual_card_list to find virtual cards.
Inputs
card_idstringrequired- ID of the virtual card (UUID). Get it from ramp_virtual_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_virtual_card_listList virtual Ramp cards, optionally filtered by owner, business entity or termination.Read-onlyList Virtual Cards
List virtual Ramp cards, optionally filtered by owner, business entity or termination. Returns a page of virtual cards with ID, owner user ID, linked fund, creation time and suspension flag, plus page.next. Use this to find virtual cards. Use ramp_card_list for physical cards and ramp_virtual_card_get for one card.
Inputs
entity_idstring- Filter by business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
is_terminatedboolean- Filter only for terminated cards. Defaults to False if not specified. Example: true.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
user_idstring- Filter by card owner. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_createCreate a Ramp bill for a vendor invoice, with line items, accounting coding and payment method.WriteCreate Bill
Create a Ramp bill for a vendor invoice, with line items, accounting coding and payment method. Returns the new bill with its ID, amount, status and payment details. Use this to enter an invoice for payment. Use ramp_bill_draft_create to start a draft instead, and ramp_bill_update to change an approved bill. Get vendor_id from ramp_vendor_list and entity_id from ramp_entity_list. Set payment_method or use_default_payment_method, and vendor_contact_id or use_default_vendor_contact.
Inputs
due_atstringrequired- Due date of the bill. Example: 2026-02-14.
entity_idstringrequired- Associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
invoice_currencystringrequired- Currency of the invoice. Example: USD.one of
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEUREURCFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMROPEN_USDPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSDBUSDCUSDGUSDSUIUSDTUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWGZWL invoice_numberstringrequired- The invoice number on the bill. Example: INV-2026-0042.
issued_atstringrequired- Issued date of the bill. Example: 2026-01-15.
vendor_idstringrequired- Unique identifier of bill vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_field_selectionsarray- Accounting coding for the record, as a list of selections. Each selection names the ERP field by its external (remote) ID and either picks one of that field's options by its external ID or, for free-text and date fields, supplies text (dates as YYYY-MM-DD). Get field and option remote IDs from ramp_accounting_field_list and ramp_accounting_field_option_list. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
enable_accounting_syncboolean- A flag you can set to False to prevent this bill from syncing to your ERP. Note: enable_accounting_sync must be True when remote_id is provided. Example: true.
inventory_line_itemsarray- Inventory line items on the bill. Each line needs a quantity and a unit price (major currency units) and can carry a memo and accounting field selections; on updates a line can keep its existing id or be matched to a purchase order line item. Example: [{"quantity": 10, "unit_price": 12.50, "memo": "Printer paper"}].
line_itemsarray- Expense line items on the bill. Each line needs an amount in major currency units (for example 450.00) and can carry a memo and its own accounting field selections; on updates a line can keep its existing id or be matched to a purchase order line item. Example: [{"amount": 450.00, "memo": "Consulting hours"}].
memostring- Memo of the bill. Example: Q1 office supplies.
payment_datestring- For a non-card bill, the date the payment is scheduled to be initiated. If the requested date is unavailable, such as a weekend, bank holiday, past date, or same-day cutoff miss, Ramp schedules the payment for the next available initiation date. Example: 2026-01-15.
payment_methodstring- Payment method for the bill. Required unless use_default_payment_method is true. Example: ACH.one of
ACHCARDCHECKCRYPTO_WALLET_TRANSFERDOMESTIC_WIREINTERNATIONALLOCAL_BANK_TRANSFERONE_TIME_CARDONE_TIME_CARD_DELIVERYPAID_MANUALLYSWIFT posting_datestring- The date the bill is posted to the accounting system. Example: 2026-01-15.
purchase_order_idsarray- Unique identifiers of the purchase orders to match this bill to. Get the ID from ramp_purchase_order_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
remote_idstring- An ID that identifies the bill on the client's side. An accounting connection is required and enable_accounting_sync must be True when remote_id is provided. Omit remote_id for bills that will not be synced to an accounting provider. Example: 1001.
target_payment_arrival_datestring- For a bill created with use_default_payment_method=true, the target vendor arrival date. Ramp uses this date to compute the latest payment initiation date needed to target vendor arrival. If that initiation date is in the past or after today's cutoff, Ramp schedules the next valid initiation date. Example: 2026-01-15.
use_default_payment_methodboolean- When set to true, create the bill using the default payment method configured for the vendor. If set to true, payment_method and payment_details should not be provided. Example: true.
use_default_vendor_contactboolean- When set to true, create the bill using the default contact configured for the vendor. If set to true, vendor_contact_id should not be provided. Example: true.
vendor_contact_idstring- Unique identifier of vendor contact, must be associated with passed vendor. Required unless use_default_vendor_contact is true. Get the ID from ramp_vendor_contact_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_memostring- Memo to the vendor. Example: Payment for invoice INV-2026-0042.
ramp_bill_draft_createCreate a draft bill for a vendor, with any invoice details, line items and coding known so far.WriteCreate Draft Bill
Create a draft bill for a vendor, with any invoice details, line items and coding known so far. Returns the new draft bill with its ID. Use this to start a bill that will be completed later. Use ramp_bill_draft_submit to submit it, or ramp_bill_create to create a full bill directly. Get vendor_id from ramp_vendor_list.
Inputs
vendor_idstringrequired- Unique identifier of bill vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_field_selectionsarray- Accounting coding for the record, as a list of selections. Each selection names the ERP field by its external (remote) ID and either picks one of that field's options by its external ID or, for free-text and date fields, supplies text (dates as YYYY-MM-DD). Get field and option remote IDs from ramp_accounting_field_list and ramp_accounting_field_option_list. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
due_atstring- Due date of the bill. Example: 2026-01-15.
enable_accounting_syncboolean- A flag you can set to False to prevent this bill from syncing to your ERP. Example: true.
entity_idstring- Associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
inventory_line_itemsarray- Inventory line items on the bill. Each line needs a quantity and a unit price (major currency units) and can carry a memo and accounting field selections; on updates a line can keep its existing id or be matched to a purchase order line item. Example: [{"quantity": 10, "unit_price": 12.50, "memo": "Printer paper"}].
invoice_currencystring- Currency of the invoice. Example: USD.one of
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEUREURCFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMROPEN_USDPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSDBUSDCUSDGUSDSUIUSDTUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWGZWL invoice_numberstring- The invoice number on the bill. Example: INV-2026-0042.
issued_atstring- Issued date of the bill. Example: 2026-01-15.
line_itemsarray- Expense line items on the bill. Each line needs an amount in major currency units (for example 450.00) and can carry a memo and its own accounting field selections; on updates a line can keep its existing id or be matched to a purchase order line item. Example: [{"amount": 450.00, "memo": "Consulting hours"}].
memostring- Memo of the bill. Example: Q1 office supplies.
payment_methodstring- Payment method of the bill. Example: ACH.one of
ACHCARDCHECKCRYPTO_WALLET_TRANSFERDOMESTIC_WIREINTERNATIONALLOCAL_BANK_TRANSFERONE_TIME_CARDONE_TIME_CARD_DELIVERYPAID_MANUALLYSWIFT posting_datestring- The date the bill is posted to the accounting system. Example: 2026-01-15.
purchase_order_idsarray- Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. Get the ID from ramp_purchase_order_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
remote_idstring- An ID that identifies the bill on client's side. Example: 1001.
use_default_payment_methodboolean- Set to true to use the vendor's default payment method; then leave payment_method empty. Example: true.
vendor_contact_idstring- Unique identifier of vendor contact, must be associated with passed vendor. Get the ID from ramp_vendor_contact_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_memostring- Memo to the vendor. Example: Payment for invoice INV-2026-0042.
ramp_bill_draft_submitSubmit a Ramp draft bill so it becomes a bill and enters approval.WriteSubmit Draft Bill
Submit a Ramp draft bill so it becomes a bill and enters approval. Returns the resulting bill. Use this once a draft is complete. Use ramp_bill_draft_update first to fill in missing details.
Inputs
draft_bill_idstringrequired- ID of the draft bill (UUID). Get it from ramp_bill_draft_list or ramp_bill_draft_create. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_draft_updateUpdate a Ramp draft bill's vendor, invoice details, dates, line items, accounting coding, memos or payment method.WriteUpdate Draft Bill
Update a Ramp draft bill's vendor, invoice details, dates, line items, accounting coding, memos or payment method. Returns the updated draft bill. Use this to complete a draft before submitting it with ramp_bill_draft_submit. Line item lists replace all existing lines.
- Idempotent
Inputs
draft_bill_idstringrequired- ID of the draft bill (UUID). Get it from ramp_bill_draft_list or ramp_bill_draft_create. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_field_selectionsarray- Accounting coding for the record, as a list of selections. Each selection names the ERP field by its external (remote) ID and either picks one of that field's options by its external ID or, for free-text and date fields, supplies text (dates as YYYY-MM-DD). Get field and option remote IDs from ramp_accounting_field_list and ramp_accounting_field_option_list. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
due_atstring- Due date of the bill. Example: 2026-01-15.
enable_accounting_syncboolean- A flag you can set to False to prevent this bill from syncing to your ERP. Example: true.
entity_idstring- Associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
inventory_line_itemsarray- Replaces all inventory line items on the draft. Each line needs a quantity and unit price (major currency units) and can carry a memo, accounting field selections, the id of an existing line to keep, and a purchase order line item to match. Example: [{"quantity": 10, "unit_price": 12.50}].
invoice_currencystring- Currency of the invoice. Example: USD.one of
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEUREURCFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMROPEN_USDPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSDBUSDCUSDGUSDSUIUSDTUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWGZWL invoice_numberstring- The invoice number on the bill. Example: INV-2026-0042.
issued_atstring- Issued date of the bill. Example: 2026-01-15.
line_itemsarray- Replaces all expense line items on the draft. Each line needs an amount in major currency units and can carry a memo, accounting field selections, the id of an existing line to keep, and a purchase order line item to match. Example: [{"amount": 450.00, "memo": "Consulting hours"}].
memostring- Memo of the bill. Example: Q1 office supplies.
payment_methodstring- Payment method of the bill. Example: ACH.one of
ACHCARDCHECKCRYPTO_WALLET_TRANSFERDOMESTIC_WIREINTERNATIONALLOCAL_BANK_TRANSFERONE_TIME_CARDONE_TIME_CARD_DELIVERYPAID_MANUALLYSWIFT posting_datestring- The date the bill is posted to the accounting system. Example: 2026-01-15.
purchase_order_idsarray- Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. Get the ID from ramp_purchase_order_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
remote_idstring- An ID that identifies the bill on client's side. Example: 1001.
use_default_payment_methodboolean- Set to true to use the vendor's default payment method; then leave payment_method empty. Example: true.
vendor_contact_idstring- Unique identifier of vendor contact, must be associated with passed vendor. Get the ID from ramp_vendor_contact_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_idstring- Unique identifier of bill vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_memostring- Memo to the vendor. Example: Payment for invoice INV-2026-0042.
ramp_bill_holdPut a Ramp bill on hold, blocking all payment rails and unscheduling its payment.WriteHold Bill
Put a Ramp bill on hold, blocking all payment rails and unscheduling its payment. Returns the bill with its updated status. Use this to stop a bill from being paid. Use ramp_bill_release to allow payment again, and ramp_vendor_hold to block all of a vendor's bills.
Inputs
bill_idstringrequired- ID of the bill (UUID). Get it from ramp_bill_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
reasonstring- Optional reason for placing the bill on hold. Example: Disputed invoice under review.
ramp_bill_releaseRelease the hold on a Ramp bill so its payment can be scheduled.WriteRelease Bill Hold
Release the hold on a Ramp bill so its payment can be scheduled. Returns the bill with its updated status. Use this to undo ramp_bill_hold. Reschedule the payment afterwards if needed.
Inputs
bill_idstringrequired- ID of the bill (UUID). Get it from ramp_bill_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_bill_updateUpdate an approved Ramp bill's vendor, invoice details, dates, line items, accounting coding, memos or payment method.WriteUpdate Bill
Update an approved Ramp bill's vendor, invoice details, dates, line items, accounting coding, memos or payment method. Returns the updated bill. Use this to correct an approved bill. Use ramp_bill_draft_update for draft bills, and ramp_bill_hold to stop its payment. Only approved bills can be updated. Line item lists replace all existing lines.
- Idempotent
Inputs
bill_idstringrequired- ID of the bill (UUID). Get it from ramp_bill_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_field_selectionsarray- Accounting coding for the record, as a list of selections. Each selection names the ERP field by its external (remote) ID and either picks one of that field's options by its external ID or, for free-text and date fields, supplies text (dates as YYYY-MM-DD). Get field and option remote IDs from ramp_accounting_field_list and ramp_accounting_field_option_list. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
due_atstring- Due date of the bill. Example: 2026-01-15.
entity_idstring- Associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
inventory_line_itemsarray- Replaces all inventory line items on the bill. Each line needs a quantity and unit price (major currency units) and can carry a memo, accounting field selections, the id of an existing line to keep, and a purchase order line item to match. Example: [{"quantity": 10, "unit_price": 12.50}].
invoice_numberstring- The invoice number on the bill. Example: INV-2026-0042.
issued_atstring- Issued date of the bill. Example: 2026-01-15.
line_itemsarray- Replaces all expense line items on the bill. Each line needs an amount in major currency units and can carry a memo, accounting field selections, the id of an existing line to keep, and a purchase order line item to match. Example: [{"amount": 450.00, "memo": "Consulting hours"}].
memostring- Memo of the bill. Example: Q1 office supplies.
payment_datestring- For non-card payments, the date the payment is scheduled to start. Ramp moves unavailable dates (weekends, holidays, past dates) to the next available day. Example: 2026-01-15.
payment_methodstring- Payment method of the bill. Example: ACH.one of
ACHCARDCHECKCRYPTO_WALLET_TRANSFERDOMESTIC_WIREINTERNATIONALLOCAL_BANK_TRANSFERONE_TIME_CARDONE_TIME_CARD_DELIVERYPAID_MANUALLYSWIFT posting_datestring- The date the bill is posted to the accounting system. Example: 2026-01-15.
purchase_order_idsarray- Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. Get the ID from ramp_purchase_order_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
remote_idstring- An ID that identifies the bill on client's side. Example: 1001.
vendor_contact_idstring- Unique identifier of vendor contact, must be associated with passed vendor. Get the ID from ramp_vendor_contact_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_idstring- Unique identifier of bill vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_memostring- Memo to the vendor. Example: Payment for invoice INV-2026-0042.
ramp_card_createIssue a new physical Ramp card to a user and ship it to an address.WriteCreate Physical Card
Issue a new physical Ramp card to a user and ship it to an address. Returns the new card with its ID, cardholder, state and fulfillment details. Use this to order a physical card. Use ramp_card_update to change an existing card. Get the user ID from ramp_user_list.
Inputs
shipping_addressobjectrequired- Where to ship the card. Provide address1, city, country and postal_code; add address2 and state when needed. Example: {"address1": "1 Market St", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "US"}.
user_idstringrequired- ID of the user receiving this card. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
automatic_routing_enabledboolean- Set to true to route spend to the user's matching funds automatically. Only allowed on a user's primary card, and not together with fund_id. Example: true.
fund_idstring- Specify id to set the fund this card is associated with. If set, auto_routing_enabled cannot be passed in, and will automatically be set to False. Get the ID from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_card_suspendSuspend a physical Ramp card so it cannot be used.WriteSuspend Physical Card
Suspend a physical Ramp card so it cannot be used. The suspension can be reversed. Returns the card with is_suspended set to true. Use this to temporarily block a card. Use ramp_card_unsuspend to restore it.
Inputs
card_idstringrequired- ID of the physical card (UUID). Get it from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_card_updateUpdate a physical Ramp card's display name, linked fund or automatic routing setting.WriteUpdate Physical Card
Update a physical Ramp card's display name, linked fund or automatic routing setting. Returns the updated card. Use this to rename a card or move it to another fund. Use ramp_card_suspend to block a card.
- Idempotent
Inputs
card_idstringrequired- ID of the physical card (UUID). Get it from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
automatic_routing_enabledboolean- Set to true to route spend to the user's matching funds automatically. Only allowed on a user's primary card, and not together with fund_id. Example: true.
display_namestring- New display name for the card. A card tied to a single spend limit shows that limit's name instead. Example: Marketing Team Card.
fund_idstring- Specify id to set the fund this card is associated with. If set, auto_routing_enabled cannot be passed in, and will automatically be set to False. Get the ID from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_comment_createPost a comment to the discussion thread of a Ramp bill, draft bill, spend request or transaction, optionally mentioning users.WriteCreate Comment
Post a comment to the discussion thread of a Ramp bill, draft bill, spend request or transaction, optionally mentioning users. Returns the new comment's ID, author, message and creation time. Use this to ask a question or leave a note on spend. Use ramp_comment_list to read the thread. Needs the write scope of the object's resource, such as bills:write or transactions:write.
Inputs
messagestringrequired- The comment message content. When message_format is MARKDOWN, standard Markdown syntax is supported (e.g., link text for hyperlinks, **bold**, *italic*). Example: Please attach the receipt for this charge.
object_idstringrequired- ID (UUID) of the bill, draft bill, spend request or transaction whose discussion thread to use. Get it from the matching list tool, such as ramp_bill_list or ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
object_typestringrequired- Type of object whose discussion thread to use: bills, draft-bills, spend-requests or transactions. Example: bills.one of
billsdraft-billsspend-requeststransactions mention_user_idsarray- IDs of users to mention; Ramp adds @Name for each to the start of the message. Get them from ramp_user_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
message_formatstring- Format of message: PLAIN_TEXT (default) or MARKDOWN for links, bold and italics. Example: MARKDOWN.one of
MARKDOWNPLAIN_TEXT
ramp_department_createCreate a department in Ramp.WriteCreate Department
Create a department in Ramp. Returns the new department's ID and name. Use this to add a department. Use ramp_department_update to rename one.
Inputs
namestringrequired- Name of the department. Example: Marketing.
ramp_department_updateRename a Ramp department.WriteUpdate Department
Rename a Ramp department. Returns the updated department's ID and name. Use this to change a department name. Use ramp_department_create to add one.
- Idempotent
Inputs
department_idstringrequired- ID of the department (UUID). Get it from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
namestringrequired- New name of the department. Example: Growth Marketing.
ramp_fund_createCreate a Ramp fund (spend limit) owned by a user, either from a spend program or standalone.WriteCreate Fund
Create a Ramp fund (spend limit) owned by a user, either from a spend program or standalone. Returns the new fund with its ID, balance, restrictions and members. Use this to give a user a new spend limit. Use ramp_fund_update to change an existing fund. A fund without spend_program_id needs display_name, spending_restrictions and permitted_spend_types. Get program IDs from ramp_spend_program_list.
Inputs
user_idstringrequired- Unique identifier of the fund owner. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_rulesarray- Accounting rules that code the fund's spend. Each rule pairs an accounting field ID with one of its option IDs (Ramp IDs from ramp_accounting_field_list and ramp_accounting_field_option_list). Example: [{"field_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "field_option_id": "9b2f1c7e-4d3a-4e8b-a1f2-6c5d4e3b2a10"}].
display_namestring- Display name of the fund. Required when spend_program_id is not set. Example: Marketing Team Card.
idempotency_keystring- Optional unique value sent as the X-Idempotency-Key header so Ramp does not apply the same request twice. Use a new value (for example a UUID) for each new operation and reuse it only when retrying. 1 to 255 characters. Example: 6f1c2b3a-9d4e-4f5a-8b7c-1d2e3f4a5b6c.
is_exempt_from_policy_agentboolean- Whether this fund is exempt from policy agent review. Example: true.
is_shareableboolean- Whether the fund is shareable among multiple users. Example: true.
permitted_spend_typesobject- Which kinds of spend the fund allows. Provide all three flags: physical_card (the user's physical card can draw on the fund), virtual_card (virtual cards can be linked) and reimbursements (reimbursements can be submitted against it). Example: {"physical_card": true, "virtual_card": true, "reimbursements": false}.
spend_program_idstring- ID of the spend program to create the fund from; the fund inherits the program's defaults. Get it from ramp_spend_program_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
spending_restrictionsobject- Spending rules for the fund. Set the limit as an amount in the smallest currency unit (cents for USD) with an optional currency code, and the interval it resets on (DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY, ANNUAL, TERTIARY or TOTAL). You can also cap each transaction the same way, allow or block Ramp category codes, vendor IDs or MCC codes, set a lock date after which the fund is suspended, and convert limits to the entity's currency. Example: {"interval": "MONTHLY", "limit": {"amount": 50000, "currency_code": "USD"}, "transaction_amount_limit": {"amount": 10000}}.
ramp_fund_member_addAdd users as members of a shareable Ramp fund.WriteAdd Fund Members
Add users as members of a shareable Ramp fund. Returns the updated fund with its members. Use this to let more people spend from a fund. Get user IDs from ramp_user_list.
Inputs
fund_idstringrequired- ID of the fund (UUID). Get it from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
user_idsarrayrequired- IDs of the users to add to the fund. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]. Get the ID from ramp_user_list.
ramp_fund_suspendSuspend a Ramp fund so no one can spend from it.WriteSuspend Fund
Suspend a Ramp fund so no one can spend from it. Returns the fund with its suspension details. Use this to pause a fund. Use ramp_fund_unsuspend to restore it, or ramp_card_suspend to block a single card.
Inputs
fund_idstringrequired- ID of the fund (UUID). Get it from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_fund_updateUpdate a Ramp fund's name, spend program, sharing, spending restrictions, permitted spend types or accounting rules.WriteUpdate Fund
Update a Ramp fund's name, spend program, sharing, spending restrictions, permitted spend types or accounting rules. Returns the updated fund. Use this to change a fund's limits or settings. Use ramp_fund_member_add to add members and ramp_fund_suspend to pause it.
- Idempotent
Inputs
fund_idstringrequired- ID of the fund (UUID). Get it from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_rulesarray- Replaces the fund's accounting rules. Each rule pairs an accounting field ID with one of its option IDs (Ramp IDs from ramp_accounting_field_list and ramp_accounting_field_option_list). Example: [{"field_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "field_option_id": "9b2f1c7e-4d3a-4e8b-a1f2-6c5d4e3b2a10"}].
display_namestring- Display name for the fund. Example: Marketing Team Card.
idempotency_keystring- Optional unique value sent as the X-Idempotency-Key header so Ramp does not apply the same request twice. Use a new value (for example a UUID) for each new operation and reuse it only when retrying. 1 to 255 characters. Example: 6f1c2b3a-9d4e-4f5a-8b7c-1d2e3f4a5b6c.
is_exempt_from_policy_agentboolean- Whether the fund is exempt from policy agent review. Example: true.
is_shareableboolean- Whether the fund supports multiple members. Example: true.
permitted_spend_typesobject- Replaces the fund's permitted spend types. Provide all three flags: physical_card, virtual_card and reimbursements. Example: {"physical_card": true, "virtual_card": false, "reimbursements": true}.
spend_program_idstring- ID of the spend program to link the fund to. Get it from ramp_spend_program_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
spending_restrictionsobject- Spending restriction changes, merged into the current restrictions (on a program-linked fund these override the program defaults). You can change the limit (amount in the smallest currency unit, such as cents, with an optional currency code), its interval, a per-transaction cap, allowed or blocked Ramp category codes, vendor IDs or MCC codes, the lock date, and mark a limit change as temporary. Example: {"limit": {"amount": 75000}, "interval": "MONTHLY"}.
ramp_item_receipt_createRecord goods or services received against a Ramp purchase order.WriteCreate Item Receipt
Record goods or services received against a Ramp purchase order. Returns the new item receipt with its ID and line items. Use this for three-way match. Get purchase order and line item IDs from ramp_purchase_order_get.
Inputs
item_receipt_line_itemsarrayrequired- Lines received. Each line names the purchase order line item being received and, where needed, the quantity received; lot-tracked inventory can also list per-lot quantities. Example: [{"purchase_order_line_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "unit_quantity": 5}].
item_receipt_numberstringrequired- Item receipt number. Example: IR-1001.
purchase_order_idstringrequired- Unique identifier of the purchase order this item receipt is attached to. Get the ID from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
received_atstringrequired- Date the goods or services were received. Example: 2026-01-15.
memostring- Memo for the item receipt. Example: Received 5 laptops at HQ.
ramp_location_createCreate a location in Ramp, optionally tied to a business entity.WriteCreate Location
Create a location in Ramp, optionally tied to a business entity. Returns the new location's ID, name and entity ID. Use this to add an office or site. Use ramp_location_update to change one.
Inputs
namestringrequired- Name of the location. Example: New York Office.
entity_idstring- ID of the business entity this location belongs to. Get it from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_location_updateRename a Ramp location or move it to another business entity.WriteUpdate Location
Rename a Ramp location or move it to another business entity. Returns the updated location. Use this to change a location. Users at the location move with it to the new entity.
- Idempotent
Inputs
location_idstringrequired- ID of the location (UUID). Get it from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
namestringrequired- New name of the location. Example: NYC HQ.
entity_idstring- ID of the business entity to move the location to. Users assigned to the location also move. Get it from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_memo_createAdd a memo to a Ramp transaction, optionally applying it to similar future transactions.WriteAdd Transaction Memo
Add a memo to a Ramp transaction, optionally applying it to similar future transactions. Returns the transaction ID and the saved memo. Use this to explain a charge. Use ramp_memo_get to read the current memo.
Inputs
memostringrequired- Memo text for the transaction, up to 255 characters. Example: Q1 office supplies.
transaction_idstringrequired- ID of the Ramp card transaction (UUID). Get it from ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
is_memo_recurringboolean- Whether this memo should automatically apply to similar future transactions. Example: true.
ramp_purchase_order_createCreate a Ramp purchase order with line items, currency, entity and optional vendor, owner, dates and accounting coding.WriteCreate Purchase Order
Create a Ramp purchase order with line items, currency, entity and optional vendor, owner, dates and accounting coding. Returns the new purchase order with its ID, number and line items. Use this to raise a PO. Use ramp_purchase_order_line_item_add to add lines later and ramp_purchase_order_update to change it. Get entity_id from ramp_entity_list and vendor_id from ramp_vendor_list.
Inputs
currencystringrequired- Currency of the purchase order. Example: USD.one of
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEUREURCFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMROPEN_USDPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSDBUSDCUSDGUSDSUIUSDTUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWGZWL entity_idstringrequired- Unique identifier of associated business entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
line_itemsarrayrequired- Purchase order line items. Each line needs a unit price (major currency units) and a quantity, and can carry a description, start and end dates for the spend, a client-side external ID, a retainage withholding rate (0 to 1) and its own accounting field selections. Example: [{"description": "Laptops", "unit_price": "1200.00", "unit_quantity": 5}].
three_way_match_enabledbooleanrequired- Whether three-way match is enabled, meaning an item receipt is expected to confirm goods were received before paying. Example: true.
accounting_field_selectionsarray- Accounting coding for the record, as a list of selections. Each selection names the ERP field by its external (remote) ID and either picks one of that field's options by its external ID or, for free-text and date fields, supplies text (dates as YYYY-MM-DD). Get field and option remote IDs from ramp_accounting_field_list and ramp_accounting_field_option_list. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
external_idstring- An ID that uniquely identifies the purchase order on the client's side. Must be unique per business and cannot be updated after creation. Example: PO-EXT-1001.
memostring- Memo for the purchase order. Example: Laptops for new hires.
namestring- Name of the purchase order; must contain a non-whitespace character. Example: Q1 laptop refresh.
net_payment_termsinteger- The required time an invoice needs to be paid after receipt in days. Example: 30.
owner_idstring- Unique identifier for the owner of the purchase order. Defaults to the API caller when not provided. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
promise_datestring- The date the vendor will deliver the goods or services. Example: 2026-01-15.
purchase_order_numberstring- Unique purchase order number with format <prefix>-<number>. Prefixes must only contain numbers, uppercase letters, and dashes. Invalid characters will be filtered out automatically. If not provided, one will be auto-generated using a prefix specified in procurement settings, if it exists. Example: PO-1001.
spend_end_datestring- The date when spending for this purchase order ends. Example: 2026-01-15.
spend_start_datestring- The date when spending for this purchase order begins. Example: 2026-01-15.
vendor_idstring- Unique identifier for the vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
withholding_default_ratenumber- Default retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%. Example: 0.10.
ramp_purchase_order_line_item_addAdd line items to an existing Ramp purchase order without changing its current lines.WriteAdd Purchase Order Line Items
Add line items to an existing Ramp purchase order without changing its current lines. Returns the updated purchase order. Use this to extend a PO. Use ramp_purchase_order_line_item_update to change an existing line.
Inputs
line_itemsarrayrequired- Line items to add. Each line needs a unit price (major currency units) and a quantity, and can carry a description, start and end dates, a client-side external ID, a retainage withholding rate (0 to 1) and accounting field selections. Example: [{"description": "Docking stations", "unit_price": "150.00", "unit_quantity": 5}].
purchase_order_idstringrequired- ID of the purchase order (UUID). Get it from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_purchase_order_line_item_updateUpdate one line item on an approved Ramp purchase order: description, price, quantity, dates, withholding rate or accounting coding.WriteUpdate Purchase Order Line Item
Update one line item on an approved Ramp purchase order: description, price, quantity, dates, withholding rate or accounting coding. Returns the updated purchase order. Use this to correct a PO line. Get line item IDs from ramp_purchase_order_get.
- Idempotent
Inputs
line_item_idstringrequired- ID of the purchase order line item (UUID). Get it from the line_items array returned by ramp_purchase_order_get. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
purchase_order_idstringrequired- ID of the purchase order (UUID). Get it from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_field_selectionsarray- Accounting coding for the record, as a list of selections. Each selection names the ERP field by its external (remote) ID and either picks one of that field's options by its external ID or, for free-text and date fields, supplies text (dates as YYYY-MM-DD). Get field and option remote IDs from ramp_accounting_field_list and ramp_accounting_field_option_list. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
descriptionstring- New description of the line item. Example: Laptops, 16GB.
end_datestring- The date when spending for this line item ends. Omit to preserve the current date; set to null to clear it. Example: 2026-01-15.
start_datestring- The date when spending for this line item begins. Omit to preserve the current date; set to null to clear it. Example: 2026-01-15.
unit_pricenumber- Unit price of the line item. Example: 450.00.
unit_quantitynumber- Quantity of the line item. Example: 2.
withholding_ratenumber- Retainage withholding rate for the line item, expressed as a fractional decimal. If set, this line-level rate overrides the purchase order withholding_default_rate for this line item. For example, 0.10 means 10%. Example: 0.10.
ramp_purchase_order_updateUpdate an approved Ramp purchase order's name, memo, owner, spend dates, withholding rate or accounting coding.WriteUpdate Purchase Order
Update an approved Ramp purchase order's name, memo, owner, spend dates, withholding rate or accounting coding. Returns the updated purchase order. Use this to change PO header details. Use ramp_purchase_order_line_item_update to change a line.
- Idempotent
Inputs
purchase_order_idstringrequired- ID of the purchase order (UUID). Get it from ramp_purchase_order_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_field_selectionsarray- Replaces the purchase order's header-level accounting coding (all or nothing). Each selection names an ERP field by its external ID and picks an option by external ID or supplies free text. Usually only a vendor field is supported. Example: [{"field_external_id": "class", "field_option_external_id": "100"}].
memostring- New memo for the purchase order. Example: Laptops for new hires.
namestring- New name of the purchase order; must contain a non-whitespace character. Example: Q1 laptop refresh.
owner_idstring- Unique identifier of the new owner of the purchase order. The purchase order must be approved. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
spend_end_datestring- The date when spending for this purchase order ends. Example: 2026-01-15.
spend_start_datestring- The date when spending for this purchase order begins. Example: 2026-01-15.
withholding_default_ratenumber- Default retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%. Example: 0.10.
ramp_reimbursement_mileage_createCreate a mileage reimbursement for a user's trip, with distance, date, start and end locations and an optional memo.WriteCreate Mileage Reimbursement
Create a mileage reimbursement for a user's trip, with distance, date, start and end locations and an optional memo. Returns the new reimbursement with its ID, amount and state. Use this to log business mileage. Use ramp_reimbursement_list to review reimbursements. Get reimbursee_id from ramp_user_list.
Inputs
distancenumberrequired- Distance travelled, in the units set by distance_units. Example: 32.5.
reimbursee_idstringrequired- ID of the user being reimbursed (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
trip_datestringrequired- Date of the trip. Example: 2026-01-15.
distance_unitsstring- Units for distance: MILES or KILOMETERS. Example: KILOMETERS.one of
KILOMETERSMILES end_locationstring- Where the trip ended, as an address or place name. Example: 500 El Camino Real, Palo Alto, CA.
memostring- Memo describing the business purpose of the trip. Example: Q1 office supplies.
spend_allocation_idstring- ID of the fund to attribute the mileage reimbursement to (UUID). Get it from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
start_locationstring- Where the trip started, as an address or place name. Example: 1 Market St, San Francisco, CA.
waypointsarray- Stops between the start and end locations, in order, as addresses or place names. Example: ["200 Main St, Redwood City, CA"].
ramp_spend_program_createCreate a Ramp spend program, a template for funds with a name, icon, permitted spend types and spending restrictions.WriteCreate Spend Program
Create a Ramp spend program, a template for funds with a name, icon, permitted spend types and spending restrictions. Returns the new spend program with its ID. Use this to define a reusable spend policy. Use ramp_fund_create with spend_program_id to issue funds from it.
Inputs
descriptionstringrequired- Description of the spend program. Example: Monthly software subscriptions for engineering.
display_namestringrequired- Display name of the spend program. Example: Engineering Software.
iconstringrequired- Template icon for the spend program, from Ramp's fixed icon list (for example SoftwareIcon or CardIcon). Example: CardIcon.one of
AccountingServicesIconAdvertisingIconCONTRACTORS_AND_PROFESSIONAL_SERVICESCUSTOMCardIconEducationStipendIconEmployeeRewardsIconGroundTransportationIconLegalFeesIconLodgingIconLunchOrderingIconOnboardingIconPerDiemCardIconSOFTWARESaasSubscriptionIconSoftwareTrialIconSuppliesIconTeamSocialIconTravelExpensesIconVirtualEventIconWellnessIconWorkFromHomeIconadvertisingairlinesbillsbusinesscar_servicescontractoreducationentertainmentevent_balloonsevent_virtualfoodfuel_and_gasgeneral_expensegeneral_merchandisegiftgovernment_servicesinternet_and_phonelegallodginglodging_roomnewspaperofficephysical_cardprocurement_checklistprocurement_intakeprofessional_servicesrestaurantsrewardsaas_softwareshippingtravel_miscwellness permitted_spend_typesobjectrequired- Which kinds of spend the program allows. Provide both flags: primary_card_enabled (the user's physical card can be linked) and reimbursements_enabled (reimbursements can be submitted). Example: {"primary_card_enabled": true, "reimbursements_enabled": false}.
spending_restrictionsobjectrequired- Spending rules for funds from this program. Set the limit as an amount in the smallest currency unit (cents for USD) with an optional currency code, and the interval it resets on (DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY, ANNUAL, TERTIARY or TOTAL). You can also cap each transaction, allow or block Ramp category codes, merchant IDs or MCC codes, and set a lock date. Example: {"interval": "MONTHLY", "limit": {"amount": 100000, "currency_code": "USD"}}.
is_shareableboolean- Dictates whether the spend program is shareable among multiple users. Example: true.
issue_physical_card_if_neededboolean- Dictates whether the spend program should issue a physical card if the user does not have one. Example: true.
ramp_transaction_splitSplit a Ramp card transaction into line items, replace an existing split, or remove the split.WriteSplit Transaction
Split a Ramp card transaction into line items, replace an existing split, or remove the split. Returns the updated transaction. Use this to allocate one charge across memos or accounting codes. Use ramp_memo_create to add a memo to the whole transaction.
- Idempotent
Inputs
line_itemsarrayrequired- Line items for the split. Each line needs an amount in minor units (5000 is $50.00) and can carry a memo and accounting field selections; the amounts must add up to the transaction amount. Send an empty list to remove the split. Example: [{"amount": 3000, "memo": "Client dinner"}, {"amount": 2000, "memo": "Team dinner"}].
transaction_idstringrequired- ID of the Ramp card transaction (UUID). Get it from ramp_transaction_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_user_deactivateDeactivate a Ramp user so they can no longer log in, spend on cards or receive Ramp notifications.WriteDeactivate User
Deactivate a Ramp user so they can no longer log in, spend on cards or receive Ramp notifications. Returns an empty object on success. Use this when someone leaves. Use ramp_user_reactivate to restore access.
- Idempotent
Inputs
user_idstringrequired- ID of the Ramp user (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_user_invite_createInvite a new user to Ramp by email, with a role and optional department, location and manager.WriteInvite User
Invite a new user to Ramp by email, with a role and optional department, location and manager. Starts an asynchronous invite task and returns the task ID; the user receives an invite email unless created as a draft. Use this to add a person to Ramp. Use ramp_user_invite_status_get to check the task, and ramp_user_invite_manage to send a draft user's invite later.
Inputs
emailstringrequired- The employee's email address. Example: jane.doe@example.com.
first_namestringrequired- First name of the employee. Example: Jane.
idempotency_keystringrequired- Unique value (for example a UUID) that lets Ramp recognize retries of this invite so the user is not invited twice. Use a new value for each new invite. Example: 6f1c2b3a-9d4e-4f5a-8b7c-1d2e3f4a5b6c.
last_namestringrequired- Last name of the employee. Example: Doe.
rolestringrequired- Role for the new user. BUSINESS_ADMIN is Admin, BUSINESS_USER is Cardholder, BUSINESS_BOOKKEEPER is Bookkeeper; BUSINESS_OWNER cannot be invited. Example: AUDITOR.one of
AUDITORBUSINESS_ADMINBUSINESS_BOOKKEEPERBUSINESS_OWNERBUSINESS_USERGUEST_USERIT_ADMIN department_idstring- Unique identifier of the employee's department. Get the ID from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
direct_manager_idstring- Unique identifier of the employee's direct manager. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
is_draftboolean- Set to true to create the user as a draft without sending an invite email. Send the invite later with ramp_user_invite_manage. Example: true.
is_managerboolean- Whether the employee is a manager. Example: true.
location_idstring- Unique identifier of the employee's location. Get the ID from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
scheduled_deactivation_datestring- The date when the user is scheduled to be deactivated. For guest users, this will automatically be set to 6 months from the invite creation date unless explicitly set to null. Cannot be set for admins or owners. Example: 2026-12-31.
ramp_user_invite_manageSend, schedule or cancel the invite for a draft Ramp user.WriteManage User Invite
Send, schedule or cancel the invite for a draft Ramp user. Returns an empty object on success. Use this after creating a draft user with ramp_user_invite_create and is_draft set. SEND_NOW and SCHEDULE need the user to be in DRAFT status.
Inputs
actionstringrequired- The invite action to perform. SCHEDULE creates or updates a scheduled invitation (requires `invitation_time`). DESCHEDULE cancels any pending scheduled invitation. SEND_NOW immediately sends the user's invite. Example: DESCHEDULE.one of
DESCHEDULESCHEDULESEND_NOW user_idstringrequired- ID of the Ramp user (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
invitation_timestring- The datetime at which the user should be invited. Required when `action` is SCHEDULE; ignored otherwise. Must be an ISO 8601 datetime with a timezone offset. Example: 2026-02-01T09:00:00-08:00.
ramp_user_reactivateReactivate a deactivated Ramp user so they can log in, use their cards and get notifications again.WriteReactivate User
Reactivate a deactivated Ramp user so they can log in, use their cards and get notifications again. Returns an empty object on success. Use this to undo ramp_user_deactivate.
- Idempotent
Inputs
user_idstringrequired- ID of the Ramp user (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_user_updateUpdate a Ramp user's name, role, department, location, manager, manager flag or scheduled deactivation date.WriteUpdate User
Update a Ramp user's name, role, department, location, manager, manager flag or scheduled deactivation date. Returns no content on success; call ramp_user_get to see the updated user. Use this to change a user's details. Use ramp_user_deactivate or ramp_user_reactivate to change access.
- Idempotent
Inputs
user_idstringrequired- ID of the Ramp user (UUID). Get it from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
auto_promoteboolean- Whether to automatically promote the users manager to manager. Example: true.
department_idstring- Unique identifier of the employee's department. Get the ID from ramp_department_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
direct_manager_idstring- Unique identifier of the employee's direct manager. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
first_namestring- New first name for the user. Example: Jane.
is_managerboolean- Whether the employee is a manager. Example: true.
last_namestring- New last name for the user. Example: Doe.
location_idstring- Unique identifier of the employee's location. Get the ID from ramp_location_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
rolestring- New role for the user. BUSINESS_ADMIN is Admin, BUSINESS_USER is Cardholder, BUSINESS_BOOKKEEPER is Bookkeeper; BUSINESS_OWNER cannot be set. Example: AUDITOR.one of
AUDITORBUSINESS_ADMINBUSINESS_BOOKKEEPERBUSINESS_OWNERBUSINESS_USERGUEST_USERIT_ADMIN scheduled_deactivation_datestring- The date when the user is scheduled to be deactivated. Set to null to clear. Cannot be set for admins or owners. Example: 2026-12-31.
ramp_vendor_agreement_createCreate a vendor agreement (contract) for a Ramp vendor, with name, start date, total value, renewal and notification settings and optional line items.WriteCreate Vendor Agreement
Create a vendor agreement (contract) for a Ramp vendor, with name, start date, total value, renewal and notification settings and optional line items. Returns the new agreement with its ID. Use this to record a contract. Use ramp_vendor_agreement_update to change it.
Inputs
auto_renewalbooleanrequired- Whether the agreement renews automatically. Example: true.
namestringrequired- Name of the agreement. Example: Acme SaaS annual contract.
notifications_onbooleanrequired- Whether renewal notifications are turned on for the agreement. Example: true.
start_datestringrequired- Start date of the agreement. Example: 2026-01-01.
total_valueobjectrequired- Total value of the agreement, as an amount in the currency's minor unit (cents for USD) with an optional currency code that defaults to USD. Example: {"amount": 1200000, "currency_code": "USD"}.
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
contract_owner_idsarray- IDs of the users who own the contract. Get them from ramp_user_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
descriptionstring- Description of the agreement. Example: Annual platform subscription, 50 seats.
end_datestring- End date of the agreement. Example: 2026-12-31.
last_date_to_terminatestring- Last date by which the agreement can be terminated. Example: 2026-11-30.
line_itemsarray- Products or services covered by the agreement. Each line needs a product or service name, a quantity and a price per unit, and can add a discount, total price, unit name, term and time unit. Example: [{"product_or_service_name": "Platform seats", "quantity": 50, "price_per_unit": 240}].
ramp_vendor_agreement_listList vendor agreements (contracts) in Ramp, filtered by vendor, owner, department, active or renewal state, dates, value or days remaining.WriteList Vendor Agreements
List vendor agreements (contracts) in Ramp, filtered by vendor, owner, department, active or renewal state, dates, value or days remaining. Returns a page of agreements with ID, name, vendor, dates, total value, renewal status and owners, plus page.next. Use this to review contracts or find upcoming renewals. Use ramp_vendor_agreement_get for one agreement. This read uses POST because Ramp takes the filters in the request body.
Inputs
auto_renewsboolean- Filter by whether the agreement auto-renews. Example: true.
contract_owner_idsarray- Only return agreements owned by these users. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
department_idsarray- Only return agreements for these departments. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
exclude_snoozedboolean- Exclude snoozed agreements when true. Example: true.
has_end_dateboolean- Filter by whether the agreement has an end date. Example: true.
has_pending_expansion_requestsboolean- Filter by whether the agreement has pending expansion requests. Example: true.
has_remindersboolean- Filter by whether the agreement has reminders configured. Example: true.
include_archivedboolean- Include archived agreements when true. Example: true.
is_activeboolean- Filter by whether the agreement is active. Example: true.
is_up_for_renewalboolean- Filter by whether the agreement is up for renewal. Example: true.
max_days_remaininginteger- Filter by agreements with days remaining less than or equal to this value. Example: 90.
max_end_datestring- Filter by agreements whose end date is on or before the provided date. Example: 2026-01-15.
max_last_date_to_terminatestring- Filter by agreements whose last date to terminate is on or before the provided date. Example: 2026-01-15.
max_start_datestring- Filter by agreements whose start date is on or before the provided date. Example: 2026-01-15.
max_total_valuenumber- Filter by agreements with total value less than or equal to this value. Example: 50000.
min_days_remaininginteger- Filter by agreements with days remaining greater than or equal to this value. Example: 0.
min_end_datestring- Filter by agreements whose end date is on or after the provided date. Example: 2026-01-15.
min_last_date_to_terminatestring- Filter by agreements whose last date to terminate is on or after the provided date. Example: 2026-01-15.
min_start_datestring- Filter by agreements whose start date is on or after the provided date. Example: 2026-01-15.
min_total_valuenumber- Filter by agreements with total value greater than or equal to this value. Example: 1000.
page_sizeinteger- Number of results per page, between 2 and 100. Ramp returns 20 when this is left empty. Example: 50.
payee_agreement_idsarray- Only return these agreements. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
payee_idsarray- Only return agreements with these vendors. Get vendor IDs from ramp_vendor_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
payee_owner_idsarray- Only return agreements whose vendor is owned by these users. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
renewal_statusarray- Only return agreements in these renewal statuses: NOT_STARTED, PLANNING, EVALUATING, INITIATED, RENEWED, CANCELLED, EXPIRED, REJECTED or TERMINATED. Example: ["PLANNING", "EVALUATING"].
renewal_status_excludearray- Leave out agreements in these renewal statuses (same values as renewal_status). Example: ["EXPIRED"].
startstring- Pagination cursor: the ID of the last item on the previous page. Copy the start value from the page.next URL in the previous response; leave empty for the first page. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_agreement_updateUpdate a vendor agreement's name, description, dates, total value, owners, auto-renewal, notifications or renewal reminder snooze.WriteUpdate Vendor Agreement
Update a vendor agreement's name, description, dates, total value, owners, auto-renewal, notifications or renewal reminder snooze. Returns the updated agreement. Use this to change a contract's terms. Use ramp_vendor_agreement_get to see the current values.
- Idempotent
Inputs
agreement_idstringrequired- ID of the vendor agreement (UUID). Get it from ramp_vendor_agreement_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
auto_renewalboolean- Whether the agreement renews automatically. Example: true.
contract_owner_idsarray- IDs of the users who own the contract (replaces the current owners). Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"].
descriptionstring- New description of the agreement. Example: Annual platform subscription, 60 seats.
end_datestring- End date of the agreement. Example: 2026-12-31.
last_date_to_terminatestring- Last date by which the agreement can be terminated. Example: 2026-11-30.
namestring- New name of the agreement. Example: Acme SaaS annual contract.
notifications_onboolean- Whether renewal notifications are turned on for the agreement. Example: true.
renewal_notification_snoozed_untilstring- Date when renewal reminders resume (YYYY-MM-DD), after today and at most a year away. Example: 2026-06-30.
start_datestring- Start date of the agreement. Example: 2026-01-01.
total_valueobject- New total value, as an amount in the currency's minor unit (cents for USD) with an optional currency code that defaults to USD. Example: {"amount": 1440000, "currency_code": "USD"}.
ramp_vendor_contact_createAdd a contact to a Ramp vendor, optionally as the default contact.WriteCreate Vendor Contact
Add a contact to a Ramp vendor, optionally as the default contact. Returns the contact ID, vendor ID and status of the change (it may need approval). Use this to add a billing or sales contact. Use ramp_vendor_contact_list to see existing contacts.
Inputs
emailstringrequired- Email address of the contact. Example: billing@acme.com.
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
first_namestring- First name of the contact, up to 40 characters. Example: Jane.
is_defaultboolean- Set to true to make this the vendor's default contact. Example: true.
last_namestring- Last name of the contact, up to 40 characters. Example: Doe.
phonestring- Phone number of the contact. Example: +14155550123.
ramp_vendor_createCreate a Ramp vendor with a contact, country and optional address, owner, payment terms and accounting link.WriteCreate Vendor
Create a Ramp vendor with a contact, country and optional address, owner, payment terms and accounting link. Returns the new vendor with its ID and details. Vendors created through the API are approved by default. Use this to add a payee before creating bills. Use ramp_vendor_update to change a vendor and ramp_vendor_contact_create to add more contacts.
Inputs
business_vendor_contactsobjectrequired- Primary contact at the vendor. An email is required; first name, last name and phone are optional. Example: {"email": "billing@acme.com", "first_name": "Sam", "last_name": "Lee"}.
countrystringrequired- Country of the vendor as a two-letter ISO code. Example: US.
accounting_vendor_remote_idstring- The accounting remote id of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. The referenced accounting vendor must not already be linked to another Ramp vendor. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
addressobject- Vendor postal address. Provide the first address line, city, country and postal code; add a second line if needed, and the two-letter state or province code for US, CA and AU addresses. Example: {"address_line_1": "1 Market St", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "US"}.
default_entity_idstring- Unique identifier of the default business entity to associate with this vendor. Must belong to the current business. If omitted, the vendor is created without a default entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
external_vendor_idstring- Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. Example: VEND-0091.
namestring- Name of the new vendor. Example: Acme Supplies.
net_payment_termsinteger- Number of days after receipt that payment is due. 0 means due on receipt. Null clears terms; omission may inherit terms from a parent vendor. Example: 30.
parent_vendor_idstring- Unique identifier of the parent vendor to associate with this vendor. Get the ID from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
request_payment_detailsboolean- Whether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires a contact email. Example: true.
request_tax_detailsboolean- Whether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires a contact email. Example: true.
requesting_user_idstring- Unique identifier of the Ramp user to record as the requestor for any payment or tax details request created during vendor creation. Defaults to existing vendor creation behavior when omitted. Requires the token user to have admin or owner privileges. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
statestring- Two-letter US state code for the vendor, such as CA. Required when country is US; ignored otherwise. Example: CA.
vendor_owner_idstring- Unique identifier of the user that will own this vendor. If omitted, the vendor will be created without an owner. Get the ID from ramp_user_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
vendor_tracking_category_option_idstring- Ramp unique identifier of the accounting vendor to link to this vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. The referenced accounting vendor must not already be linked to another Ramp vendor. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_holdPlace a hold on a Ramp vendor, blocking payments to it and removing its open bills from scheduled payment runs.WriteHold Vendor
Place a hold on a Ramp vendor, blocking payments to it and removing its open bills from scheduled payment runs. Returns no content when the hold is accepted. Use this to stop all payments to a vendor. Use ramp_vendor_release to lift it, or ramp_bill_hold to hold one bill.
Inputs
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
reasonstring- Optional reason for placing the vendor on hold. Example: Bank details under verification.
ramp_vendor_releaseRelease the hold on a Ramp vendor so new payments can be scheduled.WriteRelease Vendor Hold
Release the hold on a Ramp vendor so new payments can be scheduled. Returns no content when the release is accepted. Use this to undo ramp_vendor_hold. Payments removed during the hold must be scheduled again.
Inputs
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_vendor_updateUpdate a Ramp vendor's name, description, address, country, default entity or bank account, payment terms, active state or accounting link.WriteUpdate Vendor
Update a Ramp vendor's name, description, address, country, default entity or bank account, payment terms, active state or accounting link. Returns the updated vendor. Use this to change vendor details. Use ramp_vendor_hold to block payments to the vendor.
- Idempotent
Inputs
vendor_idstringrequired- ID of the Ramp vendor (UUID). Get it from ramp_vendor_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
accounting_vendor_remote_idstring- ERP remote ID of the accounting vendor to link to this vendor. Set at most one of this and vendor_tracking_category_option_id. Example: 1001.
addressobject- Vendor postal address. Provide the first address line, city, country and postal code; add a second line if needed, and the two-letter state or province code for US, CA and AU addresses. Example: {"address_line_1": "1 Market St", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "US"}.
countrystring- Country of the vendor as a two-letter ISO code. Example: US.
default_bank_account_idstring- ID of one of this vendor's bank accounts to use as its default payment method. Get it from ramp_vendor_bank_account_list. Existing bills are not changed. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
default_entity_idstring- Unique identifier of the default business entity to associate with this vendor. Must belong to the current business. Set to null to clear the default entity. Get the ID from ramp_entity_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
descriptionstring- Description of the vendor. Example: Office supplies and furniture.
external_vendor_idstring- Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. Example: VEND-0091.
is_activeboolean- Whether this vendor is active. Example: true.
namestring- Name of the vendor. Example: Acme Supplies.
net_payment_termsinteger- Number of days after receipt that payment is due. 0 means due on receipt; null clears the terms. Omit to leave unchanged. Example: 30.
request_payment_detailsboolean- Whether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires an existing default vendor contact email. Example: true.
request_tax_detailsboolean- Whether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires an existing default vendor contact email. Example: true.
statestring- Two-letter US state code for the vendor, such as CA. Required when country is US; ignored otherwise. Example: CA.
vendor_tracking_category_option_idstring- Ramp ID of the accounting vendor to link to this vendor. Get it from ramp_accounting_vendor_list. Set at most one of this and accounting_vendor_remote_id. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_card_unsuspendLift the suspension on a physical Ramp card so it can be used again.DestructiveUnsuspend Physical Card
Lift the suspension on a physical Ramp card so it can be used again. Returns the card with is_suspended set to false. Use this to restore a card suspended with ramp_card_suspend.
- Idempotent
Inputs
card_idstringrequired- ID of the physical card (UUID). Get it from ramp_card_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
ramp_fund_unsuspendLift the suspension on a Ramp fund so it can be used again.DestructiveUnsuspend Fund
Lift the suspension on a Ramp fund so it can be used again. Returns the fund with its updated state. Use this to undo ramp_fund_suspend.
- Idempotent
Inputs
fund_idstringrequired- ID of the fund (UUID). Get it from ramp_fund_list. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
No tools match.