Brex: Travel schemas
59 Brex schemas with complete fields and constraints.
← Travel operations · All schemas
Get booking — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A booking representation. |
booking_data | Model | Required within parent | Expand Get booking — response body — booking data |
booking_reference | JSON | Optional | |
booking_reference (anyOf 1) | string | Alternative | The booking reference number shown in the dashboard and used when contacting Brex Support. This is the reference from the travel provider, not the Brex internal booking ID. May be null if the booking has no associated reference. |
booking_reference (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The time when the booking was created. Format: date-time |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | Custom field values associated with this resource. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Get trip — response body — custom fields Custom field values associated with this resource item |
custom_fields (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the booking. |
policy | JSON | Optional | |
policy (anyOf 1) | JSON | Alternative | The result of evaluating the customer's travel policy against this booking, as shown to the traveler when the booking was made. Mirrors the policy information available in the booking export. May be null when no policy was evaluated for the booking. |
policy (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — policy out of policy, violations out of policy, violations |
policy (anyOf 2) | null | Alternative | |
source | string | Required within parent | The original source of a booking: * `BREX_TRAVEL` - The booking was created via Brex Travel. * `EXTERNAL` - The booking was manually inserted, e.g. a hotel room block for a group event. Known values: BREX_TRAVEL, EXTERNAL |
status | Model | Required within parent | Expand Get booking — response body — status |
trip_id | string | Required within parent | The ID of the trip to which this booking belongs. |
trip_reference | JSON | Optional | |
trip_reference (anyOf 1) | string | Alternative | The trip reference number shown in the dashboard and used when contacting Brex Support. This is the reference from the travel provider, not the Brex internal trip ID. May be null if the trip has no associated reference. |
trip_reference (anyOf 2) | null | Alternative | |
type | string | Required within parent | The type of a booking. Known values: AIR, CAR_RENTAL, LODGING, RAIL |
updated_at | string | Required within parent | The time when the booking was last updated. Format: date-time |
version | JSON | Required within parent | |
version (anyOf 1) | integer | Alternative | The current version of the booking. Format: int32 Minimum: 1 |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get booking — response body — booking data, Get booking — response body — policy out of policy, violations out of policy, violations, Get booking — response body — status, Get trip — response body — custom fields Custom field values associated with this resource item
Get booking — response body — booking data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Type-specific booking data. discriminator: {"mapping": {"AIR": "#/components/schemas/travel__AirBookingData", "CAR_RENTAL": "#/components/schemas/travel__CarRentalBookingData", "LODGING": "#/components/schemas/travel__LodgingBookingData", "RAIL": "#/components/schemas/travel__RailBookingData"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Get booking — response body — booking data Air-specific booking information |
$ (anyOf 2) | Model | Alternative | Expand Get booking — response body — booking data Car rental-specific booking information |
$ (anyOf 3) | Model | Alternative | Expand Get booking — response body — booking data Lodging-specific booking information |
$ (anyOf 4) | Model | Alternative | Expand Get booking — response body — booking data Rail-specific booking information |
Referenced models: Get booking — response body — booking data Air-specific booking information, Get booking — response body — booking data Car rental-specific booking information, Get booking — response body — booking data Lodging-specific booking information, Get booking — response body — booking data Rail-specific booking information
Get booking — response body — booking data Air-specific booking information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Air-specific booking information. |
journeys | array | Required within parent | The journeys that make up this booking. |
journeys[] | Model | Each item | Expand Get booking — response body — booking data Air-specific booking information journeys item |
known_traveler_number | JSON | Optional | |
known_traveler_number (anyOf 1) | JSON | Alternative | |
known_traveler_number (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country |
known_traveler_number (anyOf 1) (allOf 2) | JSON | All variants apply | The Known Traveler Number associated with this booking. |
known_traveler_number (anyOf 2) | null | Alternative | |
redress_number | JSON | Optional | |
redress_number (anyOf 1) | JSON | Alternative | |
redress_number (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country |
redress_number (anyOf 1) (allOf 2) | JSON | All variants apply | The Redress Number associated with this booking. |
redress_number (anyOf 2) | null | Alternative | |
tickets | array | Required within parent | The flight tickets in this booking. |
tickets[] | Model | Each item | Expand Get booking — response body — booking data Air-specific booking information tickets item |
type | string | Optional |
Referenced models: Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country, Get booking — response body — booking data Air-specific booking information tickets item, Get booking — response body — booking data Air-specific booking information journeys item
Get booking — response body — booking data Air-specific booking information journeys item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A journey is composed of one or more flight segments that take a passenger from an origin to a final destination. E.g. if a traveler is doing a round trip from GIG to SFO, but they need to make a connection in IAH in each direction, the booking will contain 2 journeys. The first will contain 2 segments: GIG > IAH, and IAH > SFO. The second journey will also contain 2 segments: SFO > IAH, and IAH > GIG. |
cabin_display_name | JSON | Optional | |
cabin_display_name (anyOf 1) | string | Alternative | The cabin name as shown by the airline. |
cabin_display_name (anyOf 2) | null | Alternative | |
flights | array | Required within parent | The flights that make up this journey. |
flights[] | Model | Each item | Expand Get booking — response body — booking data Air-specific booking information journeys item flights item |
status | JSON | Required within parent | |
status (allOf 1) | Model | All variants apply | Expand Get booking — response body — status |
status (allOf 2) | JSON | All variants apply | The status of this specific journey. |
Referenced models: Get booking — response body — booking data Air-specific booking information journeys item flights item, Get booking — response body — status
Get booking — response body — booking data Air-specific booking information journeys item flights item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A flight taken by the traveler. |
arrival_time | JSON | Required within parent | |
arrival_time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
arrival_time (allOf 2) | JSON | All variants apply | The time when the flight arrives at the destination. |
cabin_class | JSON | Optional | |
cabin_class (anyOf 1) | JSON | Alternative | |
cabin_class (anyOf 1) (allOf 1) | string | All variants apply | The cabin class of a flight. Known values: ECONOMY, PREMIUM_ECONOMY, BUSINESS, FIRST |
cabin_class (anyOf 1) (allOf 2) | JSON | All variants apply | The cabin class for this flight. |
cabin_class (anyOf 2) | null | Alternative | |
confirmation_code | JSON | Optional | |
confirmation_code (anyOf 1) | string | Alternative | The airline confirmation code. |
confirmation_code (anyOf 2) | null | Alternative | |
departure_time | JSON | Required within parent | |
departure_time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
departure_time (allOf 2) | JSON | All variants apply | The time when the flight departs the origin. |
destination | Model | Required within parent | Expand Get booking — response body — booking data Air-specific booking information journeys item flights item origin |
duration | JSON | Optional | |
duration (anyOf 1) | string | Alternative | The duration of the flight in the ISO 8601 PnYnMnDTnHnMnS format. |
duration (anyOf 2) | null | Alternative | |
marketing_flight | JSON | Optional | |
marketing_flight (anyOf 1) | JSON | Alternative | |
marketing_flight (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information |
marketing_flight (anyOf 1) (allOf 2) | JSON | All variants apply | The marketing flight number. Some flights are sold by one airline, but operated by another in the same alliance. This is the flight that was originally sold. |
marketing_flight (anyOf 2) | null | Alternative | |
operating_flight | JSON | Optional | |
operating_flight (anyOf 1) | JSON | Alternative | |
operating_flight (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information |
operating_flight (anyOf 1) (allOf 2) | JSON | All variants apply | The operating flight number. Some flights are sold by one airline, but operated by another in the same alliance. This is the flight the traveler is actually taking. |
operating_flight (anyOf 2) | null | Alternative | |
origin | Model | Required within parent | Expand Get booking — response body — booking data Air-specific booking information journeys item flights item origin |
seat | JSON | Optional | |
seat (anyOf 1) | JSON | Alternative | |
seat (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Air-specific booking information journeys item flights item seat The seat reserved for this flight Seat information in a flight |
seat (anyOf 1) (allOf 2) | JSON | All variants apply | The seat reserved for this flight. |
seat (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body — booking data Air-specific booking information journeys item flights item origin, Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information, Get booking — response body — booking data Air-specific booking information journeys item flights item seat The seat reserved for this flight Seat information in a flight, Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The flight number, including carrier information. |
airline_code | string | Required within parent | The IATA code for the airline. Pattern: [0-9A-Z]{2} |
airline_name | JSON | Optional | |
airline_name (anyOf 1) | string | Alternative | The name of the airline. |
airline_name (anyOf 2) | null | Alternative | |
number | string | Required within parent | The number of the flight. Pattern: \d{1,4} |
Get booking — response body — booking data Air-specific booking information journeys item flights item origin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The place where a flight departs from or arrives at. |
airport_code | string | Required within parent | The 3-letter IATA code of the airport. Pattern: [A-Z]{3} |
airport_location | JSON | Optional | |
airport_location (anyOf 1) | JSON | Alternative | |
airport_location (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone |
airport_location (anyOf 1) (allOf 2) | JSON | All variants apply | The location of the airport. |
airport_location (anyOf 2) | null | Alternative | |
gate | JSON | Optional | |
gate (anyOf 1) | string | Alternative | The gate for boarding or leaving the plane. |
gate (anyOf 2) | null | Alternative | |
terminal | JSON | Optional | |
terminal (anyOf 1) | string | Alternative | The terminal name and/or number. |
terminal (anyOf 2) | null | Alternative |
Get booking — response body — booking data Air-specific booking information journeys item flights item seat The seat reserved for this flight Seat information in a flight
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Seat information in a flight. |
number | string | Required within parent | The seat number. |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | The status of a flight seat. Known values: PENDING, CONFIRMED, CANCELED |
status (anyOf 1) (allOf 2) | JSON | All variants apply | |
status (anyOf 2) | null | Alternative |
Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A document number such as a redress number or a known traveler number. |
document_number | string | Required within parent | The actual document number. |
issuing_country | string | Required within parent | The country that issued this document. |
Get booking — response body — booking data Air-specific booking information tickets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A flight ticket. |
issue_date | JSON | Optional | |
issue_date (anyOf 1) | string | Alternative | The date when the ticket was issued. Format: date |
issue_date (anyOf 2) | null | Alternative | |
number | string | Required within parent | The ticket number provided by the airline. |
Get booking — response body — booking data Car rental-specific booking information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Car rental-specific booking information. |
car_details | Model | Required within parent | Expand Get booking — response body — booking data Car rental-specific booking information car details |
reservation_details | Model | Required within parent | Expand Get booking — response body — booking data Car rental-specific booking information reservation details |
type | string | Optional |
Referenced models: Get booking — response body — booking data Car rental-specific booking information car details, Get booking — response body — booking data Car rental-specific booking information reservation details
Get booking — response body — booking data Car rental-specific booking information car details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information on a rental car. |
car_class | JSON | Optional | |
car_class (anyOf 1) | JSON | Alternative | |
car_class (anyOf 1) (allOf 1) | string | All variants apply | The kind of car. Known values: ECONOMY, COMPACT, INTERMEDIATE, PREMIUM, LUXURY, CONVERTIBLE, COMPACT_SUV, INTERMEDIATE_SUV, PREMIUM_SUV, LUXURY_SUV, MINI_VAN, PASSENGER_VAN, PICKUP_TRUCK, HYBRID, ELECTRIC, MINI, STANDARD, FULL_SIZE, SUV, SPORTS, SPECIAL, RECREATIONAL_VEHICLE, OTHER |
car_class (anyOf 1) (allOf 2) | JSON | All variants apply | |
car_class (anyOf 2) | null | Alternative | |
display_name | string | Required within parent | The name of the car as displayed to the user. |
Get booking — response body — booking data Car rental-specific booking information reservation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information on a car reservation such as pickup, drop-off, etc. |
confirmation_code | JSON | Optional | |
confirmation_code (anyOf 1) | string | Alternative | The confirmation code given by the vendor. |
confirmation_code (anyOf 2) | null | Alternative | |
drop_off | JSON | Required within parent | |
drop_off (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off |
drop_off (allOf 2) | JSON | All variants apply | Information on the car return. |
pickup | JSON | Required within parent | |
pickup (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off |
pickup (allOf 2) | JSON | All variants apply | Information on the car pickup. |
rental_company | JSON | Optional | |
rental_company (anyOf 1) | string | Alternative | Name of car rental company. |
rental_company (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off
Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the car pickup or drop-off. |
location | JSON | Required within parent | |
location (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone |
location (allOf 2) | JSON | All variants apply | The location where the car can be picked up or where it must be returned. |
time | JSON | Required within parent | |
time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
time (allOf 2) | JSON | All variants apply | The time when the car will be available for pickup or by when it must be returned. |
Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone, Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
Get booking — response body — booking data Lodging-specific booking information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lodging-specific booking information. |
lodging_details | Model | Required within parent | Expand Get booking — response body — booking data Lodging-specific booking information lodging details |
reservation_details | Model | Required within parent | Expand Get booking — response body — booking data Lodging-specific booking information reservation details |
type | string | Optional |
Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details, Get booking — response body — booking data Lodging-specific booking information reservation details
Get booking — response body — booking data Lodging-specific booking information lodging details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information on a lodging venue. |
brand_name | JSON | Optional | |
brand_name (anyOf 1) | string | Alternative | The brand name of the hotel. |
brand_name (anyOf 2) | null | Alternative | |
chain_name | JSON | Optional | |
chain_name (anyOf 1) | string | Alternative | The name of the hotel chain. |
chain_name (anyOf 2) | null | Alternative | |
contact_information | JSON | Optional | |
contact_information (anyOf 1) | JSON | Alternative | |
contact_information (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information lodging details contact information Contact information of a venue Contact information of a venue |
contact_information (anyOf 1) (allOf 2) | JSON | All variants apply | |
contact_information (anyOf 2) | null | Alternative | |
display_name | string | Required within parent | The name of the venue as displayed to the user. |
location | JSON | Optional | |
location (anyOf 1) | JSON | Alternative | |
location (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone |
location (anyOf 1) (allOf 2) | JSON | All variants apply | The location of the hotel. |
location (anyOf 2) | null | Alternative | |
star_rating | JSON | Optional | |
star_rating (anyOf 1) | JSON | Alternative | |
star_rating (anyOf 1) (anyOf 1) | number | Alternative | The star rating of the hotel. Some hotels have half stars. Format: float |
star_rating (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
star_rating (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone, Get booking — response body — booking data Lodging-specific booking information lodging details contact information Contact information of a venue Contact information of a venue
Get booking — response body — booking data Lodging-specific booking information lodging details contact information Contact information of a venue Contact information of a venue
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contact information of a venue. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | The email address of the venue. |
email (anyOf 2) | null | Alternative | |
fax | JSON | Optional | |
fax (anyOf 1) | string | Alternative | The fax number of the venue. |
fax (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | The phone number of the venue. |
phone (anyOf 2) | null | Alternative |
Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A location. All fields are optional, but the object will hold as much information as possible. |
address_line_1 | JSON | Optional | |
address_line_1 (anyOf 1) | string | Alternative | The first line of the address. |
address_line_1 (anyOf 2) | null | Alternative | |
address_line_2 | JSON | Optional | |
address_line_2 (anyOf 1) | string | Alternative | The second line of the address. |
address_line_2 (anyOf 2) | null | Alternative | |
administrative_area | JSON | Optional | |
administrative_area (anyOf 1) | string | Alternative | Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. |
administrative_area (anyOf 2) | null | Alternative | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | The city where the address is located. |
city (anyOf 2) | null | Alternative | |
coordinates | JSON | Optional | |
coordinates (anyOf 1) | JSON | Alternative | |
coordinates (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone coordinates The coordinates of the address The coordinates of an address |
coordinates (anyOf 1) (allOf 2) | JSON | All variants apply | The coordinates of the address. |
coordinates (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. |
country (anyOf 2) | null | Alternative | |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | The postal code of the given address. |
postal_code (anyOf 2) | null | Alternative | |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The timezone in the given address. |
timezone (anyOf 2) | null | Alternative |
Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone coordinates The coordinates of the address The coordinates of an address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The coordinates of an address. |
latitude | JSON | Required within parent | |
latitude (anyOf 1) | number | Alternative | Format: double |
latitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude | JSON | Required within parent | |
longitude (anyOf 1) | number | Alternative | Format: double |
longitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get booking — response body — booking data Lodging-specific booking information reservation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information on a reservation such as check-in, checkout, etc. |
check_in_time | JSON | Required within parent | |
check_in_time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
check_in_time (allOf 2) | JSON | All variants apply | The time when check-in will be available. |
checkout_time | JSON | Required within parent | |
checkout_time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
checkout_time (allOf 2) | JSON | All variants apply | The time limit for checkout. |
confirmation_code | JSON | Optional | |
confirmation_code (anyOf 1) | string | Alternative | Confirmation code provided by the vendor. |
confirmation_code (anyOf 2) | null | Alternative | |
room | JSON | Optional | |
room (anyOf 1) | JSON | Alternative | |
room (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details room Information on a room that was booked Information on a room that was booked |
room (anyOf 1) (allOf 2) | JSON | All variants apply | |
room (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp, Get booking — response body — booking data Lodging-specific booking information reservation details room Information on a room that was booked Information on a room that was booked
Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A time within a booking, including local time in the relevant location, and a timestamp when possible. |
local_time | string | Required within parent | The local time in the relevant location in the ISO 8601 format. Format: date-time |
timestamp | JSON | Optional | |
timestamp (anyOf 1) | string | Alternative | An ISO 8601 timestamp. Format: date-time |
timestamp (anyOf 2) | null | Alternative |
Get booking — response body — booking data Lodging-specific booking information reservation details room Information on a room that was booked Information on a room that was booked
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information on a room that was booked. |
bed_count | JSON | Optional | |
bed_count (anyOf 1) | JSON | Alternative | |
bed_count (anyOf 1) (anyOf 1) | integer | Alternative | The number of beds. Format: int32 |
bed_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bed_count (anyOf 2) | null | Alternative | |
bed_type | JSON | Optional | |
bed_type (anyOf 1) | string | Alternative | The kind of bed. |
bed_type (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A description of the room. |
description (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | The name of the room as displayed to the user. |
display_name (anyOf 2) | null | Alternative |
Get booking — response body — booking data Rail-specific booking information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Rail-specific booking information. |
journeys | array | Required within parent | The journeys that make up this booking. |
journeys[] | Model | Each item | Expand Get booking — response body — booking data Rail-specific booking information journeys item |
type | string | Optional |
Referenced models: Get booking — response body — booking data Rail-specific booking information journeys item
Get booking — response body — booking data Rail-specific booking information journeys item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A journey is composed of the legs that take a passenger from an origin to a final destination. E.g. if a traveler is going from Aberdeen to London, but they need to change trains in Edinburgh, the booking will contain 1 journey composed of 2 legs. The first leg is Aberdeen to Edinburgh, and the second is Edinburgh to London. |
legs | array | Required within parent | The legs that make up this journey. |
legs[] | Model | Each item | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item |
Referenced models: Get booking — response body — booking data Rail-specific booking information journeys item legs item
Get booking — response body — booking data Rail-specific booking information journeys item legs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A leg is a portion of the journey between two consecutive stops. |
arrival_time | JSON | Required within parent | |
arrival_time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
arrival_time (allOf 2) | JSON | All variants apply | The time when the leg ends. |
departure_time | JSON | Required within parent | |
departure_time (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp |
departure_time (allOf 2) | JSON | All variants apply | The time when the leg starts. |
destination | Model | Required within parent | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item origin |
duration | JSON | Optional | |
duration (anyOf 1) | string | Alternative | PT4h20M |
duration (anyOf 2) | null | Alternative | |
origin | Model | Required within parent | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item origin |
rail_class | JSON | Optional | |
rail_class (anyOf 1) | JSON | Alternative | |
rail_class (anyOf 1) (allOf 1) | string | All variants apply | The class of travel for a rail leg. Known values: FIRST, STANDARD, BUSINESS, SLEEPER, STANDARD_PREMIUM, BUSINESS_PREMIUM, COACH, ROOM, EXECUTIVE |
rail_class (anyOf 1) (allOf 2) | JSON | All variants apply | |
rail_class (anyOf 2) | null | Alternative | |
seat | JSON | Optional | |
seat (anyOf 1) | JSON | Alternative | |
seat (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item seat The seat that has been reserved for this leg A seat in a train leg |
seat (anyOf 1) (allOf 2) | JSON | All variants apply | The seat that has been reserved for this leg. |
seat (anyOf 2) | null | Alternative | |
vehicle | JSON | Optional | |
vehicle (anyOf 1) | JSON | Alternative | |
vehicle (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type |
vehicle (anyOf 1) (allOf 2) | JSON | All variants apply | The vehicle that will be used in this leg. |
vehicle (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp, Get booking — response body — booking data Rail-specific booking information journeys item legs item seat The seat that has been reserved for this leg A seat in a train leg, Get booking — response body — booking data Rail-specific booking information journeys item legs item origin, Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type
Get booking — response body — booking data Rail-specific booking information journeys item legs item origin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An endpoint in a rail leg. |
location | JSON | Optional | |
location (anyOf 1) | JSON | Alternative | |
location (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone |
location (anyOf 1) (allOf 2) | JSON | All variants apply | The location of the station. |
location (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the station. |
name (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | JSON | Alternative | |
type (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item origin type string string |
type (anyOf 1) (allOf 2) | JSON | All variants apply | |
type (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone, Get booking — response body — booking data Rail-specific booking information journeys item legs item origin type string string
Get booking — response body — booking data Rail-specific booking information journeys item legs item origin type string string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The kind of station. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. * `INDIVIDUAL` - A regular train station. * `GROUP` - Stations grouped together, usually in a major European city. E.g. "London, Any". * `METRO` - A metro/subway station. * `BUS_STOP` - A bus stop. * `FERRY_TERMINAL` - A ferry terminal. Known values: INDIVIDUAL, GROUP, METRO, BUS_STOP, FERRY_TERMINAL |
Get booking — response body — booking data Rail-specific booking information journeys item legs item seat The seat that has been reserved for this leg A seat in a train leg
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A seat in a train leg. |
coach_number | JSON | Optional | |
coach_number (anyOf 1) | string | Alternative | The number of the coach. |
coach_number (anyOf 2) | null | Alternative | |
seat_number | JSON | Optional | |
seat_number (anyOf 1) | string | Alternative | The number of the seat. |
seat_number (anyOf 2) | null | Alternative |
Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A vehicle used in a train leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. |
carrier | JSON | Optional | |
carrier (anyOf 1) | string | Alternative | The carrier that operates this leg. E.g. Amtrak, Thameslink. |
carrier (anyOf 2) | null | Alternative | |
timetable_id | JSON | Optional | |
timetable_id (anyOf 1) | string | Alternative | The timetable ID for the vehicle. The concept is similar to a flight number. |
timetable_id (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | JSON | Alternative | |
type (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type type string string |
type (anyOf 1) (allOf 2) | JSON | All variants apply | |
type (anyOf 2) | null | Alternative |
Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type type string string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The kind of vehicle to be used in a leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. * `TRAIN` - A regular train. * `BUS` - A bus. * `FERRY` - A ferry. * `WALK`- Walking between stations. * `TAXI` - A taxi between stations. * `TRAM` - Tram/light rail. * `METRO` - Metro/subway. * `TUBE` - London underground. Known values: TRAIN, BUS, FERRY, WALK, TAXI, TRAM, METRO, TUBE |
Get booking — response body — policy out of policy, violations out of policy, violations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The result of evaluating the customer's travel policy against this booking, as shown to the traveler when the booking was made. Mirrors the policy information available in the booking export. May be null when no policy was evaluated for the booking. |
out_of_policy | boolean | Required within parent | Whether the booking is out of policy, i.e. at least one travel policy rule was broken. |
violations | array | Optional | The specific travel policy rules that this booking violated. Empty when the booking is in policy. |
violations[] | Model | Each item | Expand Get booking — response body — policy out of policy, violations out of policy, violations violations item |
Referenced models: Get booking — response body — policy out of policy, violations out of policy, violations violations item
Get booking — response body — policy out of policy, violations out of policy, violations violations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A travel policy rule that a booking violated. |
code | Model | Required within parent | Expand Get booking — response body — policy out of policy, violations out of policy, violations violations item code |
description | string | Required within parent | A human-readable description of the policy violation. |
Referenced models: Get booking — response body — policy out of policy, violations out of policy, violations violations item code
Get booking — response body — policy out of policy, violations out of policy, violations violations item code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | A machine-readable code identifying the policy rule that was violated: * `MIN_DAYS_IN_ADVANCE` - The booking was made less than the minimum number of days in advance. * `MAX_FARE_PER_TRAVELER` - The fare exceeds the maximum allowed per traveler. * `TICKET_REFUNDABILITY` - The ticket refundability does not meet policy requirements. * `TICKET_CHANGEABILITY` - The ticket changeability does not meet policy requirements. * `AMOUNT_LIMIT_BY_FLIGHT_DURATION` - The fare exceeds the maximum allowed for the flight duration. * `ALLOWED_CABIN_CLASSES_BY_DURATION` - The cabin class is not allowed for the flight duration. * `ALLOWED_CABIN_CLASSES_BY_DURATION_DOMESTIC` - The cabin class is not allowed for the domestic flight duration. * `ALLOWED_CABIN_CLASSES_BY_DURATION_INTERNATIONAL` - The cabin class is not allowed for the international flight duration. * `MEDIAN_PRICE` - The price exceeds the median price. * `LOWEST_LOGICAL_FARE` - The price exceeds the lowest logical fare. * `MAX_STARS` - The hotel rating exceeds the maximum allowed. * `DEFAULT_NIGHTLY_RATE` - The nightly rate exceeds the maximum allowed. * `NIGHTLY_RATE_FOR_LOCATION` - The nightly rate exceeds the maximum allowed for the location. * `MAX_HOTEL_BOOKING_PRICE` - The hotel booking price exceeds the maximum allowed. * `ALLOWED_CAR_CLASSES` - The car class is not allowed. * `MAX_DAILY_RATE` - The daily rate exceeds the maximum allowed. * `OTHER` - A policy violation that is not covered by the other codes. Known values: MIN_DAYS_IN_ADVANCE, MAX_FARE_PER_TRAVELER, TICKET_REFUNDABILITY, TICKET_CHANGEABILITY, AMOUNT_LIMIT_BY_FLIGHT_DURATION, ALLOWED_CABIN_CLASSES_BY_DURATION, ALLOWED_CABIN_CLASSES_BY_DURATION_DOMESTIC, ALLOWED_CABIN_CLASSES_BY_DURATION_INTERNATIONAL, MEDIAN_PRICE, LOWEST_LOGICAL_FARE, MAX_STARS, DEFAULT_NIGHTLY_RATE, NIGHTLY_RATE_FOR_LOCATION, MAX_HOTEL_BOOKING_PRICE, ALLOWED_CAR_CLASSES, MAX_DAILY_RATE, OTHER |
Get booking — response body — status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The status of the booking: * `HOLD` - The booking is a hold, and may be canceled without being charged. * `PENDING` - Some action needs to be completed before the booking is confirmed. Usually the action is the payment being confirmed. * `CONFIRMED` - The booking is confirmed. * `COMPLETED` - The booking has already happened. * `CANCELED` - The booking has been canceled. * `IN_PROGRESS` - The booking is currently in progress. * `REFUNDED` - A refund has been issued. It may or may not be a full refund. * `VOIDED` - Voided is similar to (and can be treated the same as) canceled. * `PROCESSING` - The booking has been created or changed, but confirmation from the vendor has not been received yet. * `UNCONFIRMED` - The booking was in the `PROCESSING` state for too long and some action is probably required to get this booking confirmed. * `AIRLINE_CONTROL` - The airline has taken control of the booking and further updates may not be visible. * `PAYMENT_DECLINED` - The payment for the booking has failed. * `SCHEDULE_CHANGE` - Some change has happened to the booking schedule, e.g. the flight getting canceled and the passenger reallocated to another flight. Travel support should reach out to confirm the traveler accepts the new schedule. * `APPROVAL_REQUESTED` - The booking is subject to approval, and it is waiting for a review. * `APPROVAL_DENIED` - A reviewer has denied the booking, or the deadline to approve the booking has passed and it got canceled. * `CANCELLATION_IN_PROGRESS` - The booking is currently being canceled. Known values: HOLD, PENDING, CONFIRMED, COMPLETED, CANCELED, IN_PROGRESS, REFUNDED, VOIDED, PROCESSING, UNCONFIRMED, AIRLINE_CONTROL, PAYMENT_DECLINED, SCHEDULE_CHANGE, APPROVAL_REQUESTED, APPROVAL_DENIED, CANCELLATION_IN_PROGRESS |
Get trip — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A trip representation. |
billable_at | JSON | Optional | |
billable_at (anyOf 1) | string | Alternative | The time when the trip became billable. If absent, the trip is currently not billable. Format: date-time |
billable_at (anyOf 2) | null | Alternative | |
booker_user_id | string | Required within parent | The ID of the user who booked the trip. If the trip was created on copilot mode, this will be the ID of the user on behalf of whom the trip was booked. |
created_at | string | Required within parent | The time when the trip was created. Format: date-time |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | Custom field values associated with this resource. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Get trip — response body — custom fields Custom field values associated with this resource item |
custom_fields (anyOf 2) | null | Alternative | |
ends_at | JSON | Optional | |
ends_at (anyOf 1) | string | Alternative | The time when the last booking in the trip ends. Format: date-time |
ends_at (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the trip. |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the trip as seen in the dashboard. Maximum length: 100 |
name (anyOf 2) | null | Alternative | |
starts_at | JSON | Optional | |
starts_at (anyOf 1) | string | Alternative | The time when the first booking in the trip starts. Format: date-time |
starts_at (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The current status of a trip. Known values: PENDING, UPCOMING, IN_PROGRESS, COMPLETED, CANCELED, REFUNDED, VOIDED, DRAFT, DELETED, PROCESSING, UNCONFIRMED, AIRLINE_CONTROL, PAYMENT_DECLINED, SCHEDULE_CHANGE, HOLD, APPROVAL_REQUESTED, APPROVAL_DENIED, CANCELLATION_IN_PROGRESS |
status (allOf 2) | JSON | All variants apply | The current status of the trip. |
traveler | JSON | Optional | |
traveler (anyOf 1) | JSON | Alternative | |
traveler (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST |
traveler (anyOf 1) (allOf 2) | JSON | All variants apply | Information on the person who will be traveling. |
traveler (anyOf 2) | null | Alternative | |
trip_reference | JSON | Optional | |
trip_reference (anyOf 1) | string | Alternative | The trip reference number shown in the dashboard and used when contacting Brex Support. This is the reference from the travel provider, not the Brex internal trip ID. May be null if the trip has no associated reference. |
trip_reference (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The time when the latest trip update happened. Format: date-time |
version | JSON | Required within parent | |
version (anyOf 1) | integer | Alternative | The current version of the trip. Format: int32 Minimum: 1 |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item, Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST
Get trip — response body — custom fields Custom field values associated with this resource item
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean value, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp value
Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Base class for custom field values |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
value_type | JSON | Required within parent | |
value_type (allOf 1) | string | All variants apply | The type of the custom field value. Known values: SINGLE_VALUE, LIST |
value_type (allOf 2) | JSON | All variants apply | The type of the custom field value. |
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Boolean list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | boolean | Each item | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Boolean value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | boolean | Alternative | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. Format: date |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Multiple value wrapper for custom fields |
value_type | JSON | Required within parent | |
value_type (allOf 1) | string | All variants apply | The type of the custom field value. Known values: SINGLE_VALUE, LIST |
value_type (allOf 2) | JSON | All variants apply | The type of the custom field value. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. Format: date |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Single value wrapper for custom fields |
value_type | JSON | Required within parent | |
value_type (allOf 1) | string | All variants apply | The type of the custom field value. Known values: SINGLE_VALUE, LIST |
value_type (allOf 2) | JSON | All variants apply | The type of the custom field value. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Decimal list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | JSON | Each item | |
data (anyOf 1)[] (anyOf 1) | number | Alternative | The data of the custom field. |
data (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Decimal value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | JSON | Alternative | |
data (anyOf 1) (anyOf 1) | number | Alternative | The data of the custom field. |
data (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enum list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. Format: enum |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enum value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. Format: enum |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | Model | Each item | Expand Get transfer — response body — amount |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get transfer — response body — amount, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | JSON | Alternative | |
data (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
data (anyOf 1) (allOf 2) | JSON | All variants apply | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get transfer — response body — amount, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Option string list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | Model | Each item | Expand Get user — response body — custom fields array item value The value of the custom field Option string list value data array item |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value The value of the custom field Option string list value data array item, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Option string value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | JSON | Alternative | |
data (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Option string list value data array item |
data (anyOf 1) (allOf 2) | JSON | All variants apply | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value The value of the custom field Option string list value data array item, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | String list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | String value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timestamp list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. Format: date-time |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timestamp value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. Format: date-time |
data (anyOf 2) | null | Alternative | |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
$ (allOf 1) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values |
Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information on the person who will be traveling. |
guest_email | JSON | Optional | |
guest_email (anyOf 1) | string | Alternative | If the traveler is a guest, this is their email. |
guest_email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | JSON | Alternative | |
name (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST name The name of the traveler The name of the traveler |
name (anyOf 1) (allOf 2) | JSON | All variants apply | |
name (anyOf 2) | null | Alternative | |
type | string | Required within parent | Whether the trip is for an employee or a guest. Known values: EMPLOYEE, GUEST |
user_id | JSON | Optional | |
user_id (anyOf 1) | string | Alternative | If the traveler is an employee, this is their user ID. |
user_id (anyOf 2) | null | Alternative |
Referenced models: Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST name The name of the traveler The name of the traveler
Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST name The name of the traveler The name of the traveler
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The name of the traveler. |
first_name | string | Optional | The traveler's first name. |
last_name | string | Optional | The traveler's last name. |
middle_name | JSON | Optional | |
middle_name (anyOf 1) | string | Alternative | The traveler's middle name. |
middle_name (anyOf 2) | null | Alternative | |
suffix | JSON | Optional | |
suffix (anyOf 1) | string | Alternative | The suffix in the traveler's name. |
suffix (anyOf 2) | null | Alternative |
List trip bookings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get booking — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get booking — response body
List trips — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get trip — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get trip — response body