Reference

Agent Tools

Canonical generated list of Ramp tools available through Ramp MCP and Ramp CLI.

This is the canonical generated list of Ramp Agent Tools available through both Ramp MCP and Ramp CLI at build time, including exact tool names, descriptions, and parameters.

Runtime access still depends on the authenticated Ramp identity's permissions, admin controls, scopes, connected client, environment, and installed CLI version. If this list differs from the tools available in your MCP client or CLI, reconnect Ramp or update the CLI and use the live tool list for that connection.

Generated from https://api.ramp.com/v1/public/agent-tools/spec. This reviewed snapshot includes 147 tools. Runtime access still depends on the authenticated Ramp identity's permissions, scopes, connected client, environment, and installed CLI version. If this list differs from your MCP client or CLI, reconnect Ramp or update the CLI and use the live tool list.

Accounting and sync

ramp_get_latest_sync

Get the most recent accounting sync commit for the acting user's business and sync type.

Parameters and full description

Get the most recent accounting sync commit for the acting user's business and sync type. Use this when you need the latest sync status plus every intended and successful count exposed by Ramp's accounting latest-sync endpoint.

ParameterTypeDescription
rationalerequiredstringRationale
sync_typerequiredstringSync type to fetch, such as TRANSACTION_SYNC, BILL_SYNC, BILL_PAYMENT_SYNC, REIMBURSEMENT_SYNC, TRANSFER_SYNC, WALLET_TRANSFER_SYNC, or ACCRUAL_SYNC.
ramp_get_sync_commit_failure_details

Get object-level failure details for an accounting sync commit by UUID.

Parameters and full description

Get object-level failure details for an accounting sync commit by UUID. Use this when a customer asks about failed accounting sync rows, including rows from the accounting transactions table, reimbursements table, or bills tab.

ParameterTypeDescription
rationalerequiredstringRationale
sync_commit_uuidrequiredstringSync Commit Uuid
ramp_get_tracking_categories

Retrieve active accounting tracking category metadata for transaction coding, such

Parameters and full description

Retrieve active accounting tracking category metadata for transaction coding, such as departments, classes or business units, locations, projects, customers, and cost centers. Use GetTrackingCategoryOptions for a category's options. If passing transaction_uuid, use an actual TransactionCanonical UUID from context or a prior lookup; omit it rather than passing a placeholder or natural-language reference.

ParameterTypeDescription
rationalerequiredstringRationale
include_hiddenbooleanInclude Hidden
transaction_uuidstring | nullTransaction Uuid
ramp_get_tracking_category_options

List specific departments, projects, or other options for a tracking category.

Parameters and full description

List specific departments, projects, or other options for a tracking category. Pass `query_string` to narrow by name, synonym, or provider code. Do not call this tool when you already have the exact tracking_category_option_uuid from user-provided context, suggested codings, or another tool result; pass that UUID directly to the coding tool as the option_selection. If the user message includes `tracking_category_option_uuid=...`, do not call this tool just to confirm the option. If you're coding a specific transaction or reimbursement, pass its UUID so results respect conditional filtering (subsidiary, department, location, etc.); skip it for generic lookups, including bill/invoice contexts. Categories can have millions of options — paginate via `next_page_cursor` when needed, keeping all other inputs unchanged between pages.

ParameterTypeDescription
rationalerequiredstringRationale
tracking_category_uuidrequiredstringTracking Category Uuid
include_hiddenbooleanInclude Hidden
next_page_cursorinteger | nullNext Page Cursor
page_sizeintegerPage Size
query_stringstring | nullQuery String
reimbursement_uuidstring | nullReimbursement Uuid
transaction_uuidstring | nullTransaction Uuid
ramp_mark_ready_to_sync

Mark objects as ready to sync to your accounting provider

Parameters and full description

Mark objects as ready to sync to your accounting provider

ParameterTypeDescription
object_idsrequiredarrayIDs of the objects to mark as ready to sync. All IDs must belong to the authenticated business; the request fails if any ID is not found.
object_typerequiredstringThe type of object to mark ready to sync. Supported values are TRANSACTION and REIMBURSEMENT.

Agent cards and x402

ramp_enroll_business_in_agent_cards

Enroll the current business in agent cards for agentic commerce.

Parameters and full description

Enroll the current business in agent cards for agentic commerce.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_fund_x402_wallet

Fund the business's x402 wallet from a Ramp Checking Account.

Parameters and full description

Fund the business's x402 wallet from a Ramp Checking Account. Before calling, use ListBusinessAccounts to obtain the source account UUID; never guess it. Confirm the exact source account and positive USD amount with the user before creating this irreversible transfer. MCP and CLI callers must provide an idempotency key. Only active Increase USD accounts are supported.

ParameterTypeDescription
amountrequirednumber | stringAmount
rationalerequiredstringRationale
source_wallet_account_uuidrequiredstringSource Wallet Account Uuid
idempotency_keystring | nullIdempotency Key
ramp_get_agent_card_creds

Get a one-time payment token for a fund. Handles card enrollment and purchase instructions automatically.

Parameters and full description

Get a one-time payment token for a fund. Handles card enrollment and purchase instructions automatically.

ParameterTypeDescription
amountrequiredstringAmount
currency_coderequiredstringCurrency Code
fund_idrequiredstringFund Id
merchant_country_coderequiredstringMerchant Country Code
merchant_namerequiredstringMerchant Name
merchant_urlrequiredstringMerchant Url
rationalerequiredstringRationale
idempotency_keystring | nullOptional for direct callers and required when recognized vault-proxy context is present. Must be a non-empty string of at most 255 characters.
ramp_get_agent_card_funds

List funds that can be used for agent card payments. Returns eligible funds with available balance.

Parameters and full description

List funds that can be used for agent card payments. Returns eligible funds with available balance.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_pay_with_x402

Pay an x402 payment request from your business's stablecoin balance.

Parameters and full description

Pay an x402 payment request from your business's stablecoin balance. Fill the inputs from the merchant's 402 payment challenge. Returns a ready-to-send payment header to attach when retrying the original request.

ParameterTypeDescription
acceptedrequiredobjectExact chosen entry from the challenge's accepts array
rationalerequiredstringRationale
resourcerequiredobjectResource object from the merchant's 402 challenge
extensionsobject | nullExtensions
ramp_provision_x402_wallet

Provision your business's x402 wallet after the user explicitly confirms.

Parameters and full description

Provision your business's x402 wallet after the user explicitly confirms. Returns the same sign-ready Solana wallet on repeated calls. Do not call this tool until an owner or admin confirms that the wallet should be provisioned.

ParameterTypeDescription
confirmedrequiredbooleanConfirmed
rationalerequiredstringRationale
ramp_withdraw_x402_wallet

Withdraw the business's x402 wallet balance to a Ramp Checking Account.

Parameters and full description

Withdraw the business's x402 wallet balance to a Ramp Checking Account. Before calling, use ListBusinessAccounts to obtain the destination account UUID; never guess it. Confirm the exact destination account and USDC amount with the user before creating this irreversible transfer. MCP and CLI callers must provide an idempotency key. Only active Increase USD accounts are supported.

ParameterTypeDescription
amountrequirednumber | stringAmount
destination_wallet_account_uuidrequiredstringDestination Wallet Account Uuid
rationalerequiredstringRationale
idempotency_keystring | nullIdempotency Key

Analytics and AI spend

ramp_execute_analyst_query

Run read-only SQL for aggregate business analysis. First use the analyst catalog and read the domain docs for every table in the query; those docs define supported tables, columns, joins, and metric semantics.

Parameters and full description

Run read-only SQL for aggregate business analysis. First use the analyst catalog and read the domain docs for every table in the query; those docs define supported tables, columns, joins, and metric semantics.

ParameterTypeDescription
rationalerequiredstringRationale
sqlrequiredstringSql
artifact_instance_idstringArtifact Instance Id
ramp_get_ai_token_spend_aggregates

Aggregate AI token usage or estimated cost over a time window, grouped by caller-selected dimensions (provider, model, configuration, department, user, or API-key tag group).

Parameters and full description

Aggregate AI token usage or estimated cost over a time window, grouped by caller-selected dimensions (provider, model, configuration, department, user, or API-key tag group).

ParameterTypeDescription
end_atrequiredstringEnd At
metricrequiredstringMetric
rationalerequiredstringRationale
start_atrequiredstringStart At
configuration_idsarray | nullConfiguration Ids
department_uuidsarray | nullDepartment Uuids
group_byarray | nullGroup By
model_compute_tierarray | nullModel Compute Tier
model_context_windowarray | nullModel Context Window
model_familiesarray | nullModel Families
model_fine_tune_sourcearray | nullModel Fine Tune Source
model_speedarray | nullModel Speed
model_thinkingarray | nullModel Thinking
modelsarray | nullModels
providersarray | nullProviders
rollupstringTime bucketing. 'all' returns a single bucket per group; 'daily'/'weekly'/'monthly' return one row per bucket per group.
tag_definition_idstring | nullTag Definition Id
user_uuidsarray | nullUser Uuids
ramp_get_ai_token_spend_connections

Summarize connected AI providers (admin keys and OpenRouter/LiteLLM gateway connections). Use GetAiTokenSpendCurrentSpend for actual vendor spend and GetAiTokenSpendAggregates for estimated token usage and cost.

Parameters and full description

Summarize connected AI providers (admin keys and OpenRouter/LiteLLM gateway connections). Use GetAiTokenSpendCurrentSpend for actual vendor spend and GetAiTokenSpendAggregates for estimated token usage and cost.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_ai_token_spend_current_spend

Report the business's actual trailing-30-day Ramp spend on AI vendors (card, bill, and reimbursement spend) per provider. Requires transaction, reimbursement, or bill read access.

Parameters and full description

Report the business's actual trailing-30-day Ramp spend on AI vendors (card, bill, and reimbursement spend) per provider. Requires transaction, reimbursement, or bill read access.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_ai_token_spend_filter_options

List the dimensions and values available for AI-spend aggregate queries: providers, models, model families/facets, departments, and API-key tag groups.

Parameters and full description

List the dimensions and values available for AI-spend aggregate queries: providers, models, model families/facets, departments, and API-key tag groups.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_analyst_catalog

Discover available analyst tables and starter SQL for aggregate business analysis. Review the catalog before writing a query, then read domain docs for every table used.

Parameters and full description

Discover available analyst tables and starter SQL for aggregate business analysis. Review the catalog before writing a query, then read domain docs for every table used.

ParameterTypeDescription
rationalerequiredstringRationale
artifact_instance_idstringArtifact Instance Id
ramp_get_analyst_metric_metadata

Discover supported analyst metrics and starter SQL for aggregate business analysis.

Parameters and full description

Discover supported analyst metrics and starter SQL for aggregate business analysis.

ParameterTypeDescription
rationalerequiredstringRationale
artifact_instance_idstringArtifact Instance Id
ramp_get_analyst_spend_facts_domain_docs

Read domain documentation for analyst.spend_facts before using it in an analyst query.

Parameters and full description

Read domain documentation for analyst.spend_facts before using it in an analyst query.

ParameterTypeDescription
rationalerequiredstringRationale
artifact_instance_idstringArtifact Instance Id
ramp_get_analyst_table_domain_docs

Read domain documentation for an analyst table before using it in an analyst query.

Parameters and full description

Read domain documentation for an analyst table before using it in an analyst query.

ParameterTypeDescription
qualified_namerequiredstringSchema-qualified analyst table whose domain docs should be returned.
rationalerequiredstringRationale
artifact_instance_idstringArtifact Instance Id
ramp_get_my_ai_token_spend_aggregates

Aggregate the acting user's own AI token usage and estimated token cost over a time window, optionally grouped by provider and model.

Parameters and full description

Aggregate the acting user's own AI token usage and estimated token cost over a time window, optionally grouped by provider and model.

ParameterTypeDescription
end_atrequiredstringEnd At
rationalerequiredstringRationale
start_atrequiredstringStart At
group_byarray | nullGroup By
model_compute_tierarray | nullModel Compute Tier
model_context_windowarray | nullModel Context Window
model_familiesarray | nullModel Families
model_fine_tune_sourcearray | nullModel Fine Tune Source
model_speedarray | nullModel Speed
model_thinkingarray | nullModel Thinking
modelsarray | nullModels
providersarray | nullProviders
rollupstringTime bucketing. 'all' returns a single bucket per group; 'daily'/'weekly'/'monthly' return one row per bucket per group.

