Releases YouServe API's

Information about new features, bugfixes and other news on the File API.

Information about new features, bugfixes and other news on the YouServe developer portal.

2024-06-24 - API enhancements The following enhancements are now available: Extend candidate model with 30 custom fields CustomFields are string. Allow up to 100Mb for the whole request

  08-05-2024: History days on leave and leave balance data As described in the documentation of the API for BI systems, history data of max 4 years are made available.  Recently we learned that this limitation was not in place for the datatypes leave (NL: verlofaanvraag) and leave balance (NL: verlofbalans). In stead, all data was delivered.   On 15-5-2024 we will release a fix to align the history data also for leave and leave balance.   Leave After the fix only leave periods are delivered which are within scope of 4 years. If a leave period starts before the scope of 4 years, but ends after, it will still be delivered.   Leave balances After the fix only leave periods are delivered which are within scope of 4 years. Most likely, leave entitlements start on the first of January. So if data is retrieved today (8-5-2024), taken in account that leave balance starts on first of January, the leave balance of 2020 up and till 2024 is delivered.  

Release notes of MLM API are published in this article, ordered by release date.

Update (21-8-2023, 1pm) The upgrade is finished.    Original message: On the 21st of August 2023, we will upgrade our Service Gateway tooling. This will cause downtime of all our API's starting at 11am. We expect the API's to be unavailable for a few hours. When the API's are available again, we will give an update.   Q&A Why do we need to upgrade? The upgrade is mandatory while the old version from our third party will no longer be supported soon. The new version will also bring advantages to handle the backend of the APIs.   Why do we do this during office hours? We are running this update during business hours, because APIs are system to system connections, not bound to office hours. On the other hand, delivering support for migrations is much easier during office hours.   What can you do if you experience connection issues after 11am on 21st of August? Please revisit this message to check for updates. If the upgrade is not finished yet, please wait till the upgrade is finished. If the upgrade is finished and you experience connection issues, please contact our Service Desk or known communication channels.

19-05-2023: Added 7 Belgian custom fields Employees endpoint - The following custom fields were added as part of the extensions of the contract: BirthcountryBE - Geboorteland [BE] - 10528257 Nationality - Nationaliteit - 10519287 CountryBE - Woonland [BE] - 10528256 FunctionLevelBE - Functieniveau [BE] - 10528456 DepartureReasonBE - Reden ontslag [BE] - 10528258 HospitalisationInsurancep18 - Hospitalisatieverzekering +18 [BE] - 10528431 HospitalisationInsurancem18 - Hospitalisatieverzekering -18 [BE] - 10528432 Endpoint documentation is updated.

We follow current industry standards and best practices. Authentication/authorization is no exception. As part of the Identity and Access Management Strategy for system-to-system integrations, our APIs are based on  OAuth 2.0 and the authorization grant Client Credentials. Every API consumer system will be provisioned in our API Gateway as a Client Application (App). API key (client_id) and Secret key (client_secret) will be provided to be used by Apps as credentials. Apps will be able to authenticate and get an access token (JWT) within the response payload. Subsequent request authorization will be based on that access token previously retrieved.     A detailed explanation is available in our knowledge base.   Additional security level: Secured OAuth2 flow with client private key Demands for security measures are always increasing. Upon the existing authentication, we have added an extra security level: Secured OAuth2 flow with client private key. With this addition, the identification with API key (client_id) and Secret key (client_secret) is replaced by an API Key (client_id) + client_assertion (private key) which will be verified with a stored public key. The access token (JWT) will be delivered and can be used to retrieve data.      A detailed technical explanation of how to use the increased security level is available in our knowledge base. If you want to start using the increased security level, please contact your account manager or Service Delivery Manager.    

  22-03-2023: property employmentIndicator added to Employments endpoint Persons endpoint - The property employmentIndicator is added to the Employments endpoint.  Endpoint documentation is updated.   23-01-2023: property Identity added to Persons endpoint Persons endpoint - The property Identity is added to the Persons endpoint.  Endpoint documentation is updated.   3-10-2022: new endpoint LeaveBalances We have added 1 more endpoint to the WFM API: LeaveBalances. This new endpoint is available for all WFM API consumers. The LeaveBalances endpoint delivers information about  leave entitlement and the leave taken. Learn more about this endpoint in our knowledge base.   23-8-2022: change fields PersonId/Personcode The properties PersonId and Personcode did not refer to the same source in HR Core Business throughout the WFM API. Sometimes the property PersonId refered to the UPI, sometimes to the Personcode. Same for the property Personcode. To have a logical and more intuitive explanation of the properies, we have synchronized the mapping throughout the WFM API.   The PersonId and Personcode is synchronized for all endpoint in WFM API: PersonId - refers to the UPI (NL: Uniek Persoonlijk Id) in HR Core Business PersonCode  - refers to the Person code (NL: Persoonscode) in HR Core Business This change has no impact for consumers of the WFM API. When the Person layer is enabled in HR Core Business (requirement for normal usage of WFM API), these values are the same. Therefore, switching the mapping in the WFM API has no impact for WFM API consumers.      19-07-2022: change of description of leaveBalancesPayroll endpoint LeaveBalancesPayroll endpoint - The HR Core Business example of Id property has changed.   Old text: id - Combined field of: [PersonId] +  [Payroll year] + [Payroll period] ... New: id - Combined field of: [EmployeeId] +  [Payroll year] + [Payroll period] ... The description of the user endpoint : WFM LeaveBalancesPayroll endpoint.   13-07-2022: Leaves endpoint Three more endpoints are added to the WFM API: Leaves, LeaveTypes, LeaveReasons. Learn more about these endpoints in our knowledge base.     13-05-2022: managerPersonCode removed from endpoint OrganizationUnits The property managerPersonCode is removed from endpoint OrganizationUnits. Although described in the documentation and swagger, the property was never supported and has the same value as managerPersonId. Documentation and swagger page are adjusted. To Identify the manager of a organizationalUnit, the property managerPersonId can be used. Description of endpoint: OrganizationUnits    

