Kennisbank Youforce API & bestandsuitwisseling

Developer portal, een account aanmaken, applicatie registreren en toegang tot de klantgegevens

Deze pagina beschrijft de benodigde stappen om een Youforce-bestand te koppelen aan de File API.

Status  De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor HR Core Online gebruikers. Dit betekent dat je geen 4Me-ticket meer hoeft in te vullen om Bestandsuitwisseling voor jouw gebruikers te activeren, maar dat je zelf de autorisatie kunt toekennen in Autorisatiebeheer. Bestandsuitwisseling is de vervanger van handmatig Zenden/Ontvangen met IBU.   Enkele voordelen: Intuïtief en gebruiksvriendelijk Geen lokale installatie of configuratie nodig Betrouwbaar, veilig en automatisch opschalen tijdens piek uren Vanaf heden zal de applicatie Bestandsuitwisseling standaard beschikbaar in Autorisatiebeheer. De autorisatie van elke gebruiker voor de verschillende file types kan door de Autorisatiebeheer administrator worden gedaan door het toekennen van de juiste rechten.   Wat je moet doen Als je al de juiste rollen hebt gedefinieerd in Autorisatiebeheer, volg dan onderstaande stappen. Zo niet, volg dan eerst de stappen zoals beschreven in dit artikel en daarna de stappen zoals hieronder beschreven.   Stap 1: Voeg de applicatie Bestandsuitwisseling toe aan de gewenste rol(len) met de volgende rechten: Toegang tot Bestandsuitwisseling Zend testbestanden naar Bestandsuitwisseling Ontvang testbestanden van Bestandsuitwisseling Op dit punt hebben de gebruikers toegang tot Bestandsuitwisseling, maar alleen toegang tot testbestanden en nog geen toegang tot applicatie specifieke bestanden.   Stap 2: Voeg alle gewenste applicaties en hun specifieke rechten toe aan de juiste rollen: Betaalmanager Ontvang opdrachten van Betaalmanager Gemal Ontvang downloads van Betaalmanager Gemal HR Core Zend bestanden naar HR Core Online Ontvang bestanden van HR Core Online Oude Zend-Ontvang naam was Zenden naar Hosted BO4  / Ontvangen van Hosted BO4 Payroll Gemal Direct Ontvang bestanden van Payroll Gemal Direct Personeelsdossier Zend bestanden naar Personeelsdossier Ontvang bestanden van Personeelsdossier Salarisdossier Gemal Ontvang bestanden van Salarisdossier Gemal Youforce Account Beheer  Zend XSSO bestanden naar Gebruikersbeheer Self Service  Zend HI CSV bestand naar Self Service Zend HI XML bestand naar Self Service Managementinformatie Ontvang HR datafeed bestanden van Managementinformatie Stap 3. Controleer of je gebruikers die Bestandsuitwisseling al gebruiken ook de juiste rollen hebben toegewezen gekregen. Indien nodig kun je rechten toekennen aan individuele gebruikers.   Stap 4. Koppel de Youforce bestanden aan de Bestandsuitwisseling. Zie instructies.     Stap 5. Bestandsuitwisseling is op dit moment beschikbaar in Mijn Youforce, maar kan ook worden bereikt via de "Bestandsuitwisseling" -tegel op de Youforce Desktop. In dat laatste geval moet de tegel wel worden geautoriseerd via Toegangsbeheer.  Extra informatie Gebruikers moeten zich aanmelden via de nieuwe login om gebruik te kunnen maken van de Bestandsuitwisseling applicatie. Bestanden kunnen gedurende 1 maand worden opgehaald/ontvangen. Bestanden kunnen gedurende 1 maand zo nodig meerdere malen worden ontvangen. 1 maand na inzenden worden bestanden verplaatst naar een archief en zijn dan niet meer zichtbaar in Bestandsuitwisseling. Tot 90 dagen na inzenden van een bestand kan het bestand nog door het indienen van een 4Me aanvraag beschikbaar worden gesteld in Bestandsuitwisseling. Ontvangen bestanden worden opgeslagen in de Download directory die in je browser is geconfigureerd. Wil je bestanden in verschillende directories ontvangen dan kan dat door je browser zo te configureren dat hij bij elke download vraagt om een directory waar de bestanden gedownload moeten worden. De Nederlandse taal wordt ondersteund. De gebruikte taal volgt de keuze die je bij de persoonlijke instellingen in Mijn Youforce hebt gemaakt. Het is al mogelijk om tegelijkertijd meerdere bestanden te ontvangen. Zie Release-opmerkingen Bestandsuitwisseling update 16-10-2023 De Gemal Salaris tabellen die je gebruikt worden bij elke vernieuwing automatisch op de J-schijf geplaatst in de nieuwe Payroll-Tables directory. Bestandsuitwisseling toont gebruiker informatie van degene(n) die een bestand hebben ontvangen of verzonden. Zie dit artikel voor meer informatie. Kennisartikelen Zenden en Ontvangen met de IBU stopt Hoe richt ik de rechten voor Mijn Youforce zo overzichtelijk mogelijk in 'autorisatiebeheer'? Youforce-bestanden koppelen aan Bestandsuitwisseling.   Hoe Bestandsuitwisseling testen met dummy-bestanden Releases voor bestandsuitwisseling  

Zenden en Ontvangen, waarbij IBU wordt gebruikt, en Bestandsuitwisseling, die gebruik maakt van de File API, zijn 2 verschillende Youforce modules. Ze hebben elk hun eigen bestanden. Standaard worden Youforce bestanden voor jou naar Zenden en Ontvangen gestuurd. Om de bestanden ook beschikbaar te krijgen voor Bestandsuitwisseling moet je sommige Youforce modules die je gebruikt vertellen dat ze de bestanden naar Bestandsuitwisseling sturen.   Deze pagina beschrijft voor elke module waar een aanpassing voor nodig is, de benodigde stappen om een Youforce-bestand te koppelen aan Bestandsuitwisseling.  Omdat  Bestandsuitwisseling ook gebruik maakt van de File API wordt in de beschrijvingen vaak alleen gerefereerd aan de File API. Hier mag je dus ook Bestandsuitwisseling voor lezen. Gebruik je straks zowel Bestandsuitwisseling (interactief) als File API (automatische koppeling) voor dezelfde Youforce module dan hoef je de stappen voor die module slechts 1x uit te voeren.   Voor de volgende Youforce-modules zijn aanpassingen nodig:     Payroll Gemal Direct Payroll Gemal - Ontvang Bestandsuitwisseling biedt de mogelijkheid om de bestanden die in een Payroll Gemal-productie zijn afgeroepen, te downloaden naar je lokale omgeving. Het gaat om het ophalen van data bestanden zoals bijv. de journaalposten, flexbestanden, loonstaten in csv; zoals deze in bestandsvorm bij Zenden en Ontvangen gedownload kunnen worden.   Onderstaande werkgevercode is voor alle klanten die met losse Gemal output (zie bestandsnamen verderop) werken in Zenden en Ontvangen en zij kunnen dit onderdeel via Bestandsuitwisseling laten verlopen zodra deze stap is uitgevoerd.   Hoe Werkgeverscode 30050 is vanaf 2022-10 beschikbaar in Gemal Direct Inrichting om de ontvangen bestanden naar beiden (IBU en File API) of alleen naar Bestandsuitwisseling (File API) te sturen. Deze werkgevercode vind je in Gemal Direct Inrichting via Selecteren werkgever-productie / werkgevergegevens / overzicht en bestanden / algemeen   Werkgeverscode 30050 File-API 0 = Bestanden via 'Zenden&Ontvangen' 1 = Bestanden via 'Zenden&Ontvangen' en via de File API  / Bestandsuitwisseling 2 = Bestanden via File API / Bestandsuitwisseling - (werkt voorlopig nog gelijk aan waarde 1, maar ben je over op Bestandsuitwisseling (File API), leg deze waarde dan vast)         Als de waarde 0 is, worden de bestanden op de oude/huidige manier verzonden. Een waarde van 1 maakt de bestanden ook beschikbaar in Bestandsuitwisseling. Waarde 2 heeft nu nog hetzelfde effect als 1, maar door dit vast te leggen als je over bent, krijgen we inzicht in de mate waarin klanten deze stap hebben gezet. Op termijn zal waarde 2 conform de beschrijving alleen via Bestandsuitwisseling worden verwerkt. Gewijzigde bestandsnamen LET OP! Daarnaast zijn de bestandsnamen als deze via Bestandsuitwisseling worden aangeboden, aangepast. Hierdoor wordt het meer helder welk bestand je daar ziet staan. In 'Zenden en Ontvangen' blijven de huidige benamingen van toepassing. Zie onderstaande figuur voor een weergave van de nieuwe namen.   Werkgeverscode 30050 hoeft alleen geregistreerd te worden bij instelling nummer 1.   Tenslotte: De Salaristabellen zijn voor HR Core On Premise klanten beschikbaar via  Bestandsuitwisseling. Na elke nieuwe publicatie van de Salaristabellen worden de Salaristabellen die je gebruikt automatisch beschikbaar gesteld in Bestandsuitwisseling. Voor HR Core Online klanten worden nieuwe versies van de Salaristabellen automatisch geplaatst op de J-Drive in de nieuwe Payroll-Tables directory. HR Core online HR Core Online Hosted - Ontvang   De bestanden moeten worden geplaatst in de nieuwe map 'Hosted-Klant-Files'. Vanuit deze map worden de bestanden gekoppeld aan Bestandsuitwisseling.  HR Core Online Hosted - Zend De ingestuurde bestanden worden op de J-schijf geplaatst in de map J:\Raet\Klant-Hosted net zoals je gewend was met IBU Zenden. Betaalmanager  Betaalmanager Gemal Downloads Betaalmanager Gemal Opdrachten Betaalmanager VIPS Disbursements Downloads Betaalmanager VIPS Disbursements Opdrachten   Betaalmanager biedt de mogelijkheid automatisch betaal- en downloadbestanden te ontvangen in de klantomgeving met behulp van Bestandsuitwisseling.  Op het scherm Beheer > Instellingen is het veld Zenden naar gesplitst in drie velden SEPA-betalingen zenden naar, Downloads zenden naar en non-SEPA zenden naar. Om instellingen aan te passen is rechts een knop Aanpassen toegevoegd:   Indien je op de knop Aanpassen klikt, dan wordt een apart scherm Instellingen rekening aanpassen getoond waarin je eventuele rekeninginstellingen kunt wijzigen:   Als je een nieuw IBAN van afschrijving gaat gebruiken, dan blijft de initiële inrichting: SEPA betalingen zenden naar EQUENS-CPS, Download zenden naar Zenden Ontvangen en Non-SEPA betalingen zenden naar Zenden Ontvangen.  Het is niet mogelijk om achteraf nog bestanden te achterhalen. Mocht je gebruik willen maken van de Bestandsuitwisseling/File Api, adviseren wij om de Online Help van de Betaalmanager door te lezen, waarin onder andere het volgende is opgenomen:   Als bij Beheer > Instellingen >  Aanpassen > SEPA betalingen zenden naar gekozen is voor verzenden naar File Api dan maakt de Betaal Manager het SEPA-betaalbestand aan en biedt dit aan aan de File Api. De betaalbestanden worden dan beschikbaar gesteld in Bestandsuitwisseling. De status van een verzonden betaalopdracht ziet u bij de details van de betaalopdracht bij Betaalopdrachten bekijken.  