Approvals and review

ramp_approve_or_reject_bill

Approve or reject a submitted bill that is pending approval. The authenticated user must be the next required approver on the bill's approval chain. Rejection is additionally allowed for bill-pay admins as an override, even when they are not the next approver. Find bills awaiting the authenticated user's approval with get-bills-for-approval. Some bills require step-up verification that agents cannot complete; in that case the error includes a redirect_url that the human user must open in a browser to finish the action there. Approving advances the bill's approval chain, exactly as approving in the Ramp web app does: depending on the business's payment-release settings, a bill that becomes fully approved with payment details and a payment date already set may proceed to payment automatically. After an approval, the response reports the bill's resulting payment state: whether any of its payments has been initiated (payment_initiated — this includes earlier partial payments; a chain-completing approval may have just added one) and the earliest such payment date (payment_date) — so you can inform the user. This tool never schedules payments or edits payment details; payment scheduling and release are managed in the Ramp web app — hand the user the bill_url returned on success.

Parameters and full description

Approve or reject a submitted bill that is pending approval. The authenticated user must be the next required approver on the bill's approval chain. Rejection is additionally allowed for bill-pay admins as an override, even when they are not the next approver. Find bills awaiting the authenticated user's approval with get-bills-for-approval. Some bills require step-up verification that agents cannot complete; in that case the error includes a redirect_url that the human user must open in a browser to finish the action there. Approving advances the bill's approval chain, exactly as approving in the Ramp web app does: depending on the business's payment-release settings, a bill that becomes fully approved with payment details and a payment date already set may proceed to payment automatically. After an approval, the response reports the bill's resulting payment state: whether any of its payments has been initiated (payment_initiated — this includes earlier partial payments; a chain-completing approval may have just added one) and the earliest such payment date (payment_date) — so you can inform the user. This tool never schedules payments or edits payment details; payment scheduling and release are managed in the Ramp web app — hand the user the bill_url returned on success.

ParameterTypeDescription
action_typerequiredstringAction Type
bill_idrequiredstringBill Id
rationalerequiredstringRationale
reasonstring | nullReason
ramp_approve_or_reject_reimbursement

Approve or reject an employee reimbursement request for an out-of-pocket expense.

Parameters and full description

Approve or reject an employee reimbursement request for an out-of-pocket expense. Use this tool when the user wants to approve or reject a reimbursement. Reimbursements are employee-submitted requests for reimbursement of out-of-pocket expenses. Common usage patterns: "approve this reimbursement", "reject the expense", "yes, reimburse them", "no, don't reimburse this". This tool is specifically for employee reimbursements and is NOT for approving/rejecting card transactions or unified requests (spend allocations, purchase orders).

ParameterTypeDescription
actionrequiredstringThe action to take on the reimbursement: approve or reject.
rationalerequiredstringRationale
reimbursement_idrequiredstringReimbursement Id
thoughtsstring | nullThoughts
user_reasonstring | nullUser Reason
ramp_approve_or_reject_request

Approve or reject a pending unified request for spend allocation (fund), purchase order, or procurement approval.

Parameters and full description

Approve or reject a pending unified request for spend allocation (fund), purchase order, or procurement approval. Use this tool when a user wants to approve or reject a specific request they have identified or referenced. Common usage patterns: "approve this request", "reject this request", "accept the request", "deny this", "authorize this", "yes approve it", "decline this request". This tool is specifically for unified requests (spend allocations, purchase orders, procurement approvals) and is NOT for approving expenses like corporate card transactions or reimbursements. The user must have proper approval authority for the request.

ParameterTypeDescription
actionrequiredstringThe action to perform: APPROVE or REJECT
rationalerequiredstringRationale
thoughtsrequiredstringThoughts
unified_request_idrequiredstring | nullUnified Request Id
ramp_approve_or_reject_transaction

Approve or reject a transaction awaiting your review.

Parameters and full description

Approve or reject a transaction awaiting your review. Use this tool when the user wants to approve a transaction, send it back for revisions, or require the cardholder to repay the full amount. The acting user must have the proper approval authority for the transaction. If the user provides a written justification (e.g., “reject this because the receipt is missing”), pass that verbatim via `user_reason`—do not invent your own rationale.

ParameterTypeDescription
actionrequiredstringAction to perform: APPROVE, REJECT_AND_REQUEST_CHANGES (send back to cardholder with requested revisions), or REJECT_AND_REQUEST_FULL_REPAYMENT (require employee repayment).
rationalerequiredstringRationale
thoughtsrequiredstringThoughts
transaction_idrequiredstringTransaction Id
user_reasonstring | nullUser Reason
ramp_get_bills_for_approval

Get bills that are pending approval from the current user.

Parameters and full description

Get bills that are pending approval from the current user. Use this tool when the user wants to see bills they need to approve or asks about pending approvals. This returns only bills where the authenticated user is the next required approver in the approval chain. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
rationalerequiredstringRationale
limitintegerLimit
page_cursorstring | nullPage Cursor
ramp_get_reimbursements_for_approval

Get employee reimbursements pending approval by the current user. Includes policy assessment data and recommended actions.

Parameters and full description

Get employee reimbursements pending approval by the current user. Includes policy assessment data and recommended actions.

ParameterTypeDescription
rationalerequiredstringRationale
limitintegerLimit
ramp_get_requests_to_review

Get requests that require the current user's review and approval.

Parameters and full description

Get requests that require the current user's review and approval. This is the approval-queue wrapper over SearchUnifiedRequests. Use it when the user is specifically asking what they need to review or approve right now. For broader lookup by vendor, owner, status, or request name, prefer SearchUnifiedRequests instead. Only handles lookups, does not take any action.

ParameterTypeDescription
rationalerequiredstringRationale
thoughtsrequiredstringThoughts
page_sizeintegerPage Size
request_typesarray | nullRequest Types
startstring | nullStart
ramp_remind_bill_approvers

Remind next approvers for bills awaiting approval.

Parameters and full description

Remind next approvers for bills awaiting approval. Use this tool when the user wants to nudge approvers for specific bill UUIDs. The bills should be awaiting approval; use get-bills-for-approval first if the user has not identified the bill UUIDs.

ParameterTypeDescription
bill_uuidsrequiredarrayBill Uuids
rationalerequiredstringRationale

Banking and treasury

ramp_account_numbers

List agent account numbers

Parameters and full description

List agent account numbers

ParameterTypeDescription
rationalerequiredstringWhy this MCP tool call is needed.
page_sizeinteger | nullThe number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.
startstring | nullThe ID of the last entity of the previous page, used for pagination to get the next page.
ramp_accounts

List bank accounts

Parameters and full description

List bank accounts

ParameterTypeDescription
rationalerequiredstringWhy this MCP tool call is needed.
connection_providerstring | nullFilter bank accounts by connection provider.
page_sizeinteger | nullThe number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.
startstring | nullThe ID of the last entity of the previous page, used for pagination to get the next page.
ramp_create

Create a manually connected bank account

Parameters and full description

Create a manually connected bank account

ParameterTypeDescription
account_numberrequiredstringBank account number.
account_subtyperequiredstringBank account subtype.
rationalerequiredstringWhy this MCP tool call is needed.
routing_numberrequiredstringABA routing number used for ACH transfers.
account_namestring | nullOptional display name for the bank account.
idempotency_keystring | nullUnique idempotency key generated by the client. Must be a non-empty string of at most 255 characters.
wire_detailsobject | nullOptional wire-transfer details for the account.
ramp_get_account_balance_history

Get daily balance history for a specific Ramp Checking Account.

Parameters and full description

Get daily balance history for a specific Ramp Checking Account. Use when the user asks about balance history for a specific account, savings account trend, checking account balance over time, or the balance trend for a specific Ramp Checking Account. This tool only supports Ramp Checking Accounts, not Investment Accounts or Managed Portfolios.

ParameterTypeDescription
account_uuidrequiredstringAccount Uuid
rationalerequiredstringRationale
end_datestring | nullEnd Date
start_datestring | nullStart Date
ramp_get_investment_account_balance

Get the balance of investment accounts for the business.

Parameters and full description

Get the balance of investment accounts for the business. Use this when the user asks about investment account balances, brokerage cash, or the current balance of Ramp investment accounts. Returns all investment accounts the business has, along with balances, status, yield, and earnings.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_managed_portfolio_account_balance

Get the balance of managed portfolio accounts for the business.

Parameters and full description

Get the balance of managed portfolio accounts for the business. Use this when the user asks about managed portfolio balances, managed portfolio cash, or the current balance of Ramp managed portfolio accounts. Returns all managed portfolio accounts the business has, along with balances, market value, status, yield, and earnings.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_ramp_business_account_balance

Get the balance of Ramp Checking Accounts for the business.

Parameters and full description

Get the balance of Ramp Checking Accounts for the business. Returns the available balance, statement balance, and other details for all Ramp Checking Accounts associated with the user's business. This includes yield/earnings information and account status. This tool is intentionally limited to the stable user-facing fields for Ramp Checking Accounts. Do not infer deprecated pending balances or current month accrued yield values from other treasury payloads when responding to the user.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_treasury_balance_history

Get daily balance history across all Treasury accounts for a date range.

Parameters and full description

Get daily balance history across all Treasury accounts for a date range.

ParameterTypeDescription
end_daterequiredstringEnd Date
rationalerequiredstringRationale
start_daterequiredstringStart Date
ramp_list_business_accounts

List all Ramp Checking Accounts (wallet accounts) for the user's business.

Parameters and full description

List all Ramp Checking Accounts (wallet accounts) for the user's business. Returns account details including balances, currency, yield rate, and status. Use this tool when the user asks about their checking accounts, wallet accounts, or wants to see an overview of their Ramp Checking Accounts.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_list_treasury_accounts

List all Treasury accounts (Ramp Checking Accounts, Investment Accounts, Managed Portfolios).

Parameters and full description

List all Treasury accounts (Ramp Checking Accounts, Investment Accounts, Managed Portfolios).

ParameterTypeDescription
rationalerequiredstringRationale
ramp_list_wallet_transfers

List wallet transfers for the user's business Ramp Checking Accounts.

Parameters and full description

List wallet transfers for the user's business Ramp Checking Accounts. Returns a list of transfers including deposits, withdrawals, and other transactions with details like amount, status, and dates.

ParameterTypeDescription
rationalerequiredstringRationale
from_datestring | nullFrom Date
page_sizeintegerPage Size
to_datestring | nullTo Date
ramp_request_funds

Request funds for a banking account

Parameters and full description

Request funds for a banking account

ParameterTypeDescription
amountrequiredobjectAmount to request in minor currency units
banking_account_idrequiredstringUnique identifier of the banking account.
external_bank_account_idrequiredstringExternal bank account to request funds from
rationalerequiredstringWhy this MCP tool call is needed.
agent_account_number_idstring | nullAgent account number to receive the funds. If omitted, the banking account's primary account number is used
idempotency_keystring | nullUnique idempotency key generated by the client. Must be a non-empty string of at most 255 characters.
memostring | nullOptional reason for the funding request

Bills and vendor payments

ramp_create_draft_bill

Create a new draft bill for an existing vendor. Use search-vendors to resolve a vendor name to vendor_uuid first. This creates only a draft: it does not submit the bill, start approvals, schedule it, release it, or initiate a payment. Use update-draft-bill for later edits and submit-draft-bill only after the user confirms the completed draft is ready.

Parameters and full description

Create a new draft bill for an existing vendor. Use search-vendors to resolve a vendor name to vendor_uuid first. This creates only a draft: it does not submit the bill, start approvals, schedule it, release it, or initiate a payment. Use update-draft-bill for later edits and submit-draft-bill only after the user confirms the completed draft is ready.

