Mijn Communities
Help

Knowledge base YouServe API's

Sorteren op:
Description of MLM API endpoints and swagger page.
Volledig artikel weergeven
31-01-2022 11:14 (Bijgewerkt op 19-01-2024)
  • 0 Antwoorden
  • 1 kudos
  • 2417 Weergaven
The files which are related to the same “business” are functionally grouped in File types called “Business types”. File types are represented by an integer called “Business type id”.
Volledig artikel weergeven
21-04-2023 17:22 (Bijgewerkt op 15-01-2024)
  • 0 Antwoorden
  • 0 kudos
  • 1309 Weergaven
  MLM API The available API’s of Visma | YouServe are developed corresponding with the data which is required for a specific HR domain. This MLM API has an ‘outside in’ set up, which means that each domain contains only the data and endpoints they need. The API’s support all common and domain-specific fields. For instance, the social security number is only available in domains with a legitimate reason, like Medical Leave Management. In other domains, other fields could be available. By using customer-specific ‘extensions’ it’s possible to add extra fields for an API user. This Medical Leave API will expose the necessary data which is needed to do your sickness case management according to the Dutch law ‘Wet Poortwachter’. Currently, we support the data entities People, Organisation Units, Sickness registrations, Value lists, Maternity Leaves, RoleAssignments, JobProfiles & Companies by exposing these via different endpoints.    Handle full loads & changes By calling the API the user will by default retrieve the tenant-specific data in full loads. In cases the user prefers to fetch only the changed data, we provide the possibility to use the parameters ‘ChangedAfter' & ‘ChangedUntil’ (see example).   Example date-time format : changedAfter - 2020-08-21T00:00:00.000Z changedUntil - 2020-08-21T12:01:46.077Z   Pagination of the result set To reduce the load of an endpoint each endpoint supports paging. In case the results of an endpoint contain more than 500 records, a ‘nextLink tag’ is available to retrieve the next page of the result. The nextLink tag is part of the body of the response and is also returned in the header of the response.   Example of nextlink in the in the body: "nextLink": "/persons?pageToken=20220207T1409148404911Z-20210121-B2011&take=500"   Example of nextlink in the header: x-nextlink: /persons?pageToken=0GXW0HLDWLoPqg3c63IGhbQuQhYB9mixdwbEP4+w52UUGnxYuKqsNBNDvK03lnoH&take=500" The nextLink indicates that there are more pages to load. If there is no nextLink available, this means that it’s the last page of the result set. Handle deletions The existing endpoints will provide the API consumers a status field that says something about the (in)active status of a specific record. For example in situations where sickness cases were deleted in the core system. The response bodies of the endpoints will have the following flag : "iD" : "123456" "IsDeleted":"false" The active value will be stated as “False” and an inactive (deleted) record will be stated as “True”. All the remaining fields in the deleted records will be empty and not visible in the output anymore. Historical, current & future data The different endpoints in the MLM API provide the most accurate data corresponding with the different data entities (Employee; Employments, Sickness cases, etcetera.). By executing full loads (and changed) the API exposes default data until 4 years back in history (from today’s date). Besides historical data also future changes will be exposed via the API. All these different data sets will show in ‘versions' by using a ‘ValidFrom’ and a “ValidUntil’ date. These ‘ValidFrom’ and ‘ValidUntil’ are functional dates which are sent to the API by the Visma core systems along with the corresponding data. These dates indicate the duration for which this version of the entity is valid. This makes it possible to expose for example contract details of an Employee multiple years back in time and also the future changes. In case a future change is added to the core system (from 24 hours p/w to 32 hours p/w per 01-01-2021) the API exposes all these versions in ‘time slices’. EXAMPLE OF RECORDS VERSIONS In the example below, the employee changes his working hours on 01-11-2018 into 32 hours. After this change, the system creates a new version of the record with a validFrom and validUntil. On 01-04-2019 he becomes UX designer in the UX team, so the next version is created. Response times API Visma Verzuim (a.k.a. DWC) is a Visma | YouServe partner that integrates with Youforce for employee, organization and sickness data. The data is made available to Visma Verzuim using the Youforce API for Medical Leave Systems (In short: ‘MLM API’).  The Youforce APIs are optimized for availability and scalability: the data is being ‘pre-processed’ for the API consumer. In this way we ensure that data is always available to integrated systems.  Pre-processing means the data is stored in a read optimized database to which the API is connected. The pre-processing also takes data authorization into account. In this way the API and HR Core system remain responsive when dealing with peak loads from consuming systems.  As a consequence it takes time before transactions in Youforce are available to other systems. This is known as ‘stale data’. The delay is normally within 10 to 30 minutes. Structural delays of more than 30 minutes are considered an issue.  Versioning of the different endpoints Some endpoints of the Medical Leave API might offer you multiple versions. Currently, the /employees endpoint has two functional versions. The technical usage of the different versions will be explained below. SWAGGER : In the Swagger tool this can be executed by switching the version in the right top bar 'Select a definition’ (see example).     After selecting the right version (f.e. V2), the corresponding version will show up in the Swagger documentation.     POSTMAN: In the Postman tool versioning can be managed by changing the Key 'Accept-Version' to 2.0 (see example). Entity model The MLM domain model contains the following entities     Endpoint Entity Description Employee endpoint Person A natural person. In HR it is more common to talk about employees, but the entity Person is broader than the entity employee. The entity could also contain Persons without any employment with the employer, like contact persons, suppliers, etc. Employee An employee is a person who had, has, or will have employment with the employer.  In natural language, we talk about employees, old employees or former employees.  Employment An Employment or Employment relationship defines the official relation between the employee and the employer. The employment can be based on multiple contracts as long it describes one continuous period of which the employee was employed to the same employer. Sickleave endpoint Sickness leave A sickness leave describes an uninterrupted period of absence because of sickness. Within this period an Employee can be partially recovered, but the sick leave will ends when the Employee is fully recovered. Maternity Leaves endpoint Maternity leave The maternity leave period that the employee is absent because of maternity leave. Sickness related to the pregnancy before or after the Maternity leave is not part of the Maternity leave itself but are separate sickness leave. Company endpoint Company The (legal) company as know by the core system Note: not all Core systems support the legal company, but only the Payroll company. There could be some payroll reasons to split a legal company into 2 different Payroll companies. For instance, if the legal company supports more than one payroll period (e.g. Month + 4 weeks). In that case, the official legal company does not exist. OrgUnits endpoint Organizational Unit The organization structure describes the organization in terms of Business unit, department, teams, etc. and how there are related to each other. Based on the organization structure it's clear how the organization is structured and "which" department is responsible for "what" RoleAssignments endpoint Role Assignment The role assignment describes "who" is responsible for "which role"  for "which period" for the organization unit. For instance "who is the manager" or "who is the financial controller", etc. JobProfiles endpoint JobProfiles All job profiles of the organization.    User The user account of a single employee   Based on the HR domain model we’ve defined the following endpoints : Endpoint GET /employees (current versions)  Endpoint GET /contracts (all versions)  Endpoint GET /persons (all versions)  Endpoint GET /organizationUnits (all versions)  Endpoint GET /sickleaves (all versions)  Endpoint GET /maternityleaves (all versions)  Endpoint GET /jobprofiles (all versions)  Endpoint GET /roleassignments (all versions)    How to ‘match’ entities? As a user, you are able to ‘match’ corresponding datasets, based on entity-specific unique identifiers. These specific keys per entity are unique and do not change during time.