The IAM model     Data mapping Person  The personal details of an employee. This could also contains person without a (active) employment. HR Core Beaufort: Persoon   id The globally unique id assigned to an employee 32789 P01001 Persoonsnummer personCode The unique id assigned to the employee 32789 P01001 Persoonsnummer personId The globally unique id assigned to an employee 32789 P01001 Persoonsnummer initials The initials of the employee A.B. P00303 Voorletters firstNames The official given names of the employee Amy Beatrice P01002 Voornamen knownAs The name which is used by the employee as first name Amy P01003 Roepnaam lastNameAtBirth The last name at birth of the employee. Also known as the family name Vries P00301 Geboortenaam lastNameAtBirth Prefix The prefix of the employee's last name at birth de P00302 Geboortenaam voorvoegsels lastName The last name used by the employee at present Vries - Van Eijck P01008 Samengestelde naam lastNamePrefix The prefix of the employee's last name at present de P01009 Samengestelde naam voorvoegsel nameAssemble Order Code of the assemble order used by the core system for the last name. C   value E: birthname B: partnername & birthname C: birthname & partnername P: partnername P00304 Gebruik achternaam partnerName The last name of the employee's partner Eijck P00390 Partner naam partnerName Prefix The prefix of the partner's last name Van P00391 Voorvoegsel partner titlePrefix Formal title prefix drs. P00305 Titulatuur voor de naam titleSuffix Formal title suffix Msc P03937 Titulatuur achter de naam gender Gender of the employee Female P00330  Geslacht dateOfBirth Date of birth 1986-12-02 P00321 Geboorte datum deceased This field indicates if an employee is deceased when false the property is not returned true P01005  Datum overlijden UserUID Digital Identity of the user from the portal bdd38fd2-FAKE-4313-FAKE-671c786d0758   Ping ID directly from the portal youforceAccount Indicaties if the person do have a user account J P15013 Youforce gebruiker phoneNumbers List of phone numbers and types Home +3188 123 45 67 P01027 Telefoonnummer woonadres Business +3188 345 67 89 P01037  Telefoonnummer werk Mobile +316 12 34 56 78 P01036 Telefoonnummer mobiel emailAddresses List of email addresses of the employee Business b.user@example.com P01035 E-mail adres werk Private p.user@example.com P01034 E-mail adres privé Addresses List of addresses   type Home street Kerkstraat P01014  Straat houseNumber 1 P01016 Huisnummer houseNumber Addition C P01018  Huisnummer toevoeging postalCode 1234 AB P01020  Postcode city Amersfoort P01022  Woonplaats country NL P01024 Woonland effectiveDate 2023-08-01 P01012  Adres m.i.v.   type Postal street Poststraat P00365 Straatnaam houseNumber 1 P00367 Huisnummer houseNumber Addition A P00368 Huisnummer toevoeging postalCode 1234 AB P00313 Postcode city Amersfoort P00308 Plaatsnaam country NL P00847 Land effectiveDate 2023-08-01 P00847 Adres m.i.v.     Employments  The employment of the employee. A person can have multiple employments at the same time.   HR Core Beaufort: Dienstverband   employmentCode The code of the employment 1 P01101  Volgnummer dienstverband 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 P00834 Datum in dienst CAO dischargeDate The end date or discharge date of the employment. This is always an "up to and including" date. In case of no values the field will not be returned as part of te response body 2018-12-31 P00830  Datum uitdienst hireDate Date of hire for the employment 2017-05-01 P00322 Datum in dienst classification Cost allocation of the employment 123 P01110 Code doelgroep employmentType Code of the employment type 4 P01102 Soort arbeidsrelatie contractType Contract type of the employee. It is the code that refers to the entity contract type. 0 P08259 Code contract (on)bepaalde tijd workingAmount Working amount of the employment. amountOfWork: numeric value representing the work amount 40   P01109 Uren per week unitOfWork: unit of work that specifies the unit for the amount Hours P01109 Uren per week periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined -Day -Week -Month -Quarter P01109 Uren per week jobProfile The job profile code 9909 DEV P01107 Primaire functie organizationUnit The organization unit id 1234567 ZKH P01106 Hiërarchisch organisatorische eenheid Payroll Client Code     P01103  CEA-nummer Payroll Institution Code      P01104 Instelling nummer Company PayrollClientCode and PayrollInsituationCode combined       Termination Reason     P01113 Reden einde dienstverband   Het endpoint employments toont bovenstaande velden met de in Beaufort geldende actuele waarden.    Het endpoint employments/Timelines is gebaseerd op de historie tabel van Beaufort waardoor het endpoint de ingangsdatum bevat en indien aanwezig de einddatum. Het endpoint  bevat dezelfde velden als het endpoint employments maar dus ook inclusief ingangsdatum waardoor er een soort tijdlijn ontstaat.  Indien gewenst, gebruik het filter ValidOn om enkel de records te verkrijgen die op een bepaalde datum geldig zijn.     Assignments The possible assignments of an employee for their employment. In example, employee works is assigned to a different department as temporary replacement or to help another department without changing his own employment. HR Core Beaufort: Inzet   id Unique id of the role assignment. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.   100 1 12 1234 20200923 system field Unique id of the assignment personCode The unique id assigned to the employee 32789 P01001 Persoonsnummer personId The globally unique id assigned to an employee 32789 P01001 Persoonsnummer employmentCode The code of the employment of the person 1 P01101  Volgnummer dienstverband startDate The start date of the assignments 2017-05-01 P01125 Ingang inzet endDate The end date of the assignment. This is always an "up to and including" date. In case of no values the field will not be returned as part of te response body 2017-11-30 P01126 Einde inzet jobProfile Job title or job profile code of the assignment. DEV P01122 Operationele functie organizationUnit The organization unit id of the assignment. PD P01121 Operationele organisatorische eenheid workingAmount Working amount of the employment.. amountOfWork: numeric value representing the work amount 40   P01123 Uren inzet per week unitOfWork: unit of work that specifies the unit for the amount Hours P01123 Uren inzet per week periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined Week P01123 Uren inzet per week costCenter The cost center of a Assignment     P01128 - Kostenplaats Inzet costUnit The cost unit of an Assignment     P01129 - Kostendrager Inzet costType The cost type of an Assignment     P01127 - Kostensoort Inzet type Type of assignment     P01123 - Soort Inzet   Cost allocation The cost allocation of an employee. The cost allocations are generated by Beaufort. An employee can multiple cost allocations. Mostly the cost allocation with sequence number 0 or the one with the highest percentages  is the main cost allocation. HR Core Beaufort: Loonverdeling   id Unique id of the cost allocation. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.   32789 1 0 system field Unique id of the assignment PersonCode The unique id assigned to the employee 32789   Persoonsnummer employmentCode The code of the employment of the person 1   Dienstverband volgnummer sequenceNumber Unique sequence number or row number of the cost allocation within the employee 0 P01131 regelnummer loonverdeling costTypeCode code of the cost type  4004 P01133 Kostensoort loonverdeling CostTypeName full name of the cost type Loonkosten   Omschrijving kostensoort (referentie tabel) costCenterCode code of the cost center 4000 P01134 Kostenplaats loonverdeling costCenterName full name of the cost center KNO Operaties   Omschrijving kostenplaats (referentie tabel) costUnitCode code of the cost unit 4100 P01135 Kostendrager loonverdeling costUnitName full name of the cost unit KNO   Omschrijving kostendrager (referentie tabel) percentage percentage of the cost allocation 100 P01132 loonverdeling loonverdeling     Organization Units The organization structure describes the organization in terms of business unit, departments, divisions, etc. and how these are related to each other. Based on the organization structure it's clear “how” units are related and "which" department is responsible for "what". HR Core Beaufort: Organisatie eenheden   validFrom The date from which the record is valid 2020-04-01 N/A Data niet beschikbaar in de API 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 Data niet beschikbaar in de API id Unique id of the organization unit PD P01061 Code organisatorische eenheid shortName Code or short name of the Organization Unit PD P01061 Code organisatorische eenheid fullName Name or full title of the Organization Unit Product Development   Naam organisatorische eenheid parentOrgUnit Code of the parent organization unit PD_EU   Organisatie eenheid > Onderdeel van organizationUnitType Type of organization unit Divisie   Type organisatorische eenheid isBlocked   True/false   Deze indicatie wordt gebruikt om aan te geven dat er geen nieuwe medewerkers meer op de organisatie eenheid mogen worden geplaatst. De indicatie IsBlocked wil dus niet zeggen dat er geen medewerkers meer aan gekoppeld zijn. Address       Adres-velden bij de OE. PhoneNumber       Telefoonnummer bij de OE. CostCenterCode       Kostenplaatscode behorend bij de OE.   Role Assignments The role assignment describes "who" is responsible for “what“ and “when“ within the organization unit. HR Core Beaufort: Rol toewijzing   validFrom The date from which the record is valid 2020-04-01     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     id Unique id of the role assignment. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user. R1 - N/A BO4 - 78000 1877 MGR 20200101   Id van het record personId The unique id assigned to the employee 10017   Persoonsnummer van de houder van de rol organizationUnit The organization unit id of the assignment. 459   Code van organisatorische eenheid shortName The code of the role MGR   Code van de rol personCode The code of the person 12345   Persoonsnummer van de houder van de rol (gelijk aan personID) startDate Start date of role assignment 2013-04-17     endDate End date of role assignment 2020-01-31       Indien gewenst, gebruik het filter ValidOn om enkel de records te verkrijgen die op een bepaalde datum geldig zijn. Zo zullen zonder dit filter alle rollen, inclusief hun start- en einddatum, getoond worden - zelfs die met een toekomstige startdatum. Dankzij het filter kan je nu alleen de roltoewijzingen ophalen die geldig zijn op een specifieke dag.     Job Profiles All job profiles that have been defined within the tenant. HR Core Beaufort: Functie   shortName Code or short name of the Job Profile SE Functie code fullName Name or full title of the Job Profile Software Engineer 5 Functie omschrijving jobFamily Code or short name of the Job Family PD5 Functie groep code validFrom The date from which the record is valid 2020-04-01 Data niet beschikbaar in de API 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 Data niet beschikbaar in de API type     Functietype costUnit     Kostensoort costType     Kostendrager  

  Account aanmaken op Visma Developer Portal De Visma Developer portal is te bereiken via  https://oauth.developers.visma.com/service-registry/home   en maak via Create account een account aan             De portal zal via do.not.reply@mail.connect.visma.com  je een e-mail sturen met een Activatie account link.   Gebruik bij het registreren het Kvk-nummer als Organization number       Startscherm na inloggen       Desgewenst kun je een collega toevoegen via My team en New member. Jullie hebben dan beiden inzicht in de gegevens van de applicatie.       De volgende stap is het aanmaken van een applicatie. Een applicatie aanmaken   Door een applicatie aan te maken ontstaat er een API Key en een Secret Key die je gebruikt om de authenticatietoken op te halen.   Kies via het tabblad My Applications voor Add Application     Als application type selecteer Service, dit is het enige type wat door Visma|Raet wordt ondersteund.       Het aanmaken van de applicatie gaat via vier tabbladen, vul de gegevens in op het eerste tabblad Details. Weet dat de opgegeven Client Id wordt gebruikt als API key bij de API-aanroepen.   Je moet zelf de Client Id opgeven.    Testomgeving - Het is tevens mogelijk om gebruik te maken van onze sandbox. Met deze sandbox kun je testen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan de sandbox. Maak hiervoor een 2e Invitation code  aan (deze stap wordt later toegelicht).    Via deze applicatie met bijbehorende Client Id en Secret krijg je toegang de data en of bestanden uit de Youforce/HRCoreOnline-omgeving(en). Eén API key-set kan toegang geven tot meerdere klantomgevingen. Via de Tenant Id die je als Header meestuurt bij het aanvragen van een authenticatie token bepaal je de benodigde klantomgeving.   Access Token Lifetime mag op de default waarde blijven staan. Een aanpassing van deze waarde heeft geen effect op werking van de API, alsmede de opties Include JSON Web Token ID en TestApplication.   Gebruik eerst Save as a draft om vervolgens de applicatie aan te maken via Create, via Next ga je naar het volgende tabblad.       Het tabblad Credentials stelt je in staat om de API Secret aan te maken. Let op, de Secret waarde wordt alleen getoond via de pop up bij het aanmaken, dus neem dit direct over. De pop up toont ook je eerder gekozen ID (API key).   Let op: Wordt de bestaande secret vergeten dan dien je een nieuwe aan te maken, deze wordt dan toegevoegd.       Via het tabblad Integrations selecteer de gewenste Youforce API, oftewel je ‘basis’ API, je gebruikt hiervoor New integration.         Visma Raet zal de opgegeven API’s goedkeuren. Dit gaat via een workflow in de portal, je hoeft daar niks voor te doen. De goedkeuring door Visma Raet kan enkele dagen duren en zolang de goedkeuring niet is verleend kan je de stap van de Visma App Store niet uitvoeren.       Per API dien je de Scope te selecteren welke gebruikt gaat worden in de applicatie. Op deze manier kun je bepaalde functionaliteiten (endpoints) binnen de Youforce API uitsluiten van je applicatie. Je kunt vanzelfsprekend ook alle Scopes selecteren, een API kan ook bestaan uit 1 Scope.       Het tabblad Integrations kan je niet direct bevestigen via Save, dat kan pas op het moment dat Visma|Raet de gekozen API’s bij de applicatie heeft goedgekeurd, dit gaat via een flow je hoeft hier niks voor te doen. De goedkeuring door Visma Raet kan enkele dagen duren en zolang de goedkeuring niet is verleend kan je de stap van de Visma App Store niet uitvoeren.   Je kan door te klikken op stap ‘Visma App store’ naar de laatste stap (mits Visma Raet de API('s) heeft goedgekeurd).             Tabblad Visma App Store, op dit moment stellen wij de Visma App Store niet ter beschikking aan onze klanten.    Voor toegang tot de klantdata genereer je een Invitation Code. Hoe je dit doet staat hieronder verder uitgelegd. Visma Raet zal de toegang tot de klant-data goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereedmaken.       Na Start setup for Visma App Store ziet u onderstaand scherm en dan kies je bij Access level - Audience voor Invite only   Vul ook de url in waar uw product is uitgelegd.       Je bent nu klaar met het aanmaken van de applicatie, de optie Save wordt zichtbaar op het moment dat Visma Raet de applicatie heeft goedgekeurd, je kunt het aanmaken sluiten door bijvoorbeeld op Back to my Applications te klikken.    Wanneer Visma Raet de goedkeuring heeft verleend, ontvang je hier een e-mail van en kun je de volgende stap uitvoeren door de applicatie te koppelen aan klant-data. Dit staat uitgelegd in het volgende hoofdstuk ‘Invitatiecode aanmaken’.   Invitatiecode aanmaken Met een invitatiecode maak je het mogelijk de klantgegevens op te halen via je applicatie. Ga naar de Developer Portal https://oauth.developers.visma.com/service-registry/home    Kies voor My Applications. En klik op het potloodje achter de applicatie (Edit).      Kies voor het tabblad Visma App Store. En vervolgens New Invitation Code.       Bij Invitation description vul je de naam van de betreffende klant in. En klik vervolgens op Generate.         Visma Raet zal de toegang tot de klant-data goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereedmaken.   Binnen het beheer van je applicatie en het scherm Integrations is via de tabblad Tenants (default wordt het tabblad Scopes getoond) terug te zien welke klanten (tenants) gekoppeld zijn aan je applicatie. Dit scherm laat ook de bijbehorende TenantID zien. De TenantID is benodigd bij het opvragen van de authenticatie token.     Voorbeeld van een Tenant ID     Testomgeving - Het is tevens mogelijk om gebruik te maken van onze sandbox. Met deze sandbox kun je testen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan de sandbox. Maak hiervoor een Invitation code  aan en deel die met Visma Raet.  