ParameterTypeDescription
draft_billrequiredobjectDraft bill fields to set at creation. Do not include vendor fields; vendor_uuid is the only vendor input.
rationalerequiredstringRationale
vendor_uuidrequiredstringUUID of the existing vendor/payee for this draft bill.
idempotency_keystring | nullUnique idempotency key generated by the client. Must be a non-empty string of at most 255 characters.
ramp_create_pending_payee

Create a pending vendor/payee record.

Parameters and full description

Create a pending vendor/payee record. Call SearchVendors first with include_draft=true. Reuse a suitable existing vendor, including a pending vendor, instead of creating a duplicate. Never create a duplicate to work around an existing vendor whose status is INACTIVE — an admin must re-enable that vendor instead.

ParameterTypeDescription
namerequiredstringName
rationalerequiredstringRationale
contactobject | nullVendor contact
descriptionstring | nullDescription
websitestring | nullWebsite
ramp_get_bill_amount_summary

Get aggregate dollar amounts for bills matching the given filters.

Parameters and full description

Get aggregate dollar amounts for bills matching the given filters. Examples: total unpaid amount, total pending amount. Use when users ask things like "How much do we owe in bills?" or "What's our total outstanding bill amount?". Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
rationalerequiredstringRationale
due_date_fromstring | nullDue Date From
due_date_tostring | nullDue Date To
max_amountnumber | nullMax Amount
min_amountnumber | nullMin Amount
payment_statusstring | nullPayment Status
vendor_namestring | nullVendor Name
ramp_get_bill_comments

Retrieve comments from a bill's comment thread.

Parameters and full description

Retrieve comments from a bill's comment thread. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
bill_idrequiredstringBill Id
rationalerequiredstringRationale
ramp_get_bill_details

Get comprehensive details about a specific bill including payment status, approval status, and all metadata.

Parameters and full description

Get comprehensive details about a specific bill including payment status, approval status, and all metadata. This tool retrieves submitted bills only. For draft bills that have not yet been submitted, use get-draft-bill-details instead. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
bill_idrequiredstringBill Id
rationalerequiredstringRationale
ramp_get_bill_history

Retrieve the full modification and approval history of a bill, including status changes, approval actions, and creation details.

Parameters and full description

Retrieve the full modification and approval history of a bill, including status changes, approval actions, and creation details. Returns a chronological event log — creation, submission, each approval-chain action with actor and timestamp, and deletion. Use it to answer questions like "who approved this bill?". Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
bill_idrequiredstringBill Id
rationalerequiredstringRationale
ramp_get_bill_invoices

Retrieve invoice file attachments (PDFs/images) for a submitted bill.

Parameters and full description

Retrieve invoice file attachments (PDFs/images) for a submitted bill. Returns the source documents backing the bill: for each attachment, the filename, type, and a time-limited download URL (the URL expires after about 3 days). Draft bills are not supported: draft attachments are not retrievable through agent tools. get-draft-bill-details returns draft metadata and a link to the draft page in the Ramp web app, where attachments can be viewed. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
bill_idrequiredstringBill Id
rationalerequiredstringRationale
ramp_get_bill_metrics

Returns the count of bills matching specified filters. Use this to answer questions like "How many bills are pending approval?" or "How many overdue bills do we have?".

Parameters and full description

Returns the count of bills matching specified filters. Use this to answer questions like "How many bills are pending approval?" or "How many overdue bills do we have?". Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
rationalerequiredstringRationale
approval_statusstring | nullApproval Status
from_due_datestring | nullFrom Due Date
is_draftboolean | nullIs Draft
payment_statusstring | nullPayment Status
status_summarystring | nullStatus Summary
to_due_datestring | nullTo Due Date
vendor_namestring | nullVendor Name
ramp_get_bill_status

Get the current payment and approval status of a specific bill, including any required next actions.

Parameters and full description

Get the current payment and approval status of a specific bill, including any required next actions. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
bill_idrequiredstringBill Id
rationalerequiredstringRationale
ramp_get_draft_bill_details

Get rich details for a draft bill.

Parameters and full description

Get rich details for a draft bill. Returns compact draft-bill metadata by default. When requested, it also returns the draft's full editable field set inline, in the shape accepted by the draft update tool. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
bill_idrequiredstringBill Id
rationalerequiredstringRationale
return_line_itemsbooleanReturn Line Items
ramp_get_recurring_bill

Retrieve details of a recurring bill template including vendor, amount, recurrence schedule, and next payment date.

Parameters and full description

Retrieve details of a recurring bill template including vendor, amount, recurrence schedule, and next payment date. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
rationalerequiredstringRationale
recurring_bill_idrequiredstringRecurring Bill Id
ramp_get_vendor_agreement

Retrieve details for a specific vendor agreement/contract by UUID. Returns contract metadata, terms, line items, contract owners, documents, linked spend requests, and renewal history.

Parameters and full description

Retrieve details for a specific vendor agreement/contract by UUID. Returns contract metadata, terms, line items, contract owners, documents, linked spend requests, and renewal history.

ParameterTypeDescription
payee_agreement_uuidrequiredstringPayee Agreement Uuid
rationalerequiredstringRationale
ramp_get_vendor_document_bulk_status

Get bulk vendor document upload progress and current document review state.

Parameters and full description

Get bulk vendor document upload progress and current document review state. Use this after `BulkUploadVendorDocuments` to inspect the batch job status, understand whether any documents still need manual review, and inspect the current document/vendor matching and extracted tax details.

ParameterTypeDescription
batch_idrequiredstringBatch Id
rationalerequiredstringRationale
is_w_documentboolean | nullIs W Document
ramp_list_bills

List and filter bills with optional search, pagination, and status filters.

Parameters and full description

List and filter bills with optional search, pagination, and status filters. Returns bills for the current user's business. When called with no parameters, returns the most recent bills. Supports optional text search across vendor name, invoice number, and payment ID. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
rationalerequiredstringRationale
include_paidbooleanInclude Paid
limitintegerLimit
page_cursorstring | nullPage Cursor
querystring | nullQuery
ramp_list_vendor_agreements

List and filter vendor agreements/contracts across the business. Returns agreement details including dates, values, renewal status, line items, and days remaining. All filters are optional — omit all to list all agreements, or combine filters to narrow results.

Parameters and full description

List and filter vendor agreements/contracts across the business. Returns agreement details including dates, values, renewal status, line items, and days remaining. All filters are optional — omit all to list all agreements, or combine filters to narrow results.

ParameterTypeDescription
rationalerequiredstringRationale
auto_renewsboolean | nullAuto Renews
contract_owner_idsarray | nullContract Owner Ids
department_idsarray | nullDepartment Ids
has_end_dateboolean | nullHas End Date
include_archivedbooleanInclude Archived
is_activeboolean | nullIs Active
is_up_for_renewalboolean | nullIs Up For Renewal
limitintegerLimit
max_days_remaininginteger | nullMax Days Remaining
max_end_datestring | nullMax End Date
max_last_date_to_terminatestring | nullMax Last Date To Terminate
max_start_datestring | nullMax Start Date
max_total_valuenumber | string | nullMax Total Value
min_days_remaininginteger | nullMin Days Remaining
min_end_datestring | nullMin End Date
min_last_date_to_terminatestring | nullMin Last Date To Terminate
min_start_datestring | nullMin Start Date
min_total_valuenumber | string | nullMin Total Value
payee_agreement_idsarray | nullPayee Agreement Ids
payee_owner_idsarray | nullPayee Owner Ids
payee_uuidstring | nullPayee Uuid
renewal_statusarray | nullRenewal Status
sort_ascendingboolean | nullSort Ascending
sort_bystring | nullSort results by: TOTAL_AMOUNT, NUM_DAYS_REMAINING, or END_DATE. Default: NUM_DAYS_REMAINING ascending.
vendor_namestring | nullVendor Name
ramp_search_bills

Search for bills using natural language queries like vendor names, amounts, or invoice numbers.

Parameters and full description

Search for bills using natural language queries like vendor names, amounts, or invoice numbers. Submitted and active draft bills may both be returned unless include_drafts=False. To look up only a draft bill, use get-draft-bill-details instead. Check each result: when is_draft is true, follow up with get-draft-bill-details; otherwise use get-bill-details. Bills in Ramp have two stages: draft bills (created/uploaded but not yet submitted; use the draft-bill tools) and bills (submitted; they move through approval, then scheduling, then payment). A draft keeps the same ID after submission, but draft-only tools stop working on it once submitted.

ParameterTypeDescription
rationalerequiredstringRationale
accrual_year_monthstring | nullAccrual Year Month
from_due_datestring | nullFrom Due Date
from_payment_datestring | nullFrom Payment Date
include_draftsboolean | nullInclude Drafts
include_paidboolean | nullInclude Paid
limitintegerLimit
page_cursorstring | nullPage Cursor
querystringQuery
status_summariesarray | nullStatus Summaries
to_due_datestring | nullTo Due Date
to_payment_datestring | nullTo Payment Date
ramp_search_vendors

Search for vendors (payees) within the business by name.

Parameters and full description

Search for vendors (payees) within the business by name. This tool searches for vendor records using both fuzzy SQL matching (trigram similarity + substring) and semantic (vector) search. Use this to find vendor IDs when you need to: - Look up a vendor by partial name - Find the correct vendor UUID for further analysis - Discover vendors similar to a given name The search is scoped to the current business context.

ParameterTypeDescription
rationalerequiredstringRationale
include_draftbooleanInclude Draft
is_1099_tracking_enabledboolean | nullIs 1099 Tracking Enabled
limitintegerLimit
search_termstring | nullSearch Term
tax_1099_yearinteger | nullTax 1099 Year
ramp_submit_draft_bill

Submit a ready draft bill for approval. The draft must be complete (vendor, amount, payment method, and vendor contact set) - read it with get-draft-bill-details first and fill gaps with update-draft-bill. Submission is accepted asynchronously: the bill keeps the same ID as the draft, so verify completion with get-bill-status using the same ID. Once created, the bill enters its approval chain automatically. Some submissions require identity verification that agents cannot complete; in that case the error includes a redirect_url that the human user must open in a browser to finish submitting in the Ramp web app. Payment scheduling and release are done in the Ramp web app, not through tools.

Parameters and full description

Submit a ready draft bill for approval. The draft must be complete (vendor, amount, payment method, and vendor contact set) - read it with get-draft-bill-details first and fill gaps with update-draft-bill. Submission is accepted asynchronously: the bill keeps the same ID as the draft, so verify completion with get-bill-status using the same ID. Once created, the bill enters its approval chain automatically. Some submissions require identity verification that agents cannot complete; in that case the error includes a redirect_url that the human user must open in a browser to finish submitting in the Ramp web app. Payment scheduling and release are done in the Ramp web app, not through tools. Submit only when the user has reviewed the draft and their current message clearly asks to submit that specific draft. A request to create, edit, or review a draft is not authorization to submit it.

ParameterTypeDescription
draft_bill_idrequiredstringUUID of the draft bill to submit. Find it with search-bills (DRAFT_* statuses) or get-draft-bill-details.
rationalerequiredstringRationale
ramp_update_draft_bill

Update a draft bill: its fields, line items, accounting category coding, and draft payment details.

Parameters and full description

Update a draft bill: its fields, line items, accounting category coding, and draft payment details. Call get-draft-bill-details first and echo its `version` back on this call; if the draft changed in between, the update is rejected and the error includes the current version to retry with. Omitted fields are left unchanged; set a nullable field to null only to intentionally clear it. `provisional_bill_id` takes the draft bill's UUID. Tracking-category and option ids may be passed as UUIDs from get-tracking-categories / get-tracking-category-options. Draft bills that have already been submitted can no longer be edited. Draft bills with retainage (withholding) are not supported by this tool.

ParameterTypeDescription
provisional_billrequiredobjectThe draft bill fields to change (same shape as `editable_payload` returned by get-draft-bill-details). Omitted fields remain unchanged; set a nullable field to null only when you intentionally want to clear it. Tracking-category and option ids may be passed as UUIDs (from get-tracking-categories / get-tracking-category-options) — they are resolved automatically.
provisional_bill_idrequiredstringProvisional Bill Id
rationalerequiredstringRationale
versionrequiredstringVersion
vendor_paymentsarrayVendor Payments

Cards and funds

ramp_activate_card

Activate a card by its last four digits.

Parameters and full description