Volledig artikel weergeven
31-01-2022 22:24 (Bijgewerkt op 04-01-2024)
  • 0 Antwoorden
  • 0 kudos
  • 900 Weergaven
  This API is intended for external payroll systems and allows them to fetch the necessary data they need to run the payrolls.   Employee basic data Property Description Example Data type isDeleted If the employee was removed in the core system true boolean customerId The code of the tenant 4024898 string companyId The id of the company 15951 string upi The unique id assigned to the employee 32789 string employeeCode The code of the employee 1079224 string employeeId The employee id in the core system 13665966 string contractId The contract id in the core system 13665965 string hireDate The hire date of the contract 2017-03-01T00:00:00 DateTime dischargeDate The discharge date of the contract 2020-12-30T00:00:00 DateTime personData List of person data versions (*)       validFromDate 2017-03-01T00:00:00 DateTime validToDate 2020-12-30T00:00:00 DateTime personalDetails (name, lastname, birthdate, prefix...)     addresses (list of addresses (home and postal))     contactInformation (personal email, work email, work number...)     extensions     lastNameAtBirth The last name at birth of the employee. Also known as the family name Vries string prefixLastNameAtBirth The prefix of the employee's last name at birth de string lastNameToUse The last name used by the employee at present Vries - Van Eijck string prefixLastNameToUse The prefix of last name used by the employee at present Van String initials The initials of the employee A.B. string firstNames The official given names of the employee Amy Beatrice string knownAs The name which is used by the employee as first name Amy string titlePrefix The title prefix of the employee Mr. string titleSuffix The title suffix of the employee Jr. string gender Gender of the employee Female string dateOfBirth The date of birth of the employee 1970-01-01 DateTime dateDeceased The date of the death 2020-01-01 DateTime? countryOfBirth The country of birth of the employee ES string placeOfBirth The place of birth of the employee Amsterdam string maritalStatus The marital status of the employee 1 string (reference list) primaryNationality The primary nationality of the employee 0001 string (reference list) nationalIdentificationNumber The national identification number of the employee 367565572 string addresses List of addresses array of objects   type Home string street Kerkstraat string houseNumber 1 string addition C string additionalInfo 2nd floor string zipCode 1234 AB string city Amersfoort string region Region string country NL string (reference list) contactInformation emailAddresses     phoneNumbers     emailAddresses List of email addresses     type Private string address p.user@example.com string phoneNumbers List of phone numbers     type Home string number +3188 123 45 67 string extensions List of custom fields     key AmountOfChildren string value 3 string employmentData List of employment versions (*)     validFromDate 2017-03-01T00:00:00 DateTime validToDate 2020-12-30T00:00:00 DateTime contractDetails     costAllocations     bankAccounts     workAmountPattern     extensions     contractNumber The contract number 1 string firstHireDate The first hire date or original hire date of an employee within the organization. 2017-03-01T00:00:00 DateTime location The location of where the employment is being performed Headquarter string contractType The type of the contract   string employmentType Code of the employment type 4 string (reference list) daysPeriod Working days in a period for the employee 5 decimal classification Classification 110001 string (reference list) jobProfile The job profile code DEV string (reference list) collectiveLaborAgreement The collective labor agreement of the company 13124836 string (reference list) organizationalUnit The organizational unit of the employee 31081923 string (reference list) terminationReason The reason of the termination of the contract REA string (reference list) costAllocations List of cost allocations     costCenter cc1 string percentage 100 int bankAccounts List of bank accounts     country NL string (reference list) iban NL62INGB1954254121 string accountOwner   string bic ABNANL2AALC string routingNumber   string accountNumber 1954254121 string bankName   string bankAccountType 01 string (reference list) currency EUR string (by default is EUR) workAmountPattern workingAmount 40 decimal workingUnit Hours string workingPeriod 1 string (reference list) workPatternId 40HoursWeek string workingPatterns (list of work pattern versions that applies to the period of the contract version)     workingPattern validFromDate 2017-03-01T00:00:00 DateTime validToDate 2020-12-30T00:00:00 DateTime days (list of workingDay)     workingDay dayIndexNumber 1 int dayOfWeek Monday = 1 enum hours 8 decimal Dependents List of dependents dependentId dependentPersonNumber dependentData: List of dependent versions     dependentId Identifier of the dependent 1 int dependentPersonNumber Person number of the dependent 10001 string dependentData List of dependent versions     prefix Van string lastName Vries string firstName Erika string gender Female string dateOfBirth 2001-01-01 DateTime dateOfDeath   DateTime relationship Partner string relationshipStartDate 2020-01-01 DateTime relationshipEndDate 2020-12-31 DateTime validFromDate 2020-01-01 DateTime validToDate 9999-12-31 DateTime extensions: List of custom fields per dependent and country     (*) The list of versions of PersonData and ContractData includes all versions, when the employee is in service and out of service.   The extensions fields in PersonData, EmploymentData and DependentData would be filled in with custom fields. No dependent data is available for German employees.   Employee benefits Property Description Example Data type IsDeleted If the employee was removed in the core system true boolean customerId The code of the tenant 4024898 string employeeCode The code of the employee 1079224 string employeeId The employee id in the core system 13665966 string contractId The contract id in the core system 13665965 string Benefits List of benefits of the employee       PayComponent HourlySalary string value 20 string validFrom 2017-03-01T00:00:00 DateTime validTo 2020-12-30T00:00:00 DateTime   Pay components included as Benefits: Pay component Element number KpiCompensation 10201240 PersonalAllowanceB 10201251 PersonalAllowanceC 10201252 PersonalAllowanceReduction 10201253 PersonalAllowanceIncludingCao 10201254 SightingFee 10201255 JobBonus 10201256 StandBy 10201257 CarAllowance 10201258 CostReimbursementTax 10201259 TravelExpenses 10204902 DivergentSalary 10300579 PersonalAllowancePercentage 10303254 HourlySalary 10518747 SalaryAmount 10302976 SalaryScale 10300574 SalaryLevel 10300575 CategorieSalaryScale 10300576   Employee fixed payments Property Description Example Data type IsDeleted If the employee was removed in the core system true boolean customerId The code of the tenant 4024898 string employeeCode The code of the employee 1079224 string employeeId The employee id in the core system 13665966 string contractId The contract id in the core system 13665965 string FixedPayments List of fixed payments of the employee       PayComponent Fixed allowance string value 10 string validFrom 2017-03-01T00:00:00 DateTime validTo 2020-12-30T00:00:00 DateTime   Pay components included as Fixed payments: Pay component Element number GrossFixedFee 10207320 InternshipCompensationNB 10207480 StaffBonus 10203907 ExpenseAllowanceUntaxed 10202687 BAdditionTaxableIncomeFixed 10207160   Employee one-off payments Property Description Example Data type IsDeleted If the employee was removed in the core system true boolean customerId The code of the tenant 4024898 string employeeCode The code of the employee 1079224 string employeeId The employee id in the core system 13665966 string contractId The contract id in the core system 13665965 string OneOffPayments List of one off payments of the employee       PayComponent Train ticket string value 17 string date 2017-03-01T00:00:00 DateTime   Pay components included as One Off Payments: Pay component Element number DailyAllowenceNet01 10206880 DailyAllowenceNet02 10206882 DailyAllowenceNet03 10206884 DailyAllowenceNet04 10206886 DailyAllowenceNet05 10206888 DailyAllowenceNet06 10206890 DailyAllowenceNet07 10206892 DailyAllowenceNet09 10206896 DailyAllowenceNet10 10206898 DailyAllowenceNet11 10206900 DailyAllowenceNet12 10206902 DailyAllowenceNet13 10206904 KilometresStatement 10204904 CAllowenceVar 10200763 AAllowenceVar 10200759   Extensions fields for German companies Person data extensions Property Example Data type SocialSecurityNumber 15090270W758 string TaxIdentificationNumber 1234562001 string Employment data extensions Property Example Data type CapitalAccumulationBenefits 2 string (reference list) CertificationOfIncreasedPensionInsurance 2 string (reference list) CertificationOfParenthood 2 string (reference list) CertificationOfPensionInsuranceExemption 2 string (reference list) ChildDaycareAllowance 2 string (reference list) ChildTaxCredit 1 string (reference list) CompanyCar 1 string (reference list) CrossborderWorker 5 string (reference list) DegreeOfDisability 9 string (reference list) EducationDegree 1 string (reference list) EmployeeGroup 1 string (reference list) EmployerFundedPension 1 string (reference list) HealthInsuranceType 3 string (reference list) LevelOfEducation 9 string (reference list) LimitedincomeTax 2 string (reference list) MainEmploymentAtOtherEmployer 2 string (reference list) Name Audi BKK string Place Ingolstadt string Religion 10 string (reference list) TaxGroup 1 string (reference list) TravelAllowance 1 string (reference list) Vouchers 2 string (reference list) With 3 string (reference list) WorkingAs 71394-3 string (reference list) WorkingLocation HH string (reference list) ContractType 1 string (reference list)   Extensions fields for Belgian companies Employment data extensions Property Description Example Data type Element number in HRCB LinkingTableBICCodeBelgium Linking table bic code 2 string (reference list) 10525244 StartDateLimosaNotification Effective date Limosa notification 2020-01-01 DateTime 10525245 NationalInsuranceNumberOld National Insurance number (old) 750915 4998 658 string 10525231 LanguagePayslip Salary slip language 1 string (reference list) 10525253 Flex Flex 1 boolean 10525255 IncomePartner Income of the partner 2 string (reference list) 10525252 CountryOfBirth Country of birth 2 string (reference list) 10517302 EndDateLimosaNotification End of limosa notification 2021-01-01 DateTime 10525246 NationalInsuranceNumber INSZ number 750915 4998 659 string 10517301 DegreeOfEducation Education degree 2 string (reference list) 10525254 MaritalStatusBE Marital status 2 string (reference list) 10517075 TaxCivilStatusOnEmployment Fiscal Marital status upon employment 1 string (reference list) 10519436 PrintPaySlips Print payslips 1 boolean 7707 CategoryEmployee Category of the employee A string (reference list) 10525264 ReasonForDismissal Reason for dismissal BP string (reference list) 10525248 SeniorityDate Seniority date 2020/08/14 DateTime 10525233 HierarchicalStatute Hierarchical status 1 string (reference list) 10520266 TaxStatus Tax status 1 string (reference list) 10525251 StartDateParentalLeave Start date interruption parental leave 2021/01/01 DateTime 10525234 EndDateParentalLeave End date interruption parental leave 2021/03/01 DateTime 10525235 ParentalLeave Type interruption parental leave OH string (reference list) 10525257 PercentageInterruptionParentalLeave Percentage interruption parental leave 12,00 number 10525237 StartDatePalliativeLeave Start date interruption palliative leave 2021/01/01 DateTime 10525238 EndDatePalliativeLeave End date interruption palliative leave 2021/03/01 DateTime 10525239 PalliativeLeave Type interruption palliative leave PD string (reference list) 10525258 PercentagePalliativeLeave Percentage interruption palliative leave 13,00 number 10525240 StartDateMedicalAssistance Star date interruption medical assistance 2021/01/03 DateTime 10525241 EndDateMedicalAssistance End date interruption medical assistance 2021/01/04 DateTime 10525242 MedicalAssistance Type interruption medical assistance MV string (reference list) 10525259 PercentageMedicalAssistance Percentage interruption medical assistance 14,00 number 10525243 StartDateTimeCredit Start date interruption time credit 2021/01/05 DateTime 10525261 EndDateTimeCredit End date interruption time credit 2021/01/06 DateTime 10525262 TimeCredit Type interruption time credit TV string (reference list) 10525260 PercentageTimeCredit Percentage interruption time credit 15,00 number 10525263 Contract1Type Type of contract 1 1 string (reference list) 10525766 Contract2Type Type of contract 2 2 string (reference list) 10525767 Contract3Type Type of contract 3 3 string (reference list) 10525776 Contract1StartDate Start date of contract 1 01/01/2021 00:00:00 DateTime 10525770 Contract2StartDate Start date of contract 2 02/01/2021 00:00:00 DateTime 10525774 Contract3StartDate Start date of contract 3 03/01/2021 00:00:00 DateTime 10525775 Contract1EndDate End date of contract 1 01/31/2021 00:00:00 DateTime 10525771 Contract2EndDate End date of contract 2 02/28/2021 00:00:00 DateTime 10525772 Contract3EndDate End date of contract 3 03/31/2021 00:00:00 DateTime 10525773 NumberOfDependentChildren Number of dependent children for tax purposes 1 int 10517103 NumberOfDependentHandicappedChildren Number of disabled dependent children 1 int 10517104 PartnerIncome Professional income partner 2 string (reference list) 10517076 HandicappedPartner Disabled partner 1 boolean 10517102 HospitalizationInsuranceForPartner Hospitalization insurance for partner 1 boolean 10526113 NumberOfDependentPersons Number of other dependent residents <65 years 1 int 10517105 NumberOfDependentDependent Number of other disabled residents dependent 1 int 10517106 NumberOfDependentPersonsGt65 Number of other dependents >= 65 years 1 int 10517107 NumberOfDependentHandicappePersonsGt65 Number of disabled residents dependent> 65 years 1 int 10517108 TaxRegimeBE Belasting regime [BE]     10528135 SocialSecurityReductionReasonBE Reden verlaging Sociale zekerheid [BE]     10528136 TaxReductionReasonBE Reden belasting verlaging [BE]     10528137 SocialSecurityRegimeBE Sociaal zekerheid regime [BE]     10528138 PartimeIndicationBE Deeltijd indicatie [BE]     10528139 WorkScheduleNumberBE Werkschema nummer  [BE]     10528141 PaymentMethodBE Betaalwijze [BE]     10528223 EmployeeContractBE Arbeidsovereenkomst [BE]     10528224 GroupNumberBE Groepsnummer [BE]     10528225 DentalInsurancePlus18BE Dentalverzekering +18 [BE]     10528226 DentalInsuranceMinus18BE Dentalverzekering -18 [BE]     10528227 NationalRegisterNumberProTimeBE INSZ-nummer ProTime [BE]     10528228 EMailProTimeBE E-mail ProTime [BE]     10528229 PartnerProfessioneBE Beroep echtgenote [BE]     10528231 PeopleDependentOn65InformalCareBE Personen ten laste 65+ mantelzorg [BE]     10528239 PersonsAtChargeDisabledPartnerBE Pers. ten laste: Mindervalide echtgenote [BE]     10528240 PersonsAtChargePartnerBE Personen ten laste-echtgenote [BE]     10528241 HigherValueMealVouchersBE Hogere waarde maaltijdcheques [BE]     10528242 MonthlyGrossIncomeScaleBE Barema brutoloon  [BE]     10528243 HourlyWageScaleBE Barema uurloon (chauffeurs) [BE]     10528244 SalaryLevelBE Looncategorie [BE]     10528245 HourlyWageBE Basis uurloon arbeiders [BE]     10528246 MonthlyGrossIncomeBE Maandloon bedienden [BE]     10528247 AlternativeHourlyWage2BE Basis uurloon chauffeurs  [BE]     10528248 ReasonWageIncreaseBE!! Reden loonsverhoging [BE]     10528249 ExtraAllowance1BE Distributiepremie chauffeurs [BE]     10528250 ExtraAllowance2BE Toeslag trainer chauffeurs [BE]     10528251 WorkSchemeCodeBE Werkschema code [BE]     10528252 DisabledEmployee Minder valide medewerker     10528253 TypeOfPayslipBE Type loonstrook [BE]     10528254 Regime5Or6BE Stelsel 5-6 [BE]     10528259 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 WorkLocation Work Location     7449 LastNameToUse Last name to use     590 NumberOfPeopleDependentOn65PlusInformCare Number of people dependent 65+ on  informal care     10528515   Dependent data extensions Property Description Example Data type Element number in HRCB DependentPersonStatus Status 1 string (reference list) 10519335 DependentPersonIsDisabled Disabled 1 boolean 10519251 HospitalizationInsuranceForChild Hospitalization insurance for a child? 1 boolean 10526114 DisabilityRate Disability rate 50 decimal 10526116 IsChildBenefitReceived Are child benefits received? 1 boolean 10526115  