Beschrijving van SIVI Verzuimberichten, de inhoud van het bestand en de filter-mogelijkheden.

Choose an API product Youforce has several API products available, you find more information here:  https://developer.visma.com/api/youforce   Every API covers a different use cases, for example The IAM API is intended for identity & access management systems and enables the provisioning of users in other systems like Active Directory or IDP.  The Learning API provides employee data that is relevant for applications in the learning, development, appraisal domain, etc.   The File API allows you to download or upload files directly from Youforce. In this way we help to achieve ‘purpose binding’ required to safeguard the privacy of employees and to comply with GDPR legislation. It furthermore allows us to tailor and grow the API supporting specific needs in that domain   Create an account and application To use an Youforce API product, you must register and create an account. An account is quick to set up and is free of charge. A step by step manual is availible here.   Get the access token In order to grant access to a target API, Apps must first authenticate against our Authorization Server.    This token will provide access to a particular tenant in a specific application. Hence, this step will require knowing the client-id, client-secret and tenant-id.   curl -X POST   'https://connect.visma.com/connect/token'  -H 'Cache-Control: no-cache'   -H 'Content-Type: application/x-www-form-urlencoded'   -d 'client_secret=xxxxxxx      &client_id=xxxxxxxx      &tenant_id=xxxxxxxx      &grant_type=client_credentials'     Below, a response example containing the access token, the authorized scopes and the expiration time which is 1 hour max. After that time Apps need to re-authenticate to get a new access token.   {     'access_token':'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',     'expires_in': '3600',     'token_type': 'Bearer',     "scope": "youforce-fileapi:files:list youforce-fileapi:files:upload" }     HTTPs support   Our API's domain is secured by using digicert (SHA2) certificates, a world wide industry-recognized provider.   Protocol TLS 1.2 (only) Key exchange ECDHE RSA with X25519 Cipher AES_256_GCM   All HTTP Requests will be refused with a Not Found 404 error response.   Request headers   Our APIs have headers in common   Header Name Description Cache-Control The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. In our authentication request the header is mandatory with the value Cach-Control: no-cache Content-Type The content type of the resource in case the request content in the body. Example: Content-Type: application/x-www-form-urlencoded Authorization The information required for request authentication Accept The Accept request-header field can be used to specify certain media types which are acceptable for the response. Example: Accept: text/plain   Response Codes Our APIs have response codes in common.   Type Responses Situation Succes Codes 200 OK Synchronous read, update, and delete operations 201 Created Synchronous create requests   202 Accepted A-synchronous operations   204 No Content Referring to non-existing entity (e.g. after delete)   Redirection Codes 304 Not Modified Resource has not been modified. 308 Permanent redirect Resource has permanently moved.   Invalid Request Errors 400 Bad request Bad Request (e.g. validation errors) 401 Unauthorized Not Authorized: Missing or invalid access token   403 Forbidden Not Authorized: Authenticated, but user has no access to the API   404 Not Found Invalid  URL: Item does not exist (anymore). The canonical identifier (collection/{canonical id}) cannot be found. Not Authorized:  Authenticated, access to api, but user has no access to to the resource (data authorization).  From a security standpoint we don't expose the reason why the object could not be found because an  attacker can use this to figure out the internals of our system.   409 Conflict Concurrency problem: Record changed by another user   Server Errors 500 Internal server error Server Error (e.g. database failure, event could not be send) 503 Service unavailable Server Error (resource temporary not available)        

