Terug naar documentatie overzicht

This changelog is still in development and expiremental. It is subject to change at any time.

API Changelog

Version 9.0.0 (24-08-2026)

This is a major restructure of the /caodb/dump/{CAOID} endpoint. The CAO dump now mirrors the new (2026) remuneration data model: leave, payments, pension, sick pay, insurances and value calculations are exposed as fully period-based structures. Several legacy containers have been replaced by their new structured equivalents (see Removed). Every new container is a has_many where each item carries a periods array with validFrom / validTo boundaries.

Added

  • Body: /caodb/dump/{CAOID}
    • Added property: workingHoursReduction - CAO working hours reduction (ADV) regulation (replaces aDVRegulations)
    • Added property: wageIncrements - New structured wage increment items, each with periods (replaces wageIncrementsOld)
      • hash - Unique identifier of the wage increment (replaces the previous sortIndex)
      • periods > datePublication - Publication date of the retroactive wage increment agreement (only present when isRetroactive is true)
      • periods > interval - Code of the interval at which the wage increment applies
      • periods > intervalAmount - Number of units per interval
    • Added property: periodicals - New structured periodical wage increment items with periods (replaces cAOPeriodicals)
    • Added property: youthScales - New structured youth scale items with periods (replaces youthScalesOld)
    • Added property: reimbursement - CAO reimbursement (vergoeding) items with periods, type and travel expense components (replaces untaxedExpenses)
    • Added property: insurances - CAO insurance items
    • Added property: socialSecurityArrangements - CAO social security arrangement items
    • Added property: paidBreaks - CAO paid break items
    • Added property: holidays - CAO (public) holiday items
    • Added property: cAOHolidayAllowance - CAO holiday allowance items
    • Added property: invidualChoiceBudgets - CAO individual choice budget (IKB) arrangements
    • Added property: invidualChoiceBudgetComponents - Spendable components within the CAO IKB (e.g. vacation payout, bicycle plan)
    • Added property: fixedPayments - CAO fixed payment (vaste uitkering) items
    • Added property: variablePayments - CAO variable payment (variabele uitkering) items
    • Added property: anniversaryPayments - CAO anniversary payment (jubileumuitkering) items
    • Added property: specialHolidays - CAO special holiday (bijzondere vakantiedag) items, with type
    • Added property: specialLeave - CAO special leave (bijzonder verlof) items, with occasion
    • Added property: mandatoryLeave - CAO mandatory leave (verplicht verlof) items, with type
    • Added property: maternityParentalLeave - CAO maternity/parental leave items, with type
    • Added property: timeForTime - CAO time-for-time (compensatieverlof) arrangements
    • Added property: sickPay - CAO sick pay (loondoorbetaling bij ziekte) arrangements
    • Added property: sickPayConditions - CAO sick pay conditions (voorwaarden loondoorbetaling)
    • Added property: sickPayWaitingDays - CAO sick pay waiting days (wachtdagen bij ziekte)
    • Added property: sickPayWaitingDaysCompensation - CAO sick pay waiting days compensation (compensatie wachtdagen)
    • Added property: pensionRegulations - CAO pension regulations
    • Added property: additionalPensionArrangements - CAO additional pension arrangements (aanvullende pensioenregeling)
    • Added property: sustainableEmployability - CAO sustainable employability arrangements (duurzame inzetbaarheid)
    • Added property: mandatoryEducation - CAO mandatory education/training arrangements (verplichte scholing)
    • Added property: value-calculation (rekenwaarde) singletons describing how the value of a leave day is determined:
      • valueCalculationADV - for an ADV (working hours reduction) leave day
      • valueCalculationHolidays - for a vacation day
      • valueCalculationSpecialHolidays - for a public-holiday leave day
      • valueCalculationSpecialLeave - for a special-leave day
      • valueCalculationMaternityLeave - for a maternity/parental (WAZO) leave day
    • Added property: allowances
      • subType - Sub-type of the allowance
      • workingHours - Reference to the working hours the allowance depends on
    • Added property: allowances > periods
      • phaseOutScheme - Description of the phase-out scheme (afbouwregeling) for this allowance period
      • allowanceComponents - Components within the allowance period (e.g. a shift-work sub-type)
    • Added property: travelExpenses > periods
      • id - ID of the travel expenses period
      • reimbursementAsWorkingHours - Whether travel time is compensated as worked hours, compensatory hours, or money
      • compensationType - Type of compensation for travel expenses
      • description - General description of the travel expenses arrangement
      • cAOTravelExpenseComponents - CAO travel expense components (reiskostencomponenten)
    • Added property: workingHours > periods
      • valueNote - Article reference for the working hours value
      • perNote - Article reference for the working hours period
      • descriptionNote - Article reference for the working hours description

