Zoeken
Mijn Communities
Help

MLM API - Endpoints

31-01-2022 11:14 (Bijgewerkt op 27-03-2024)
  • 0 Antwoorden
  • 1 kudos
  • 3281 Weergaven

 

Swagger documentation

The following swagger page gives an overview of the endpoints:

Older versions:

Endpoints

Companies

The entity Companies contains data related to the existing sub-companies within a tenant/client.
https://api.youserve.nl/mlm/companies 

 

Filters

Single company - Retrieve specific company by adding the id of the company.

GET https://api.youserve.nl/mlm/companies/<id>

 

Companycode - Retrieve specific company by filtering on companycode.

https://api.youserve.nl/mlm/companies?companyCode=<companyCode>

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. 

By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/companies?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T...

Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

 

Data mapping

PI field

Description

Example

HR Core Business (r1)

Id

Technical and unique Id for a company. The Id is unique within the entity and tenant. The Id is generated by the system and can not be changed by a user.
35146808

mutKey of company

code

Code of company

500

Company code

NL: Bedrijfscode

name

Name of the company

Icommus

Company name

NL: Bedrijfsnaam

totalWorkAmount

Indicates the full-time hours per period within a specific company. For example 40 or 36 hours per week.

40

Hours period

NL: Uren periode

Element nr: 465
establishmentCountry

Country of company

NL

Country of establishment

NL: Vestigingsland bedrijf

Element nr: 10525700
address: street

Street of company
Icommuslaan

Street

NL: Straat

Element nr: 29
address: houseNumber

house number of company
500

House number

NL: Huisnummer

Element nr: 30
address: houseNumberAddition

addition to house number of company
a

House number addition

NL: Huisnummer toevoeging

Element nr: 31
address: postalCode

postal code of company
5050 IC

Postal code

NL: Postcode

Element nr: 32
address: city

city of company
Amsterdam

Municipality

NL: Woonplaats

Element nr: 33
address: country

 
 

 
mailingAddress: boxnumber
  boxnumber of company  6060

P.O. box

NL: Postbus

Element nr:  446
mailingAddress: postalCode
 Post code of boxnumber of company 6060 AB

Post code P.O. box address

NL: Postcode postbusadres

Element nr: 447
mailingAddress: cityTown

city of boxnumber of company

Amsterdam

Town P.O. box address

NL: 
Woonplaats postbusadres

Element nr: 448

validFrom

Startdate of the timeslice/version of a record.

2024-01-01

Referencedate

NL: Peildatum

validUntil

Enddate of the timeslice/version of a record.
The enddate is the (validFrom-1) of the successive version. If no successive version is available then value is 9999-12-31.

9999-12-31
2024-12-31

 N/A
isDeleted

Provide the active/inactive status of the record in the core system.

false

 N/A

Extensions are not supported in companies endpoint.

 

Contracts

The endpoints /employees and /contracts exposes all the corresponding details of a contract belonging to an employee. (HR Core Business: "Medewerker > Contract").

To retrieve the list of all available contracts within a tenant the Contract endpoint can be used without using any additional parameters.

https://api.youserve.nl/mlm/contracts

 

Filters

Single employment - Retrieve specific employment by adding the id of the employment.

https://api.youserve.nl/mlm/contracts/<contractid>  

 

PersonId - In case all contracts from a specific person are needed, this can be retrieved based on the “personId”

https://api.youserve.nl/mlm/contracts?personId=<personId>

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/contracts??ChangedAfter=2023-01-01T10:00:00.000Z&ChangedUntil=2023-06-01...

Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

 

API field

Description

Example

HR Core Business (r1)

Id

Technical and unique Id for a contract. The Id is unique within the entity and tenant. The Id is generated by the system and can not be changed by a user.

23456789

49 - Mutkey of the contract

validFrom

Startdate of the timeslice/version of a record.

2024-01-01

Reference date / Peildatum (NL)

validUntill