Domain model   The Learning model   Person  The personal details of an employee. This could also contains person without a (active) employment. HR Core Beaufort: Persoon   id The globally unique id assigned to an employee 32789 P01001 Persoonsnummer personCode The unique id assigned to the employee 32789 P01001 Persoonsnummer personId The globally unique id assigned to an employee 32789 P01001 Persoonsnummer initials The initials of the employee A.B. P00303 Voorletters firstNames The official given names of the employee Amy Beatrice P01002 Voornamen knownAs The name which is used by the employee as first name Amy P01003 Roepnaam lastNameAtBirth The last name at birth of the employee. Also known as the family name Vries P00301 Geboortenaam lastNameAtBirth Prefix The prefix of the employee's last name at birth de P00302 Geboortenaam voorvoegsels lastName The last name used by the employee at present Vries - Van Eijck P01008 Samengestelde naam lastNamePrefix The prefix of the employee's last name at present de P01009 Samengestelde naam voorvoegsel nameAssemble Order Code of the assemble order used by the core system for the last name. C   value E: birthname B: partnername & birthname C: birthname & partnername P: partnername P00304 Gebruik achternaam partnerName The last name of the employee's partner Eijck P00390 Partner naam partnerName Prefix The prefix of the partner's last name Van P00391 Voorvoegsel partner titlePrefix Formal title prefix drs. P00305 Titulatuur voor de naam titleSuffix Formal title suffix Msc P03937 Titulatuur achter de naam gender Gender of the employee Female P00330  Geslacht dateOfBirth Date of birth 1986-12-02 P00321 Geboorte datum deceased This field indicates if an employee is deceased when false the property is not returned true P01005  Datum overlijden UserUID Digital Identity of the user from the portal bdd38fd2-FAKE-4313-FAKE-671c786d0758   Ping ID directly from the portal youforceAccount Indicaties if the person do have a user account J P15013 Youforce gebruiker phoneNumbers List of phone numbers and types Home +3188 123 45 67 P01027 Telefoonnummer woonadres Business +3188 345 67 89 P01037  Telefoonnummer werk Mobile +316 12 34 56 78 P01036 Telefoonnummer mobiel emailAddresses List of email addresses of the employee Business b.user@example.com P01035 E-mail adres werk Private p.user@example.com P01034 E-mail adres privé Addresses List of addresses   type Home street Kerkstraat P01014  Straat houseNumber 1 P01016 Huisnummer houseNumber Addition C P01018  Huisnummer toevoeging postalCode 1234 AB P01020  Postcode city Amersfoort P01022  Woonplaats country NL P01024 Woonland effectiveDate 2023-08-01 P01012  Adres m.i.v.   type Postal street Poststraat P00365 Straatnaam houseNumber 1 P00367 Huisnummer houseNumber Addition A P00368 Huisnummer toevoeging postalCode 1234 AB P00313 Postcode city Amersfoort P00308 Plaatsnaam country NL P00847 Land effectiveDate 2023-08-01 P00847 Adres m.i.v.     Employments  The employment of the employee. A person can have multiple employments at the same time.   HR Core Beaufort: Dienstverband   employmentCode The code of the employment 1 P01101  Volgnummer dienstverband 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 P00834 Datum in dienst CAO dischargeDate The end date or discharge date of the employment. This is always an "up to and including" date. In case of no values the field will not be returned as part of te response body 2018-12-31 P00830  Datum uitdienst hireDate Date of hire for the employment 2017-05-01 P00322 Datum in dienst classification Cost allocation of the employment 123 P01110 Code doelgroep employmentType Code of the employment type 4 P01102 Soort arbeidsrelatie contractType Contract type of the employee. It is the code that refers to the entity contract type. 0 P08259  Code contract (on)bepaalde tijd workingAmount Working amount of the employment. amountOfWork: numeric value representing the work amount 40   P01109 Uren per week unitOfWork: unit of work that specifies the unit for the amount Hours P01109 Uren per week periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined -Day -Week -Month -Quarter P01109 Uren per week jobProfile The job profile code 9909 DEV P01107 Primaire functie organizationUnit The organization unit id 1234567 ZKH P01106 Hiërarchisch organisatorische eenheid Payroll Client Code     P01103  CEA-nummer Payroll Institution Code      P01104 Instelling nummer Company PayrollClientCode and PayrollInsituationCode combined       Termination Reason     P01113 Reden einde dienstverband bigNumber     P09165 Big nummer   Het endpoint employments toont bovenstaande velden met de in Beaufort geldende actuele waarden.    Het endpoint employments/Timelines is gebaseerd op de historie tabel van Beaufort waardoor het endpoint de ingangsdatum bevat en indien aanwezig de einddatum. Het endpoint  bevat dezelfde velden als het endpoint employments maar dus ook inclusief ingangsdatum waardoor er een soort tijdlijn ontstaat.  Indien gewenst, gebruik het filter ValidOn om enkel de records te verkrijgen die op een bepaalde datum geldig zijn.     Assignments The possible assignments of an employee for their employment. In example, employee works is assigned to a different department as temporary replacement or to help another department without changing his own employment. HR Core Beaufort: Inzet   id Unique id of the role assignment. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.   100 1 12 1234 20200923 system field Unique id of the assignment personCode The unique id assigned to the employee 32789 P01001 Persoonsnummer personId The globally unique id assigned to an employee 32789 P01001 Persoonsnummer employmentCode The code of the employment of the person 1 P01101  Volgnummer dienstverband startDate The start date of the assignments 2017-05-01 P01125 Ingang inzet endDate The end date of the assignment. This is always an "up to and including" date. In case of no values the field will not be returned as part of te response body 2017-11-30 P01126 Einde inzet jobProfile Job title or job profile code of the assignment. DEV P01122 Operationele functie organizationUnit The organization unit id of the assignment. PD P01121 Operationele organisatorische eenheid workingAmount Working amount of the employment.. amountOfWork: numeric value representing the work amount 40   P01123 Uren inzet per week unitOfWork: unit of work that specifies the unit for the amount Hours P01123 Uren inzet per week periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined Week P01123 Uren inzet per week costCenter The cost center of a Assignment     P01128 - Kostenplaats Inzet costUnit The cost unit of an Assignment     P01129 - Kostendrager Inzet costType The cost type of an Assignment     P01127 - Kostensoort Inzet type Type of assignment     P01123 - Soort Inzet   Cost allocation The cost allocation of an employee. The cost allocations are generated by Beaufort. An employee can multiple cost allocations. Mostly the cost allocation with sequence number 0 or the one with the highest percentages  is the main cost allocation. HR Core Beaufort: Loonverdeling   id Unique id of the cost allocation. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.   32789 1 0 system field Unique id of the assignment PersonCode The unique id assigned to the employee 32789   Persoonsnummer employmentCode The code of the employment of the person 1   Dienstverband volgnummer sequenceNumber Unique sequence number or row number of the cost allocation within the employee 0 P01131 regelnummer loonverdeling costTypeCode code of the cost type  4004 P01133 Kostensoort loonverdeling CostTypeName full name of the cost type Loonkosten   Omschrijving kostensoort (referentie tabel) costCenterCode code of the cost center 4000 P01134 Kostenplaats loonverdeling costCenterName full name of the cost center KNO Operaties   Omschrijving kostenplaats (referentie tabel) costUnitCode code of the cost unit 4100 P01135 Kostendrager loonverdeling costUnitName full name of the cost unit KNO   Omschrijving kostendrager (referentie tabel) percentage percentage of the cost allocation 100 P01132 loonverdeling loonverdeling     Organization Units The organization structure describes the organization in terms of business unit, departments, divisions, etc. and how these are related to each other. Based on the organization structure it's clear “how” units are related and "which" department is responsible for "what". HR Core Beaufort: Organisatie eenheden   validFrom The date from which the record is valid 2020-04-01 N/A Data niet beschikbaar in de API 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 Data niet beschikbaar in de API id Unique id of the organization unit PD P01061 Code organisatorische eenheid shortName Code or short name of the Organization Unit PD P01061 Code organisatorische eenheid fullName Name or full title of the Organization Unit Product Development   Naam organisatorische eenheid parentOrgUnit Code of the parent organization unit PD_EU   Organisatie eenheid > Onderdeel van organizationUnitType Type of organization unit Divisie   Type organisatorische eenheid isBlocked   True/false   Deze indicatie wordt gebruikt om aan te geven dat er geen nieuwe medewerkers meer op de organisatie eenheid mogen worden geplaatst. De indicatie IsBlocked wil dus niet zeggen dat er geen medewerkers meer aan gekoppeld zijn. Address       Adres-velden bij de OE. PhoneNumber       Telefoonnummer bij de OE. CostCenterCode       Kostenplaatscode behorend bij de OE.   Role Assignments The role assignment describes "who" is responsible for “what“ and “when“ within the organization unit. HR Core Beaufort: Rol toewijzing   validFrom The date from which the record is valid 2020-04-01     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     id Unique id of the role assignment. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user. R1 - N/A BO4 - 78000 1877 MGR 20200101   Id van het record personId The unique id assigned to the employee 10017   Persoonsnummer van de houder van de rol organizationUnit The organization unit id of the assignment. 459   Code van organisatorische eenheid shortName The code of the role MGR   Code van de rol personCode The code of the person 12345   Persoonsnummer van de houder van de rol (gelijk aan personID) startDate Start date of role assignment 2013-04-17     endDate End date of role assignment 2020-01-31       Indien gewenst, gebruik het filter ValidOn om enkel de records te verkrijgen die op een bepaalde datum geldig zijn. Zo zullen zonder dit filter alle rollen, inclusief hun start- en einddatum, getoond worden - zelfs die met een toekomstige startdatum. Dankzij het filter kan je nu alleen de roltoewijzingen ophalen die geldig zijn op een specifieke dag.     Job Profiles All job profiles that have been defined within the tenant. HR Core Beaufort: Functie   shortName Code or short name of the Job Profile SE Functie code fullName Name or full title of the Job Profile Software Engineer 5 Functie omschrijving jobFamily Code or short name of the Job Family PD5 Functie groep code validFrom The date from which the record is valid 2020-04-01 Data niet beschikbaar in de API 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 Data niet beschikbaar in de API type     Functietype costUnit     Kostensoort costType     Kostendrager      

Eigen rubrieken toevoegen aan de API, wat is er mogelijk, wat moet je vooraf afstemmen en hoe vraag je het aan.

User endpoint   The user endpoint supports the retrieval of users and to set an identity for a user, the following methods are supported as part of the users endpoint. https://api.youforce.com/iam/v1.0/users GET Allows retrieving a single employee based on employeeId for the tenant specified in the request header. https://api.youforce.com/iam/v1.0/users(employeeId=12345) Supports the following parameter as part of the resource path: employeeId - The unique id assigned to an employee Returns a 200 OKwhen successful PATCH Allows to update or set an identity for a specific user based on employeeId for the tenant specified in the request header. https://api.youforce.com/iam/v1.0/users(employeeId=12345)/identity Supports the following parameters as part of its request body: id- Ping Id of the employee which is to be used for SSO { "id": "user@customer.com" } Returns a 204 No content when successful Returns a 404 when the user account doesn't exists 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 This will be addressed in future, when we merge the two services. 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 c7e230db-2a7f-4ef0-ad1d-9d30e7d94a2f string sourceId Username of the user in the Youforce portal XX123456 string identityId UPN/Identity in the customer authentication system that takes care of authentication Note: Only email format is supported user@customer.com string