Extra fields endpoints Employees & Contracts We’ve added two fields "noRisk" & "endDateNoRisk" to the endpoint /contracts & /employees (V1 / V2) related to the data of HR coresystem HRCB (r1). In this HR core system users are able to manage the following WIA / no-risk related elements :   The field ‘No Risk polis van toepassing' is a dropdown with the options Ja/Nee. The field 'Einddatum no risk periode’ is a date field. For sharing this relevant information to external MLM systems / UWV, we’ve added two extra fields in the /contracts & /employees endpoints of the MLM API: noRisk (boolean field) > mapped to ‘No Risk polis van toepassing'. endDateNoRisk (date field) > mapped to ‘Einddatum no risk periode'. Latest version endpoint /contracts : (see row 25 & 26) [ { "validFrom": "2021-06-10T06:24:53.362Z", "validUntil": "2021-06-10T06:24:53.362Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "isDeleted": true, "employeeCode": "string", "personId": "string", "contractCode": "string", "originalHireDate": "2021-06-10T06:24:53.362Z", "dischargeDate": "2021-06-10T06:24:53.362Z", "hireDate": "2021-06-10T06:24:53.362Z", "company": "string", "employmentType": "string", "contractType": "string", "jobProfile": "string", "organizationUnit": "string", "fullTimeWorkingAmount": 0, "noRisk": true, "endDateNoRisk": "2021-06-10T06:24:53.362Z", "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" } } ]     Latest version endpoint /employees : (see row 78 & 79) [ { "validFrom": "2021-06-10T06:25:58.121Z", "validUntil": "2021-06-10T06:25:58.121Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "personCode": "string", "isDeleted": true, "initials": "string", "firstNames": "string", "knownAs": "string", "lastNameAtBirth": "string", "lastNameAtBirthPrefix": "string", "lastName": "string", "lastNamePrefix": "string", "nameAssembleOrder": "string", "partnerName": "string", "partnerNamePrefix": "string", "titlePrefix": "string", "titleSuffix": "string", "gender": "string", "birthDate": "2021-06-10T06:25:58.121Z", "deceasedDate": "2021-06-10T06:25:58.121Z", "nationalIdentificationNumber": "string", "userUID": "string", "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "addresses": [ { "type": "string", "streetName": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" } ], "contracts": [ { "validFrom": "2021-06-10T06:25:58.121Z", "validUntil": "2021-06-10T06:25:58.121Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "isDeleted": true, "employeeCode": "string", "personId": "string", "contractCode": "string", "originalHireDate": "2021-06-10T06:25:58.121Z", "dischargeDate": "2021-06-10T06:25:58.121Z", "hireDate": "2021-06-10T06:25:58.121Z", "company": "string", "employmentType": "string", "contractType": "string", "jobProfile": "string", "organizationUnit": "string", "fullTimeWorkingAmount": 0, "noRisk": true, "endDateNoRisk": "2021-06-10T06:25:58.121Z", "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" } } ] } ]   By using the fields ‘No Risk polis van toepassing' & 'Einddatum no risk periode’ in the above screen of HRCB the ‘sickleave coordinators' of our customers can manage all fields for administrative purposes. Only the red alligned elements are exposed to the MLM API for external sharing reasons.

Extra fields endpoint Sickleaves We’ve added two fields "internalFollowUp" & "additionalNote" to the endpoint /sickleaves. HR coresystem HRCB (r1) added these two elements in the front-end application, see below :      By using the fields Actielijst & Korte notitie on the sickleave screen of HRCB the ‘sickleave coordinators' of our customers can select the necessary follow-up activities in the core system.The follow-up values are flexible configurable per client / tenant via Waardelijsten / Valuelists. The field Korte notitie can process up to 100 characters. Because of this we’ve added two extra fields in the /sickleaves endpoint of the MLM API: internalFollowUp (string) > mapped to ‘Actielijst’. Provides a code. Via /valuelists the corresponding values can be retrieved. additionalNote (string) > mapped to ‘Korte notitie’. Latest version endpoint /sickleaves :   [ { "id": "string", "isDeleted": true, "personId": "string", "contractId": "string", "reportingDate": "2021-05-11T09:25:42.632Z", "startDate": "2021-05-11T09:25:42.632Z", "hoursWorkedFirstDay": 0, "sicknessType": "string", "absenceReason": "string", "recoveryDate": "2021-05-11T09:25:42.632Z", "expectedRecoveryDate": "2021-05-11T09:25:42.632Z", "recourse": true, "ongoingSickness": true, "safetynet": "string", "dateWVP": "2021-05-11T09:25:42.632Z", "urgentCheckRequired": true, "expectedFinalResult": "string", "finalResult": "string", "internalFollowUp": "string", "additionalNote": "string", "partialRecoveries": [ { "illnessPercentage": 0, "startDate": "2021-05-11T09:25:42.632Z" } ], "nursingAddresses": [ { "startDate": "2021-05-11T09:25:42.632Z", "endDate": "2021-05-11T09:25:42.632Z", "nameCareAddress": "string", "streetName": "string", "number": "string", "numberAdditional": "string", "postcode": "string", "city": "string", "country": "string", "phoneNumber": "string", "faxNumber": "string", "emailAddress": "string", "region": "string", "locationDesignation": "string" } ], "therapeuticPeriods": [ { "startDate": "2021-05-11T09:25:42.632Z", "endDate": "2021-05-11T09:25:42.632Z", "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" }, "workingPercentage": 0 } ], "extensions": [ { "key": "string", "value": "string" } ] } ]     To use these extra elements, a full load in the API is needed!

Extra field endpoint RoleAssignments For the client in our core system HR Core Business there’s a possibility to mark the level of authorisation of a specific Role Assignment. Some roles within an organisation might have more permissions to see or manage processes. In HR Core Business users can manage this via the field ‘Incl. onderliggende OE’s' :     Since 25-Mar '21 the MLM API will also expose this property in the output results of the RoleAssignments endpoint. The name is "includingChildOrgUnits" and will expose the values true / false. The endpoint will look like : [ { "id": "string", "shortName": "string", "fullName": "string", "organizationUnitId": "string", "personId": "string", "employeeId": "string", "includingChildOrgUnits": true, "isDeleted": true, "startDate": "2021-03-22T16:41:38.887Z", "endDate": "2021-03-22T16:41:38.887Z", "extensions": [ { "key": "string", "value": "string" } ] } ]      

Release field “fullTimeWorkingAmount” In January we’ve improved the field “fullTimeWorkingAmount”, which indicates the full-time hours per period within a specific company. For example 40 or 36 hours per week. This field is now finally released to the PROD environments of the MLM API. In December 2020 this field was already correctly shown in the endpoint: Endpoint /companies [ { "validFrom": "2021-03-22T16:33:20.583Z", "validUntil": "2021-03-22T16:33:20.583Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "code": "string", "name": "string", "totalWorkAmount": "string", "establishmentCountry": "string", "isDeleted": true, "address": { "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "mailingAddress": { "boxNumber": "string", "postalCode": "string", "cityTown": "string" } } ]     In January 2021 we’ve corrected the position in the different body responses of other endpoints. Until Dec-2020 the field “fullTimeWorkingAmount” was part of the Person data details. However, the values of this specific field belong to contracts/employments. That’s why we’ve added the field to the endpoints: Endpoint /contracts [ { "validFrom": "2021-03-22T16:34:23.131Z", "validUntil": "2021-03-22T16:34:23.131Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "isDeleted": true, "employeeCode": "string", "personId": "string", "contractCode": "string", "originalHireDate": "2021-03-22T16:34:23.131Z", "dischargeDate": "2021-03-22T16:34:23.131Z", "hireDate": "2021-03-22T16:34:23.131Z", "company": "string", "employmentType": "string", "contractType": "string", "jobProfile": "string", "organizationUnit": "string", "fullTimeWorkingAmount": 0, "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" } } ] Endpoint /employees [ { "validFrom": "2021-03-22T16:36:27.514Z", "validUntil": "2021-03-22T16:36:27.514Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "personCode": "string", "isDeleted": true, "initials": "string", "firstNames": "string", "knownAs": "string", "lastNameAtBirth": "string", "lastNameAtBirthPrefix": "string", "lastName": "string", "lastNamePrefix": "string", "nameAssembleOrder": "string", "partnerName": "string", "partnerNamePrefix": "string", "titlePrefix": "string", "titleSuffix": "string", "gender": "string", "birthDate": "2021-03-22T16:36:27.514Z", "deceasedDate": "2021-03-22T16:36:27.514Z", "nationalIdentificationNumber": "string", "userUID": "string", "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "addresses": [ { "type": "string", "streetName": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" } ], "contracts": [ { "validFrom": "2021-03-22T16:36:27.514Z", "validUntil": "2021-03-22T16:36:27.514Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "isDeleted": true, "employeeCode": "string", "personId": "string", "contractCode": "string", "originalHireDate": "2021-03-22T16:36:27.514Z", "dischargeDate": "2021-03-22T16:36:27.514Z", "hireDate": "2021-03-22T16:36:27.514Z", "company": "string", "employmentType": "string", "contractType": "string", "jobProfile": "string", "organizationUnit": "string", "fullTimeWorkingAmount": 0, "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" } } ] } ]    

  Field “fullTimeWorkingAmount” We’ve improved the field “fullTimeWorkingAmount”, which indicates the full-time hours per period within a specific company. For example 40 or 36 hours per week. This field was already correctly shown in the endpoint: Endpoint /companies [ { "validFrom": "2021-01-12T19:49:43.484Z", "validUntil": "2021-01-12T19:49:43.484Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "code": "string", "name": "string", "totalWorkAmount": "40", "establishmentCountry": "string", "isDeleted": true, "address": { "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "mailingAddress": { "boxNumber": "string", "postalCode": "string", "cityTown": "string" } } ] We’ve corrected the position in the different body responses of other endpoints. Until Dec-2020 the field “fullTimeWorkingAmount” was part of the Person data details. However, the values of this specific field belong to contracts/employments. So, that’s why we’ve added the field to the endpoints: Endpoint /contracts { "validFrom": "2021-01-12T19:51:10.147Z", "validUntil": "2021-01-12T19:51:10.147Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "isDeleted": true, "employeeCode": "string", "personId": "string", "contractCode": "string", "originalHireDate": "2021-01-12T19:51:10.147Z", "dischargeDate": "2021-01-12T19:51:10.147Z", "hireDate": "2021-01-12T19:51:10.147Z", "company": "string", "employmentType": "string", "contractType": "string", "jobProfile": "string", "organizationUnit": "string", "fullTimeWorkingAmount": 0, "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" } } Endpoint /employees { "validFrom": "2021-01-12T19:52:29.217Z", "validUntil": "2021-01-12T19:52:29.217Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "personCode": "string", "isDeleted": true, "initials": "string", "firstNames": "string", "knownAs": "string", "lastNameAtBirth": "string", "lastNameAtBirthPrefix": "string", "lastName": "string", "lastNamePrefix": "string", "nameAssembleOrder": "string", "partnerName": "string", "partnerNamePrefix": "string", "titlePrefix": "string", "titleSuffix": "string", "gender": "string", "birthDate": "2021-01-12T19:52:29.217Z", "deceasedDate": "2021-01-12T19:52:29.217Z", "nationalIdentificationNumber": "string", "userUID": "string", "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "addresses": [ { "type": "string", "streetName": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" } ], "contracts": [ { "validFrom": "2021-01-12T19:52:29.217Z", "validUntil": "2021-01-12T19:52:29.217Z", "extensions": [ { "key": "string", "value": "string" } ], "id": "string", "isDeleted": true, "employeeCode": "string", "personId": "string", "contractCode": "string", "originalHireDate": "2021-01-12T19:52:29.217Z", "dischargeDate": "2021-01-12T19:52:29.217Z", "hireDate": "2021-01-12T19:52:29.217Z", "company": "string", "employmentType": "string", "contractType": "string", "jobProfile": "string", "organizationUnit": "string", "fullTimeWorkingAmount": 0, "phoneNumbers": [ { "type": "string", "number": "string" } ], "emailAddresses": [ { "type": "string", "address": "string" } ], "workingAmount": { "amountOfWork": 0, "unitOfWork": "string", "periodOfWork": "string" } } ] } System HR Core Business The values related to these HRCB clients were “0” until December 2020. In January 2021 we’ve improved the extraction of these values. System HR Core Online (BO4) The values related to these BO4 clients were empty until December 2020. We’ve improved the data extraction from BO4 system and the calculation behind it. Now the field “fullTimeWorkingAmount” will show the correct values from BO4. Extra field “Meerling” endpoint Maternity Leaves For both core systems HRCB and HR Core Online (BO4) we’ve added the field “multipleBirthIndication” to the endpoint Maternity Leaves. In case more than one child is expected, this can be defined in both core systems (field name in core systems: Meerling). Value “true” indicates that Multiple births are expected for this specific Maternity Leave case. Endpoint Maternity Leaves { "id": "string", "isDeleted": true, "personId": "string", "contractId": "string", "reportingDate": "2021-01-12T19:36:56.808Z", "startDate": "2021-01-12T19:36:56.808Z", "firstWorkingDay": "2021-01-12T19:36:56.808Z", "probableDeliveryDate": "2021-01-12T19:36:56.808Z", "actualDeliveryDate": "2021-01-12T19:36:56.808Z", "multipleBirthIndication": true, "extensions": [ { "key": "string", "value": "string" } ] } Extra filter on active & inactive sickness records For the endpoint /sickleaves there an additional (optional) filter available. The extra parameter is could be added while fetching all sickness records within a tenant/client. By default, the base URL of this endpoint will expose all available sickness records (active & inactive) within the specific client data set. By adding the active filter to the base URL of this endpoint, the response output will only show the current active records corresponding to this client. For example : https://api.raet.com/mlm/sickleaves?active=true Extra filter option based on ‘level’ For the endpoints /valuelists & /jobprofiles we’ve made it possible to execute an extra (optional) filter on the exposed data records. The body responses of both endpoints already expose a field “level”, which indicates the level this Job Profile or Valuelist is configured in the core system, for example, “client”, “company” or “system” level. By default the base URLs of these endpoints will expose all available jobprofile & valuelist records within the specific client data set. Example endpoint /jobprofiles { "validFrom": "2018-10-17", "validUntil": "9999-12-31", "extensions": [ { "key": "null", "value": "null" } ], "id": "AA123", "fullName": "receptionist", "level": "company", "companyCode": "20114", "isDeleted": false } By adding the level filter to the base URL of these two endpoints, the response output will only show the records corresponding to this level. For example : https://api.raet.com/mlm/jobprofiles?level=Company

04-09-2024: fix retention time ..

2021-07 Increase of performance From 5th of July up and till 9th of July a technical update on the IAM API will be deployed. The technical update will result in faster responses of the IAM API endpoints. To roll out this technical update to all consumers of the IAM API, a reload of data from HR Core to the API platform is needed for each consumer of the API. During this reload, you might receive an error on the endpoints. This is only temporarily. Please try again after some minutes.   2021-08 Clean-up process for historical records On daily base the system will clean-up the API data for historical records in the API. This clean-up process will remove all versions older than the default retention time of 90 days and also remove old-employees with a discharge date before this 90 days criteria.  Note:  It's possible that some customers deviate their retention of the historical records and keep them longer than the default 90 days.  With the new clean-up mechanism we will respect the retention time as is configured for the customer.

2020-10 The IAM API has been expanded with the following endpoint: Employments: The employments endpoint returns employments based on id. The following filters are supported PersonCode PersonId Company OrganizationUnit validFrom validUntil mutation retrieval based on from and to dates 2020-11 Persons endpoint The IAM API has been expanded with the following endpoint: Persons The persons endpoint returns employee personalia data based on id. Value list endpoint The value list endpoint now supports filtering based on configuration levels. As part of HRCB customers are able to configure value list properties on different levels. The new filtering allows to retrieve value list based on: levels companyCode Job profiles endpoint The job profiles endpoint now supports filtering based on company codes. The new filtering allows to retrieve job profiles based on: companyCode    

2020-08-20 - API enhancements The following enhancements are now available: Record versions (validFrom / validUntil) in all endpoints With this release we we support record version in every endpoint. Even if the the Core system doesn’t support record versioning, like HR Core Beaufort, we add default value for the  validFrom  and  ValidUntil  attributes. The default for  ValidFrom  is '0001-01-01' and the default  validUntil  is '9999-12-31'. Delete flag for delete records If a record is deleted in the core system, a  isDelete = true attribute is set in the API. Based on this information you can delete the record as well in your own system. Delete means that the whole entity is deleted and not just one version. "id": "907624", "isDeleted": true, "shortName": "907624" } ]]> Note: Delete means that we delete the whole record and not just a version. ID attribute in Job profile was missing In the Job Profile endpoint an  ID  was missing. In this release we add the  ID  field to the Job Profile as well. For Job profile the  ID  and  shortName  contains both the same value. Example of the ID and the validFrom and validUntil in the Job profile endpoint { "id": "723912", "shortName": "723912", "fullName": "Business Analyst", "jobFamily": "Software", "validFrom": "0001-01-01", "validUntil": "9999-12-31" } ] ]]> Manager in organization Unit endpoint (HRCB Business only) For HR Core Business the manager was missing in the organization unit endpoint. In this release we add the manager field to the organization unit endpoint. Note: For HR Core Beaufort the manager is part of the endpoint role assignment with role type = MGR UserUID for Single Sign On as part of the employee endpoint In this release we add the  userUID  as part of the employee endpoint. The  userUID  can be used for the Single Sign On solution of Visma Raet. { "id": "79500", "personCode": "79500", "initials": "HJB", "firstNames": "Herbert Jacob Bert", "knownAs": "Herbert", "lastName": "Robles", "lastNameAtBirth": "Robles", "nameAssembleOrder": "E", "gender": "Male", "birthDate": "1989-03-02", "deceased": false, "userUID": "3d89f34f-9fd8-41c4-8d63-09051a470591", "employments": [ { "employmentCode": "1", "hireDate": "2020-01-01", "employmentType": "005", "originalHireDate": "2020-01-01", "jobProfile": "8302", "organizationUnit": "1867", "workingAmount": { "amountOfWork": 36, "unitOfWork": "Hours", "periodOfWork": "Week" } } ], "validFrom": "1900-01-01", "validUntil": "9999-12-31" }]]> 2020-08-19 - Employee endpoint includes also address details and original hire date The address details and the original hire date are also added to the employee endpoint.   "id": "79505", "personCode": "79505", "initials": "J", "firstNames": "Jos", "knownAs": "Josje", "lastName": "Janssens", "lastNameAtBirth": "Janssens", "nameAssembleOrder": "E", "gender": "Female", "addresses": [ { "type": "Home", "street": "Computerweg", "houseNumber": "99", "postalCode": "3822CM", "city": "AMERSFOORT", "country": "NED" }, { "type": "Postal", "street": "Computerweg", "houseNumber": "99", "postalCode": "3822CM", "city": "AMERSFOORT", "country": "NED" } ]]> 2020-07-01 - Learning API Controlled available The Learning API is controlled available. The API supports endpoints for: Getting employee data from HR Core systems like HR Core Beaufort and HR Core Business Upload diplomas or certificates to the Personal File System of Visma Raet (Personeelsdossier) 2021-03-23 -  Uploading certificates for HRCB customers is available Uploading certificates in the Learning API was previously working only for HR Core Beaufort customers. Now is also available for HRCB customers. 2021-03-29 -  Job family code in job profile The job family code is now available as part of the job profile data. 2021-04-08 -  Performance improvements Performance improvements in queries. 2021-04-16 - Job familiy reference list is available The endpoint for getting the job family reference list is available. 2021-05-05 -  Fixed issue with the changedUntil parameter The changedAfter parameter can be used now without the changedUntil parameter. Search with the changedUntil parameter is working now without the changeAfter parameter.   2022-03-16 Communication Language added as part of employee data The communication language is now available as part of the employee data.   2024-02-27 Manager person code added as part of Organizational Unit The manager person code is now available as part of the organizational unit data.     Please read the documentation and the FAQ if you have questions about “How to use this API”.