Enddate of the timeslice/version of a record.
The enddate is the (validFrom-1) of the successive version. If no successive version is available then value is 9999-12-31.

9999-12-31

2024-12-31

 

isDeleted

Provide the active/inactive status of the Contract in the core system.

False

 

personId

The Id of a unique person within a tenant.

10056832

10519680 - personNumber

employeeCode

Logical code of the employee or employment (reference).

01

22 - Medewerkercode

contractCode

Code of the contract.

01

91 - Contract Id

company

Unique (alphanumeric) code of the company (legal entity) with which the contract is concluded.

004

18 - Company code

companyId

Unique (numeric) identifier of the company
11058330

mutkey of company

originalHireDate

The first hire date of original hire date of an employee within the organization. This date is important for the tenure or working anniversary of an employee.

2010-10-01

308 - Datum indienst organisatie

dischargeDate

The end date/discharge date of the employment. This is always an ‘up to and including’ date. The field will always be in the response, even if the field is not filled.

2025-12-31

10520479 - Geplande laatste datum indienst

hireDate

The hire date of the employment.

2010-10-01

39 - Datum indienst

employmentType (V)

Type of employment like Internal Employee, Contractor, Wachtgelder

shortName: Code or short name of the employment type
fullName: name or full title of the employment type

CNTR

7393 - Type Medewerker

contractType (V)

Type of the contact like indefinite period ('onbepaalde tijd') or given time ('bepaalde tijd').

Bepaalde tijd

10204687 - Contract type

jobProfile

Official job title or job profile of the employment. The Job profile contains the following details: shortName > Code or short name of the job profile.

DEV

97 - Functie

organizationUnit

Official organization unit of employment. The Organization Unit contains the following details: reference Id to the OrgUnit.
ShortName: Code or short name of the organization Unit

PD

6000 - Organisatorische eenheid
fullTimeWorkingAmount

Indicates the full-time hours per period within a specific company. For example 40 or 36 hours per week.

 36

Uren periode (465). NB: confingured on company level. 
noRisk

indicator of noRisk status

false (default)

 No Risk polis van toepassing
endDateNoRisk

Last date of noRisk status
2025-12-31
 Einddatum no risk periode

phoneNumbers: type

type

 

  

phoneNumbers: number

number

088-1004300

Business : 7374 - Telefoonnummer intern

emailAddresses: type

type

 

  

emailAddresses: address

address

AnneMarie@work.com

Business : 7212 - E-mailadres

workingAmount:  amountOfWork

Indicates the full-time hours per period for this employment

36

465 - Uren periode

workingAmount:  unitOfWork (V)

Indicator of unit type of amount of work

Hours

 

workingAmount : periodOfWork (V)

Indicates the period for which amountOfWork and unitOfWork are defined

1

463 - Dagen/uren per

1 = "Week"
2 = "FourWeeks"
3 = "Month"
4 = "Quarter"
establishmentCode

The location at which the employment is being fulfilled

1

7449 - Werklocatie
expireDate

 Date when the employment will expire

2025-12-31

7226 - afloopdatum
employmentIndicator

 Indicates if employment is employed or out of service

1

38 - Dienstverband indicatie

1) Employed / In Dienst

2) Out of Service / Uit Dienst
parttimeFactor

 

1

10002071
extensions: key

Extra customer specific data can be added with extensions.
extensions: value

 

Employees

This endpoint will return unique persons with their associated contracts. 

Only the current active version of the person with its contracts is returned.

If person has only contracts in the future, this will be returned.

If person only has active contract in the past, the last contract is returned.
Details we’ll expose are personal details, partner details, contact information, and the latest address details. 

 

To fetch the list of all employees (persons with contracts) within a tenant the Employee endpoint can be used without using any additional parameters.

https://api.youserve.nl/mlm/employees 

 

Filters

PersonId/ PersonCode - In case specific person incl. contract records are needed, this can be retrieved based on the “personId” or “personCode”.

