TravelRequests
Retrieve a list of all budget categories.
Columns
| Name | Type | Description |
| Id [KEY] | String | The unique identifier of the Request. |
| Name | String | The name of the Request. |
| Approved | Boolean | Indicates whether this Request is approved. |
| AllocationFormId | String | The unique identifier of the allocation form. |
| ApprovalLimitDate | Datetime | Limit approval date of the proposal. Past this date, the proposal will not be viable any more. Note: Offset MUST be in form YYYY-MM-DDThh:mm:ss. |
| AuthorizedDate | Datetime | For approved Request, the date at which the approval process was completed. |
| BusinessPurpose | String | The business purpose of the Request. |
| CanceledPostApproval | Boolean | Indicates whether this Request was canceledPostApproval. |
| Closed | Boolean | Indicates whether this Request is closed. |
| CreationDate | Datetime | The date the Request was created. |
| EndDate | Date | The end date of the Request. |
| EndTime | Time | The end time of the Request. |
| EverSentBack | Boolean | Indicates whether the Request has ever been sent back to the employee. |
| HighestExceptionLevel | String | The highest level of exception contained in this Request. Supported values: WARNING, ERROR, and NONE |
| Href | String | Hyperlink to the resource for this Request. |
| LastModified | Datetime | The date the Request was last modified. |
| PendingApproval | Boolean | Indicates whether this Request is pending approval. |
| PRN | String | The value of the pnr provided within the agency proposals by the travel agency. |
| RequestId | String | The public key of the Request (unique per customer). |
| StartDate | Date | The start date of the Request. |
| StartTime | Time | The end date of the Request. |
| SubmitDate | Datetime | The date the Request was submitted (last submit date in case of recall). |
| ApprovalStatusCode | String | The code for the approval status of the Request. Supported values: NOT_SUBMITTED, SUBMITTED, APPROVED, CANCELED, or SENTBACK |
| ApprovalStatusName | String | The approval status of the Request in the current user?s language. |
| ApproverId | String | Unique identifier of the related object. |
| ApproverFirstName | String | The first name of the employee. |
| ApproverLastName | String | The last name of the employee. |
| ApproverMiddleInitial | String | The middle initial of the employee. |
| MainDestinationId | String | The id of the location. |
| MainDestinationCity | String | Required for all city location type (not airport, or rail station - except for STD location type) The city name of the location.Note: STD location type for rail is considered as a city location type, city and countryCode fields are required in that case. |
| MainDestinationCountryCode | String | Required if city or name is used The ISO 3166-1 country code. Max length 2 characters. |
| MainDestinationCountrySubDivisionCode | String | The ISO 3166-2 country sub code. |
| MainDestinationiataCode | String | Required if air is used The IATA code of an airport location. |
| MainDestinationLatitude | Integer | The latitude of the location. |
| MainDestinationLongitude | Integer | The longitude of the location. |
| MainDestinationLocationCode | String | Required if rail is used with RAIL_xx locationType The code of the location. Optional for segments based on city locations, will be required in case of duplicate locations within database. If provided (with city and countryCode still required), it will be considered first, and if not found then city and countryCode will be considered. |
| MainDestinationType | String | Required if rail is used The type of the location. |
| MainDestinationName | String | The name of the location. Always provide the countryCode value in addition to the name. |
| OwnerId | String | Unique identifier of the related object. |
| OwnerFirstName | String | The first name of the employee. |
| OwnerLastName | String | The last name of the employee. |
| OwnerMiddleInitial | String | The middle initial of the employee. |
| TotalApprovedAmountValue | Integer | The amount in the defined currency. |
| TotalApprovedAmountCurrency | String | The 3-letter ISO 4217 code for the currency in which the amount is expressed. Max length 3 characters. |
| TotalPostedAmountValue | Integer | The amount in the defined currency. |
| TotalPostedAmountCurrency | String | The 3-letter ISO 4217 code for the currency in which the amount is expressed. Max length 3 characters. |
| TotalRemainingAmountValue | Integer | The amount in the defined currency. |
| TotalRemainingAmountCurrency | String | The 3-letter ISO 4217 code for the currency in which the amount is expressed. Max length 3 characters. |
| RequestTypeCode | String | The code of the type inherited from the Request Policy type. Possible values: Authorization, Cash Advance, Travel |
| RequestTypeLabel | String | The label of the type inherited from the Request Policy Type. |
| Custom1Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom1Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom1Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom2Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom2Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom2Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom3Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom3Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom3Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom4Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom4Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom4Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom5Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom5Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom5Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom6Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom6Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom6Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom7Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom7Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom7Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom8Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom8Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom8Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom9Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom9Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom9Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom10Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom10Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom10Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom12ode | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom11Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom1Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom12Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom12Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom12Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom13Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom13Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom13Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom14Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom14Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom14Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom15Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom15Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom15Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom16Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom16Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom16Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom17Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom17Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom17Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom18Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom18Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom18Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom19Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom19Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom19Href | String | The link to get this list item on the list service. Empty for non-list items. |
| Custom20Code | String | The short code for the list item. For non-list fields, this value will be blank. |
| Custom20Value | String | The value of the non-list item. For list fields, this is the unique id of the list item. |
| Custom20Href | String | The link to get this list item on the list service. Empty for non-list items. |
| CashAdvances | String | The list of cash advances for this Request. |
| Comments | String | The list of comments for this Request. |
| Exceptions | String | The list of exceptions that have been raised to this Request. |
| Expenses | String | Expected expenses attached to this Request. |
| ExtensionOf | String | The Request for which this Request is an extension of, or addendum to. |
| EventRequest | String | The parent Event Request to which this child Request is related. |
| Policy | String | The policy that applies to the Request. |
| TravelAgency | String | The travel agency office that is managing the trip associated to this Request. |
| View | String | Name of the view defining the scope of the Requests to get. Supported values:ALL: Get all existing Requests for a user (relevant only for the traveler).ACTIVE Get all active Requests. Does not include cancelled Requests. Approved Requests included are aged less than three months based on current date and must not be in closed status.ACTIVEAPPROVED Get all active Requests at the Approved status. Those approved Requests are aged less than three months based on current date and must not be in closed status.UNSUBMITTED: Get all the unsubmitted Requests (relevant only for the traveler).PENDING: Get all the Requests that are submitted but not yet approved (relevant only for the traveler).VALIDATED: Get all the approved Requests for a user (relevant only for the traveler). Closed Requests are included in this view.APPROVED: Get all the approved Requests by a user (relevant only for the approver). Closed Requests are included in this view.CANCELED: Get all the cancelled Requests for a user (relevant only for the traveler). Cancelled could include closed/not closed Requests.CLOSED: Get all the closed Requests for a user (relevant only for the traveler). Includes canceled then closed Request as well as approved then closed Requests.SUBMITTED: Get all the submitted Requests for a user (relevant only for the traveler). Submitted does not include cancelled requests.TOAPPROVE: Get all Requests to be approved by the user (relevant only for the approver).PENDINGEBOOKING: Approved Requests awaiting Concur Travel booking(s).PENDINGPROPOSAL: Get all Requests submitted to a Travel Agency (TMC) step (relevant only for the TMC agent), userId is required.PROPOSALAPPROVED: Get all the approved Requests by a user (relevant only for the TMC agent), userId is required.PROPOSALCANCELED: Get all the cancelled Requests for a user (relevant only for the TMC agent), userId is required.If no view value is sent, the default view ALL will be used.
The default value is ALL. |
| UserId | String | Associated with a traveler view: the unique identifier of the Request owner to use when searching for Requests.Associated with an approver view: the unique identifier of the approver to user when searching for Requests.Associated with a TMC agent view, Required, the unique identifier of the TMC agent to use. This TMC agent user must have a default Travel Agency assigned in its profile corresponding to the Travel Agency assigned to the Requests |