De Basic api heeft de status Controlled Available en is enkel nog beschikbaar in overleg met Visma Raet.       Domein model  De Basic api bevat uitsluitend de basis medewerker- en organisatiegegevens. Middels deze API hebben externe systemen inzicht in de organisatiestructuur en de huidige medewerker.   Het model Entiteiten en velden   Person (Persoon) Id / personId Technical and unique id. the Id is unique within the entity and tenant. The id is owned by the core system and can not changed by a user P01001 - Persoonsnummer PersonCode The logical code or number of the employee. P01001 - Persoonsnummer Initials The initials of the employee. Format depends P00303 - Voorletters firstNames The official given names of the employee as stored in the HR Core system P01002 - Voornamen KnownAs The name which is used by the employee as his first name P01003 - Roepnaam lastNameAtBirth The last name at birth of the employee. Also known as the family name P00301 - Geboortenaam lastNameAtBirthPrefix The prefix of the last name at birth P00302 - Geboortenaam-voorvoegsels lastName The last which is currently used by the employee as his last name P01008 - Samengestelde naam lastNamePrefix The prefix of the last name as used currently P01009 - Samengestelde naam-voorvoegsels nameAssembleOrder Code of the assemble order that the core system uses for the last Name. The assemble order is depending on the core system and the logic behind it. P00304 - Gebruik achternaam partnerName The partner last name P00390 - Partner-naam partnerNamePrefix The prefix of the partner last name P00391 - Partner-voorvoegsels titlePrefix The formal title which will be used as a prefix before the name like Doctor, Professor, et cetera P00305 - Titulatuur voor de naam titleSuffix The formal title which will be used as postfix after the name like MSc or Master of Science P03937 - Titulatuur achter de naam gender Gender of the person conform the ISO/IEC 5128 standard (0) Not known (1) Male (2) Female (9) Not applicable P00330 - Geslacht M = Man / Male V = Vrouw / Female dateOfBirth Date of Birth P00321 -Geboorte datum deceased Indicated if the employee deceased Note: most core systems have a date field. In the API this will be translated to boolean P01005 - Datum overlijden UserUID Digital Identity of the user from the portal PORTAL : Ping ID emailAddresses List of the email addresses of the employee. The fields are: type like Business, Private, etc. address Business: P01035 - E-mail adres werk Private: P01034 - E-mail adres prive phoneNumbers list of phone numbers of the employee type like Business, Home, Mobile, et cetera number Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel Business :P01037 - Telefoonnr werk FaxBusiness : P01039 Faxnr werk FaxHome : P01038 Faxnr prive Addresses list of addresses of the employee. The address fields are: addressType like Home, Post, etc. streetName Number streetNumberAdditional postalCode city country Home: P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land Postal: P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land     Employment (Dienstverband) Id / employmentId Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user. Object Id = "PersonCode" + ContractCode PersonCode / PersonId Person code to which the employment is related P01001 - Persoonsnummer employmentCode / ContractCode / ContractId Code of the contract P01101 - volgnr dienstverband PayrollClientCode Logical code of the payroll client. Filter option for Row Authorisation (configuration API) [P01103 Opdrachtgever] PayrollInstitutionCode Logical code of the payroll Institution. Filter option for Row Authorisation (configuration API) [P01104 Instelling] hireDate The hire date of the employment P00322 - Datum in dienst dischargeDate The end date or discharge date of the employment. This is always an "up to and including" date. In unknown the field will not be visible in the API P00830 - Datum uit dienst originalHireDate The first hire date of original hire date of an employee within the organization. This date is important for the tenure or working anniversary of an employee P00834 -Datum in dienst CAO employmentType Type of employment like Internal employee, contractor, "Wachtgelder" Filter option for Row Authorisation (configuration API) P01102 - Soort arbeidsrelatie contractType Type of the contact like indefinite period ('Onbepaalde tijd') or given time ('bepaalde tijd') P08259 - Code contract (on)bepaalde tijd jobProfile Official job title or job profile of the employment. The Job profile contains the following details: shortName: Code or short name of the job profile P01107 - Primaire functie classification group or classification of the employment. Generic field Filter option for Row Authorisation (configuration API) P01110 - Code doelgroep organizationUnit organization unit Id of employment. The Id is a reference to the entity org units P01106 - Hierarchische org. eenheid workingAmount Work amount of employment. amountOfWork: the amount of work unitOfWork: Unit of work that specifies the amount of work like "hours", "days", et cetera periodOfWork: Period of work like "week" or "month" parttimePercentage P01109 - Uren per week P00404 percentage deelbetrekking   Organisation unit (Organisatie-eenheid) id Technical and unique id of the organization Unit. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user. ID shortName Code or short name of the organizational unit OE Code fullName Name of the organization unit OE naam parentOrgUnit reference to the parent organizational unit. Empty means that it is organizational unit on the highest level in the company ParentID organisationUnitTpe Type of the organization Unit   address Address of the organisation Unit - Address - street - number - numberAdditional - postalCode - city OE Adres costCenter default cost center of the organisation unit. Kostenplaats IsBlocked Indicates if the Organization unit is block for adding new employees. note: it is possible there are still employee referring to this Org Unit. blocked/inactive   Role assignment (roltoewijzing) id Technical and unique id of the role assigment. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user. object ID PersonID / personCode Technical ID of the Person Persoonsnummer shortName Short name of the role the person will have for this organization, like Manager, HR Professional, Director. P01062 - Rol organisationUnit Id of the organisation Unit P01061 - Operationele org.eenheid startDate Start date from which the role assignment is valid for that employee P01063 - ingangsdatum roltoewijzing endDate end date until when the role assignment is valid P01064 - einddatum roltoewijzing   Job profile (functie) id / shortName Unique id of the Job profile. the Id is unique within the entity and tenant. P02301 - Code functie fullName Name of the Job Profile P02302 - Omschrijving functie jobFamily Job family to which the job profile belongs P02305 - Code Functiegroep   User (Youforce user account) Id / UserUID Ping Id or User Id which be used for the SSO solution of Visma Raet Ping ID SourceId Youforce user name Gebruikersnaam IdentityId Identity of the user on the local network Identity

Artikel inhoud     Domein model  Het model   Entiteiten en velden Person (Persoon) Id / personId Technical and unique id. the Id is unique within the entity and tenant. The id is owned by the core system and can not changed by a user P01001 - Persoonsnummer PersonCode The logical code or number of the employee. P01001 - Persoonsnummer Initials The initials of the employee. Format depends P00303 - Voorletters firstNames The official given names of the employee as stored in the HR Core system P01002 - Voornamen KnownAs The name which is used by the employee as his first name P01003 - Roepnaam lastNameAtBirth The last name at birth of the employee. Also known as the family name P00301 - Geboortenaam lastNameAtBirthPrefix The prefix of the last name at birth P00302 - Geboortenaam-voorvoegsels lastName The last which is currently used by the employee as his last name P01008 - Samengestelde naam lastNamePrefix The prefix of the last name as used currently P01009 - Samengestelde naam-voorvoegsels nameAssembleOrder Code of the assemble order that the core system uses for the last Name. The assemble order is depending on the core system and the logic behind it. P00304 - Gebruik achternaam partnerName The partner last name P00390 - Partner-naam partnerNamePrefix The prefix of the partner last name P00391 - Partner-voorvoegsels titlePrefix The formal title which will be used as a prefix before the name like Doctor, Professor, et cetera P00305 - Titulatuur voor de naam titleSuffix The formal title which will be used as postfix after the name like MSc or Master of Science P03937 - Titulatuur achter de naam gender Gender of the person conform the ISO/IEC 5128 standard (0) Not known (1) Male (2) Female (9) Not applicable P00330 - Geslacht M = Man / Male V = Vrouw / Female dateOfBirth Date of Birth P00321 -Geboorte datum deceased Indicated if the employee deceased Note: most core systems have a date field. In the API this will be translated to boolean P01005 - Datum overlijden emailAddresses List of the email addresses of the employee. The fields are: type like Business, Private, etc. address Business: P01035 - E-mail adres werk Private: P01034 - E-mail adres prive phoneNumbers list of phone numbers of the employee type like Business, Home, Mobile, et cetera number Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel Business :P01037 - Telefoonnr werk FaxBusiness : P01039 Faxnr werk FaxHome : P01038 Faxnr prive Addresses list of addresses of the employee. The address fields are: addressType like Home, Post, etc. streetName Number streetNumberAdditional postalCode city country Home: P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land P01012 Adres m.i.v. Postal: P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land P01011 Adres m.i.v.   Employment (Dienstverband) Id / employmentId Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user. Object Id = "PersonCode" + ContractCode PersonCode / PersonId Person code to which the employment is related P01001 - Persoonsnummer employmentCode / ContractCode / ContractId Code of the contract P01101 - volgnr dienstverband PayrollClientCode Logical code of the payroll client. Filter option for Row Authorisation (configuration API) P01103 Opdrachtgever PayrollInstitutionCode Logical code of the payroll Institution. Filter option for Row Authorisation (configuration API) P01104 Instelling hireDate The hire date of the employment P00322 - Datum in dienst dischargeDate The end date or discharge date of the employment. This is always an "up to and including" date. In unknown the field will not be visible in the API P00830 - Datum uit dienst originalHireDate The first hire date of original hire date of an employee within the organization. This date is important for the tenure or working anniversary of an employee P00834 -Datum in dienst CAO employmentType Type of employment like Internal employee, contractor, "Wachtgelder" Filter option for Row Authorisation (configuration API) P01102 - Soort arbeidsrelatie contractType Type of the contact like indefinite period ('Onbepaalde tijd') or given time ('bepaalde tijd') P08259 - Code contract (on)bepaalde tijd jobProfile Official job title or job profile of the employment. The Job profile contains the following details: shortName: Code or short name of the job profile P01107 - Primaire functie classification group or classification of the employment. Generic field Filter option for Row Authorisation (configuration API) P01110 - Code doelgroep organizationUnit organization unit Id of employment. The Id is a reference to the entity org units P01106 - Hierarchische org. eenheid workingAmount Work amount of employment. amountOfWork: the amount of work unitOfWork: Unit of work that specifies the amount of work like "hours", "days", et cetera periodOfWork: Period of work like "week" or "month" parttimePercentage P01109 - Uren per week P00404 percentage deelbetrekking   SalaryDetails (Dienstverband) Id Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.   PersonCode Person code to which the employment is related P01001 - Persoonsnummer employmentCode Code of the employment P01101 - volgnr dienstverband GENERAL     typePaidWorkerCode type of paid or unpaid worker P00332 Code soort loner SALARY DETAILS     payrollSchemeCode payroll scheme related to the collective agreement P00314 Code salarisregeling payrollScale Salary scale P01151 Salaris payrollSeniority Salary step or seniority within the salary scale P00326 Ancienniteit salaris payrollAmountNo salary amount number P01152 Inpassingsnr salaris       GARANTEED SALARY DETAILS     GuaranteedPayrollScale Garanteed salary scale. P01157 Garantieschaal nummer GuaranteedSeniority Garanteed step or seniority within the garanteed scale P01158 Ancienniteit garantieschaal GuaranteedPayrollAmountNo salary amount number P00318 garantie salaris       CALCULATED SALARY DETAILS     CalculatedSalary calculated gross salary by Beaufort P01161 Berekend bruto salaris CalculatedHourlySalary calculated gross hourly salary by Beaufort P01162 Berekend bruto uurloon CalculatedGuaranteedSalary calculated gross garanteed salary by Beaufort P01159 Berekend garantiesalaris CalculatedGuaranteedHourlySalary calculated gross garanteed hourly salary by Beaufort P01160 Berekend garantie uurloon   Assignments (Inzet) assignmentID Technical and unique id. the Id is unique within the entity and tenant. The id is generated by the system and can not changed by a user.   PersonCode / PersonId Person code to which the employment is related P01001 - Persoonsnummer employmentCode / ContractCode / ContractId Code of the contract P01101 - volgnr dienstverband startDate/validFrom The date when the assignments start P01125 - Ingang inzet endDate/ValidUntil The end date of the assignment. This is always an "up to and including" date. In unknown the field will not be visible in the API P01126 - Einde inzet jobProfile Job title or job profile of the assignment. The Job profile contains the following details: shortName: Code or short name of the job profile P01122 - Operationele functie organizationUnit Organization unit id of the assignment. The Organization Unit Id is a reference tot the organization unit entity P01121 - Operationele org. eenheid workingAmount work amount of the assignment. amountOfWork: the amount of work unitOfWork : Unit of work that specifies the amount of work like "hours", "days", et cetera periodOfWork: Period of work like "week" or "month" P01124 - Uren inzet per week costCenter the cost center of the Assignment P01128 - Kostenplaats Inzet costUnit the cost unit of the Assignment P01129 - Kostendrager Inzet costType the cost type of the Assignment P01127 - Kostensoort Inzet type Type of assignment P01123 - Soort Inzet   Cost allocation (Loonverdeling) API Field Description (English) Beaufort field Example id Technical and unique id. the Id is unique within the entity and tenant.   1000 1 0 PersonCode Person code to which the employment is related P01001 - Persoonsnummer 1000 employmentCode Code of the contract P01101 - volgnr dienstverband 1 sequenceNumber Row number or sequence number or the cost allocation within the employee P01131 - regelnr loonverdeling 0 costCenter the cost center of the cost allocation row P01134 - Kostenplaats loonverdeling 10000 - administratie costUnit the cost unit of the cost allocation row P01135 - Kostendrager loonverdeling 10000 - Aministratie costType the cost type of the cost allocation row P01133 - Kostensoort loonverdeling 41300 - Afdelingshoofd percentage Percentage of the cost allocation row P01132 - Percentage loonverdeling 100 Leave Entitlements (Verlofrechten) id Technical and unique id. the Id is unique within the entity and tenant. object id PersonCode Person code to which the employment is related Persoonsnummer employmentCode Code of the contract volgnr dienstverband leaveType leave type code, like WET for legal P01430 code verlofsoort werknemer leaveEntitlementYear Year of the Leave entitlement P01440 verlofjaar verlofrechten leaveEntitlementLastYear leave entitlement last year P01442 verlofrecht vorig jaar in uren leaveEntitlementThisYear leave entitlement this year P01443 verlofrecht huidig jaar in uren   leave hours (Opgenomen verlof in uren) id Technical and unique id. the Id is unique within the entity and tenant.   PersonCode Person code to which the employment is related Persoonsnummer employmentCode Code of the contract volgnr dienstverband leaveEntitlementYear Year of the Leave entitlement P01466 - verlofjaar verlofrecht leaveType leave type code, like WET for legal P01465 - code verlofsoort leaveSequence leave request Id P01460 - Volgnummer verloftijdvak leaveDate leave date P01470 - Datum verlof leaveHours hours leave on specific leave P01471 - uren verlof   Sickleave (Ziekte algemeen, uitgezonderd zwangerschapsverlof) id Technical and unique id of the sickness case. The Id is unique within the entity and tenant.   PersonCode Person code to which the employment is related Persoonsnummer employmentCode Code of the contract volgnr dienstverband startDate first day of the sickness of the employee P01600 Datum eerste ao-dag recoveryDate recovery date or first working day of the employee P01606 Datum herstel expectedRecoveryDate Expected recovery date P01605 Datum verwacht herstel toevoegen Partial recovery     periodId technical id of the partial recovery period   periodStartDate The start date from which the new Illness percentages is valid P01640 - Ziektetijdvak vanaf percentage The percentages the employee is still sick. the percentage is always related to the total amount of working hours of the employee itself P01642 - Percentage ziek     Maternity leave (ziekte zwangerschapsverlof) id Technical and unique id of the Maternity leave. The Id is unique within the entity and tenant.   PersonCode Person code to which the employment is related Persoonsnummer employmentCode Code of the contract volgnr dienstverband startDate first day of the maternity leave of the employee P01600 Datum eerste ao-dag recoveryDate recovery date or first working day of the employee P01606 Datum herstel  