Volledig artikel weergeven
28-01-2022 11:25 (Bijgewerkt op 23-11-2023)
  • 0 Antwoorden
  • 0 kudos
  • 701 Weergaven
  Swagger documentation The following swagger page gives an overview of the endpoints: HR Core and Payroll API   Endpoints Addresses These endpoints return the address data of the employee that consists of the home and postal address. Each field has its own timeline.   Get the addresses of all employees of a customer: - Get: https://api.youserve.nl/hrp/v1.0/addresses   Get the addresses of all employees of a company: -  Get: https://api.youserve.nl/hrp/v1.0/addresses?companyId=10028636   Get the addresses of an employee: -  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024/addresses   Response example: { "employeeId": 10030024, "companyId": 10028636, "personCode": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "NU1926" } ], "employeeCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "120" } ], "initials": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2022-01-31T00:00:00Z", "value": "A.H." }, { "startDate": "2022-02-01T00:00:00Z", "endDate": "2023-03-05T00:00:00Z", "value": "A.H.T." }, { "startDate": "2023-03-06T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "AB" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "AFR" } ], "lastName": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Huffman" } ], "addresses": [ { "type": "Home", "country": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "2006-10-31T00:00:00Z", "value": "NL" }, { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "NL" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL" } ], "street": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2019-04-07T00:00:00Z", "value": "Dobberhof" }, { "startDate": "2019-04-08T00:00:00Z", "endDate": "2019-04-19T00:00:00Z", "value": "zevenhuizen" }, { "startDate": "2019-04-20T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "biltstraat" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "wigsfrfvpb" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Vitoria" } ], "houseNumber": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2021-07-31T00:00:00Z", "value": "5" }, { "startDate": "2021-08-01T00:00:00Z", "endDate": "2022-02-28T00:00:00Z", "value": "5" }, { "startDate": "2022-03-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "5" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "17" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "2" } ], "houseNumberAddition": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "25" } ], "postalCode": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "1121 PB" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1234 AB" } ], "municipality": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2014-07-31T00:00:00Z", "value": "Deventer" }, { "startDate": "2014-08-01T00:00:00Z", "endDate": "2022-01-31T00:00:00Z", "value": "Deventer" }, { "startDate": "2022-02-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "Deventer" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "kkvviybree" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Madrid" } ], "location": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "guufgvstcy" } ], "region": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "xhcvjoprbh" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Sanfer" } ] }, { "type": "Postal", "country": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "NL" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "NL" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL" } ], "street": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "Plotterweg" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "golurxcftu" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Vitoria2" } ], "houseNumber": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "A" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "06" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "03" } ], "houseNumberAddition": [], "postalCode": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "3821 BB" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "1234 AB" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "4567 CD" } ], "municipality": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "Amerfoort" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "ponccrykpq" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arturo2" } ], "location": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "hier" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "xhfjpfbkmu" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arturo3" } ], "region": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "werk" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "cndsqcxmkt" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arturo4" } ] } ] }   This endpoint allows to update an employee's addresses. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/addresses/10030024 Request body example: { "StartDate": "2023-04-03", "Addresses": [ { "Type": "Home", "Street": "Straat", "HouseNumber": "1", "Municipality": "Municipality", "Region": "Amsterdam" }, { "Type": "Postal", "Street": "Tejas", "HouseNumber": "1", "Municipality": "San Fernando", "Region": "Madrid" } ] } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "4385028f-e8b2-4503-9b94-4b0ae6aaa653" }   Bank Accounts These endpoints return the bank account data of the employees that consists of 10 bank accounts. Each field has its own timeline.   Get the bank accounts of all employees of a customer: - Get: https://api.youserve.nl/hrp/v1.0/bankAccounts   Get the bank accounts of all employees of a company: -  Get: https://api.youserve.nl/hrp/v1.0/bankAccounts?companyId=10028636   Get the bank accounts of an employee: -  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024/bankAccounts   Response example: { "employeeId": 10030024, "companyId": 10028636, "personCode": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "NU1926" } ], "employeeCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "120" } ], "initials": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2022-01-31T00:00:00Z", "value": "A.H." }, { "startDate": "2022-02-01T00:00:00Z", "endDate": "2023-03-05T00:00:00Z", "value": "A.H.T." }, { "startDate": "2023-03-06T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "AB" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "AFR" } ], "lastName": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Huffman" } ], "bankAccounts": [ { "id": 1, "iban": [ { "startDate": "2012-10-01T00:00:00Z", "endDate": "2013-01-31T00:00:00Z", "value": "NL50INGB0000009887" }, { "startDate": "2013-02-01T00:00:00Z", "endDate": "2013-08-31T00:00:00Z", "value": "NL50INGB0000009887" }, { "startDate": "2013-09-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "NL50INGB0000009887" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "GB33BUKB20201555555555" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "GB33BUKB20201555555555" } ], "bic": [ { "startDate": "2012-10-01T00:00:00Z", "endDate": "2013-01-31T00:00:00Z", "value": "INGBNL2A" }, { "startDate": "2013-02-01T00:00:00Z", "endDate": "2013-08-31T00:00:00Z", "value": "INGBNL2A" }, { "startDate": "2013-09-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "INGBNL2A" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "MOLUNL22" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "MOLUNL22" } ], "description": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "tksapvnxfq" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NewDescription" } ], "accountType": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "01" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "01" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "accountHolder": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "stppb" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arthur" } ], "amount": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "100,5" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "100" } ] }, { "id": 2, "iban": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "GB33BUKB20201555555555" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "GB33BUKB20201555555555" } ], "bic": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "MOLUNL22" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "MOLUNL22" } ], "description": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "wxrhuivevj" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "NewDescription2" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "test5" } ], "accountType": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "01" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "accountHolder": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "nqvmq" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arthur" } ], "amount": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "100,5" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "4" } ] }, { "id": 3, "iban": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "GB33BUKB20201555555555" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "GB33BUKB20201555555555" } ], "bic": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "MOLUNL22" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "MOLUNL22" } ], "description": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "jipeavrepm" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "test5" } ], "accountType": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "01" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "accountHolder": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "nnfkk" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arthur" } ], "amount": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "100,5" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "3" } ] }, { "id": 4, "iban": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "GB33BUKB20201555555555" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "GB33BUKB20201555555555" } ], "bic": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "MOLUNL22" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "MOLUNL22" } ], "description": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "wnwifysqin" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "test5" } ], "accountType": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "01" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "accountHolder": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "gcimf" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arthur" } ], "amount": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "100,5" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "2" } ] }, { "id": 5, "iban": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "GB33BUKB20201555555555" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "GB33BUKB20201555555555" } ], "bic": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "MOLUNL22" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "MOLUNL22" } ], "description": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "rkqdbeusep" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "test5" } ], "accountType": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "01" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "accountHolder": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "ckocx" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "arthur" } ], "amount": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-04-02T00:00:00Z", "value": "100,5" }, { "startDate": "2023-04-03T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1" } ] } ] } This endpoint allows to update an employee's bank accounts. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/bankAccounts/10030024 Request body example:   { "StartDate": "2023-04-03", "BankAccounts": [ { "Id": 1, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "tksapvnxfq", "AccountType": "01", "AccountHolder": "stppb", "Amount": "100,5" }, { "Id": 2, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "wxrhuivevj", "AccountType": "01", "AccountHolder": "nqvmq", "Amount": "100,5" }, { "Id": 3, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "jipeavrepm", "AccountType": "01", "AccountHolder": "nnfkk", "Amount": "100,5" }, { "Id": 4, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "wnwifysqin", "AccountType": "01", "AccountHolder": "gcimf", "Amount": "100,5" }, { "Id": 5, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "rkqdbeusep", "AccountType": "01", "AccountHolder": "ckocx", "Amount": "100,5" } ] }   As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "72d2bd02-517e-425e-9593-cc2f631b09aa" }   Personal Details These endpoints return the personal details of the employee. Each field has its own timeline.   Get the personal details of all employees of a customer: - Get: https://api.youserve.nl/hrp/v1.0/personalDetails   Get the personal details of all employees of a company: -  Get: https://api.youserve.nl/hrp/v1.0/personalDetails?companyId=10028636   Get the personal details of an employee: -  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024/personalDetails   Response example: { "employeeId": 10030024, "companyId": 10028636, "personCode": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "NU1926" } ], "employeeCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "120" } ], "initials": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2022-01-31T00:00:00Z", "value": "A.H." }, { "startDate": "2022-02-01T00:00:00Z", "endDate": "2023-03-05T00:00:00Z", "value": "A.H.T." }, { "startDate": "2023-03-06T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "AB" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "AFR" } ], "firstNames": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-01-31T00:00:00Z", "value": "Arno Hendrik" }, { "startDate": "2023-02-01T00:00:00Z", "endDate": "2023-03-05T00:00:00Z", "value": "Joshua Megan" }, { "startDate": "2023-03-06T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Juan_1" } ], "knownAs": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-04T00:00:00Z", "value": "Arno" }, { "startDate": "2023-03-05T00:00:00Z", "endDate": "2023-03-05T00:00:00Z", "value": "1" }, { "startDate": "2023-03-06T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "Juan_1" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Peter" } ], "lastName": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Huffman" } ], "lastNamePrefix": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "de" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "ak" } ], "maritalStatus": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "1" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1" } ], "partnerName": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "Heek" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "hlplocatnw" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Lola" } ], "partnerNamePrefix": [ { "startDate": "2017-07-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "van" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "nf" } ], "titlePrefix": [ { "startDate": "2023-03-05T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "1" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "rm" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Mr" } ], "titleSuffix": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "k" } ], "gender": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2013-05-31T00:00:00Z", "value": "1" }, { "startDate": "2013-06-01T00:00:00Z", "endDate": "2014-07-31T00:00:00Z", "value": "1" }, { "startDate": "2014-08-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "1" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1" } ], "birthDate": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "1962-11-08" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "2010-03-05" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1979-03-23" } ], "birthplace": [], "nationality": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "2006-10-31T00:00:00Z", "value": "0001" }, { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "0001" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "0001" } ], "dateOfDeath": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "2023-03-08" } ], "userUID": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "FakePingId" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "046588" } ], "communicationLanguage": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "2006-10-31T00:00:00Z", "value": "NL" }, { "startDate": "2006-11-01T00:00:00Z", "endDate": "2013-08-31T00:00:00Z", "value": "NL" }, { "startDate": "2013-09-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "NL" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL" } ], "bsnSocSecNumber": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-26T00:00:00Z", "value": "111222333" }, { "startDate": "2023-03-27T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "283232237" } ], "phoneNumbers": [ { "type": "Mobile", "number": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "06-11987622" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "085282265" } ] }, { "type": "Mobile", "number": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "532186503" } ] } ], "emailAddresses": [ { "type": "Work", "email": [ { "startDate": "2006-11-01T00:00:00Z", "endDate": "2022-02-28T00:00:00Z", "value": "ah.devoogd@raet.com" }, { "startDate": "2022-03-01T00:00:00Z", "endDate": "2023-03-08T00:00:00Z", "value": "demo@raet.com" }, { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "test2@visma.com" } ] }, { "type": "Private", "email": [ { "startDate": "2023-03-09T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "test@visma.com" } ] } ] } This endpoint allows to update an employee's personal details. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/personalDetails/10030024 Request body example: { "StartDate": "2023-03-09", "PersonalDetails": { "EmployeeCode": "AFR26", "Initials": "AFR", "FirstNames": "Arturo", "KnownAs": "Arthur", "LastName": "Conan", "LastNamePrefix": "mr", "MaritalStatus": "1", "PartnerName": "Alexandra", "PartnerNamePrefix": "ms", "TitlePrefix": "Dr", "TitleSuffix": "jr", "Gender": "1", "BirthDate": "1978-03-12", "Birthplace": "The Netherlands", "Nationality": "0001", "DateOfDeath": "", "UserUID": "046588", "CommunicationLanguage": "NL", "PhoneNumbers": [ { "Type": "Mobile", "Number": "639424977" }, { "Type": "Private", "Number": "912801078" } ], "EmailAddresses": [ { "Type": "Private", "Email": "arthur@gmail.com" }, { "Type": "Work", "Email": "arturo.conan@visma.com" } ] } } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "50b00afd-e9f2-44b1-bc10-c2a3132641a7" }   Employees These endpoints return the data of the employees: personal details, bank accounts, addresses. Each field has its own timeline.   Get all employees of a customer: - Get: https://api.youserve.nl/hrp/v1.0/employees   Get all employees of a company: -  Get: https://api.youserve.nl/hrp/v1.0/employees?companyId=10028636   Get the data of an employee: -  Get: https://api.youserve.nl/hrp/v1.0/employees/10030024   Response example: { "employeeId": 10030307, "companyId": 10028637, "personalDetails": { "personCode": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "NU1545" } ], "employeeCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "10090" } ], "initials": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "IH" } ], "firstNames": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Inge" } ], "knownAs": [], "lastName": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Rooibos" } ], "lastNamePrefix": [], "maritalStatus": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1" } ], "partnerName": [], "partnerNamePrefix": [], "titlePrefix": [], "titleSuffix": [], "gender": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "2" } ], "birthDate": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1974-08-09" } ], "birthplace": [], "nationality": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "0001" } ], "dateOfDeath": [], "userUID": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "FakePingId" } ], "communicationLanguage": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL" } ], "bsnSocSecNumber": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "080141729" } ], "phoneNumbers": [], "emailAddresses": [] }, "addresses": [ { "type": "Home", "country": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL" } ], "street": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Dorpstraat" } ], "houseNumber": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "12" } ], "houseNumberAddition": [], "postalCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "6745 re" } ], "municipality": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2016-06-30T00:00:00Z", "value": "Oegstgeest" }, { "startDate": "2016-07-01T00:00:00Z", "endDate": "2017-05-31T00:00:00Z", "value": "Oegstgeest" }, { "startDate": "2017-06-01T00:00:00Z", "endDate": "2023-01-31T00:00:00Z", "value": "Oegstgeest" }, { "startDate": "2023-02-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Oegstgeest" } ], "location": [], "region": [] }, { "type": "Postal", "country": [], "street": [], "houseNumber": [], "houseNumberAddition": [], "postalCode": [], "municipality": [], "location": [], "region": [] } ], "bankAccounts": [ { "id": 1, "iban": [ { "startDate": "2013-09-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL55INGB0000005432" } ], "bic": [ { "startDate": "2013-09-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "INGBNL2A" } ], "description": [], "accountType": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "accountHolder": [], "amount": [] }, { "id": 2, "iban": [ { "startDate": "2013-09-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL76INGB0000000689" } ], "bic": [ { "startDate": "2013-09-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "INGBNL2A" } ], "description": [], "accountType": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "06" } ], "accountHolder": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Wehkamp" } ], "amount": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "200" } ] }, { "id": 4, "iban": [ { "startDate": "2013-09-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL81INGB0000002345" } ], "bic": [ { "startDate": "2013-09-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "INGBNL2A" } ], "description": [], "accountType": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "03" } ], "accountHolder": [], "amount": [] } ] }   This endpoint allows to create an employee (Hire). No contract data is needed except for the Collective Labour Agreement that is mandatory. Also it is allowed to send the field "templateGroup" in the contract data and the data of the employee in HR Core will be filled in according with the definition. - Post: https://api.youserve.nl/hrp/v1.0/employees Request body example: { "companyId": 10028637, "startDate": "2023-03-29", "PersonalDetails": { "EmployeeCode": "YSDU001", "Initials": "A.", "FirstNames": "Arthur Ignatius", "KnownAs": "A2D2", "LastName": "Conan Doyle", "LastNamePrefix": " van", "MaritalStatus": "1", "PartnerName": "Jean Leckie", "PartnerNamePrefix": "van", "TitlePrefix": "Mr.", "TitleSuffix": "ex", "Gender": "1", "BirthDate": "1978/05/22", "Birthplace": "Spain", "Nationality": "0001", "UserUID": "1234567", "CommunicationLanguage": "NL", "BsnSocSecNumber": "292985782", "PhoneNumbers": [ { "Type": "Mobile", "Number": "085282265" }, { "Type": "Private", "Number": "532186503" } ], "EmailAddresses": [ { "Type": "Private", "Email": "test@visma.com" }, { "Type": "Work", "Email": "test2@visma.com" } ] }, "Addresses": [ { "Type": "Home", "Country": "NL", "Street": "wigsfrfvpb", "HouseNumber": "17", "HouseNumberAddition": "25", "PostalCode": "1234 AB", "Municipality": "kkvviybree", "Location": "guufgvstcy", "Region": "xhcvjoprbh" }, { "Type": "Postal", "Country": "NL", "Street": "golurxcftu", "HouseNumber": "13", "HouseNumberAddition": "06", "PostalCode": "1234 AB", "Municipality": "ponccrykpq", "Location": "xhfjpfbkmu", "Region": "cndsqcxmkt" } ], "BankAccounts": [ { "Id": 1, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "tksapvnxfq", "AccountType": "01", "AccountHolder": "stppb", "Amount": "101,5" }, { "Id": 2, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "wxrhuivevj", "AccountType": "01", "AccountHolder": "nqvmq", "Amount": "102,5" }, { "Id": 3, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "jipeavrepm", "AccountType": "01", "AccountHolder": "nnfkk", "Amount": "103,5" }, { "Id": 4, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "wnwifysqin", "AccountType": "01", "AccountHolder": "gcimf", "Amount": "104,5" }, { "Id": 5, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "rkqdbeusep", "AccountType": "01", "AccountHolder": "ckocx", "Amount": "105,5" } ], "Contract": { "CollectiveLabourAgreement": "13155437" } } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "d5e5edd9-bdf2-4413-bf53-340982d8f48e" }   This endpoint allows to update an employee. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/employees/10030024 Request body example: { "StartDate": "2023-03-09", "PersonalDetails": { "EmployeeCode": "120", "Initials": "fq", "FirstNames": "cafkndvcro", "KnownAs": "yuwlr", "LastName": "aisejkqi", "LastNamePrefix": "ak", "MaritalStatus": "1", "PartnerName": "hlplocatnw", "PartnerNamePrefix": "nf", "TitlePrefix": "rm", "TitleSuffix": "k", "Gender": "1", "BirthDate": "2010-03-05T00:00:00", "Birthplace": "spain", "Nationality": "0001", "DateOfDeath": "2023-03-09T00:00:00+01:00", "UserUID": "046588", "CommunicationLanguage": "NL", "PhoneNumbers": [ { "Type": "Mobile", "Number": "085282265" }, { "Type": "Private", "Number": "532186503" } ], "EmailAddresses": [ { "Type": "Private", "Email": "test@visma.com" }, { "Type": "Work", "Email": "test2@visma.com" } ] }, "Addresses": [ { "Type": "Home", "Country": "NL", "Street": "wigsfrfvpb", "HouseNumber": "17", "HouseNumberAddition": "25", "PostalCode": "1234 AB", "Municipality": "kkvviybree", "Location": "guufgvstcy", "Region": "xhcvjoprbh" }, { "Type": "Postal", "Country": "NL", "Street": "golurxcftu", "HouseNumber": "13", "HouseNumberAddition": "06", "PostalCode": "1234 AB", "Municipality": "ponccrykpq", "Location": "xhfjpfbkmu", "Region": "cndsqcxmkt" } ], "BankAccounts": [ { "Id": 1, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "tksapvnxfq", "AccountType": "01", "AccountHolder": "stppb", "Amount": "100,5" }, { "Id": 2, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "wxrhuivevj", "AccountType": "01", "AccountHolder": "nqvmq", "Amount": "100,5" }, { "Id": 3, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "jipeavrepm", "AccountType": "01", "AccountHolder": "nnfkk", "Amount": "100,5" }, { "Id": 4, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "wnwifysqin", "AccountType": "01", "AccountHolder": "gcimf", "Amount": "100,5" }, { "Id": 5, "Iban": "GB33BUKB20201555555555", "Bic": "MOLUNL22", "Description": "rkqdbeusep", "AccountType": "01", "AccountHolder": "ckocx", "Amount": "100,5" } ] } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "c0abf203-f569-445a-823b-921d702785e6" }   Contracts These endpoints return the data of the contracts. Each field has its own timeline.   Get all contracts of a customer: - Get: https://api.youserve.nl/hrp/v1.0/contracts   Get all contracts of an employee: -  Get: https://api.youserve.nl/hrp/v1.0/contracts?employeeId=10030024   Get the data of a contract: -  Get: https://api.youserve.nl/hrp/v1.0/contracts/10030025   Response example: { "employeeId": 10036130, "companyCode": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "1" } ], "personCode": [], "employeeCode": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "594" } ], "initials": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "GH" } ], "lastName": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "Meer" } ], "contractId": 10030025, "employmentCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1" } ], "description": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "TestPatch" } ], "jobProfile": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Proj_L" } ], "daysPeriod": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "2023-03-22T00:00:00Z", "value": "5" }, { "startDate": "2022-12-01T00:00:00Z", "endDate": "2022-12-31T00:00:00", "value": "5" }, { "startDate": "2023-01-01T00:00:00Z", "endDate": "2023-01-31T00:00:00", "value": "4" }, { "startDate": "2023-02-01T00:00:00Z", "endDate": "2023-03-22T00:00:00", "value": "5" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "2023-03-24T00:00:00Z", "value": "7" }, { "startDate": "2023-03-25T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "7" } ], "hoursPeriod": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "2015-02-28T00:00:00Z", "value": "40" }, { "startDate": "2015-03-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "36" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "2023-03-24T00:00:00Z", "value": "3" }, { "startDate": "2023-03-25T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "3" } ], "contractType": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "B" } ], "location": [], "costCenter": [], "collectiveLaborAgreement": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "10027028" } ], "contractEndDate": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "9999-12-31" } ], "department": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "BD" } ], "incomeRelationshipNumber": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "16" } ], "writtenLaborAgreement": [ { "startDate": "2019-10-31T00:00:00Z", "endDate": "9999-12-31T00:00:00", "value": "J" }, { "startDate": "2019-11-01T00:00:00Z", "endDate": "9999-12-31T00:00:00", "value": "J" } ], "onCallAgreement": [ { "startDate": "2019-10-31T00:00:00Z", "endDate": "9999-12-31T00:00:00", "value": "N" }, { "startDate": "2019-11-01T00:00:00Z", "endDate": "9999-12-31T00:00:00", "value": "N" } ], "mainOrAncillaryContract": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "1" } ], "probationaryPeriod": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "0" } ], "hireDate": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "1996-11-01" } ], "firstHireDate": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "1996-11-01" } ], "establishmentUnit": [ { "startDate": "2006-01-01T00:00:00+00:00", "endDate": "9999-12-31T00:00:00+00:00", "value": "10054050" } ], "organizationalUnit": [ { "startDate": "2023-04-01T00:00:00Z", "endDate": "9999-12-31T00:00:00", "value": "13234918" } ] } This endpoint allows to update an employee. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/contracts/10031392 Request body example: { "startDate": "2023-04-24", "employmentCode": "2", "description": "stringTest", "jobProfile": "AF", "daysPeriod": 7, "hoursPeriod": 9, "contractType": "C", "location": "Madrid", "costCenter": "01", "collectiveLaborAgreement": 10027028, "contractEndDate": "2026-01-01", "department": "AF", "incomeRelationshipNumber": 2, "writtenLaborAgreement": "K", "onCallAgreement": "Y", "mainOrAncillaryContract": "0", "probationaryPeriod": "5", "hireDate": "2023-04-24", "firstHireDate": "2000-01-01", "establishmentUnit": "10054051", "organizationalUnit": "10641457" } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "2788965b-bafb-4cc8-a235-3dd0efb3ffae" }   Benefits These endpoints return the data of the benefits: Salary scale or Gross variable. The timeline is associated to the set of fields.   Get the Salary scale data of a contract: - Get: https://api.youserve.nl/hrp/v1.0/contracts/10030338/salaryScale Response example: [ { "validFrom": "2006-01-01T00:00:00", "validUntil": "2008-06-30T00:00:00", "contractId": 10030338, "employeeId": 10033542, "personCode": null, "employeeCode": "592", "initials": "M.", "lastName": "Ruiter", "companyCode": "2", "employmentCode": "1", "salaryPeriodicity": "13", "salaryScale": null, "salaryLevel": 0, "rsp": 0, "category": null, "factorToConvertAnnualSalary": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false, "blockCollectiveSalaryIncrease": false, "assessmentScore": null, "blockIncreaseOfSalaryBasedOnAssessment": false, "salaryAmount": 0 }, { "validFrom": "2008-07-01T00:00:00", "validUntil": "2012-02-29T00:00:00", "contractId": 10030338, "employeeId": 10033542, "personCode": null, "employeeCode": "592", "initials": "M.", "lastName": "Ruiter", "companyCode": "2", "employmentCode": "1", "salaryPeriodicity": "13", "salaryScale": "10", "salaryLevel": 0, "rsp": 0, "category": null, "factorToConvertAnnualSalary": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false, "blockCollectiveSalaryIncrease": false, "assessmentScore": null, "blockIncreaseOfSalaryBasedOnAssessment": false, "salaryAmount": 500 }, { "validFrom": "2012-03-01T00:00:00", "validUntil": "2012-12-30T00:00:00", "contractId": 10030338, "employeeId": 10033542, "personCode": null, "employeeCode": "592", "initials": "M.", "lastName": "Ruiter", "companyCode": "2", "employmentCode": "1", "salaryPeriodicity": "13", "salaryScale": "10", "salaryLevel": 0, "rsp": 0, "category": null, "factorToConvertAnnualSalary": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false, "blockCollectiveSalaryIncrease": false, "assessmentScore": null, "blockIncreaseOfSalaryBasedOnAssessment": false, "salaryAmount": 500 }, { "validFrom": "2012-12-31T00:00:00", "validUntil": "2013-12-31T00:00:00", "contractId": 10030338, "employeeId": 10033542, "personCode": null, "employeeCode": "592", "initials": "M.", "lastName": "Ruiter", "companyCode": "2", "employmentCode": "1", "salaryPeriodicity": "13", "salaryScale": "10", "salaryLevel": 0, "rsp": 0, "category": null, "factorToConvertAnnualSalary": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false, "blockCollectiveSalaryIncrease": false, "assessmentScore": null, "blockIncreaseOfSalaryBasedOnAssessment": false, "salaryAmount": 500 }, { "validFrom": "2014-01-01T00:00:00", "validUntil": "9999-12-31T00:00:00", "contractId": 10030338, "employeeId": 10033542, "personCode": null, "employeeCode": "592", "initials": "M.", "lastName": "Ruiter", "companyCode": "2", "employmentCode": "1", "salaryPeriodicity": "13", "salaryScale": "10", "salaryLevel": 0, "rsp": 0, "category": null, "factorToConvertAnnualSalary": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false, "blockCollectiveSalaryIncrease": false, "assessmentScore": null, "blockIncreaseOfSalaryBasedOnAssessment": false, "salaryAmount": 2075 } ] Get the Gross variable data of a contract: - Get: https://api.youserve.nl/hrp/v1.0/contracts/10030778/grossVariable Response example:   [ { "validFrom": "2006-01-01T00:00:00", "validUntil": "2012-12-30T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 0, "salaryHoursWorked": 0, "salaryDaysWorked": 0, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false }, { "validFrom": "2012-12-31T00:00:00", "validUntil": "2013-08-31T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 0, "salaryHoursWorked": 0, "salaryDaysWorked": 0, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false }, { "validFrom": "2013-09-01T00:00:00", "validUntil": "2015-11-30T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 0, "salaryHoursWorked": 0, "salaryDaysWorked": 0, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false }, { "validFrom": "2015-12-01T00:00:00", "validUntil": "2015-12-31T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 10, "salaryHoursWorked": 160, "salaryDaysWorked": 20, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false }, { "validFrom": "2016-01-01T00:00:00", "validUntil": "2016-01-31T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 10, "salaryHoursWorked": 152, "salaryDaysWorked": 19, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false }, { "validFrom": "2016-02-01T00:00:00", "validUntil": "2016-02-29T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 10, "salaryHoursWorked": 100, "salaryDaysWorked": 13, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false }, { "validFrom": "2016-03-01T00:00:00", "validUntil": "9999-12-31T00:00:00", "employeeId": 10033760, "personCode": null, "employeeCode": "602", "initials": "K.", "lastName": "Buiten", "contractId": 10030778, "companyCode": "2", "employmentCode": "1", "salaryHourlyRate": 10, "salaryHoursWorked": 0, "salaryDaysWorked": 0, "salaryScale": null, "salaryLevel": 0, "rsp": 0, "alternateSalaryHourlyWages": 0, "autoIncreaseLevelBasedOnAge": false, "autoLevelIncreaseBasedOnYearsInService": false } ]   This endpoint allows to update the salary scale data of a contract. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/contracts/10030025/salaryScale Request body example: { "startDate": "2023-03-23", "salaryPeriodicity": "13", "salaryScale": "2", "salaryLevel": 11, "rsp": 8, "category": "2", "factorToConvertAnnualSalary": 1, "autoIncreaseLevelBasedOnAge": true, "autoLevelIncreaseBasedOnYearsInService": false, "blockCollectiveSalaryIncrease": true, "blockIncreaseOfSalaryBasedOnAssessment": true, "salaryAmount": 1000 } This endpoint allows to update the gross variable data of a contract. The request body is fixed and the missing fields are ignored. The start date is mandatory. - Patch: https://api.youserve.nl/hrp/v1.0/contracts/10030025/grossVariable Request body example: { "startDate": "2023-03-23", "salaryHourlyRate": 8, "salaryHoursWorked": 8, "salaryDaysWorked": 5, "salaryScale": "2", "salaryLevel": 11, "rsp": 8, "alternateSalaryHourlyWages": 2, "autoIncreaseLevelBasedOnAge": true, "autoLevelIncreaseBasedOnYearsInService": false } As they are asynchronous operations, you will get a requestId to check using the Get request status endpoint. { "requestId": "366c639d-0336-4818-8394-4116f8cf8bbe" }   Value lists These endpoints return the different value lists used in the employee and contract data. It is possible to set filters for language and reference date.   Marital statuses: - Get: https://api.youserve.nl/hrp/v1.0/maritalStatuses - Get: https://api.youserve.nl/hrp/v1.0/maritalStatuses?language=NL - Get: https://api.youserve.nl/hrp/v1.0/maritalStatuses?referenceDate=2023-01-01   Genders: - Get: https://api.youserve.nl/hrp/v1.0/genders - Get: https://api.youserve.nl/hrp/v1.0/genders?language=NL - Get: https://api.youserve.nl/hrp/v1.0/genders?referenceDate=2023-01-01   Nationalities: - Get: https://api.youserve.nl/hrp/v1.0/nationalities - Get: https://api.youserve.nl/hrp/v1.0/nationalities?language=NL - Get: https://api.youserve.nl/hrp/v1.0/nationalities?referenceDate=2023-01-01   Communication Languages: - Get: https://api.youserve.nl/hrp/v1.0/communicationLanguages - Get: https://api.youserve.nl/hrp/v1.0/communicationLanguages?language=NL - Get: https://api.youserve.nl/hrp/v1.0/communicationLanguages?referenceDate=2023-01-01   Countries: (Address types: Home or Postal) - Get: https://api.youserve.nl/hrp/v1.0/countries?addressType=Home - Get: https://api.youserve.nl/hrp/v1.0/countries?addressType=Home&language=NL - Get: https://api.youserve.nl/hrp/v1.0/countries?addressType=Home&referenceDate=2023-01-01   Account Types: (AccountTypeId: 1 - 10) - Get: https://api.youserve.nl/hrp/v1.0/accountTypes?accountTypeId=1 - Get: https://api.youserve.nl/hrp/v1.0/accountTypes?accountTypeId=1&language=NL - Get: https://api.youserve.nl/hrp/v1.0/accountTypes?accountTypeId=1&referenceDate=2023-01-01   Job Profiles: - Get: https://api.youserve.nl/hrp/v1.0/jobProfiles - Get: https://api.youserve.nl/hrp/v1.0/jobProfiles?language=NL - Get: https://api.youserve.nl/hrp/v1.0/jobProfiles?referenceDate=2023-01-01     Contract Types: - Get: https://api.youserve.nl/hrp/v1.0/contractTypes - Get: https://api.youserve.nl/hrp/v1.0/contractTypes?language=NL - Get: https://api.youserve.nl/hrp/v1.0/contractTypes?referenceDate=2023-01-01   Locations: - Get: https://api.youserve.nl/hrp/v1.0/locations - Get: https://api.youserve.nl/hrp/v1.0/locations?language=NL - Get: https://api.youserve.nl/hrp/v1.0/locations?referenceDate=2023-01-01   Classifications: - Get: https://api.youserve.nl/hrp/v1.0/classifications - Get: https://api.youserve.nl/hrp/v1.0/classifications?language=NL - Get: https://api.youserve.nl/hrp/v1.0/classifications?referenceDate=2023-01-01   Cost Centers: - Get: https://api.youserve.nl/hrp/v1.0/costCenters - Get: https://api.youserve.nl/hrp/v1.0/costCenters?language=NL - Get: https://api.youserve.nl/hrp/v1.0/costCenters?referenceDate=2023-01-01   Salary Scales: - Get: https://api.youserve.nl/hrp/v1.0/salaryScales - Get: https://api.youserve.nl/hrp/v1.0/salaryScales?language=NL - Get: https://api.youserve.nl/hrp/v1.0/salaryScales?referenceDate=2023-01-01   Departments: - Get: https://api.youserve.nl/hrp/v1.0/departments - Get: https://api.youserve.nl/hrp/v1.0/departments?language=NL - Get: https://api.youserve.nl/hrp/v1.0/departments?referenceDate=2023-01-01   Written Labor Agreements: - Get: https://api.youserve.nl/hrp/v1.0/writtenLaborAgreements - Get: https://api.youserve.nl/hrp/v1.0/writtenLaborAgreements?language=NL - Get: https://api.youserve.nl/hrp/v1.0/writtenLaborAgreements?referenceDate=2023-01-01   On Call Agreements: - Get: https://api.youserve.nl/hrp/v1.0/onCallAgreements - Get: https://api.youserve.nl/hrp/v1.0/onCallAgreements?language=NL - Get: https://api.youserve.nl/hrp/v1.0/onCallAgreements?referenceDate=2023-01-01   Main or Ancillary Contracts: - Get: https://api.youserve.nl/hrp/v1.0/mainOrAncillaryContracts - Get: https://api.youserve.nl/hrp/v1.0/mainOrAncillaryContracts?language=NL - Get: https://api.youserve.nl/hrp/v1.0/mainOrAncillaryContracts?referenceDate=2023-01-01   Probationary Periods: - Get: https://api.youserve.nl/hrp/v1.0/probationaryPeriods - Get: https://api.youserve.nl/hrp/v1.0/probationaryPeriods?language=NL - Get: https://api.youserve.nl/hrp/v1.0/probationaryPeriods?referenceDate=2023-01-01   Employment Types: - Get: https://api.youserve.nl/hrp/v1.0/employmentTypes - Get: https://api.youserve.nl/hrp/v1.0/employmentTypes?language=NL - Get: https://api.youserve.nl/hrp/v1.0/employmentTypes?referenceDate=2023-01-01   Response example of the previous value lists: [ { "code": "0", "description": "Unknown" }, { "code": "1", "description": "Single" }, { "code": "2", "description": "Wed" }, { "code": "3", "description": "Divorced" }, { "code": "4", "description": "Widow/widower" }, { "code": "5", "description": "Registered partnership" }, { "code": "6", "description": "Cohabiting" }, { "code": "7", "description": "Cohabiting without contract" }, { "code": "8", "description": "Cohabiting with contract" } ]   Collective Labour Agreements: - Get: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements - Get: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements/10025352 Response example: { "id": 10025352, "code": [ { "startDate": "2001-01-01T00:00:00+00:00", "endDate": "2023-03-22T00:00:00Z", "value": "487" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "codeUpd" } ], "workSchedule": [ { "startDate": "2001-12-30T00:00:00Z", "endDate": "2023-03-22T00:00:00", "value": "1111122000000000000000000000" }, { "startDate": "2001-12-31T00:00:00Z", "endDate": "2023-03-22T00:00:00", "value": "1111122000000000000000000000" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "workScheduleUpd" } ], "client": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "10029306" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "10029306" } ], "nameImplementationCompany": [ { "startDate": "2001-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NameImplementationArt" } ], "name": [ { "startDate": "2001-01-01T00:00:00+00:00", "endDate": "2023-03-22T00:00:00Z", "value": "Raet Demo Administratie NL" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "testName" } ], "workHoursScheduleWeek1": [ { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "112" } ], "flexBundleIdentification": [], "employerCategory": [], "sequenceNumber": [ { "startDate": "2001-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "00002" } ] } This endpoint allows to create a new company collective labour agreement: Post: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements Request body example: { "companyId": 13155436, "startDate": "2023-09-05", "code": "CodeArt2", "workSchedule": "WorkScheduleArt", "client": "10029306", "nameImplementationCompany": "NameImplementationArt", "name": "Name4", "workHoursScheduleWeek1": "112", "sequenceNumber": "0007" } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "c2c131ce-59ef-4ab5-b60f-c0a68474fc28" }   This endpoint allows to update a company collective labour agreement. The body is fixed and the missing fields are ignored. Patch: https://api.youserve.nl/hrp/v1.0/collectiveLabourAgreements/14073663 Request body example: { "startDate": "2023-02-02", "code": "CodeArt2", "workSchedule": "WorkScheduleArt", "client": "10029306", "nameImplementationCompany": "NameImplementationArt", "name": "Name4", "workHoursScheduleWeek1": "112", "sequenceNumber": "0008" } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "c2c131ce-59ef-4ab5-b60f-c0a68474fc28" }   Organizational Units: - Get: https://api.youserve.nl/hrp/v1.0/organizationalUnits - Get: https://api.youserve.nl/hrp/v1.0/organizationalUnits/10641457 Response example: { "id": 10641457, "code": [ { "startDate": "2009-11-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "ILaYVs" } ], "name": [ { "startDate": "2009-11-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "name" } ], "backupManager": [ { "startDate": "2009-11-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "10647865" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "13375375" } ], "numberOfFTEs": [ { "startDate": "2009-11-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "12" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1" } ], "manager": [ { "startDate": "2009-11-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "10033037" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "10033037" } ], "numberKvK": [], "organizationType": [ { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "01" } ], "numberOfEmployees": [ { "startDate": "2009-11-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "12" } ], "yearEstimation": [ { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "1212" } ], "educationBudget": [ { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "2121" } ] }   This endpoint allows to create a new organizational unit: Post: https://api.youserve.nl/hrp/v1.0/organizationalUnits Request body example: { "tenantId": 10029872, "startDate": "2023-01-01", "code": "ART1", "name": "name", "backupManager": "13375375", "numberOfFTEs": "1", "manager": "10033037", "numberKvK": "11", "organizationType": "01", "numberOfEmployees": "12", "yearEstimation": "2023", "educationBudget": "455" } As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "99045997-77e5-46b0-8657-8a3612e3f9d8" }   This endpoint allows to update an organizational unit. The body is fixed and the missing fields are ignored. Patch: https://api.youserve.nl/hrp/v1.0/organizationalUnits/14075602 Request body example:   { "startDate": "2023-01-01", "code": "ART51", "name": "nameUp", "backupManager": "13375375", "numberOfFTEs": "11", "manager": "10033037", "numberKvK": "111", "organizationType": "01", "numberOfEmployees": "121", "yearEstimation": "20231", "educationBudget": "4551" }  As it is an asynchronous operation, you will get a requestId to check using the Get request status endpoint. { "requestId": "2cec716f-34f7-4602-b81c-a1c074d2937e" }   Establishment Units: - Get: https://api.youserve.nl/hrp/v1.0/establishmentUnits - Get: https://api.youserve.nl/hrp/v1.0/establishmentUnits/10054043 Response example: { "id": 10054043, "code": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "@710e1" } ], "name": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Ve8l7t" } ], "numberKvK": [], "addresses": [ { "type": "WorkLocation", "country": [], "regionNameAbroad": [], "municipality": [], "location": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2017-12-31T00:00:00Z", "value": "Amersfoort" }, { "startDate": "2018-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Enschede" } ], "locationDescription": [], "street": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2017-12-31T00:00:00Z", "value": "Vlasblom" }, { "startDate": "2018-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "Rembrandtlaan" } ], "streetHouseNumber": [], "houseNumber": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2017-12-31T00:00:00Z", "value": "34" }, { "startDate": "2018-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "225" } ], "houseNumberSuffix": [], "postalCode": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2017-12-31T00:00:00Z", "value": "9999 AA" }, { "startDate": "2018-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "7545 ZW" } ] }, { "type": "Mailing", "country": [ { "startDate": "2016-04-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "NL" } ], "regionNameAbroad": [], "municipality": [], "location": [], "locationDescription": [], "street": [], "streetHouseNumber": [], "houseNumber": [], "houseNumberSuffix": [], "postalCode": [] } ], "website": [ { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "www.added.com" } ], "emailAddress": [], "telephoneNumber": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "2023-03-22T00:00:00Z", "value": "033-4506506" }, { "startDate": "2023-03-23T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "112" } ], "faxNumber": [ { "startDate": "2006-01-01T00:00:00Z", "endDate": "9999-12-31T00:00:00Z", "value": "033-4506708" } ] }     Request status All asynchronous operations return a requestId. This endpoint allows to check the status of the request using the requestId.   Get the addresses of all employees of a customer: - Get: https://api.youserve.nl/hrp/v1.0/requests/31118e5d-cc72-4d43-a644-57a1afbed118   Response example: (in failure) { "processStatus": "Finished", "timeStamp": "2023-03-27 08:48:39", "result": { "status": "Failed", "errorMessages": [ "Value in field is not unique within: Company" ] } }     Postman collection and environment As attachment you can find a zip file with the collection and the environment.    
