Nedap Ons is een populair systeem dat zorgprofessionals veel administratieve taken uit handen neemt door personeelsplanningen te maken en deze te koppelen aan Elektronische CliëntenDossiers (ECD).
Visma | Raet levert, met het toonaangevende Youforce platform, een volledig digitale HR-administratie waarmee de werkgever ‘in control’ is over alle processen in de employee lifecycle: van recruitment tot offboarding.
De integratie specialisten van Visma Connect hebben een API connector ontwikkeld die de overdracht van HR data tussen de applicaties van Visma | Raet en Nedap automatiseert.
Youforce API en import ONS Nedap
De Youforce Workforce Management (WFM) API met de Extenions API, welke het mogelijk maakt om flexibel 'eigen' rubrieken toe te voegen, vormen de bron voor de connector. Via de API's wordt de data opgehaald uit HRCoreOnline, waarnodig getransformeerd en aangeboden aan de API van ONS Nedap of via de XML-import van ONS Nedap zodat de data zichtbaar is in de applicatie van ONS Nedap.
Om gebruik te kunnen maken van de connector dien je contact op te nemen met je Customer Success Manager.
Frequentie van het ophalen van de data via de Youforce WFM API en het aanbieden aan ONS Nedap via de API en via de XML-import is ieder uur.
Via onderstaand tabel zie je de betreffende HRCoreOnline-velden die worden uitgewisseld. De velden maken deel uit van een 'scope' (deelgebied), als klant kan je kiezen welke scope(s) je op wilt nemen in de koppeling, bespreek dit met de Raet Consultant.
Benodigde voorbereiding
Eigen rubrieken aanmaken
Een belangrijk deel van de informatie wordt via Eigen rubrieken vastgelegd, deze velden zijn essentieel om ONS Nedap goed te kunnen gebruiken, de aanwezigheid van deze velden in HRCoreOnline zijn dus een vereiste. Het aanmaken van de velden met de refentietabellen kan eenvoudig via XML-importbestanden, vraag die op bij je consultant. De wijze van import in HRCoreOnline staat hier beschreven:
https://community.visma.com/t5/Nieuws-Youforce-HR-Core-Beaufort/Rubrieken-voor-eigen-HRSS-inrichting-betaald-ouderschapsverlof/ba-p/504058
Let op, de velden zijn dan beschikbaar in HRCoreOnline desgewenst dien je ze ook op te nemen in de Selfservice-workflows.
ONS Nedap API en XML-import toegang
Als klant vraag je bij ONS Nedap het volgende aan:
Login credentials voor de ONS Nedap API (met Certificaat)
Gebruikersnaam en wachtwoord voor de XML-import
Je deelt dit met de Raet Consultant.
Youforce API filter
Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen. Bekijk de mogelijkheden via:
https://community.visma.com/t5/Kennisbank-Youforce-API/Autorisatie-WFM-api/ta-p/557545
Inhoud van de koppeling
Scope Basis (Persoonsgegevens, dienstverbanden en inzetregels).
HRCoreOnline - veld
Import via ONS Nedap API-veld
Import via Nedap XML- veld
Opmerking
Persoon
P01001 - Persoonsnummer
employee.identificationNo
P00303 - Voorletters
employee.initials
P01003 - Roepnaam
employee.firstName
P00301 - Geboortenaam
employee.birthName
P00302 - Geboortenaam-voorvoegsels
employee.partnerName
P01008 - Samengestelde naam
employee.lastName
P01009 - Samengestelde naam-voorvoegsels
employee.prefix
P00304 - Gebruik achternaam
employee.preferredNameType
P00390 - Partner-naam
employee.partnerName
P00391 - Partner-voorvoegsels
employee.partnerNamePrefix
P00330 - Geslacht
employee.gender
P00321 -Geboorte datum
employee.dateOfBirth
Contact- gegevens
Business: P01035 - E-mail adres werk
employee.emailAddress
Business :P01037 - Telefoonnr werk
employee.mobilePhoneNumber
Dienst- verband
P01101 - volgnr dienstverband
employee.identificationNo-[Volgnr van WFM]
contract.beginDate
contract.endDate
Employee.type
Heeft een vaste waarde 0 (regular)
P01102 - Soort Arbeidsrelatie
contract.contractType
P01119 - Max. uren per week
payroll.Contract.var /contract.hoursVar
Inzet-regels
P01125 - Ingang inzet
teamAssignments.beginDate
P01126 - Einde inzet
teamAssignments.endDate
P01121 - Operationele org. eenheid
team_assignments.teamObjectId
P01124 - Uren inzet per week
payroll.Contract.fixed /contract.hoursFixed
Einddatum van het contract in ONS is gebasseerd op de einddatum van de inzetregel.
Scope Extensies (Eigen rubrieken)
HRCoreOnline - veld
Import via ONS Nedap API-veld
Import via Nedap XML- veld
Opmerking
Extentie-velden
WKKRT1 - Weekkaartprofiel
registrationprofile
AGB001 - AGB-code 1
employee. agb.primaryAgbCode
AGB002 - AGB-code 2
employee.agb.agbCode
P09165 - BIG-nummer (1)
employee.bigCode
BIG002 - BIG-nummer (2)
employee.bigCode
BIG003 - BIG-nummer (3)
employee.bigCode
DBC001 - Cono-/DBC-beroepsgroep 1
employee. conoBeroepsgroep
DBC002 - Cono-/DBC-beroepsgroep 2
employee. conoBeroepsgroep
DBC003 - Cono-/DBC-beroepsgroep 3
employee. conoBeroepsgroep
AUT001 - Authenticatienummer
employee. authentication MobilePhone
employee. authenticationNumber
CAO001- CAO-code Ons
collectiveagreement. agreement
DEP001- Deskundigheids-profiel
education.id
COMP01- Compensatie berekenen
Wordt toegevoegd
COMP02- Compensatie begindatum
Wordt toegevoegd
COMP03 -Compensatie uitbetalen
Wordt toegevoegd
ONAN001- Onderaannemer
Niet beschikbaar
Scope Prive (Adres, telefoonnummer en e-mailadres)
HRCoreOnline - veld
Import via ONS Nedap API-veld
Import via Nedap XML- veld
Opmerking
Adres (thuis)
P01014 straatnaam
EmployeeAddress.street
Adres (thuis)
P01016 Huisnummer
EmployeeAddress. homeNumber
Adres (thuis)
P01018 Huisnummer toev
EmployeeAddress. homeNumberExtension
Adres (thuis)
P01020 Postcode
EmployeeAddress.zipcode
Adres (thuis)
P01022 Plaatsnaam
EmployeeAddress.city
Adres (thuis)
P01024 Land
EmployeeAddress.country
Adres (post)
P00365 straatnaam
EmployeeAddress.street
Adres (post)
P00367 huisnummer
EmployeeAddress. homeNumber
Adres (post)
P00368 huisnummer toev
EmployeeAddress. homeNumberExtension
Adres (post)
P00308 plaatsnaam
EmployeeAddress.zipcode
Adres (post)
P00313 postcode
EmployeeAddress.city
Adres (post)
P00847 land
EmployeeAddress.country
Telefoonnummer
Home: P01027 - telefoonnr woonadres
EmployeeAddress. telephoneNumber
Telefoonnummer
Mobile : P01036 - Telefoonnr mobiel
EmployeeAddress. telephoneNumber2
E-mailadres
Prive: P01034 - E-mail adres privé
EmployeeAddress.email
Type Adres
typeString
Standaard wordt de volgende waarde gebruikt: 1: Living (bij Adres Thuis) 2: Postal (bij Adres Post)
Type persoon
personType
Standaard wordt de volgende waarde gebruikt: 2: Employee
Type verblijf
residentType
Standaard wordt de volgende waarde gebruikt: 0: Unknown
_______________________
Scope Salaris details
HRCoreOnline - veld
Import via ONS Nedap API-veld
Import via Nedap XML- veld
Opmerkingen
Berekend uurloon
P01160 Berekend garantie uurloon
employee.HourlyWage.wageInCents
employee.HourlyWage.startOfWage
Datum waarop dit uurloon is ingegaan. *Bestaat niet in Youforce, eventueel contract datum nemen
employee.HourlyWage.endOfWage
Datum waarop dit uurloon niet langer valide is.
*Bestaat niet in Youforce eventueel contract datum nemen
_____________________
Scope Verlof (rechten)
HRCoreOnline - veld
Import via ONS Nedap API-veld
Import via Nedap XML- veld
Opmerkingen
Verlofsoort (WET, BW etc.)
P01430 code verlofsoort werknemer
VacationAmount.plb
Jaar verlofrecht
P01440 verlofjaar verlofrechten
CurrentDate
Verlofrechten huidig jaar
P01443 verlofrecht huidig jaar in uren
VacationAmount.absolute
Note: De WFM api is controlled available en is nog niet beschikbaar voor algemeen gebruik. De WFM API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een Workforce Management systeem toegang heeft.
Het autorisatie mechanisme bestaat uit de volgende onderdelen:
Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties.
Autorisatie op medewerkers Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen.
Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.
Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd. Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.
Scope
Omschrijving
Endpoints
Invitation_only
Scope noodzakelijk om de API te kunnen activeren. Tijdens het activering proces wordt de contractafspraken gecontroleerd en vastgelegd. Deze scope geeft nog geen toegang tot enige vorm van data maar is noodzakelijk voor de onboarding van klanten op de API of applicatie
-
Get_Basic
Get basic data zoals medewerker- & organisatiedata
GET persons GET employments
GET employmentTimelines GET assignments GET organizationUnits GET roleAssignments GET jobProfiles
GetPrivateContactDetails
Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres.
GET persons GET Employees
Dit betreft de volgende gegevens: ADRESGEVENS
Home:
P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land
Postal:
P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land
TELEFOONNUMMERS
Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel
EMAILADRES
Prive: P01034 - E-mail adres privé
Get salaryDetails
Lezen van de salarisgevens van medewerkers
GET SalaryDetails GET SalaryDetailTimelines
Get_maternitityLeave
Lezen van zwangerschapverlof van medewerkers
GET maternityLeave
Get_sicknessLeave
Lezen van ziekmeldingen van medewerkers
GET sickLeave
Get_leave
Lezen van verlofrechten en verlofopnames van medewerkers
GET leaveEntitlements GET leaveHours
Uw consultant kan u helpen bij het activeren / deactiveren van deze scopes binnen de API.
Autorisatie op basis van autorisatie filters
De autorisatie filters hebben betrekking op welke medewerkers zichtbaar zijn in de API. Standaard worden altijd alle medewerkers getoond in de API. Bij het activeren van de API kan een consultant filters inrichten zodat maar een beperkte groep medewerkers via de API beschikbaar komen.
Filteren in de API is mogelijk op de volgende Beaufort velden:
P01102- Soort Arbeidsrelatie
P01103- Opdrachtgever
P01104- Instelling
P01110 - Code doelgroep
P05042 - Selectie rubriek Domain API - WFM
Een veel voorkomen filter is bijvoorbeeld op Soort Arbeidsrelatie waarbij alleen eigen medewerkers in het extern systeem opgenomen worden. Maar ook een filter op de combinatie Opdrachtgever / Instelling geeft u de mogelijkheid om de medewerkers van één of meerdere specifieke instellingen in de API op te nemen.
Uw consultant kan u helpen bij het inrichten of wijzigen van de autorisatie filters.
Artikel inhoud
Domein model
Het model
Entiteiten en velden
Person (Persoon)
Id / personId
Technical and unique id. the Id is unique within the entity and tenant. The id is owned by the core system and can not changed by a user
P01001 - Persoonsnummer
PersonCode
The logical code or number of the employee.
P01001 - Persoonsnummer
Initials
The initials of the employee. Format depends
P00303 - Voorletters
firstNames
The official given names of the employee as stored in the HR Core system
P01002 - Voornamen
KnownAs
The name which is used by the employee as his first name
P01003 - Roepnaam
lastNameAtBirth
The last name at birth of the employee. Also known as the family name
P00301 - Geboortenaam
lastNameAtBirthPrefix
The prefix of the last name at birth
P00302 - Geboortenaam-voorvoegsels
lastName
The last which is currently used by the employee as his last name
P01008 - Samengestelde naam
lastNamePrefix
The prefix of the last name as used currently
P01009 - Samengestelde naam-voorvoegsels
nameAssembleOrder
Code of the assemble order that the core system uses for the last Name. The assemble order is depending on the core system and the logic behind it.
P00304 - Gebruik achternaam
partnerName
The partner last name
P00390 - Partner-naam
partnerNamePrefix
The prefix of the partner last name
P00391 - Partner-voorvoegsels
titlePrefix
The formal title which will be used as a prefix before the name like Doctor, Professor, et cetera
P00305 - Titulatuur voor de naam
titleSuffix
The formal title which will be used as postfix after the name like MSc or Master of Science
P03937 - Titulatuur achter de naam
gender
Gender of the person conform the ISO/IEC 5128 standard (0) Not known (1) Male (2) Female (9) Not applicable
P00330 - Geslacht M = Man / Male V = Vrouw / Female
dateOfBirth
Date of Birth
P00321 -Geboorte datum
deceased
Indicated if the employee deceased Note: most core systems have a date field. In the API this will be translated to boolean
P01005 - Datum overlijden
emailAddresses
List of the email addresses of the employee. The fields are: type like Business, Private, etc. address
Business: P01035 - E-mail adres werk Private: P01034 - E-mail adres prive
phoneNumbers
list of phone numbers of the employee type like Business, Home, Mobile, et cetera number
Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel Business :P01037 - Telefoonnr werk FaxBusiness : P01039 Faxnr werk FaxHome : P01038 Faxnr prive
Addresses
list of addresses of the employee. The address fields are: addressType like Home, Post, etc. streetName Number streetNumberAdditional postalCode city country
Home: P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land P01012 Adres m.i.v. Postal: P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land P01011 Adres m.i.v.
Employment (Dienstverband)
Id / employmentId
Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.
Object Id = "PersonCode" + ContractCode
PersonCode / PersonId
Person code to which the employment is related
P01001 - Persoonsnummer
employmentCode / ContractCode / ContractId
Code of the contract
P01101 - volgnr dienstverband
PayrollClientCode
Logical code of the payroll client. Filter option for Row Authorisation (configuration API)
P01103 Opdrachtgever
PayrollInstitutionCode
Logical code of the payroll Institution. Filter option for Row Authorisation (configuration API)
P01104 Instelling
hireDate
The hire date of the employment
P00322 - Datum in dienst
dischargeDate
The end date or discharge date of the employment. This is always an "up to and including" date. In unknown the field will not be visible in the API
P00830 - Datum uit dienst
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
P00834 -Datum in dienst CAO
employmentType
Type of employment like Internal employee, contractor, "Wachtgelder" Filter option for Row Authorisation (configuration API)
P01102 - Soort arbeidsrelatie
contractType
Type of the contact like indefinite period ('Onbepaalde tijd') or given time ('bepaalde tijd')
P08259 - Code contract (on)bepaalde tijd
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
P01107 - Primaire functie
classification
group or classification of the employment. Generic field Filter option for Row Authorisation (configuration API)
P01110 - Code doelgroep
organizationUnit
organization unit Id of employment. The Id is a reference to the entity org units
P01106 - Hierarchische org. eenheid
workingAmount
Work amount of employment. amountOfWork: the amount of work unitOfWork: Unit of work that specifies the amount of work like "hours", "days", et cetera periodOfWork: Period of work like "week" or "month" parttimePercentage
P01109 - Uren per week P00404 percentage deelbetrekking
SalaryDetails (Dienstverband)
Id
Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.
PersonCode
Person code to which the employment is related
P01001 - Persoonsnummer
employmentCode
Code of the employment
P01101 - volgnr dienstverband
GENERAL
typePaidWorkerCode
type of paid or unpaid worker
P00332 Code soort loner
SALARY DETAILS
payrollSchemeCode
payroll scheme related to the collective agreement
P00314 Code salarisregeling
payrollScale
Salary scale
P01151 Salaris
payrollSeniority
Salary step or seniority within the salary scale
P00326 Ancienniteit salaris
payrollAmountNo
salary amount number
P01152 Inpassingsnr salaris
GARANTEED SALARY DETAILS
GuaranteedPayrollScale
Garanteed salary scale.
P01157 Garantieschaal nummer
GuaranteedSeniority
Garanteed step or seniority within the garanteed scale
P01158 Ancienniteit garantieschaal
GuaranteedPayrollAmountNo
salary amount number
P00318 garantie salaris
CALCULATED SALARY DETAILS
CalculatedSalary
calculated gross salary by Beaufort
P01161 Berekend bruto salaris
CalculatedHourlySalary
calculated gross hourly salary by Beaufort
P01162 Berekend bruto uurloon
CalculatedGuaranteedSalary
calculated gross garanteed salary by Beaufort
P01159 Berekend garantiesalaris
CalculatedGuaranteedHourlySalary
calculated gross garanteed hourly salary by Beaufort
P01160 Berekend garantie uurloon
Assignments (Inzet)
assignmentID
Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.
PersonCode / PersonId
Person code to which the employment is related
P01001 - Persoonsnummer
employmentCode / ContractCode / ContractId
Code of the contract
P01101 - volgnr dienstverband
startDate/validFrom
The date when the assignments start
P01125 - Ingang inzet
endDate/ValidUntil
The end date of the assignment. This is always an "up to and including" date. In unknown the field will not be visible in the API
P01126 - Einde inzet
jobProfile
Job title or job profile of the assignment. The Job profile contains the following details: shortName: Code or short name of the job profile
P01122 - Operationele functie
organizationUnit
Organization unit id of the assignment. The Organization Unit Id is a reference tot the organization unit entity
P01121 - Operationele org. eenheid
workingAmount
work amount of the assignment. amountOfWork: the amount of work unitOfWork : Unit of work that specifies the amount of work like "hours", "days", et cetera periodOfWork: Period of work like "week" or "month"
P01124 - Uren inzet per week
costCenter
the cost center of the Assignment
P01128 - Kostenplaats Inzet
costUnit
the cost unit of the Assignment
P01129 - Kostendrager Inzet
costType
the cost type of the Assignment
P01127 - Kostensoort Inzet
type
Type of assignment
P01123 - Soort Inzet
Cost allocation (Loonverdeling)
API Field
Description (English)
Beaufort field
Example
id
Technical and unique id. the Id is unique within the entity and tenant.
1000 1 0
PersonCode
Person code to which the employment is related
P01001 - Persoonsnummer
1000
employmentCode
Code of the contract
P01101 - volgnr dienstverband
1
sequenceNumber
Row number or sequence number or the cost allocation within the employee
P01131 - regelnr loonverdeling
0
costCenter
the cost center of the cost allocation row
P01134 - Kostenplaats loonverdeling
10000 - administratie
costUnit
the cost unit of the cost allocation row
P01135 - Kostendrager loonverdeling
10000 - Aministratie
costType
the cost type of the cost allocation row
P01133 - Kostensoort loonverdeling
41300 - Afdelingshoofd
percentage
Percentage of the cost allocation row
P01132 - Percentage loonverdeling
100
Leave Entitlements (Verlofrechten)
id
Technical and unique id. the Id is unique within the entity and tenant.
object id
PersonCode
Person code to which the employment is related
Persoonsnummer
employmentCode
Code of the contract
volgnr dienstverband
leaveType
leave type code, like WET for legal
P01430 code verlofsoort werknemer
leaveEntitlementYear
Year of the Leave entitlement
P01440 verlofjaar verlofrechten
leaveEntitlementLastYear
leave entitlement last year
P01442 verlofrecht vorig jaar in uren
leaveEntitlementThisYear
leave entitlement this year
P01443 verlofrecht huidig jaar in uren
leave hours (Opgenomen verlof in uren)
id
Technical and unique id. the Id is unique within the entity and tenant.
PersonCode
Person code to which the employment is related
Persoonsnummer
employmentCode
Code of the contract
volgnr dienstverband
leaveEntitlementYear
Year of the Leave entitlement
P01466 - verlofjaar verlofrecht
leaveType
leave type code, like WET for legal
P01465 - code verlofsoort
leaveSequence
leave request Id
P01460 - Volgnummer verloftijdvak
leaveDate
leave date
P01470 - Datum verlof
leaveHours
hours leave on specific leave
P01471 - uren verlof
Sickleave (Ziekte algemeen, uitgezonderd zwangerschapsverlof)
id
Technical and unique id of the sickness case. The Id is unique within the entity and tenant.
PersonCode
Person code to which the employment is related
Persoonsnummer
employmentCode
Code of the contract
volgnr dienstverband
startDate
first day of the sickness of the employee
P01600 Datum eerste ao-dag
recoveryDate
recovery date or first working day of the employee
P01606 Datum herstel
expectedRecoveryDate
Expected recovery date
P01605 Datum verwacht herstel toevoegen
Partial recovery
periodId
technical id of the partial recovery period
periodStartDate
The start date from which the new Illness percentages is valid
P01640 - Ziektetijdvak vanaf
percentage
The percentages the employee is still sick. the percentage is always related to the total amount of working hours of the employee itself
P01642 - Percentage ziek
Maternity leave (ziekte zwangerschapsverlof)
id
Technical and unique id of the Maternity leave. The Id is unique within the entity and tenant.
PersonCode
Person code to which the employment is related
Persoonsnummer
employmentCode
Code of the contract
volgnr dienstverband
startDate
first day of the maternity leave of the employee
P01600 Datum eerste ao-dag
recoveryDate
recovery date or first working day of the employee
P01606 Datum herstel