Changed

  • Body: /caodb/dump/{CAOID}
    • Changed property: wageIncrements — The publication date is no longer provided at the wage increment level. For version 9.0.0 and higher it is provided per retroactive period (wageIncrements > periods > datePublication) instead.

Removed

  • Body: /caodb/dump/{CAOID}
    • Removed property: aDVRegulations - Legacy ADV structure, superseded by workingHoursReduction
    • Removed property: wageIncrementsOld - Legacy wage increment structure, superseded by wageIncrements
      • datePublication - Moved to wageIncrements > periods > datePublication
      • datePublicationNote - No longer maintained
      • sortIndex - Replaced by wageIncrements > hash
    • Removed property: cAOPeriodicals - Legacy periodical structure, superseded by periodicals
    • Removed property: untaxedExpenses - Legacy untaxed expenses structure, superseded by reimbursement
    • Removed property: youthScalesOld - Legacy youth scale structure, superseded by youthScales

Version 8.0.0 (30-05-2026)

  • Body: /caodb/dump/{CAOID}

    • Added property: wageIncrements - New structured wage increment items with sortIndex and periods (replaces data previously in wageIncrementsOld)
      • Each period contains: date, isRetroactive, description, conditions, validFrom, validTo
    • Added property: youthScales - New structured youth scale items with sortIndex and periods (replaces data previously in youthScalesOld)
      • Each period contains: timing, periodType, description, isDescribedAsAmount, amount, amountType, interval, validFrom, validTo
    • Added property: insurances - Insurance items from the CAO
      • Each item contains: id, type, and periods
    • Added property: socialSecurityArrangements - Social security arrangement items from the CAO
      • Each item contains: id, type, and periods
    • Added property: periodicals - New structured periodical wage increment items (replaces data previously in caoPeriodicals)
      • Each item contains: id, sortIndex, appliesToAllFunctions, and periods
      • Each period contains: conditionType, isDescribedAsAmount, value fields (amount, amountType, basedOn, interval), description, conditions, validFrom, validTo
      • experienceCondition (when conditionType is experience or both) with its own periods containing type, duration/date fields, validFrom, validTo
      • performanceCondition (when conditionType is performance or both) with its own periods containing reviewMomentType, reviewDate, description, validFrom, validTo
  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}

    • Added property: functionGroups > steps
      • rawHourWage - Non-rounded hourly wage for the given step. Provides full precision for calculations where the 2-decimal hourWage may introduce rounding discrepancies.
    • Added property: baseOrganisationData
      • proprietaryRemunerationValidFrom - Start date for the validity period of the company-specific remuneration
      • proprietaryRemunerationValidTill - End date for the validity period of the company-specific remuneration
    • Added property: leaveData — value calculation fields for each leave type:
      • hasValueCalculationWorkingHoursReduction / valueCalculationWorkingHoursReduction
      • hasValueCalculationVacationDay / valueCalculationVacationDay
      • hasValueCalculationHoliday / valueCalculationHoliday
      • hasValueCalculationSpecialLeave / valueCalculationSpecialLeave
      • hasValueCalculationMaternityLeave / valueCalculationMaternityLeave
    • Added property: leaveData > holidayConditions - Conditions that apply to the holiday regulations
    • Added conditions property to the following items (indicates when the arrangement applies):
      • leaveData > workingHoursReductions > conditions
      • leaveData > vacationDays > conditions
      • leaveData > specialLeave > conditions
      • leaveData > additionalParentalLeave > conditions
      • leaveData > mandatoryLeave > conditions
      • leaveData > holidays > conditions
      • leaveData > timeForTimes > conditions
      • holidayAllowances > conditions
      • individualChoiceBudget > conditions
      • individualChoiceBudget > items > conditions
      • paymentsData > anniversaryPayments > conditions
      • paymentsData > fixedPayments > conditions
      • paymentsData > oneTimePayments > conditions
      • paymentsData > variablePayments > conditions
      • paidBreaks > items > conditions
      • reimbursementsData > reimbursements > conditions (previously existed but now standardised)
      • travelExpensesData > travelExpenses > components > conditions
      • sustainableEmployability > sustainableEmployabilityArrangements > conditions (previously existed but now standardised)
      • sustainableEmployability > mandatoryEducation > conditions
      • otherEmploymentConditionsData > items > conditions
      • pensionData > items > conditions
      • pensionData > arrangementItems > conditions
      • sickPay > waitingDaysConditions
      • sickPay > waitingDaysCompensationConditions
    • Added property: paidBreaks > items
      • isDescribedAsAmount - Whether the paid break is described as a concrete amount or as a calculation/description
    • Added property: wageIncrementsData - New structured component for wage increments, periodicals, and youth scales (replaces data previously in wageIncrements)
      • hasWageIncrements - Whether general wage increments are known
      • hasYouthScales - Whether youth scale regulations are known
      • hasPeriodicals - Whether periodical wage increments are known
      • wageIncrements - Array of wage increment items, each with date, isRetroactive, conditions, and arrangement fields
      • youthScales - Youth scales timing configuration (timingValue, periodTypeValue)
      • periodicals - Array of periodical items with structured condition types (experience, performance, both, text, none), each condition type providing its own sub-fields
    • Added property: insurancesData - New component for insurances and social security arrangements (previously, social security arrangements were part of paymentsData)
      • hasInsurances - Whether there are insurances
      • hasAdditionalSocialSecurityArrangements - Whether additional social security arrangements apply
      • insurances - Array of insurance items, each with type, amount, coverage details, employee premium contribution, and conditions
      • additionalSocialSecurityArrangements - Array of social security arrangement items (moved from paymentsData)
    • Added property: individualChoiceBudget
      • isDescribedAsAmount - Whether the overall IKB budget is described as a concrete amount