Volledig artikel weergeven
10-10-2023 12:17 (Bijgewerkt op 10-10-2023)
  • 0 Antwoorden
  • 0 kudos
  • 366 Weergaven
  Swagger documentation The following swagger page gives an overview of the endpoints: WFM API Endpoints Classifications The endpoint returns a list of all classifications. GET https://api.youserve.nl/wfm/v1.0/classifications   The valueList can be configured on different levels in HRCB; system  - The 1st level a property can be defined, this is the highest level. client  - The 2nd level, these items are defined on the tenant level and generally defined by the customer company  - The 3rd level, these items are defined on company level, meaning only relevant for the specific company the properties are defined for The company code is returned as part of the company type   Data mapping Property Description Example HR Core Business shortName short name of classification       fullName full name of the item       level Indicates the level in the core system where the item is configured (“client” level or “company” level).       validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A   Companies The endpoint GET companies gives a list of company versions of the tenant. GET https://api.youserve.nl/wfm/v1.0/companies    Retrieve 1 company by adding the id of the company: GET https://api.youserve.nl/wfm/v1.0/companies/<id>    Retrieve only records which that have changed within the provided date-time (UTC) range: GET https://api.youserve.nl/wfm/v1.0/companies?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z . Format:  YYYY-MM-DDTHH:MM:SS.sssZ Data mapping Property Description Example HR Core Business id identifier of the company     mutkey shortName short name of the company     company code fullName full name of the company     company name validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted           Cost centers The endpoint returns a list of all cost centers. GET https://api.youserve.nl/wfm/v1.0/costcenters   The valueList can be configured on different levels in HRCB; system  - The 1st level a property can be defined, this is the highest level. client  - The 2nd level, these items are defined on the tenant level and generally defined by the customer company  - The 3rd level, these items are defined on company level, meaning only relevant for the specific company the properties are defined for The company code is returned as part of the company type   Retrieve only records which that have changed within the provided date-time (UTC) range: GET https://api.youserve.nl/wfm/v1.0/costcenters?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z . Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business shortName short name of cost center       fullName full name of the cost center       level Indicates the level in the core system where the item is configured (“client” level or “company” level).       validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted           Employments The employee endpoint returns information about the employments registered in HRCB ("Medewerker > Contract").   https://api.youserve.nl/wfm/v1.0/employments   Retrieve 1 employment by adding the id of the employment. https://api.youserve.nl/wfm/v1.0/employments/<id>    Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/employments?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business id Employment id 12459897 49 Contract mutkey personCode The unique id assigned to the employee 32789 10519680 Persoon nummer personId The globally unique id assigned to an employee 12345678 7014 Uniek Persoonlijk ID (UPI) employeeCode The code of the employee or employment 12345 22 Medewerker code contractCode Code of the contract 1 91 Contract id costAllocation Deprecated use costCenter instead       dischargeDate The end date or discharge date of the employee. This is always an "up to and including" date. In case of no values the field will not be returned as part of the response body 2018-12-31 10520479 Geplande laatste datum indienst note: calculated field: [Geplande laatste datum indienst] = [Datum uitdienst] - 1 day   Datum uitdienst = fieldnr 40 hireDate Date of hire for the employment 2017-05-01 39 Datum in dienst originalHireDate The first hire date or 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 in dienst organisatie Enddate Enddate of contract 2022-12-31 7226 Afloopdatum company (deprecated)  (deprecated) Unique identifier of company the where contract is concluded 001 18 Bedrijfscode companyCode Unique identifier of company the where contract is concluded 001 18 Bedrijfscode location The location of where the employment is being performed 789 75 Vestiging site The location at which the employment is being fulfilled Vestiging 1 7449 Vestiging costCenter The cost center under which the employment is registered 012 53 Kostenplaats classification Cost allocation of the employment 123 474 Classifiecatiekenmerk 1 employmentType Code of the employment type 4 7393 Type medewerker jobProfile The job profile code 9909 DEV 97 Functie organizationUnit The organization unit id 1234567 ZKH 6000 Mutkey organisatorische eenheid employmentIndicator Indicator if employee is in or out of service 1 = In service, 2 = Out of service 38 Dienstverband indicatie emailAddresses Business email address   Business b.user@example.com 7212 E-mailadres phoneNumbers List of phone numbers and types Business +3188 345 67 89 7374 Telefoonnummer intern workingAmount Working amount of the employment. amountOfWork: numeric value representing the work amount 40   465 Uren periode periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined Week FourWeeks Month Quarter 463 Dagen/uren per Week Maand validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted Provide the active/inactive status of the record in the core system. False       Employment types The endpoint returns a list of all employment types. https://api.youserve.nl/wfm/v1.0/employmenttypes    The valueList can be configured on different levels in HRCB; system  - The 1st level a property can be defined, this is the highest level. client  - The 2nd level, these items are defined on the tenant level and generally defined by the customer company  - The 3rd level, these items are defined on company level, meaning only relevant for the specific company the properties are defined for The company code is returned as part of the company type   Data mapping Property Description Example HR Core Business shortName short name of employment type 001     fullName full name of the employment type Internship     level Indicates the level in the core system where the item is configured (“client” level or “company” level). Client     validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted             Jobprofiles GET jobprofiles The jobProfiles endpoint returns information about the job profiles (Dutch: "Functie informatie") registered.   https://api.youserve.nl/wfm/v1.0/jobprofiles   Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/jobprofiles?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business id Unique identifier of Jobprofile     mutkey of jobprofile shortName Code or short name of the Job Profile SE 97 Functie code fullName Name or full title of the Job Profile Software Engineer 5 97 Functie omschrijving jobTitle Job title description Senior Software Developer 932 Visitekaartje validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A   Leaves Returns a list of all leaves for the tenant specified in the request header consisting of: https://api.youserve.nl/wfm/v1.0/leaves    Retrieve 1 item by adding the id of the leave. https://api.youserve.nl/wfm/v1.0/leaves/<id>     Retrieve all leaves from 1 person: https://api.youserve.nl/wfm/v1.0/leaves?personCode=<personcode>   Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/leaves?from=2022-01-01T09:00:00.000Z&to=2022-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Note: When person layer is enabled in HRCore Business, the PersonId is equal to PersonCode.   Property Description Example HR Core Business   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 49 -  leave mutkey   employmentId 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   personCode The Id of a unique person within a tenant. 10056832 10519680 - Persoonscode   leaveRequestDate Represents the date the leave was requested. 2022-04-01 Request date / Datum aanvraag   leaveStartDate Represents the startdate of the leave. 2022-07-01   Starting date / Begindatum   leaveEndDate Represents the enddate of the leave. 2022-07-02    End date / Einddatum   leaveDuration  Number of leavehours.  16 Leave (Units) / Verlof(eenheden)   leaveTypeId Represents the code of a type of leave. All leavetypes can be retrieved in the endpoint leavetypes.   10000100 Type of leave / Verlofsoort   leaveReason Represents the code of a reason of leave. All leavereasons can be retrieved in the endpoint leavereasons   10000195 Leave reason / Reden verlof   leaveTypeOfSettlement Represents if the leavehours should be deducted from the balance or not 1 = Settle / Verrekenen 2 = Do not settle / Niet verrekenen 1 Type of settlement / Soort verrekening   leaveRequestStatus Represents the status of the leave request: granted, denied, etc 1 = Approved / Goedgekeurd 2 = To be approved / Te fiatteren 3 = Rejected  / Afgewezen 1 Status leave request / Status verlofaanvraag   validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted Provide the active/inactive status of the sickness record in the core system. False         LeaveBalances Returns a list of all available leave balances based on leave module in HR Core Business. https://api.youserve.nl/wfm/v1.0/leavebalances   Leave balance in HR Core Business   Retrieve 1 leave balance by adding the id of the item. https://api.youserve.nl/wfm/v1.0/leavebalances/<id>    Retrieve leave balance for 1 person: https://api.youserve.nl/wfm/v1.0/leavebalances?personid=<personid>   Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/leavebalances?from=2022-10-01T09:00:00.000Z&to=2022-10-02T09:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping  Property Description Example HR Core Business (technical number) id Technical and unique ID of the leave balance.  This unique ID is generated by the system and can not be changed by a user. 35148458 n/a personId The Id of a unique person within a tenant. This field refers to the Id in the endpoint Persons. 1000 Unique Person ID (7014) employmentId Technical and unique ID of the employment or contract This field refers to the Id in the endpoint Employments. 35148469 Key of the contract (49) companyCode Reference to company of the employee 500 CompanyCode employeeCode Reference to the employee 1000 EmployeeCode (22) leaveBalanceDetails yearBeginDate: Begin date of the leave entitlement 2022-01-01 n/a (configuration HRCB) yearEndDate: End date of the leave entitlement 2022-12-31 n/a (configuration HRCB) expirationDate: Date of expiration of the entitlement. The leave hours are canceled after this date 2023-07-01 n/a (configuration HRCB) leaveTypeId: This field refers to the shortName in the endpoint LeaveTypes. 10004750 n/a (configuration HRCB) basicRights: The leave entitlements (in hours) granted per leave type. 160,00 n/a (configuration HRCB) ageRelatedLeaveHours: The leave entitlements (in hours) per leave type based on age and AOW age together. 8,00 n/a (configuration HRCB) yearsOfServiceRelatedHours: The leave entitlements (in hours) per leave type based on years of service. 8,00 n/a (configuration HRCB) additionalIndiviualRights: The extra rights granted (per hour) individually per leave type. 32,00 n/a (configuration HRCB) transferredRights: The transferred entitlements (per hour) per leave type. 8,99 n/a (configuration HRCB) hoursTakenNotSettled: The sum of the booked leave per leave type with status is "Approved" and "not to be settled". Hours are not substracted from the balance. 4,00 n/a (configuration HRCB) hoursTaken: The sum of the booked leave per leave type with status is "Approved".  24,00 n/a (configuration HRCB) balance: Total of leave balance for given leave type.  160,00 n/a (configuration HRCB) validFrom The date from which the record is valid 2020-04-01 Reference date (peildatum) validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record (9999-12-31). 9999-12-31 2020-05-01 n/a isDeleted Provide the active/inactive status of the record in the core system. False n/a       LeaveBalancesPayroll Returns a list of all available leave balances based on payroll calculations for the tenant. https://api.youserve.nl/wfm/v1.0/leavebalancespayroll   Retrieve 1 LeaveBalancesPayroll by adding the id of the item. https://api.youserve.nl/wfm/v1.0/leavebalancespayroll/<id>    Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/leavebalancespayroll?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping  Property Description Example HR Core Business id Unique ID of the leave entitlements.  This unique ID is generated by the system and can not be changed by a user. 2359055420217 Combined field of: [EmployeeId] +  [Payroll year] + [Payroll period] Example: EmployeeId= 23590554 Payroll Year = 2021 Payroll Period = 7 ID = 23590554202107 personId The Id of a unique person within a tenant. 10056832 7014 - Unique Person ID employeeID Unique technical ID of the employee 23590554 EmployeeId employmentId 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 companyCode Reference to company of the employee 001 CompanyCode employeeCode Reference to the employee T0120 EmployeeCode payrollYear Year of the monthly or 4-weekly payroll calculation 2021 PayrollYear payrollPeriod Period of the monthly or 4-weekly payroll calculation  7 PayrollPeriod   leaveBalanceLegalHoliday Leave balance for regular leave as calculated by the payroll 138,40 leaveBalanceLegalHoliday payroll element = 10524591 leaveBalanceAboveLegal Leave balance for regular leave as calculated by the payroll 41,02 leaveBalanceAboveLegal payroll element = 10524590 leaveBalanceTVT Leave balance for "time for time" calculated by the payroll 24,00 LeaveBalanceTVT payroll element = 10524137 leaveBalanceATV Leave balance for "Reduction of working hours" calculated by the payroll 48,00 LeaveBalanceAtv payroll element = 10524136     Leave types The endpoint returns a list of all leave types. https://api.youserve.nl/wfm/v1.0/leavetypes   Data mapping Property Description Example HR Core Business shortName Short name of leave type 123     fullName full name of leave type Leave     level Indicates the level in HRCore Business where the item is configured: system, client, company. company     companyCode   If level is "company" then the         validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted Provide the active/inactive status of the record in the core system. False         Leave reasons The endpoint returns a list of all leave reasons. https://api.youserve.nl/wfm/v1.0/leavereasons   Data mapping Property Description Example HR Core Business shortName Short name of leave reason 123     fullName full name of leave reason compassionate leave     level Indicates the level in HRCore Business where the item is configured: system, client, company. company     companyCode   If level is "company" then the         validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted Provide the active/inactive status of the record in the core system. False             Locations The endpoint returns a list of all locations. https://api.youserve.nl/wfm/v1.0/locations   The valueList can be configured on different levels in HRCB; system  - The 1st level a property can be defined, this is the highest level. client  - The 2nd level, these items are defined on the tenant level and generally defined by the customer company  - The 3rd level, these items are defined on company level, meaning only relevant for the specific company the properties are defined for The company code is returned as part of the company type   Data mapping Property Description Example HR Core Business shortName Short name of location AMS     fullName full name of location Amsterdam     level Indicates the level in the core system where the item is configured (“client” level or “company” level). Client     validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted Provide the active/inactive status of the sickness record in the core system. False         Maternityleaves Returns a list of all maternity leaves for the tenant specified in the request header consisting of: https://api.youserve.nl/wfm/v1.0/maternityleaves   Retrieve 1 maternity leave by adding the id of the item. https://api.youserve.nl/wfm/v1.0/maternityleaves/<id>    Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/maternityleaves?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business id Technical and unique ID of the maternity registration. This unique ID is generated by the core system and can not be changed by a user. 12345678 7593 - Mutkey 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 7014 - Unique Person ID employmentId 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 startDate The first date of the sickness case. 2010-10-01 7594 - Begindatum verlof / WAZO firstWorkingDay The first day the employee appears at his work after the maturity leave period. 2010-10-04 7596 - eerste werkdag     Organization Units The organizationUnits endpoint returns information about the organization structures registered in Youforce, including:  Hierarchical information OrganizationUnit types Management information https://api.youserve.nl/wfm/v1.0/organizationunits   Retrieve 1 item by adding the id of the item. https://api.youserve.nl/wfm/v1.0/organizationunits/<id>    Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/organizationunits?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business id Unique id of the organization unit 12345678 N/A Mutkey organisatorische eendheid shortName Code or short name of the Organization Unit PD 548 Code organisatorische eenheid fullName Name or full title of the Organization Unit Product Development 549 Naam organisatorische eenheid parentOrgUnit Code of the parent organization unit PD_EU 6000 Bovenliggende organisatorische eenheid organizationUnitType Type of organization unit Divisie 7475 Type organisatorische eenheid manager Unique id of the manager 1234567 N/A Mutkey medewerker managerPersonCode deprecated       managerPersonId The globally unique id assigned to an the management employee 12345678 10519680 Persoon nummer Corresponds with: Endpoint: Person, Property: personCode validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The date from which the record is no longer valid. Will contains a default date in case no “end date“ has been defined for the record. 2020-05-01   9999-12-31 N/A  N/A isDeleted           Organization unit types The endpoint returns a list of all organization unit types: https://api.youserve.nl/wfm/v1.0/organizationunittypes    The valueList can be configured on different levels in HRCB; system  - The 1st level a property can be defined, this is the highest level. client  - The 2nd level, these items are defined on the tenant level and generally defined by the customer company  - The 3rd level, these items are defined on company level, meaning only relevant for the specific company the properties are defined for The company code is returned as part of the company type   Data mapping   Property Description Example HR Core Business HR Core Beaufort Data type shortName Short name of item AMS         string fullName full name of the item Amsterdam         string level Indicates the level in the core system where the item is configured (“client” level or “company” level). Client         string validFrom The date from which the record is valid 2020-04-01 N/A Peildatum N/A N/A YYYY-MM-DD ISO 8601 validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A N/A N/A YYYY-MM-DD ISO 8601 isDeleted                 Persons The endpoint persons gives a list of all persons (HRCore Business: "Medewerker > Persoon")) of the tenant. https://api.youserve.nl/wfm/v1.0/persons   Retrieve 1 person by adding the id of the employee. https://api.youserve.nl/wfm/v1.0/persons/<id>     Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/persons?from=2022-01-01T09:00:00.000Z&to=2022-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business id The globally unique id assigned to an employee 12345678 7014 Uniek Persoonlijk ID (UPI) personCode The unique id assigned to the employee 32789 10519680 Persoon nummer initials The initials of the employee A.B. 25 Voorletters firstNames The official given names of the employee Amy Beatrice 51 Voornamen knownAs The name which is used by the employee as 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 employee's last name at birth de 26 Voorvoegsels lastName The last name used by the employee at present de Vries - van Eijck 524 Opgemaakte naam aanhef The value is determined by the setting in nameAssembleOrder lastNamePrefix (not recommended to use this field. This field is the same as lastNameAtBirthPrefix) The prefix of the employee's last name at birth de 26 Voorvoegsels nameAssembleOrder Code of the assemble order used by the core system for the last name. Values: 0 = Partner's name + own last name 1 = Own last name only 2 = Partner's name only 3 = Own last name + partner's name 4 = Compound surname 3 28 Eigennaam code identity Identity field Johnson@email.com 7013 Identity partnerName The last name of the employee's partner Eijck 27 Naam Partner partnerNamePrefix The prefix of the partner's last name Van 166 Voorvoegsels Partner titlePrefix Formal title prefix drs. 94 Titel voor titleSuffix Formal title suffix Msc 95 Titel na gender Gender of the employee 2 36 Geslacht (0) Not known (1) Male (2) Female (9) Not applicable dateOfBirth Date of Birth 1986-02-12 35 geboorte datum deceased This field indicates if an employee is deceased when false the property is not returned true 10302568 Datum overlijden validFrom The date from which the record is valid 2020-04-01 N/A Peildatum validUntil The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. 9999-12-31 2020-05-01 N/A N/A isDeleted Provide the active/inactive status of the record in the core system. False     phoneNumbers List of phone numbers and types Home +3188 123 45 67 7376 Telefoonnummer privé Mobile +316 12 34 56 78 7377 Telefoonnummer mobiel emailAddresses Private email addresses of the employee Private p.user@example.com 7213 E-mailadres privé Addresses List of addresses   type Home street Kerkstraat 391 Straat houseNumber 1 392 Huisnummer houseNumberAddition C 393 Huisnummer toevoeging additionalAddressLine 2nd floor 8099  Locatie omschrijving postalCode 1234 AB 394 Postcode city Amersfoort 395 Woonplaats country NL 34 Woonland   type Postal street Poststraat 7572 Straat (postadres) houseNumber 1 7573 Huisnummer (postadres) houseNumberAddition A 7574 Huisnummer toev (postadres) additionalAddressLine 2nd floor 8100 Locatie omschrijving (postadres) postalCode 1234 AB 7575 Postcode (postadres) city Amersfoort 7576 Plaats (postadres) country NL 7571 Land (postadres)   Sickleaves Returns a list of all sick leaves for the tenant specified in the request header consisting of: https://api.youserve.nl/wfm/v1.0/sickleaves    Retrieve 1 item by adding the id of the sickleave. https://api.youserve.nl/wfm/v1.0/sickleaves/<id>     Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/wfm/v1.0/sickleaves?from=2022-01-01T09:00:00.000Z&to=2022-01-01T14:00:00.000Z Format:  YYYY-MM-DDTHH:MM:SS.sssZ   Data mapping Property Description Example HR Core Business 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 7014 - Unique Person ID employmentId 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 startDate The first date of the sickness case. 2010-10-01 7206 - Eerste verzuimdag expectedRecoveryDate The expected recovery date. 2010-10-04 7443 - Verwachte hersteldatum sicknessType 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 recoveryDate The recovery date is defined as the first day the employee appears at his work after a sickness period. 2010-10-05 7207 - Eerste werkdag safetynetCase Reason of Safetynet case   N/A partial recovery startDate illnessPercentage 2010-10-05 80 7464 - Ziektepercentage therapeutic period startDate endDate workingAmount workingPercentage 2010-10-07 2010-10-10 16 40  7089 - Arbeidstherapiepercentage      
