Ramp: Trips schemas
5 Ramp schemas with complete fields and constraints.
← Trips operations · All schemas
Fetch a trip — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date the trip was created Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | The description for the trip |
description (anyOf 2) | null | Alternative | |
end_date | string | Required within parent | The date the trip ends Format: date-time |
id | string | Required within parent | Unique identifier for the trip Format: uuid |
length_in_days | JSON | Required within parent | |
length_in_days (anyOf 1) | integer | Alternative | Number of days for the trip |
length_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
locations | array | Required within parent | Destinations and location segments for the trip |
locations[] | Model | Each item | Expand Fetch a trip — response body — locations item |
name | string | Required within parent | The name of the trip |
spend_events | array | Required within parent | Spend events for the trip |
spend_events[] | Model | Each item | Expand Fetch a trip — response body — spend events item |
start_date | string | Required within parent | The date the trip starts Format: date-time |
status | string | Required within parent | Current trip status Known values: cancelled, completed, ongoing, upcoming |
total_spend | JSON | Required within parent | |
total_spend (anyOf 1) | number | Alternative | Total spend for the trip. Deprecated: use `total_spend_amount` instead. Read only: true |
total_spend (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_spend_amount | JSON | Required within parent | |
total_spend_amount (anyOf 1) | Model | Alternative | Expand Fetch a transaction — response body — entity amount currency, value Total spend for the trip in minor units with an explicit ISO 4217 currency code. May be negative for refund-dominated trips. `null` when the trip has no spend events or its spend events do not share a single recognized currency. Read only: true |
total_spend_amount (anyOf 2) | null | Alternative | |
travel_types | array | Required within parent | Types of travel for this trip (flights, hotels, cars) Read only: true |
travel_types[] | string | Each item | Known values: CAR, FLIGHT, HOTEL |
updated_at | string | Required within parent | The date the trip was last updated Format: date-time |
user_id | string | Required within parent | User/traveler's ID Format: uuid |
Referenced models: Fetch a transaction — response body — entity amount currency, value, Fetch a trip — response body — locations item, Fetch a trip — response body — spend events item
Fetch a trip — response body — locations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Required within parent | The date the trip segment ends Format: date-time |
location | Model | Required within parent | Expand Fetch a trip — response body — locations item location The location of the trip segment |
start_date | string | Required within parent | The date the trip segment starts Format: date-time |
Referenced models: Fetch a trip — response body — locations item location
Fetch a trip — response body — locations item location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | |
city (anyOf 2) | null | Alternative | |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
latitude | JSON | Required within parent | |
latitude (anyOf 1) | JSON | Alternative | |
latitude (anyOf 1) (anyOf 1) | number | Alternative | |
latitude (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
latitude (anyOf 2) | null | Alternative | |
longitude | JSON | Required within parent | |
longitude (anyOf 1) | JSON | Alternative | |
longitude (anyOf 1) (anyOf 1) | number | Alternative | |
longitude (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude (anyOf 2) | null | Alternative | |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative |
Fetch a trip — response body — spend events item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The ID of the spend event Format: uuid Read only: true |
spend_type | string | Required within parent | The type of the spend event Known values: BILL, REIMBURSEMENT, TRANSACTION |
List all trips for the business — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | array | Each item | |
data[][] | Model | Each item | Expand Fetch a trip — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a trip — response body