Changed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Changed property: leaveData > mandatoryLeave
      • typeOther - Renamed from occasionOther / otherDescription to typeOther to align with naming conventions
    • Changed property: wageIncrements — This section no longer stores maintained data for new publications. For version 8.0.0 and higher, use wageIncrementsData instead. Existing data in wageIncrements is preserved for backwards compatibility.

Removed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Removed property: paymentsData
      • hasAdditionalSocialSecurityArrangements - Moved to insurancesData
      • additionalSocialSecurityArrangements - Moved to insurancesData

Version 7.6.0 (05-05-2026)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: functionGroups > steps
      • RawHourWage - Non-rounded value for hourly wage. This option has been added to provide transparency about the exact values that the system uses for calculations, since the displayed hourly wage amounts are rounded to 2 decimal places and may lead to rounding differences in further calculations.

Version 7.5.0 (18-03-2026)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: paymentsData
      • anniversaryPayments > type - Added custom type for naming a anniversary payment
      • oneTimePayments
        • type - Added custom type for naming a one-time payment
        • isDescribedAsAmount - Whether the one-time payment is described as an amount or as a calculation or other within the description
      • fixedPayments > type - Added custom type for naming a fixed payment
    • Added property: individualChoiceBudget > items
      • IsDescribedAsAmount - Whether the individual choice budget component is described as an amount or as a calculation or other within the description
    • Added property: sickPayData
      • IsDescribedAsAmount - Whether the sick pay waiting days are described as an amount or as a calculation or other within the description
    • Added property: SustainableEmployabilityData > sustainableEmployabilityArrangements
      • isDescribedAsAmount - Whether the sustainable employability arrangements are described as an amount or as a calculation or other within the description

