All details on this document are copyrighted and are protected by Egencia copyright laws. Any unauthorized use of any\n part of this document may violate copyright laws and may lead to legal actions. By accepting the terms and\n conditions, you acknowledge and agree that Egencia have the right, in its sole discretion, to modify these terms.\n Egencia will notify you about material changes to this Agreement by sending a notice to the email address, fax\n number, or other address that you provided to us or by placing a prominent notice on the APIs and SPIs. Customers\n will be responsible for reviewing and becoming familiar with any such modifications.\n Egencia will notify Consumer and Shared Client of the availability of new major versions and provide the timeframe\n for the Consumer to upgrade.
\nEgencia will release new version of the software with backward compatibility only when there is significant\n change(s). These changes can be structural, and can contain enhancements, major bug fixes, or change of behavior,\n new fields added, or fields removed.
\nThis document provides a reference for both query and response for the BI Transactions API version 1.0. This document\n includes a series of notes and instructions that outline the BI Transactions API version 1. The API provides users\n with a simple, standardised, resource-oriented, RESTful interface with JSON-formatted responses that make it easy to\n fetch, filter and retrieve Transaction data. To have a secure data transfer and streamlined integration, we use the\n HTTPs protocol for API calls.
\nTo help you find what you're looking for, this documentation is divided into three sections: API, Authentication and\n Resources.
\nThis document is aimed for BI Transactions API customers, partners and software developers who would like to consume\n the BI Transactions API.
\n\nBI Transactions API offers an interface for customers and partners to retrieve consolidated booking transaction data\n from Egencia. The BI Transactions API is organised around REST /JSON over HTTPS for transaction data retrieval. This\n API accepts JSON requests and returns JSON responses, and uses standard HTTPs response codes, authentication, and\n verbs. The following offerings are available:
\n| \n Transaction Type \n | \n \n Description \n | \n \n \n
|---|---|
| All Line of business transactions (summary) | \nOffers booking transaction data for all line of businesses which gives a consolidated summary view. | \n
| Air transactions | \nOffers booking transaction data for specifically Air transactions. | \n
| Air transactions including segment information | \nOffers booking transaction data for specifically Air including segment level information. | \n
| Air transactions including ticketing information | \nOffers booking transaction data for specifically Air including ticketing level information. | \n
| Hotel transactions | \nOffers booking transaction data for specifically Hotel transactions. | \n
| Train transactions | \nOffers booking transaction data for specifically Train transactions. | \n
| Train transactions including segment information | \nOffers booking transaction data for specifically Train transactions including segment level information.\n | \n
| Train transactions including leg information | \nOffers booking transaction data for specifically Train transactions including leg level information.\n | \n
| Car transactions | \nOffers booking transaction data for specifically Car transactions. | \n
| Fee transactions | \nOffers booking transaction data for specifically Fee transactions. | \n
Egencia will notify the Client about the availability of new major versions and provide the timeframe for the\n upgrades. Major version is a new version of the software with a significant change(s). Minor version is a new\n version of the software with possible backward compatibility and with a minor degree of change. The changes can be\n structural, and can contain enhancements, major bug fixes, or change of behavior, endpoint changes, new fields\n added, or fields removed. The version change log will list all the changes included in the corresponding version\n from the previous one.
\n\nYou can also see a full API version change log under this heading.
\n| Change log | \n||
| API | \nCurrent Version | \nWhat has changed? | \n
| Reporting | \nVersion 1 | \nFirst stable version. | \n
Public BI Transactions API is a generic and secure solution to allow clients to access their previous booking\n transaction data dynamically for different dates and other user query filters such as ob, locale, currency code or\n report level.
\n| \n Endpoint \n | \n \n /v1/transactions | \n
|---|---|
| \n Endpoint \n | \n \n /v1/transactions | \n
| Method | \nPOST | \n
| application/json | \n|
| Accept | \napplication/hal+json | \n
The Endpoint URL for communicating with the Transaction API system is:
\nPlease note the use of the https protocol. This ensures that all data that travels between the server and your\n program are encrypted. This protects your credentials and the transmitted data.
\n\nBefore you can access the BI Transactions API, you need to authenticate and authorise who you are. Our API uses the\n OAuth 2.0 standard for authentication.
\n\n Note: All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without\n authentication will also fail.\n
\nBefore calling Transaction data API the client should be successfully authorized with Egencia's Authentication\n service. The access token generated within authorization step should be provided in the further call(s) to the API.\n
\nEgencia transaction data API supports access token based on OAuth2.0 protocol. A client ID and Client Secret ID will\n be generated and shared to the client.
\n\nThe Client ID and Client Secret are like a username and password that authenticate your application. They aren't used\n directly in making most API requests, instead, they are exchanged for tokens, which are used to make the actual\n requests.
\nAll requests to the OAuth 2.0 endpoint must be given your credentials in the form of Basic authentication. To comply\n with the HTTP requirements, your Client ID\n and Secret should be encoded in base 64.\n
\nMake sure to keep the client secret secure - anyone who has it can impersonate your application!
\n| \n Endpoint \n | \n \n Headers \n | \n \n HTTP method \n | \n
|---|---|---|
| \n Endpoint \n | \n \n Headers \n | \n \n HTTP method \n | \n
| /auth/v1/tokens | \nAuthorization: Basic\n base64encode(client_id:client_secret) Content-Type: application/x-www-form-urlencoded\n | \n Post | \n
\n Post the client_id and client_secret to the URL\n {{authUrl}} to\n obtain an access token which you can then use to call BI Transactions APIs. \n
\n\nRequest
\nResponse (status code = 200)
\nThe access token generated within Authorization call kept alive within expiration time provided in the successful\n authorization response, no need to generate new access token each time the Client calls BI Reporting API until\n it expires. Expiration time provided in seconds.
\nNOTE:
\nThe Egencia BI Transactions API is the new solution that is being offered to clients for accessing their booking data\n in a programmatic method. With the help of the Egencia BI Transactions API you can
\nDoing a POST of BI API will return the metadata (hyperlinks) of the resource from where all the qualified\n transactions will be fetched in a paginated manner. You can page through the resource by making a GET request to the\n \"next\" URL provided in the paginated response. If there are no more pages, \"next\" will be set null. The users can\n page through any valid page number at any time using the Get request.
\n\nThis API call allows the client to submit a request for retrieving transactions for a specified search criterion.
\n| Method | \nEndpoints | \nDescription | \n
|---|---|---|
| Post | \n/v1/transactions | \nCreates paginated transaction queries and metadata based on search criteria for all LOBs. | \n
| Post | \n/v1/transactions/air | \nCreates paginated transaction queries and metadata based on search criteria for air LOBs. | \n
| Post | \n/v1/transactions/car | \nCreates paginated transaction queries and metadata based on search criteria for car LOBs. | \n
| Post | \n/v1/transactions/train | \nCreates paginated transaction queries and metadata based on search criteria for train LOBs. | \n
| Post | \n/v1/transactions/hotel | \nCreates paginated transaction queries and metadata based on search criteria for hotel LOBs. | \n
| Post | \n/v1/transactions/fees | \nCreates paginated transaction queries and metadata based on search criteria for fee LOBs. | \n
| Post | \n/v1/transactions/ground | \nCreates paginated transaction queries and metadata based on search criteria for ground LOBs. | \n
| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the booking\n transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\"2020-05-05 09:00:00\")\n These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nValue: [“cdf”]. To include custom data fields in the response. Custom data fields will now come in\n response only when requested by users in the include option. Values: [“cdf”].\n Includes [“co2”]only for LOB Air. To include co2 emission details in the response for air (ticket, leg\n and segment). Co2 emission values will now come in the air response only when requested by users in the\n include option. Values: [“co2”]\n | \n
| report_level | \nOptional | \nString | \nReport level for the LOB's air and train to retrieve data for a specific report level.\n \"ticket, segment, leg\" are the three different requests configured by report_level field.\n If this data is not provided Ticket Level data will be returned by default.\n | \n
| date_type | \nOptional | \nString | \nThe date type to search the records. You can search for records based on travel date as well as issue\n date. \"Issue date\" and \"travel date\" will provide data based on issue date and travel date respectively.\n If no value is passed as datetype, issue date will be considered by default.\n Note : Issue date cannot be future date. However, travel date can be a future date or past date.\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList<String> | \nWith this parameter, it becomes possible for a client or a partner to specify the\n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
| reconciled_records_only | \nOptional | \nString | \nA string to select only the reconciled records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you recieve only the records undergoing\n reconciliation process.\n | \n
| \n \n \n | \n
|---|
\n {\n \"start_date\": \"2019-01-01 09:00:00\",\n \"end_date\": \"2020-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"includes\":[\"cdf\"],\n \"report_level\":\"leg\"\n \"date_type: \"issue_date\",\n \"active_records_only\":\"true\",\n \"client_ids\":[\"10098\",\"13882\",\"19120\"],\n \"reconciled_records_only\":\"true\"\n }\n \n | \n
| \n Attribute\n | \n\n Type\n | \n\n Description\n | \n
|---|---|---|
| metadata | ||
| page_limit | \nInteger | \nThe maximum number of records allowed in a single page. | \n
| total_records | \nInteger | \nTotal number of records in the response. | \n
| total_pages | \nInteger | \nTotal Pages in the response. | \n
| report_id | \nString | \nUnique identifier for the Report. Example: \"ec49a1c4-4a49-4916-b60e-81c1bcf8b07b\"\n | \n
| latest_reconciled_date | \nString | \nThe latest reconciled date of the records in the response.\"\n | \n
| Code | \nDescription | \n
|---|---|
| 200 | \nOk | \n
\n {\n \"metadata\": {\n \"page_limit\": 100,\n \"total_records\": 8592,\n \"total_pages\": 86,\n \"latest_reconciled_date\": \"2020-04-19 00:00:00\"\n },\n \"_links\": {\n \"next\": {\n \"href\": \"{{transactionUrl}}/c1eb18d8-35e0-464f-b94e-0d371c1cb41b?page=1\"\n },\n \"last\": {\n \"href\": \"{{transactionUrl}}/c1eb18d8-35e0-464f-b94e-0d371c1cb41b?page=84\"\n }\n },\n \"report_id\": \"c1eb18d8-35e0-464f-b94e-0d371c1cb41b\"\n }\n \n | \n
| Method | \nEndpoint | \nDescription | \n
|---|---|---|
| GET | \n/v1/transactions/{id}?page={page_number} | \nCreates detailed transaction reports based on search criteria | \n
| Attribute | \nType | \nDescription | \n
|---|---|---|
| report_id | \nString | \nReport ID used to fetch transaction records based on the search criteria and metadata | \n
| page_number | \nString | \nPage number the user wants to access | \n
| Attribute | \nType | \nDescription | \n
|---|---|---|
| Transactions: Transaction response based on different user filters | \n||
| advance_purchase_days | \nString | \nAdvance purchase days. | \n
| booking_method | \nString | \nOnline or Agent-assisted. Online indicates a booking made through\n the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted\n indicates bookings made offline with the assistance of an Egencia travel consultant. | \n
| cabin_class | \nString | \nCabin class associated with the booking. | \n
| class_of_service | \nString | \nMarket share trend by class of service. | \n
| company_name | \nString | \nThe name of the company travel was booked through. | \n
| custom_data_field | \nString | \nCustom Data Fields. These are the fields that are configurable for the Customer.\n This information can be in billing data, receipt and invoices. Example: Employee ID: 123, Department\n Cost Center: 123\n | \n
| carbon_emissions | \nString | \nCarbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of\n Energy and Climate Change (DECC) and the Department for Environment,Food and Rural Affairs (Defra)).\n Formula : Mileage * Air conversion factors\n | \n
| department | \nString | \nThe department selected by the traveler at the time of booking. | \n
| Duration: Duration of booking | \n||
| days | \nString | \nCount of days that person was traveling. Starting from travel start\n date to travel end date\n | \n
| end | \nString | \nThe date that travel is complete for the particular travel booking (e.g. return or arrival\n date for an air ticket).\n | \n
| start | \nString | \nThe date that travel commences for the particular travel booking (e.g.\n departure date for an air ticket).\n | \n
| geography_type | \nString | \nGeography type, domestic, international, etc. | \n
| Identifier: Unique transaction identification details | \n||
| confirmation_number | \nString | \nThis is the confirmation number for a booking transaction. | \n
| invoice_number | \nString | \nThis is the unique Invoice number for a\n booking transaction.\n | \n
| itinerary_number | \nString | \nThe Egencia itinerary number associated with the travel transaction\n being reported on.\n | \n
| pnr | \nString | \nThe booking reference code provided by the vendor. Also known as a PNR\n (passenger name record) code. This is typically a 6 character reference code\n | \n
| record_locator | \nString | \nRecord locator is a unique identifier for a record. | \n
| ticket_number | \nString | \nThis is a unique number for a ticket booking. | \n
| invoice_date | \nString | \nThe date the booking was invoiced. Invoice date is only applicable for\n European points of sale.\n | \n
| is_agent_assisted | \nString | \nIdentifier to state if it was a agent assisted. Possible values: True /\n False\n | \n
| is_special_request | \nString | \nIdentifier to state if it was a special request. Possible values: True\n / False\n | \n
| line_of_business | \nString | \nLine of business for the transaction , e.g. Air, Hotel, Car | \n
| location | \nString | \nFor hotels, this field shows the city, state/province and country where\n the hotel is located. For air and train, this field shows the routing information and for car, this\n field shows the pick-up location\n | \n
| meeting_name | \nString | \nThe meeting name associated with the transaction. Meeting will be empty\n for European points of sale and for travel that is not associated with a meeting.\n | \n
| point_of_sale | \nString | \nPoint of sale. | \n
| policy: Policy details | \n||
| is_in_policy | \nString | \nIndicates whether the transaction was booked within policy or out of\n policy.\n | \n
| policy_reason_code | \nString | \nThe two character reason code selected by the traveler to explain why\n they made an out of policy booking. e.g. AQ, AR, AN\n | \n
| policy_reason_description | \nString | \nPolicy reason description in case of out of policy booking. | \n
| price: Price information | \n||
| average_leg_price | \nString | \nAverage leg price | \n
| average_segment_price | \nString | \nAverage segment price | \n
| base | \nString | \nBase amount | \n
| change_fee_amount | \nString | \nFee/penalty charged on any changes made | \n
| coupon_amount | \nString | \nCoupon amount | \n
| extra_person_amount | \nString | \nAmount charged per extra person accommodation | \n
| fare_bases | \nString | \nFare bases | \n
| fee | \nString | \nTotal Amount charged by Egencia for Fare Savings Finder Optimization.\n | \n
| rate_type | \nString | \nThe type of inventory purchased or reserved by the traveler (Published\n Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.).\n | \n
| segment_count | \nString | \nSegment count. | \n
| ticket_code | \nString | \nThe number of the ticket associated with the air transaction. | \n
| transaction_date | \nString | \nThe date the transaction occurred on an itinerary (e.g. the date of the\n air ticket purchase, car reservation or hotel cancellation).\n | \n
| Traveler: Traveler details\n | \n||
| name | \nString | \nName of the person for whom the booking transaction was made. | \n
| group | \nString | \nThe traveler group associated with the traveler (person for which the travel is\n booked.)\n | \n
| String | \nemail of the person for whom the booking transaction was made. | \n|
| meeting_attendee_group | \nString | \nThe current traveler group associated with the traveler for a specific meeting.\n Meeting attendee group will be empty for European points of sale and for travel that is not associated\n with a meeting. | \n
| is_guest | \nString | \nIdentifier to state if booking was done by the guest traveler. | \n
| vendor_name | \nString | \nThe company providing the travel service. | \n
| Method | \nGET | \n
| Content-type | \napplication/json | \n
| Accept | \napplication/hal+json | \n
| Attribute | \nRequired/Optional | \nType | \nDescription | \n
|---|---|---|---|
| report_id | \nRequired | \nString | \nReport ID used to fetch search criteria and metadata | \n
| page_number | \nOptional | \nString | \nPage number the user wants to access. If this value is not present it will use the default value '1' | \n
| Code | \nDescription/Optional | \n
|---|---|
| 200 | \nOk Success: The request is received and is being processed. | \n
| 201 | \nOk Created: The request has been fulfilled and has resulted in one or more new resources being created. | \n
| 204 | \nOk No Content: The request was received and understood, but that there is no need to send any data back. | \n
| Code | \nDescription/Optional | \n
|---|---|
| 400 | \nBad Request: Invalid input or request | \n
| 401 | \nUnauthorized: authentication token empty, invalid or expired | \n
| 403 | \nForbidden: User not Validated for operation | \n
| 404 | \nNot Found | \n
| 422 | \nInvalid input: invalid or missing required input | \n
| 500 | \nInternal Server Error: unable to process request | \n
This section will be updated soon.
\n\nIATA Code API offers an interface for customers and partners to retrieve IATA codes for the specified Point of Sale or\n all Point of Sales in case none specified from Egencia. This API is organised around REST /JSON over HTTPS for\n data retrieval. The API returns JSON responses and uses standard HTTPs response codes, authentication, and verbs.
\n\n\n Note: Please refer to the\n Versioning section\n of the BI Transaction API for further information regarding versioning\n \n
\n\nThis public API solution allows clients to access the IATA codes based on the Point of Sales for different transactions\n obtained from the Transaction API response.
\n| \n Endpoint \n | \n \n /v1/egencia_iata | \n
|---|---|
| Method | \nGET | \n
| application/json | \n|
| Accept | \napplication/json | \n
The Endpoint URL for communicating with the IATA Code API system is:
\nPlease note the use of the https protocol. This ensures that all data that travels between the server and your\n program are encrypted. This protects your credentials and the transmitted data.
\n\nAuthentication for the IATA Code API is same as that of the Transactions API where the API supports access token based\n on OAuth2.0 protocol. You can use the same client ID and Client Secret ID as BI API for calling IATA Code API
\n\n Note: Please refer to the\n Authentication section\n of the BI Transaction API for further information\n \n
\n\n| Method | \nEndpoint | \nDescription | \n
|---|---|---|
| GET | \n/v1/egencia_iata?pos={point_of_sale} | \nGets IATA code based on the POS | \n
| Attribute | \nRequired/Optional | \nType | \nDescription | \n
|---|---|---|---|
| pos | \nOptional | \nString | \nPoint of Sale for which the user wants to get the IATA code. If absent, gets all the available IATA\n Codes\n | \n
| Attribute | \nType | \nDescription | \n
|---|---|---|
| pos | \nString | \nPoint of Sale | \n
| iata | \nString | \nIATA code for the specified Point of sale | \n
\n Note: Please refer to the\n HTTP Success Response Codes section \n of the BI Transaction API for further information\n \n
\n\n\n Note: Please refer to the\n HTTP Error Codes section\n of the BI Transaction API for further information\n \n
\n\nTo get help with the Egencia BI API, please contact our Support Team.
","title":"BI API","version":"v1.0"},"servers":[{"url":"https://apis.egencia.com/bi/api","description":"Generated server url"}],"tags":[{"description":"Transaction data operations","name":"transaction-service-controller"}],"paths":{"/v1/egencia_iata":{"get":{"description":"Allows clients to access the IATA codes based on the Point of Sales for different transactions\n obtained from the Transaction API response.
\n\nRequest Specifications:
\n| Attribute | \nRequired | \nType | \nDescription | \n
|---|---|---|---|
| \n pos\n | \nOptional | \nString | \nPoint of Sale for which the user wants to get the IATA code. | \n
Fetching IATA codes for specified Point of Sale
\n\n\n\n GET https://apis.egencia.com/bi/api/v1/egencia_iata?pos=France\n -> 200 OK\n [\n {\n \"pos\":\"France\",\n \"iata\":\"1234567\"\n }\n ]\n\n\n\nFetching IATA codes for all available Point of Sales
\n\n\n GET https://apis.egencia.com/bi/api/v1/egencia_iata\n -> 200 OK\n [\n {\n \"pos\":\"France\",\n \"iata\":\"1234567\"\n },\n {\n \"pos\":\"India\",\n \"iata\":\"563489\"\n },\n {\n \"pos\":\"United States of America\",\n \"iata\":\"824485\"\n },\n {\n \"pos\":\"United Kingdom\",\n \"iata\":\"4593557\"\n },\n {\n \"pos\":\"Australia\",\n \"iata\":\"45983645\"\n }\n {\n \"pos\":\"Denmark\",\n \"iata\":\"9876543\"\n },\n {\n \"pos\":\"Norway\",\n \"iata\":\"609843\"\n }\n ]\n\n\n\nThis API will return the Point of Sales and their corresponding IATA Codes
","operationId":"getIATACode","parameters":[{"description":"Point of Sale code to look up. Returns all Point of Sales if not specified","example":"US","in":"query","name":"pos","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IATA Code response"}}}},"description":"OK : IATA code(s) returned successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IATA Code response"}}}},"description":"Bad Request : invalid query parameter"},"401":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IATA Code response"}}}},"description":"Unauthorized : authentication token empty, invalid or expired"},"403":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IATA Code response"}}}},"description":"Forbidden : user does not have the permission to access data"},"500":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IATA Code response"}}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Gets IATA code for the specified Point of Sale or all Point of Sales if none specified","tags":["pos-iata-controller"]}},"/v1/transactions":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (All LOB summary).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields in the response. Custom data fields will now come in response only when\n requested by users in the include option. Values: [\"cdf\"]\n | \n
| report_level | \nOptional | \nString | \nReport level for the LOB's air and train to retrieve data for a specific report level. \"ticket, segment, leg\" are the three different requests configured by report_level field. If this data is not provided Ticket Level data will be returned by default\n | \n
| date_type | \nOptional | \nString | \nThe date type to search the records. You can search for records based on travel date as well as issue\n date. \"Issue date\" and \"travel date\" will provide data based on issue date and travel date respectively.\n If no value is passed as datetype, issue date will be considered by default. Accepted Values are: issue_date,travel_date\n Note : Issue date cannot be future date. However, travel date can be a future date or past date.\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
| reconciled_records_only | \nOptional | \nString | \nA string to select only the reconciled records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you recieve only the records\n undergoing reconciliation process.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"date_type\": \"issue_date\",\n \"active_records_only\":\"true\",\n \"client_ids\":[\"10098\",\"13882\",\"19120\"],\n \"reconciled_records_only\":\"true\"\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2,\n \"latest_reconciled_date\": \"2018-04-29 00:00:00\"\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be fetched in a paginated manner.
","operationId":"queryTransactions","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for all LOBs summary data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/air":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (Air\n LOB).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields and/or co2 in the response. These will now come in response only when\n requested by users in the include option. Values: [\"cdf\",\"co2\"]\n | \n
| report_level | \nOptional | \nString | \nReport level for the LOB's air and train to retrieve data for a specific report level. \"ticket, segment, leg\" are the three different requests configured by report_level field. If this data is not provided Ticket Level data will be returned by default\n | \n
| date_type | \nOptional | \nString | \nThe date type to search the records. You can search for records based on travel date as well as issue\n date. \"Issue date\" and \"travel date\" will provide data based on issue date and travel date respectively.\n If no value is passed as datetype, issue date will be considered by default. Accepted Values are: issue_date,travel_date\n Note : Issue date cannot be future date. However, travel date can be a future date or past date.\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
| reconciled_records_only | \nOptional | \nString | \nA string to select only the reconciled records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you recieve only the records\n undergoing reconciliation process.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions/air\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"report_level\": \"segment\",\n \"date_type\": \"issue_date\",\n \"includes\": [\"cdf\",\"co2\"],\n \"active_records_only\":\"true\",\n \"client_ids\":[\"10098\",\"13882\",\"19120\"],\n \"reconciled_records_only\":\"true\"\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2,\n \"latest_reconciled_date\": \"2018-04-29 00:00:00\"\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be\n fetched in a paginated manner.
","operationId":"queryTransactionsForAir","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for Air LOB data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/car":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (Car LOB).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields in the response. Custom data fields will now come in response only when\n requested by users in the include option. Values: [\"cdf\"]\n | \n
| report_level | \nOptional | \nString | \nReport level for the LOB's air and train to retrieve data for a specific report level. \"ticket, segment, leg\" are the three different requests configured by report_level field. If this data is not provided Ticket Level data will be returned by default\n | \n
| date_type | \nOptional | \nString | \nThe date type to search the records. You can search for records based on travel date as well as issue\n date. \"Issue date\" and \"travel date\" will provide data based on issue date and travel date respectively.\n If no value is passed as datetype, issue date will be considered by default. Accepted Values are: issue_date,travel_date\n Note : Issue date cannot be future date. However, travel date can be a future date or past date.\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions/car\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"date_type\": \"issue_date\",\n \"active_records_only\":\"true\"\n \"client_ids\":[\"10098\",\"13882\",\"19120\"]\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be fetched in a paginated manner.
","operationId":"queryTransactionsForCar","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for Car LOB data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/fees":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (Fee LOB).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields in the response. Custom data fields will now come in response only when\n requested by users in the include option. Values: [\"cdf\"]\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions/fees\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"active_records_only\":\"true\"\n \"client_ids\":[\"10098\",\"13882\",\"19120\"]\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be fetched in a paginated manner.
","operationId":"queryTransactionsForFees","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for Fees LOB data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/ground":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (Ground LOB).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n | \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields in the response. Custom data fields will now come in response only when\n requested by users in the include option. Values: [\"cdf\"]\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions/ground\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"active_records_only\":\"true\"\n \"client_ids\":[\"10098\",\"13882\",\"19120\"]\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be fetched in a paginated manner.
","operationId":"queryTransactionsForGround","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for Ground LOB data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/hotel":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (Hotel LOB).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields in the response. Custom data fields will now come in response only when\n requested by users in the include option. Values: [\"cdf\"]\n | \n
| report_level | \nOptional | \nString | \nReport level for the LOB's air and train to retrieve data for a specific report level. \"ticket, segment, leg\" are the three different requests configured by report_level field. If this data is not provided Ticket Level data will be returned by default\n | \n
| date_type | \nOptional | \nString | \nThe date type to search the records. You can search for records based on travel date as well as issue\n date. \"Issue date\" and \"travel date\" will provide data based on issue date and travel date respectively.\n If no value is passed as datetype, issue date will be considered by default. Accepted Values are: issue_date,travel_date\n Note : Issue date cannot be future date. However, travel date can be a future date or past date.\n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions/hotel\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"date_type\": \"issue_date\",\n \"active_records_only\":\"true\"\n \"client_ids\":[\"10098\",\"13882\",\"19120\"]\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be fetched in a paginated manner.
","operationId":"queryTransactionsForHotel","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for Hotel LOB data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/train":{"post":{"description":"This API call allows the client to submit a request for retrieving transactions for a specified search criteria (Train LOB).
\nRequest Specifications:
\n| \n Attribute \n | \n \n Required/optional \n | \n \n Type \n | \n \n Description \n | \n
|---|---|---|---|
| start_date, end_date | \nRequired | \nString | \nSpecific date range for which the transaction data is requested.The date range to fetch the\n booking transactions data. Timestamp in format: YYYY-MM-DD HH:MM:SS. (Example:\n 2020-05-05 09:00:00) These should come as a pair.Note: Future date is only allowed if the date_type is set as travel_date.\n
| \n
| locale | \nOptional | \nString | \nLocale represents the supported language to get the report. Accepted values are: nb-NO, de-DE, en-US,\n en-CA, es-ES, fr-CA, it-IT, nl-NL, sv-SE, en-AU, da-DK, fr-FR, en-GB (Defult locale is en-US)\n Note: This value is case sensitive.\n | \n
| currency_code | \nOptional | \nString | \n3 character currency code to get the amount in given currency. Accepted Values are: CHF, ARS, MXN, CLP,\n ZAR, INR, VND, CNY, THB, AUD, ILS, JPY, PLN, GBP, IDR, PHP, TRY, RUB, AED, HKD, EUR, COP, DKK, CAD, MYR,\n USD, NOK, SGD, CZK, SEK, NZD, BRL, UAH\n | \n
| includes | \nOptional | \nString | \nTo include custom data fields in the response. Custom data fields will now come in response only when\n requested by users in the include option. Values: [\"cdf\"]\n | \n
| report_level | \nOptional | \nString | \nReport level for the LOB's air and train to retrieve data for a specific report level. \"ticket, segment, leg\" are the three different requests configured by report_level field. If this data is not provided Ticket Level data will be returned by default\n | \n
| date_type | \nOptional | \nString | \nThe date type to search the records. You can search for records based on travel date as well as issue\n date. \"Issue date\" and \"travel date\" will provide data based on issue date and travel date respectively.\n If no value is passed as datetype, issue date will be considered by default. Accepted Values are: issue_date,travel_date\n Note : Issue date cannot be future date. However, travel date can be a future date or past date. \n | \n
| active_records_only | \nOptional | \nString | \nA string to select only the records with active ticket status or all records, present for a given start\n and end date. The possible values for the string are \"true\" or \"false\". By default, it is set as\n false which would show all the records for a time period. By passing true, you can exclude\n bookings and items that have been cancelled, exchanged, voided, or refunded.\n | \n
| client_ids | \nOptional | \nList | \n With this parameter, it becomes possible for a client or a partner to specify the \n companies for which they want the reporting data. It accepts a list of the client ids given in string format.\n If no value is given, by default data will be returned for all associated companies for the client.\n Note: Passing incorrect company Id values or non numeric values would return an error.\n | \n
\n\n POST https://apis.egencia.com/bi/api/v1/transactions/train\n {\n \"start_date\": \"2018-01-01 09:00:00\",\n \"end_date\": \"2018-05-05 09:00:00\",\n \"locale\": \"en-US\",\n \"currency_code\": \"USD\",\n \"report_level\": \"leg\",\n \"date_type\": \"issue_date\",\n \"includes\": [\"cdf\"],\n \"active_records_only\":\"true\",\n \"client_ids\":[\"10098\",\"13882\",\"19120\"]\n }\n -> 201 CREATED\n {\n \"metadata\": {\n \"page_limit\": 5000,\n \"total_records\": 10000,\n \"total_pages\": 2\n },\n \"_links\": {\n \"first\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=1\"\n },\n \"last\": {\n \"href\": \"https://apis.egencia.com/bi/api/v1/transactions/3004fa51-104e-4712-b34d-bf7635eb2958?page=2\"\n }\n },\n \"report_id\": \"3004fa51-104e-4712-b34d-bf7635eb2958\"\n }\n\n\n\nThis API will return the metadata (hyperlinks) of the resource from where all the qualified transactions will be fetched in a paginated manner.
","operationId":"queryTransactionsForTrain","parameters":[{"description":"Set to true to include SGP data in the response","in":"header","name":"SGP-Request","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction data filters to create a new report"}}},"required":true},"responses":{"201":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Created."},"204":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"No Content."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Create paginated transaction queries for Train LOB data based on search criteria","tags":["transaction-service-controller"]}},"/v1/transactions/{reportId}":{"get":{"description":"Allows to retrieve multiple transactions for a specified search criteria in a paginated manner.
\nList of the response attributes will vary based on the submitted query like lob, report level, etc.
\n\nRequest Specifications:
\n| Attribute | \nRequired | \nType | \nDescription | \n
|---|---|---|---|
| \n report_id\n | \nRequired | \nString | \nReport ID used to fetch transaction records based on the search criteria and metadata | \n
| \n page_number\n | \nRequired | \nString | \nPage number the user wants to access | \n
This API will return all the qualified transactions inn a paginated manner by providing the data for current page and metadata (hyperlinks) of the previous and next pages.
","operationId":"getTransactions","parameters":[{"description":"Unique report identifier returned from the POST /transactions response","in":"path","name":"reportId","required":true,"schema":{"type":"string"}},{"description":"Page number to retrieve","example":1,"in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/hal+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Transaction response"},{"$ref":"#/components/schemas/Air transaction response"},{"$ref":"#/components/schemas/Train transaction response"},{"$ref":"#/components/schemas/Hotel transaction response"},{"$ref":"#/components/schemas/Fee transaction response"},{"$ref":"#/components/schemas/Car transaction response"},{"$ref":"#/components/schemas/Ground transaction response"}]}}},"description":"Found."},"400":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Bad Request : Invalid input or request"},"401":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Unauthorized : authentication token empty, invalid or expired."},"403":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Forbidden : User not Validated for operation."},"422":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Invalid input : invalid or missing required input."},"500":{"content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelTransaction Data Response"}}},"description":"Internal Server Error : unable to process request"}},"security":[{"OAuth2":[]}],"summary":"Generates transaction data page response based on client provided filters","tags":["transaction-service-controller"]}}},"components":{"schemas":{"Address details":{"description":"Detailed address of the hotel","properties":{"address_line1":{"type":"string","description":"Address Line 1"},"address_line2":{"type":"string","description":"Address Line 2"},"city":{"type":"string","description":"City details of the address"},"country":{"type":"string","description":"Country name of the hotel. This attribute is a part of the address. "},"postal_code":{"type":"string","description":"Postal code of the hotel or car rental location"},"province":{"type":"string","description":"The state or province name"},"region":{"type":"string","description":"The state or province name"}}},"Air dates of travel":{"description":"Arrival and departure dates for air transaction","properties":{"arrival_date_time":{"type":"string","description":"Arrival time of the traveler’s flight journey in ISO 8601 format: YYYY-MM-DD HH:MM:SS Example:2020-01- 2110:07:41"},"departure_date_time":{"type":"string","description":"Departure date and time of the traveler’s flight journey in ISO 8601 format:YYYY-MM-DD HH:MM:SS Example:2020-01- 2110:07:41"}}},"Air leg details":{"description":"Leg level detailed information","properties":{"airline_alliance":{"type":"string","description":"The airline alliance for a ticket, leg, or segment (leg and segment airline alliance may differ from the ticket airline alliance)"},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"flown_cabin_class":{"type":"string","description":"Indicates the actual cabin class offered by the airline to the traveler at the time of flight. It may be different from the ticketing cabin class if airline offered a complimentary cabin class upgrade. Cabin class is a segment-level attribute. To determine ticket or leg level cabin class, the cabin class of the segment with highest mileage (distance) is used. In case two or more segments have identical mileages, then segment is chosen based on the priority order of cabin class (i.e. level of service offered by the airline), which is in the following order: First class, business, premium economy, economy."},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)"},"leg_duration":{"type":"string","description":"The total length of time (in minutes) from the flight departure time to flight arrival time. All segments and layover duration are included in the leg duration"},"leg_number":{"type":"string","description":"Represents the order of the leg within the ticket."},"marketing_airline":{"type":"string","description":"The marketing airline associated with the air leg , e.g. Alaska Airlines or British Airways."},"number_of_segments":{"type":"string","description":"The total number of segments"},"origin_destination_info":{"$ref":"#/components/schemas/Air origin destination details"},"price":{"$ref":"#/components/schemas/Price information"},"travel_dates":{"$ref":"#/components/schemas/Air dates of travel"}}},"Air origin destination details":{"description":"Origin destination info","properties":{"airport1_alphabetical":{"type":"string","description":"The first airport name of the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. Amsterdam, Netherlands (AMS-Schiphol)."},"airport1_code_alphabetical":{"type":"string","description":"The first airport code of the alphabetical airport code pair associated with the ticket, leg, or segment e.g. AMS."},"airport1_country_alphabetical":{"type":"string","description":"The country of the first airport code in the alphabetical airport code pair associated with the ticket, leg, or segment."},"airport1_location_alphabetical":{"type":"string","description":"The location of the first airport in the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. Amsterdam, Netherlands (AMS-Schiphol)."},"airport2_alphabetical":{"type":"string","description":"The second airport name of the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. Seattle, WA (SEA-Seattle - Tacoma Intl.)."},"airport2_code_alphabetical":{"type":"string","description":"The second airport code of the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. SEA."},"airport2_country_alphabetical":{"type":"string","description":"The country of the second airport code in the alphabetical airport code pair associated with the ticket, leg, or segment."},"airport2_location_alphabetical":{"type":"string","description":"The location of the second airport in the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. Seattle, WA, USA (SEA-Seattle - Tacoma Intl.)."},"airport_code_pair_alphabetical":{"type":"string","description":"The airport codes of the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. AMS:SEA."},"airport_location_pair_alphabetical":{"type":"string","description":"The airport locations of the alphabetical airport code pair associated with the ticket, leg, or segment, e.g. Amsterdam, Netherlands (AMS-Schiphol):Seattle, WA, USA (SEA-Seattle - Tacoma Intl.)."},"destination_airport":{"type":"string","description":"The airport name associated with the ending point of the ticket, leg, or segment, e.g. Seattle, WA (SEA-Seattle - Tacoma Intl.)."},"destination_airport_code":{"type":"string","description":"The airport code associated with the ending point of the ticket, leg, or segment, e.g. SEA. "},"destination_country":{"type":"string","description":"The country associated with the ending point of the route for ticket/leg/segment."},"destination_location":{"type":"string","description":"The location associated with the ending point of the route for ticket/leg/segment, e.g. ‘Lille Europe, France’ or ‘Bellem, Belgium’."},"destination_region":{"type":"string","description":"Destination region"},"origin_airport":{"type":"string","description":"The airport name associated with the starting point of the ticket, leg, or segment, e.g. Seattle, WA (SEA-Seattle - Tacoma Intl.)."},"origin_airport_code":{"type":"string","description":"The airport code associated with the starting point of the ticket, leg, or segment, e.g. SEA."},"origin_and_destination_airport_codes":{"type":"string","description":"The airport codes of the city pair associated with the ticket, leg, or segment, e.g. SEA:AMS."},"origin_and_destination_locations":{"type":"string","description":"The airport locations associated with the ticket, leg, or segment, e.g. Seattle, WA, USA (SEA-Seattle - Tacoma Intl.):Amsterdam, Netherlands (AMS-Schiphol)."},"origin_country":{"type":"string","description":"The country associated with the starting point of the route for ticket/leg/segment."},"origin_location":{"type":"string","description":"The location associated with the starting point of the route for ticket/leg/segment, e.g. ‘Lille Europe, France’ or ‘Bellem, Belgium’."},"origin_region":{"type":"string","description":"Originating region name"}}},"Air segment details":{"description":"Segment level detailed information","properties":{"airline_alliance":{"type":"string","description":"The airline alliance for a ticket, leg, or segment (leg and segment airline alliance may differ from the ticket airline alliance)"},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"duration":{"type":"string","description":"Segment duration"},"flown_cabin_class":{"type":"string","description":"Indicates the actual cabin class offered by the airline to the traveler at the time of flight. It may be different from the ticketing cabin class if airline offered a complimentary cabin class upgrade. Cabin class is a segment-level attribute. To determine ticket or leg level cabin class, the cabin class of the segment with highest mileage (distance) is used. In case two or more segments have identical mileages, then segment is chosen based on the priority order of cabin class (i.e. level of service offered by the airline), which is in the following order: First class, business, premium economy, economy."},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"haul":{"type":"string","description":"Indicates the type of flight (short, medium or long) based on distance as defined by BEIS/DEFRA methodology of calculating CO2 emissions. Details: Short Distance <=784.87 Km, 784.87 Km < Medium Distance <= 3700 Km, Long Distance > 3700 Km."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"marketing_airline":{"type":"string","description":"The marketing airline associated with the air leg or segment, e.g. Alaska Airlines or British Airways."},"origin_destination_info":{"$ref":"#/components/schemas/Air origin destination details"},"price":{"$ref":"#/components/schemas/Price information"},"segment":{"type":"string","description":"A segment is a flight operated by a single flight number, but may have an intermediate stop."},"segment_number":{"type":"string","description":"Represents the order of the segment within the ticket."},"travel_dates":{"$ref":"#/components/schemas/Air dates of travel"}}},"Air transaction response":{"description":"Transaction response based on different user filters for AIR LOB","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"Origin destination details":{"$ref":"#/components/schemas/Air origin destination details"},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"airline_alliance":{"type":"string","description":"The airline alliance for a ticket, leg, or segment (leg and segment airline alliance may differ from the ticket airline alliance)"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"arrival_date_time":{"type":"string","description":"The arrival date and time of this flight"},"booking_date":{"type":"string","description":"Date of booking"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"carrier_code":{"type":"string","description":"Carrier code of the Airline"},"changeability_type":{"type":"string","description":"Indicates whether booked air fare is changeable along with applicable penalties or restrictions. Includes values like Changeable, Changeable with charge, Restrictions may apply, Non-changeable, Unknown."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"departure_date_time":{"type":"string","description":"The departure date and time of this flight"},"distance":{"$ref":"#/components/schemas/Distance Info"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"fare_basis_code":{"type":"string","description":"A code defined by airline that determines the price, rules and regulations related to the fare; and in conjunction with other attributes (e.g., travel dates and ticket designator), the base fare."},"fare_type":{"type":"string","description":"The type of fare (published, corporate negotiated, web fare, etc.) of the ticket associated with the transaction."},"flight":{"type":"string","description":"Name of the flight associated with the booking"},"flight_number":{"type":"string","description":"The flight number associated with the airline carrier for a given takeoff and landing."},"flown_cabin_class":{"type":"string","description":"Indicates the actual cabin class offered by the airline to the traveler at the time of flight. It may be different from the ticketing cabin class if airline offered a complimentary cabin class upgrade. Cabin class is a segment-level attribute. To determine ticket or leg level cabin class, the cabin class of the segment with highest mileage (distance) is used. In case two or more segments have identical mileages, then segment is chosen based on the priority order of cabin class (i.e. level of service offered by the airline), which is in the following order: First class, business, premium economy, economy."},"fractional_ticket_count":{"type":"string","description":"The total number of tickets based on Return Ticket Count (One Way = 0.5) calculation"},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_fly_america_compliant":{"type":"string","description":"Indicates whether a booking is compliant under Fly America Act for clients traveling on US federal government funds. Any booking is considered compliant if all its flight segments are booked with a US-based ticketing or marketing airline. Excludes consideration of Open skies agreement. Data is available for all clients regardless of whether they have opted-in."},"is_sat_night_stay":{"type":"string","description":"Whether the trip or segment included a Saturday Night Stay"},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"leg_count":{"type":"string","description":"The total number of legs on a ticket"},"leg_info":{"$ref":"#/components/schemas/Air leg details"},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"low_cost_carrier":{"type":"string","description":"Indicates if the booking is in a Low Cost Carrier"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"ndc":{"$ref":"#/components/schemas/NDC (New Distribution Capability) Details"},"original_ticket_code":{"type":"string","description":"If the original ticket was exchanged, this field shows the ticket number of the original booking."},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"prior_ticket_code":{"type":"string","description":"If a ticket has been exchanged multiple times, this field shows the ticket number of the most recently exchanged ticket prior to the current one."},"purchase_count":{"type":"string","description":"The total number of purchases. Includes purchases and reservations only, across all spend categories"},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"refundability_type":{"type":"string","description":"Indicates whether booked air fare is refundable along with applicable penalties or restrictions. Includes values like Refundable, Refundable with charge, Restrictions may apply, Non-refundable, Unknown."},"route":{"type":"string","description":"Flight route. Entire route of the travel associated with the air booking."},"savings":{"$ref":"#/components/schemas/Savings"},"segment_count":{"type":"string","description":"The number of segments in this trip"},"segment_info":{"$ref":"#/components/schemas/Air segment details"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"ticket_count":{"type":"string","description":"The net number of tickets associated with the specified report period. Includes all transaction types (purchases, exchanges, cancellations etc.) and all booking methods (Online and Agent-assisted)"},"ticketing_airline":{"type":"string","description":"The airline associated with the air ticket (American Airlines, British Airways, Cathay Pacific, etc.)."},"ticketing_class_of_service":{"type":"string","description":"Market share trend by the class of service of the ticketing airlines."},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"trip_geometry":{"type":"string","description":"Type of Trip. Indicates if the trip is round trip or one way"},"trip_id":{"type":"string","description":"Unique identifier for a trip in case trip names are identical"},"trip_name":{"type":"string","description":"Name of the trip that a particular booking (or its associated fees) belongs to"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"}}},"Approval details":{"description":"Details of approval status and approver","properties":{"is_approval_required":{"type":"string","description":"Indicates whether approval was required for a booking. A ‘Yes’ value indicates that approval was needed, and a ‘No’ value indicates that approval was not required."},"level1_approver":{"type":"string","description":"The name of the person who approved the first-level approval request for a booking. A ‘SYSTEM’ value indicates that the first-level approver/s did not take any action. A blank value indicates that another (security or second-level) approval was required."}}},"Booker details":{"description":"Details of person who has made the transaction","properties":{"name":{"type":"string","description":"The name of the person who actually transacted."},"role":{"type":"string","description":"The role of the person who actually transacted"}}},"Car Origin Destination Information":{"description":"Information about origin and destination of travel","properties":{"drop_off_airport":{"type":"string","description":"IATA code of the drop-off airport"},"drop_off_city":{"type":"string","description":"City details of drop-off location"},"pick_up_airport":{"type":"string","description":"IATA code of the pick-up airport"},"pick_up_city":{"type":"string","description":"City details of pick-up location"},"pick_up_country":{"type":"string","description":"Country details of pick-up location"}}},"Car transaction response":{"description":"Transaction response based on different user filters for CAR LOB","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"acriss_code":{"type":"string","description":"ACRISS Codes is a standard code utilized by car rental companies to classify car based on four letter matrix. ACRISS stands for The Association of Car Rental Industry Systems Standards."},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"booking_date":{"type":"string","description":"Date of booking"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"car_daily_rate":{"type":"string","description":"The Base Rate per day for the car rental reservation. This value does not include taxes or fees associated with the reservation."},"car_display_group_id":{"type":"string","description":"This is the Id associated with the car type. Example “6” for Full Size Car."},"car_type":{"type":"string","description":"The class of car selected at the time of reservation. Eg : Economy Van, Luxury Van, Standard SUV, Economy SUV etc"},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"distance":{"$ref":"#/components/schemas/Distance Info"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_collected":{"type":"string","description":"Indicates whether the user picked up their car from the rental agency counter."},"is_delivered":{"type":"string","description":"Indicates whether the company-negotiated car is delivered to an agreed-upon location by its respective supplier."},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"origin_destination_info":{"$ref":"#/components/schemas/Car Origin Destination Information"},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"payment_method":{"type":"string","description":"The payment method used for the booking"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"purchase_count":{"type":"string","description":"The total number of purchases. Includes purchases and reservations only, across all spend categories"},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"rental_days":{"type":"string","description":"The total number of days cars were rented for."},"reservation_count":{"type":"string","description":"The net number of reservations associated with the specified report period.Includes all transaction types (purchases, exchanges, cancellations etc.) and all booking methods (Online and Agent-assisted)."},"segment_count":{"type":"string","description":"The number of segments in this trip"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"travel_product_country_name":{"type":"string","description":"The country of sale for the travelers account"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"trip_id":{"type":"string","description":"Unique identifier for a trip in case trip names are identical"},"trip_name":{"type":"string","description":"Name of the trip that a particular booking (or its associated fees) belongs to"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_code":{"type":"string","description":"Vendor code for the car vendor that is providing the travel service."},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"}}},"Carbon Emission Metadata":{"description":"Details of carbon emission","properties":{"advanced_settings":{"type":"string","description":"Indicates what is considered in the carbon calculation (direct, direct + indirect, direct + indirect + upstream emissions)"},"calculation_method":{"type":"string","description":"Indicates the method used when creating carbon emission reports (BEIS/DEFRA, IATA)"}}},"Carbon Emissions":{"description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","properties":{"carbon_emission_kg":{"type":"string","description":"The carbon footprint generated by travel activities measured in kilograms according to organisational calculation standards. For Air, Hotel, and Train, if carbon calculation method is BEIS/DEFRA, CO2 emissions are calculated by multiplying the distance travelled or nights stayed with a DEFRA (Department for Environment, Food & Rural Affairs) conversion coefficient. A new coefficient is released every year around July or August, which is used to convert air and train business travel and hotel stays into kilograms (kgs) of greenhouse gas emissions. Coefficient used for calculating CO2 emissions is of the same year as the travel start year. For Car, CO2 g/km emissions are computed based on average by category and fuel type using ACRISS calculation method assuming 100 miles driven per rental day and converting it to kilograms (kgs) of greenhouse gas emissions."},"carbon_emission_lbs":{"type":"string","description":"The carbon footprint generated by travel activities measured in pounds according to organisational calculation standards. For Air, Hotel, and Train, if carbon calculation method is BEIS/DEFRA, CO2 emissions are calculated by multiplying the distance travelled or nights stayed with a DEFRA (Department for Environment, Food & Rural Affairs) conversion coefficient. A new coefficient is released every year around July or August, which is used to convert air and train business travel and hotel stays into pounds (lbs) of greenhouse gas emissions. Coefficient used for calculating CO2 emissions is of the same year as the travel start year. For Car, CO2 g/km emissions are computed based on average by category and fuel type using ACRISS calculation method assuming 100 miles driven per rental day and converting it to pounds (lbs) of greenhouse gas emissions."},"kg":{"type":"string","description":"The carbon footprint generated by travel activities measured in kilograms according to organisational calculation standards. For Air, Hotel, and Train, if carbon calculation method is BEIS/DEFRA, CO2 emissions are calculated by multiplying the distance travelled or nights stayed with a DEFRA (Department for Environment, Food & Rural Affairs) conversion coefficient. A new coefficient is released every year around July or August, which is used to convert air and train business travel and hotel stays into kilograms (kgs) of greenhouse gas emissions. Coefficient used for calculating CO2 emissions is of the same year as the travel start year. For Car, CO2 g/km emissions are computed based on average by category and fuel type using ACRISS calculation method assuming 100 miles driven per rental day and converting it to kilograms (kgs) of greenhouse gas emissions."},"lbs":{"type":"string","description":"The carbon footprint generated by travel activities measured in pounds according to organisational calculation standards. For Air, Hotel, and Train, if carbon calculation method is BEIS/DEFRA, CO2 emissions are calculated by multiplying the distance travelled or nights stayed with a DEFRA (Department for Environment, Food & Rural Affairs) conversion coefficient. A new coefficient is released every year around July or August, which is used to convert air and train business travel and hotel stays into pounds (lbs) of greenhouse gas emissions. Coefficient used for calculating CO2 emissions is of the same year as the travel start year. For Car, CO2 g/km emissions are computed based on average by category and fuel type using ACRISS calculation method assuming 100 miles driven per rental day and converting it to pounds (lbs) of greenhouse gas emissions."}}},"Client payment instrument information":{"description":"Information about Payment Instrument for client","properties":{"credit_card_bin":{"type":"string","description":"The bank identification number (BIN) of the credit card associated with the booking"},"credit_card_last4_digits":{"type":"string","description":"Last 4 digits of the credit card associated with the booking."},"credit_card_type":{"type":"string","description":"The type (American Express, Visa, MasterCard, etc.) of the credit card associated with the booking."}}},"Dates of travel":{"description":"Arrival and departure dates","properties":{"travel_end_date":{"type":"string","description":"The date that travel is complete for the particular travel booking (e.g. return or arrival date for an air ticket)."},"travel_start_date":{"type":"string","description":"The date that travel commences for the particular travel booking (e.g. departure date for an air ticket)."}}},"Distance Info":{"description":"Distance covered per segment.","properties":{"km":{"type":"string","description":"Calculated distance from the origin location to the destination location covered per segment in Kilometers. Sum of distance calculated for all segments based on filter criteria."},"miles":{"type":"string","description":"Calculated distance from the origin location to the destination location covered per segment in Miles. Sum of distance calculated for all segments based on filter criteria."}}},"Duration of booking":{"description":"The total length of time (in minutes) from the departure time to the arrival time for all segments of a trip. Layover duration is not included in the travel duration","properties":{"minutes":{"type":"string","description":"Count of minutes that person was traveling. Starting from travel start date to travel end date (e.g. flight duration)."}}},"Dynamic Hotel Rate Cap":{"description":"It is a dynamically calculated rate cap based on the Market Rate and customer policy settings. It is empty when the global or location-based rate cap (per diem) is used.","properties":{"default_rate_cap":{"type":"string","description":"The global or location based rate cap (per-diem) for a booking."},"dynamic_rate_cap":{"type":"string","description":"A dynamically calculated rate cap based on the Market Rate and customer policy settings. Empty, when the global or location based rate cap (per-diem) is used."},"market_rate":{"type":"string","description":"Median nightly rate for properties available in a destination at the time the search was performed. The market rate is determined by city level geography, so properties in the same search may have different values. Example: Seattle may have a market rate of $150, while nearby Bellevue has a market rate of $200."},"market_rate_comparison":{"type":"string","description":"Comparison of the nightly rate for the booking to the market rate. Example: A booking with $120 spend for one night with a Market Rate of $100 is 1.2 (120/100)."},"travel_policy_group_benchmark":{"type":"string","description":"Comparison of booked historical nightly rates to market rates for the given travel policy group. 70 reference bookings are necessary to calculate this benchmark with high accuracy. Example: A policy group that has on average spent 50% more than the market rate will have a benchmark of 1.5."}}},"EntityModelTransaction Data Response":{"properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"metadata":{"$ref":"#/components/schemas/Metadata corresponding to a transaction"},"report_id":{"type":"string","description":"Unique report ID"},"transactions":{"type":"array","description":"Transactions","items":{"$ref":"#/components/schemas/Transaction response"}}}},"Fee transaction response":{"description":"Transaction response based on different user filters for FEE LOB","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"booking_category":{"type":"string","description":"Booking Category of the transaction"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"distance":{"$ref":"#/components/schemas/Distance Info"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"fee_category":{"type":"string","description":"Fee Global Type"},"fee_count":{"type":"string","description":"Fee(Ticket) Count"},"fee_service_type":{"type":"string","description":"Fee Service Type Name"},"fee_type":{"type":"string","description":"The fee type of the transaction"},"feetype":{"type":"string","deprecated":true,"description":"(Deprecated) Refer to fee_type"},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"is_waived":{"type":"string","description":"Indicates whether a fee transaction was waived by an agent"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"purchase_count":{"type":"string","description":"The total number of purchases. Includes purchases and reservations only, across all spend categories"},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"segment_count":{"type":"string","description":"The number of segments in this trip"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"ticket_count":{"type":"string","description":"Ticket Count"},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"trip_id":{"type":"string","description":"Unique identifier for a trip in case trip names are identical"},"trip_name":{"type":"string","description":"Name of the trip that a particular booking (or its associated fees) belongs to"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"waived_amount":{"type":"string","description":"Indicates the original fee amount that was supposed to be charged initially but waived later"}}},"Ground transaction response":{"description":"Transaction response based on different user filters for Ground LOB","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"booking_date":{"type":"string","description":"Date of booking"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"cancellation_rule":{"type":"string","description":"Cancellation rules set by the vendor for the booking"},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"distance":{"$ref":"#/components/schemas/Distance Info"},"drop_off_airport":{"type":"string","description":"IATA code of the drop off airport"},"drop_off_city":{"type":"string","description":"City details of drop-off location"},"drop_off_country":{"type":"string","description":"Country details of drop-off location"},"drop_off_location_type":{"type":"string","description":"Location type of the drop-off location like airport or an address"},"drop_off_region":{"type":"string","description":"Drop Off Region"},"drop_off_street":{"type":"string","description":"Street address of drop-off location"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"km":{"type":"string","description":"Calculated distance from the origin location to the destination location covered per segment in KM"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miles":{"type":"string","description":"Calculated distance from the origin location to the destination location covered per segment in Miles"},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"passenger_count":{"type":"string","description":"Maximum count of passengers allowed in the vehicle"},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"pick_up_airport":{"type":"string","description":"IATA code of the pick-up airport"},"pick_up_city":{"type":"string","description":"City details of pick-up location"},"pick_up_country":{"type":"string","description":"Country details of pick-up location"},"pick_up_location_type":{"type":"string","description":"Location type of the Pick-up location like airport or an address"},"pick_up_region":{"type":"string","description":"Pickup Region"},"pick_up_street":{"type":"string","description":"Street address of pick-up location"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"purchase_count":{"type":"string","description":"The total number of purchases. Includes purchases and reservations only, across all spend categories"},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"reservation_count":{"type":"string","description":"The net number of reservations associated with the specified report period.Includes all transaction types (purchases, exchanges, cancellations etc.) and all booking methods (Online and Agent-assisted)."},"segment_count":{"type":"string","description":"The number of segments in this trip"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"transfer_type":{"type":"string","description":"Type of ground transfer like private transfer or shared transfer etc."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"vehicle":{"$ref":"#/components/schemas/Vehicle Info"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"}}},"Hotel transaction response":{"description":"Transaction response based on different user filters for HOTEL LOB","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"address":{"$ref":"#/components/schemas/Address details"},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"booking_date":{"type":"string","description":"Date of the booking"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"credit_card_type":{"type":"string","description":"The type (American Express, Visa, MasterCard, etc.) of the credit card associated with the booking."},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"distance":{"$ref":"#/components/schemas/Distance Info"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"dynamic_hotel_rate_cap":{"$ref":"#/components/schemas/Dynamic Hotel Rate Cap"},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"hotel_airport_code":{"type":"string","description":"Three letter airport code associated with hotel."},"hotel_brand":{"type":"string","description":"The brand associated with the hotel. For example, Hilton International is a chain, and Hampton Inn, Hilton Garden Inn, and Embassy Suites are Hilton International brands."},"hotel_chain":{"type":"string","description":"The chain associated with the hotel. For example, Hilton International is a chain, and Hampton Inn, Hilton Garden Inn and Embassy Suites are Hilton International brands."},"hotel_chain_code":{"type":"string","description":"The chain code associated with the hotel."},"hotel_country_code":{"type":"string","description":"The country code associated with hotel."},"hotel_name":{"type":"string","description":"Name of the hotel"},"hotel_night_rate":{"type":"string","description":"Rate per night for the hotel booking"},"hotel_nights":{"type":"string","description":"The net number of nights in all hotel stays. Includes all transaction types (purchases, exchanges, cancellations etc.) and all booking methods (Online and Agent-assisted)."},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_non_standard_booking":{"type":"string","description":"It indicates that our Travel Consultants have created this transaction to record offline bookings for travelers."},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"lowest_published_rate":{"type":"string","description":"The Lowest Published Rate refers to the lowest published rate by the same hotel for which the room is booked. This metric only includes scenarios when the booked rate and the published rate are almost the same matches (same hotel, and same date)"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"phone_number_fax":{"type":"string","description":"Phone number or fax"},"phone_number_local":{"type":"string","description":"Hotel Local Phone"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"purchase_count":{"type":"string","description":"The total number of purchases including only purchases and reservations, across all spend categories."},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"room_count":{"type":"string","description":"The net number of rooms associated with the specified booking period"},"savings":{"$ref":"#/components/schemas/Savings"},"segment_count":{"type":"string","description":"The number of segments in this trip"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"trip_id":{"type":"string","description":"Unique identifier for a trip in case trip names are identical"},"trip_name":{"type":"string","description":"Name of the trip that a particular booking (or its associated fees) belongs to"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"}}},"IATA Code response":{"description":"IATA Code API response based on provided Point of Sale","properties":{"iata":{"type":"string","description":"IATA Code for the particular Point of Sale"},"pos":{"type":"string","description":"Point of Sale"}}},"Link":{"properties":{"deprecation":{"type":"string"},"href":{"type":"string"},"hreflang":{"type":"string"},"media":{"type":"string"},"name":{"type":"string"},"profile":{"type":"string"},"rel":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}}},"Metadata corresponding to a transaction":{"description":"Transaction metadata","properties":{"Carbon calculation setup details":{"$ref":"#/components/schemas/Carbon Emission Metadata"},"current_page":{"type":"integer","format":"int32","description":"Current page"},"latest_reconciled_date":{"type":"string","description":"Latest Reconciled Date"},"page_limit":{"type":"integer","format":"int32","description":"Number of records on one page"},"total_pages":{"type":"integer","format":"int32","description":"Total pages"},"total_records":{"type":"integer","format":"int32","description":"Total number of records"}}},"NDC (New Distribution Capability) Details":{"description":"NDC (New Distribution Capability) Details","properties":{"is_ndc":{"type":"string","description":"Indicates whether an air booking was done via NDC (New Distribution Capability) or not"}}},"Policy details":{"description":"Details about policy compliance","properties":{"in_policy":{"type":"string","description":"Indicates whether the transaction was booked within policy or out of policy."},"policy_reason_code":{"type":"string","description":"The two character reason code selected by the traveler to explain why they made an out of policy booking. e.g. AQ, AR, AN"},"policy_reason_description":{"type":"string","description":"The reason selected by the traveler to explain why they made an out of policy booking."},"violated_policy_1":{"type":"string","description":"Traveler policy that was broken for an out-of-policy booking. For Air, it can have values like - Advance purchase days, Price above recommended fare, Highest cabin class allowed, Highest price allowed, Out of policy route, Preferred airlines, Sustainable flights, etc. For Hotel, it can have values like - Dynamic Hotel Rate Cap, Default Per Diem Allowance, Location-specific Per Diem Allowance, Restricted Destinations, etc. For Car, it can have values like - Allowed car classifications, Car price policy, etc. For Train, it can have values like - Advance purchase days, Out of policy route, Highest cabin class allowed, etc. Violated Policy 2 will only have a value if more than 1 policy is broken for a booking."},"violated_policy_2":{"type":"string","description":"Traveler policy that was broken for an out-of-policy booking. For Air, it can have values like - Advance purchase days, Price above recommended fare, Highest cabin class allowed, Highest price allowed, Out of policy route, Preferred airlines, Sustainable flights, etc. For Hotel, it can have values like - Dynamic Hotel Rate Cap, Default Per Diem Allowance, Location-specific Per Diem Allowance, Restricted Destinations, etc. Violated Policy 2 will only have a value if more than 1 policy is broken for a booking."}}},"Price information":{"description":"Booking price breakup","properties":{"average_leg_amount":{"type":"string","description":"The average price of a leg."},"average_segment_amount":{"type":"string","description":"The average price of a segment."},"base_amount":{"type":"string","description":"Base Amount for the current transaction"},"best_fare_option":{"type":"string","description":"The lowest in-policy fare matching your reasonable flight settings. For exchanges, this is the transaction amount."},"change_fee":{"type":"string","description":"Change Fee for the current transaction"},"change_fees":{"type":"string","deprecated":true,"description":"(Deprecated) Refer to change_fee"},"coupon_amount":{"type":"string","description":"Indicates if any coupon amount is used for the booking transaction."},"extra_guest_charges":{"type":"string","description":"Amount charged for Extra Person in USD"},"fare_bases":{"type":"string","description":"Fare bases"},"fees":{"type":"string","description":"Fees for the current transaction"},"goodwill_amount":{"type":"string","description":"Goodwill amount of the current transaction"},"leg_amount":{"type":"string","description":"The total amount associated with the leg in the report period."},"local_currency":{"type":"string","description":"Indicates the local currency symbol for the booking."},"published_fare":{"type":"string","description":"The published or undiscounted rate of the booking item."},"segment_amount":{"type":"string","description":"The total amount associated with the segments (without tax)"},"tax_gst":{"type":"string","description":"The Goods and Services Tax charged for transaction. For purchases, this will be GST for the ticket. For exchanges, this will be the differential GST of the exchange. Federal tax currently set to 5%."},"tax_hst":{"type":"string","description":"The Harmonized Sales Tax charged for transaction. For purchases, this will be HST for the ticket. For exchanges, this will be the differential HST of the exchange. Combination of federal and provincial tax used in provinces such as Ontario, New Brunswick, Nova Scotia, Newfoundland and Labrador, and PEI in Canada."},"tax_pst":{"type":"string","description":"The Provincial Sales Tax charged for transaction. For purchases, this will be PST for the ticket. For exchanges, this will be the differential PST of the exchange. Only levied in some provinces such as British Columbia, Saskatchewan, Manitoba, and Quebec in Canada."},"tax_qst":{"type":"string","description":"The Québec Sales Tax charged for transaction. For purchases, this will be QST for the ticket. For exchanges, this will be the differential QST of the exchange. Provincial sales tax charged on most goods and services in the province of Quebec, Canada."},"tax_vat":{"type":"string","description":"The description added Tax charged with booking base amount."},"taxes":{"type":"string","description":"Taxes for the current transaction (fees included for car)"},"taxes_and_fees":{"type":"string","description":"The taxes and fees associated with the current transaction."},"transaction_amount":{"type":"string","description":"Total booking amount for the current transaction"},"transaction_amount_local":{"type":"string","description":"Indicates the gross booking amount in local currency, including taxes and fees."},"transaction_amount_vat":{"type":"string","description":"Transaction Amount VAT"},"true_ticket_amount":{"type":"string","description":"The total ticket amount (including base and tax). This does not include any credits from a prior ticket or exchange penalties."}}},"Savings":{"description":"Indicates the Total Savings","properties":{"dynamic_rate_cap_savings":{"type":"string","description":"Dynamic rate cap encourages travelers to book closer to the market rate. To determine how much it helps save, first a group of bookings (min 70) is used to find the percentage of how much travelers tend to book above or below the market median rate (i.e., Group benchmark). To determine savings for a booking, booked rate is multiplied by Group benchmark, and average nightly rate (i.e., market median rate) is subtracted from it for that booking (then multiply by room nights if more than one night per booking). In other words, if travelers usually book 10% above the market median rate but now they choose a rate (say, $100) which is 10% below market median rate of the search (say, $110), because the dynamic rate cap is active and is set at per diem, that's a 20% drop in spend (1.2 group benchmark). ($100 booked rate x 1.2) - ($110 market median rate) = $10 savings per night."},"egencia_preferred_rate_savings":{"type":"string","description":"The difference between the ticketed fare and published fare when the ticketed fare was an Egencia Preferred Rates. The published fare refers to the price published by the same airline from which the ticket is booked. This metric only includes scenarios when the ticketed Egencia Preferred Rates and the published fare are a match (same airline, same flight, same routing, and as close as possible flexibility status (changeable, refundable, etc.)."},"missed_savings":{"type":"string","description":"The difference between the ticketed fare and the best fare option.Calculated for Online Purchases only"},"negotiated_savings":{"type":"string","description":"The difference between the ticketed fare and the published fare, if the ticketed fare was a negotiated rate.Calculated for corporate negotiated rates for air ticket purchases only. This does not include Egencia Preferred Rates."},"savings_over_published_fare":{"type":"string","description":"This field shows the difference between the ticketed fare and the published fare. For example, if the ticketed fare is $350 and the published fare is $400, savings over published fare is $50."},"savings_over_published_rate":{"type":"string","description":"Actual savings realized for Hotel as the difference between published rate and booked rate. For example, if the published rate is $100 and the booked rate is $80, savings over published rate is $20"}}},"Train leg details":{"description":"Leg detailed information","properties":{"average_segment_amount":{"type":"string","description":"Train Leg - The average amount paid for a Segment (without tax)."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the leg at the time of booking."},"carrier":{"type":"string","description":"The carrier associated with the train leg(e.g. SNCF, etc.)."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"geography_type":{"type":"string","description":"The region of travel for the leg of the journey (domestic, international, regional, etc.)"},"is_active":{"type":"string","description":"Indicates whether the Transaction/Leg is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"origin_destination_info":{"$ref":"#/components/schemas/Train origin destination details"}}},"Train origin destination details":{"description":"Segment origin destination details","properties":{"city_code_pair":{"type":"string","description":"The origin and destination city code pair"},"city_name_pair":{"type":"string","description":"Origin and Destination City name pair"},"destination_country":{"type":"string","description":"The country associated with the ending point of the route for ticket/leg/segment."},"destination_location":{"type":"string","description":"Destination Location"},"destination_station":{"type":"string","description":"Destination Station"},"destination_station_code":{"type":"string","description":"Station code of destination location"},"origin_and_destination_station_codes":{"type":"string","description":"The train station codes associated with the route for ticket/leg/segment, e.g. ‘BEBEL:FRLLE’."},"origin_and_destination_station_locations":{"type":"string","description":"The location associated with the starting and ending point of the route for ticket/leg/segment, e.g. ‘Bellem, Belgium:Lille Europe, France’"},"origin_country":{"type":"string","description":"The country associated with the starting point of the route for ticket/leg/segment."},"origin_country_ticket_count":{"type":"string","description":"Origin country ticket count"},"origin_location":{"type":"string","description":"The location associated with the starting point of the route for ticket/leg/segment, e.g. ‘Lille Europe, France’ or ‘Bellem, Belgium’."},"origin_station":{"type":"string","description":"Origin Station"},"origin_station_code":{"type":"string","description":"The train station code associated with the starting point of the route for ticket/leg/segment, e.g. BEBEL, FRLLE."},"station1_alphabetical":{"type":"string","description":"The train station name associated with the starting point ot the route for ticket/leg/segment, e.g. Bellem, Lille Europe. for a bidirectional or return trip"},"station1_code_alphabetical":{"type":"string","description":"The train station code associated with the starting point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 1 Code- Alphabetical' value is same i.e. ‘BEBEL’."},"station1_country_alphabetical":{"type":"string","description":"The country associated with the starting point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment for a bidirectional or return trip. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 1 Country - Alphabetical' value is same i.e. ‘Belgium’ "},"station1_location_alphabetical":{"type":"string","description":"The location associated with the starting point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 1 Location - Alphabetical' value is same i.e. ‘Bellem, Belgium’."},"station2_alphabetical":{"type":"string","description":"The train station name associated with the ending point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 2 - Alphabetical' value is same i.e. ‘Lille Europe’"},"station2_code_alphabetical":{"type":"string","description":"The train station code associated with the ending point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 2 Code- Alphabetical' value is same i.e. ‘FRLLE’."},"station2_country_alphabetical":{"type":"string","description":"The country associated with the ending point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 2 Country - Alphabetical' value is same i.e. ‘France’."},"station2_location_alphabetical":{"type":"string","description":"The location associated with the ending point of the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice versa. 'Station 2 Location - Alphabetical' description is same i.e. ‘Lille Europe, France’."},"station_code_pair_alphabetical":{"type":"string","description":"The train station code pair associated with the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice-vera. 'Station Code Pair - Alphabetical' value is same i.e. ‘BEBEL:FRLLE’."},"station_location_pair_alphabetical":{"type":"string","description":"The location pair associated with the route (sorted alphabetically by Station Code) for the ticket/leg/segment. E.g. For a travel from Lille Europe(FRLLE), France to Bellem(BEBEL), Belgium or vice-vera. 'Station Location Pair - Alphabetical' value is same i.e. ‘Bellem, Belgium:Lille Europe, France’."}}},"Train segment details":{"description":"Segment level detailed information","properties":{"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"cabin_class_type":{"type":"string","description":"Cabin class Type for the current segment"},"carrier":{"type":"string","description":"The carrier associated with the train ticket, leg, or segment (e.g. SNCF, etc.)."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)"},"is_active":{"type":"string","description":"The trip status for the current segment"},"operating_carrier_segment":{"type":"string","description":"Indicates train operator associated with the segment. Includes values like OUIGO, ICE, RE, THALYS, Renfe, Vy, SJR, etc."},"origin_destination_info":{"$ref":"#/components/schemas/Train origin destination details"},"segment":{"type":"string","description":"Segment"},"segment_number":{"type":"string","description":"Represents the order of the segment within the ticket."},"ticket_code":{"type":"string","description":"The number of the ticket associated with the train transaction for this segment"},"ticket_number":{"type":"string","deprecated":true,"description":"(Deprecated) Refer to ticket_code"},"train_number_segment":{"type":"string","description":"Train Number"},"trip_geometry":{"type":"string","description":"The trip type, e.g. One way, Round Trip, Multi-Destination"}}},"Train transaction response":{"description":"Transaction response based on different user filters for TRAIN LOB","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"arrival_date_time":{"type":"string","description":"The date and time when a flight or train will arrive for leg/segment."},"booking_date":{"type":"string","description":"Date of booking"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"carrier":{"type":"string","description":"The carrier associated with the train ticket"},"carrier_code":{"type":"string","description":"The unique identification code of the carrier associated with the train ticket"},"city_code_pair":{"type":"string","description":"The origin and destination city code pair"},"city_name_pair":{"type":"string","description":"Origin and Destination City name pair"},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"class_of_service_code":{"type":"string","description":"(Deprecated) Refer to \"class_of_service\""},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"corporate_traveler_group":{"type":"string","description":"Corporate traveler group"},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"departure_date_time":{"type":"string","description":"Departure time of the traveler’s flight journey in ISO 8601 format: YYYY-MM-DD HH:MM:SS Example:2020-01-21 10:07:41"},"distance":{"$ref":"#/components/schemas/Distance Info"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"fare_type":{"type":"string","description":"The type of fare (published, corporate negotiated, web fare, etc.) of the ticket associated with the transaction."},"fraction_ticket_count":{"type":"string","description":"The total number of tickets based on Return Ticket Count (One Way = 0.5) calculation."},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"group_account_department_id":{"type":"string","description":"Group account department ID"},"group_account_department_name":{"type":"string","description":"Group account department name"},"group_account_id":{"type":"string","description":"Group account ID"},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_sat_night_stay":{"type":"string","description":"Whether the trip or segment included a Saturday Night Stay"},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"itinerary_text":{"type":"string","description":"Itinerary text"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"leg_count":{"type":"string","description":"The total number of legs"},"leg_info":{"$ref":"#/components/schemas/Train leg details"},"leg_number":{"type":"string","description":"Represents the order of the leg within the ticket."},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"origin_destination_info":{"$ref":"#/components/schemas/Train origin destination details"},"original_ticket_code":{"type":"string","description":"If the original ticket was exchanged, this field shows the ticket number of the original booking."},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"purchase_count":{"type":"string","description":"The total number of purchases. Includes purchases and reservations only, across all spend categories."},"purchase_count_ratio":{"type":"string","description":"Purchase count ratio"},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"routing":{"type":"string","description":"The ordered list of origin and destination train station code for every stop on the ticket."},"segment_count":{"type":"string","description":"The number of segments in this trip"},"segment_level_info":{"$ref":"#/components/schemas/Train segment details"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"ticket_count":{"type":"string","description":"The net number of tickets associated with the specified report period."},"ticketing_carrier":{"type":"string","description":"The carrier associated with the train ticket"},"ticketing_fare_type":{"type":"string","description":"Ticketing fare type (published, corporate negotiated, web fare, etc.) associated with the transaction."},"train_fare_type_name":{"type":"string","description":"Train fare type name"},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"trip_geometry":{"type":"string","description":"Type of Trip e.g. One way, Round Trip, Multi-Destination"},"trip_id":{"type":"string","description":"Unique identifier for a trip in case trip names are identical"},"trip_name":{"type":"string","description":"Name of the trip that a particular booking (or its associated fees) belongs to"},"trip_type_name":{"type":"string","description":"Trip type name"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"}}},"Transaction data filters to create a new report":{"description":"Search criteria containing filters for the transaction query","properties":{"active_records_only":{"type":"string","description":"String that takes true to retrieve active records only or false for taking all records."},"client_ids":{"type":"array","description":"List of companies for which the search is done","items":{"type":"string","description":"List of companies for which the search is done"}},"company_id":{"type":"integer","format":"int32","description":"The Company identifier"},"currency_code":{"type":"string","description":"Currency code to get the amount in given currency, default description is USD"},"date_type":{"type":"string","description":"Date Type is used to generate the reports based on Issue Date or Travel Date, default description is Issue Date"},"end_date":{"type":"string","format":"date-time","description":"End date for transactions."},"includes":{"type":"array","description":"Additional inclusions like cdf, etc.","items":{"type":"string","description":"Additional inclusions like cdf, etc."}},"locale":{"type":"string","description":"Locale to get the report in supported languages. Ex. en-US, fr-FR, default description is en-US"},"product_id":{"type":"integer","format":"int32","description":"The Product identifier"},"reconciled_records_only":{"type":"string","description":"String that takes true to retrieve reconciled records only or false for taking all records."},"report_level":{"type":"string","description":"Report level for the LOB like leg, segment, etc."},"start_date":{"type":"string","format":"date-time","description":"Start date for transactions."}},"required":["currency_code","end_date","locale","start_date"]},"Transaction response":{"description":"Transaction response based on different user filters","properties":{"Booker":{"$ref":"#/components/schemas/Booker details"},"advance_purchase_days":{"type":"string","description":"Number of days purchased in Advance"},"advance_purchase_window":{"type":"string","description":"The number of days before the travel start date that a traveler books a ticket or makes a reservation. This is usually depicted as a range of days. Includes purchase & reservations only"},"ancillary_type":{"type":"string","description":"The type of ancillary (Excess Baggage, Taxi, Shuttle, Parking, etc) associated with an Air or Train booking. It includes visas, insurance, additional services, air transportation, food, and seats."},"approval":{"$ref":"#/components/schemas/Approval details"},"booking_method":{"type":"string","description":"Online or Agent-assisted. Online indicates a booking made through the Egencia website or mobile app without the assistance of an Egencia travel consultant. Agent-assisted indicates bookings made offline with the assistance of an Egencia travel consultant."},"cabin_class":{"type":"string","description":"Indicates the highest travel class (economy, first, business, etc) of the ticket, leg, or segment at the time of booking."},"class_of_service":{"type":"string","description":"The fare class (F, S etc.) associated with trains in the report period. The fare class indicates the cabin type as well as ticket or reservation restrictions."},"client_code":{"type":"string","description":"This is a Unique Identifier for a client in Egencia. In the current version, it will be corresponding to the GPID."},"co2":{"type":"array","description":"Carbon Emission as per Air conversion factors (Source by DEFRA Produced by AEA for the Department of Energy and Climate Change (DECC) and the Department for Environment, Food and Rural Affairs (Defra))","items":{"$ref":"#/components/schemas/Carbon Emissions"}},"company_name":{"type":"string","description":"The name of the company travel was booked through"},"custom_data_fields":{"type":"object","additionalProperties":{"type":"object","description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"description":"The custom fields set up by your company for reporting purposes that are either specified by the traveler at the time of booking or from the traveler profile."},"department":{"type":"string","description":"The Department selected by the traveler at the time of booking"},"distance":{"$ref":"#/components/schemas/Distance Info"},"duration":{"$ref":"#/components/schemas/Duration of booking"},"geography_type":{"type":"string","description":"The region of travel (domestic, international, regional, etc.)."},"identifier":{"$ref":"#/components/schemas/Unique transaction identification details"},"invoice_date":{"type":"string","description":"The date the booking was invoiced. Invoice date is only applicable for European points of sale."},"is_active":{"type":"string","description":"Indicates whether the Transaction/Ticket/Leg/Segment is Active or Inactive. A 'Yes' value indicates that the transaction is active, and a 'No' value indicates that the transaction has been cancelled, voided, refunded, or exchanged."},"is_special_request":{"type":"string","description":"Indicates whether or not the ticket is a special request"},"last_modified_date":{"type":"string","description":"Date and time when a particular record in reporting was last updated due to modifications after original purchase, back-dated data fixes, etc."},"line_of_business":{"type":"string","description":"Line of business for the transaction, e.g. Air, Hotel, Car, Train, Ground"},"location":{"type":"string","description":"For hotels, this field shows the city, state/province and country where the hotel is located. For air and train, this field shows the routing information and for car, this field shows the pick-up location"},"meeting_name":{"type":"string","description":"Indicates meeting name associated with a booking (Meetings/Group Air Online or Group Trips). Applicable for Air, Hotel and Train in Group Trips, and only Air in Meetings. Empty for meetings outside of US and Canada."},"miscellaneous_transport_type":{"type":"string","description":"Indicates the type of miscellaneous transport that the agent booked offline. It includes Car, Limo/town car (Ground), Ferry, Helicopter, Bus, High-speed craft, and Other."},"parent_client_code":{"type":"string","description":"The Client’s Parent Organisation Id."},"payment_instrument_info":{"$ref":"#/components/schemas/Client payment instrument information"},"point_of_sale_country":{"type":"string","description":"The country of sale for the travelers account"},"point_of_sale_type":{"type":"string","description":"Indicates whether a booking is made via Egencia's point of sale or EGA (Egencia Global Alliance). It Includes values like Egencia, EGA Partners"},"policy":{"$ref":"#/components/schemas/Policy details"},"price":{"$ref":"#/components/schemas/Price information"},"purchase_count":{"type":"string","description":"The total number of purchases. Includes purchases and reservations only, across all spend categories"},"rate_type":{"type":"string","description":"The type of inventory purchased or reserved by the traveler (Published Rate, Egencia Preferred Rate, Corporate negotiated rate, etc.)."},"record_id":{"type":"string","description":"System-generated unique identifier for each record in reporting."},"segment_count":{"type":"string","description":"The number of segments in this trip"},"ticket_code":{"type":"string","description":"The number of the ticket associated with the air transaction"},"transaction_date":{"type":"string","description":"The date the transaction occurred on an itinerary (e.g. the date of the air ticket purchase, car reservation or hotel cancellation)"},"transaction_type":{"type":"string","description":"The type of action applied to a transaction (Air purchase, Hotel reservation, Hotel cancel, etc.)."},"travel_dates":{"$ref":"#/components/schemas/Dates of travel"},"traveler":{"$ref":"#/components/schemas/Traveler details"},"vendor":{"type":"string","description":"The company providing the travel service, e.g. car rental company"},"vendor_name":{"type":"string","description":"The company providing the travel service, e.g. car rental company"}}},"Traveler details":{"description":"Detailed information of traveler","properties":{"email":{"type":"string","description":"Email address of the person for whom the travel booking was made"},"group":{"type":"string","description":"Traveler group that the traveler is a member of"},"is_guest":{"type":"string","description":"Whether the traveler is a guest traveler"},"meeting_attendee_group":{"type":"string","description":"The current traveler group associated with the traveler for a specific meeting. Meeting attendee group will be empty for European points of sale and for travel that is not associated with a meeting"},"name":{"type":"string","description":"The name of the person for whom the travel booking was made"}}},"Unique transaction identification details":{"description":"Booking identifier","properties":{"confirmation_number":{"type":"string","description":"A unique number generated by supplier that identifies the booking."},"invoice_number":{"type":"string","description":"The invoice number associated with the travel transaction being reported on."},"itinerary_number":{"type":"string","description":"The Egencia itinerary number associated with the travel transaction being reported on."},"pnr":{"type":"string","description":"The booking reference code provided by the vendor. Also known as a PNR (passenger name record) code. This is typically a 6 character reference code"},"record_locator":{"type":"string","description":"The booking reference code provided by the vendor. Also known as a PNR (passenger name record) code. This is typically a 6 character reference code."},"ticket_code":{"type":"string","description":"Ticket code associated with the booking"},"ticket_number":{"type":"string","deprecated":true,"description":"(Deprecated) Refer to ticket_code"}}},"Vehicle Info":{"description":"Details about vehicle","properties":{"category":{"type":"string","description":"Category of Vehicle"},"type":{"type":"string","description":"Type of Vehicle"}}}},"securitySchemes":{"OAuth2":{"flows":{"clientCredentials":{"tokenUrl":"https://apis.egencia.com/auth/v1/token"}},"type":"oauth2"}}}}