> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ramp

> How to set up the Ramp connector, plus the actions and events that are available.

![Ramp](https://stackone-logos.com/api/ramp/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/ramp/changelog.md)

[75 actions](#actions) · [42 events](#events) · 2 auth methods

Expense Management

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/ramp/guides/connector-profile/oauth-2-0.md)
>
> User-delegated access via Ramp's OAuth consent screen — the end user authorizes the connection on behalf of their Ramp b...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/ramp/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Server-to-server access to your own Ramp business with no user sign-in. Requires a Ramp developer app with the Client cr...

Optionally, configure receiving Events for Ramp into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/ramp/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/ramp/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/ramp/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounting:read

accounting:write

bills:read

business:read

cards:read

cards:write

departments:read

departments:write

entities:read

funds:read

locations:read

locations:write

memos:read

memos:write

merchants:read

purchase\_orders:read

receipts:read

receipts:write

reimbursements:read

repayments:read

spend\_programs:read

spend\_programs:write

transactions:read

transactions:write

transfers:read

trips:read

users:read

users:write

vendors:read

vendors:write

No scopes found

75 actions

ActionDescriptionRequired scopes

List Transactions`ramp_list_transactions`

List transactions

`transactions:read`

Fetch A Transaction`ramp_get_transaction`

Fetch a transaction

`transactions:read`

Update A Transaction`ramp_update_transaction`

Update a transaction

`transactions:write`

List Receipts`ramp_list_receipts`

List receipts

`receipts:read`

Fetch A Receipt`ramp_get_receipt`

Fetch a receipt

`receipts:read`

Upload A Receipt`ramp_create_receipts`

Upload a receipt image

`receipts:write`

List Memos`ramp_list_memos`

List memos

`memos:read`

Fetch A Transaction Memo`ramp_get_memo`

Fetch a transaction memo

`memos:read`

Upload A New Memo For A Transaction`ramp_create_memos`

Upload a new memo for a transaction

`memos:write`

List Merchants`ramp_list_merchants`

List merchants

`merchants:read`

List Physical Cards`ramp_list_physical_cards`

List physical cards

`cards:read`

Fetch A Physical Card`ramp_get_physical_card`

Fetch a physical card

`cards:read`

Create A Physical Card`ramp_create_physical_card`

Create a physical card

`cards:write`

Update A Physical Card`ramp_update_physical_card`

Update a physical card

`cards:write`

List Virtual Cards`ramp_list_virtual_cards`

List virtual cards

`cards:read`

Fetch A Virtual Card`ramp_get_virtual_card`

Fetch a virtual card

`cards:read`

List Users`ramp_list_users`

List users

`users:read`

Fetch A User`ramp_get_user`

Fetch a user

`users:read`

Manage A User's Invite Lifecycle`ramp_manage_user_invite`

Manage a user's invite lifecycle

`users:write`

Update A User`ramp_update_user`

Update a user

`users:write`

Create A User`ramp_create_user`

Create a user

`users:write`

Fetch User Creation Task Status`ramp_get_user_deferred_status`

Fetch user creation task status

`users:read`

List Reimbursements`ramp_list_reimbursements`

List reimbursements

`reimbursements:read`

Fetch A Reimbursement`ramp_get_reimbursement`

Fetch a reimbursement

`reimbursements:read`

List Bills`ramp_list_bills`

List bills

`bills:read`

Fetch A Bill`ramp_get_bill`

Fetch a bill

`bills:read`

List Vendors`ramp_list_vendors`

List vendors

`vendors:read`

Fetch A Vendor`ramp_get_vendor`

Fetch a vendor

`vendors:read`

Create A New Vendor`ramp_create_vendors`

Create a new vendor

`vendors:write`

Update A Vendor`ramp_update_vendor`

Update a vendor

`vendors:write`

Delete A Vendor`ramp_delete_vendor`

Delete a vendor

`vendors:write`

List Spend Programs`ramp_list_spend_programs`

List spend programs

`spend_programs:read`

Fetch A Spend Program`ramp_get_spend_program`

Fetch a spend program

`spend_programs:read`

Create A Spend Program`ramp_create_spend_programs`

Create a spend program

`spend_programs:write`

List Departments`ramp_list_departments`

List departments

`departments:read`

Fetch A Department`ramp_get_department`

Fetch a department

`departments:read`

Create A Department`ramp_create_departments`

Create a department

`departments:write`

Update A Department`ramp_update_department`

Update a department

`departments:write`

List Locations`ramp_list_locations`

List locations

`locations:read`

Fetch A Location`ramp_get_location`

Fetch a location

`locations:read`

Create A Location`ramp_create_locations`

Create a location

`locations:write`

Update A Location`ramp_update_location`

Update a location

`locations:write`

List General Ledger Accounts`ramp_list_accounting_accounts`

List general ledger accounts

`accounting:read`

List Accounting Connections`ramp_list_accounting_connections`

List accounting connections

`accounting:read`

List Options For A Given Custom Accounting Field`ramp_list_accounting_field_options`

List options for a given custom accounting field

`accounting:read`

List Custom Accounting Fields`ramp_list_accounting_fields`

List custom accounting fields

`accounting:read`

List Vendors`ramp_list_accounting_vendors`

List vendors

`accounting:read`

Fetch A General Ledger Account`ramp_get_accounting_account`

Fetch a general ledger account

`accounting:read`

Fetch An Accounting Connection By ID`ramp_get_accounting_connection`

Fetch an accounting connection by ID

`accounting:read`

Fetch A Custom Accounting Field`ramp_get_accounting_field`

Fetch a custom accounting field

`accounting:read`

Fetch A Vendor`ramp_get_accounting_vendor`

Fetch a vendor

`accounting:read`

Upload General Ledger Accounts`ramp_create_accounting_accounts`

Upload general ledger accounts

`accounting:write`

Post Accounting Coding Selections To An Object`ramp_create_accounting_codings`

Post accounting coding selections to an object

`accounting:write`

Register A New API Based Accounting Connection`ramp_create_accounting_connection`

Register a new API based accounting connection

`accounting:write`

Upload New Options`ramp_create_accounting_field_options`

Upload new options

`accounting:write`

Update A Custom Accounting Field Option`ramp_update_accounting_field_option`

Update a custom accounting field option

`accounting:write`

Delete A Custom Accounting Field Option`ramp_delete_accounting_field_option`

Delete a custom accounting field option

`accounting:write`

Create A New Custom Accounting Field`ramp_create_accounting_fields`

Create a new custom accounting field

`accounting:write`

Post Ready To Sync Status`ramp_create_accounting_ready_to_sync`

Post ready to sync status

`accounting:write`

Post Sync Status`ramp_create_accounting_syncs`

Post sync status

`accounting:write`

Upload Vendors`ramp_create_accounting_vendors`

Upload vendors

`accounting:write`

Update A General Ledger Account`ramp_update_accounting_account`

Update a general ledger account

`accounting:write`

Delete A General Ledger Account`ramp_delete_accounting_account`

Delete a general ledger account

`accounting:write`

Fetch The Company Information`ramp_get_business`

Fetch the company information

`business:read`

Fetch The Company Balance Information`ramp_get_business_balance`

Fetch the company balance information

`business:read`

List Business Entities`ramp_list_entities`

List business entities

`entities:read`

Get A Business Entity`ramp_get_entity`

Get a business entity

`entities:read`

List Funds`ramp_list_funds`

List funds

`funds:read`

Fetch A Fund`ramp_get_fund`

Fetch a fund

`funds:read`

List All Trips For The Business`ramp_list_trips`

List all trips for the business

`trips:read`

Fetch A Trip`ramp_get_trip`

Fetch a trip

`trips:read`

List Purchase Orders`ramp_list_purchase_orders`

List purchase orders

`purchase_orders:read`

List Transfer Payments`ramp_list_transfers`

List transfer payments

`transfers:read`

Fetch A Transfer Payment`ramp_get_transfer`

Fetch a transfer payment

`transfers:read`

List Repayments`ramp_list_repayments`

List repayments

`repayments:read`

## Events

Tags

Select all
|
Clear

Applications

Bills

Business Entities

Comments

Item Receipts

Payments

Purchase Orders

Reimbursements

Spend Requests

Transactions

Unified Requests

Users

Vendors

Webhooks

No tags found

42 events

EventDescriptionTags

Webhook Endpoint Verification`ramp_webhook_verification`

Handles the Ramp webhooks.verification challenge. Ramp sends only \{type, challenge} with no subscription ID, so the subs...

Webhooks

Application Status Updated`ramp_webhook_applications_status_updated`

Processes Ramp applications.status\_updated webhook events — fired when an application status has changed, such as approv...

ApplicationsWebhooks

Bill Approved`ramp_webhook_bills_approved`

Processes Ramp bills.approved webhook events — fired when a bill has been approved. The payload carries the affected res...

BillsWebhooks

Bill Archived`ramp_webhook_bills_archived`

Processes Ramp bills.archived webhook events — fired when a bill has been archived. The payload carries the affected res...

BillsWebhooks

Bill Created`ramp_webhook_bills_created`

Processes Ramp bills.created webhook events — fired when a bill has been created. The payload carries the affected resou...

BillsWebhooks

Bill Paid`ramp_webhook_bills_paid`

Processes Ramp bills.paid webhook events — fired when a bill payment has been completed. The payload carries the affecte...

BillsWebhooks

Bill Ready to Sync`ramp_webhook_bills_ready_to_sync`

Processes Ramp bills.ready\_to\_sync webhook events — fired when a bill is ready to sync to an accounting system. The payl...

BillsWebhooks

Bill Rejected`ramp_webhook_bills_rejected`

Processes Ramp bills.rejected webhook events — fired when a bill has been rejected. The payload carries the affected res...

BillsWebhooks

Bill Updated`ramp_webhook_bills_updated`

Processes Ramp bills.updated webhook events — fired when a bill has been edited (invoice number, PO matching, accounting...

BillsWebhooks

Business Entity Created`ramp_webhook_entities_created`

Processes Ramp entities.created webhook events — fired when a business entity has been created. The payload carries the...

Business EntitiesWebhooks

Item Receipt Created`ramp_webhook_item_receipts_created`

Processes Ramp item\_receipts.created webhook events — fired when an item receipt has been created. The payload carries t...

Item ReceiptsWebhooks

Payment Updated`ramp_webhook_payments_updated`

Processes Ramp payments.updated webhook events — fired when a bill payment has been updated. The payload carries the aff...

PaymentsWebhooks

Purchase Order Archived`ramp_webhook_purchase_orders_archived`

Processes Ramp purchase\_orders.archived webhook events — fired when a purchase order has been archived. The payload carr...

Purchase OrdersWebhooks

Purchase Order Created`ramp_webhook_purchase_orders_created`

Processes Ramp purchase\_orders.created webhook events — fired when a purchase order has been created. The payload carrie...

Purchase OrdersWebhooks

Purchase Order Updated`ramp_webhook_purchase_orders_updated`

Processes Ramp purchase\_orders.updated webhook events — fired when a purchase order has been modified. The payload carri...

Purchase OrdersWebhooks

Reimbursement Batch Payment Reimbursed`ramp_webhook_reimbursements_batch_payment_reimbursed`

Processes Ramp reimbursements.batch\_payment\_reimbursed webhook events — fired when a reimbursement batch payment has bee...

ReimbursementsWebhooks

Reimbursement Ready for Review`ramp_webhook_reimbursements_ready_for_review`

Processes Ramp reimbursements.ready\_for\_review webhook events — fired when a reimbursement needs review. The payload car...

ReimbursementsWebhooks

Reimbursement Ready to Sync`ramp_webhook_reimbursements_ready_to_sync`

Processes Ramp reimbursements.ready\_to\_sync webhook events — fired when a reimbursement is ready to sync to an accountin...

ReimbursementsWebhooks

Reimbursement Sync Requested`ramp_webhook_reimbursements_sync_requested`

Processes Ramp reimbursements.sync\_requested webhook events — fired when a reimbursement sync has been requested. The pa...

ReimbursementsWebhooks

Spend Request Comment Created`ramp_webhook_spend_requests_comment_created`

Processes Ramp spend\_requests.comment\_created webhook events — fired when a comment has been added to a spend request. T...

Spend RequestsCommentsWebhooks

Test Event`ramp_webhook_tests_test_event`

Processes Ramp tests.test\_event webhook events — fired when a mock/test webhook delivery was fired (not a business event...

Webhooks

Transaction Requirements and Approval Changed`ramp_webhook_transactions_all_requirements_met_and_approved_changed`

Processes Ramp transactions.all\_requirements\_met\_and\_approved\_changed webhook events — fired when a transaction's all\_re...

TransactionsWebhooks

Transaction Authorized`ramp_webhook_transactions_authorized`

Processes Ramp transactions.authorized webhook events — fired when a card transaction has been authorized. The payload c...

TransactionsWebhooks

Transaction Body Coding Updated`ramp_webhook_transactions_body_coding_updated`

Processes Ramp transactions.body\_coding\_updated webhook events — fired when a transaction's body-level accounting coding...

TransactionsWebhooks

Transaction Cleared`ramp_webhook_transactions_cleared`

Processes Ramp transactions.cleared webhook events — fired when a transaction has settled (also fires for refunds and re...

TransactionsWebhooks

Transaction Declined`ramp_webhook_transactions_declined`

Processes Ramp transactions.declined webhook events — fired when a card transaction has been declined. The payload carri...

TransactionsWebhooks

Transaction Ready for Review`ramp_webhook_transactions_ready_for_review`

Processes Ramp transactions.ready\_for\_review webhook events — fired when a transaction needs review or coding. The paylo...

TransactionsWebhooks

Transaction Ready to Sync`ramp_webhook_transactions_ready_to_sync`

Processes Ramp transactions.ready\_to\_sync webhook events — fired when a transaction is ready to sync to an accounting sy...

TransactionsWebhooks

Transaction Receipt Added`ramp_webhook_transactions_receipt_added`

Processes Ramp transactions.receipt\_added webhook events — fired when a receipt has been added to a transaction. The pay...

TransactionsWebhooks

Transaction Sync Requested`ramp_webhook_transactions_sync_requested`

Processes Ramp transactions.sync\_requested webhook events — fired when a transaction sync has been requested. The payloa...

TransactionsWebhooks

Transaction Synced`ramp_webhook_transactions_synced`

Processes Ramp transactions.synced webhook events — fired when a transaction has been marked as synced. The payload carr...

TransactionsWebhooks

Unified Request Created`ramp_webhook_unified_requests_created`

Processes Ramp unified\_requests.created webhook events — fired when a unified request has been created. The payload carr...

Unified RequestsWebhooks

Unified Request External Approval Requested`ramp_webhook_unified_requests_external_approval_request`

Processes Ramp unified\_requests.external\_approval\_request webhook events — fired when a unified request is ready for ext...

Unified RequestsWebhooks

Unified Request External Approval Reset`ramp_webhook_unified_requests_external_approval_request_reset`

Processes Ramp unified\_requests.external\_approval\_request\_reset webhook events — fired when an external approval request...

Unified RequestsWebhooks

Unified Request Modified`ramp_webhook_unified_requests_modified`

Processes Ramp unified\_requests.modified webhook events — fired when a unified request has been modified. The payload ca...

Unified RequestsWebhooks

Unified Request Node Advanced`ramp_webhook_unified_requests_node_advanced`

Processes Ramp unified\_requests.node\_advanced webhook events — fired when a unified request advanced to another workflow\...

Unified RequestsWebhooks

Unified Request Override Approved`ramp_webhook_unified_requests_override_approved`

Processes Ramp unified\_requests.override\_approved webhook events — fired when a unified request override has been approv...

Unified RequestsWebhooks

Unified Request Updated`ramp_webhook_unified_requests_updated`

Processes Ramp unified\_requests.updated webhook events — fired when a unified request has been updated. The payload carr...

Unified RequestsWebhooks

User Invite Accepted`ramp_webhook_users_invite_accepted`

Processes Ramp users.invite\_accepted webhook events — fired when a user has accepted an invitation. The payload carries...

UsersWebhooks

Vendor Activated`ramp_webhook_vendors_activated`

Processes Ramp vendors.activated webhook events — fired when a vendor has been activated. The payload carries the affect...

VendorsWebhooks

Vendor Approved`ramp_webhook_vendors_approved`

Processes Ramp vendors.approved webhook events — fired when a vendor has been approved. The payload carries the affected...

VendorsWebhooks

Vendor Updated`ramp_webhook_vendors_updated`

Processes Ramp vendors.updated webhook events — fired when a vendor has been updated. The payload carries the affected r...

VendorsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.