Volledig artikel weergeven
30-01-2022 21:22 (Bijgewerkt op 09-10-2023)
  • 0 Antwoorden
  • 2 kudos
  • 3135 Weergaven
  This API is intended for external HR solutions and other external consumers in order to create and update data in HR Core and Payroll. This is an entity driven API, based on the following entities: Employee: Person that belongs to a company Contract: Employee in a specific position Payroll data: Benefits, fixed payments and one off payment of an employee Value lists   Employee Element Number Label Description 22 EmployeeCode Employee code 10519680 PersonCode PersonCode 25 Initials Initials 51 FirstNames First names 165 KnownAs Known As 24 LastName Last name 26 LastNamePrefix Prefixes 37 MaritalStatus Marital status 27 NamePartner Name partner 166 PrefixesPartner Prefixes partner 94 TitlePrefix Title before name 95 TitleSuffix Title after name 36 Gender Gender 35 BirthDate Birth date 7363 Birthplace Birthplace 10204761 Nationality Nationality 10302568 DateOfDeath Date Of Death 10523564 UserUID UserUID 10 Language Language 10000018 BsnSocSecNumber BSN/soc sec number 7376 TelephoneNumberPrivate Telephone number: private 7377 TelephoneNumberMobile Telephone number: mobile 7212 EmailAddress Email address 7213 EmailAddressPrivate Email address: private 34 CountryOfResidence Country of residence 391 StreetEmployee Street (employee) 392 HouseNumberEmployee House number (employee) 393 HouseNumberAdditionEmployee House number addition (employee) 394 PostalCodeEmployee Postal code (employee) 395 MunicipalityEmployee Municipality (employee) 8099 LocationDescription Location description 10205283 RegionaamBuitenland Regionaam buitenland 7571 CountryMailingAddress Country (mailing address) 7572 StreetMailingAddress Street (mailing address) 7573 AddressNumberMailingAddress Address number (mailing address) 7574 HouseNumberPostalAddress House number (postal address) 7575 PostalCodeMailingAddress Postal code (mailing address) 7576 MunicipalityMailingAddress Municipality (mailing address) 8100 LocationDescriptionMailingAddress Location description (mailing address) 8101 RegionNameAbroadMailingAddress Region name abroad (mailing address) 7745 Bic1 BIC (1) 7755 Iban1 IBAN (1) 10000037 Description1 Description (1) 10000085 AccountType1 Account type (1) 10003044 AccountHolder1 Account holder (1) 10000038 Amount1 Amount (1) 7746 Bic2 BIC (2) 7756 Iban2 IBAN (2) 10000040 Description2 Description (2) 10000041 Amount2 Amount (2) 10000086 AccountType2 Account type (2) 10003045 AccountHolder2 Account holder (2) 7747 Bic3 BIC (3) 7757 Iban3 IBAN (3) 10000043 Description3 Description (3) 10000044 Amount3 Amount (3) 10000087 AccountType3 Account type (3) 10003046 AccountHolder3 Account holder (3) 7748 Bic4 BIC (4) 7758 Iban4 IBAN (4) 10000046 Description4 Description (4) 10000047 Amount4 Amount (4) 10000088 AccountType4 Account type (4) 10003047 AccountHolder4 Account holder (4) 7749 Bic5 BIC (5) 7759 Iban5 IBAN (5) 10000049 Description5 Description (5) 10000050 Amount5 Amount (5) 10000089 AccountType5 Account type (5) 10003048 AccountHolder5 Account holder (5) 7750 Bic6 BIC (6) 7760 Iban6 IBAN (6) 10000071 Description6 Description (6) 10000072 Amount6 Amount (6) 10000090 AccountType6 Account type (6) 10003049 AccountHolder6 Account holder (6) 7751 Bic7 BIC (7) 7761 Iban7 IBAN (7) 10000074 Description7 Description (7) 10000075 Amount7 Amount (7) 10000091 AccountType7 Account type (7) 10003050 AccountHolder7 Account holder (7) 7752 Bic8 BIC (8) 7762 Iban8 IBAN (8) 10000077 Description8 Description (8) 10000078 Amount8 Amount (8) 10000092 AccountType8 Account type (8) 10003051 AccountHolder8 Account holder (8) 7753 Bic9 BIC (9) 7763 Iban9 IBAN (9) 10000080 Description9 Description (9) 10000081 Amount9 Amount (9) 10000093 AccountType9 Account type (9) 10003052 AccountHolder9 Account holder (9) 7754 Bic10 BIC (10) 7764 Iban10 IBAN (10) 10000083 Description10 Description (10) 10000084 Amount10 Amount (10) 10000094 AccountType10 Account type (10) 10003053 AccountHolder10 Account holder (10) 17 CompanyCode Company Code   Contract Element Number Label Description 91 EmploymentCode EmploymentCode 90 ContractDescription ContractDescription 97 JobProfile JobProfile 465 HoursPeriod AmountOfWork 464 DaysPeriod UnitOfWork 10204687 ContractType ContractType 75 Location Location 474 Classification Classification 53 CostCenter CostCenter 10300574 SalaryScale SalaryScale 193 CollectiveLaborAgreement CollectiveLaborAgreement 7226 ContractEndDate EndDate 96 Department Department 10301875 IncomeRelationshipNumber IncomeRelationshipNumber 10524364 WrittenLaborAgreement WrittenLaborAgreement 10524365 OnCallAgreement OnCallAgreement 10524210 MainOrAncillaryContract MainOrAncillaryContract 7145 ProbationaryPeriod Employee code 39 HireDate HireDate 308 FirstHireDate FirstHireDate 10520479 LastWorkingDate LastWorkingDate 7449 EstablishmentUnit Establishment Unit 6000 OrganizationalUnit OrganizationalUnit 7393 EmploymentType EmploymentType 22 EmployeeCode Employee code 10519680 PersonCode PersonCode 25 Initials Initials 24 LastName Last name 18 CompanyCode CompanyCode   Payroll data Benefits Salary Scale Element Number Label Description 10200268 SalaryPeriodicity Salary Periodicity 10300574 SalaryScale Salary Scale 10300575 SalaryLevel Salary Level 10308085 RSP RSP 10300576 Category Category 10513358 FactorToConvertAnnualSalary Factor To Convert Annual Salary 10513356 AutoIncreaseLevelBasedOnAge Auto Increase Level Based On Age 10524248 AutoLevelIncreaseBasedOnYearsInService Auto Level Increase Based On Years In Service 10300582 BlockCollectiveSalaryIncrease Block Collective Salary Increase 10515124 AssessmentScore Assessment Score 10515125 BlockIncreaseOfSalaryBasedOnAssessment Block Increase Of Salary Based On Assessment 10300579 SalaryAmount Salary Amount 91 EmploymentCode Employment Code 22 EmployeeCode Employee code 10519680 PersonCode Person Code 25 Initials Initials 24 LastName Last name 18 CompanyCode Company Code Gross Variable Element Number Label Description (EN) 10001489 SalaryHourlyRate Salary Hourly Rate 10001490 SalaryHoursWorked Salary Hours Worked 10001491 SalaryDaysWorked Salary Days Worked 10300574 SalaryScale Salary Scale 10300575 SalaryLevel Salary Level 10308085 RSP RSP 10512096 AlternateSalaryHourlyWages Alternate Salary Hourly Wages 10513356 AutoIncreaseLevelBasedOnAge Auto Increase Level Based On Age 10524248 AutoLevelIncreaseBasedOnYearsInService Auto Level Increase Based On Years In Service 91 EmploymentCode Employment Code 22 EmployeeCode Employee code 10519680 PersonCode PersonCode 25 Initials Initials 24 LastName Last name 18 CompanyCode CompanyCode   Value lists and other entities Company Collective Labor Agreement Element Number Label Description 47 Code Code 65 WorkSchedule Work Schedule 191 ClientCLA Client CLA 194 NameCLAImplementationCompany Name CLA Implementation Company 549 Name Name 565 WorkHoursScheduleWeek1 Work Hours Schedule Week 1 587 FlexBundleIdentification Flex Bundle Identification 893 EmployerCategory Employer Category 10520175 SequenceNumberCompanyCLA Sequence Number Company CLA 18 CompanyCode Company Code Organizational Unit Element Number Label Description 548 Code Code 549 Name Name 7011 BackupManager Backup Manager 7012 NumberOfFTEs Number Of FTEs 7137 Manager Manager 7271 NumberKvK Number KvK 7475 OrganizationType Organization Type 7476 NumberOfEmployees Number Of Employees 7477 YearEstimation Year Estimation 7478 EducationBudget Education Budget Establishment Unit Element Number Label Description 147 StreetHouseNumber Street House Number 548 Code Code 7271 NumberKvK Number KvK 7375 FaxNumber Fax Number 7380 HouseNumberMailingAddress House Number Mailing Address 7381 MunicipalityMailingAddress Municipality Mailing Address 7382 PostalCodeMailingAddress Postal Code Mailing Address 7383 StreetMailingAddress Street Mailing Address 7384 HouseNumberSuffixMailingAddress House Number Suffix Mailing Address 7415 TelephoneNumber Telephone Number 7445 WorklocationName Worklocation Name 7446 Location Location 7447 EmailAddress Email Address 7451 HouseNumber House Number 7452 HouseNumberSuffix House Number Suffix 7453 PostCode PostCode 7454 Street Street 7456 Website Website 7571 CountryMailingAddress Country Mailing Address 8099 LocationDescription Location Description 8100 LocationDescriptionMailingAddress Location Description Mailing Address 8101 RegionNameAbroadMailingAddress Region Name Abroad Mailing Address 8110 Country Country 10205283 NameRegionAbroad Name Region Abroad   Values lists Employee MaritalStatus - 37  Gender - 36 Nationality - 10204761 Communication Language - 10 34 Home Address - 7571 Postal Address - Country AccountType1-10 (10000085,10000086,10000087,10000088,10000089,10000090,10000091,10000092,10000093,10000094) Contract JobProfile - 97 ContractType - 10204687 Location - 75 Classification - 474 CostCenter - 53 Salary Scale  - 10300574 Department - 96 writtenLaborAgreement - 10524364 onCallAgreement - 10524365 mainOrAncillaryContract - 10524210 probationaryPeriod - 7145 EmploymentType - 7393 The value list endpoints return a list of codes and descriptions.