Activate a card by its last four digits. Activates an unactivated card for the user. If the card is a physical card awaiting delivery confirmation, call this tool first without confirm_delivery to detect the state, then call again with confirm_delivery=True after the user confirms the physical card has arrived.

ParameterTypeDescription
last_fourrequiredstringLast Four
rationalerequiredstringRationale
confirm_deliverybooleanConfirm Delivery
ramp_get_funds

Retrieve funds (cards or budgets) and their balances, restrictions, locks, owners,

Parameters and full description

Retrieve funds (cards or budgets) and their balances, restrictions, locks, owners, or permitted spend. For a named person's funds, resolve their UUID with GetOrgChart and pass user_uuids. For the current user's funds, use MY_FUNDS. Search by fund name with search_by_fund_display_name or look up a known UUID with fund_uuid. When balance_info is returned, treat its remaining balance as authoritative for cleared charges and pending authorizations. Do not subtract those amounts again. Never infer that a booking is included merely because it is confirmed: a postpaid booking with no charge or pending authorization is a future charge and has not yet reduced the remaining balance.

ParameterTypeDescription
rationalerequiredstringRationale
agent_card_eligibleboolean | nullAgent Card Eligible
cursorstring | nullCursor
for_transaction_idstring | nullFor Transaction Id
fund_uuidstring | nullFund Uuid
funds_to_retrievestring | nullScope of funds to retrieve. Use MY_FUNDS ONLY when the user explicitly asks about 'my funds'. Use ALL_FUNDS for general searches (e.g., searching by fund name) or when no specific owner is mentioned. NEVER use this parameter when the user mentions a specific person - use user_uuids instead.
include_balancebooleanInclude Balance
include_lock_infobooleanInclude Lock Info
include_membersbooleanInclude Members
include_restrictionsbooleanInclude Restrictions
is_sharedboolean | nullIs Shared
page_sizeintegerPage Size
search_by_fund_display_namestring | nullSearch By Fund Display Name
spend_intent_uuidsarray | nullSpend Intent Uuids
statestring | nullFilter funds by state. Use ACTIVE to show only active funds, TERMINATED for terminated funds, or ARCHIVED for archived funds. If not provided, returns funds in all states.
user_uuidsarray | nullUser Uuids
ramp_issue_one_off_funds

Issue one-off funds (spend allocations) directly, bypassing approval flows.

Parameters and full description

Issue one-off funds (spend allocations) directly, bypassing approval flows. Use this tool when an admin wants to create new funds for one or more users with a specific amount, interval, and optional restrictions. This creates virtual-card-only spend allocations outside of spend programs. The acting user must have the SPEND_ISSUE_SPEND_BYPASS_APPROVAL permission.

ParameterTypeDescription
amountrequiredstringAmount
display_namerequiredstringDisplay Name
rationalerequiredstringRationale
user_idsrequiredarrayUser Ids
categories_blacklistarray | nullCategories Blacklist
categories_whitelistarray | nullCategories Whitelist
default_member_limit_amountstring | nullDefault Member Limit Amount
department_idsarray | nullDepartment Ids
dynamic_user_group_idsarray | nullDynamic User Group Ids
intervalstringInterval
is_shareablebooleanIs Shareable
location_idsarray | nullLocation Ids
lock_datestring | nullLock Date
member_idsarray | nullMember Ids
user_custom_field_idsarray | nullUser Custom Field Ids
vendor_blacklistarray | nullVendor Blacklist
vendor_whitelistarray | nullVendor Whitelist
ramp_limit_increase

Increase the spending limit on a fund (spend allocation) or card. Supports temporary (resets at the next interval) and permanent increases.

Parameters and full description

Increase the spending limit on a fund (spend allocation) or card. Supports temporary (resets at the next interval) and permanent increases. Call only when the user's current message clearly requests an increase for the specific fund or card and specifies temporary or permanent. A declined transaction, budget question, or currency correction is not authorization to increase a limit. Do not infer or default the increase type.

ParameterTypeDescription
amountrequirednumber | stringAmount
rationalerequiredstringRationale
actionstringAction
card_idstring | nullCard Id
increase_typestringIncrease Type
spend_allocation_idstring | nullSpend Allocation Id
user_confirmed_increase_typebooleanUser Confirmed Increase Type
user_confirmed_limit_increasebooleanUser Confirmed Limit Increase
ramp_list_cards

List non-terminated cards for the current user or a visible target cardholder, including activation status, lock state, and shipping metadata.

Parameters and full description

List non-terminated cards for the current user or a visible target cardholder, including activation status, lock state, and shipping metadata. IMPORTANT: For the current user's unlock request, call this tool first to check spendability and locks. If cardholder_user_uuid targets another user, never open the acting user's feed. For locks, follow remediation_action. Use LockOrUnlockCard only when can_lock_or_unlock=true. GET_ATTENTION_FEED means resolve the task there, not through LockOrUnlockCard; re-list until blocking_task_count=0 and is_spendable=true. Do not use GetUserFunds for card unlock requests; funds and cards are different.

ParameterTypeDescription
rationalerequiredstringRationale
cardholder_user_uuidstring | nullOptional user UUID for the cardholder whose cards should be listed. Provide this when an admin or manager asks about another employee's cards. Omit it to list the acting user's own cards.
ramp_lock_or_unlock_card

Lock or unlock a card the acting user is authorized to manage. Locking prevents all transactions on it until unlocked.

Parameters and full description

Lock or unlock a card the acting user is authorized to manage. Locking prevents all transactions on it until unlocked. Lock only when the user's current message clearly requests locking the specific card. Do not infer a lock request from suspicious activity. Unlocking does not require additional confirmation. If this returns FraudLockDetected, use UnlockFraudLockedCard instead.

ParameterTypeDescription
actionrequiredstringAction
idrequiredstringId
rationalerequiredstringRationale
ramp_lock_or_unlock_spend_allocation

Lock or unlock a fund (spend allocation) at the fund level, affecting all members.

Parameters and full description

Lock or unlock a fund (spend allocation) at the fund level, affecting all members. Lock only when the user's current message clearly requests locking the specific fund. Do not infer a fund lock from a declined transaction or budget discussion. Unlocking does not require additional confirmation.

ParameterTypeDescription
actionrequiredstringAction
idrequiredstringId
rationalerequiredstringRationale
ramp_lock_or_unlock_spend_allocation_member

Lock or unlock a specific member's access to a fund (spend allocation).

Parameters and full description

Lock or unlock a specific member's access to a fund (spend allocation). Lock only when the user's current message clearly requests locking the specific member's access to the specific fund. Do not infer a member lock from a declined transaction or suspicious activity. Unlocking does not require additional confirmation. If this returns FraudLockDetected, use UnlockFraudLockedCard instead.

ParameterTypeDescription
actionrequiredstringAction
idrequiredstringId
member_idrequiredstringMember Id
rationalerequiredstringRationale
ramp_unlock_fraud_locked_card

Unlock a card that was locked due to a suspicious transaction. Requires the user to confirm they recognize the flagged transaction.

Parameters and full description

Unlock a card that was locked due to a suspicious transaction. Requires the user to confirm they recognize the flagged transaction.

ParameterTypeDescription
idrequiredstringId
rationalerequiredstringRationale
user_confirmed_fraud_whitelistbooleanUser Confirmed Fraud Whitelist
ramp_update_category_restrictions

Update spending category restrictions (whitelist or blacklist) on a single fund. Manages spend types (e.g., Restaurants, Travel), not individual merchants.

Parameters and full description

Update spending category restrictions (whitelist or blacklist) on a single fund. Manages spend types (e.g., Restaurants, Travel), not individual merchants.

ParameterTypeDescription
actionrequiredstringThe action to perform: 'add_to_whitelist' (restrict to only these categories), 'remove_from_whitelist', 'add_to_blacklist' (block these categories), or 'remove_from_blacklist'.
category_idsrequiredarrayCategory Ids
rationalerequiredstringRationale
spend_allocation_idrequiredstringSpend Allocation Id
ramp_update_merchant_restrictions

Update merchant restrictions (whitelist or blacklist) on a fund (spend allocation).

Parameters and full description

Update merchant restrictions (whitelist or blacklist) on a fund (spend allocation). - Add or remove merchants from the allowed merchants list (whitelist) - Add or remove merchants from the blocked merchants list (blacklist) Use this when a user wants to: - Allow specific merchants on a fund (add to whitelist) - Block specific merchants on a fund (add to blacklist) - Remove merchants from the allowed or blocked lists

ParameterTypeDescription
actionrequiredstringWhether to add or remove merchants from the list.
merchant_uuidsrequiredarrayMerchant Uuids
rationalerequiredstringRationale
restriction_typerequiredstringWhether to modify the allowed merchants (whitelist) or blocked merchants (blacklist).
spend_allocation_idrequiredstringSpend Allocation Id

Other

ramp_get_bookings

Retrieve flight, hotel, and car rental booking summaries for the user. Returns confirmed bookings and pending requests, with unsuccessful requests available via include_failed; check the status field and call GetBookingDetails for one entry's detailed state.

Parameters and full description

Retrieve flight, hotel, and car rental booking summaries for the user. Returns confirmed bookings and pending requests, with unsuccessful requests available via include_failed; check the status field and call GetBookingDetails for one entry's detailed state.

ParameterTypeDescription
rationalerequiredstringRationale
include_carsbooleanInclude Cars
include_failedbooleanInclude Failed
include_flightsbooleanInclude Flights
include_hotelsbooleanInclude Hotels
include_pastbooleanInclude Past
limitintegerLimit
traveler_user_idstring | nullTraveler User Id
verification_modebooleanVerification Mode
ramp_get_decline_explanation

Get a detailed explanation of why a card transaction was declined. Returns the reason, remediation actions, user notification, and transaction details. Only valid for already-declined transactions.

Parameters and full description

Get a detailed explanation of why a card transaction was declined. Returns the reason, remediation actions, user notification, and transaction details. Only valid for already-declined transactions.

ParameterTypeDescription
rationalerequiredstringRationale
transaction_uuidrequiredstringTransaction Uuid
ramp_get_office_locations

Retrieve the company's office locations and addresses. Use this to find office addresses when searching for hotels near an office or determining travel destinations.

Parameters and full description

Retrieve the company's office locations and addresses. Use this to find office addresses when searching for hotels near an office or determining travel destinations. The two shapes are complementary: ``office_locations`` has coordinates but no street address, and ``company_address`` has a street address but no coordinates.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_user_trips

Fetch trips for the acting user with optional filters.

Parameters and full description

Fetch trips for the acting user with optional filters.

ParameterTypeDescription
rationalerequiredstringRationale
cursorstring | nullCursor
page_sizeinteger | nullPage Size
statusstring | nullStatus
ramp_list

List merchants

Parameters and full description

List merchants

ParameterTypeDescription
rationalerequiredstringWhy this MCP tool call is needed.
merchant_namestring | nullFilter merchants by a case-sensitive display name prefix.
merchant_urlstring | nullFilter merchants by URL or domain after normalization.
page_sizeinteger | nullThe number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.
startstring | nullThe ID of the last entity of the previous page, used for pagination to get the next page.
transaction_from_datestring | nullFilter merchants by transactions occurring (`user_transaction_time`) on or after this date
transaction_to_datestring | nullFilter merchants by transactions occurring (`user_transaction_time`) on or before this date
ramp_search_flights

Search for flights and return policy-tagged offers ready to quote. Before first use in a conversation, load and follow the ramp-book-flight skill when available.

Parameters and full description

