Skip to main content

Ramp Component

Ramp

Ramp 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.

Component key: ramp

Description​

Ramp 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:​

This component was built using the Ramp REST API V1 Reference.

Connections​

OAuth 2.0​

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 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 for more information.
    4. Scopes: Defines scopes that may be granted to access token.
    5. Redirect URIs: Enter https://oauth2.prismatic.io/callback for US based integrations.
      1. For integrations outside the US refer to this guide to find your region’s Callback URL

Supply the following values to the OAuth 2.0 connection in your integration within Prismatic:

  • 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

Data Sources​

Select Bill​

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

Data Source Payload​

{
  "result": [
    {
      "key": "1",
      "label": "432 - PAID"
    },
    {
      "key": "2",
      "label": "423 - OPEN"
    }
  ]
}

Select Business Entity​

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

Data Source Payload​

{
  "result": [
    {
      "key": "1",
      "label": "Amazon"
    },
    {
      "key": "2",
      "label": "Widgets Inc"
    }
  ]
}

Select Department​

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

Data Source Payload​

{
  "result": [
    {
      "key": "1",
      "label": "Amazon"
    },
    {
      "key": "2",
      "label": "Widgets Inc"
    }
  ]
}

Select General Ledger Account​

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

Data Source Payload​

{
  "result": [
    {
      "key": "1",
      "label": "Expense - 6410"
    },
    {
      "key": "2",
      "label": "Widgets Inc - 6850"
    }
  ]
}

Select Location​

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

Data Source Payload​

{
  "result": [
    {
      "key": "1",
      "label": "Amazon"
    },
    {
      "key": "2",
      "label": "Widgets Inc"
    }
  ]
}

Select Vendor​

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

Data Source Payload​

{
  "result": [
    {
      "key": "1",
      "label": "Amazon"
    },
    {
      "key": "2",
      "label": "Widgets Inc"
    }
  ]
}

Actions​

Create Custom Accounting Field​

Create a custom accounting field | key: createCustomAccountingField

Output Example Payload​

