Surcharges

Retrieve applicable surcharges for a registration period

Changed on Sep 29, 2026

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

Base URL
https://api.maqqie.app (the document declares no server; this is the origin it was published from)
Auth
OAuth 2
Client credentials
Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token
TypeScript
https://skmtc.dev/maqqie/apis/maqqie-public-api/docs/public/surcharges/v1/retrieve-surcharges/post.ts
A function with typed inputs. Its response is checked against the schema.

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"
    }
  ]
}

Changes

Sep 29, 2026f9510f3f4b22 Revision changes
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  the request's body type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to string for status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the optional property to the response with the status
Sep 29, 20263352b56bb8fe Revision changes
- breaking
  the request's body type changed from object to no type
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from string to no type for status
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the optional property from the response with the status
- info
  response schema application/json enum value removed COMPANY_DOES_NOT_EXIST
- info
  response schema application/json enum value removed INVALID_COLLECTIVE_LABOUR_AGREEMENT_NUMBER
- info
  response schema application/json enum value removed REGISTRATION_EXCEEDS_MAXIMUM_HOURS
- info
  response schema application/json enum value removed START_DATE_TIME_MUST_BE_BEFORE_END_DATE_TIME

Operation history (8 revisions)