Sign in

v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB
Surcharges

Retrieve applicable surcharges for a registration period

This endpoint calculates and returns applicable surcharges, based on the provided CAO number, function type, and registration periods.

Note: In case a CLA has set both a fixed amount and a factor for a surcharge and stacking rule higher, this endpoint will arbitrarily choose the factor-based surcharge.

post/public/surcharges/v1/retrieve-surcharges

Request body

caoNumberinteger required

The CAO number relevant to the registration.

companyIdstring uuid

The UUID of the company of the registration.

functionTypestring

The function type relevant to the registration.

functionSubTypestring

The function sub type relevant to the registration.

Example request

{
  "caoNumber": 433,
  "functionType": "A-Deel",
  "functionSubType": "Leerling",
  "registration": {
    "startDateTime": "2024-09-26T03:00:00Z",
    "endDateTime": "2024-09-26T14:30:00Z"
  }
}

Response

Successfully retrieved applicable surcharges

Example response

{
  "surcharges": [
    {
      "surchargeFactor": 0.5,
      "fixedSurchargeAmountPerHour": 2.5,
      "startDateTime": "2024-05-26T08:00:00Z",
      "endDateTime": "2024-05-26T10:00:00Z"
    }
  ]
}