Ramp

Overview

Pre-built tooling

✅ Authorization
ToolsStatus
Pre-built authorization (OAuth)✅
Credentials auto-refresh✅
Pre-built authorization UI✅
Custom authorization UI✅
Expired credentials detection✅
✅ Read & write data
ToolsStatus
Pre-built integrations✅
API unification✅
2-way sync✅
Webhooks from Tenklo on data modifications✅
Real-time webhooks from 3rd-party API🚫 (time to contribute: <48h)
Proxy requests✅
✅ Observability & data quality
ToolsStatus
HTTP request logging✅
End-to-end type safety✅
Data runtime validation✅
OpenTelemetry export✅
Slack alerts on errors✅
Integration status API✅
✅ Customization
ToolsStatus
Create or customize use-cases✅
Pre-configured pagination🚫 (time to contribute: <48h)
Pre-configured rate-limit handling🚫 (time to contribute: <48h)
Per-customer configurations✅

Others

Function nameDescriptionTypeSource code
archive-purchase-orderArchive (soft-remove) a purchase order.Action🔗 Github
create-bill-draftCreate a bill in draft state, to be reviewed/edited before submission.Action🔗 Github
create-billCreate a bill directly (not via the draft flow) with line items.Action🔗 Github
create-departmentCreate a new department.Action🔗 Github
create-fundCreate a new fund (spend limit) for a user, optionally auto-issuing a card against it.Action🔗 Github
create-locationCreate a new location.Action🔗 Github
create-mileage-reimbursementCreate a mileage reimbursement for a user business trip.Action🔗 Github
create-physical-cardIssue a new physical card to a user, optionally attached to a specific fund/spend limit.Action🔗 Github
create-purchase-orderCreate a new purchase order against a vendor.Action🔗 Github
create-user-inviteCreate a new user and trigger an async task to send them an email invite.Action🔗 Github
create-vendorCreate a new vendor with a primary contact.Action🔗 Github
deactivate-userDeactivate a user, revoking login, card-spend, and notification access.Action🔗 Github
delete-vendorPermanently delete a vendor.Action🔗 Github
find-or-create-vendorFind a vendor by exact name or create it when missing, flagging ambiguous duplicate names.Action🔗 Github
get-bank-accountRetrieve a single externally-linked bank account by ID.Action🔗 Github
get-banking-account-balance-historyGet the daily available balance history for a Ramp Treasury/Business banking account.Action🔗 Github
get-banking-account-balance-trendGet a Ramp Treasury/Business banking account merged with its daily balance history and a computed balance trend.Action🔗 Github
get-bill-remittance-receiptFetch the PDF remittance receipt for a paid bill.Action🔗 Github
get-billRetrieve a single bill by ID.Action🔗 Github
get-business-balanceGet the business aggregate card balance, limits, and billing cycle dates.Action🔗 Github
get-business-profileGet the connected business's own profile (legal name, address, phone, card limits).Action🔗 Github
get-card-full-statusComposite: a card (physical or virtual) merged with its fund's current spending limit/balance and its recent transactions.Action🔗 Github
get-cashbackRetrieve a single cashback record by ID.Action🔗 Github
get-departmentRetrieve a single department by ID.Action🔗 Github
get-entityRetrieve a single business entity by ID.Action🔗 Github
get-fundRetrieve a single fund by ID.Action🔗 Github
get-item-receiptRetrieve a single item receipt by ID.Action🔗 Github
get-locationRetrieve a single location by ID.Action🔗 Github
get-physical-cardRetrieve a single physical card by ID.Action🔗 Github
get-purchase-orderRetrieve a single purchase order by ID.Action🔗 Github
get-receiptRetrieve a single receipt by ID, including its metadata and pre-signed download URL.Action🔗 Github
get-reimbursementRetrieve a single reimbursement by ID.Action🔗 Github
get-spend-programRetrieve a single spend program by ID, including its full custom-form field definitions.Action🔗 Github
get-statementRetrieve a single statement by ID.Action🔗 Github
get-transaction-full-contextComposite: a transaction merged with its receipts and current memo in one call.Action🔗 Github
get-transaction-memoGet the current memo text on a transaction.Action🔗 Github
get-transactionRetrieve a single transaction by its ID.Action🔗 Github
get-transferRetrieve a single transfer by ID.Action🔗 Github
get-tripRetrieve a single trip by ID.Action🔗 Github
get-user-creation-task-statusPoll the async task created by create-user-invite to retrieve the new user ID once ready.Action🔗 Github
get-userRetrieve a single Ramp user by ID.Action🔗 Github
get-vendorRetrieve a single vendor by ID.Action🔗 Github
get-virtual-cardRetrieve a single virtual card by ID.Action🔗 Github
hold-billPlace a hold on a bill, pausing any pending payment.Action🔗 Github
hold-or-release-bill-with-validationPlace or remove a hold on a bill after validating that the status transition is allowed.Action🔗 Github
list-approvalsList the approval chain and history for a set of bills, reimbursements, or transactions.Action🔗 Github
list-audit-log-eventsList business-wide audit log events (logins, approvals, transaction state changes, settings changes, etc).Action🔗 Github
list-bank-accountsList external bank accounts linked to the business.Action🔗 Github
list-banking-accountsList Ramp's own Business Account / Treasury accounts (wallet, brokerage, investment).Action🔗 Github
list-bill-draftsList bills that are still in draft state (not yet submitted into the approval/payment flow).Action🔗 Github
list-billsList Bill Pay bills with extensive filtering.Action🔗 Github
list-cashbacksList cashback payouts earned on card spend.Action🔗 Github
list-departmentsList departments.Action🔗 Github
list-entitiesList legal entities/subsidiaries under the business.Action🔗 Github
list-fundsList funds - Ramp's current API name for what the product UI still calls "spend limits" - each a card-attached spending limit with its own balance and restrictions.Action🔗 Github
list-item-receiptsList item receipts recording physical or quantity receipt against purchase order line items.Action🔗 Github
list-locationsList office/work locations.Action🔗 Github
list-merchantsList merchants the business has transacted with, with category and auto-approval metadata.Action🔗 Github
list-physical-cardsList physical cards issued to employees.Action🔗 Github
list-purchase-ordersList procurement purchase orders.Action🔗 Github
list-receiptsList receipt images/PDFs, optionally filtered by transaction or reimbursement.Action🔗 Github
list-reimbursementsList out-of-pocket and mileage reimbursements.Action🔗 Github
list-repaymentsList off-Ramp card repayments (e.g. a cardholder reimbursing the business for a disallowed personal charge).Action🔗 Github
list-rolesList the custom/base roles defined on the business, with their permission capabilities.Action🔗 Github
list-spend-programsList spend program templates that funds can be created from or inherit restrictions from.Action🔗 Github
list-statementsList card statements.Action🔗 Github
list-transactionsList card transactions, with extensive filtering and cursor pagination.Action🔗 Github
list-transfersList transfers between the business's bank accounts and its Ramp balance.Action🔗 Github
list-tripsList business trips, including their location segments, linked spend events, and total spend.Action🔗 Github
list-usersList employees/users on the business.Action🔗 Github
list-vendor-accountsList a vendor's bank accounts on file, used as payment destinations for bills.Action🔗 Github
list-vendor-contactsList contacts associated with a vendor.Action🔗 Github
list-vendor-creditsList credits issued by vendors (e.g. refunds/overpayments) applicable against future bills.Action🔗 Github
list-vendorsList vendors (payees for bills and purchase orders).Action🔗 Github
list-virtual-cardsList virtual cards.Action🔗 Github
manage-user-inviteSchedule, reschedule, deschedule, or immediately send a user's pending invite.Action🔗 Github
reactivate-userReactivate a previously-deactivated user.Action🔗 Github
release-billRemove a hold previously placed on a bill.Action🔗 Github
resume-physical-cardReverse a suspension on a physical card.Action🔗 Github
set-transaction-memoSet or replace the memo text on a transaction.Action🔗 Github
submit-bill-draftSubmit a previously-created draft bill into the normal approval/payment pipeline.Action🔗 Github
suspend-physical-cardTemporarily suspend a physical card, blocking new transactions until it is unsuspended.Action🔗 Github
terminate-fundPermanently terminate a fund (spend limit), including any cards issued against it.Action🔗 Github
terminate-physical-cardPermanently terminate a physical card.Action🔗 Github
update-departmentRename a department.Action🔗 Github
update-fundUpdate a fund.Action🔗 Github
update-locationRename a location or reassign it to a different entity.Action🔗 Github
update-physical-cardUpdate the display name, fund assignment, or automatic-routing setting of a physical card.Action🔗 Github
update-transaction-line-itemsSet or replace the accounting line-item split (amount, memo, and accounting field selections) on a transaction.Action🔗 Github
update-userUpdate a user's name, department, location, manager, or role.Action🔗 Github
update-vendorUpdate a vendor (name, address, payment terms, or active status) in Ramp.Action🔗 Github
usersSync employees/users, including suspended users.Sync🔗 Github
bank-accountsSync externally-linked bank accounts used as Bill Pay funding sources and vendor payment destinations.Sync🔗 Github
banking-account-balancesSync the daily available balance history for every Ramp Treasury/Business account.Sync🔗 Github
billsSyncs Bill Pay bills from Ramp, including their status, approval, payment and line item details.Sync🔗 Github
cardsSync both physical and virtual cards into one unified card roster sync.Sync🔗 Github
departmentsSync departments from Ramp.Sync🔗 Github
locationsSync office/work locations.Sync🔗 Github
reimbursementsSyncs out-of-pocket and mileage reimbursements and user repayments, incrementally by last-updated time.Sync🔗 Github
statementsSync card statements, including statement periods, balances, and line items.Sync🔗 Github
transactionsSync Ramp card transactions (including declined ones), incrementally by user_transaction_time with a periodic full refresh.Sync🔗 Github
vendorsSync vendors incrementally by updated_at, with a daily full refresh that detects deleted vendors.Sync🔗 Github

Access requirements

Pre-RequisitesStatusComment
Paid dev account❓
Paid test account❓
Partnership❓
App review❓
Security audit❓

Setup guide

No setup guide yet.

Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Contribute useful links by editing this page

API gotchas

  • In order to authenticate you need to have a user permission of BUSINESS_OWNER or BUSINESS_ADMIN
Contribute API gotchas by editing this page

On this page