{
  "data": {
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "Department",
    "input_type": "SINGLE_CHOICE",
    "is_active": true,
    "is_splittable": true,
    "name": "Department",
    "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

Create Department​

Create a new department | key: createDepartment

Output Example Payload​

{
  "data": {
    "id": "c16b6ee1-2f5d-45e9-9fb4-c1c541a9ea70",
    "name": "Bookkeeping"
  }
}

Create Location​

Create a new location | key: createLocation

Output Example Payload​

{
  "data": {
    "entity_id": "bb25a7e8-cc2f-4ba7-9bf4-7730ffe152bb",
    "id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
    "name": "New York City, NY"
  }
}

Delete Custom Accounting Field​

Delete a custom accounting field | key: deleteCustomAccountingField

Output Example Payload​

{
  "data": "Deleted successfully"
}

Delete Custom Accounting Field Option​

Delete a custom accounting field option | key: deleteCustomAccountingFieldOption

Output Example Payload​

{
  "data": "Deleted successfully"
}

Delete General Ledger Account​

Delete a general ledger account | key: deleteGeneralLedgerAccount

Output Example Payload​

{
  "data": "Deleted successfully"
}

Delete Vendor​

Delete a vendor | key: deleteVendor

Output Example Payload​

{
  "data": "Deleted successfully"
}

Get Bill​

Retrieve a bill by ID | key: getBill

Output Example Payload​

{
  "data": {
    "accounting_field_selections": [],
    "amount": {
      "amount": 96993,
      "currency_code": "USD"
    },
    "created_at": "2024-05-12T01:37:27+00:00",
    "deep_link_url": null,
    "due_at": "2022-12-31T00:00:00+00:00",
    "entity_id": "5bcc3734-f03a-4756-bc4b-afeb52d738ad",
    "id": "6e3816e3-0e53-42ae-b075-bdb0adff10c4",
    "invoice_number": "432",
    "invoice_urls": [
      "https://receipts.ramp.com/some-url"
    ],
    "issued_at": "2022-12-31T00:00:00+00:00",
    "line_items": [
      {
        "accounting_field_selections": [],
        "amount": {
          "amount": 1998,
          "currency_code": "USD"
        },
        "memo": "Telephone Headset"
      },
      {
        "accounting_field_selections": [],
        "amount": {
          "amount": 94995,
          "currency_code": "USD"
        },
        "memo": "2-Drawer Lateral File Cabinet Steel White"
      }
    ],
    "payment": {
      "amount": {
        "amount": 96993,
        "currency_code": "USD"
      },
      "effective_date": "2024-05-13T00:00:00+00:00",
      "payment_date": "2024-05-13T00:00:00+00:00",
      "payment_method": "ACH"
    },
    "remote_id": null,
    "status": "OPEN",
    "user": {
      "first_name": "John",
      "id": "96bb7007-eec5-430f-8d09-e033cbc000c2",
      "last_name": "Doe"
    },
    "vendor": {
      "remote_id": "Amazon",
      "remote_name": "Amazon",
      "type": "BUSINESS"
    }
  }
}

Get Business Entity​

Retrieve a business entity by ID | key: getBusinessEntity

Output Example Payload​

{
  "data": {
    "entity_name": "Canada",
    "id": "55da4b86-5b47-4b6b-a274-a669a6cb14be",
    "is_primary": false,
    "currency": "CAD"
  }
}

Get Custom Accounting Field​

Retrieve a custom accounting field by ID | key: getCustomAccountingField

Output Example Payload​

{
  "data": {
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "Department",
    "input_type": "SINGLE_CHOICE",
    "is_active": true,
    "is_splittable": true,
    "name": "Department",
    "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

Get Custom Accounting Field Option​

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

Output Example Payload​

{
  "data": {
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "123",
    "is_active": true,
    "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
    "remote_code": "20001",
    "updated_at": "2020-08-28T14:40:12+00:00",
    "value": "Office/Admin:Phone & Internet"
  }
}

Get Department​

Retrieve a department by ID | key: getDepartment

Output Example Payload​

{
  "data": {
    "id": "c16b6ee1-2f5d-45e9-9fb4-c1c541a9ea70",
    "name": "Bookkeeping"
  }
}

Get General Ledger Account​

Retrieve a general ledger account by ID | key: getGeneralLedgerAccount

Output Example Payload​

{
  "data": {
    "classification": "EXPENSE",
    "code": "6410",
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "514",
    "is_active": true,
    "name": "Employees:Salaries & Wages",
    "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

Get Location​

Retrieve a location by ID | key: getLocation

Output Example Payload​

{
  "data": {
    "entity_id": "bb25a7e8-cc2f-4ba7-9bf4-7730ffe152bb",
    "id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
    "name": "New York City, NY"
  }
}

Get Reimbursement​

Retrieve a reimbursement by ID | key: getReimbursement

Output Example Payload​

{
  "data": {
    "accounting_field_selections": [
      {
        "category_info": {
          "external_id": "Category",
          "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
          "name": "Category",
          "type": "GL_ACCOUNT"
        },
        "external_id": "Category",
        "id": "07b4ce4d-2750-412e-aef4-6b7815f1411c",
        "name": "Category",
        "type": "GL_ACCOUNT"
      }
    ],
    "amount": 484.46,
    "created_at": "2023-08-20T:00:00+00:00",
    "currency": "USD",
    "direction": "BUSINESS_TO_USER",
    "distance": 55,
    "entity_id": "4bec9dc1-710e-4781-b254-fc606c76a241",
    "id": "d47ba06e-14ac-4a7b-89b4-4775412ba545",
    "line_items": [
      {
        "accounting_field_selections": [
          {
            "category_info": {
              "external_id": "Category",
              "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
              "name": "Category",
              "type": "GL_ACCOUNT"
            },
            "external_id": "425",
            "id": "07b4ce4d-2750-412e-aef4-6b7815f1411b",
            "name": "Ramp LP",
            "type": "Subsidiary"
          }
        ],
        "amount": {
          "amount": 43446,
          "currency_code": "USD"
        }
      },
      {
        "accounting_field_selections": [
          {
            "category_info": {
              "external_id": "Category",
              "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
              "name": "Category",
              "type": "GL_ACCOUNT"
            },
            "external_id": "426",
            "id": "07b4ce4d-2750-412e-aef4-6b7815f1411a",
            "name": "Ramp BV",
            "type": "Subsidiary"
          }
        ],
        "amount": {
          "amount": 5000,
          "currency_code": "USD"
        }
      }
    ],
    "memo": "Airfare for business travel",
    "merchant": "Delta Airlines",
    "original_reimbursement_amount": {
      "amount": 48446,
      "currency_code": "USD"
    },
    "payee_amount": {
      "amount": 48446,
      "currency_code": "USD"
    },
    "payment_id": "NDPHKHCN6G",
    "receipts": [],
    "spend_limit_id": "92a68991-8374-4c0a-b5c0-5180c41b5148",
    "state": "REIMBURSED",
    "synced_at": "2023-08-21T:00:00+00:00",
    "transaction_date": "2022-08-19",
    "trip_id": "ec6aae2b-38c6-4eeb-adf0-80f25dbf9aad",
    "type": "OUT_OF_POCKET",
    "updated_at": "2023-08-22T:00:00+00:00",
    "user_email": "dwight@dundermilflin.com",
    "user_full_name": "Dwight Schrute",
    "user_id": "7979392e-8d41-4f97-815b-ccd7584802bf"
  }
}

Get Transaction​

Retrieve a transaction by ID | key: getTransaction

Output Example Payload​

{
  "data": {
    "accounting_categories": [],
    "accounting_field_selections": [
      {
        "category_info": {
          "external_id": "Category",
          "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
          "name": "Category",
          "type": "GL_ACCOUNT"
        },
        "external_id": "Category",
        "id": "07b4ce4d-2750-412e-aef4-6b7815f1411c",
        "name": "Category",
        "type": "GL_ACCOUNT"
      }
    ],
    "amount": 90,
    "card_holder": {
      "department_id": "d471d830-2e73-4082-8a75-68540f83e86e",
      "department_name": "Executive",
      "first_name": "Patrick",
      "last_name": "Robinson",
      "location_id": "4fcf3423-a2e6-42f6-8dd8-9b3a8c51e069",
      "location_name": "San Francisco",
      "user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
    },
    "card_id": "6bc41b14-f853-4862-bae5-4f122f123f6e",
    "currency_code": "USD",
    "disputes": [],
    "entity_id": "24850cdb-1b3f-4eb9-bf20-967ca9f97605",
    "id": "fd14cd6a-846e-4994-9315-5a59e6bb465f",
    "line_items": [
      {
        "accounting_field_selections": [
          {
            "category_info": {
              "external_id": "Subsidiary",
              "id": "15e9565d-7e73-40d8-9fbc-5f6f89b1c075",
              "name": "Subsidiary",
              "type": "SUBSIDIARY"
            },
            "external_id": "425",
            "id": "07b4ce4d-2750-412e-aef4-6b7815f1411b",
            "name": "Ramp LP",
            "type": "Subsidiary"
          }
        ],
        "amount": {
          "amount": 4000,
          "currency_code": "USD"
        }
      },
      {
        "accounting_field_selections": [
          {
            "category_info": {
              "external_id": "Subsidiary",
              "id": "15e9565d-7e73-40d8-9fbc-5f6f89b1c075",
              "name": "Subsidiary",
              "type": "SUBSIDIARY"
            },
            "external_id": "426",
            "id": "07b4ce4d-2750-412e-aef4-6b7815f1411a",
            "name": "Ramp BV",
            "type": "SUBSIDIARY"
          }
        ],
        "amount": {
          "amount": 5000,
          "currency_code": "USD"
        }
      }
    ],
    "memo": null,
    "merchant_category_code": null,
    "merchant_category_code_description": null,
    "merchant_data": {
      "auto_rental": null,
      "flight": null,
      "fuel": null,
      "lodging": null,
      "receipt": [
        {
          "commodity_code": null,
          "description": "Vanta Automated Compliance",
          "discount": null,
          "quantity": 1,
          "tax": null,
          "total": 5000,
          "unit_cost": 5000
        },
        {
          "commodity_code": null,
          "description": "Vanta Risk Management",
          "discount": null,
          "quantity": 1,
          "tax": null,
          "total": 4000,
          "unit_cost": 4000
        }
      ],
      "reference": "343165593943"
    },
    "merchant_descriptor": "VANTA",
    "merchant_id": "2907e304-cac2-4abf-84c4-b3b454ae3b8c",
    "merchant_location": {
      "city": "SAN FRANCISCO",
      "country": "USA",
      "postal_code": "941050000",
      "state": "06"
    },
    "merchant_name": "Vanta",
    "original_transaction_amount": {
      "amount": 9000,
      "currency_code": "EUR"
    },
    "policy_violations": [],
    "receipts": [],
    "settlement_date": "2022-05-03T00:00:00+00:00",
    "sk_category_id": "40,41",
    "sk_category_name": "SaaS / Software",
    "state": "CLEARED",
    "synced_at": "2022-05-04T00:00:00+00:00",
    "trip_id": "ec6aae2b-38c6-4eeb-adf0-80f25dbf9aad",
    "trip_name": "Trip to Europe",
    "user_transaction_time": "2022-04-28T00:00:00+00:00"
  }
}

Get Vendor​

Retrieve a vendor by ID | key: getVendor

Output Example Payload​

{
  "data": {
    "code": "19566",
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "123",
    "is_active": true,
    "is_synced": true,
    "name": "Amazon",
    "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

List Bills​

Retrieve a list of all bills | key: listBills

Output Example Payload​

{
  "data": {
    "data": [
      {
        "accounting_field_selections": [],
        "amount": {
          "amount": 96993,
          "currency_code": "USD"
        },
        "created_at": "2024-05-12T01:37:27+00:00",
        "deep_link_url": null,
        "due_at": "2022-12-31T00:00:00+00:00",
        "entity_id": "5bcc3734-f03a-4756-bc4b-afeb52d738ad",
        "id": "6e3816e3-0e53-42ae-b075-bdb0adff10c4",
        "invoice_number": "432",
        "invoice_urls": [
          "https://receipts.ramp.com/some-url"
        ],
        "issued_at": "2022-12-31T00:00:00+00:00",
        "line_items": [
          {
            "accounting_field_selections": [],
            "amount": {
              "amount": 1998,
              "currency_code": "USD"
            },
            "memo": "Telephone Headset"
          },
          {
            "accounting_field_selections": [],
            "amount": {
              "amount": 94995,
              "currency_code": "USD"
            },
            "memo": "2-Drawer Lateral File Cabinet Steel White"
          }
        ],
        "payment": {
          "amount": {
            "amount": 96993,
            "currency_code": "USD"
          },
          "effective_date": "2024-05-13T00:00:00+00:00",
          "payment_date": "2024-05-13T00:00:00+00:00",
          "payment_method": "ACH"
        },
        "remote_id": null,
        "status": "OPEN",
        "user": {
          "first_name": "John",
          "id": "96bb7007-eec5-430f-8d09-e033cbc000c2",
          "last_name": "Doe"
        },
        "vendor": {
          "remote_id": "Amazon",
          "remote_name": "Amazon",
          "type": "BUSINESS"
        }
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Business Entities​

Retrieve a list of all business entities | key: listBusinessEntities

Output Example Payload​

{
  "data": {
    "page": {
      "next": ""
    },
    "data": [
      {
        "entity_name": "Canada",
        "id": "55da4b86-5b47-4b6b-a274-a669a6cb14be",
        "is_primary": false,
        "currency": "CAD"
      },
      {
        "entity_name": "Global Entity",
        "id": "364bab39-0485-4bcf-b9b1-7f18fac77600",
        "is_primary": true,
        "currency": "USD"
      }
    ]
  }
}

List Custom Accounting Field​

List custom accounting fields | key: listCustomAccountingField

Output Example Payload​

{
  "data": {
    "data": [
      {
        "created_at": "2019-08-28T14:15:22+00:00",
        "id": "Department",
        "input_type": "SINGLE_CHOICE",
        "is_active": true,
        "is_splittable": true,
        "name": "Department",
        "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
        "updated_at": "2020-08-28T14:40:12+00:00"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Custom Accounting Field Options​

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

Output Example Payload​

{
  "data": {
    "data": [
      {
        "created_at": "2019-08-28T14:15:22+00:00",
        "id": "123",
        "is_active": true,
        "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
        "remote_code": "20001",
        "updated_at": "2020-08-28T14:40:12+00:00",
        "value": "Office/Admin:Phone & Internet"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Departments​

Retrieve a list of all Departments | key: listDepartments

Output Example Payload​

{
  "data": {
    "data": [
      {
        "id": "c16b6ee1-2f5d-45e9-9fb4-c1c541a9ea70",
        "name": "Bookkeeping"
      }
    ],
    "page": {
      "next": "https://api.prismatic.io/departments?page=2"
    }
  }
}

List General Ledger Accounts​

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

Output Example Payload​

{
  "data": {
    "data": [
      {
        "classification": "EXPENSE",
        "code": "6410",
        "created_at": "2019-08-28T14:15:22+00:00",
        "id": "514",
        "is_active": true,
        "name": "Employees:Salaries & Wages",
        "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
        "updated_at": "2020-08-28T14:40:12+00:00"
      },
      {
        "classification": "EXPENSE",
        "code": "6410",
        "created_at": "2019-08-28T14:15:22+00:00",
        "id": "514",
        "is_active": true,
        "name": "Employees:Salaries & Wages",
        "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
        "updated_at": "2020-08-28T14:40:12+00:00"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Locations​

Retrieve a list of all locations | key: listLocations

Output Example Payload​

{
  "data": {
    "data": [
      {
        "entity_id": "bb25a7e8-cc2f-4ba7-9bf4-7730ffe152bb",
        "id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
        "name": "New York City, NY"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Reimbursements​

Retrieve a list of all reimbursements | key: listReimbursements

Output Example Payload​

{
  "data": {
    "data": [
      {
        "accounting_field_selections": [
          {
            "category_info": {
              "external_id": "Category",
              "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
              "name": "Category",
              "type": "GL_ACCOUNT"
            },
            "external_id": "Category",
            "id": "07b4ce4d-2750-412e-aef4-6b7815f1411c",
            "name": "Category",
            "type": "GL_ACCOUNT"
          }
        ],
        "amount": 484.46,
        "created_at": "2023-08-20T:00:00+00:00",
        "currency": "USD",
        "direction": "BUSINESS_TO_USER",
        "distance": 55,
        "entity_id": "4bec9dc1-710e-4781-b254-fc606c76a241",
        "id": "d47ba06e-14ac-4a7b-89b4-4775412ba545",
        "line_items": [
          {
            "accounting_field_selections": [
              {
                "category_info": {
                  "external_id": "Category",
                  "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
                  "name": "Category",
                  "type": "GL_ACCOUNT"
                },
                "external_id": "425",
                "id": "07b4ce4d-2750-412e-aef4-6b7815f1411b",
                "name": "Ramp LP",
                "type": "Subsidiary"
              }
            ],
            "amount": {
              "amount": 43446,
              "currency_code": "USD"
            }
          },
          {
            "accounting_field_selections": [
              {
                "category_info": {
                  "external_id": "Category",
                  "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
                  "name": "Category",
                  "type": "GL_ACCOUNT"
                },
                "external_id": "426",
                "id": "07b4ce4d-2750-412e-aef4-6b7815f1411a",
                "name": "Ramp BV",
                "type": "Subsidiary"
              }
            ],
            "amount": {
              "amount": 5000,
              "currency_code": "USD"
            }
          }
        ],
        "memo": "Airfare for business travel",
        "merchant": "Delta Airlines",
        "original_reimbursement_amount": {
          "amount": 48446,
          "currency_code": "USD"
        },
        "payee_amount": {
          "amount": 48446,
          "currency_code": "USD"
        },
        "payment_id": "NDPHKHCN6G",
        "receipts": [],
        "spend_limit_id": "92a68991-8374-4c0a-b5c0-5180c41b5148",
        "state": "REIMBURSED",
        "synced_at": "2023-08-21T:00:00+00:00",
        "transaction_date": "2022-08-19",
        "trip_id": "ec6aae2b-38c6-4eeb-adf0-80f25dbf9aad",
        "type": "OUT_OF_POCKET",
        "updated_at": "2023-08-22T:00:00+00:00",
        "user_email": "dwight@dundermilflin.com",
        "user_full_name": "Dwight Schrute",
        "user_id": "7979392e-8d41-4f97-815b-ccd7584802bf"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Transactions​

Retrieve a list of all transactions | key: listTransactions

Output Example Payload​

{
  "data": {
    "data": [
      {
        "accounting_categories": [],
        "accounting_field_selections": [
          {
            "category_info": {
              "external_id": "Category",
              "id": "0c0d0bcc-8716-4e05-a651-4ad5e64d2b3e",
              "name": "Category",
              "type": "GL_ACCOUNT"
            },
            "external_id": "Category",
            "id": "07b4ce4d-2750-412e-aef4-6b7815f1411c",
            "name": "Category",
            "type": "GL_ACCOUNT"
          }
        ],
        "amount": 90,
        "card_holder": {
          "department_id": "d471d830-2e73-4082-8a75-68540f83e86e",
          "department_name": "Executive",
          "first_name": "Patrick",
          "last_name": "Robinson",
          "location_id": "4fcf3423-a2e6-42f6-8dd8-9b3a8c51e069",
          "location_name": "San Francisco",
          "user_id": "a26c82c9-6b7d-4022-bc4b-a55b4c4743c7"
        },
        "card_id": "6bc41b14-f853-4862-bae5-4f122f123f6e",
        "currency_code": "USD",
        "disputes": [],
        "entity_id": "24850cdb-1b3f-4eb9-bf20-967ca9f97605",
        "id": "fd14cd6a-846e-4994-9315-5a59e6bb465f",
        "line_items": [
          {
            "accounting_field_selections": [
              {
                "category_info": {
                  "external_id": "Subsidiary",
                  "id": "15e9565d-7e73-40d8-9fbc-5f6f89b1c075",
                  "name": "Subsidiary",
                  "type": "SUBSIDIARY"
                },
                "external_id": "425",
                "id": "07b4ce4d-2750-412e-aef4-6b7815f1411b",
                "name": "Ramp LP",
                "type": "Subsidiary"
              }
            ],
            "amount": {
              "amount": 4000,
              "currency_code": "USD"
            }
          },
          {
            "accounting_field_selections": [
              {
                "category_info": {
                  "external_id": "Subsidiary",
                  "id": "15e9565d-7e73-40d8-9fbc-5f6f89b1c075",
                  "name": "Subsidiary",
                  "type": "SUBSIDIARY"
                },
                "external_id": "426",
                "id": "07b4ce4d-2750-412e-aef4-6b7815f1411a",
                "name": "Ramp BV",
                "type": "SUBSIDIARY"
              }
            ],
            "amount": {
              "amount": 5000,
              "currency_code": "USD"
            }
          }
        ],
        "memo": null,
        "merchant_category_code": null,
        "merchant_category_code_description": null,
        "merchant_data": {
          "auto_rental": null,
          "flight": null,
          "fuel": null,
          "lodging": null,
          "receipt": [
            {
              "commodity_code": null,
              "description": "Vanta Automated Compliance",
              "discount": null,
              "quantity": 1,
              "tax": null,
              "total": 5000,
              "unit_cost": 5000
            },
            {
              "commodity_code": null,
              "description": "Vanta Risk Management",
              "discount": null,
              "quantity": 1,
              "tax": null,
              "total": 4000,
              "unit_cost": 4000
            }
          ],
          "reference": "343165593943"
        },
        "merchant_descriptor": "VANTA",
        "merchant_id": "2907e304-cac2-4abf-84c4-b3b454ae3b8c",
        "merchant_location": {
          "city": "SAN FRANCISCO",
          "country": "USA",
          "postal_code": "941050000",
          "state": "06"
        },
        "merchant_name": "Vanta",
        "original_transaction_amount": {
          "amount": 9000,
          "currency_code": "EUR"
        },
        "policy_violations": [],
        "receipts": [],
        "settlement_date": "2022-05-03T00:00:00+00:00",
        "sk_category_id": "40,41",
        "sk_category_name": "SaaS / Software",
        "state": "CLEARED",
        "synced_at": "2022-05-04T00:00:00+00:00",
        "trip_id": "ec6aae2b-38c6-4eeb-adf0-80f25dbf9aad",
        "trip_name": "Trip to Europe",
        "user_transaction_time": "2022-04-28T00:00:00+00:00"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

List Vendors​

Retrieve a list of all vendors | key: listVendors

Output Example Payload​

{
  "data": {
    "data": [
      {
        "code": "19566",
        "created_at": "2019-08-28T14:15:22+00:00",
        "id": "123",
        "is_active": true,
        "is_synced": true,
        "name": "Amazon",
        "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
        "updated_at": "2020-08-28T14:40:12+00:00"
      },
      {
        "code": "19566",
        "created_at": "2019-08-28T14:15:22+00:00",
        "id": "123",
        "is_active": true,
        "is_synced": true,
        "name": "Amazon",
        "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
        "updated_at": "2020-08-28T14:40:12+00:00"
      }
    ],
    "page": {
      "next": "https://api.ramp.com/developer/v1/<resources>?<new_params>"
    }
  }
}

Post Sync Status​

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

Raw Request​

Send raw HTTP request to Ramp API | key: rawRequest

Update Custom Accounting Field​

Update an existing custom accounting field | key: updateCustomAccountingField

Output Example Payload​

{
  "data": {
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "Department",
    "input_type": "SINGLE_CHOICE",
    "is_active": true,
    "is_splittable": true,
    "name": "Department",
    "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

Update Custom Accounting Field Option​

Update an existing custom accounting field option | key: updateCustomAccountingFieldOption

Output Example Payload​

{
  "data": {
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "123",
    "is_active": true,
    "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
    "remote_code": "20001",
    "updated_at": "2020-08-28T14:40:12+00:00",
    "value": "Office/Admin:Phone & Internet"
  }
}

Update Department​

Update a department by ID | key: updateDepartment

Output Example Payload​

{
  "data": {
    "id": "c16b6ee1-2f5d-45e9-9fb4-c1c541a9ea70",
    "name": "Bookkeeping"
  }
}

Update General Ledger Account​

Update an existing general ledger account | key: updateGeneralLedgerAccount

Output Example Payload​

{
  "data": {
    "classification": "EXPENSE",
    "code": "6410",
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "514",
    "is_active": true,
    "name": "Employees:Salaries & Wages",
    "ramp_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

Update Location​

Update an existing location | key: updateLocation

Output Example Payload​

{
  "data": {
    "entity_id": "bb25a7e8-cc2f-4ba7-9bf4-7730ffe152bb",
    "id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
    "name": "New York City, NY"
  }
}

Update Vendor​

Update an existing vendor | key: updateVendor

Output Example Payload​

{
  "data": {
    "code": "19566",
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "123",
    "is_active": true,
    "is_synced": true,
    "name": "Amazon",
    "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
    "updated_at": "2020-08-28T14:40:12+00:00"
  }
}

Upload Custom Accounting Field Option​

Upload a new custom accounting field option | key: uploadCustomAccountingFieldOption

Output Example Payload​

{
  "data": {
    "created_at": "2019-08-28T14:15:22+00:00",
    "id": "123",
    "is_active": true,
    "ramp_id": "649b6731-33c6-4ff5-8a5d-2333fcc90ace",
    "remote_code": "20001",
    "updated_at": "2020-08-28T14:40:12+00:00",
    "value": "Office/Admin:Phone & Internet"
  }
}