Important: This API is currently in pre-release status and is only available to approved early access participants. The API is under development and might change before being generally released. To become an early access participant, contact your SAP Concur Representative.

Schema

Request

Name Type Format Description
approvalLimitDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ The date by which the Request must be approved. This element appears only when integrated with Concur Travel
approvalStatus object Approval Status The approval status of the Request
approved boolean - Indicates whether this Request is approved
authorizedDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ 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
comment string - The last comment attached to this Request
comments object ResourceLink The list of comments for this Request
creationDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ The date the Request was created
custom1 to custom20 object CustomField The details from the Custom fields. These fields may not have data, depending on the configuration
endDate date [ISO 8601] yyyy-MM-dd The end date of the Request
endTime time [ISO 8601] yyyy-MM-dd The end time of the Request
everSentBack boolean - Indicates whether the Request has ever been sent back to the employee
expenses array ResourceLink Expected expenses attached to this Request
extensionOf object RequestLink The Request that this Request is an extension of, or addendum to
href string [RFC 3986] Hyperlink to the resource for this Request
id string - The unique identifier of the Request
lastModified timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ The date the Request was last modified
mainDestination object Location The main destination of the Request
name string - The name of the Request
owner object Employee The employee who owns the Request
pendingApproval boolean - Indicates whether this Request is pending approval
policy object ResourceLink The policy that applies to the Request
requestId string 4 to 6 alphanumeric characters The public key of the Request (unique per customer)
startDate date [ISO 8601] yyyy-MM-dd The start date of the Request
startTime time [ISO 8601] yyyy-MM-dd The start time of the Request
submitDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ The date the Request was submitted (last submit date in case of recall)
totalApprovedAmount object Amount The total amount of approved expected expenses in the Request, expressed in the reimbursement currency of the employee at the time they created the Request
totalPostedAmount object Amount The total amount of the Request, expressed in the reimbursement currency of the employee at the time they created the Request
totalRemainingAmount object Amount The total amount not included in an Expense report, expressed in the reimbursement currency of the employee at the time they created the Request
travelAgency object ResourceLink The travel agency office that is managing the trip associated to this Request
operations array Link Links to operations available for the Request, depends on the current workflow status
type object RequestType The type of the Request, inherited from the Request Policy Type

Amount

Name Type Format Description
value number - Required The amount in the defined currency
currency string [ISO 4217:2015] Required The 3-letter ISO 4217 code for the currency in which the amount is expressed

Approval Status

Name Type Format Description
code string - The code for the approval status the Request.
Possible values: NOT_SUBMITTED, SUBMITTED, APPROVED, CANCELED or SENTBACK
name string - The approval status of the Request in the current user’s language

Comments

Name Type Format Description
author object Employee The employee who has created the comment in the expected expense
creationDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS Creation date of the comment
isLatest boolean - True when the comment has been edited since the last workflow transition
value string - The value of the comment

CustomField

Name Type Format Description
code string - The short code for the list item. For non-list fields, this value will be blank
value string - The value of the non-list item. For list fields, this is the unique id of the item
listItemId string - The unique id of the item in case of a list field
href string - The link to get this list item on the list service. Empty for non-list items

Employee

Name Type Format Description
firstName string - The first name of the employee
href string [RFC 3986] Hyperlink to the resource
id string [RFC 4122] Unique identifier of the related object
lastName string - The last name of the employee
middleInitial string - The middle initial of the employee
template string - Hyperlink template to the resource
Name Type Format Description
rel string [RFC 5988] Relation type as defined by the server. There are registered relation types listed in RFC 5988 6.2.2. Initial Registry Contents including pagination relation types of next, prev, first and last
href string [RFC 3986] Hyperlink to the resource

List of Request

Name Type Format Description
data array Request List of Requests in the page requested
operations array Link Links to next, prev, first and last pages

List of Request Policies

Name Type Format Description
- array Request Policy List of active Requests policies for a given user

Location

Name Type Format Description
countryCode string [ISO 3166-1] The ISO 3166-1 country code
countrySubDivisionCode string [ISO 3166-2] The ISO 3166-2 country sub code
city string - The city name of the location
iataCode string - The IATA code of the location
name string - The name of the location
Name Type Format Description
href string [RFC 3986] Hyperlink to the resource
id string [RFC 4122] Unique identifier of the related object
template string - Hyperlink template to the resource
Name Type Format Description
requestId string 4 to 6 alphanumeric characters The public key of the Request (unique per customer)

Request Policy

Name Type Format Description
href string [RFC 3986] Hyperlink to the resource for this Request policy
id string - The Request policy unique identifier
name string - The name of the Request policy

Request Type

Name Type Format Description
code string - The code of the type inherited from the Request Policy type
label string - The label of the type inherited from the Request Policy Type

Expected Expense

Name Type Format Description
allocations object Allocation The details of the allocations for this expected expense.
approvedAmount object Amount The approved amount of the expected expense entry, in the transaction currency of the Request
budgetAccrualDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ The date to determine which budgets are affected
businessPurpose string - The business purpose of the Request entry
comments object ResourceLink The list of comments for this expected expense
custom1 to custom40 object CustomField The details from the Custom fields.
These fields may not have data, depending on the configuration
exchangeRate object Exchange Rate The exchange rate that applies to the entry
expenseType object Expense Type The expense type of the entry.
Required for expected expenses, automatically set for segments depending on the SegmentType code.
href string [RFC 3986] Hyperlink to the resource for this Request entry
id string - The unique identifier of the expected expense entry
lastComment string - The last comment (most recent) of the expected expense entry
lastModifiedDate timestamp [RFC 3339] The date when this expected expense was last modified
location object Location The location of the expected expense entry
orgUnit1 to orgUnit6 object Amount The details from the Custom fields.
These fields may not have data, depending on the configuration
postedAmount object Amount The posted amount of the expected expense entry, in the transaction currency of the Request
remainingAmount object Amount The remaining amount of the expected expense entry, in the transaction currency of the Request
source enum - The source that created the expected expense. It can be CASH_ADVANCE or TRAVEL_ALLOWANCE.
This field will be empty in any other case
transactionAmount object Amount Required The amount of the expected expense entry, in the transaction currency paid to the vendor
transactionDate timestamp [RFC 3339] yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ Required The date of the transaction
travelAllowance object Travel Allowance The Travel allowance
tripData object Trip Data The description of the trip
vendor object Vendor The vendor of the expected expense entry