Version 7.4.0 (18-02-2026)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: reimbursements > typeOther - Added 'typeOther' field to reimbursements to be able to describe the type when the type is 'Other'
    • Added enum value: individualChoiceBudget
      • AmountType - Added "Daily" as possible enum value for amount type of the individual choice budget

Version 7.3.0 (02-01-2026)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}

    • Added property: publisher > disclaimer - Optional disclaimer text, when published with an advanced assist request role, this is filled
  • Body: /invitation/{CompanyID}

    • Add property: autoAssistType - Type of assist request

Version 7.2.0 (02-01-2026)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added enum value: workingHoursReductions
      • Interval - Added "Hourly" as possible enum value for

Version 7.1.0 (22-12-2025)

Added

  • Endpoint: /remuneration/pdf/{companyID}/{partnerID}/{remunerationID}/{version}

    • Generates a PDF representation of the remuneration data in a base64 encoded string
  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}

    • Added property: sustainableEmployability > mandatoryEducation
      • isDescribedAsAmount - Whether the mandatory education is described as an amount or as a calculation or other within the description
    • Added property: otherEmploymentConditionsData > employmentConditions
      • id - Unique identifier for the employment condition
      • isDescribedAsAmount - Whether the employment condition is described as an amount or as a calculation or other within the description
    • Added property: sickPay > sickPayAmounts
      • description - description of the sick pay amount

Version 7.0.0 (27-11-2025)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: workingHours
      • workingHoursPerWeek - The number of working hours per week (for cases when the time is in different intervals than weekly, e.g. average yearly)
    • Added property: paymentsData > additionalSocialSecurityArrangements
      • interval - The interval (unit) at which additional social security arrangements are built up
      • intervalAmount - The number of units per interval for additional social security arrangements
      • isDescribedAsAmount - Whether the additional social security arrangements are described as an amount or as a calculation or other within the description
    • Added property: paymentsData > anniversaryPayments
      • isDescribedAsAmount - Whether the anniversary payments are described as an amount or as a calculation or other within the description
    • Added property: leaveData > specialLeave
      • isDescribedAsAmount - Whether the anniversary payments are described as an amount or as a calculation or other within the description
    • Added property: leaveData
      • timeForTimes - regulations regarding time traded for time off (tijd-voor-tijd regeling)
    • Added property: sustainableEmployability > sustainableEmployabilityArrangements
      • isDescribedAsAmount - Whether the anniversary payments are described as an amount or as a calculation or other within the description
    • Added property: otherEmploymentConditionsData > employmentConditions
      • amountType - The unit of the amount
      • basedOnOther - Whether the other employment condition is based on another value than provided by the dropdown

Removed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Removed property: leaveData
      • hasVacationDays - Whether the remuneration has vacation days described or not (these are mandatory by law, so this property is redundant)
    • Removed property: leaveData > specialLeave
      • name - name of the special leave (this is redundant as it is now described with ocassion)
      • occasionOther - other occasion description (this is redundant as it is now described with ocassion)

Version 6.3.0 (06-11-2025)

Added

  • Body: /remuneration/setu/{setuVersion}/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property positionProfile
      • workDescription - Description of the work performed in the position

Version 6.2.0 (29-10-2025)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added properties: reimbursementsData > reimbursements
      • IsProportional - Whether the reimbursement is calculated pro rata
      • ProportionalBasedOn - The basis for the pro rata calculation
      • ProportionalDescription - The description of the pro rata calculation