Veel arbodiensten gebruiken een eigen systeem om terugkoppelingsdocumenten op te stellen. Deze documenten zijn bedoeld voor betrokkenen binnen de klantorganisatie. Om deze terugkoppelingsdocumenten ook in Verzuim Management beschikbaar te krijgen, is het nodig om deze documenten handmatig in te voeren. Dit leidt echter tot dubbele invoer van de documenten en is bovendien foutgevoelig. Om deze dubbele invoer én eventuele fouten te voorkomen, is de SIVI documenten interface ontwikkeld.   Bij gebruikmaking van SIVI documenten leveren de arbodiensten de bestanden geautomatiseerd aan Visma Raet, via een beveiligde verbinding. Deze bestanden worden gekoppeld aan in Verzuim Management bestaande acties die zijn ingericht met een verwijzing naar de Identificatie document soort van SIVI.   Het aanleveren van de bestanden aan Visma Raet gebeurt via onze File API, de werking van de File API is hier gedocumenteerd.   De pagina Getting Started beschrijft hoe je een access token opvraagt en via Publishers/Multipart upload staat de API call beschreven die zorgt voor de upload.    Het bestand is het door SIVI voorgeschreven (XML)format versie 2020, de XML-bestandsnaam moet bij insturen via de File API voldoen aan het volgende formaat:   DO-XXXXXXXXXXXXXXX_YYYYMMDDHHMMSSFFF.xml of DO-XXXXXXXXXXXXXXX_YYYYMMDDHHMMSSFF.xml of DO-XXXXXXXXXXXXXXX_YYYYMMDDHHMMSS.xml   Voorbeelden:  DO-Tussentijdse evaluatie_20180622010203444.xml DO-Evaluatie n.a.v. gesprek 1_20180622010203444.xml   Toelichting: Onderdeel inhoud DO- Vaste waarde XXXXXXXXX Vrij in te vullen waarde. Variabel, minimaal 1 positie, maximaal 160 posities. Toegestane waarden:  alfa numeriek: A-Z, a-z, 0-9. punten. spaties _ Vast waarde, scheidingsteken YYYY Jaar, 4 posities MM Maand, 2 posities dd Dag, 2 posities HH Uur, 2 posities MM Minuut, 2 posities SS Seconden, 2 posities FF of FFF Milliseconden 0, 2 of 3 posities .xml Vaste waarde, extensie   Om het bestand via een File API-call te versturen naar Visma Raet dient businessTypeID 124000 gebruikt te worden in de call. Dit businessTypeID staat in Youforce voor de SIVI Documenten en dient samen met de bestandsnaam als metadata worden toegevoegd aan de API call. Een voorbeeld van de API-call:     Je kan de upload testen door gebruik te maken van onderstaande API-credentials API Key: VRA_fileapi_4001401_uploadsivi Secret Key: F0m9N5kbdXB4xEPQTkQRpd76H4JZw6CYoJQbskQ9zAJDdtu8WalC687ozkjoZ6tm TenantID: f556855c-a0c4-42c7-88f1-98bf5b209393   Met onderstaande variabelen in het SIVI document-XML-bestand voor een succesvolle test-verwerking:        <IdInzndr>ArbodienstX/IdInzndr> <IdOntvngr>Visma - Raet</IdOntvngr>  <HndlsnmOrg>RAET SIVI TEST</HndlsnmOrg> <IdWrkgvrArbdnst>test12345test</IdWrkgvrArbdnst> <AansltnrGeguitwlngArbdnst>6431</AansltnrGeguitwlngArbdnst> <Lhnr>999999999999</Lhnr> <SrtDocumentCd>999</SrtDocumentCd> <SrtDocumentOms>Overig</SrtDocumentOms> <KenmerkZendPartij>ArbodienstX</KenmerkZendPartij>   <IdWrknmr>1945</IdWrknmr> <IdDnstvbnd>1</IdDnstvbnd> <PersNr>1945</PersNr> <VrzmgvlId>1945 1 1809</VrzmgvlId> <DatEerstVrzmdg>2022-05-24</DatEerstVrzmdg>   Wanneer de File API een 201 (Created) teruggeeft dan is de upload succesvol geweest, neem met Visma Raet contact op om samen te controleren of het document daadwerkelijk is toegevoegd aan het verzuimdossier van de betreffende medewerker (persoonsnummer 1945, verzuimdossier 24-05-2022), een specifieke bestandsnaam van het document (<Bestandsnm>) helpt bij de controle.    

De IAM API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een Identity & Access Management toegang heeft.  Het autorisatie mechanisme bestaat uit de volgende onderdelen:   Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties. Autorisatie op medewerkers  Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen.  Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.     Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd.  Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.   Scope Omschrijving Endpoints Invitation_only Scope noodzakelijk om de API te kunnen activeren. Tijdens het activering proces wordt de contractafspraken gecontroleerd en vastgelegd.    Get_Basic Deze scope geeft nog geen toegang tot enige vorm van data maar is noodzakelijk voor de onboarding van klanten op de API of applicatie. Get basic data zoals medewerker- & organisatiedata GET Users GET persons GET employments GET employees GET assignments GET costAllocations GET organizationUnits GET roleAssignments GET jobProfiles Update_Identity Update van het veld Identity in de Youforce portal bij de medewerker. PATCH users GetPrivateContactDetails Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres. GET Employees   Dit betreft de volgende gegevens: ADRESGEVENS Home: P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land Postal: P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land TELEFOONNUMMERS Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel EMAILADRES Prive: P01034 - E-mail adres prive Write_Basic Update de HRCoreOnline-velden Email adres werk en of telefoonnummer werk. P01035 - E-mail adres werk P01037  - Telefoonnummer werk   Uw consultant kan u helpen bij het activeren / deactiveren van deze scopes binnen de API.     Autorisatie op basis van autorisatie filters De autorisatie filters hebben betrekking op welke medewerkers zichtbaar zijn in de API. Standaard worden altijd alle medewerkers getoond in de API. Bij het activeren van de API kan een consultant filters inrichten zodat maar een beperkte groep medewerkers via de API beschikbaar komen.   Filteren in de API is mogelijk op de volgende Beaufort velden: P01102- Soort Arbeidsrelatie  P01103- Opdrachtgever  P01104- Instelling  P01110 - Code doelgroep  P05040 - Selectie rubriek Domain API - IAM  Een veel voorkomen filter is bijvoorbeeld op Soort Arbeidsrelatie waarbij alleen eigen medewerkers in het extern systeem opgenomen worden.  Maar ook een filter op de combinatie Opdrachtgever / Instelling geeft u de mogelijkheid om de medewerkers van één of meerdere specifieke instellingen in de API op te nemen.   Uw consultant kan u helpen bij het inrichten of wijzigen van de autorisatie filters.

Dit document beschrijft de 'HelloID - Visma Raet IAM API’-connector. Een koppeling gebaseerd op de Visma Raet IAM API.

