Travel Allowance

The Travel Allowance API fetches all the fixed allowance days in the specified expense report. Clients using this API can determine whether an allowance is a full day or partial day allowance.

Limitations

This API is available only for Finland customers. This API is not available in the China Data Center.

Process Flow

Image of Process_Flow

Products and Editions

  • Concur Expense Professional Edition
  • Concur Expense Standard Edition

Scope Usage

Name Description Endpoint
travelallowance.allowancedays.read View the allowance days in an expense report GET
EXPRPT Retrieve the report ID from the Expense Report API to supply to the Travel Allowance API GET

Dependencies

The developer must call the Expense Report v3 API prior to using this API, to get the expense report Id.

Access Token Usage

This API will work with Company access token only. A valid Company access token is needed to use this API.

Retrieve a Company Access Token

A Company-level access token is required to create an integration with this API. This allows your integration to get fixed allowance day details of an expense report.

For clients connecting to this API to build a custom integration you will receive client credentials and information on how to generate your company access token or company refresh token from the SAP Concur Web Services resource assigned to assist you with Authentication.

Before making requests to this API, you must obtain an access token from the Authentication API.

The response will include an access_token field, which contains your access token. For subsequent calls, you will need to include this access token in the Authorization header of your calls.

Get Details of Travel Allowance Days

Scopes

travelallowance.allowancedays.read - Refer to Scope Usage for full details.

Request

URI

Template
https://{datacenterURI}/api/v4/travelallowance/allowancedays/companyUUID/{companyUUID}/contexts/{Context}/{ContextId}
Parameters
Name Type Format Description
companyUUID uuid - Required The company’s unique identifier.
Context string - Required For expense reports, the value is EXPENSE_REPORT
ContextId string - Required For expense reports, this is the reportId of the report.

Headers

Payload

  • None

Response

Status Codes

Headers

Payload

Example

Request

GET https://us.api.concursolutions.com/api/v4/travelallowance/allowancedays/companyUUID/d5528866-51b1-40a1-bab2-76296a106dcd/contexts/EXPENSE_REPORT/B769E8B106C04F30AE27
Authorization: Bearer {token}
Content-Type: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 06 Jul 2020 17:33:03 GMT
Content-Length: 1270

{
  "links": [
    {
      "rel": "self",
      "href": "https://us.api.concursolutions.com/api/v4/travelallowance/allowancedays/companyUUID/d5528866-51b1-40a1-bab2-76296a106dcd/contexts/EXPENSE_REPORT/B769E8B106C04F30AE27"
    }
  ],
  "content": [
    {
      "currencyCode": "EUR",
      "fullAllowanceDay": "False",
      "allowanceDate": "2018-09-244T12:00:00",
      "expenseTransactionDate": "2018-09-244T12:00:00",
      "expenseTransactionAmount": 29,
      "expenseTypeCode": "MEALS"
    },
    {
      "currencyCode": "EUR",
      "fullAllowanceDay": "False",
      "allowanceDate": "2018-09-245T12:00:00",
      "expenseTransactionDate": "2018-09-245T12:00:00",
      "expenseTransactionAmount": 29,
      "expenseTypeCode": "MEALS"
    },
    {
      "currencyCode": "EUR",
      "fullAllowanceDay": "False",
      "allowanceDate": "2018-09-246T12:00:00",
      "expenseTransactionDate": "2018-09-246T12:00:00",
      "expenseTransactionAmount": 29,
      "expenseTypeCode": "MEALS"
    }
  ]
}

Schema

Get Travel Allowance Days Response Schema

Name Type Format Description
expenseTypeCode string - Expense Code. For example, MEALS for Travel Allowance.
fullAllowanceDay string - True/False. ‘True’ means full allowance day and ‘False’ means partial allowance day.
currencyCode string - The 3-letter ISO 4217 currency code for the expense report currency. The expense report currency is defined as the report creator’s default reimbursement currency.
allowanceDate dateTime dateTime Travel Allowance Date.
expenseTransactionDate dateTime dateTime Expense transaction date.
expenseTransactionAmount numeric - Expense transaction amount, in the expense entry currency.
href string - The href represents the target resource identifiers.
rel string - The link relation type describes how the current context (source) is related to the target resource.

Error

Name Type Format Description
exception string - Relative exception details.
timestamp date - Time at which exception occur.
message string - Required Message associated with the error.
path string - Relative data path.

Definitions

Name Type Format Description
dateTime string - DateTime of where the transaction happened in format specified in ISO 8601, using UTC + Offset. For example, 2016-04-22T12:20+0700 (12:20 PM in Pacific Time).

On this page