Version 6.1.0 (25-10-2025)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added properties: pensionData > pensionAmount
      • targetGroup - The target group for the pension amount
      • ageFromTo - The range of age if targetGroup is Age
      • employmentDuration - The duration of employment if targetGroup is EmploymentDuration
    • Added properties: reimbursementsData > reimbursements
      • hasMinMaxAmount - Whether the reimbursement has a min/max amount
      • minAmount - The minimum amount of the reimbursement
      • maxAmount - The maximum amount of the reimbursement

Version 6.0.0 (20-10-2025)

Added

  • Endpoint: /remuneration/setu/{setuVersion}/{companyID}/{partnerID}/{remunerationID}/{version}

  • Body: /company

    • Added property: type - The type of company
  • Request body: /invitation/{CompanyID}

    • Added property: replyTo - Email address to which the invitation reply should be sent (as a replacement for the default of the user)
  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}

    • Added property: baseOrganisationData
      • hasPayroll
      • isCLAApplicable
    • Added property: publisher - Information about the publisher of the remuneration
    • Added property: paidBreaks
    • Added property: allowances
    • Added property: reimbursementsData
    • Added property: travelExpensesData
    • Added property: individualChoiceBudget
    • Added property: paymentsData
    • Added property: sickPay
    • Added property: leave
    • Added property: pensionData
    • Added property: sustainableEmployability
    • Added property: employmentConditions
      • items
      • hasEmploymentConditions

Removed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Removed property: hasActiveSurcharges
    • Removed property: surcharges
    • Removed property: expenses
    • Removed property: employmentConditions
      • isHasPayroll
      • confirmedPayrollNotification
      • hasGuarantee
      • hasGuaranteeOnOwnInitiative
      • conditions
      • ownConditions

Version 5.0.0 (04-06-2025)

Removed

  • The properties below are removed as part of the removal of untaxedExpense regulations. The expenses now contain both taxed and untaxed expenses.

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}

    • Removed property: expenses > expenses
      • IsUntaxed
      • TaxedAmount
      • UntaxedAmount
      • MaxAllowed
      • IsWKR
      • IsWKRID
    • Removed property: expenses > yearEndBonus
    • Removed property: WorkingHours > RegulationData

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: holidayAllowances - Holiday allowances defined in the remuneration

Version 4.6.0 (12-06-2025)

Added

  • Endpoint: Get a dump of all the details of a CAO (/caodb/dump/{CAOID})
  • Param: Added a showAll query parameter to the /caodb/cao endpoint.
  • Body: /caodb/cao
    • Add property: type - The type of CAO.

Version 4.5.0 (05-05-2025)

Added

  • Endpoint: Get list of all CAO's that have data available (/caodb/cao)
  • Endpoint: Get functions, workinghours and general info from a CAO (/caodb/cao/{CAOID})
  • Endpoint: Get wage table types from a CAO (/caodb/tables/{CAOID}/{CAOWorkingHoursID}/{CAOFunctionID})
  • Endpoint: Get function groups for a CAO function (/caodb/function/{CAOID}/{CAOFunctionID})
  • Endpoint: Get wage steps for give wage table, working hours & function group combination (/caodb/steps/{CAOID})
  • Endpoint: Get details of CAO including (hourly) wage rate & calculation methods (/caodb/details/{CAOID})
  • Endpoint: Get information of the current user (linked by the oauth token) (/account/me)
  • Endpoint: Get information of the current user (linked by the oauth token) for a specific company (/account/{CompanyID})

Version 4.4.0 (05-02-2025)

