ConnectCloud Developers

Travel rates and settings of the tenant (tenant:access)

GET /api/hr/v1/travel-config

Module: HR · operationId: getTravelConfig · Tag: Travel expenses · Auth: access token (Authorization: Bearer <accessToken>)

The allowance rates per country and validity (the German domestic rates are seeded as editable tenant data) and the trade document type of released reports.

Responses

  • 200 Configuration (application/json)

Fields of the 200 answer:

  • rates (array of TravelRate): Allowance rates per country and start date
    • country (string, required): ISO 3166-1 alpha-2 code of the country
    • validFrom (string (date), required): First day the rates apply (YYYY-MM-DD)
    • breakfastPercent (integer): Cut for breakfast in percent of the full-day rate (20)
    • dinnerPercent (integer): Cut for dinner (40)
    • fullDayCents (integer): 24-hour allowance
    • id (string, read-only): Id of the rate row
    • lunchPercent (integer): Cut for lunch (40)
    • mileageCentsPerKm (integer): Mileage allowance (used from the home country's rate)
    • overnightCents (integer): Lodging lump sum per night
    • partialDayCents (integer): Allowance of departure/return days and single days over 8 hours
    • version (integer): Version for optimistic locking: send the version you read with a change (stale: 409 version_conflict)
  • settings (TravelSettings)
    • homeCountry (string): Country whose mileage rate applies
    • transactionType (string): Trade document type code of released reports
    • version (integer): Version for optimistic locking: send the version you read with a change (stale: 409 version_conflict)

Example 200 answer:

{
  "rates": [
    {
      "breakfastPercent": 20,
      "country": "DE",
      "dinnerPercent": 40,
      "fullDayCents": 2800,
      "id": "4d6f8b0d-2f4b-4d6f-9b0d-2f4b6d8f0b43",
      "lunchPercent": 40,
      "mileageCentsPerKm": 30,
      "overnightCents": 2000,
      "partialDayCents": 1400,
      "validFrom": "2020-01-01",
      "version": 1
    },
    {
      "breakfastPercent": 20,
      "country": "AT",
      "dinnerPercent": 40,
      "fullDayCents": 5000,
      "id": "2b4d6f8b-0d2f-4b4d-8f6b-0d2f4b6d8f42",
      "lunchPercent": 40,
      "mileageCentsPerKm": 30,
      "overnightCents": 11700,
      "partialDayCents": 3300,
      "validFrom": "2026-01-01",
      "version": 1
    }
  ],
  "settings": {
    "homeCountry": "DE",
    "transactionType": "TRAVEL_EXPENSE",
    "version": 2
  }
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/hr/v1/travel-config' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI