Kennisbank Youforce API & bestandsuitwisseling

Swagger documentation The following swagger pages gives an overview of the endpoint: SIVI endpoints    Endpoint Verzuimmeldingen The endpoint /verzuimmeldingen will return all generated sick leave messages within a specific tenant / client; strictly corresponded with the Dutch standard of sivi.org. The structure of the XML message is fully in line with the XSD version of Verzuimmelding 2020. Currently we’re not able to return every single field with values. For a detailed data mapping overview, click here.   Full load : GET /verzuimmeldingen To fetch the total list of messages corresponding to a client number the endpoint Verzuimmeldingen can be used without using any additional (filter) parameters. https://api.raet.com/sivi/verzuimmeldingen Incremental load : GET /verzuimmeldingen?ChangedAfter=20210402&ChangedUntil=20210404 By executing the parameters ChangedAfter - ChangedUntil the API will only expose the available SIVI messages within the specified timerange. In the below example an API consumer would like to retrieve only the messages between the 2nd of April 2021 and 4th of April 2021.   https://api.raet.com/sivi/verzuimmeldingen?ChangedAfter=2022-06-27T00:00:00.001Z&ChangedUntil=2022-06-27T07:29:00.000Z Example date-time format : changedAfter - 2020-08-21T00:00:00.000Z changedUntil - 2020-08-21T12:01:46.077Z   Mappings A table with all the corresponding property mappings for the Verzuimmeldingen endpoint can be found here. 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 100 records, the results set will end with a ‘nextLink tag’. The nextLink indicates that there are more pages to load. If there is no nextLink at the end of the page, this means that it’s the last page of the result set.

  Domain model   Field mapping Verzuimmeldingen The endpoint /verzuimmeldingen exposes all the corresponding personal, contract & sick leave details of an employee. ALGEMEEN (R) DESCRIPTION XML-TAG R / O EXAMPLE BO4 ONLINE Soort bericht + versienummer BrCd R 00100 Configuration API Versienummer bericht, code VnrBrCd R 00008 Configuration API Aanmaakdatum bericht AandatBr R 2021-03-31 System Date Aanmaaktijd bericht AantijdBr R 13:06:55 System Time Identificatie inzender IdInzndr R Visma - Raet NA Gebruikt softwarepakket GebrSwPakket R BO4 System Data Identificatie ontvanger IdOntvngr R 101 Configuration API Bericht referentienummer Berrefnr R 20210331 T1306559722624Z System Data Test J/N TestJN R N System Data Ontvangstbevestiging gewenst J/N OntvngstbevJN R N System Data ADMINISTRATIEKANTOOR (O) DESCRIPTION XML-TAG R / O EXAMPLE BO4 ONLINE Handelsnaam organisatie HndlsnmOrg R NA   Inschrijvingsnummer Kamer van Koophandel InschrijvingsnrKvK O NA   Vestigingsnummer Vestigingsnr Handelsregister O NA   WERKGEVER (R)         Handelsnaam organisatie HndlsnmOrg R Bogé regressiebestand Opdrachtgever Inschrijvingsnummer Kamer van Koophandel InschrijvingsnrKvK O NA   Vestigingsnummer Vestigingsnr Handelsregister O NA   Identificatie werkgever bij Arbo-dienst IdWrkgvrArbdnst R 105 Configuration API Aansluitnummer gegevensuitwisseling Arbodienst AansltnrGeguitwlng Arbdnst R 6431 Configuration API/To be received from Arbo Identificatie werkgever bij UWV IdWrkgvrUWV O NA   Loonheffingennummer Lhnr O NA   Indicatie eigenrisicodrager voor de WGA IndERDWGA O NA   Indicatie eigenrisicodrager voor de ZW IndERDZW O NA   STRAATADRES NEDERLAND StrAdrNl O     Soort adres, code SrtAdrsCd R 01   Ingangsdatum Ingdat O NA   Einddatum Enddat O NA   Postcode Pc R 3821 BB   Woonplaatsnaam Wnpl R Plotterweg   Straatnaam StraatLang O NA   Huisnummer Huisnr R 38   Huisnummertoevoeging HuisToev O A   POSTBUSADRES NEDERLAND (O) PbadrsNl O     Ingangsdatum Ingdat O NA   Einddatum Enddat O NA   Postcode Pc R NA   Woonplaatsnaam Wnpl R NA   Postbusnummer Pbnr R NA   COMMUNICATIE (O) Soort communicatie, code SrtComCd R NA   Nummer/adres communicatie NrCom R NA   CONTACTPERSOON (O) Identificatie Werknemer IdWrknmr O NA   Personeelsnummer Persnr O NA   Achternaam /Achternamen Achternaam R NA   Voorletters Voorl O NA   Roepnaam Roepnaam O NA   Geslachtsaanduiding, code GslchtCd O NA   Rol contactpersoon, code RolCntprsnCd R NA   COMMUNICATIE (R) Soort communicatie, code SrtComCd R NA   Nummer/adres communicatie NrCom R NA   WERKNEMER (R) Ingangsdatum mutatie IngdatMut O NA   Burgerservicenummer SofiNr O NA   Geboortedatum Gebdat R 1990-03-20 P00321 Overlijdensdatum Overldat O 2013-11-20 P01005- Datum overlijden Significant deel van de achternaam SignNm R Hoffman P00301 - Geboortenaam Voorletters Voorl R M P00303 - Voorletters Voorvoegsels Voorv O de P00302 - Geboortenaam-voorvoegsels Roepnaam Roepnaam O Marcel P01003 - Roepnaam Titulatuur voor de naam TitVNm O Doctor P00305 - Titulatuur voor de naam Titulatuur achter de naam TitANm O NA P03937 - Titulatuur achter de naam Naamvoorkeur, code NmvrkrCd R 01 P00304 - Gebruik achternaam Geslachtsaanduiding, code GslchtCd R M P00330 - Geslacht Niveau opleiding, code NivOpldngCd O NA   Identificatie werknemer IdWrknmr R 700066 P01001 - Persoonsnummer Identificatie werknemer oud IdWrknmrOud O NA   BANKREKENING BnkGiro O NA   IBAN Iban O NA   BIC Bic O NA   PARTNER (O) Significant deel van de achternaam SignNm R Maria P00390 - Partner-naam Voorvoegsels Voorv O E P00391 - Partner-voorvoegsels STRAATADRES NEDERLAND (O) Soort adres, code SrtAdrsCd R 01 System Data Soort verpleegadres, code SrtVrplgadrsCd O NA System Data Naam verpleegadres NmVrpladrs O VU Medisch Centrum P01622 - Naam verpleegadres Ingangsdatum Ingdat O 2021-03-03 P01620 - Ingangsdatum verpleegadres Einddatum Enddat O 2021-04-21 P01621 - einddatum verpleegadres Postcode Pc R 3816NR P01626 - verpleegadres Woonplaatsnaam Wnpl R HAARLEM P01627 - verpleegadres Straatnaam StraatLang O Haarlemmerstraat P01623 - Straatnaam verpleegadres Huisnummer Huisnr R 45 P01624 - huisnummer verpleegadres Huisnummertoevoeging HuisToev O B P01625 - huisnummer toe verpleegadres STRAATADRES BUITENLAND (O) Soort adres, code SrtAdrsCd O NA   Soort verpleegadres, code SrtVrplgadrsCd O NA   Naam verpleegadres NmVrpladrs O NA   Ingangsdatum Ingdat O NA   Einddatum Enddat O NA   Locatieomschrijving buitenland LocomsBtl O NA   Postcode buitenland PcBtl O NA   Woonplaatsnaam buitenland WnplBtl R NA   Regionaam buitenland RegBtl O NA   Land, code LandCd R NA   Landnaam Landnm O NA   Straatnaam StraatLang O NA   Huisnummer buitenland HuisnrBtl R NA   COMMUNICATION (O) Soort communicatie, code SrtComCd R 05 System Data Nummer/adres communicatie NrCom R marcel.h@icici.com marcel.h@gmail.com 0612399001 0610922334 P01035 - E-mail adres werk P01034 - E-mail adres prive P01036 - Telefoonnr mobiel P01037 - Telefoonnr werk DIENSTVERBAND (R) Ingangsdatum mutatie IngdatMut O NA   Identificatie dienstverband IdDnstvbnd R 1 System Data Identificatie dienstverband oud IdDnstvbndOud O NA System Data Ingangsdatum Ingdat R 2021-01-01 P00322 - Datum in dienst Einddatum Enddat O 9999-12-31 P00830 - Datum uit dienst Reden einde dienstverband, code RdEndDnstvbndCd O 01 System Data Personeelsnummer PersNr O 700060 P01001 - Persoonsnummer Personeelsnummer oud PersNrOud O NA   Contractnummer bij Arbo-dienst CntrnrArbdnst O NA System Data Soort dienstverband, code SrtDnstvbndCd O NA P01102 - Soort arbeidsrelatie Functiecode Fnctcd O 3002 P01107 - Primaire functie Naam functie NmFnct O accountant P01107 - Primaire functie Code fase indeling F&Z FsIndFZ O NA   Naam organisatie-eenheid NmOrgeenh O API Public Support 7 Sickness P01106 - Hierarchische org. eenheid Organisatie-eenheid, code OrgeenhCd R 1882 P01106 - Hierarchische org. eenheid Onderdeel van organisatieeenheid, code OndOrgeenhCd O 801   Onderdeel van organisatie-eenheid, naam OndOrgeenhCdNm O Algemene ondersteuning   Postcode standplaats PcStandplts O NA   Verdeling, code VrdlngCd O NA   Code contract onbepaalde / bepaalde tijd CdBepTd O O/B P08259 - Code contract Aantal contracturen per week AantCtrcturenPWk O 36.0 P01109 - Uren per week Soort variabele werktijden, code SrtVarWrktdCd O NA   Aantal loonwachtdagen AantLnwchtdgn O NA   Percentage loondoorbetaling PrcLndrbtng O NA   ARBEIDSRELATIE (O) Identificatie arbeidsrelatie IdArbeidsrelatie R NA   Identificatie arbeidsrelatie oud IdArbeidsrelatieOud O NA   Personeelsnummer PersNr O NA   Personeelsnummer oud PersNrOud O NA   Ingangsdatum Ingdat R NA   Ingangsdatum mutatie IngdatMut O NA   Einddatum Enddat O NA   Aantal contracturen per week AantCtrcturenPWk R NA   KOSTENPLAATS (O) Ingangsdatum Ingdat O NA   Ingangsdatum mutatie IngdatMut O NA   Einddatum Enddat O NA   Naam kostenplaats NmKostenplaats R NA   Kostenplaats, code KostenplaatsCd R NA   Onderdeel van kostenplaats, code OndKostenplaatsCd O NA   Onderdeel van kostenplaats, naam OndKosten plaatsNm O NA   VERZUIM (R) Verwerking, code VrwrkCd R 01 System Data Ingangsdatum mutatie verzuim IngdatMutVrzm R 2021-03-01 System Data Ingangsdatum mutatie verzuim oud IngdatMutVrzmOud O 2021-02-21 System Data Verzuimgeval identificatie VrzmgvlId R 700060 1 926 Combination of Personeelsnummer + Identificatie dienstverband + Sickness ID Verzuimgeval identificatie oud VrzmgvlIdOud O NA   Verzuimgeval volgnummer melding VrzmgvlVnrMld R 2 System Data Einde verzuim J/N EndVrzmJN R J   Datum verzuimmelding werkgever DatVrzmWrkgvr O 2021-11-21 P01603 - Datum ziekmelding Datum eerste verzuimdag DatEerstVrzmdg R 2021-07-31 P01600 - Datum eerste ao-dag Datum eerste verzuimdag oud DatEerstVrzmdgOud O 2021-04-11   Datum hersteld DatHrstld O 2021-03-20 P01606 - Datum herstel Datum hersteld werkgever DatHrstldWrkgvr O NA   Percentage verzuim PrcVrzm R 80 P01642 - ziekte percentage Bijzondere reden start verzuim, code BijzRdnStartVrzmCd O NA   Oorzaak verzuim, code OorzkVrzmCd R 99   Vangnetgeval J/N VngntJN R J P01645 - Soort vangnetgeval Reden einde verzuim, code RdnEndVrzmCd O 01   WAZO, code WAZOCd O 01   Nummer uitkering bedrijfsvereniging NrUitkBdrver O NA   Percentage arbeidstherapie PrcArbther O NA   CONTACTPERSOON (O) Identificatie Werknemer IdWrknmr O 700066   Personeelsnummer Persnr O 700066 Personeelsnummer of the Contact person Achternaam /Achternamen Achternaam R Veltman   Voorletters Voorl O A   Roepnaam Roepnaam O Marcel   Geslachtsaanduiding, code GslchtCd O V   Rol contactpersoon, code RolCntprsnCd R 01   COMMUNICATIE (R) Soort communicatie, code SrtComCd R 06   Nummer/adres communicatie NrCom R alisha.veltman@raet.com   ACTIE (O) Actie, code ActieCd R NA   VRIJE TEKST (O) Vrije tekst VrijeTekst R NA   CONTACTPERSOON (O) werkgever - werknemer - dienstverband - CONTACTPERSOON Identificatie Werknemer IdWrknmr O 700066   Personeelsnummer Persnr O 700066   Achternaam /Achternamen Achternaam R Veltman   Voorletters Voorl O A   Roepnaam Roepnaam O Marcel   Geslachtsaanduiding, code GslchtCd O V   Rol contactpersoon, code RolCntprsnCd R 01   COMMUNICATIE (R) werkgever - werknemer - dienstverband - contactpersoon - COMMUNICATIE Soort communicatie, code SrtComCd R 08   Nummer/adres communicatie NrCom R 0622345978