Nedap Ons is een populair systeem dat zorgprofessionals veel administratieve taken uit handen neemt door personeelsplanningen te maken en deze te koppelen aan Elektronische CliëntenDossiers (ECD).    Visma | Raet levert, met het toonaangevende Youforce platform, een volledig digitale HR-administratie waarmee de werkgever ‘in control’ is over alle processen in de employee lifecycle: van recruitment tot offboarding.   De integratie specialisten van Visma Connect hebben een API connector ontwikkeld die de overdracht van HR data tussen de applicaties van Visma | Raet en Nedap automatiseert.   Youforce API en import ONS Nedap De Youforce Workforce Management (WFM) API met de Extenions API, welke het mogelijk maakt om flexibel 'eigen' rubrieken toe te voegen, vormen de bron voor de connector.  Via de API's wordt de data opgehaald uit HRCoreOnline, waarnodig getransformeerd en aangeboden aan de API van ONS Nedap of via de XML-import van ONS Nedap zodat de data zichtbaar is in de applicatie van ONS Nedap.       Om gebruik te kunnen maken van de connector dien je contact op te nemen met je Customer Success Manager.   Frequentie van het ophalen van de data via de Youforce WFM API en het aanbieden aan ONS Nedap via de API en via de XML-import is ieder uur.   Via onderstaand tabel zie je de betreffende HRCoreOnline-velden die worden uitgewisseld. De velden maken deel uit van een 'scope' (deelgebied), als klant kan je kiezen welke scope(s) je op wilt nemen in de koppeling, bespreek dit met de Raet Consultant.   Benodigde voorbereiding    Eigen rubrieken aanmaken Een belangrijk deel van de informatie wordt via Eigen rubrieken vastgelegd, deze velden zijn essentieel om ONS Nedap goed te kunnen gebruiken, de aanwezigheid van deze velden in HRCoreOnline zijn dus een vereiste. Het aanmaken van de velden met de refentietabellen kan eenvoudig via XML-importbestanden, vraag die op bij je consultant. De wijze van import in HRCoreOnline staat hier beschreven:   https://community.visma.com/t5/Nieuws-Youforce-HR-Core-Beaufort/Rubrieken-voor-eigen-HRSS-inrichting-betaald-ouderschapsverlof/ba-p/504058   Let op, de velden zijn dan beschikbaar in HRCoreOnline desgewenst dien je ze ook op te nemen in de Selfservice-workflows.   ONS Nedap API en XML-import toegang Als klant vraag je bij ONS Nedap het volgende aan: Login credentials voor de ONS Nedap API (met Certificaat) Gebruikersnaam en wachtwoord voor de XML-import Je deelt dit met de Raet Consultant.   Youforce API filter Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen. Bekijk de mogelijkheden via: https://community.visma.com/t5/Kennisbank-Youforce-API/Autorisatie-WFM-api/ta-p/557545     Inhoud van de koppeling   Scope Basis (Persoonsgegevens, dienstverbanden en inzetregels).   HRCoreOnline - veld Import via ONS Nedap API-veld Import via Nedap XML-  veld Opmerking  Persoon P01001 - Persoonsnummer  employee.identificationNo        P00303 - Voorletters  employee.initials       P01003 - Roepnaam employee.firstName       P00301 - Geboortenaam employee.birthName       P00302 - Geboortenaam-voorvoegsels employee.partnerName       P01008 - Samengestelde naam employee.lastName       P01009 - Samengestelde naam-voorvoegsels employee.prefix       P00304 - Gebruik achternaam employee.preferredNameType       P00390 - Partner-naam employee.partnerName       P00391 - Partner-voorvoegsels employee.partnerNamePrefix       P00330 - Geslacht employee.gender       P00321 -Geboorte datum employee.dateOfBirth               Contact- gegevens Business: P01035 - E-mail adres werk employee.emailAddress       Business :P01037 - Telefoonnr werk employee.mobilePhoneNumber               Dienst- verband P01101 - volgnr dienstverband employee.identificationNo-[Volgnr van WFM]         contract.beginDate         contract.endDate         Employee.type   Heeft een vaste waarde 0 (regular)   P01102  - Soort Arbeidsrelatie contract.contractType     P01119 - Max. uren per week* payroll.Contract.var /contract.hoursVar               Inzet-regels P01125 - Ingang inzet teamAssignments.beginDate       P01126 - Einde inzet teamAssignments.endDate       P01121 - Operationele org. eenheid** team_assignments.teamObjectId       P01124 - Uren inzet per week payroll.Contract.fixed /contract.hoursFixed       Einddatum van het contract in ONS is gebasseerd op de einddatum van de inzetregel.   *Voor de berekening van de variabele contacturen worden de uren vanuit 'Max uren per week' vermindert met de contracturen uit het dienstverband (P01109 - Uren per week).    **bij meerdere actuele inzet-regels wordt de Organisatorische Eenheid gebruikt uit de inzetregel met het hoogst aantal uren per week, is dat ook gelijk dan zet de connector de Organisatorische eenheid  met de vroegste startdatum inzet over naar ONS.        Scope Extensies (Eigen rubrieken)     HRCoreOnline - veld Import via ONS Nedap API-veld Import via Nedap XML-  veld Opmerking Extentie-velden WKKRT1 - Weekkaartprofiel   registrationprofile     AGB001 - AGB-code 1   employee. agb.primaryAgbCode     AGB002 - AGB-code 2   employee.agb.agbCode     P09165 - BIG-nummer (1)   employee.bigCode     BIG002 - BIG-nummer (2)   employee.bigCode     BIG003 - BIG-nummer (3)   employee.bigCode     DBC001 - Cono-/DBC-beroepsgroep 1   employee. conoBeroepsgroep     DBC002 - Cono-/DBC-beroepsgroep 2   employee. conoBeroepsgroep     DBC003 - Cono-/DBC-beroepsgroep 3   employee. conoBeroepsgroep     AUT001 - Authenticatienummer employee. authentication MobilePhone employee. authenticationNumber     CAO001- CAO-code Ons   collectiveagreement. agreement     DEP001- Deskundigheids-profiel   education.id     COMP01- Compensatie berekenen     Wordt toegevoegd   COMP02- Compensatie begindatum     Wordt toegevoegd   COMP03 -Compensatie uitbetalen     Wordt toegevoegd   ONAN001- Onderaannemer     Niet beschikbaar    Bovenstaande velden worden geimporteerd via de Nedap XML-import. De XML-import ontvangt de data maar valideert niet dus er kan uitval ontstaan bij de verwerking. Raadpleeg het verwerkingsverslag van ONS voor de bevestiging van de verwerking. Indien er een fout zit in een XML-import-bestand dan vallen alle mutaties in dat bestand uit dus zorg ervoor dat de invoer van de velden juist is, denk aan het veld BIG001, dit veld is voor ONS nummeriek met een maximum aantal posities.   Scope Prive (Adres, telefoonnummer en e-mailadres)   HRCoreOnline - veld Import via ONS Nedap API-veld Import via Nedap XML-  veld Opmerking Adres (thuis) P01014 straatnaam EmployeeAddress.street     Adres (thuis) P01016 Huisnummer EmployeeAddress. homeNumber     Adres (thuis) P01018 Huisnummer toev EmployeeAddress. homeNumberExtension     Adres (thuis) P01020 Postcode EmployeeAddress.zipcode     Adres (thuis) P01022 Plaatsnaam EmployeeAddress.city     Adres (thuis) P01024 Land EmployeeAddress.country     Adres (post) P00365 straatnaam EmployeeAddress.street     Adres (post) P00367 huisnummer EmployeeAddress. homeNumber     Adres (post) P00368 huisnummer toev EmployeeAddress. homeNumberExtension     Adres (post) P00308 plaatsnaam EmployeeAddress.zipcode     Adres (post) P00313 postcode EmployeeAddress.city     Adres (post) P00847 land EmployeeAddress.country     Telefoonnummer Home: P01027 - telefoonnr woonadres EmployeeAddress. telephoneNumber     Telefoonnummer Mobile : P01036 - Telefoonnr mobiel EmployeeAddress. telephoneNumber2     E-mailadres Prive: P01034 - E-mail adres privé EmployeeAddress.email     Type Adres   typeString   Standaard wordt de volgende waarde gebruikt: 1: Living (bij Adres Thuis) 2: Postal (bij Adres Post) Type persoon   personType   Standaard wordt de volgende waarde gebruikt: 2: Employee Type verblijf   residentType   Standaard wordt de volgende waarde gebruikt: 0: Unknown     _______________________       Scope Salaris details   HRCoreOnline - veld Import via ONS Nedap API-veld Import via Nedap XML-  veld Opmerkingen Berekend uurloon P01160 Berekend garantie uurloon   employee.HourlyWage.wageInCents         employee.HourlyWage.startOfWage Datum waarop dit uurloon is ingegaan.  *Bestaat niet in Youforce,  eventueel contract datum nemen       employee.HourlyWage.endOfWage Datum waarop dit uurloon niet langer valide is. *Bestaat niet in Youforce eventueel contract datum nemen _____________________         Scope Verlof (rechten)   HRCoreOnline - veld Import via ONS Nedap API-veld Import via Nedap XML-  veld Opmerkingen Verlofsoort (WET, BW etc.) P01430 code verlofsoort werknemer   VacationAmount.plb   Jaar verlofrecht P01440 verlofjaar verlofrechten   CurrentDate   Verlofrechten huidig jaar P01443 verlofrecht huidig jaar in uren   VacationAmount.absolute      

  Introductie Voor de overgang van de IBU (Automatisch) naar File API kun je de volgende opties in overweging nemen:   Je kunt dit volledig zelf doen Consultancy afspraak van een uur waarin wij de file API en benodigde stappen uitleggen. Consultancy afspraak van 4 uur (Intake 1 uur + 3 uur verdere inrichting)  waarin we onderstaande stappen gezamenlijk doorlopen. Voor optie 2 en 3 (het inplannen van een consultancy afspraak) kan je in Mijn Support een nieuwe aanvraag indienen, kiezen voor soort consultancy (API), optie Aanvraag consultancy en vervolgens de benodigde informatie velden invullen.    Indien je ervoor kiest om de inrichting zelf te doen, volg dan onderstaande stappen zoals beschreven in dit artikel: Inventariseer om welke bestanden het gaat. Maak een account aan op het Visma Developer Portal Maak een applicatie aan op het Visma Developer Portal Maak een invitatiecode aan op Visma Developer Portal Dien een ticket in via ‘Mijn support’ Pas zonodig de modules aan om gebruik te maken van File API Implementeer de nieuwe File API oplossing in uw eigen omgeving.  1 - Inventariseer om welke bestanden het gaat Jullie Customer Success Manager heeft inzicht in het gebruik van IBU en kan daar op verzoek een lijst van aanleveren.   2 - Account aanmaken op Visma Developer Portal De Visma Developer portal is te bereiken via  https://oauth.developers.visma.com/service-registry/home   en maak via Create account een account aan         De portal zal via do.not.reply@mail.connect.visma.com  je een e-mail sturen met een Activatie account link.   Gebruik bij het registreren het Kvk-nummer als Organization number     Startscherm na inloggen     Desgewenst kun je een collega toevoegen via My team en New member. Jullie hebben dan beiden inzicht in de gegevens van de applicatie.     De volgende stap is het aanmaken van een applicatie (zie stap 3). 3 - Een applicatie aanmaken   Door een applicatie aan te maken ontstaat er een API Key en een Secret Key die je gebruikt om de authenticatietoken op te halen. Bij het inrichten van de File API vragen we je om een aparte applicatie aan te maken per file type (bijv. Datafeed, Aktes Export). Volg de stappen 3 tot en met 5 uit dit document voor elke applicatie die je aanmaakt.   Kies via het tabblad My Applications voor Add Application   Als application type selecteer Service, dit is het enige type wat door Visma|Raet wordt ondersteund.     Het aanmaken van de applicatie gaat via vier tabbladen, vul de gegevens in op het eerste tabblad Details. Weet dat de opgegeven Client Id wordt gebruikt als API key bij de API-aanroepen.    Je moet zelf de Client Id opgeven en om je bij vragen sneller van dienst te kunnen zijn, vragen wij je om bij het inrichten van de File API de waarde alsvolgt te kiezen: VRA_fileapi_6412345_Datafeed oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer en file type.  De 'isv'-prefix wordt standaard altijd toegevoegd   Let op: De Applicatienaam en Client Id heb je nodig in stap 5 om de autorisatie aan te vragen.   Let op:  Testomgeving - Indien je de API wilt koppelen aan jullie eigen testomgeving vragen wij je om bij het inrichten van de File API de waarde als volgt te kiezen: VRA_fileapi_6412346_BINT oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer van de testomgeving en file type.    Om je File API inrichting te testen kun je tevens gebruik maken van onze sandbox. Met deze sandbox kun je 3 dummy files ontvangen en ook testbestanden insturen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan deze sandbox. Maak hiervoor een 2e invitatie code aan in stap 4.    Via deze applicatie met bijbehorende Client Id en Secret krijg je toegang de data en of bestanden uit de Youforce/HRCoreEducation-omgeving(en). Eén API key-set kan toegang geven tot meerdere klantomgevingen.   Via de Tenant Id die je als Header meestuurt bij het aanvragen van een authenticatie token bepaal je de benodigde klantomgeving.   Access Token Lifetime mag op de default waarde blijven staan. Een aanpassing van deze waarde heeft geen effect op werking van de API, alsmede de opties Include JSON Web Token ID en TestApplication.   Gebruik eerst Save as a draft om vervolgens de applicatie aan te maken via Create, via Next ga je naar het volgende tabblad.     Het tabblad Credentials stelt je in staat om de API Secret aan te maken. Let op, de Secret waarde wordt alleen getoond via de pop up bij het aanmaken, dus neem dit direct over. De pop up toont ook je eerder gekozen ID (API key).   Let op: Wordt de bestaande secret vergeten dan dien je een nieuwe aan te maken, deze wordt dan toegevoegd.     Via het tabblad Integrations selecteer je Youforce File (voor de bestanden), oftewel je ‘basis’ API, je gebruikt hiervoor New integration.       Visma | Raet zal de opgegeven API’s goedkeuren. Dit gaat via een workflow in de portal, je hoeft daar niks voor te doen. De goedkeuring door Visma | Raet kan enkele dagen duren.       Per API dien je de Scope(s) te selecteren welke gebruikt gaat worden in deze applicatie. Op deze manier kun je bepaalde functionaliteiten binnen de Youforce API uitsluiten van je applicatie. Je kunt vanzelfsprekend ook alle Scopes selecteren, maar een API kan ook slechts 1 Scope gebruiken.   Onder het volgende screenshot vind je een tabel met de beschikbare scopes voor de verschillende file types.     Scopes Betekenis businesstypes list  In de toekomst zal deze scope inzenders en ontvangers toestaan om informatie te krijgen over file types (businesstypes). Op dit moment is het alleen mogelijk voor een inzender om op te vragen of er een ontvanger is voor een specifieke tenant/file type combinatie. files delete Deze scope staat ontvangers toe om bestanden te verwijderen die je niet wilt downloaden. files download Deze scope staat ontvangers toe om bestanden te downloaden, alsook inzenders om bestanden die zij zelf geüpload hebben te downloaden. files upload Deze scope staat inzenders toe om bestanden te uploaden. files list Deze scope staat ontvangers toe om bestanden weer te geven die klaar staan voor ontvangen, alsook inzenders voor de bestanden die zij zelf geüpload hebben. Onderstaande tabel bevat alle beschikbare file types en de scopes die beschikbaar zijn voor dat file type. Kies het file type waar je de applicatie voor aan het aanmaken bent en maak een keuze uit de scopes die daarvoor beschikbaar zijn. (Meerdere opties zijn dus mogelijk) Tabel file types   HR Core Education gebruik makend van de IBU  IBU: Module Id - Naam File API: File Type Id - Name Scopes 3 - Payroll Gemal Engine - Download 128001 - Payroll Gemal Exports businesstypes list files delete files download files list 17 - PayrollZend - Upload 129001 - Gemal Direct import Integratiebestanden (WIG*.im) businesstypes list files upload files download files list 34-Betaalmanager Downloads - Download 135000 - RBM Gemal Downloads (csv)  businesstypes list files delete files download files list 36-Betaalmanager Opdrachten - Download 135001 - RBM Gemal Payment Files (xml, zip) businesstypes list files delete files download files list 33 - Salarisdossier - Download 106000 - Salarisdossier Gemal Export businesstypes list files delete files download files list 35 - Personeelsdossier - Upload 107003 - Personeelsdossier Imports businesstypes list files upload files download files list 38 - Personeelsdossier - Download 107001 - Personeelsdossier Exports businesstypes list files delete files download files list 41 - Gebruikersbeheer - Upload 121003 - IAM XSSO businesstypes list files upload files download files list 80 - HR Core Edu Bulk Import - Upload 120000 - HRCE Bulk import businesstypes list files upload files download files list 81 - Management Informatie - Download 117000 - MI Education Datafeed Exports businesstypes list files delete files download files list 81 - Management Informatie - Download 117001 - MI Education Aktes Exports businesstypes list files delete files download files list 81 - Management Informatie - Download 120001 - HR Core Declaration Exports businesstypes list files delete files download files list 82 - Management Informatie - Upload 117004 - MI Education Akte Imports businesstypes list files upload files download files list   Het tabblad Integrations kan je niet direct bevestigen via Save, dat kan pas op het moment dat Visma|Raet de gekozen API’s bij de applicatie heeft goedgekeurd, dit gaat via een flow je hoeft hier niks voor te doen.    Je moet wachten op de bevestigings email van de goedkeuring door Visma|Raet voordat je met de volgende stappen verder kunt gaan.   Je kan door te klikken op de knop ‘Visma App store’ naar de laatste stap.   Tabblad Visma App Store   Voor toegang tot de klantdata genereer je straks in stap 4 een Invitatie Code. Hiervoor moet in de Visma App Store eerst het Access level - Audience configureren.     Na Start setup for Visma App Store ziet u onderstaand scherm en dan kies je bij Access level - Audience voor Invite only       Je bent nu klaar met het aanmaken van de applicatie, de optie Save is zichtbaar op het moment dat Visma | Raet de applicatie heeft goedgekeurd. Zo niet dan kun je dit scherm sluiten door bijvoorbeeld op Back to my Applications te klikken.  4 - Invitatiecode aanmaken Met een invitatiecode maak je het mogelijk de klantgegevens op te halen via je applicatie. Ga naar de Developer Portal https://oauth.developers.visma.com/service-registry/home  Kies voor My Applications. En klik op het potloodje achter de applicatie (Edit).    Kies voor het tabblad Visma App Store. En vervolgens New Invitation Code.     Bij Invitation description vul je de naam van de betreffende klant in. En klik vervolgens op Generate.       Let op: De Invitation Code heb je nodig in stap 5 om toegang te vragen tot de klant-data.   Visma | Raet zal de toegang tot de klant-data goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereedmaken.   Binnen het beheer van je applicatie en het scherm Integrations is via de tabblad Tenants (default wordt het tabblad Scopes getoond) terug te zien welke klanten (tenants) gekoppeld zijn aan je applicatie. Dit scherm laat ook de bijbehorende TenantID zien. De TenantID is benodigd bij het opvragen van de authenticatie token.   Voorbeeld van een Tenant ID   5 - Dien een ticket in via Mijn Support Dien ticket in via Mijn Support met de invitation code en het verzoek om autorisatie voor de File API. Vermeld in het ticket de volgende gegevens:   Klantnummer: Je Visma|Raet relatienummer Naam IT medewerker Degene die de File API bij jullie installeert Telefoonnummer IT medewerker   Email IT medewerker   Invitatiecode Deze code heb je aangemaakt in stap 4 Client Id De Client Id heb je aangemaakt in stap 3 Applicatienaam De Applicatienaam heb je aangemaakt in stap 3 File type Het file type wat je met deze applicatie gaat zenden of ontvangen. Bijv 117000 - MI Education Datafeed Exports   6 - Pas systemen aan om gebruik te maken van File API Als je Payroll Gemal Direct en/of Betaalmanager gebruikt dan moet je deze applicaties  configureren voor de File API. Zie deze  link voor meer informatie per module.   Voor andere modules hoef je niets te doen.   7 - Implementeer de nieuwe File API oplossing in uw eigen omgeving.  Vraag een IT collega met verstand van schedulen en het opstellen van powershell scripts om het stappenplan te volgen. Je vind de voorbeeld powershell scripts op deze pagina.    

