Kennisbank Youforce API & bestandsuitwisseling

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

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.  

  Q: How can I receive only changed records? A:  The From and To filter is available to receive changes in a given time range. The From and To filter option is available on most endpoints, except valueLists. Example employees: Returns (active) employee records that have changed within the provided date-time range.   https://api.youforce.com/iam/v1.0/persons? from=2021-01-01T09:00:00.000Z &to=2022-01-10T14:00:00.000Z   Q: What does the 90 day retention policy signify? A:  At current, the retention policy on the data stored in for the IAM API is 90 days. Based on the following properties a record will be removed when the date defined for these properties is greater than 90 days in the past: dischargeDate  - employments, employees endDate  - role assignments, assignments Q: Why do I see records with the with dischargeDates or endDates in the past? A: We support the notion of retroactive changes i.e. when a dischargeDate for an employment or endDate for an assignment is defined today for a date is set in the past. This can be the result of an administrative mistake. In this scenario, the record will remain available for 90 more days based on the mutation date (date when the change was made).   Q: Why do I not see all the properties mentioned in the data mapping document in my response? In the IAM API properties that do not have values defined in the core systems are hidden. For this reason there might be a different amount of properties available per record.

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.

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