Ramp
App · 26 actions
Automate spend management on Ramp: watch and review card transactions, reimbursements and bills, add receipts and memos, create bills and vendors, invite and offboard people, and issue funds with virtual cards.
Actions
| Action | What it does |
|---|---|
| Archive bill | Archive (delete) a bill and cancel its payment if it hasn't been sent. |
| Create bill | Add a vendor's invoice to Ramp Bill Pay for one amount. |
| Create fund | Give someone a fund: a spending limit that gets its own virtual card, such as for software or a trip. |
| Create vendor | Add a vendor with a contact, ready for bills. |
| Deactivate user | Deactivate someone, such as when they leave: they can no longer log in, spend on their cards or get Ramp emails. |
| Delete vendor | Delete a vendor. |
| Get bill | Get one bill: vendor, invoice number, amount, due date, approval and payment state. |
| Get company balance | Get your company's details in Ramp with its card limit, what is still available, the card balance and the next statement date. |
| Get fund | Get one fund: its limit, how often it resets, what has been spent, who can spend from it and its cards. |
| Get reimbursement | Get one reimbursement: who it is for, the amount, the merchant, its state and when it was approved and paid. |
| Get transaction | Get one card transaction: amount, merchant, cardholder, memo, category and whether it has everything it needs. |
| Get user | Get one person: name, email, role, status, department, location and manager. |
| Invite user | Add someone to Ramp with a role, department, location and manager, and email them an invite (or keep them as a draft). |
| List bills | List bills from vendors, filtered by vendor, paid or not, approval, due date or invoice number. |
| List funds | List funds (spending limits) with their limits, what has been spent and their cards. |
| List reimbursements | List reimbursements of out-of-pocket and mileage expenses, filtered by date, state or person. |
| List transactions | List card transactions, newest first, filtered by date, state, cardholder, department, location, category or amount. |
| List users | List the people on your Ramp account, filtered by role, status, department, location or email. |
| List vendors | List vendors, optionally only those with a name or only active ones. |
| Set transaction memo | Write the memo on a card transaction (what it was for), replacing the one it had. |
| Suspend or unsuspend fund | Stop spending from a fund and its cards, or allow it again. |
| Terminate fund | End a fund for good, with its virtual cards. |
| Update fund | Change a fund's name, limit, how often it resets, the most per purchase or the day it suspends itself. |
| Update user | Change someone's name, role, department, location or manager. |
| Update vendor | Change a vendor's name, payment terms, your ID for it or its country, or make it active or inactive. |
| Upload receipt | Upload a receipt image or PDF to a card transaction. |
Archive bill
Archive (delete) a bill and cancel its payment if it hasn't been sent. Paid bills can't be archived.
Inputs
- Bill
bill_idtextRequired - The bill's ID, from List bills, Create bill or an earlier step.
Outputs
archivedtrue/false- Always true once archived
bill_idtext- The bill archived
Example output
{
"archived": true,
"bill_id": "6e3816e3-0e53-42ae-b075-bdb0adff10c4"
}Create bill
Add a vendor's invoice to Ramp Bill Pay for one amount. It then goes through your approvals; payment is set up in Ramp.
Inputs
- Vendor
vendor_idtextRequired - The vendor. Pick one, or give its ID from an earlier step.
- Invoice number
invoice_numbertextRequired - The number on the vendor's invoice.
- Amount
amountnumberRequired - The total to pay, such as 1250.00.At least 0.01.
- Due date
due_datedateRequired - When the vendor should be paid by.
- Invoice date
issued_datedate - The date on the invoice. Defaults to today.
- Currency
currencytext - The invoice's currency code, such as EUR. Defaults to USD.
- Description
descriptiontext - What the bill is for, shown on its line.
- Memo
memotext - A note on the bill for your team.
- Entity
entity_idtext - The business entity paying it. Defaults to the vendor's, or your only one.
- Vendor contact
vendor_contact_idtext - The vendor contact's ID. Defaults to the vendor's main contact.
Outputs
billobject- The bill
Example output
{
"bill": {
"amount": 969.93,
"amount_cents": 96993,
"approval_status": "PENDING",
"archived_at": null,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"due_at": "2026-10-31T00:00:00+00:00",
"entity_id": "5bcc3734-f03a-4756-bc4b-afeb52d738ad",
"id": "6e3816e3-0e53-42ae-b075-bdb0adff10c4",
"invoice_number": "432",
"issued_at": "2026-10-01T00:00:00+00:00",
"memo": "Office Supplies",
"owner_name": "John Doe",
"paid_at": null,
"payment_date": null,
"payment_method": null,
"status": "OPEN",
"status_summary": "APPROVAL_PENDING",
"vendor_id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a",
"vendor_memo": null,
"vendor_name": "Ali's Art shop"
}
}Create fund
Give someone a fund: a spending limit that gets its own virtual card, such as for software or a trip. Start from a spend program or set the limit here.
Inputs
- Owner
owner_idtextRequired - The person the fund is for.
- Name
nametext - What the fund is for, such as Software. Needed unless a spend program is chosen.
- Limit
amountnumber - How much can be spent each interval, such as 500. Needed unless a spend program is chosen.At least 0.01.
- Resets
intervaltext - How often the limit starts again. Defaults to every month.One of:
MONTHLY(Every month),WEEKLY(Every week),DAILY(Every day),QUARTERLY(Every quarter),YEARLY(Every year),TOTAL(In total, never resets). - Spend program
spend_program_idtext - Start from one of your spend programs and take its settings.
- Most per purchase
per_purchase_limitnumber - The most any one purchase may be.At least 0.01.
- Currency
currencytext - The limit's currency code, such as EUR. Defaults to USD.
- Only these categories
allowed_categorieslist - Allow spending only in these categories.One or more of:
4(Airlines),20(Alcohol and bars),27(Advertising),16(Books and newspapers),5(Car rental),29(Car services),34(Charitable donations),15(Clothing),41(Cloud computing),31(Clubs and memberships), and 33 more. - Block these categories
blocked_categorieslist - Refuse purchases in these categories.One or more of:
4(Airlines),20(Alcohol and bars),27(Advertising),16(Books and newspapers),5(Car rental),29(Car services),34(Charitable donations),15(Clothing),41(Cloud computing),31(Clubs and memberships), and 33 more. - Suspend on
lock_datedate - The day the fund suspends itself, such as the end of a trip.
- Virtual card
virtual_cardtrue/false - Give the fund its own virtual card.Default:
true. - Physical card
physical_cardtrue/false - Let the owner's physical card spend from it too.Default:
false. - Reimbursements
reimbursementstrue/false - Let the owner claim reimbursements from it.Default:
false.
Outputs
fundobject- The fund
Example output
{
"fund": {
"card_ids": [
"a40a6ce8-70d4-4d06-91e1-0728ad9bbe39"
],
"card_last_four": "2543",
"cleared": 65.0,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"entity_id": "c18d9d2e-964f-476d-8bb3-9ac078f00e11",
"id": "d8135cfe-0396-4b2d-b2cf-ad809fb04731",
"interval": "MONTHLY",
"is_shareable": false,
"limit": 500.0,
"limit_cents": 50000,
"lock_date": null,
"member_ids": [
"2ba219ba-5867-453f-bec2-b8d0414b7f75"
],
"name": "Software",
"pending": 35.0,
"per_purchase_limit": 100.0,
"physical_card_enabled": false,
"reimbursements_enabled": false,
"spend_program_id": null,
"spent": 100.0,
"state": "ACTIVE",
"suspended": false,
"virtual_card_enabled": true
}
}Create vendor
Add a vendor with a contact, ready for bills. Vendors added this way skip Ramp's vendor approval.
Inputs
- Name
nametextRequired - The vendor's name.
- Contact email
contact_emailtextRequired - The email address of your contact at the vendor.
- Contact first name
contact_first_nametext - Your contact's first name.
- Contact last name
contact_last_nametext - Your contact's last name.
- Country
countrytext - The vendor's two-letter country code, such as US or GB. Defaults to US.
- US state
statetext - For a US vendor, the two-letter state code, such as CA.
- Payment terms (days)
net_payment_termsnumber - How many days after an invoice arrives it is due, such as 30.From 0 to 3650.
- Your vendor ID
external_vendor_idtext - Your own ID for the vendor, such as the one in your other systems.
- Ask for bank details
request_payment_detailstrue/false - Email the contact asking for their bank details so you can pay them.Default:
false.
Outputs
vendorobject- The vendor
Example output
{
"vendor": {
"category": "General merchandise",
"contact_ids": [
"315eb85a-3a60-45ba-8d1c-67385cd0281f"
],
"country": "US",
"created_at": "2026-05-12T02:23:00+00:00",
"default_entity_id": "90b73fdf-e058-4cad-970d-0ed5a6949792",
"external_vendor_id": "EXT-12345",
"id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a",
"is_active": true,
"name": "Ali's Art shop",
"net_payment_terms": 30,
"owner_id": null,
"spend_currency": "USD",
"spend_this_year": 1250.0,
"state": "CA",
"updated_at": "2026-10-01T09:00:00+00:00"
}
}Deactivate user
Deactivate someone, such as when they leave: they can no longer log in, spend on their cards or get Ramp emails.
Inputs
- Person
ramp_user_idtextRequired - The person in Ramp. Pick one, or give their user ID.
Outputs
userobject- The person
Example output
{
"user": {
"department_id": "2d68eb67-f6eb-4284-8683-7d530c77a5a6",
"email": "linda@example.com",
"employee_id": "E-1042",
"entity_id": "0e90959a-28ba-4f7d-a75b-9c241f384b9a",
"first_name": "Linda",
"id": "bde8334e-042e-4f39-9a5d-355ae17342e6",
"is_manager": false,
"last_name": "Gu",
"location_id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
"manager_id": "ccc5d4cc-337f-49a5-86b3-5df128233f2c",
"name": "Linda Gu",
"role": "BUSINESS_USER",
"status": "USER_INACTIVE"
}
}Delete vendor
Delete a vendor. One with transactions, bills or contracts can't be deleted; make it inactive with Update vendor instead.
Inputs
- Vendor
vendor_idtextRequired - The vendor. Pick one, or give its ID from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
vendor_idtext- The vendor deleted
Example output
{
"deleted": true,
"vendor_id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a"
}Get bill
Get one bill: vendor, invoice number, amount, due date, approval and payment state.
Inputs
- Bill
bill_idtextRequired - The bill's ID, from List bills, Create bill or an earlier step.
Outputs
billobject- The bill
Example output
{
"bill": {
"amount": 969.93,
"amount_cents": 96993,
"approval_status": "PENDING",
"archived_at": null,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"due_at": "2026-10-31T00:00:00+00:00",
"entity_id": "5bcc3734-f03a-4756-bc4b-afeb52d738ad",
"id": "6e3816e3-0e53-42ae-b075-bdb0adff10c4",
"invoice_number": "432",
"issued_at": "2026-10-01T00:00:00+00:00",
"memo": "Office Supplies",
"owner_name": "John Doe",
"paid_at": null,
"payment_date": null,
"payment_method": null,
"status": "OPEN",
"status_summary": "APPROVAL_PENDING",
"vendor_id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a",
"vendor_memo": null,
"vendor_name": "Ali's Art shop"
}
}Get company balance
Get your company's details in Ramp with its card limit, what is still available, the card balance and the next statement date.
Inputs
None.
Outputs
businessobject- Your company
Example output
{
"business": {
"active": true,
"available_card_limit": 1993728.78,
"card_balance": 6271.22,
"card_limit": 2000000.0,
"created_at": "2022-08-20T16:54:29+00:00",
"id": "9abffcf0-dd7d-42f0-b806-ce0502ab6496",
"name": "Sushi Luncheonette",
"name_on_card": "Sushi Luncheonette",
"next_billing_date": "2026-11-01",
"phone": "8014441234",
"previous_billing_date": "2026-10-01",
"statement_balance": 4941.29,
"website": "www.example.com"
}
}Get fund
Get one fund: its limit, how often it resets, what has been spent, who can spend from it and its cards.
Inputs
- Fund
fund_idtextRequired - The fund. Pick one, or give its ID from an earlier step.
Outputs
fundobject- The fund
Example output
{
"fund": {
"card_ids": [
"a40a6ce8-70d4-4d06-91e1-0728ad9bbe39"
],
"card_last_four": "2543",
"cleared": 65.0,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"entity_id": "c18d9d2e-964f-476d-8bb3-9ac078f00e11",
"id": "d8135cfe-0396-4b2d-b2cf-ad809fb04731",
"interval": "MONTHLY",
"is_shareable": false,
"limit": 500.0,
"limit_cents": 50000,
"lock_date": null,
"member_ids": [
"2ba219ba-5867-453f-bec2-b8d0414b7f75"
],
"name": "Software",
"pending": 35.0,
"per_purchase_limit": 100.0,
"physical_card_enabled": false,
"reimbursements_enabled": false,
"spend_program_id": null,
"spent": 100.0,
"state": "ACTIVE",
"suspended": false,
"virtual_card_enabled": true
}
}Get reimbursement
Get one reimbursement: who it is for, the amount, the merchant, its state and when it was approved and paid.
Inputs
- Reimbursement
reimbursement_idtextRequired - The reimbursement's ID, from List reimbursements, the New reimbursement trigger or an earlier step.
Outputs
reimbursementobject- The reimbursement
Example output
{
"reimbursement": {
"amount": 48.45,
"amount_cents": 4845,
"approved_at": null,
"created_at": "2026-10-02T18:00:00+00:00",
"currency": "USD",
"distance_miles": null,
"end_location": null,
"entity_id": "4bec9dc1-710e-4781-b254-fc606c76a241",
"fund_id": "92a68991-8374-4c0a-b5c0-5180c41b5148",
"id": "d47ba06e-14ac-4a7b-89b4-4775412ba545",
"memo": "Printer paper",
"merchant": "Office Depot",
"original_amount": 48.45,
"original_currency": "USD",
"paid_at": null,
"receipt_count": 1,
"start_location": null,
"state": "PENDING",
"submitted_at": "2026-10-02T18:05:00+00:00",
"sync_status": "NOT_SYNC_READY",
"transaction_date": "2026-10-02",
"type": "OUT_OF_POCKET",
"user_email": "joe@example.com",
"user_id": "7979392e-8d41-4f97-815b-ccd7584802bf",
"user_name": "Joe Johnson"
}
}Get transaction
Get one card transaction: amount, merchant, cardholder, memo, category and whether it has everything it needs.
Inputs
- Transaction
transaction_idtextRequired - The card transaction's ID, from List transactions, the New transaction trigger or an earlier step.
Outputs
transactionobject- The transaction
Example output
{
"transaction": {
"amount": 90.0,
"amount_cents": 9000,
"amount_display": "$90.00",
"card_id": "6bc41b14-f853-4862-bae5-4f122f123f6e",
"cardholder_first_name": "Patrick",
"cardholder_name": "Patrick Robinson",
"category": "Taxi and rideshare",
"currency": "USD",
"date_display": "Oct 3, 2026",
"department_name": "Executive",
"entity_id": "24850cdb-1b3f-4eb9-bf20-967ca9f97605",
"fully_approved": true,
"fund_id": "5e25f547-bd09-40ad-aab3-b8fefdf16885",
"id": "fd14cd6a-846e-4994-9315-5a59e6bb465f",
"location_name": "San Francisco",
"memo": "Ride to client office",
"merchant_id": "ba5d8e64-0f04-4d0c-9a0c-6c3f6a4d6f7e",
"merchant_name": "Uber",
"original_amount": 90.0,
"original_currency": "USD",
"receipt_count": 1,
"settled_at": "2026-10-04T00:00:00+00:00",
"spend_program_id": null,
"state": "CLEARED",
"sync_status": "SYNC_READY",
"transaction_time": "2026-10-03T14:20:00+00:00",
"user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
}
}Get user
Get one person: name, email, role, status, department, location and manager.
Inputs
- Person
ramp_user_idtextRequired - The person in Ramp. Pick one, or give their user ID.
Outputs
userobject- The person
Example output
{
"user": {
"department_id": "2d68eb67-f6eb-4284-8683-7d530c77a5a6",
"email": "linda@example.com",
"employee_id": "E-1042",
"entity_id": "0e90959a-28ba-4f7d-a75b-9c241f384b9a",
"first_name": "Linda",
"id": "bde8334e-042e-4f39-9a5d-355ae17342e6",
"is_manager": false,
"last_name": "Gu",
"location_id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
"manager_id": "ccc5d4cc-337f-49a5-86b3-5df128233f2c",
"name": "Linda Gu",
"role": "BUSINESS_USER",
"status": "USER_ACTIVE"
}
}Invite user
Add someone to Ramp with a role, department, location and manager, and email them an invite (or keep them as a draft).
Inputs
- Email
emailtextRequired - Their work email address.
- First name
first_nametextRequired - Their first name.
- Last name
last_nametextRequired - Their last name.
- Role
roletext - What they can do in Ramp. Defaults to employee.One of:
BUSINESS_USER(Employee),BUSINESS_ADMIN(Admin),BUSINESS_BOOKKEEPER(Bookkeeper),IT_ADMIN(IT admin),AUDITOR,GUEST_USER(Guest). Default:BUSINESS_USER. - Department
department_idtext - Their department.
- Location
location_idtext - Their location, which also sets their business entity.
- Manager
manager_idtext - The person they report to.
- Send the invite email
send_invitetrue/false - Email them an invite now. Turn off to add them as a draft and invite them from Ramp later.Default:
true.
Outputs
statustext- SUCCESS, or IN_PROGRESS if Ramp is still working
task_idtext- Ramp's ID for the invite task
userobject- The new person
user_idtext- The new person's user ID, empty if Ramp is still adding them
Example output
{
"status": "SUCCESS",
"task_id": "eca553b8-6923-42b2-aea9-8f3c15b079ff",
"user": {
"department_id": "2d68eb67-f6eb-4284-8683-7d530c77a5a6",
"email": "linda@example.com",
"employee_id": "E-1042",
"entity_id": "0e90959a-28ba-4f7d-a75b-9c241f384b9a",
"first_name": "Linda",
"id": "bde8334e-042e-4f39-9a5d-355ae17342e6",
"is_manager": false,
"last_name": "Gu",
"location_id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
"manager_id": "ccc5d4cc-337f-49a5-86b3-5df128233f2c",
"name": "Linda Gu",
"role": "BUSINESS_USER",
"status": "INVITE_PENDING"
},
"user_id": "bde8334e-042e-4f39-9a5d-355ae17342e6"
}List bills
List bills from vendors, filtered by vendor, paid or not, approval, due date or invoice number.
Inputs
- Vendor
vendor_idtext - Only bills from this vendor.
- Paid
payment_statustext - Only bills that are paid, or only those not paid yet.One of:
OPEN(Not paid yet),PAID. - Approval
approval_statustext - Only bills in this approval state.One of:
PENDING(Waiting for approval),APPROVED,REJECTED. - Due from
due_fromdate - Only bills due on or after this day.
- Due to
due_todate - Only bills due on or before this day.
- Invoice number
invoice_numbertext - Only the bill with exactly this invoice number.
- How many
limitnumber - How many to return, 1 to 100.From 1 to 100. Default:
20. - Next page
cursortext - The next_cursor from an earlier list step, to get the page after it.
Outputs
billslist- The bills
countnumber- How many are on this page
next_cursortext- Pass as Next page to get the page after this; empty on the last
Example output
{
"bills": [
{
"amount": 969.93,
"amount_cents": 96993,
"approval_status": "PENDING",
"archived_at": null,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"due_at": "2026-10-31T00:00:00+00:00",
"entity_id": "5bcc3734-f03a-4756-bc4b-afeb52d738ad",
"id": "6e3816e3-0e53-42ae-b075-bdb0adff10c4",
"invoice_number": "432",
"issued_at": "2026-10-01T00:00:00+00:00",
"memo": "Office Supplies",
"owner_name": "John Doe",
"paid_at": null,
"payment_date": null,
"payment_method": null,
"status": "OPEN",
"status_summary": "APPROVAL_PENDING",
"vendor_id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a",
"vendor_memo": null,
"vendor_name": "Ali's Art shop"
}
],
"count": 1,
"next_cursor": ""
}List funds
List funds (spending limits) with their limits, what has been spent and their cards.
Inputs
- Owner
owner_idtext - Only funds this person owns.
- Spend program
spend_program_idtext - Only funds from this spend program.
- Terminated only
terminatedtrue/false - Show only funds that were terminated.Default:
false. - How many
limitnumber - How many to return, 1 to 100.From 1 to 100. Default:
20. - Next page
cursortext - The next_cursor from an earlier list step, to get the page after it.
Outputs
countnumber- How many are on this page
fundslist- The funds
next_cursortext- Pass as Next page to get the page after this; empty on the last
Example output
{
"count": 1,
"funds": [
{
"card_ids": [
"a40a6ce8-70d4-4d06-91e1-0728ad9bbe39"
],
"card_last_four": "2543",
"cleared": 65.0,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"entity_id": "c18d9d2e-964f-476d-8bb3-9ac078f00e11",
"id": "d8135cfe-0396-4b2d-b2cf-ad809fb04731",
"interval": "MONTHLY",
"is_shareable": false,
"limit": 500.0,
"limit_cents": 50000,
"lock_date": null,
"member_ids": [
"2ba219ba-5867-453f-bec2-b8d0414b7f75"
],
"name": "Software",
"pending": 35.0,
"per_purchase_limit": 100.0,
"physical_card_enabled": false,
"reimbursements_enabled": false,
"spend_program_id": null,
"spent": 100.0,
"state": "ACTIVE",
"suspended": false,
"virtual_card_enabled": true
}
],
"next_cursor": ""
}List reimbursements
List reimbursements of out-of-pocket and mileage expenses, filtered by date, state or person.
Inputs
- Created from
from_datedate - Only reimbursements created on or after this day.
- Created to
to_datedate - Only reimbursements created on or before this day.
- State
statetext - Only reimbursements in this state.One of:
PENDING(Waiting for approval),APPROVED,AWAITING_PAYMENT(Waiting to be paid),REIMBURSED(Paid),REJECTED,CANCELED,DRAFT. - Person
ramp_user_idtext - Only this person's reimbursements.
- How many
limitnumber - How many to return, 1 to 100.From 1 to 100. Default:
20. - Next page
cursortext - The next_cursor from an earlier list step, to get the page after it.
Outputs
countnumber- How many are on this page
next_cursortext- Pass as Next page to get the page after this; empty on the last
reimbursementslist- The reimbursements
Example output
{
"count": 1,
"next_cursor": "",
"reimbursements": [
{
"amount": 48.45,
"amount_cents": 4845,
"approved_at": null,
"created_at": "2026-10-02T18:00:00+00:00",
"currency": "USD",
"distance_miles": null,
"end_location": null,
"entity_id": "4bec9dc1-710e-4781-b254-fc606c76a241",
"fund_id": "92a68991-8374-4c0a-b5c0-5180c41b5148",
"id": "d47ba06e-14ac-4a7b-89b4-4775412ba545",
"memo": "Printer paper",
"merchant": "Office Depot",
"original_amount": 48.45,
"original_currency": "USD",
"paid_at": null,
"receipt_count": 1,
"start_location": null,
"state": "PENDING",
"submitted_at": "2026-10-02T18:05:00+00:00",
"sync_status": "NOT_SYNC_READY",
"transaction_date": "2026-10-02",
"type": "OUT_OF_POCKET",
"user_email": "joe@example.com",
"user_id": "7979392e-8d41-4f97-815b-ccd7584802bf",
"user_name": "Joe Johnson"
}
]
}List transactions
List card transactions, newest first, filtered by date, state, cardholder, department, location, category or amount. Beta: In the last (days), More than and Missing a receipt filter further; Every page returns them all at once; each transaction has its amount and date ready to read; Add cardholder emails adds each cardholder's email; and by_cardholder groups them per person, with a total and their transactions written as lines, ready for one message to each person.
Inputs
- From
from_datedate - Only purchases made on or after this day.
- To
to_datedate - Only purchases made on or before this day.
- In the last (days)
in_last_daysnumber - Beta. Only purchases from the last this many days up to now, such as 7 for the last week, so no earlier step has to work out the start date. Use it instead of From.From 1 to 730.
- State
statetext - Leave empty for every transaction except declined ones.One of:
CLEARED,PENDING,DECLINED,ALL(All, including declined). - Cardholder
cardholder_idtext - Only this person's transactions.
- Department
department_idtext - Only transactions by people in this department.
- Location
location_idtext - Only transactions by people at this location.
- Category
categorytext - Only transactions in this Ramp spending category.One of:
4(Airlines),20(Alcohol and bars),27(Advertising),16(Books and newspapers),5(Car rental),29(Car services),34(Charitable donations),15(Clothing),41(Cloud computing),31(Clubs and memberships), and 33 more. - At least
min_amountnumber - Only transactions of at least this many US dollars.At least 0.
- More than
more_thannumber - Beta. Only transactions of more than this many US dollars, so "over $500" is 500 (At least 500 would include $500.00 itself). Use it instead of At least.At least 0.
- At most
max_amountnumber - Only transactions of at most this many US dollars.At least 0.
- Missing a receipt
missing_receipttrue/false - Beta. Only transactions with no receipt attached, so no Filter step on the receipt count is needed.Default:
false. - Order
ordertext - How to sort them. Defaults to newest first.One of:
newest(Newest first),oldest(Oldest first),largest(Largest first),smallest(Smallest first). Default:newest. - How many
limitnumber - How many to return, 1 to 100.From 1 to 100. Default:
20. - Next page
cursortext - The next_cursor from an earlier list step, to get the page after it.
- Every page
all_pagestrue/false - Beta. Return every matching transaction (up to 1,000) in one go, so no loop over Next page is needed. How many is then ignored.Default:
false. - Add cardholder emails
cardholder_emailstrue/false - Beta. Look up each cardholder's email address (once per person) and add it to their transactions and to By cardholder, so no Get user step is needed to email them. Needs the users:read scope.Default:
false.
Outputs
by_cardholderlist- Beta. The transactions grouped by cardholder, for one message to each person. Transactions with no cardholder are left out.
countnumber- How many are on this page
next_cursortext- Pass as Next page to get the page after this; empty on the last
transactionslist- The transactions
Example output
{
"by_cardholder": [
{
"count": 1,
"email": "patrick@example.com",
"first_name": "Patrick",
"name": "Patrick Robinson",
"total": 90.0,
"total_display": "$90.00",
"transaction_lines": "\u2022 Oct 3, 2026, $90.00, Uber",
"transactions": [
{
"amount": 90.0,
"amount_cents": 9000,
"amount_display": "$90.00",
"card_id": "6bc41b14-f853-4862-bae5-4f122f123f6e",
"cardholder_email": "patrick@example.com",
"cardholder_first_name": "Patrick",
"cardholder_name": "Patrick Robinson",
"category": "Taxi and rideshare",
"currency": "USD",
"date_display": "Oct 3, 2026",
"department_name": "Executive",
"entity_id": "24850cdb-1b3f-4eb9-bf20-967ca9f97605",
"fully_approved": true,
"fund_id": "5e25f547-bd09-40ad-aab3-b8fefdf16885",
"id": "fd14cd6a-846e-4994-9315-5a59e6bb465f",
"location_name": "San Francisco",
"memo": "Ride to client office",
"merchant_id": "ba5d8e64-0f04-4d0c-9a0c-6c3f6a4d6f7e",
"merchant_name": "Uber",
"original_amount": 90.0,
"original_currency": "USD",
"receipt_count": 1,
"settled_at": "2026-10-04T00:00:00+00:00",
"spend_program_id": null,
"state": "CLEARED",
"sync_status": "SYNC_READY",
"transaction_time": "2026-10-03T14:20:00+00:00",
"user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
}
],
"user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
}
],
"count": 1,
"next_cursor": "",
"transactions": [
{
"amount": 90.0,
"amount_cents": 9000,
"amount_display": "$90.00",
"card_id": "6bc41b14-f853-4862-bae5-4f122f123f6e",
"cardholder_email": "patrick@example.com",
"cardholder_first_name": "Patrick",
"cardholder_name": "Patrick Robinson",
"category": "Taxi and rideshare",
"currency": "USD",
"date_display": "Oct 3, 2026",
"department_name": "Executive",
"entity_id": "24850cdb-1b3f-4eb9-bf20-967ca9f97605",
"fully_approved": true,
"fund_id": "5e25f547-bd09-40ad-aab3-b8fefdf16885",
"id": "fd14cd6a-846e-4994-9315-5a59e6bb465f",
"location_name": "San Francisco",
"memo": "Ride to client office",
"merchant_id": "ba5d8e64-0f04-4d0c-9a0c-6c3f6a4d6f7e",
"merchant_name": "Uber",
"original_amount": 90.0,
"original_currency": "USD",
"receipt_count": 1,
"settled_at": "2026-10-04T00:00:00+00:00",
"spend_program_id": null,
"state": "CLEARED",
"sync_status": "SYNC_READY",
"transaction_time": "2026-10-03T14:20:00+00:00",
"user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
}
]
}List users
List the people on your Ramp account, filtered by role, status, department, location or email.
Inputs
- Role
roletext - Only people with this role.One of:
BUSINESS_USER(Employee),BUSINESS_ADMIN(Admin),BUSINESS_BOOKKEEPER(Bookkeeper),IT_ADMIN(IT admin),AUDITOR,GUEST_USER(Guest),BUSINESS_OWNER(Owner). - Status
statustext - Leave empty for active and deactivated people.One of:
USER_ACTIVE(Active),USER_INACTIVE(Deactivated),USER_SUSPENDED(Suspended),USER_DRAFT(Draft (not invited yet)). - Department
department_idtext - Only people in this department.
- Location
location_idtext - Only people at this location.
- Email
emailtext - Only the person with this email address.
- How many
limitnumber - How many to return, 1 to 100.From 1 to 100. Default:
20. - Next page
cursortext - The next_cursor from an earlier list step, to get the page after it.
Outputs
countnumber- How many are on this page
next_cursortext- Pass as Next page to get the page after this; empty on the last
userslist- The people
Example output
{
"count": 1,
"next_cursor": "",
"users": [
{
"department_id": "2d68eb67-f6eb-4284-8683-7d530c77a5a6",
"email": "linda@example.com",
"employee_id": "E-1042",
"entity_id": "0e90959a-28ba-4f7d-a75b-9c241f384b9a",
"first_name": "Linda",
"id": "bde8334e-042e-4f39-9a5d-355ae17342e6",
"is_manager": false,
"last_name": "Gu",
"location_id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
"manager_id": "ccc5d4cc-337f-49a5-86b3-5df128233f2c",
"name": "Linda Gu",
"role": "BUSINESS_USER",
"status": "USER_ACTIVE"
}
]
}List vendors
List vendors, optionally only those with a name or only active ones.
Inputs
- Name
nametext - Only the vendor with this name.
- Active
activetext - Only active, or only inactive, vendors.One of:
active,inactive. - How many
limitnumber - How many to return, 1 to 100.From 1 to 100. Default:
20. - Next page
cursortext - The next_cursor from an earlier list step, to get the page after it.
Outputs
countnumber- How many are on this page
next_cursortext- Pass as Next page to get the page after this; empty on the last
vendorslist- The vendors
Example output
{
"count": 1,
"next_cursor": "",
"vendors": [
{
"category": "General merchandise",
"contact_ids": [
"315eb85a-3a60-45ba-8d1c-67385cd0281f"
],
"country": "US",
"created_at": "2026-05-12T02:23:00+00:00",
"default_entity_id": "90b73fdf-e058-4cad-970d-0ed5a6949792",
"external_vendor_id": "EXT-12345",
"id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a",
"is_active": true,
"name": "Ali's Art shop",
"net_payment_terms": 30,
"owner_id": null,
"spend_currency": "USD",
"spend_this_year": 1250.0,
"state": "CA",
"updated_at": "2026-10-01T09:00:00+00:00"
}
]
}Set transaction memo
Write the memo on a card transaction (what it was for), replacing the one it had.
Inputs
- Transaction
transaction_idtextRequired - The card transaction's ID, from List transactions, the New transaction trigger or an earlier step.
- Memo
memotextRequired - What the purchase was for, up to 255 characters.
Outputs
memotext- The memo now on it
transaction_idtext- The transaction's ID
Example output
{
"memo": "Team lunch with Acme",
"transaction_id": "fd14cd6a-846e-4994-9315-5a59e6bb465f"
}Suspend or unsuspend fund
Stop spending from a fund and its cards, or allow it again. Nothing changes if it is already that way.
Inputs
- Fund
fund_idtextRequired - The fund. Pick one, or give its ID from an earlier step.
- Change
changetextRequired - Suspend stops all spending; unsuspend allows it again.One of:
suspend(Suspend (stop spending)),unsuspend(Unsuspend (allow spending again)).
Outputs
changedtrue/false- False if it was already that way
fundobject- The fund
Example output
{
"changed": true,
"fund": {
"card_ids": [
"a40a6ce8-70d4-4d06-91e1-0728ad9bbe39"
],
"card_last_four": "2543",
"cleared": 65.0,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"entity_id": "c18d9d2e-964f-476d-8bb3-9ac078f00e11",
"id": "d8135cfe-0396-4b2d-b2cf-ad809fb04731",
"interval": "MONTHLY",
"is_shareable": false,
"limit": 500.0,
"limit_cents": 50000,
"lock_date": null,
"member_ids": [
"2ba219ba-5867-453f-bec2-b8d0414b7f75"
],
"name": "Software",
"pending": 35.0,
"per_purchase_limit": 100.0,
"physical_card_enabled": false,
"reimbursements_enabled": false,
"spend_program_id": null,
"spent": 100.0,
"state": "SUSPENDED",
"suspended": true,
"virtual_card_enabled": true
}
}Terminate fund
End a fund for good, with its virtual cards. This can't be undone.
Inputs
- Fund
fund_idtextRequired - The fund. Pick one, or give its ID from an earlier step.
Outputs
fundobject- The fund
Example output
{
"fund": {
"card_ids": [
"a40a6ce8-70d4-4d06-91e1-0728ad9bbe39"
],
"card_last_four": "2543",
"cleared": 65.0,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"entity_id": "c18d9d2e-964f-476d-8bb3-9ac078f00e11",
"id": "d8135cfe-0396-4b2d-b2cf-ad809fb04731",
"interval": "MONTHLY",
"is_shareable": false,
"limit": 500.0,
"limit_cents": 50000,
"lock_date": null,
"member_ids": [
"2ba219ba-5867-453f-bec2-b8d0414b7f75"
],
"name": "Software",
"pending": 35.0,
"per_purchase_limit": 100.0,
"physical_card_enabled": false,
"reimbursements_enabled": false,
"spend_program_id": null,
"spent": 100.0,
"state": "TERMINATED",
"suspended": false,
"virtual_card_enabled": true
}
}Update fund
Change a fund's name, limit, how often it resets, the most per purchase or the day it suspends itself.
Inputs
- Fund
fund_idtextRequired - The fund. Pick one, or give its ID from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Limit
amountnumber - A new limit per interval, such as 750. Leave empty to keep it.At least 0.01.
- Resets
intervaltext - A new interval. Leave empty to keep it.One of:
MONTHLY(Every month),WEEKLY(Every week),DAILY(Every day),QUARTERLY(Every quarter),YEARLY(Every year),TOTAL(In total, never resets). - Most per purchase
per_purchase_limitnumber - The most any one purchase may be.At least 0.01.
- Suspend on
lock_datedate - The day the fund suspends itself, such as the end of a trip.
Outputs
fundobject- The fund
Example output
{
"fund": {
"card_ids": [
"a40a6ce8-70d4-4d06-91e1-0728ad9bbe39"
],
"card_last_four": "2543",
"cleared": 65.0,
"created_at": "2026-10-01T01:37:27+00:00",
"currency": "USD",
"entity_id": "c18d9d2e-964f-476d-8bb3-9ac078f00e11",
"id": "d8135cfe-0396-4b2d-b2cf-ad809fb04731",
"interval": "MONTHLY",
"is_shareable": false,
"limit": 750.0,
"limit_cents": 75000,
"lock_date": null,
"member_ids": [
"2ba219ba-5867-453f-bec2-b8d0414b7f75"
],
"name": "Software",
"pending": 35.0,
"per_purchase_limit": 100.0,
"physical_card_enabled": false,
"reimbursements_enabled": false,
"spend_program_id": null,
"spent": 100.0,
"state": "ACTIVE",
"suspended": false,
"virtual_card_enabled": true
}
}Update user
Change someone's name, role, department, location or manager. Only the fields given change.
Inputs
- Person
ramp_user_idtextRequired - The person in Ramp. Pick one, or give their user ID.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Role
roletext - A new role. Leave empty to keep it.One of:
BUSINESS_USER(Employee),BUSINESS_ADMIN(Admin),BUSINESS_BOOKKEEPER(Bookkeeper),IT_ADMIN(IT admin),AUDITOR,GUEST_USER(Guest). - Department
department_idtext - Their department.
- Location
location_idtext - Their location, which also sets their business entity.
- Manager
manager_idtext - The person they report to.
Outputs
userobject- The person
Example output
{
"user": {
"department_id": "2d68eb67-f6eb-4284-8683-7d530c77a5a6",
"email": "linda@example.com",
"employee_id": "E-1042",
"entity_id": "0e90959a-28ba-4f7d-a75b-9c241f384b9a",
"first_name": "Linda",
"id": "bde8334e-042e-4f39-9a5d-355ae17342e6",
"is_manager": false,
"last_name": "Gu",
"location_id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
"manager_id": "ccc5d4cc-337f-49a5-86b3-5df128233f2c",
"name": "Linda Gu",
"role": "BUSINESS_USER",
"status": "USER_ACTIVE"
}
}Update vendor
Change a vendor's name, payment terms, your ID for it or its country, or make it active or inactive. Only fields given change.
Inputs
- Vendor
vendor_idtextRequired - The vendor. Pick one, or give its ID from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Active
activetext - Make the vendor active or inactive. Leave empty to keep it.One of:
active,inactive. - Payment terms (days)
net_payment_termsnumber - How many days after an invoice arrives it is due, such as 30.From 0 to 3650.
- Your vendor ID
external_vendor_idtext - Your own ID for the vendor, such as the one in your other systems.
- Country
countrytext - The vendor's two-letter country code, such as US or GB. Defaults to US.
- US state
statetext - For a US vendor, the two-letter state code, such as CA.
Outputs
vendorobject- The vendor
Example output
{
"vendor": {
"category": "General merchandise",
"contact_ids": [
"315eb85a-3a60-45ba-8d1c-67385cd0281f"
],
"country": "US",
"created_at": "2026-05-12T02:23:00+00:00",
"default_entity_id": "90b73fdf-e058-4cad-970d-0ed5a6949792",
"external_vendor_id": "EXT-12345",
"id": "4f08baf7-e3f0-4271-aedd-4d2c2214ed9a",
"is_active": true,
"name": "Ali's Art shop",
"net_payment_terms": 30,
"owner_id": null,
"spend_currency": "USD",
"spend_this_year": 1250.0,
"state": "CA",
"updated_at": "2026-10-01T09:00:00+00:00"
}
}Upload receipt
Upload a receipt image or PDF to a card transaction. Without a transaction, Ramp matches it to the right one itself.
Inputs
- Receipt
receipttextRequired - The receipt, as an image or PDF.
- Cardholder
cardholder_idtextRequired - The person who made the purchase.
- Transaction
transaction_idtext - The transaction it belongs to. Leave empty to let Ramp match it.
Outputs
receipt_idtext- The new receipt's ID
transaction_idtext- The transaction it was attached to, empty when Ramp matches it
user_idtext- The cardholder's user ID
Example output
{
"receipt_id": "0a0ed428-0250-4993-96ad-94cd77bc86b6",
"transaction_id": "fd14cd6a-846e-4994-9315-5a59e6bb465f",
"user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
}