Volledig artikel weergeven
09-10-2023 10:36 (Bijgewerkt op 09-10-2023)
  • 0 Antwoorden
  • 1 kudos
  • 171 Weergaven
This API is intended for Work Force Management systems and allows them to get the data needed for Workforce management systems who are responsible the planning of employees of an organization: Retrieve employee data from Youforce Retrieve organizational structures from Youforce Retrieve job profile information from Youforce
Volledig artikel weergeven
30-01-2022 22:42 (Bijgewerkt op 19-09-2023)
  • 0 Antwoorden
  • 0 kudos
  • 820 Weergaven
  Q: How can I receive only changed records? A:  The From and To filter is available to receive changes in a given time range. The From and To filter option is available on most endpoints, except valueLists. Example employees: Returns (active) employee records that have changed within the provided date-time range.   https://api.youserve.nl/iam/v1.0/employees?from=2021-01-01T09:00:00.000Z &to=2022-01-10T14:00:00.000Z   Q: What does the 90 day retention policy signify? A:  At current, the retention policy on the data stored in for the IAM API is 90 days. Based on the following properties a record will be removed when the date defined for these properties is greater than 90 days in the past: validUntil  - all entities dischargeDate  - employments, employees endDate  - role assignments, assignments Q: Why do I see records with the with dischargeDates or endDates in the past? A: We support the notion of retroactive changes i.e. when a dischargeDate for an employment or endDate for an assignment is defined today for a date is set in the past. This can be the result of an administrative mistake. In this scenario, the record will remain available for 90 more days based on the mutation date (date when the change was made).   Q: Why do I not see all the properties mentioned in the data mapping document in my response? In the IAM API properties that do not have values defined in the core systems are hidden. For this reason there might be a different amount of properties available per record.   Q: What are extensions? A: Extensions are based on the customer-specific fields defined in the core application. These custom fields can be configured and returned as part of the API response body . As a customer I have a custom field named: “height“. As part of my integration it is important to know the height of my employees in order to validate their identity. With the extensions feature we are able to expose this field and value as part of the API response allowing the customer to validate the identity of employees with the help of their height. Extensions are only available for HR Core Business and for the Employees (employee entity) and Employments (contract entity) endpoint.   Q: Why do I have more than 1 record for my entities? A: As part of the IAM API we support support, historic, current and future changes. A change in the core is reflected by a new record in the IAM API, which can be referred to as “versions“. Each record has the following properties: validFrom - This reflects the date from which a record is considered valid, the “start date“ of the validity validUntil - This reflect the date from which a record is no longer valid, it’s “end date“ of the validity    