Added

  • Body: /invitation/{CompanyID}
    • Add property: sendAutoAssist - Allows for sending an assist request that will be auto-accepted. Only available when inviting a non-existing (in the system of inlenersbeloning.com) company.
    • Add property: userFields - Extra fields that will prefill the registration of the newly invited user, will be ignored if user already exists
      • salutation - Salutation of the user
      • firstName - First name of the user
      • lastName - Last name of the user
      • phoneNumber - Phone number of the user
      • functionTitle - Function title of the user
      • establishment - Establishment of the user
      • organizationPhoneNumber - Phone number of the organization the user will be added to
  • Endpoint: allows to retreive whether the company (by kvk number) exists in the system and, if so, when they last shared a remuneration (/company/info/{KvKNumber})

Version 4.3.0 (23-12-2024)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: surcharges
      • appliesToAllFunctions if the surcharge applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: wageIncrements > incrementData
      • appliesToAllFunctions if the increment data applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: wageIncrements > retroactiveIncrementData
      • appliesToAllFunctions if the retroactive increment data applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: wageIncrements > periodicalData
      • appliesToAllFunctions if the periodical increment data applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > expenses
      • appliesToAllFunctions if the expense applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > workFromHomeAllowanceData
      • appliesToAllFunctions if the work from home allowance applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > oneOffPaymentData
      • appliesToAllFunctions if the one-off payment applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > yearEndBonus
      • appliesToAllFunctions if the year-end bonus applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: employmentConditions > conditions
      • appliesToAllFunctions if the condition applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: employmentConditions > ownConditions
      • appliesToAllFunctions if the own condition applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false

Version 4.2.0 (17-06-2024)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added enum value: Surcharges
      • surchargeIn - Added "tijd" as possible enum value for
    • Added property: Surcharges
      • time - Time when the surcharge is applied (if type "tijd" is used)

Version 4.1.0 (30-05-2024)

NOTE: This version has breaking changes. although released as a minor version, it is recommended to update your implementation to be compatible with this version. Normally this would be a major version, but due to the nature of the changes, it is released as a minor version in consultation with the software suppliers that make use of this API.