https://api.youserve.nl/mlm/employees/<personId> 
https://api.youserve.nl/mlm/employees?personCode=<personCode> 

 

When person layer is enabled in HRCore Business, the PersonId is equal to PersonCode. If so, personId can also be used in filtering:

https://api.youserve.nl/mlm/employees?personCode=<personId> 

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. 

https://api.youserve.nl/mlm/employees?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

Data mapping

Data from Persons and Contracts endpoint is combined in the Employees endpoint. Please check data mapping with Persons and Contracts endpoint for data mapping of Employees endpoint.

 

Jobprofiles

This endpoint returns all the relevant data regarding the job profiles, like Job family information & Job profile descriptions.

https://api.youserve.nl/mlm/jobprofiles


JobProfiles can be configured on different levels in the core system, on ‘client level’ or on 'company level'. The endpoint will provide details regarding the the level.

In case a JobProfile belongs to a specific subcompany of a client, the response will also show the corresponding “companyCode”. (Dutch: "Functie informatie")

 

Output example 1 : JobProfile on client (tenant) level

{
 "validFrom": "2024-01-01",
 "validUntil": "9999-12-31"
 "extensions": [],
 "id": "45",
 "fullName": "Functie 45",
 "level": "client",
 "isDeleted": false
 }

Output example 2 : JobProfile on company level

{
 "validFrom": "2024-01-01",
 "validUntil": "9999-12-31"
 "extensions": [],
 "id": "185",
 "fullName": "Functie 185",
 "level": "company",
 "companyCode" : "3511"
 "isDeleted": false
 }

 

 

Filters

Single job profile - Retrieve 1 jobProfile by adding the id of the jobprofile.

https://api.youserve.nl/mlm/jobprofiles/<id>  

 

Level - Filter out specific Job Profiles corresponding to a specific “level”.

https://api.youserve.nl/mlm/jobprofiles?level=client

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/jobprofiles?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

 

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

API field

Description

Example

HR Core Business (r1)

id

 

123

Mutkey of jobprofile 4

fullName

The full name of the Job Profile.

Developer02

97 - DEVV. FLDDES

level

Indicates the level in the core system where the job profile is configured (“client” level or “company” level).

Client

Company

 

companyCode

In case the level is indicated as “company”, the API expose also the corresponding “companyCode”. In case the Job Profile is configured at “client” level, the value of this field is “NULL” and will not be shown in the API response.

50320014

 

isDeleted

Provide the active/inactive status of the record in the core system.

False

 

validFrom

Startdate of the timeslice/version of a record.

2024-01-01

Reference date / Peildatum (NL)

validUntil

Enddate of the timeslice/version of a record. The enddate is the (validFrom-1) of the successive version. If no successive version is available then value is 9999-12-31.

9999-12-31

9999-12-31
2024-12-31

Extensions are not supported in this endpoint.

 

Maternityleaves

This endpoint will provide all the needed data regarding Maternity Leave of an employee.

https://api.youserve.nl/mlm/maternityleaves

 

Filters

Single maternity leave - Retrieve specific maternity leave by adding the id of the leave.

https://api.youserve.nl/mlm/maternityleaves/<id>  

 

PersonId - In case all maternityleaves of a specific person are needed, this can be retrieved based on the “personId”

https://api.youserve.nl/mlm/maternityleaves?personId=<personid>  

 

ContractId - In case all maternityleaves of a specific contract are needed, this can be retrieved based on the “contractId”

https://api.youserve.nl/mlm/maternityleaves?contractId=<contractid>  

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/sickleaves?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

 

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

API field

Description

Example

HR Core Business (r1)

Id

Technical and unique ID of the maternity leave case. This ID is unique within the entity and tenant. The ID is generated by the system and can not be changed by a user.

4320628

7593 - Key of the maternity

isDeleted

Provide the active/inactive status of the record in the core system.

False

 

personId

The Id of a unique person within a tenant.

10056832

10519680 - personNumber

contractID