Allocation

Name Type Format Description
allocationAmount object Amount The amount of the allocation calculated with the percentage value multiplied by the transaction amount on the expected expense. This amount is given in the transaction’s currency and rounded to 8 decimals after decimal point.
approvedAmount object Amount The amount of the allocation calculated with the percentage value multiplied by the approved amount on the expected expense. This amount is given in the user’s currency and rounded to 8 decimals after decimal point.
allocationId string - The unique allocation identifier
custom1 to custom20 object CustomField The details from the Custom fields.
These fields may not have data, depending on the configuration
expenseId string - The unique identifier of the expected expense associated with the allocation
percentEdited boolean - Whether the allocation percent has been edited
percentage number - The percentage of the total expected expense that this allocation represents
postedAmount object Amount The amount of the allocation calculated with the percentage value multiplied by the posted amount on the expected expense. This amount is given in the user’s currency and rounded to 8 decimals after decimal point.
systemAllocation boolean - Whether the allocation is a system allocation, usually hidden from the user. If displayed to the user, should be read-only

Exchange Rate

Name Type Format Description
operation string - Exchange rate operation. Possible values are: MULTIPLY or DIVIDE
value number - Exchange rate value

Expense Type

Name Type Format Description
id string - Required Unique identifier of the expense type
name string - Name of the expense type

List Item Field

Name Type Format Description
code string - The short code of the list item
value string - Unique identifier of the list item
href string [RFC 3986] Hyperlink to the resource for the list item

Segment Leg

Name Type Format Description
class list List Item Field The booking class of the segment leg.
classOfService string - The class of service of the segment leg. For example, in the case of an air segment, this field would contain the one-letter booking code: Y for economy class, or F for first class…
comment string - Contains the last comment saved in this segment leg.
custom1 to custom40 object CustomField The details from the Custom fields. These fields may not have data, depending on the configuration
endDate date [ISO 8601] YYYY-MM-DD The date of the end of this segment leg. It represents the arrival date of AIRFR and TRAIN segments, check out date for HOTEL or drop off for CARRT
endLocation object ResourceLink The location where this segment leg arrives. This would be the arrival location for an air segment for example.
endLocationDetail string - Details about the end location. This would contain details about the name of a hotel, or some details about a car rental agency for example.
endTime time [ISO 8601] HH:MM The time for the end of this segment leg
id string - The unique identifier of the segment leg
returnLeg boolean - Indicates whether this leg is the return leg of a round trip. In case of a ROUND_TRIP, if not explicitly set, the second segment leg will be considered as the return leg.
startDate date [ISO 8601] YYYY-MM-DD The date of the beginning of this segment leg
startLocation object ResourceLink The start location of this segment leg. This would be the departure location for an air segment for example.
startLocationDetail string - Details about the start location. This would contain details about the name of a hotel, or some details about a car rental agency for example.
startTime time [ISO 8601] HH:MM The time for the beginning of this segment leg
segmentLocator string - This is the identifier for ConcurTravel segments (if applicable)
vendorName string - Contains the vendor description of the segment leg.

Segment Type

Name Type Format Description
category enum - Describes the category of this segment type. Possible values are: REQ_SEG_AIRFR, REQ_SEG_CARRT, REQ_SEG_HOTEL, REQ_SEG_LIMOF, REQ_SEG_RAILF, REQ_SEG_TAXIF, REQ_SEG_MISC, REQ_SEG_PARKG, REQ_SEG_DININ, REQ_SEG_EVENT
code string - Required The code of the segment type. Possible values are: AIRFR, CARRT, HOTEL, LIMOF, RAILF, TAXIF, MISC, PARKG, DININ, EVENT or custom codes

It can be REQ_SEG_AIRFR / AIRFR for a regular air segment, or REQ_SEG_AIRFR / 10325 for a custom air segment.

Example:

{
  "category": "REQ_SEG_AIRFR",
  "code": "AIRFR"
}

Travel Agency

Name Type Format Description
emailAddress string - The travel agency email address
id string - The travel agency unique identifier
name string - The travel agency office name
proposalType string - The travel agency proposal type. Possible value: CWTF, AEBT or API

Travel Allowance

Name Type Format Description
dailyTravelAllowanceId string - The fixed daily travel allowance id associated with the expected expense

Trip Data

Name Type Format Description
agencyBooked boolean - True if this travel is (or has to be) handled by a travel agency
legs list Segment Leg The list of the legs of the travel
tripType string - Indicates the type of this trip. Should be one of ONE_WAY, ROUND_TRIP or MULTI_STOPS. If not provided, will be detected from the given legs.
segmentType object Segment Type Required The type of the segment
selfBooked boolean - True if this travel has been reserved by Concur Travel, or if Concur Travel has retrieved the trip information in the GDS

Vendor

Name Type Format Description
id string - The vendor identifier of the entry
name string - The vendor description of the entry