![ramp icon](/docs/img/components/icons/60/cmFtcA==.png)

# Ramp Connector

key: ramp[Source](https://github.com/prismatic-io/components/tree/main/components/ramp)[API Docs](https://docs.ramp.com/developer-api/v1/introduction)[API Changelog](https://docs.ramp.com/developer-api/v1/changelog)[Connector Changelog](#changelog)

## Description[​](#description "Direct link to Description")

[Ramp](https://ramp.com/) is a spend management platform focused on automating accounts payable and procurement processes.

Use the Ramp component to manage transactions related to vendors, bills, reimbursements and more.

#### API Documentation:[​](#api-documentation "Direct link to API Documentation:")

This component was built using the [Ramp REST API V1](https://docs.ramp.com/developer-api/v1/overview/getting-started) Reference.

## Connections[​](#connections "Direct link to Connections")

### OAuth 2.0[​](#ramp-oauth2 "Direct link to OAuth 2.0")

**key: ramp-oauth2**

Create an OAuth application:

Registering your application in the Ramp developer dashboard is the first step of building an integration based on Ramp API:

1. From the [Ramp developer](https://app.ramp.com/settings/ramp-developer) settings page, click on **Create new app** to register a new application.

2. Now you have registered a new application. Click into it and configure the following parameters:

   <!-- -->

   1. Client ID and client secret: Credentials for your application; store securely.
   2. App name and description
   3. Grant types: A list of grant types that the application may use to get access token. See [authorization guide](https://docs.ramp.com/developer-api/v1/authorization) for more information.
   4. Scopes: Defines [scopes](https://docs.ramp.com/developer-api/v1/authorization/scopes) that may be granted to access token.
   5. Redirect URIs: Enter`https://oauth2.prismatic.io/callback`.

Supply the following values to the **OAuth 2.0** connection:

* **Client ID**
* **Client Secret**
* **Scopes**
  * Recommended Scopes (space delimited): `bills:read bills:write accounting:read accounting:write transactions:read reimbursements:read departments:read departments:write entities:read locations:read locations:write`

| Input         | Notes                                                                                                                                                     | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorize URL | The OAuth 2.0 Authorization URL for Ramp                                                                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Client ID     |                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Client Secret |                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Scopes        | A comma-delimited set of one or more scopes to get the user's permission to access. Refer to https\://docs.ramp.com/developer-api/v1/authorization/scopes | accounting:read accounting:write bills:read business:read cards:read cards:write cashbacks:read departments:read departments:write entities:read leads:read leads:write limits:read limits:write locations:read locations:write memos:read merchants:read receipt\_integrations:read receipt\_integrations:write receipts:read reimbursements:read spend\_programs:read spend\_programs:write statements:read transactions:read transfers:read users:read users:write |
| Token URL     | The OAuth 2.0 Token URL for Ramp                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

## Triggers[​](#triggers "Direct link to Triggers")

### New and Updated Records[​](#pollchangestrigger "Direct link to New and Updated Records")

Checks for new and updated records in a selected Ramp resource type on a configured schedule. | **key: pollChangesTrigger**

| Input                | Notes                                                     | Example |
| -------------------- | --------------------------------------------------------- | ------- |
| Connection           |                                                           |         |
| Resource Type        | The type of resource to poll for new and updated records. |         |
| Show New Records     | Include newly created records in trigger results.         | true    |
| Show Updated Records | Include updated records in trigger results.               | true    |

This trigger polls the [Ramp API](https://docs.ramp.com/developer-api/v1/overview/getting-started) for new and updated records on a scheduled basis.

#### How It Works[​](#how-it-works "Direct link to How It Works")

1. The trigger runs on the configured schedule
2. It fetches records from Ramp for the selected resource type — timestamp-based resources are queried using `created_at` and/or `updated_at` filters anchored to the last poll time; ID-based resources fetch all records and compare against the known ID set
3. Records are categorized as **created** or **updated** based on their timestamps relative to the last poll time, or as **created** only for ID-based resources where update detection is not supported
4. The trigger updates its internal state after each poll

#### Configuration[​](#configuration "Direct link to Configuration")

Configure the following inputs:

* **Connection**: The Ramp connection used to authenticate API requests
* **Resource Type**: The type of records to monitor — Transactions, Bills, Reimbursements, Vendors, Departments, Locations, Business Entities, General Ledger Accounts, or Custom Accounting Fields
* **Show New Records**: When enabled, includes newly created records in the results. Defaults to `true`
* **Show Updated Records**: When enabled, includes modified records in the results. Defaults to `true`

#### Returned Data[​](#returned-data "Direct link to Returned Data")

The trigger returns an object with two arrays — `created` for new records and `updated` for modified records.

Example Response

```json
{
  "data": {
    "created": [
      {
        "id": "txn_01H9ZQ2KBCDEF12345",
        "amount": 4250,
        "currency_code": "USD",
        "merchant_name": "Acme Supplies",
        "user_transaction_time": "2024-01-16T10:30:00Z"
      }
    ],
    "updated": [
      {
        "id": "reimb_01H9ZQ2KBCDEF67890",
        "amount": 125,
        "currency_code": "USD",
        "created_at": "2024-01-10T09:00:00Z",
        "updated_at": "2024-01-16T14:22:00Z"
      }
    ]
  }
}

```

#### Notes[​](#notes "Direct link to Notes")

* **Departments**, **Locations**, and **Business Entities** use ID-based change detection — the **Show Updated Records** toggle has no effect for these resource types, as update detection is not supported
* Timestamp-based resource types (Transactions, Bills, Reimbursements, Vendors, General Ledger Accounts, Custom Accounting Fields) support both new and updated record detection
* Refer to the [Ramp API documentation](https://docs.ramp.com/developer-api/v1/overview/getting-started) for rate limit details and available fields per resource type

***

## Data Sources[​](#data-sources "Direct link to Data Sources")

### Select Bill[​](#selectbill "Direct link to Select Bill")

Select a Bill from a dropdown menu. | **key: selectBill** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Bill[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectBill.json "Download example payload")

Loading…

***

### Select Business Entity[​](#selectbusinessentity "Direct link to Select Business Entity")

Select a Business Entity from a dropdown menu. | **key: selectBusinessEntity** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Business Entity[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectBusinessEntity.json "Download example payload")

Loading…

***

### Select Custom Accounting Field[​](#selectcustomaccountingfield "Direct link to Select Custom Accounting Field")

Select a custom accounting field from a dropdown menu. | **key: selectCustomAccountingField** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Custom Accounting Field[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectCustomAccountingField.json "Download example payload")

Loading…

***

### Select Custom Accounting Field Option[​](#selectcustomaccountingfieldoption "Direct link to Select Custom Accounting Field Option")

Select a custom accounting field option from a dropdown menu for the specified field. | **key: selectCustomAccountingFieldOption** | **type: picklist**

| Input                      | Notes                                             | Example                              |
| -------------------------- | ------------------------------------------------- | ------------------------------------ |
| Connection                 |                                                   |                                      |
| Custom Accounting Field ID | The ID of the custom accounting field to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Select Custom Accounting Field Option[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectCustomAccountingFieldOption.json "Download example payload")

Loading…

***

### Select Department[​](#selectdepartment "Direct link to Select Department")

Select a Department from a dropdown menu. | **key: selectDepartment** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Department[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectDepartment.json "Download example payload")

Loading…

***

### Select General Ledger Account[​](#selectledgeraccount "Direct link to Select General Ledger Account")

Select an General Ledger Account from a dropdown menu | **key: selectLedgerAccount** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select General Ledger Account[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectLedgerAccount.json "Download example payload")

Loading…

***

### Select Location[​](#selectlocation "Direct link to Select Location")

Select a Location from a dropdown menu. | **key: selectLocation** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Location[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectLocation.json "Download example payload")

Loading…

***

### Select Reimbursement[​](#selectreimbursement "Direct link to Select Reimbursement")

Select a reimbursement from a dropdown menu. | **key: selectReimbursement** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Reimbursement[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectReimbursement.json "Download example payload")

Loading…

***

### Select Transaction[​](#selecttransaction "Direct link to Select Transaction")

Select a transaction from a dropdown menu. | **key: selectTransaction** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Transaction[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectTransaction.json "Download example payload")

Loading…

***

### Select Vendor[​](#selectvendor "Direct link to Select Vendor")

Select a Vendor from a dropdown menu. | **key: selectVendor** | **type: picklist**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

Example Payload for <!-- -->Select Vendor[⤓](https://prismatic.io/docs/example-payloads/ramp/data-sources/selectVendor.json "Download example payload")

Loading…

***

## Actions[​](#actions "Direct link to Actions")

### Create Custom Accounting Field[​](#createcustomaccountingfield "Direct link to Create Custom Accounting Field")

Create a custom accounting field | **key: createCustomAccountingField**

| Input                      | Notes                                                                         | Example                              |
| -------------------------- | ----------------------------------------------------------------------------- | ------------------------------------ |
| Connection                 |                                                                               |                                      |
| Custom Accounting Field ID | The ID of the custom accounting field to create                               | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Input Type                 | The input type could be SINGLE\_CHOICE, BOOLEAN or FREE\_FORM\_TEXT           |                                      |
| Is Splitable               | If set to True, the accounting field can be used to annotate split line items |                                      |
| Name                       | The name of the custom accounting field to create                             | Amazon                               |

Example Payload for <!-- -->Create Custom Accounting Field[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/createCustomAccountingField.json "Download example payload")

Loading…

***

### Create Department[​](#createdepartment "Direct link to Create Department")

Create a new department | **key: createDepartment**

| Input      | Notes                      | Example |
| ---------- | -------------------------- | ------- |
| Connection |                            |         |
| Name       | The name of the department | Amazon  |

Example Payload for <!-- -->Create Department[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/createDepartment.json "Download example payload")

Loading…

***

### Create Location[​](#createlocation "Direct link to Create Location")

Create a new location | **key: createLocation**

| Input      | Notes                                       | Example                              |
| ---------- | ------------------------------------------- | ------------------------------------ |
| Connection |                                             |                                      |
| Entity ID  | The ID of the entity to create the location | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Name       | The name of the location                    | Amazon                               |

Example Payload for <!-- -->Create Location[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/createLocation.json "Download example payload")

Loading…

***

### Delete Custom Accounting Field[​](#deletecustomaccountingfield "Direct link to Delete Custom Accounting Field")

Delete a custom accounting field | **key: deleteCustomAccountingField**

| Input                      | Notes                                           | Example                              |
| -------------------------- | ----------------------------------------------- | ------------------------------------ |
| Connection                 |                                                 |                                      |
| Custom Accounting Field ID | The ID of the custom accounting field to delete | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Delete Custom Accounting Field[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/deleteCustomAccountingField.json "Download example payload")

Loading…

***

### Delete Custom Accounting Field Option[​](#deletecustomaccountingfieldoption "Direct link to Delete Custom Accounting Field Option")

Delete a custom accounting field option | **key: deleteCustomAccountingFieldOption**

| Input                             | Notes                                                 | Example                              |
| --------------------------------- | ----------------------------------------------------- | ------------------------------------ |
| Connection                        |                                                       |                                      |
| Custom Accounting Field Option ID | The ID of the custom accouting field option to delete | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Delete Custom Accounting Field Option[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/deleteCustomAccountingFieldOption.json "Download example payload")

Loading…

***

### Delete General Ledger Account[​](#deletegeneralledgeraccount "Direct link to Delete General Ledger Account")

Delete a general ledger account | **key: deleteGeneralLedgerAccount**

| Input                     | Notes                                          | Example                              |
| ------------------------- | ---------------------------------------------- | ------------------------------------ |
| Connection                |                                                |                                      |
| General Ledger Account ID | The ID of the general ledger account to delete | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Delete General Ledger Account[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/deleteGeneralLedgerAccount.json "Download example payload")

Loading…

***

### Delete Vendor[​](#deletevendor "Direct link to Delete Vendor")

Delete a vendor | **key: deleteVendor**

| Input      | Notes                          | Example                              |
| ---------- | ------------------------------ | ------------------------------------ |
| Connection |                                |                                      |
| Vendor ID  | The ID of the vendor to delete | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Delete Vendor[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/deleteVendor.json "Download example payload")

Loading…

***

### Get Bill[​](#getbill "Direct link to Get Bill")

Retrieve a bill by ID | **key: getBill**

| Input      | Notes                          | Example                              |
| ---------- | ------------------------------ | ------------------------------------ |
| Bill ID    | The ID of the bill to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Connection |                                |                                      |

Example Payload for <!-- -->Get Bill[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getBill.json "Download example payload")

Loading…

***

### Get Business Entity[​](#getbusinessentity "Direct link to Get Business Entity")

Retrieve a business entity by ID | **key: getBusinessEntity**

| Input              | Notes                                     | Example                              |
| ------------------ | ----------------------------------------- | ------------------------------------ |
| Business Entity ID | The ID of the business entity to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Connection         |                                           |                                      |

Example Payload for <!-- -->Get Business Entity[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getBusinessEntity.json "Download example payload")

Loading…

***

### Get Custom Accounting Field[​](#getcustomaccountingfield "Direct link to Get Custom Accounting Field")

Retrieve a custom accounting field by ID | **key: getCustomAccountingField**

| Input                      | Notes                                             | Example                              |
| -------------------------- | ------------------------------------------------- | ------------------------------------ |
| Connection                 |                                                   |                                      |
| Custom Accounting Field ID | The ID of the custom accounting field to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Custom Accounting Field[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getCustomAccountingField.json "Download example payload")

Loading…

***

### Get Custom Accounting Field Option[​](#getcustomaccountingfieldoption "Direct link to Get Custom Accounting Field Option")

Retrieve a custom accounting field option by ID | **key: getCustomAccountingFieldOption**

| Input                             | Notes                                         | Example                              |
| --------------------------------- | --------------------------------------------- | ------------------------------------ |
| Connection                        |                                               |                                      |
| Custom Accounting Field Option ID | The ID of the custom field option to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Custom Accounting Field Option[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getCustomAccountingFieldOption.json "Download example payload")

Loading…

***

### Get Department[​](#getdepartment "Direct link to Get Department")

Retrieve a department by ID | **key: getDepartment**

| Input         | Notes                                | Example                              |
| ------------- | ------------------------------------ | ------------------------------------ |
| Connection    |                                      |                                      |
| Department ID | The ID of the department to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Department[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getDepartment.json "Download example payload")

Loading…

***

### Get General Ledger Account[​](#getgeneralledgeraccount "Direct link to Get General Ledger Account")

Retrieve a general ledger account by ID | **key: getGeneralLedgerAccount**

| Input                     | Notes                                            | Example                              |
| ------------------------- | ------------------------------------------------ | ------------------------------------ |
| Connection                |                                                  |                                      |
| General Ledger Account ID | The ID of the general ledger account to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get General Ledger Account[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getGeneralLedgerAccount.json "Download example payload")

Loading…

***

### Get Location[​](#getlocation "Direct link to Get Location")

Retrieve a location by ID | **key: getLocation**

| Input       | Notes                              | Example                              |
| ----------- | ---------------------------------- | ------------------------------------ |
| Connection  |                                    |                                      |
| Location ID | The ID of the location to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Location[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getLocation.json "Download example payload")

Loading…

***

### Get Reimbursement[​](#getreimbursement "Direct link to Get Reimbursement")

Retrieve a reimbursement by ID | **key: getReimbursement**

| Input            | Notes                                   | Example                              |
| ---------------- | --------------------------------------- | ------------------------------------ |
| Connection       |                                         |                                      |
| Reimbursement ID | The ID of the reimbursement to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Reimbursement[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getReimbursement.json "Download example payload")

Loading…

***

### Get Transaction[​](#gettransaction "Direct link to Get Transaction")

Retrieve a transaction by ID | **key: getTransaction**

| Input          | Notes                                 | Example                              |
| -------------- | ------------------------------------- | ------------------------------------ |
| Connection     |                                       |                                      |
| Transaction ID | The ID of the transaction to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Transaction[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getTransaction.json "Download example payload")

Loading…

***

### Get Vendor[​](#getvendor "Direct link to Get Vendor")

Retrieve a vendor by ID | **key: getVendor**

| Input      | Notes                            | Example                              |
| ---------- | -------------------------------- | ------------------------------------ |
| Connection |                                  |                                      |
| Vendor ID  | The ID of the vendor to retrieve | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Get Vendor[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/getVendor.json "Download example payload")

Loading…

***

### List Bills[​](#listbills "Direct link to List Bills")

Retrieve a list of all bills | **key: listBills**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Bills[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listBills.json "Download example payload")

Loading…

***

### List Business Entities[​](#listbusinessentities "Direct link to List Business Entities")

Retrieve a list of all business entities | **key: listBusinessEntities**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Business Entities[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listBusinessEntities.json "Download example payload")

Loading…

***

### List Custom Accounting Field[​](#listcustomaccountingfield "Direct link to List Custom Accounting Field")

List custom accounting fields | **key: listCustomAccountingField**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Custom Accounting Field[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listCustomAccountingField.json "Download example payload")

Loading…

***

### List Custom Accounting Field Options[​](#listcustomaccountingfieldoptions "Direct link to List Custom Accounting Field Options")

List options for a given custom accounting field | **key: listCustomAccountingFieldOptions**

| Input                      | Notes                                                                                        | Example                              |
| -------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------ |
| Connection                 |                                                                                              |                                      |
| Custom Accounting Field ID | The ID of the custom accounting field to list options for                                    | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Custom Query Params        | Custom query parameters to be included in the request                                        | key1=value1                          |
| Fetch All                  | If true, will fetch all results                                                              | false                                |
| Page Size                  | Number of results to retrieve per page. Default is 50                                        | 50                                   |
| Start                      | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1                                    |

Example Payload for <!-- -->List Custom Accounting Field Options[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listCustomAccountingFieldOptions.json "Download example payload")

Loading…

***

### List Departments[​](#listdepartments "Direct link to List Departments")

Retrieve a list of all Departments | **key: listDepartments**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Departments[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listDepartments.json "Download example payload")

Loading…

***

### List General Ledger Accounts[​](#listgeneralledgeraccounts "Direct link to List General Ledger Accounts")

Retrieve a list of all general ledger accounts | **key: listGeneralLedgerAccounts**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List General Ledger Accounts[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listGeneralLedgerAccounts.json "Download example payload")

Loading…

***

### List Locations[​](#listlocations "Direct link to List Locations")

Retrieve a list of all locations | **key: listLocations**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Locations[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listLocations.json "Download example payload")

Loading…

***

### List Reimbursements[​](#listreimbursements "Direct link to List Reimbursements")

Retrieve a list of all reimbursements | **key: listReimbursements**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Reimbursements[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listReimbursements.json "Download example payload")

Loading…

***

### List Transactions[​](#listtransactions "Direct link to List Transactions")

Retrieve a list of all transactions | **key: listTransactions**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Transactions[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listTransactions.json "Download example payload")

Loading…

***

### List Vendors[​](#listvendors "Direct link to List Vendors")

Retrieve a list of all vendors | **key: listVendors**

| Input               | Notes                                                                                        | Example     |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| Connection          |                                                                                              |             |
| Custom Query Params | Custom query parameters to be included in the request                                        | key1=value1 |
| Fetch All           | If true, will fetch all results                                                              | false       |
| Page Size           | Number of results to retrieve per page. Default is 50                                        | 50          |
| Start               | The starting point for the list of results. Is fetchAll is true, this option will be ignored | 1           |

Example Payload for <!-- -->List Vendors[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/listVendors.json "Download example payload")

Loading…

***

### Post Sync Status[​](#postsyncstatus "Direct link to Post Sync Status")

This endpoint allows customers to notify Ramp of a list of sync results | **key: postSyncStatus**

| Input            | Notes                                                                                                                                                                                                           | Example                              |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Connection       |                                                                                                                                                                                                                 |                                      |
| Failed Syncs     | A list of objects that failed to be synced                                                                                                                                                                      | See Example                          |
| Idempotency Key  | An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. To avoid collisions, we encourage clients to use random generated UUIDs | d471d830-2e73-4082-8a75-68540f83e86e |
| Successful Syncs | A list of objects that failed to be synced                                                                                                                                                                      | See Example                          |
| Sync Type        | The type of object to sync                                                                                                                                                                                      | TRANSACTION\_SYNC                    |

***

### Raw Request[​](#rawrequest "Direct link to Raw Request")

Send raw HTTP request to Ramp API | **key: rawRequest**

| Input                   | Notes                                                                                                                                                                                                                                                | Example                                                       |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| Connection              |                                                                                                                                                                                                                                                      |                                                               |
| Data                    | The HTTP body payload to send to the URL.                                                                                                                                                                                                            | {"exampleKey": "Example Data"}                                |
| File Data               | File Data to be sent as a multipart form upload.                                                                                                                                                                                                     | \[{key: "example.txt", value: "My File Contents"}]            |
| File Data File Names    | File names to apply to the file data inputs. Keys must match the file data keys above.                                                                                                                                                               |                                                               |
| Form Data               | The Form Data to be sent as a multipart form upload.                                                                                                                                                                                                 | \[{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header                  | A list of headers to send with the request.                                                                                                                                                                                                          | User-Agent: curl/7.64.1                                       |
| Max Retry Count         | The maximum number of retries to attempt. Specify 0 for no retries.                                                                                                                                                                                  | 0                                                             |
| Method                  | The HTTP method to use.                                                                                                                                                                                                                              |                                                               |
| Query Parameter         | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1\&key2=value2.                                                                                                                 |                                                               |
| Response Type           | The type of data you expect in the response. You can request json, text, or binary data.                                                                                                                                                             | json                                                          |
| Retry On All Errors     | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.                                                     | false                                                         |
| Retry Delay (ms)        | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.                                                                                                                                                  | 0                                                             |
| Timeout                 | The maximum time that a client will await a response to its request                                                                                                                                                                                  | 2000                                                          |
| URL                     | Input the path only (/departments), The base URL is already included (https\://api.ramp.com/developer/v1/). For example, to connect to https\://api.ramp.com/developer/v1/departments, only /departments is entered in this field. e.g. /departments | /departments                                                  |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.                                                                                                                        | false                                                         |

***

### Update Custom Accounting Field[​](#updatecustomaccountingfield "Direct link to Update Custom Accounting Field")

Update an existing custom accounting field | **key: updateCustomAccountingField**

| Input                      | Notes                                                                         | Example                              |
| -------------------------- | ----------------------------------------------------------------------------- | ------------------------------------ |
| Connection                 |                                                                               |                                      |
| Custom Accounting Field ID | The ID of the custom accounting field to update                               | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Is Splitable               | If set to True, the accounting field can be used to annotate split line items |                                      |
| Name                       | The name of the custom accounting field                                       | Amazon                               |

Example Payload for <!-- -->Update Custom Accounting Field[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/updateCustomAccountingField.json "Download example payload")

Loading…

***

### Update Custom Accounting Field Option[​](#updatecustomaccountingfieldoption "Direct link to Update Custom Accounting Field Option")

Update an existing custom accounting field option | **key: updateCustomAccountingFieldOption**

| Input                             | Notes                                                  | Example                              |
| --------------------------------- | ------------------------------------------------------ | ------------------------------------ |
| Connection                        |                                                        |                                      |
| Custom Accounting Field Option ID | The ID of the custom accounting field option to update | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Reactivate                        | Reactivate a deleted custom field option               |                                      |
| Value                             | The value of the custom accounting field option        | Sales & Marketing                    |

Example Payload for <!-- -->Update Custom Accounting Field Option[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/updateCustomAccountingFieldOption.json "Download example payload")

Loading…

***

### Update Department[​](#updatedepartment "Direct link to Update Department")

Update a department by ID | **key: updateDepartment**

| Input         | Notes                              | Example                              |
| ------------- | ---------------------------------- | ------------------------------------ |
| Connection    |                                    |                                      |
| Department ID | The ID of the department to update | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Name          | The updated name of the department | Amazon                               |

Example Payload for <!-- -->Update Department[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/updateDepartment.json "Download example payload")

Loading…

***

### Update General Ledger Account[​](#updategeneralledgeraccount "Direct link to Update General Ledger Account")

Update an existing general ledger account | **key: updateGeneralLedgerAccount**

| Input                     | Notes                                                                                                                                                                                                                                | Example                              |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ |
| Code                      | The code of the general ledger account; you could provide an empty string if you want to reset the remote code                                                                                                                       | 19566                                |
| Connection                |                                                                                                                                                                                                                                      |                                      |
| General Ledger Account ID | The ID of the general ledger account to update                                                                                                                                                                                       | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Name                      | Name of the general ledger account                                                                                                                                                                                                   | Amazon                               |
| Reactivate                | Reactivate a deleted general ledger account                                                                                                                                                                                          |                                      |
| Subsidiaries              | IDs of a list of subsidiaries which a general ledger account can be used with. The Ramp-assigned IDs should be used here. you could provide an empty list if you want to reset the subsidiaries list for this general ledger account | See Example                          |

Example Payload for <!-- -->Update General Ledger Account[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/updateGeneralLedgerAccount.json "Download example payload")

Loading…

***

### Update Location[​](#updatelocation "Direct link to Update Location")

Update an existing location | **key: updateLocation**

| Input       | Notes                                       | Example                              |
| ----------- | ------------------------------------------- | ------------------------------------ |
| Connection  |                                             |                                      |
| Entity ID   | The ID of the entity to update the location | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Location ID | The ID of the location to update            | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Name        | The updated name of the location            | Amazon                               |

Example Payload for <!-- -->Update Location[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/updateLocation.json "Download example payload")

Loading…

***

### Update Vendor[​](#updatevendor "Direct link to Update Vendor")

Update an existing vendor | **key: updateVendor**

| Input        | Notes                                                                                                                                                               | Example                              |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Code         | Code of the vendor; you could provide an empty string to reset the remote code                                                                                      | 19566                                |
| Connection   |                                                                                                                                                                     |                                      |
| Name         | Name of a vendor                                                                                                                                                    | Amazon                               |
| Reactivate   | Reactivate a deleted vendor                                                                                                                                         |                                      |
| Subsidiaries | IDs of a list of subsidiaries associated with the vendor. The Ramp-assigned IDs should be used here. You could provide an empty list to reset the subsidiaries list | See Example                          |
| Vendor ID    | The ID of the vendor to update                                                                                                                                      | 96bb7007-eec5-430f-8d09-e033cbc000c2 |

Example Payload for <!-- -->Update Vendor[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/updateVendor.json "Download example payload")

Loading…

***

### Upload Custom Accounting Field Option[​](#uploadcustomaccountingfieldoption "Direct link to Upload Custom Accounting Field Option")

Upload a new custom accounting field option | **key: uploadCustomAccountingFieldOption**

| Input                             | Notes                                                                    | Example                              |
| --------------------------------- | ------------------------------------------------------------------------ | ------------------------------------ |
| Connection                        |                                                                          |                                      |
| Custom Accounting Field Option ID | The ID of the custom accounting field option for which to upload options | 96bb7007-eec5-430f-8d09-e033cbc000c2 |
| Options                           | A list of field options for a given custom accounting field              | See Example                          |

Example Payload for <!-- -->Upload Custom Accounting Field Option[⤓](https://prismatic.io/docs/example-payloads/ramp/actions/uploadCustomAccountingFieldOption.json "Download example payload")

Loading…

***

## Changelog[​](#changelog "Direct link to Changelog")

### 2026-05-20[​](#2026-05-20 "Direct link to 2026-05-20")

Applied automated security patches and code formatting updates

### 2026-04-30[​](#2026-04-30 "Direct link to 2026-04-30")

Updated spectral version

### 2026-04-21[​](#2026-04-21 "Direct link to 2026-04-21")

Added **New and Updated Records** polling trigger that checks for new and updated transactions, bills, reimbursements, vendors, and other financial records in Ramp on a configured schedule

### 2026-03-13[​](#2026-03-13 "Direct link to 2026-03-13")

Removed the **Debug Request** input from all action inputs. Debug logging is now controlled internally and no longer appears as a configurable field in actions.

### 2026-03-05[​](#2026-03-05 "Direct link to 2026-03-05")

Added inline data sources for transactions, reimbursements, custom accounting fields, and custom accounting field options to enhance data selection capabilities