Technical and unique ID. This ID is unique within the entity and tenant. The ID is generated by the system and can not be changed by a user.

34567

49 - Key of the contract

reportingDate

The recovery date is defined as the first day the employee appears at his work after a maternity period.

(date)

7595 - Datum melding

startDate

Start date of the maturity leave.

(date)

7594 - Begindatum verlof / WAZO

actualDeliveryDate

The actual date of birth of the child.

(date)

7599 - Feitelijke bevallingsdatum

firstWorkingDay

The first day the employee appears at his work after the maturity leave period.

(date)

7596 - Eerste werkdag

probableDeliveryDate

The probable date of delivery.

(date)

7598 - Vermoedelijke bevallingsdatum

multipleBirthIndication

In case more then one child is expected, this can be defined in both core systems. Value “true” indicates that a Multiple birth is expected for this specific Maternity Leave case.

false / true

7350 - Meerling

Extensions are not supported in this endpoint.

 

Organization Units

This endpoint will provide organization Units 

(HRCore Business: "Instellingen > Formatie en Organisatie > Organisatorische eenheden")) 

https://api.youserve.nl/mlm/organizationunits

 

Filters

Single organisation unit - Retrieve specific org unit by adding the id of the org unit.

https://api.youserve.nl/mlm/organizationunits/<id>  

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/organizationunits?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

API field

Description

Example

HR Core Business (r1)

Id

Technical and unique id of the organization Unit. the Id is unique within the entity and tenant. The id is generated by the system and can not be changed by a user.

12009338

6000 - Key org unit

shortName

Code or short name of the organizational unit.

SAL_NL

548 - Code OE

fullName

Name of the organization unit.

Sales Netherlands

549 - Naam OE

parentOrgUnit

Code of the parent organization unit

SALES_EU

6000 - Organisatie eenheid

Is the reference to the logical code

isDeleted

Provide the active/inactive status of the Org Unit in the core system.

 

 

organizationUnitType (V)

Code for the organization unit type.

BU

7475 - Type organisatie

manager

Manager of the Organisation Unit.

4005614

7137 - Manager

(mutkey of employee)
managerPersonId

The globally unique id assigned to an the management employee

12345678

10519680 - Persoon nummer

Corresponds with:

Endpoint: Person,

Property: personCode
backupManager

backup manager of org unit

4005614

7011 - Backup manager
(mutkey of employee)
backupManagerPersonId PersonCode of the Backup manager of the Organization Unit.

12345678

10519680 - Persoon nummer

Corresponds with:

Endpoint: Person,

Property: personCode

validFrom

Startdate of the timeslice/version of a record.

2024-01-01

 Reference date / Peildatum (NL)

validUntil

Enddate of the timeslice/version of a record.
The enddate is the (validFrom-1) of the successive version. If no successive version is available then value is 9999-12-31.

9999-12-31
2024-12-31

  

Extensions are not supported in this endpoint.

 

Persons

The endpoint persons expose all the available versions of a unique person, so historical, current, and future versions. (HRCore Business: "Medewerker > Persoon") 
To retrieve the list of all active persons within a tenant the Persons endpoint can be used without using any additional parameters.

https://api.youserve.nl/mlm/persons

 

Filters

Single person - Retrieve specific person by adding the id of the person.

https://api.youserve.nl/mlm/persons/<personid>  

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/persons?ChangedAfter=2023-01-01T10:00:00.000Z&ChangedUntil=2023-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

 

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

API field

Description

Example

HR Core Business (r1)

id

The Id of a unique person within a tenant.

10056832

10519680 - personNumber

personCode

The logical person code of the employee.

4005614

7014 - Uniek Persoonlijk ID (UPI)

isDeleted

Provide the active/inactive status of the Person in the core system.

False

 

initials

The initials of the employee. Format depends.

A.M.

 25 - Voorletters

firstNames

The official given names of the employee as stored in the HR Core system.

Anne Marie

 51 - Voornamen

knownAs

The name is used by the employee as his first name.