Volledig artikel weergeven
28-01-2022 16:34 (Bijgewerkt op 11-09-2023)
  • 0 Antwoorden
  • 0 kudos
  • 674 Weergaven
API for BI systems is already stated an API within the process to retrieve the CSV files. It is an File transfer API. This article is gonna explain from a functional perspective regards the files themselves.   Content: Within HR Core Business application the consultant on request can configure your specific needs, so that the files transported contains all relevant data based on entity level.    Time slices or Actual data With our API for BI business product we have two different content files. Depending on your choice you get one of those types Timelines  If history data is necessary you select for the timelines option. History data of max 4 years are made available Start and end date is mentioned for the whole slice of the selected elements  Whenever there is a change in the selected fields a new time slice is created with a start and end date Actual data This file contains only actual data that is active on moment of creation of the file. Selected fields have their own start and end date. Escaping within CSV file - escape double quote character " to "" (two times double quote) - enclose the whole field value with double quote character " in these cases:    -- escaping of double quote occurred    -- field contains delimiter (character | in our case)    -- field starts or ends with a whitespace character    -- field contains newline (any of CR LF characters)   example: field one|"escaped field due to character "" present"|field three|"field with | pipe character"|"  leading and trailing whitespaces  "|no whitespaces   ParentID and ID collumns These files contain 2 major components, that is the ID and ParentID collumn.    See the attachment in the model of all keyellements page there you can find the key elements (Entities) with their respective ParentID. This knowledge is necessary for knowing the relations between the key elements (Entities).   Filenames The name of the files regardless of which language you select in the API retrieval it will use the name of which is configurated.        
Volledig artikel weergeven
11-09-2023 09:16 (Bijgewerkt op 11-09-2023)
  • 0 Antwoorden
  • 2 kudos
  • 144 Weergaven
The File API allows you to download or upload files directly from YouServe, over HTTPS using the tool of your choice.
Volledig artikel weergeven
21-04-2023 16:25 (Bijgewerkt op 10-07-2023)
  • 0 Antwoorden
  • 0 kudos
  • 2862 Weergaven