Search for flights and return policy-tagged offers ready to quote. Before first use in a conversation, load and follow the ramp-book-flight skill when available. Tell the tool what to search (route + dates), or give it a job_id - never both. The default call blocks for ranked, policy-tagged offers; set wait_for_results=false only to start asynchronously and receive a job_id immediately instead, then use the same job_id on a later call to retrieve the final results. A call with job_id reads cached results and never starts another provider search. Use job_id alone to read the first page, add cursor to read the next page, add preferences to change the filtered or ranked view, or add sort_key to change its order; omit cursor when making either change so the new view starts at its first page. For a round trip, start the search with return_date. The first response contains OUTBOUND offers with is_round_trip=true and round-trip totals. Choose an outbound offer, then call with its job_id and outbound_offer_id to get matching RETURN offers. The chosen return offer's id identifies the complete outbound-and-return itinerary for booking. To filter return offers (e.g. by airline), pass the same job_id and outbound_offer_id with the new preference - do not start a new search, which discards the selected outbound flight and reruns the entire provider query. A completed outbound response includes web_search_url for the cached search in Ramp Travel. Fare options are nested under their flight, and a nested fare option id can be selected for return offers. Search preferences are cabin_class, airlines, max_stops, only_split_tickets, preferred_departure_time_window, preferred_arrival_time_window, and avoid_red_eye_flights; omitted preferences retain their prior values, and applied_preferences reports what each response used. Do NOT use this tool to change, modify, cancel, or rebook an existing booking.