Amy

 165 - Roepnaam

lastNameAtBirth

The last name at birth of the employee. Also known as the family name.

Vries

 24 - Achternaam

lastNameAtBirthPrefix

The prefix of the last name at birth.

de

 26 - Voorvoegsel

lastName

The last which is currently used by the employee as his last name.

Vries - Van Eijck

 524 - Opgemaakte naam aanhef

lastNamePrefix

(not recommended to use this field. This field is the same as lastNameAtBirthPrefix)

The prefix of the last name at birth.

de

 26 - Voorvoegsel

nameAssembleOrder (V)

Code of the assemble order that the core system uses for the Last Name. The assembly order is depending on the core system and the logic behind it.

C

 28 - Eigennaam code

partnerName

The partner's last name.

Eijck

 27 - Naam Partner

partnerNamePrefix

The prefix of the partner's last name.

van

 166 - Voorvoegsel Partner

titlePrefix

The formal title will be used as a prefix before the name like Doctor, Professor, etcetera.

Bachelor

94 - Titel voor Description

titleSuffix

The formal title which will be used as postfix after the name like MSc or Master of Science.

MsC

95 - Titel na Description

gender (V)

Gender of the person conform the ISO/IEC 5128 standard

(0) Not known
(1) Male
(2) Female
(9) Not applicable

2

P00330 - Geslacht
M = Man / Male
V = Vrouw / Female

birthDate

Date of Birth.

1990-05-25

35 - geboorte datum

deceasedDate

Indicated if the employee is deceased.

(if True > date format)

10302568 - Datum overlijden

nationalIdentificationNumber

Country specific Identification number.

1744263858

10000018 - Burgerservice nummer

userUID

The Digital Identity of the user from the portal, to be used for SSO.

a061c395-558f-49c7-991c-633aa9afa529

10523564 - PING ID

address

type
streetName
houseNumber
houseNumberAddition
postalCode
city
country

01
Kerkstraat
26
A
3567 AH
Hilversum
Nederland

01 Living address / 02 Postal address
391 - straat
392 - Huisnummer
393 - Huisnummer toevoeging
394 - Postcode
395 - Woonplaats
34 - Woonland > description

phoneNumbers

type
number

0546-453212

Home : 7376 - Telefoonnummer prive
Mobile : 7377 - Telefoonnummer mobiel

emailAddresses

type
address

AnneMarie@privatemail.com

Prive: 7213 - E-mailadres Prive

validFrom

Startdate of the timeslice/version of a record.

2024-01-01

Reference date / Peildatum (NL)

validUntill

Enddate of the timeslice/version of a record.
The enddate is the (validFrom-1) of the successive version. If no successive version is available then value is 9999-12-31.

9999-12-31
2024-12-31

 

Extensions are not supported in this endpoint.

 

Role Assignments

The Role assignments endpoint delivers the role an employee has in the organization. 

https://api.youserve.nl/mlm/roleassignments

 

Filters

Single roleassignment - Retrieve 1 role assignments by adding the id of the item.

https://api.youserve.nl/mlm/roleassignments/<id>

 

OrganizationUnitId - Retrieve all roleassignments for 1 specific organizational unit:

https://api.youserve.nl/mlm/roleassignments?organizationUnitId=<organizationUnitId>

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/roleassignments?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

API field

Description

Example

HR Core Business (r1)

Id

The id of the role Code or the role assignment

658332

960 - Key of the role assignment

organizationUnitId

The Id of the Organization Unit where this Role Assignment belongs to.

12345

548 - Code of the Organisation Unit
Key of the Organisation Unit. Referring to: organizationunits.id

shortName

The shortname of the role 

DM1

549 - (short)name of the role assignment

fullName

The fullname of the role 

 

 

personId

The Id of a unique person within a tenant.

10056832

10519680 - personNumber

Referring to: Persons.id

employeeId

Technical number for an employee

12345

mutkey of employee

includingChildOrgUnits

Refers to the level of authorisation of a specific role within an organisation.