With the documents endpoint files like certificates and other kind of documents can be uploaded for an employee to the Visma Personal File System (Personeelsdossier).  The API supports the following types of documents certificate (Certificaat) diploma (Diploma) career agreement (Loopbaan afspraak) career mail (Correspondentie loopbaan) career other (Overige loonbaan documenten) appraisal Review (Beoordelingsgesprek) performance Review (Functioneringsgesprek)  As-synchronized file upload Learning systems can upload files, like certificates, diplomas for individual employees to the Personal File System of Visma Raet. The file upload is an a-synchronized process. After the file is uploaded the consumer will receive a ticket Id, which can be used to monitor the process of the file upload.     Endpoints The API supports the following type of documents: API endpoint Personal file system endpoint Document type Description learning/v1.0/employees/ {personCode}/documents/certificate certificaat Certificaat learning/v1.1/employees/ {personCode}/documents/certificate certificaat Certificaat learning/v1.1/employees/ {personCode}/documents/diploma diploma Diploma learning/v1.1/employees/ {personCode}/documents/appraisalReview beoordelingsGesprek Beoordelingsgesprek learning/v1.1/employees/ {personCode}/documents/performanceReview functioneringsGesprek Functioneringsgesprek learning/v1.1/employees/ {personCode}/documents/careerAgreement loopbaanafspraken Loonbaan afspraken learning/v1.1/employees/ {personCode}/documents/careerMail corrLoopbaan Correnspondentie loopbaan learning/v1.1/employees/ {personCode}/documents/careerOther ovLoopbaan Overige loonbaan documenten   Note: v1.1 is using Content-Type: multipart/form-data and supports the other document types as well. v1.0 is using Content-Type: multipart/related and supports only certificates. We are advice you the use the latest version of an endpoint   To upload a document you need to use the POST method. For example  POST https://api.youforce.com//learning/v1.1/employees/{personCode}/documents/diploma for uploading a diploma to the Personal File System of Visma Raet. The endpoint returns a  ticketId  . The file will be stored in a standard folder for diplomas (see table for the other endpoints) The API will automatically upload the file to the Personal File System. This is an a-synchronized process with an automatic retry mechanism in case the file systems is not available. The retry mechanism will try to upload the file in a maximum of 6 hours. After this period the file will be rejected with a message. Also if the file is too big (maximum 4 Mb) or isn’t a PDF file, the upload will be rejected. GET documents/{TicketId}/status Endpoint for getting the status of the file upload. The endpoint will return the status of the file. After the file is processed successfully the status Complete is returned. Examples version 1.1 (all document types) Use POST request with multipart/form-data content type. Replace the PersonCode in the URL with the Id of the employee Use the authentication token received from the authentication endpoint Replace the tenant code with the tenant code of the client Give the document a proper description The field validFrom is optional. If it's empty the system date will be used as default The content-type for the file is  application/pdf Other type of files will be rejected by the API. The file size is also limited to a maximum of 4 Mb   Response Example of the response. HTTP/1.1 200 Content-Type: application/json { "ticketId": "7ca486f6-c730-4d50-a2ec-31a3a1373366", "description": "Example description", "size": 77491, "tenantId": "4028868", "creationDateTime": "2022-04-01T13:53:30.3985949", "status": "InProgress", "errorMessages": [] }   version 1.0 (certificates only) Use POST request with multipart/related content type with the first part having metadata in json format and the second one having a file. Replace the PersonCode in the URL with the Id of the employee Use the authentication token received from the authentication endpoint Replace the tenant code with the tenant code of the client Give the document a proper description The content-type of the metadata is application/json The content-type for the file is  application/pdf Other type of files will be rejected by the API. The file size is also limited to a maximum of 4 Mb     POST https://api.youforce.com/learning/V1.0/api/employees//documents/certificate Authorization: Bearer [YOUR_AUTH_TOKEN] Content-Type: multipart/related; boundary=boundary_not_used_within_file_content --boundary_not_used_within_file_content Content-Type: application/json; charset=UTF-8 { "Description":"YOUR_OWN_DESCRIPTION", "ValidFrom" : "2021-01-01" } --boundary_not_used_within_file_content Content-Type: application/pdf [PDF Content] --boundary_not_used_within_file_content--  Upload status After the file is posted to the API, the file upload can be followed with the status endpoint. Replace the TicketId in the URL with the  ticketId  from the previous API call. GET https://api.youforce.com/learning/v1.0/employees/documents/{{TicketId}}/status The API will return the status of the file upload. If the API could not upload the file, an error is shown as well. Response { "status": "Complete", "errorMessages": [] }

Dit document beschrijft de 'Ubeeo ATS - Visma Raet Learning API’-connector. Een koppeling gebaseerd op de Visma Raet Learning API.