ParameterTypeDescription
rationalerequiredstringRationale
airlinesarray | nullAirlines
arrivalstring | nullArrival
avoid_red_eye_flightsboolean | nullAvoid Red Eye Flights
cabin_classstring | array | nullCabin Class
clear_preferencesarray | nullClear Preferences
cursorstring | nullCursor
departurestring | nullDeparture
departure_datestring | nullDeparture Date
include_fare_optionsbooleanInclude Fare Options
job_idstring | nullJob Id
limitintegerLimit
max_stopsinteger | nullMax Stops
only_split_ticketsboolean | nullOnly Split Tickets
outbound_offer_idstring | nullOutbound Offer Id
preferred_arrival_time_windowstring | nullCurrent-leg arrival time preference. Use only when the user asks for a broad window like morning, afternoon, or evening. On a round-trip outbound_offer_id read, this is cached and applied only to return offers.
preferred_departure_time_windowstring | nullCurrent-leg departure time preference. Use only when the user asks for a broad window like morning, afternoon, or evening. On a round-trip outbound_offer_id read, this is cached and applied only to return offers.
requested_weekdaystring | nullThe weekday the traveler asked to depart, when they gave a relative day like 'Sunday' or 'next Friday'. Pass it whenever known; the search is rejected if departure_date does not fall on this weekday, catching date-resolution mistakes before results are shown. When the traveler gave only a relative day, ALWAYS confirm the resolved date with them using a server-formatted date string from the results (e.g. an offer's departure_date, 'Sun, Apr 5, 2026') exactly as returned; never pair a weekday with a date yourself.
return_datestring | nullReturn Date
sort_keystring | nullResult ordering, same keys as the flight search UI/REST API (e.g. LOWEST_TOTAL_AMOUNT, SHORTEST_DURATION). Defaults to WEIGHTED_SCORE. On a job_id read, re-sorts the cached results; to page the re-sorted view, re-send the same sort_key with the returned next_cursor.
traveler_user_idstring | nullTraveler User Id
trip_idstring | nullTrip Id
wait_for_resultsbooleanWait For Results
ramp_search_merchants

Search for merchants by name. Returns matching merchant IDs, UUIDs, names, categories, and domains.

Parameters and full description

Search for merchants by name. Returns matching merchant IDs, UUIDs, names, categories, and domains.

ParameterTypeDescription
queryrequiredstringQuery
rationalerequiredstringRationale
limitintegerLimit

People and organization

ramp_create_department

Create a new department in the company.

Parameters and full description

Create a new department in the company. Department names are unique within the business (case-insensitive). If a department with the requested name already exists, it is returned instead of creating a duplicate.

ParameterTypeDescription
department_namerequiredstringDepartment Name
rationalerequiredstringRationale
ramp_departments

List all departments in the company.

Parameters and full description

List all departments in the company. Returns the departments available in the user's business, which can be used as inputs to workflows that require department references. Each department includes organizational metadata: its owners (managers), active member count, and managing external firm, if any.

ParameterTypeDescription
rationalerequiredstringRationale
name_filterstring | nullName Filter
ramp_get_org_chart

Get org chart for a user, including reporting chain and direct reports.

Parameters and full description

Get org chart for a user, including reporting chain and direct reports. This tool provides comprehensive org chart visibility including: - The user's position in the organization - Their direct reports (team members) - Their reporting chain (managers up the hierarchy) Use this tool whenever the user asks anything about their manager, team, or direct reports.

ParameterTypeDescription
rationalerequiredstringRationale
user_idstring | nullUser Id
ramp_get_simplified_user_detail

Get the current user's details.

Parameters and full description

Get the current user's details. Returns multiple results for users that are part of multiple businesses. When authenticated via an agent key, also returns the active agent key identity.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_list_users

List and search users across the entire business.

Parameters and full description

List and search users across the entire business. Returns all users in the organization matching the given filters. Supports searching by name (partial match, case-insensitive), filtering by department or location, and pagination. Results include active and inactive users — check the is_inactive field to distinguish. Use department_ids or location_ids (lists of UUIDs from the departments or locations tools) to narrow results.

ParameterTypeDescription
rationalerequiredstringRationale
department_idsarray | nullDepartment Ids
location_idsarray | nullLocation Ids
name_searchstring | nullName Search
page_cursorstring | nullPage Cursor
page_sizeintegerPage Size
ramp_rename_department

Rename an existing department in the company.

Parameters and full description

Rename an existing department in the company. Department names must be unique within the business (case-insensitive).

ParameterTypeDescription
department_idrequiredstringDepartment Id
department_namerequiredstringDepartment Name
rationalerequiredstringRationale
ramp_search_user

Match a user name to a Ramp user in the context of a transaction, for adding as an attendee.

Parameters and full description

Match a user name to a Ramp user in the context of a transaction, for adding as an attendee. Returns users from the business ranked by relevance to the given transaction (recent attendees and teammates appear first). If no transaction ID is provided, the user's most recent transaction is used as context. The search is case-insensitive and matches partial names.

ParameterTypeDescription
rationalerequiredstringRationale
searchrequiredstringSearch
transaction_idstring | nullTransaction Id

Policy and support

ramp_answer_policy_question

Get an answer to a question about the expense policy or funds (amount, restrictions, etc).

Parameters and full description

Get an answer to a question about the expense policy or funds (amount, restrictions, etc). Use this tool when the user asks about expense policy rules, spending limits, fund restrictions, or whether certain purchases are allowed under company policy.

ParameterTypeDescription
questionrequiredstringQuestion
rationalerequiredstringRationale
include_restrictionsbooleanInclude Restrictions
ramp_get_attention_feed

Return the authenticated user's homepage attention feed.

Parameters and full description

Return the authenticated user's homepage attention feed. Use this tool to see what needs the user's attention right now: pending approvals, missing receipts, overdue reviews, signatures, and similar action items that appear on the Ramp homepage. By default, the tool returns the default homepage sections with compact LIST-hydrated task rows. To fetch more from a section, pass that section's section_type and next_cursor back in sections. For own-card GET_ATTENTION_FEED remediation, use this as the canonical task feed. blocking_effects describes a task type's possible sanction, not proof that an item caused the active lock. Use browser_handoff for user action in Ramp. For an available CompleteTransactionRevision, inspect or edit the transaction and call it with a nonblank reason. Re-read both tools and continue relevant overdue tasks; success requires the task absent, blocking_task_count=0, and is_spendable=true. Pending verification is not an unlock.

ParameterTypeDescription
rationalerequiredstringRationale
fanout_timeout_secondsnumberFanout Timeout Seconds
sectionsarray | nullSections
ramp_get_more_tools

Report a capability that is missing from the available Ramp tools.

Parameters and full description

Report a capability that is missing from the available Ramp tools. Use this when the user's request cannot be completed with the available Ramp tools. Describe the user's goal and the capability that would be needed.

ParameterTypeDescription
contextrequiredstringContext
rationalerequiredstringRationale
ramp_policy

Publish the active policy for a standalone Agent Wallet

Parameters and full description

Publish the active policy for a standalone Agent Wallet

ParameterTypeDescription
agent_idrequiredstringStandalone agent ID returned by the list agents tool.
configurationsrequiredarrayConfigurations
constraintsrequiredobject
policy_versionrequiredstringPolicy Version
rationalerequiredstringWhy this MCP tool call is needed.
schema_versionrequiredintegerSchema Version
approval_modestring
approval_validity_secondsintegerApproval Validity Seconds
ramp_post_comment

Post a comment on a Ramp object (transaction, bill, reimbursement, etc).

Parameters and full description

Post a comment on a Ramp object (transaction, bill, reimbursement, etc). If there is any ambiguity as to whether the user's message is meant to be posted to the thread, ask them for confirmation first: 'Do you want me to post that as a comment reply on your [XYZ] transaction/reimbursement/bill/etc?'. How can you determine if the user's message is meant to be a reply to a comment? - If the only other messages in the conversation history are notifications about comments or mentions in Ramp, that is a very strong signal that the user's most recent message is meant to be a reply to the comment thread. In this case, you may use this tool immediately to post the comment without confirmation. - If a recent assistant message is a notification about a comment or mention, that is a strong signal that the user's most recent message is meant to be a reply to that comment. Even if their reply seems irrelevant or unrelated to Ramp, you may ask "Would you like me to post that as a comment on your...?" - prefer asking the user instead of refusing to serve the request at all.

ParameterTypeDescription
messagerequiredstringMessage
ramp_object_typerequiredstringType of the Ramp object. Valid options are: 'reimbursement', 'transaction', 'bill', 'card', 'spend_request', 'spend_intent', 'ticket', 'payee', 'booking_request', 'provisional_bill', or 'vendor_payment'.
ramp_object_uuidrequiredstringRamp Object Uuid
rationalerequiredstringRationale
mention_user_uuidsarray | nullMention User Uuids
ramp_search_help_center_snippets

Tool for searching Ramp's help center documentation using RAG (Retrieval Augmented Generation).

Parameters and full description

Tool for searching Ramp's help center documentation using RAG (Retrieval Augmented Generation). This tool performs semantic search across help center articles using embeddings. Trusted business-scoped calls receive the complete matched articles; unscoped and external Developer API calls receive focused snippets. The tool: 1. Fetches relevant articles from the help center 2. Chunks articles into smaller semantic units 3. Uses embedding similarity to find the most relevant sections 4. Returns top K results with their source articles Some internal articles have no public URL (an empty ``url``). Never construct or guess a URL for those articles. IMPORTANT: If you have other tools that can actually perform the action a user is asking about, you should use those tools instead of or in addition to providing help center information. For example, if a user says "how can I upload a receipt", you should tell them they can upload a receipt in the chat directly, even if you also find a help center article that explains how to upload receipts in the web app. Use this tool when you need to: - Find specific information within help articles - Get concise, focused answers from documentation - Minimize token usage while maintaining relevance - Answer questions about Ramp products and features

ParameterTypeDescription
queryrequiredstringQuery
rationalerequiredstringRationale
query_variantsstring | array | nullQuery Variants
top_kintegerTop K

Procurement and purchase orders

ramp_get_purchase_order_details

Get comprehensive details about a specific purchase order.

Parameters and full description

Get comprehensive details about a specific purchase order. Use this with the exact purchase order UUID returned by SearchPurchaseOrders or supplied by page context. Never pass a purchase order number, placeholder, or guessed value.

ParameterTypeDescription
purchase_order_idrequiredstringPurchase Order Id
rationalerequiredstringRationale
ramp_get_unified_request_details

Get detailed information about a specific unified request the acting user can view.

Parameters and full description

Get detailed information about a specific unified request the acting user can view. Use this when the user asks for more detail about a specific spend request, purchase order, fund request, or other unified request - for example its current status, approval chain, comments, activity timeline, or agent-generated reports. This works both after SearchUnifiedRequests or GetRequestsToReview and for any other unified request the user can already access via page context, tagged objects, or a known unified_request_id.

ParameterTypeDescription
rationalerequiredstringRationale
unified_request_idrequiredstringUnified Request Id
ramp_procurement_requests_delete

Delete an abandoned procurement draft owned by the acting user.

Parameters and full description

Delete an abandoned procurement draft owned by the acting user.

ParameterTypeDescription
rationalerequiredstringRationale
spend_request_uuidrequiredstringDraft spend request UUID returned by draft_procurement_request.
ramp_procurement_requests_draft

Create or update a procurement draft and return the current visible form state.

Parameters and full description

Create or update a procurement draft and return the current visible form state.

ParameterTypeDescription
rationalerequiredstringRationale
answersarray | nullAnswers
change_request_answersarray | nullChange Request Answers
clear_change_request_field_idsarray | nullClear Change Request Field Ids
clear_field_idsarray | nullClear Field Ids
currencystring | nullISO 4217 currency code, e.g. USD.
existing_spend_request_uuidstring | nullThe original approved purchase-order request's spend_request_uuid from unified request details; not the unified_request_id or purchase_order_id. Provide this when requesting a change to that purchase order. Mutually exclusive with spend_intent_uuid.
internal_memostring | nullInternal Memo
line_itemsarray | nullLine Items
request_namestring | nullRequest Name
request_virtual_cardboolean | nullRequest Virtual Card
spend_intent_uuidstring | nullSpend intent UUID returned by spend-intents. Provide this when starting a new procurement request. Mutually exclusive with existing_spend_request_uuid.
spend_request_uuidstring | nullDraft spend request UUID returned by this tool. Provide this to continue editing a draft.
ramp_procurement_requests_get

Refresh and canonically revalidate a procurement draft's visible form state

Parameters and full description

Refresh and canonically revalidate a procurement draft's visible form state

ParameterTypeDescription
rationalerequiredstringValue for rationale.
spend_request_uuidrequiredstringValue for spend_request_uuid.
ramp_procurement_spend_intents

List published procurement spend programs the agent can draft against.

Parameters and full description

List published procurement spend programs the agent can draft against.

ParameterTypeDescription
rationalerequiredstringRationale
page_sizeintegerPage Size
querystring | nullQuery
ramp_procurement_submit

Submit a procurement draft after explicit user confirmation.

Parameters and full description

Submit a procurement draft after explicit user confirmation.

ParameterTypeDescription
confirmedrequiredbooleanConfirmed
rationalerequiredstringRationale
spend_request_uuidrequiredstringDraft spend request UUID returned by draft.
ramp_ramp_bulk_close_purchase_orders

Close one or more purchase orders with a specified reason.

Parameters and full description

Close one or more purchase orders with a specified reason. Use after confirming the user wants the listed POs closed. Purchase orders must not already be closed or archived. The user must have permission to close every purchase order in the request.

ParameterTypeDescription
close_reasonrequiredstringClose Reason
purchase_order_uuidsrequiredarrayPurchase Order Uuids
rationalerequiredstringRationale
ramp_ramp_bulk_reopen_purchase_orders

Reopen multiple closed purchase orders.

Parameters and full description

Reopen multiple closed purchase orders. Use only after confirming the user wants the listed POs reopened. This does not archive or delete POs; reopening restores each PO to its computed active lifecycle status when allowed. The user must have permission to reopen every purchase order in the request.

ParameterTypeDescription
purchase_order_uuidsrequiredarrayPurchase Order Uuids
rationalerequiredstringRationale
ramp_search_purchase_orders

Search for purchase orders using structured purchase order filters.

Parameters and full description

Search for purchase orders using structured purchase order filters.

ParameterTypeDescription
rationalerequiredstringRationale
filtersobject | nullCompact purchase order filters. Use search for PO numbers, request names, or owner names; for vendor/payee queries, resolve the vendor first and pass payee_uuids. Then narrow by PO status, spend request status, owner, or approval queue when needed.
limitintegerLimit
page_cursorstring | nullPage Cursor
ramp_search_unified_requests

Search for unified requests using free-text and structured request filters.

Parameters and full description

Search for unified requests using free-text and structured request filters. Use this to find existing purchase orders, fund requests, procurement requests, or approval-only requests by vendor, request name, owner, requester, status, type, exact request number, approval date, department, or whether they require action. Use GetRequestsToReview when the user is specifically asking what they need to approve right now. Use GetUnifiedRequestDetails once one request has been identified.

ParameterTypeDescription
rationalerequiredstringRationale
filtersobject | nullCompact filters for unified request search. Use filters.search for free text, request_numbers for exact REQ-* identifiers, payee_ids for an exact vendor match, and the other fields to narrow by category, status, type, approval date, department, owner, requester, or approval queue.
limitintegerLimit
page_cursorstring | nullPage Cursor

Reimbursements

ramp_cancel_reimbursement_payment

Cancel the payment on a reimbursement that has been approved but not yet paid out.

Parameters and full description

Cancel the payment on a reimbursement that has been approved but not yet paid out.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid
notesstring | nullNotes
ramp_create_reimbursement_from_receipt

Create a draft reimbursement from a receipt UUID. Pass amount/currency_code/transaction_date/merchant to skip OCR.

Parameters and full description

Create a draft reimbursement from a receipt UUID. Pass amount/currency_code/transaction_date/merchant to skip OCR.

ParameterTypeDescription
rationalerequiredstringRationale
receipt_uuidrequiredstringReceipt Uuid
amountnumber | string | nullAmount
currency_codestring | nullCurrency Code
merchantstring | nullMerchant
transaction_datestring | nullTransaction Date
ramp_delete_reimbursement

Delete a reimbursement by UUID.

Parameters and full description

Delete a reimbursement by UUID. Deletion is permanent and only allowed for reimbursements the acting user is permitted to delete (their own drafts, or others' if they have write access). Reimbursements that have progressed too far in the payment lifecycle cannot be deleted; use CancelReimbursementPayment for approved-but-unpaid reimbursements.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid
ramp_duplicate_reimbursement

Duplicate an existing reimbursement as a new draft.

Parameters and full description

Duplicate an existing reimbursement as a new draft.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid
ramp_edit_reimbursement

Edit reimbursement fields (amount, currency, date, merchant, memo, funds, accounting categories, split line items, custom records, trip, attendees). Omitted fields stay unchanged; null/[] clear when editable.

Parameters and full description

Edit reimbursement fields (amount, currency, date, merchant, memo, funds, accounting categories, split line items, custom records, trip, attendees). Omitted fields stay unchanged; null/[] clear when editable.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid
accounting_split_requestobject | nullComplete replacement for every split line on a draft. Omit for ordinary edits; null is treated as omitted and preserves existing split lines. A non-null payload must include every line with its amount, memo, and line-level tracking category selections. Required when changing the amount or currency of an existing split draft.
amountnumber | string | nullAmount
attendee_user_uuidsarray | nullAttendee User Uuids
currency_codestring | nullCurrency Code
custom_record_valuesarray | nullCustom Record Values
fund_uuidstring | nullFund Uuid
memostring | nullMemo
merchant_namestring | nullMerchant Name
merchant_uuidstring | nullMerchant Uuid
reimbursement_datestring | nullReimbursement Date
tracking_category_selectionsarray | nullTracking Category Selections
trip_uuidstring | nullTrip Uuid
ramp_estimate_mileage_reimbursement

Estimate the reimbursement amount for a given mileage distance based on the user's company rates.

Parameters and full description

Estimate the reimbursement amount for a given mileage distance based on the user's company rates.

ParameterTypeDescription
distancerequirednumber | stringDistance
rationalerequiredstringRationale
distance_unitsstringThe distance unit: MILES or KILOMETERS. Defaults to MILES.
transaction_datestring | nullTransaction Date
vehicle_mileage_classstring | nullThe vehicle mileage class, required for some countries (e.g. France, Finland).
ramp_estimate_per_diem_amount

Estimate the per diem reimbursement amount for a trip given start/end dates and optional meal deductions.

Parameters and full description

Estimate the per diem reimbursement amount for a trip given start/end dates and optional meal deductions.

ParameterTypeDescription
end_daterequiredstringEnd Date
rationalerequiredstringRationale
start_daterequiredstringStart Date
day_dataarray | nullDay Data
deduct_weekendsboolean | nullDeduct Weekends
meals_providedboolean | nullMeals Provided
trip_uuidstring | nullTrip Uuid
ramp_get_outstanding_reimbursements_by_currency

Get approved and failed reimbursements that would be affected by a bank account currency change.

Parameters and full description

Get approved and failed reimbursements that would be affected by a bank account currency change.

ParameterTypeDescription
new_currencyrequiredstringNew Currency
rationalerequiredstringRationale
entity_uuidstring | nullEntity Uuid
ramp_get_reimbursement_receipts

Retrieve receipts attached to a reimbursement.

Parameters and full description

Retrieve receipts attached to a reimbursement.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid
ramp_get_reimbursements

Search and retrieve reimbursements with filters for users, text search,

Parameters and full description

Search and retrieve reimbursements with filters for users, text search, amount ranges, tags, date ranges, approval status, and policy assessments.

ParameterTypeDescription
rationalerequiredstringRationale
from_datestring | nullFrom Date
include_policy_assessmentbooleanInclude Policy Assessment
include_suggestionsbooleanInclude Suggestions
next_page_cursorstring | nullNext Page Cursor
page_sizeintegerPage Size
reimbursement_uuidsarray | nullReimbursement Uuids
reimbursements_to_retrievestringWhich set of reimbursements to search: your own reimbursements, reimbursements awaiting your approval, or all reimbursements across the business
search_stringstring | nullSearch String
tagsarray | nullTags
to_datestring | nullTo Date
ramp_get_user_recent_reimbursements

Get reimbursement history for the current user.

Parameters and full description

Get reimbursement history for the current user. `limit` takes precedence over `up_to_days` so if you want to get all reimbursements in a given time frame, do not specify `limit`. `include_rejected` controls whether to include rejected reimbursements in the results. By default, rejected reimbursements are excluded. `include_drafts` controls whether to include draft reimbursements in the results. By default, drafts are excluded. `use_submitted_date_ordering` controls the ordering of results. By default (False), results are ordered by transaction_date. Set to True to order by submitted_date instead. If the user did not ask for a specific number of reimbursements or a time frame, assume they want to see the latest 10 reimbursements. Read each amount from `amount_decimal`, which is already in `currency`'s major unit and needs no arithmetic. Ignore `amount_cents`; it is the same amount in minor units, kept only for backwards compatibility.

ParameterTypeDescription
rationalerequiredstringRationale
include_draftsbooleanInclude Drafts
include_rejectedbooleanInclude Rejected
limitinteger | nullLimit
up_to_daysintegerUp To Days
use_submitted_date_orderingbooleanUse Submitted Date Ordering
ramp_resubmit_reimbursement

Revert a rejected reimbursement back to draft state so it can be edited and resubmitted.

Parameters and full description

Revert a rejected reimbursement back to draft state so it can be edited and resubmitted. This does NOT submit the reimbursement — it only moves it from REJECTED to DRAFT. After resubmitting, use EditReimbursement to make changes and SubmitReimbursement to submit again.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid
ramp_search_reimbursements

Search reimbursements across a business, optionally filtering to a specific user's reimbursements.

Parameters and full description

Search reimbursements across a business, optionally filtering to a specific user's reimbursements.

ParameterTypeDescription
rationalerequiredstringRationale
filtersobject | nullText-based filters to search by. Provide human-readable names for tracking categories, merchants, or spend allocations and they will be resolved to the correct IDs automatically.
from_datestring | nullFrom Date
next_page_cursorstring | nullNext Page Cursor
page_sizeintegerPage Size
reimbursement_statusstring | nullFilter by reimbursement status.
search_stringstring | nullSearch String
to_datestring | nullTo Date
user_idinteger | nullUser Id
ramp_search_user_reimbursements

Search reimbursements with text-based filters and structured filters.

Parameters and full description

Search reimbursements with text-based filters and structured filters. Supports filtering by: - User name (e.g., 'John Smith') — resolved automatically, defaults to current user if not specified - Accounting coding selections (tracking categories) like Department, Cost Center, Class, GL Account - Merchant name, spend allocation name (resolved from text automatically) - Reimbursement status (DRAFT, PENDING, APPROVED, etc.) - Date range and text search The tool resolves text queries to internal IDs automatically via the search tag service. Results are scoped to the current user's business.

ParameterTypeDescription
rationalerequiredstringRationale
filtersobject | nullText-based filters to search by. Provide human-readable names for tracking categories, merchants, or spend allocations and they will be resolved to the correct IDs automatically.
from_datestring | nullFrom Date
next_page_cursorstring | nullNext Page Cursor
page_sizeintegerPage Size
reimbursement_statusstring | nullFilter by reimbursement status.
search_stringstring | nullSearch String
to_datestring | nullTo Date
ramp_submit_reimbursement

Submit a draft out-of-pocket reimbursement for approval.

Parameters and full description

Submit a draft out-of-pocket reimbursement for approval. If the submission fails, the agent should follow up with the user based on the error returned from the endpoint. If it is due to outstanding missing items, the agent should recheck missing_items via the GetReimbursements tool and provide suggestions for the user. If only nonsupported missing items are present (trip, attendee, mileage_locations), the agent should provide the reimbursement_link URL as a clickable link in the response.

ParameterTypeDescription
rationalerequiredstringRationale
reimbursement_uuidrequiredstring | nullReimbursement Uuid

Transactions and expenses

ramp_complete_transaction_revision

Complete a revision-requested transaction as its cardholder.

Parameters and full description

Complete a revision-requested transaction as its cardholder. Use this after the cardholder has addressed the requested changes and explicitly asks to mark the transaction revision complete. The completion refreshes the corresponding task and starts Task Platform's sanction-lifting workflow.

ParameterTypeDescription
rationalerequiredstringRationale
reasonrequiredstringReason
transaction_uuidrequiredstringUUID of the revision-requested transaction to complete.
ramp_edit_transaction

Edit a transaction field (memo, funds, accounting categories, trip, attendees). Returns the updated transaction, remaining missing items, and a transaction_link for fields the API cannot edit.

Parameters and full description

Edit a transaction field (memo, funds, accounting categories, trip, attendees). Returns the updated transaction, remaining missing items, and a transaction_link for fields the API cannot edit.

ParameterTypeDescription
rationalerequiredstringRationale
transaction_uuidrequiredstring | nullTransaction Uuid
attendee_selectionsobject | nullAttendee selections: attendee_uuids (Ramp users; must be valid UUIDs, never integer IDs), non_ramp_attendees (external people), include_self_as_attendee (acting user is added automatically when include_self_as_attendee is True). This is an upsert - provide the complete set of attendees. Only provide this field when Attendees is in incomplete items, or when the user directly provides attendee values or asks to change attendees; a memo or business-purpose answer is not an attendee change by itself unless it directly identifies attendee names or an attendee change.
fund_uuidstring | nullFund Uuid
memostring | nullMemo
tracking_category_selectionsarray | nullTracking Category Selections
trip_selectionobject | nullTrip selection configuration. Provide a trip_uuid to assign/change the transaction. Set trip_uuid=None to detach a wrong trip while leaving the transaction eligible for another trip. Set mark_not_part_of_trip=True only when the transaction genuinely is not part of any trip.
user_submitted_fieldsarray | nullUser Submitted Fields
ramp_get_candidate_trips_for_transaction

Fetch trips that could be relevant to the current transaction.

Parameters and full description

Fetch trips that could be relevant to the current transaction. Returns ongoing, upcoming, and recently completed trips for the acting user.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_get_full_transaction_metadata

View all details, memos, funds, and receipts for a specific transaction.

Parameters and full description

View all details, memos, funds, and receipts for a specific transaction. Read the amount from `amount_decimal`, which is already in `currency`'s major unit and needs no arithmetic. Ignore `amount_cents`; it is the same amount in minor units, kept only for backwards compatibility.

ParameterTypeDescription
idrequiredstring | nullTransaction id (from tool calls or metadata)
rationalerequiredstringRationale
ramp_get_transaction_missing_items

Check what receipts, memos, or accounting items are missing from a specific transaction.

Parameters and full description

Check what receipts, memos, or accounting items are missing from a specific transaction.

ParameterTypeDescription
idrequiredstring | nullTransaction id (based on metadata or tool calls).
rationalerequiredstringRationale
ramp_get_transaction_suggested_memos

Get AI-suggested memo/note options for a specific transaction.

Parameters and full description

Get AI-suggested memo/note options for a specific transaction.

ParameterTypeDescription
idrequiredstring | nullThe ID of the transaction to retrieve suggested memos for.
rationalerequiredstringRationale
ramp_get_transactions

Search and retrieve individual card transactions and workflow details for the user's business, including reconciliation dates (cleared_at, settlement_date, accounting_date, synced_at) and, via details_to_include_in_response=['submitted_items'], the selected accounting categories. Use analyst tools instead for aggregate spend analysis, totals, trends, or group-bys when analyst tools are available. Declined transactions are excluded by default; pass state='declined' to include them.

Parameters and full description

Search and retrieve individual card transactions and workflow details for the user's business, including reconciliation dates (cleared_at, settlement_date, accounting_date, synced_at) and, via details_to_include_in_response=['submitted_items'], the selected accounting categories. Use analyst tools instead for aggregate spend analysis, totals, trends, or group-bys when analyst tools are available. Declined transactions are excluded by default; pass state='declined' to include them.

ParameterTypeDescription
rationalerequiredstringRationale
transactions_to_retrieverequiredstringWhich set of transactions to search.
details_to_include_in_responsearray | nullDetails To Include In Response
filtersobject | nullStructured filters by merchant, category, spend allocation, trip, or tracking category.
from_datestring | nullFrom Date
include_countbooleanInclude Count
next_page_cursorstring | nullNext Page Cursor
page_sizeintegerPage Size
reason_memo_merchant_or_user_name_text_searchstring | nullReason Memo Merchant Or User Name Text Search
sortobject | nullSort order. Defaults to transaction_date desc.
statestring | nullFilter by state. Defaults to non-declined; set 'declined' for declined/failed, or 'all' for everything.
to_datestring | nullTo Date
ramp_mark_transaction_missing_receipt

Flag a transaction as having no receipt.

Parameters and full description

Flag a transaction as having no receipt. Should be called whenever the user says "OOPS" or if the user says something along the lines of "I did not receive a receipt ...". If the user already flagged the transaction as having no receipt, then you may need to call the ProvideNoReceiptReason tool.

ParameterTypeDescription
rationalerequiredstringRationale
transaction_uuidrequiredstring | nullTransaction Uuid
ramp_merchant_categories

List all available spend categories. Returns category IDs and names.

Parameters and full description

List all available spend categories. Returns category IDs and names.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_provide_no_receipt_reason

Submit a reason explaining why a transaction has no receipt.

Parameters and full description

Submit a reason explaining why a transaction has no receipt.

ParameterTypeDescription
rationalerequiredstringRationale
reasonrequiredstringReason
transaction_uuidrequiredstring | nullTransaction Uuid
ramp_request_transaction_repayment

Request that a cardholder repay a transaction.

Parameters and full description

Request that a cardholder repay a transaction. This is the REVIEWER / APPROVER action: the acting user must be an approver or manager for the transaction, not the cardholder themselves. The tool marks the transaction as repayment-required and notifies the cardholder, who can then accept, reject, or complete repayment through their own flow. This tool does NOT execute payment (ACH, payroll, debit-card, etc.). It only creates the repayment request so the cardholder sees an actionable task. Use when a reviewer or manager says things like: - "Request repayment on this transaction" - "Mark this as needing repayment" - "Require the employee to pay back this charge" - "Flag this transaction for repayment" If the user is the cardholder wanting to repay their OWN transaction, use RepayTransaction instead — that tool provides the self-service repayment URL.

ParameterTypeDescription
rationalerequiredstringRationale
reasonrequiredstringReason
thoughtsrequiredstringThoughts
transaction_idrequiredstringTransaction Id
ramp_split

Split a transaction into line items, or update an existing split

Parameters and full description

Split a transaction into line items, or update an existing split

ParameterTypeDescription
rationalerequiredstringWhy this MCP tool call is needed.
transaction_idrequiredstringValue for transaction_id.
ramp_update_transaction_amount_limit

Set a fund's maximum amount for one transaction. Use this for decline action

Parameters and full description

Set a fund's maximum amount for one transaction. Use this for decline action INCREASE_TRANSACTION_AMOUNT_LIMIT or requests about a per-transaction, single-transaction, or max-expense limit. Use LimitIncrease for the period total. Set any positive value to raise or lower the cap. AP-card and bill-pay funds are unsupported. Provide exactly one of spend_allocation_id or card_id.

ParameterTypeDescription
new_transaction_amount_limitrequirednumber | stringNew Transaction Amount Limit
rationalerequiredstringRationale
card_idstring | nullCard Id
spend_allocation_idstring | nullSpend Allocation Id

Travel

ramp_add_traveler_loyalty_program

Compatibility route for callers that have not migrated to SetTravelerLoyaltyProgram.

Parameters and full description

Compatibility route for callers that have not migrated to SetTravelerLoyaltyProgram.

ParameterTypeDescription
loyalty_numberrequiredstringLoyalty Number
program_namerequiredstringProgram Name
rationalerequiredstringRationale
ramp_create_trip

Create a new trip for the acting user.

Parameters and full description

Create a new trip for the acting user. Do not call this solely as a prerequisite for booking a flight or hotel; SubmitFlightBooking and SubmitHotelBooking automatically select or create a trip when trip_id is omitted. If the user explicitly asks to create a named trip in addition to booking, call this once and pass the returned trip_uuid as trip_id to every related SubmitFlightBooking and SubmitHotelBooking call.

ParameterTypeDescription
are_trip_dates_from_booking_receipt_or_user_inputrequiredbooleanAre Trip Dates From Booking Receipt Or User Input
namerequiredstringName
rationalerequiredstringRationale
calendar_timezonestring | nullCalendar Timezone
destinationsarray | nullDestinations
end_datestring | nullEnd Date
start_datestring | nullStart Date
trip_purposestring | nullTrip Purpose
ramp_get_booking_details

Get itinerary, stay, or rental details plus request status, amount, payment timing, cancellation state, associated spend, error, and approval information for one result from GetBookings.

Parameters and full description

Get itinerary, stay, or rental details plus request status, amount, payment timing, cancellation state, associated spend, error, and approval information for one result from GetBookings.

ParameterTypeDescription
booking_idrequiredstringBooking Id
rationalerequiredstringRationale
ramp_get_flight_booking_locations

Resolves locations (airports/cities) available for booking a flight from user intent.

Parameters and full description

Resolves locations (airports/cities) available for booking a flight from user intent. Preserve the user's location wording in ``query``. When the user names a city or metro area such as "NYC", set ``location_type=city``. A returned city ``search_code`` searches all supported airports in that metro; do not ask the user to choose one airport when a city result is available. Call this before SearchFlights for every departure or arrival location that the user did not provide as an exact airport IATA code. If the results contain multiple plausible locations, present the choices and wait for the user to clarify; never choose a location on their behalf. Do not infer a location from profile data, an area code, or a broad description such as "somewhere warm." Returns locations where flights can be booked from or to, which may include: - Individual airports (e.g., JFK, SFO, LAX) - City groups with multiple airports (e.g., NYC includes JFK, LGA, EWR) - Major travel destinations with flight availability Pass a result's ``search_code`` straight into SearchFlights departure/arrival. Cities search every airport in the metro area; airports search just that airport.

ParameterTypeDescription
queryrequiredstringQuery
rationalerequiredstringRationale
limitintegerLimit
location_typestringLocation Type
ramp_get_hotel_rates

Fetch available room-rate options for one selected hotel from SearchHotels. Use this after the user picks a hotel from SearchHotels results and before booking. Every current room group and its rates for the stay are returned in all_rates; the returned rate.id values are the exact IDs to pass to SubmitHotelBooking. These rates are current options, not quotes - wait for the traveler to select one exact rate. When the result's all_rates_out_of_policy is true, every rate at this hotel is out of policy for the stay: tell the traveler, prefer offering an in-policy hotel from the SearchHotels results, and proceed with this hotel only if the traveler explicitly chooses to - booking will then require an oop_reason at SubmitHotelBooking.

Parameters and full description

Fetch available room-rate options for one selected hotel from SearchHotels. Use this after the user picks a hotel from SearchHotels results and before booking. Every current room group and its rates for the stay are returned in all_rates; the returned rate.id values are the exact IDs to pass to SubmitHotelBooking. These rates are current options, not quotes - wait for the traveler to select one exact rate. When the result's all_rates_out_of_policy is true, every rate at this hotel is out of policy for the stay: tell the traveler, prefer offering an in-policy hotel from the SearchHotels results, and proceed with this hotel only if the traveler explicitly chooses to - booking will then require an oop_reason at SubmitHotelBooking.

ParameterTypeDescription
check_in_daterequiredstringCheck In Date
check_out_daterequiredstringCheck Out Date
hotel_idrequiredstringHotel Id
rationalerequiredstringRationale
filtersobject | nullOptional rate-level preferences from the traveler's saved or current-trip preferences. Rates meeting more preferences rank higher in recommended_rates, but best-available fallbacks are still returned when nothing matches (see each group's unmet_preferences); all_rates remains the complete selectable inventory.
max_recommended_ratesintegerMax Recommended Rates
num_adultsintegerNum Adults
search_idstring | nullSearch Id
traveler_user_idstring | nullTraveler User Id
ramp_get_traveler_profile

Retrieve traveler profile information including name, email, phone, date of birth, gender, known traveler number (KTN/TSA), redress number, and loyalty programs.

Parameters and full description

Retrieve traveler profile information including name, email, phone, date of birth, gender, known traveler number (KTN/TSA), redress number, and loyalty programs. For delegated bookings, first resolve the traveler with GetAllReducedUsers/list-users, then pass that UUID as traveler_user_id. Omit traveler_user_id for self-booking.

ParameterTypeDescription
rationalerequiredstringRationale
traveler_user_idstring | nullTraveler User Id
ramp_list_traveler_loyalty_programs

List saved loyalty programs from the user's traveler profile. Use this directly for loyalty-only list/show/check requests; do not call GetTravelerProfile first.

Parameters and full description

List saved loyalty programs from the user's traveler profile. Use this directly for loyalty-only list/show/check requests; do not call GetTravelerProfile first.

ParameterTypeDescription
rationalerequiredstringRationale
ramp_remove_traveler_loyalty_program

Remove a saved loyalty program from the user's traveler profile.

Parameters and full description

Remove a saved loyalty program from the user's traveler profile.

ParameterTypeDescription
rationalerequiredstringRationale
traveler_loyalty_program_idrequiredstringTraveler Loyalty Program Id
ramp_search_hotel

Search hotels using the canonical Ramp web inventory and policy flow. Before first use in a conversation, load and follow the ramp-book-hotel skill when available.

Parameters and full description

Search hotels using the canonical Ramp web inventory and policy flow. Before first use in a conversation, load and follow the ramp-book-hotel skill when available. Provide location_query (city, neighborhood, address, landmark, or office) plus check_in_date and check_out_date. API calls run synchronously by default and return ranked hotels - each with at most one summary rate - plus policy_summary, total_count, and web_search_url. Results are paginated from a cached result set: pass the returned next_cursor as cursor to fetch more hotels without triggering a new provider search; never construct or edit a cursor. Put chain requests in filters.chain_names and reserve hotel_name for one exact property; a specific hotel_name uses the targeted direct-hotel path. Passing wait_for_results=false explicitly opts into an asynchronous kickoff that returns status='searching' with a search_id to resume by passing that search_id on a later call. To book from these results, pass the selected hotel id to GetHotelRates, then the selected rate id to SubmitHotelBooking with the same traveler and stay dates.

ParameterTypeDescription
rationalerequiredstringRationale
check_in_datestring | nullCheck In Date
check_out_datestring | nullCheck Out Date
cursorstring | nullCursor
filtersobject | nullOptional filters applied to fresh or cached results. Put chain requests in filters.chain_names; do not pass a chain name as hotel_name.
hotel_namestring | nullHotel Name
latitudenumber | string | nullLatitude
limitintegerLimit
location_querystring | nullLocation Query
longitudenumber | string | nullLongitude
num_adultsintegerNum Adults
preferencesstring | nullPreferences
search_idstring | nullSearch Id
sortobject | nullOptional sort configuration that mirrors web static hotel search.
traveler_user_idstring | nullTraveler User Id
wait_for_resultsboolean | nullWait For Results
ramp_set_traveler_loyalty_program

Set one loyalty program on the user's traveler profile by program name and loyalty number.

Parameters and full description

Set one loyalty program on the user's traveler profile by program name and loyalty number. If it already exists, update its loyalty number. After success, continue the active workflow when it requires refreshed data; otherwise tell the user it is saved.

ParameterTypeDescription
loyalty_numberrequiredstringLoyalty Number
program_namerequiredstringProgram Name
rationalerequiredstringRationale
ramp_submit_flight_booking

Book a selected flight offer.

Parameters and full description

Book a selected flight offer. Two-step flow: call without confirm for the authoritative preview (itinerary, price, in-policy status, and required approvals) without booking. When no fund is supplied, the preview uses the recommended eligible fund, if one exists, to determine required approvals. Then call with confirm=true and the previewed expected_total_amount (copied verbatim, digits and decimal point only, no currency symbol) only after a new, explicit user-authored response approves that latest preview. If the fare changes, preview the new total and obtain fresh approval before confirming. flight_offer_uuid is the literal id from search: the outbound flight for one-way, the return flight for round trips (it carries both legs), or a fare option's id to book that fare. On confirmation, pass exactly one funding choice: spend_allocation_id with an eligible fund UUID from the preview, or request_new_fund=true with reason set to the trip purpose. If the chosen flight is out of policy, you MUST collect an oop_reason from the traveler and pass it here. Before previewing or confirming, call GetTravelerProfile (passing the same traveler_user_id from search for delegated booking); if has_profile is false, collect the traveler's identity details and call UpdateTravelerProfile first. For changes or cancellations, use the Ramp web app.

ParameterTypeDescription
flight_offer_uuidrequiredstringLiteral 'id' of the chosen flight offer from search (the return flight id for round trips; a fare option's id to book that fare).
rationalerequiredstringRationale
confirmbooleanConfirm
expected_total_amountinteger | number | string | nullExpected Total Amount
oop_reasonstring | nullOop Reason
reasonstring | nullReason
request_new_fundbooleanRequest New Fund
selection_surface_call_idstring | nullSelection Surface Call Id
simulatebooleanSimulate
spend_allocation_idstring | nullEligible fund UUID to pay with. A preview without one uses the recommended eligible fund when available. On confirmation, provide this or set request_new_fund=true.
traveler_user_idstring | nullTraveler UUID when booking for someone else; use the value from search. Requires delegate or travel-manager permission. Omit for self-booking.
trip_idstring | nullTrip to attach the booking to. Omit to auto-select or create one.
ramp_submit_flight_cancellation

Preview or confirm cancellation of an existing flight booking.

Parameters and full description

Preview or confirm cancellation of an existing flight booking. Always call with ``confirm=false`` first. That call is read-only and returns the complete itinerary, fresh authoritative terms, and a ``preview_id``. Only after a new, explicit user-authored approval of that latest preview may you call again with ``confirm=true`` and the exact ``preview_id``. Earlier cancellation intent, standing approval, or instructions not to ask questions are not confirmation. Atlas- and Duffel-booked flights are supported. Confirmation refetches the canonical details used by the Ramp web flow and refuses to cancel if any term changed. The action always cancels the entire booking; partial passenger or leg cancellation is not supported.

ParameterTypeDescription
booking_idrequiredstringParent or flight booking UUID returned by GetBookings
rationalerequiredstringRationale
confirmbooleanConfirm
preview_idstring | nullPreview Id
ramp_submit_hotel_booking

Book a selected hotel rate.

Parameters and full description

Book a selected hotel rate. Two-step flow: call without confirm for the authoritative preview (price, policy, and required approvals) without creating a booking. When no fund is supplied, the preview uses the recommended eligible fund, if one exists, to determine required approvals. Then call with confirm=true and the previewed expected_total_amount (copied verbatim, digits and decimal point only, no currency symbol) only after a new, explicit user-authored response approves that latest preview. If the rate changes, preview the new total and obtain fresh approval before confirming. Use the exact hotel_id from SearchHotels and rate_id from GetHotelRates. On confirmation, pass exactly one funding choice: spend_allocation_id with an eligible fund UUID from the preview, or request_new_fund=true with reason set to the trip purpose. If the chosen hotel rate is out of policy, you MUST collect an oop_reason from the traveler and pass it here. Before previewing or confirming, call GetTravelerProfile (passing the same traveler_user_id for delegated booking); if has_profile is false, collect the traveler's identity details and call UpdateTravelerProfile first. If the user wants to change or cancel an existing reservation, direct them to the Ramp web app.

ParameterTypeDescription
check_in_daterequiredstringCheck In Date
check_out_daterequiredstringCheck Out Date
hotel_idrequiredstringHotel UUID from SearchHotels results.
rate_idrequiredstringRate UUID from GetHotelRates for the selected hotel.
rationalerequiredstringRationale
confirmbooleanConfirm
expected_total_amountinteger | number | string | nullExpected Total Amount
oop_reasonstring | nullOop Reason
reasonstring | nullReason
request_new_fundbooleanRequest New Fund
selection_surface_call_idstring | nullSelection Surface Call Id
spend_allocation_idstring | nullEligible fund UUID to pay with. A preview without one uses the recommended eligible fund when available. On confirmation, provide this or set request_new_fund=true.
traveler_user_idstring | nullTraveler UUID when booking for someone else.
trip_idstring | nullTrip UUID to attach this booking to. Omit to auto-select or create.
ramp_submit_hotel_cancellation

Preview or confirm cancellation of an existing hotel booking.

Parameters and full description

Preview or confirm cancellation of an existing hotel booking. Always call with ``confirm=false`` first. That call is read-only and returns fresh authoritative terms plus a ``preview_id``. Only after a new, explicit user-authored approval of that latest preview may you call again with ``confirm=true`` and the exact ``preview_id``. Earlier cancellation intent, standing approval, or instructions not to ask questions are not confirmation. Confirmation refetches the canonical details and refuses to cancel if any material hotel cancellation term changed. This tool always cancels the entire hotel booking; use the flight cancellation tool for flights.

ParameterTypeDescription
booking_idrequiredstringPublic parent booking UUID from GetBookings
rationalerequiredstringRationale
confirmbooleanConfirm
preview_idstring | nullPreview Id
ramp_update_traveler_loyalty_program

Compatibility route for callers that still update a saved loyalty program by ID.

Parameters and full description

Compatibility route for callers that still update a saved loyalty program by ID.

ParameterTypeDescription
loyalty_numberrequiredstringLoyalty Number
rationalerequiredstringRationale
traveler_loyalty_program_idrequiredstringTraveler Loyalty Program Id
ramp_update_traveler_profile

Update traveler identity and contact profile details. Never use for loyalty-only requests; use dedicated traveler loyalty program tools instead.

Parameters and full description

Update traveler identity and contact profile details. Never use for loyalty-only requests; use dedicated traveler loyalty program tools instead. For delegated bookings, first resolve the traveler with GetAllReducedUsers/list-users, then pass that UUID as traveler_user_id. Omit traveler_user_id for self-booking.

ParameterTypeDescription
rationalerequiredstringRationale
avoid_red_eye_flightsboolean | nullAvoid Red Eye Flights
date_of_birthstring | nullDate Of Birth
emailstring | nullEmail
first_namestring | nullFirst Name
home_airport_codestring | nullHome Airport Code
id_genderstring | nullId Gender
known_traveler_numberstring | nullKnown Traveler Number
last_namestring | nullLast Name
loyalty_programsarray | nullLoyalty Programs
max_stopsinteger | nullMax Stops
middle_namestring | nullMiddle Name
name_prefixstring | nullName Prefix
name_suffixstring | nullName Suffix
phone_country_codestring | nullPhone Country Code
phone_numberstring | nullPhone Number
preferred_airlinesarray | nullPreferred Airlines
preferred_arrival_time_windowstring | nullPreferred Arrival Time Window
preferred_cabin_classstring | nullPreferred Cabin Class
preferred_departure_time_windowstring | nullPreferred Departure Time Window
redress_numberstring | nullRedress Number
seat_preferencestring | nullSeat Preference
traveler_user_idstring | nullTraveler User Id

For the product-level choice, see Connecting.