true / false

913 - includeChildOU

startDate

Start date of the role assignment

2020-01-01

  

endDate

End date of the role assignment

9999-12-31

  
isDeleted

Provide the active/inactive status of the record in the core system.

false

 N/A

Extensions are not supported in this endpoint.

 

Sickleaves

Returns a list of all sick leaves for the tenant specified in the request header consisting of:

https://api.youserve.nl/mlm/sickleaves 

Filters

Single sickleave - Retrieve specific sick leave by searching on id of the sick leave

https://api.youserve.nl/mlm/sickleaves/<id>  

 

PersonId - In case all sickleaves of a specific person are needed, this can be retrieved based on the “personId”

https://api.youserve.nl/mlm/sickleaves?personId=<personid>  

 

ContractId - In case all sickleaves of a specific contract are needed, this can be retrieved based on the “contractId”

https://api.youserve.nl/mlm/sickleaves?ContractId=<contractid>  

 

Active - to retrieve only active sickleaves, use the active parameter

https://api.youserve.nl/mlm/sickleaves?active=true

 

Incremental load - To retrieve only changes after last request, use the ChangedAfter and ChangedUntil in the request. By executing the parameters ChangedAfter - ChangedUntil you will only the changed records within this time range.

https://api.youserve.nl/mlm/sickleaves?ChangedAfter=2024-01-01T10:00:00.000Z&ChangedUntil=2024-06-01T11:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ.

 

Important note :

  • All the available sickness versions will exposed as separate data records. The MLM API will expose this data as it’s received it from the core system without additional logic to merge it to one case. All the necessary technical logic to merge these records into one ‘sickness dossier’ according to the 28-days regulation has to be added at the ‘API consumer side’.

Data mapping

Fields marked with (V) should be connected with the results of the endpoint ‘Valuelists’.

API field

Description

Example

HR Core Business (r1)

Id

Technical and unique ID of the sickness registration. This unique ID is generated by the core system and can not be changed by a user.

12345678

7471 - Key of the sickness

IsDeleted

Provide the active/inactive status of the sickness record in the core system.

False

  

personId

The Id of a unique person within a tenant.

10056832

10519680 - personNumber

contractId

Technical and unique ID, which is unique within the entity and tenant. The ID is generated by the system and can not be changed by a user.

001

49 - Key of the contract

reportingDate

Date the sickness reported by the employer.

2024-01-01

7189 - Datum ziekmelding

startDate

The first date of the sickness case.

2024-01-01

7206 - Eerste verzuimdag

hoursWorkedFirstDay

Hours worked on the first sickness date. This could be relevant if the employee gets sick during his working day.

2,00

7423 - Gewerkte uren eerste verzuimdag

expectedRecoveryDate

The expected recovery date.

2024-01-08

7443 - Verwachte hersteldatum

sicknessType (V)

Type of sickness.

 

1 = Sick
2 = Illness due to pregnancy
3 = Organ donation
5 = Occupational accident
9 = Accident fault by third parties

 

in Dutch:
1 = Ziek
2 = Ziekte door zwangerschap
3 = Orgaandonatie
5 = Bedrijfsongeval
9 = Ongeval schuld derden

5

7107 - Soort Ziekte

absenceReason

Reason for absence.

(string)

#N/A

recoveryDate

The recovery date is defined as the first day the employee appears at his work after a sickness period.

2024-01-15

7207 - Eerste werkdag

recourse

Indicates the right of recourse when the sickness is the result of an accident caused by someone else.

(boolean)

7391 - Regres

ongoingSickness

Indicates if the sickness case is an ongoing sickness case. This means that in the MLM system will tread as part of the previous sickness of the employee. Mostly this is the case if the previous sickness was within 28 days.

(boolean)

7075 - Doorlopend ziektegeval

safetynet

Reason of Safetynet case

  

#N/A

dateWVP

Date of the first sickness of a series of sickness cases. In the Netherlands named ‘the 28 days rule’.

  