Added

  • Endpoint: List all intermediary companies under the given company (for backoffices) (/intermediary/{companyID})
  • Query parameters: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • intermediaryID - Filter remunerations by intermediary company ID
  • Body: /partner/{companyID}
    • Added property: remunerations
      • intermediaryID - ID of the intermediary company the remuneration is shared with (null if the remuneration is shared directly with the company)
  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: intermediaryID - ID of the intermediary company the remuneration is shared with (null if the remuneration is shared directly with the company)
    • Added property: functionGroups
      • hasHourWageCalculation Whether the function group has an hour wage calculation
      • hasCustomHourRateCalculationMethods Whether the function group has a custom/divergent hour rate calculation method
      • hourWageCalculations Array of used hour wage calculations for the function group
    • Added property: Surcharges
      • surchargeDropdownID The ID of the surcharge in the general list of options
      • typeID Enum ID for the Type property
      • shiftAmountID Enum ID for the ShiftAmount property
    • Added property: wageIncrements > periodicalData
      • experienceMinimumAmount rename of the experienceMimimumAmount property to correct typo
      • experienceMinimumAmountType rename of the experienceMimimumAmountType property to correct typo
    • Added property: expenses (this is renamed from untaxedExpenses as they can also be taxed now. So the naming didn't make sense anymore)
      • hasExpenses (this is renamed from hasUntaxedExpenses as they can also be taxed now. So the naming didn't make sense anymore)
      • hasYearEndBonuses - whether the remuneration has year-end bonuses, before this was provided inside of the yearEndBonus list which was not a correct placement for this property
      • expenses (this is renamed from expensesData as it's more a list than general data)
        • expenseID (this is renamed from untaxedExpensesDropdownID as they can also be taxed now. So the naming didn't make sense anymore and the dropdown postfix could be confusing)
        • untaxTypeID as untaxType changed to an enum this references the ID of the enum value
      • yearEndBonus
        • appliesToAllFunctions - this boolean indicates whether the year-end bonus applies to all functions, if not, the list of remuneration functions should be filled with ID's
  • Body (webhook): /remuneration
    • Added property: partnerID (ID of the partner that shared the remuneration)
    • Added property: companyID (ID of the company that received the remuneration)

Changed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Changed property: functionGroups > steps
      • hourWage Fixed null/false value when wagetable is already hourly ('Uurloon') in which case the hourWage is the same as the salary. Before it resulted in this field being null or false.
    • Changed property: Surcharges
      • type Changed from string to enum (string)
      • shiftAmount Changed from string to enum (string)
    • Changed property: expenses > expenses
      • untaxType is now an enum instead of plain string

Removed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Removed property: hourRate - this is moved to the new functionGroups > hourWageCalculations property as it is now possible to have multiple wage calculations for a function group. Also the boolean if it has an hourWageCalculation is moved to the new property inside functionGroups.
    • Removed property: wageIncrements > periodicalData
      • experienceMimimumAmount - this is renamed to experienceMinimumAmount to correct a typo
      • experienceMimimumAmountType - this is renamed to experienceMinimumAmountType to correct a typo
    • Removed property: untaxedExpenses - this is renamed to expenses as they can also be taxed now. So the naming didn't make sense anymore.
      • hasUntaxedExpenses - this is renamed to hasExpenses as they can also be taxed now. So the naming didn't make sense anymore.
      • expensesData - this is renamed to expenses as it's more a list than general data.
        • untaxedExpensesDropdownID - this is renamed to expenseID as they can also be taxed now. So the naming didn't make sense anymore and the dropdown postfix could be confusing.
      • yearEndBonus
        • hasYearEndBonus - this is moved to the expenses property as it's a property of the remuneration expenses and not of the year-end bonuses

Version 4.0.1 (08-05-2024)

  • Fixed double encoding of the code query parameter in the oAuth 2 authorization response

Version 4.0.0 (14-02-2024)

Added

  • General functionality of oAuth 2 for authentication

Version 3.4.0 (23-12-2024)

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: surcharges
      • appliesToAllFunctions if the surcharge applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: wageIncrements > incrementData
      • appliesToAllFunctions if the increment data applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: wageIncrements > retroactiveIncrementData
      • appliesToAllFunctions if the retroactive increment data applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: wageIncrements > periodicalData
      • appliesToAllFunctions if the periodical increment data applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > expenses
      • appliesToAllFunctions if the expense applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > workFromHomeAllowanceData
      • appliesToAllFunctions if the work from home allowance applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > oneOffPaymentData
      • appliesToAllFunctions if the one-off payment applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: expenses > yearEndBonus
      • appliesToAllFunctions if the year-end bonus applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: employmentConditions > conditions
      • appliesToAllFunctions if the condition applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false
    • Added property: employmentConditions > ownConditions
      • appliesToAllFunctions if the own condition applies to all functions
      • linkedFunctions list of function IDs the surcharge applies to if appliesToAllFunctions is false

Version 3.3.0 (17-06-2024)

Added

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added enum value: Surcharges
      • surchargeIn - Added "tijd" as possible enum value for
    • Added property: Surcharges
      • time - Time when the surcharge is applied (if type "tijd" is used)

Version 3.2.0 (30-05-2024)

NOTE: This version has breaking changes. although released as a minor version, it is recommended to update your implementation to be compatible with this version. Normally this would be a major version, but due to the nature of the changes, it is released as a minor version in consultation with the software suppliers that make use of this API.

Added

  • Endpoint: List all intermediary companies under the given company (for backoffices) (/intermediary/{companyID})
  • Query parameters: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • intermediaryID - Filter remunerations by intermediary company ID
  • Body: /partner/{companyID}
    • Added property: remunerations
      • intermediaryID - ID of the intermediary company the remuneration is shared with (null if the remuneration is shared directly with the company)
  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: intermediaryID - ID of the intermediary company the remuneration is shared with (null if the remuneration is shared directly with the company)
    • Added property: functionGroups
      • hasHourWageCalculation Whether the function group has an hour wage calculation
      • hasCustomHourRateCalculationMethods Whether the function group has a custom/divergent hour rate calculation method
      • hourWageCalculations Array of used hour wage calculations for the function group
    • Added property: Surcharges
      • surchargeDropdownID The ID of the surcharge in the general list of options
      • typeID Enum ID for the Type property
      • shiftAmountID Enum ID for the ShiftAmount property
    • Added property: wageIncrements > periodicalData
      • experienceMinimumAmount rename of the experienceMimimumAmount property to correct typo
      • experienceMinimumAmountType rename of the experienceMimimumAmountType property to correct typo
    • Added property: expenses (this is renamed from untaxedExpenses as they can also be taxed now. So the naming didn't make sense anymore)
      • hasExpenses (this is renamed from hasUntaxedExpenses as they can also be taxed now. So the naming didn't make sense anymore)
      • hasYearEndBonuses - whether the remuneration has year-end bonuses, before this was provided inside of the yearEndBonus list which was not a correct placement for this property
      • expenses (this is renamed from expensesData as it's more a list than general data)
        • expenseID (this is renamed from untaxedExpensesDropdownID as they can also be taxed now. So the naming didn't make sense anymore and the dropdown postfix could be confusing)
        • untaxTypeID as untaxType changed to an enum this references the ID of the enum value
      • yearEndBonus
        • appliesToAllFunctions - this boolean indicates whether the year-end bonus applies to all functions, if not, the list of remuneration functions should be filled with ID's
  • Body (webhook): /remuneration
    • Added property: partnerID (ID of the partner that shared the remuneration)
    • Added property: companyID (ID of the company that received the remuneration)

Changed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Changed property: functionGroups > steps
      • hourWage Fixed null/false value when wagetable is already hourly ('Uurloon') in which case the hourWage is the same as the salary. Before it resulted in this field being null or false.
    • Changed property: Surcharges
      • type Changed from string to enum (string)
      • shiftAmount Changed from string to enum (string)
    • Changed property: expenses > expenses
      • untaxType is now an enum instead of plain string

Removed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Removed property: hourRate - this is moved to the new functionGroups > hourWageCalculations property as it is now possible to have multiple wage calculations for a function group. Also the boolean if it has an hourWageCalculation is moved to the new property inside functionGroups.
    • Removed property: wageIncrements > periodicalData
      • experienceMimimumAmount - this is renamed to experienceMinimumAmount to correct a typo
      • experienceMimimumAmountType - this is renamed to experienceMinimumAmountType to correct a typo
    • Removed property: untaxedExpenses - this is renamed to expenses as they can also be taxed now. So the naming didn't make sense anymore.
      • hasUntaxedExpenses - this is renamed to hasExpenses as they can also be taxed now. So the naming didn't make sense anymore.
      • expensesData - this is renamed to expenses as it's more a list than general data.
        • untaxedExpensesDropdownID - this is renamed to expenseID as they can also be taxed now. So the naming didn't make sense anymore and the dropdown postfix could be confusing.
      • yearEndBonus
        • hasYearEndBonus - this is moved to the expenses property as it's a property of the remuneration expenses and not of the year-end bonuses

Version 3.1.0 (10-10-2023)

Added

  • Webhook: A remuneration is published to your company
  • Webhook: Event to test if the webhook is working
  • Endpoint: List functions published in remunerations from given company (/function/{companyID}/{partnerID})
  • Endpoint: Get function published in remunerations from given company (/function/{companyID}/{partnerID}/{functionID})
  • Endpoint: Create an invitation to share remuneration data (/invitation/{companyID})
  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Added property: functionGroups > functions
      • referenceTitleDropdownID (ID of the reference function title)

Changed

  • Body: /remuneration/{companyID}/{partnerID}/{remunerationID}/{version}
    • Changed property: publishDate (value format changed)