API Statuses Concept APIs with this status are still under development and the development team is still making changes. Only a sandbox is available to start testing and the API cannot be used with customer environments.  Controlled Available (CA) APIs (or API versions) with this status are not ready yet to be rolled out to the complete customer base: It is available to a few access partners Connections of an access partner to the customer environment (tenant) are put on a waiting list, and it will take time before the connection is accepted There can be functional limitations of these APIs Controlled Available APIs have the usual security and support level. General Available (GA) APIs (or API versions) with this status are available to all access partners. The API can be used by all customers who use any of the HR Core systems that are supported by this API. Deprecated The API (or API version) is being phased out. We do not accept any new connections on this API (version). We will ask our access partners to move to another interface API. See also your Service Level Agreement   Life cycle policy We aim to provide you with a policy for releases and support for older versions for a consistent and predictable experience. You can also find this information in the Service Level Agreement. Different types of changes The life cycle of any API products has dependencies on underlying products. Changes in those products may require changes to the API to support it. We distinguish between breaking changes and non-breaking changes. A breaking change is one that breaks the contract an API consumer depends on, either by a change in structure, behaviour or semantics. The release and support strategy makes a clear distinction in how these are managed. Major releases At times Visma YouServe may need to make larger changes to the API. Reasons may be changes to legal requirements, adding a large new feature to the API or an change in other products the API depends on. In these cases Visma YouServe may create a new major release of the API. We strive to also keep major releases backward compatible as much as possible but this may not always be possible. In case of breaking changes In general Visma YouServe aims to have a maximum of one major release per year. Each major release will be supported for at least 24 months after releasing the next major version. As a client to our API you will have to adjust your software to follow the major releases of our API as they will impact your integration. You must update your software to support the new API version as older API versions will be decommissioned following the policy as outlined above. Minor releases A minor release will never contain breaking changes, the are used to deliver incremental changes. Minor versions will not be visible in the path of the API. Visma YouServe can install minor updates in the standard release windows or as part of a hotfix and will communicate the changes as part of the release notes. Since this does not impact any existing functionality, we do not provide side-by-side support for multiple minor versions of the same major version: a minor upgrade just replaces the previous version. As a consumer of the API it is up to you to decide if you start using the newly available features. Announcing major releases Each release of a major API version will be accompanied by communication about the support lifecycle of the current version in the release notes. When approaching the sunset-date for an API product, we will actively reach out to inform any customers still using it: Communication When Where Recipient Announcement At the release of the new major version. Includes the date of decommissioning the previous version. General release notes All recipients of general release notes.   At the release of the new major version. Includes the date of decommissioning the previous version. Developer portal Designated API contact persons 1st notification 6 months prior to decommissioning   Designated API contact persons 2nd notification 3 months prior to decommissioning   Designated API contact persons 3rd notification 1 months prior to decommissioning   Designated API contact persons     Spike arrest details Spike arrest is the way we protect against traffic spikes. Our APIs and backend can handle a certain amount of traffic, and the Spike Arrest policy smooths the traffic to the general amounts. Spike Arrest’s behaviour differs from what you might expect to see from the literal per minute values. Our default spike arrest is set to 100pm (100 requests per minute). That does not mean you can do 100 requests inside a 1-second. Spike Arrest smooths the number of full requests in a minute by dividing it into smaller intervals: Per-minute rates get smoothed into full requests allowed in intervals of seconds. For example, 100pm gets smoothed like this: 60 seconds (1 minute) / 100pm = 0.6-second intervals, or 1 request allowed every 0.6 seconds. A second request inside of 0.6 seconds will fail. Also, the 101st request within a minute will fail. When you exceed the policy, the API will return response code '429 - Too many requests' and you have to wait for the next time window.
Volledig artikel weergeven
27-01-2022 16:23 (Bijgewerkt op 21-06-2023)
  • 0 Antwoorden
  • 0 kudos
  • 926 Weergaven
Overview of all IAM endpoints including Swagger.
Volledig artikel weergeven
28-01-2022 17:07 (Bijgewerkt op 12-06-2023)
  • 0 Antwoorden
  • 0 kudos
  • 3582 Weergaven
  General Access to the Visma|YouServe support desk When Partner first starts using the Domain API’s, Visma|YouServe will create one end-user (hereinafter: Administrator) for Partner, who is given access to the Ticket system of Visma|YouServe. An Administrator is an authorized person by Partner who uses the Domain API’s and subsequently is able to create new Administrators.  The Visma|YouServe Ticket system is accessible through this link: Log Support Ticket Service Support Questions about the functioning of Domain API’s s are answered by Visma| YouServe’s Service Center. We also process reports about malfunctions and deal with it adequately and ensure proper feedback. We offer these services to the registered, professional contact persons of Partner. The designated contact persons of Partner, are able to report detected incidents to Visma YouServe’s Service Center. This is possible via accessing the Visma|YouServe Ticket system.  In the case of escalation, you can contact us by telephone  The ticket system of Visma|YouServe  grants access and information about the progress of submitted questions and the offered solutions. Contact persons are during the support process able to add information and react to the offered solutions by Visma|YouServe. Access by telephone of the Service Center  Access by telephone of the Service Center is meant for those situations where direct contact is needed to provide a solution or in case of escalation. The Service Center can be reached by telephone on workdays between 8:00 am and 6:00 pm.  We kindly ask you to enter your partner number and to choose between the Service on which the question is related to. Our Stand-by Service can be reached by telephone outside work hours, for reports with respect to the availability of the Domain APIs. The Stand-by Service is available on workdays between 6:00 am and 8:00 am and between 6:00 pm and 10:00 pm and during weekends between 6:00 am and 10:00 pm.   Note: The Stand-by Service is only for reports on malfunctions in the availability of the Domain API’s applications and is not meant for substantive questions or for reporting other malfunctions.  FAQ Who can get support? Partners only. See How to become an Access Partner How can I log a ticket on an API on login? You will receive instructions for this as part of your access partner contract. How long does it take before my ticket is picked up? Visma | YouServe applies four Support Level Codes to give the right priority to the malfunction and the corresponding response time. The distinction in Support Level Codes is based on the type, severity, the corresponding initial response time and the expected recovery time of the reported malfunction.  Code Meaning Description 1 High The malfunction has a far-reached and immediate effect on the activities in the organization of the customer: activities cannot continue. There is no alternative solution that offers similar results.  2 Medium The malfunction has a significant effect on the activities in the organization of the customer: An alternative solution is available, whether or not with some limitations. 3 Low The malfunction has limited or no effect on the activities in the organization of the customer The following resolution times relate to the Service Level Code, depending on the Service Code Meaning Maximum duration 1 High Solution by means of a workaround 90% within 24 hours 100% within 48 hours Structural solution: Within 30 calendar days 2 Medium Structural solution: Between 30-90 calendar days 3 Low Solution The solution shall be included in the release calendar How do get a login to the support tool? You will receive instructions for this as part of your access partner contract.
Volledig artikel weergeven
21-01-2022 11:58 (Bijgewerkt op 15-05-2023)
  • 0 Antwoorden
  • 0 kudos
  • 922 Weergaven
Publisher is a Client Application that can upload files of authorized business types and authorized tenants. The uploaded files can also be listed/downloaded.
Volledig artikel weergeven
21-04-2023 16:57 (Bijgewerkt op 21-04-2023)
  • 0 Antwoorden
  • 0 kudos
  • 2564 Weergaven
Subscriber is a Client Application that can list/download/delete the files of authorized business types and authorized tenants.
Volledig artikel weergeven
21-04-2023 17:20 (Bijgewerkt op 21-04-2023)
  • 0 Antwoorden
  • 0 kudos
  • 2547 Weergaven
The File API allows you to download or upload files directly from Youforce, over HTTPS using the tool of your choice.
Volledig artikel weergeven
19-12-2022 14:05 (Bijgewerkt op 21-04-2023)
  • 0 Antwoorden
  • 0 kudos
  • 948 Weergaven
Endpoints: File API: [GET] getFile The endpoint GET getFile gives tenants data in a zip (with multiple CSVs inside) or a single CSV file to a reference date. Data in CSVs are defined in the HRCB application. Data are stored periodically (once a day at 05:00 AM see also disclaimer), by our scheduler since the first introduction of the referred tenant. A name of the file is defined as "{date}_{tenantId}_{language}" in zip files (2022-05-13_123456_EN.zip) and as "{date}_{tenantId}_{language}_{groupName}" in CSV files (2022-05-13_123456_EN_Company_basic.csv). Response content type is based on the type of file: zip: application/x-zip-compressed CSV: application/octet-stream    If the file does not exist, it returns 404 (NotFound). This endpoint has required and optional query parameters. If the required parameter is missing, it returns 400 (BadRequest). Parameter Description Required/ Optional Example Language Defines the language of the file. Supported languages:  EN NL Required EN Group Defines an exact type of the file and returns a CSV file. The content of a group is defined in HRCB application. When the group parameter is not set, then the endpoint returns a zip file that contains CSV files. Optional Company   Examples: Each request needs to have an "Authorization" value in the headers. https://api.youserve.nl/yds/file?language=en https://api.youserve.nl/file?language=en&group=Company   Client Header: The application needs to be authorized by the corresponding Tenant (HR Core Client) in order to consume the API. This is ensured by a header parameter 'x-raet-tenant-id' and the value is a tenant id that customer requests data for.   Escaping within CSV file - escape double quote character " to "" (two times double quote) - enclose the whole field value with double quote character " in these cases:    -- escaping of double quote occurred    -- field contains delimiter (character | in our case)    -- field starts or ends with a whitespace character    -- field contains newline (any of CR LF characters)   example: field one|"escaped field due to character "" present"|field three|"field with | pipe character"|"  leading and trailing whitespaces  "|no whitespaces   Time slices or Actual data With our API for BI business product we have two different content files. Depending on your choice you get one of those types Timelines  If history data is necessary you select for the timelines option. History data of max 4 years are made available Start and end date is mentioned for the whole slice of the selected elements  Whenever there is a change in the selected fields a new time slice is created with a start and end date Actual data This file contains only actual data that is active on moment of creation of the file. Selected fields have their own start and end date. When onboarding on this product and there is a need for more than 4 years of history please be advised to do an service request as this is a paid service of ours.   Disclaimer: For the time being, due to it is a newly launched product. Endpoint can be accessed throughout the day and triggers the most actual state of configuration and data instead of one file made ready once a day on 5 AM, so that the configuration settings can be tested by our users
Volledig artikel weergeven
08-07-2022 13:09 (Bijgewerkt op 28-02-2023)
  • 0 Antwoorden
  • 4 kudos
  • 1005 Weergaven
  Swagger documentation The following swagger page gives an overview of the endpoints: Recruiting API   Endpoints Candidates Post candidate The endpoint Post candidate allows to send a candidate to be hired in the core system. This method returns the processId to check the status. POST https://api.youserve.nl/recruiting/v1.0/candidates There are 2 ways of calling this endpoint, with or without attachments. With attachments The header Content-Type should be: multipart/related; boundary="A100x"; (The boundary is the one you choose). The total size among all files is up to 4MB and the allowed file types are pdf, docx, txt, jpg, jpeg and png. The body should be splitted by sections, being the first one a json section with the candidate data as in the request without attachments. For each attachment, there will be 2 sections: json section: name of the file --A100x Content-ID: <content> Content-Type: application/json { "Description":"contract.pdf" } file section: content of the file --A100x Content-ID: <content> Content-Type: application/pdf %PDF-1.7 %·¾¬ª 1 0 obj <<  (this example is not complete) Process status After the candidate is posted to the API, the process can be followed with the status endpoint. The status of a process could be Pending, InProgress, WaitingOnValicare (if it is configured), Completed or Failed. Replace the ProcessId in the URL with the  processId  from the previous API call. GET https://api.youserve.nl/recruiting/v1.0/candidates/{ProcessId}   Checking the status of the hire is needed, because failed hires won’t be automatically reprocessed. It is necessary to correct the problem and send them again. Also it is possible to get a list of processes, filtering by status, created after and created before. GET https://api.youserve.nl/recruiting/v1.0/candidates/status GET https://api.youserve.nl/recruiting/v1.0/candidates/status?status=Completed GET https://api.youserve.nl/recruiting/v1.0/candidates/status?createdAfter=2021-09-01&createdBefore=2021-09-12   Vacancies DRAFT ⚠️ This is a draft endpoint. Vacancy data cannot be exposed at this moment. Please reach out to our community for more info.    GET vacancies The endpoint GET vacancies gives a list of vacancies of the tenant. This endpoint is available only with mock data for the sandbox tenant. GET https://api.youserve.nl/recruiting/v1.0/vacancies   Postman collection and environment As attachment you can find a zip file with the collection and the environment.    
Volledig artikel weergeven
28-01-2022 11:26 (Bijgewerkt op 07-02-2023)
  • 0 Antwoorden
  • 0 kudos
  • 745 Weergaven
Swagger documentation The following swagger pages gives an overview of the endpoint: IAM User endpoint  User endpoint   The user endpoint supports the retrieval of users and gives the ability to set the email address as identity for a user. The next methods are supported as part of the users endpoint. https://api.youserve.nl/iam/v1.0/users GET Allows retrieving a single employee based on employeeId for the tenant specified in the request header. https://api.youserve.nl/iam/v1.0/users(employeeId=12345) Supports the following parameter as part of the resource path: employeeId - The unique id assigned to an employee. This value is available in the Employees endpoint with the property PersonCode. Returns a 200 OK when successful PATCH Allows to update or set an email address as identity for a specific user based on employeeId  (PersonCode in Employees endpoint) for the tenant specified in the request header. https://api.youserve.nl/iam/v1.0/users(employeeId=12345)/identity Supports the following parameter as part of its request body: id- email address of the employee which is to be used for SSO { "id": "user@customer.com" } Returns a 204 No content when successful Visibility of the change in Youforce portal Please note that updating the identity through this endpoint will update the identity in the Youforce authentication system will NOT show the values in Youforce portal Our authentication system is not running on the same service as the portal UI. The synchronization is just one way: Changes done in the authentication system direct will not reflect in the Youforce portal UI Changes done in this UI will reflect in the authentication system Datamapping Parameters Description Example Data type employeeId The unique id assigned to the employee by the HR Core 12345 string id User id of the employee used in the Youforce authentication system HR Core Business: (NL) PING Identiteit (elementnr. 10523564) c7e230db-2a7f-4ef0-ad1d-9d30e7d94a2f string sourceId Username of the user in the Youforce portal.  HR Core Business: (NL) Gebruikersnaam (elementnr. 61) XX123456 string identityId UPN/Identity in the customer authentication system that takes care of authentication HR Core Business: (NL) Identity (elementnr. 7013) user@customer.com string
Volledig artikel weergeven
29-04-2022 12:31 (Bijgewerkt op 20-01-2023)
  • 0 Antwoorden
  • 0 kudos
  • 925 Weergaven