7076 - Date WVP

urgentCheckRequired

Indicates if an urgent check by the occupational health service is required.

(boolean)

7401 - Spoedcontrole

expectedFinalResult

The expected final result based on the first impression by the manager. For instance, if the manager expects that the employee can fully recover without any restriction for his current Job he can set his expectation so the occupation health service can act on it.

(string)

7444 - Verwacht resultaat

finalResult (V)

The final result after the employee is recovered. For instance, if the employee returns but in another job.

(string)

7470 - Eindresultaat
internalFollowUp

 

 

 
additionalNote

 

 

 

 partial recovery

startDate
illnessPercentage

2024-01-05
80

7464 - Ziektepercentage

 therapeutic period

startDate
endDate
workingAmount
workingPercentage

2024-01-07
2024-01-10
16
40

 7089 - Arbeidstherapiepercentage

 nursing address

startDate
endDate
nameCareAddress
streetName
number
numberAdditional
locationDesignation
postalCode
city
region
country
emailAddress
phoneNumber
faxNumber

2024-01-01
2024-01-10
Ziekenhuis Rijnstate
Wagnerlaan
55


6815 AD
Arnhem
Gelderland
Nederland
info@ziekenhuis.nl
088 - 005 8888



7442 - Naam verpleegadres
391 - Straat
392 - Huisnummer
393 - Huisnummer toevoeging
8099 - Locatie omschrijving
394 - Postcode
395 - Woonplaats
10205283 - Regionaam buitenland
34 - Woonland
7447 - E-mailadres
7455 - Telefoon
7375 - faxnummer

extensions: key

Extra customer specific data can be added with extensions.

extensions: value

 

Value lists

This endpoint returns all the corresponding code & descriptions of pairs of fields that are available in the Medical Leave API.

 

This reference lists endpoint supports filtering based on type. For example, the property “Gender” will be returned as a value 1 or 2, and based on the value list data the user is able to define that 1 = male & 2 = female.

Other examples : “finalResult”; “contractType”; “country”; “employmentType”; “gender”; “nameAssembleOrder”; “organisationUnitType”; “sicknessType” & “workingUnit”. 

 

In ‘Data Mapping’, the fields, which are marked with (V), these fields should be connected with the results of the endpoint ‘Valuelists’.

Valuelists can be configured on different levels in the core system, on ‘client level’ or on ‘company level'. On top is these levels there are also 'system level’ Valuelists.

 

Output example 1 : Valuelists on (core) system level

{
 "validFrom": "2011-01-01",
 "validUntil": "9999-12-31"
 "shortName": "1",
 "fullName": "Man",
 "type": "gender",
 "level": "System",
 "isDeleted": false,
 },

Output example 2 : Valuelists on client (tenant) level

{
 "validFrom": "2018-08-10",
 "validUntil": "9999-12-31"
 "shortName": "2",
 "fullName": "Stagiair",
 "type": "employmentType",
 "level": "Client",
 "isDeleted": false,
 },

 

Retrieve all valuelists:

https://api.youserve.nl/mlm/valuelists 

 

Filters

Single type - Retrieve details of a specific type of valuelist, based on the “type”.

https://api.youserve.nl/mlm/valuelists/<type>

example https://api.youserve.nl/mlm/valuelists/employmentType

 

Level - Filter out specific valuelists corresponding to a specific “level”.

https://api.youserve.nl/mlm/valuelists?level=company 

 

Combination level, type - combining the 2 above filters.

https://api.youserve.nl/mlm/valuelists/function?level=company 

 

 

 

Labels:
Medewerkers

Visma Community

Gebruiksvoorwaarden

Richtlijnen

Veelgestelde vragen

Informatie over cookies

Over Visma

Dit is Visma

Volg Visma

Blog

LinkedIn

YouServe

Website

Contact

Inloggen applicaties

Visma

Copyright 2022 Visma Community. All right reserved.

Choose your region:
Choose your Region
Go