Note: De WFM api is controlled available en is nog niet beschikbaar voor algemeen gebruik. De WFM API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een Workforce Management systeem toegang heeft.
Het autorisatie mechanisme bestaat uit de volgende onderdelen:
Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties.
Autorisatie op medewerkers Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen.
Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.
Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd. Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.
Scope
Omschrijving
Endpoints
Invitation_only
Scope noodzakelijk om de API te kunnen activeren. Tijdens het activering proces wordt de contractafspraken gecontroleerd en vastgelegd. Deze scope geeft nog geen toegang tot enige vorm van data maar is noodzakelijk voor de onboarding van klanten op de API of applicatie
-
Get_Basic
Get basic data zoals medewerker- & organisatiedata
GET persons GET employments
GET employmentTimelines GET assignments GET organizationUnits GET roleAssignments GET jobProfiles
GetPrivateContactDetails
Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres.
GET persons GET Employees
Dit betreft de volgende gegevens: ADRESGEVENS
Home:
P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land
Postal:
P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land
TELEFOONNUMMERS
Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel
EMAILADRES
Prive: P01034 - E-mail adres privé
Get salaryDetails
Lezen van de salarisgevens van medewerkers
GET SalaryDetails GET SalaryDetailTimelines
Get_maternitityLeave
Lezen van zwangerschapverlof van medewerkers
GET maternityLeave
Get_sicknessLeave
Lezen van ziekmeldingen van medewerkers
GET sickLeave
Get_leave
Lezen van verlofrechten en verlofopnames van medewerkers
GET leaveEntitlements GET leaveHours
Uw consultant kan u helpen bij het activeren / deactiveren van deze scopes binnen de API.
Autorisatie op basis van autorisatie filters
De autorisatie filters hebben betrekking op welke medewerkers zichtbaar zijn in de API. Standaard worden altijd alle medewerkers getoond in de API. Bij het activeren van de API kan een consultant filters inrichten zodat maar een beperkte groep medewerkers via de API beschikbaar komen.
Filteren in de API is mogelijk op de volgende Beaufort velden:
P01102- Soort Arbeidsrelatie
P01103- Opdrachtgever
P01104- Instelling
P01110 - Code doelgroep
P05042 - Selectie rubriek Domain API - WFM
Een veel voorkomen filter is bijvoorbeeld op Soort Arbeidsrelatie waarbij alleen eigen medewerkers in het extern systeem opgenomen worden. Maar ook een filter op de combinatie Opdrachtgever / Instelling geeft u de mogelijkheid om de medewerkers van één of meerdere specifieke instellingen in de API op te nemen.
Uw consultant kan u helpen bij het inrichten of wijzigen van de autorisatie filters.
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:
Inventariseer om welke bestanden het gaat.
Maak een Account aan op Visma Developer Portal
Maak een applicatie aan op Visma Developer Portal
Maak een Invitatiecode aan op Visma Developer Portal
Dien een ticket in via ‘Mijn support’
Pas systemen 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. Een overzicht van alle file types die in de File API beschikbaar zijn vind je hier. Kijk op deze pagina ook naar de beschikbare file types per Youforce module.
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 gebruik van de File API raden we je aan om een aparte applicatie aan te maken per Youforce module.
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, om je bij vragen sneller van dienst te kunnen zijn, vragen wij je om bij het gebruik van de File API de waarde alsvolgt te kiezen: VRA_fileapi_6412345_Gemal oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer en module.
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 gebruik van de File API de waarde als volgt te kiezen:
VRA_fileapi_6412345_Gemal
oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer van de testomgeving en module.
Het is tevens mogelijk om gebruik te maken van onze sandbox. Met deze sandbox kun je 3 dummy testfiles testen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan de sandbox. Maak hiervoor een 2e invitation code aan.
Via deze applicatie met bijbehorende Client Id en Secret krijg je toegang tot de data en of bestanden uit de Youforce 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 minimaal 1 Scope te selecteren welke gebruikt gaat worden in de applicatie. Door de juiste scopes te selecteren voorkom je dat de API per ongeluk voor de verkeerde actie (download of upload) wordt gebruikt. Maar je mag vanzelfsprekend ook alle Scopes selecteren.
Scopes
Betekenis
businesstypes list
In de toekomst zal deze scope publishers en subscribers toestaan om informatie te krijgen over businesstypes.
Op dit moment is het alleen mogelijk voor een publisher om op te vragen of er een subscriber is voor een specifieke tenant/businesstype combinatie.
files delete
Deze scope staat subscribers toe om bestanden te verwijderen zonder ze eerst te downloaden.
files download
Deze scope staat subscribers toe om bestanden te downloaden, alsook publishers om bestanden die zij zelf geüpload hebben te downloaden.
files upload
Deze scope staat publishers toe om bestanden te uploaden.
files list
Deze scope staat subscribers toe om bestanden weer te geven, alsook publishers voor de bestanden die zij zelf geüpload hebben.
Als een API bijv. alleen voor inzenden (publisher) voor een module wordt gebruikt dan is de 'files download' scope niet nodig en niet selecteren voorkomt dat je hem toch per ongeluk voor downloaden gebruikt.
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 kan door te klikken op tab ‘Visma App store’ naar de laatste stap.
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 4 ‘Invitatiecode aanmaken’.
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 een ticket in via Mijn Support met de invitation code en het verzoek om autorisatie.
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
De file types die je met deze applicatie gaat zenden of ontvangen. Bijv: 101015 - HR Core EDI INH
101029 - HR Core UWV DigiZSM
6 - Pas systemen aan om gebruik te maken van File API
Payroll Gemal Direct en Betaalmanager dienen te worden aangepast om bestanden via de File API te kunnen ontvangen. Zie link voor meer informatie per systeem.
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.
Status
De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor Payroll Only gebruikers. Dit betekent dat je zelf de autorisatie kunt toekennen in Autorisatiebeheer. Bestandsuitwisseling is de vervanger van handmatig Zenden/Ontvangen met IBU.
Vanaf vandaag zal de applicatie Bestandsuitwisseling standaard beschikbaar zijn in Autorisatiebeheer. In Autorisatiebeheer kan de beheerder rechten geven voor de verschillende bestandstypes aan de desbetreffende gebruikers.
Heb je nog geen toegang tot Autorisatiebeheer? Dien een ticket in bij 4Me en vermeld daarin de gebruikers die toegang moeten krijgen tot Autorisatiebeheer. Wij zullen er dan voor zorgen dat deze gebruikers worden toegevoegd.
Wat je moet doen
Ken in Autorisatiebeheer de juiste (onderstaande) rechten toe aan je gebruikers aan de hand van de volgende stappen.
NOOT: Indien je nog niet bekend bent met Autorisatiebeheer kun je hier lezen hoe je Autorisatiebeheer kunt gebruiken.
Stap 1: Maak een nieuwe Autorisatie aan, door in het startscherm van Autorisatiebeheer op ‘Autorisatie toevoegen’ te klikken. Vul de naam in voor de nieuwe Autorisatie en ken vervolgens de nieuwe Autorisatie toe aan ‘Alle gebruikers’ of ‘Specifieke gebruikers’. Voeg de applicatie Bestandsuitwisseling toe aan de nieuwe Autorisatie met de volgende rechten:
Toegang tot Bestandsuitwisseling
Zend testbestanden naar Bestandsuitwisseling
Ontvang testbestanden van Bestandsuitwisseling
Met deze rechten hebben de gebruikers, aan wie de nieuwe Autorisatie is toegekend, toegang tot Bestandsuitwisseling, maar alleen voor de testbestanden en nog geen rechten voor applicatie specifieke bestanden.
Stap 2: Voeg alle gewenste applicaties en hun specifieke rechten toe aan de juiste autorisatiegroepen. Hierbij is het mogelijk om aan één Autorisatie meerdere applicaties inclusief bijbehorende rechten te koppelen:
Betaalmanager
Ontvang downloads van Betaalmanager Gemal
Ontvang opdrachten van Betaalmanager Gemal
Payroll Gemal Direct
Ontvang bestanden van Payroll Gemal Direct
Payroll Gemal Direct Zenden
Zend PSG Integratiebestanden naar Payroll Gemal Direct
Zend SPG Integratiebestanden naar Payroll Gemal Direct
Salarisdossier Gemal
Ontvang bestanden van Salarisdossier Gemal
Personeelsdossier
Ontvang bestanden van Personeelsdossier
Zend bestanden naar Personeelsdossier
Youforce Account Beheer
Zend XSSO bestanden naar Gebruikersbeheer
Zend Dienstverbanden CSV bestand naar Gebruikersbeheer
Zend Organisatie bestanden naar Gebruikersbeheer
Zend Roltoewijzing bestanden naar Gebruikersbeheer
Flex Benefit
Ontvang TE bestanden van Flex Benefits
Zend RBP Werknemers bestanden naar Flex Benefits
Stap 3. Controleer of alle gebruikers, die toegang moeten hebben tot Bestandsuitwisseling, toegevoegd zijn aan deze autorisatie. Dit kan per gebruiker of via het rapport.
Stap 4. Aanvullend dient in de applicaties ‘Betaalmanager’ en ‘Payroll Gemal Direct’ te worden ingesteld dat de bestanden verstuurd worden naar Bestandsuitwisseling in plaats van naar Zenden & Ontvangen. Een overzicht van de acties per applicatie staan op deze community pagina.
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 het nieuwe inloggen om gebruik te kunnen maken van Bestandsuitwisseling.
Bestanden kunnen gedurende 1 maand worden opgehaald/ontvangen.
Bestanden kunnen gedurende 1 maand zo nodig meerdere malen worden ontvangen.
Bij verzenden van bestanden wordt er een kopie van de te verzenden bestanden verstuurd. Het verzonden bestand blijft lokaal beschikbaar.
Ontvangen bestanden worden opgeslagen in de Download directory die in je browser is geconfigureerd.
De Nederlandse taal wordt ondersteund. De gebruikte taal volgt de keuze die je bij de persoonlijke instellingen in Mijn Youforce hebt gemaakt.
Het is mogelijk om tegelijkertijd meerdere bestanden te ontvangen. Zie Release-opmerkingen Bestandsuitwisseling update 16-10-2023.
Aan de volgende onderwerpen wordt op dit moment gewerkt. We zullen je hier op de community op de hoogte houden van de voortgang:
Op dit moment wordt nog niet geregistreerd wie een bestand heeft ingezonden of ontvangen. Deze informatie is dus nog niet terug te zien in de betreffende schermen
Kennisartikelen
Zenden en Ontvangen met de IBU stopt
Youforce-bestanden koppelen aan Bestandsuitwisseling.
Hoe Bestandsuitwisseling testen met dummy-bestanden
Releases voor bestandsuitwisseling
This document describes the ‘Office Travel App - Visma Raet Learning API’ - connector. This connector has been built on top of the Visma Raet Learning API.
This document describes the ‘De leerrekening (EduBookers) - Visma Raet Learning API’ - connector. This connector has been built on top of the Visma Raet Learning API.
Note:
De Recruitment api heeft de status Controlled Available en is enkel nog beschikbaar in overleg met Visma Raet.
Artikel inhoud
Domein model
De Recruitment api bevat uitsluitend de basis medewerker- en organisatiegegevens. Middels deze API heeft de recruitment system inzicht in de organisatiestructuur en de huidige medewerker als mogelijk potentiële kandidaten binnen het recruitment proces.
Note:
De vacature en het onboarden van de nieuwe medewerker maken nog geen onderdeel uit van deze API.
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
Status
De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor VIPS Disbursements gebruikers. Dit betekent dat je zelf de autorisatie kunt toekennen in Autorisatiebeheer. Bestandsuitwisseling is de vervanger van handmatig Zenden/Ontvangen met IBU.
Vanaf vandaag zal de applicatie Bestandsuitwisseling standaard beschikbaar zijn in Autorisatiebeheer. In Autorisatiebeheer kan de beheerder rechten geven voor de verschillende bestandstypes aan de desbetreffende gebruikers.
Heb je nog geen toegang tot Autorisatiebeheer? Dien een ticket in bij Jira Support en vermeld daarin de gebruikers die toegang moeten krijgen tot Autorisatiebeheer. Wij zullen er dan voor zorgen dat deze gebruikers worden toegevoegd.
Wat je moet doen
Ken in Autorisatiebeheer de juiste (onderstaande) rechten toe aan je gebruikers aan de hand van de volgende stappen.
NOOT: Indien je nog niet bekend bent met Autorisatiebeheer kun je hier lezen hoe je Autorisatiebeheer kunt gebruiken.
Stap 1: Maak een nieuwe Autorisatie aan, door in het startscherm van Autorisatiebeheer op ‘Autorisatie toevoegen’ te klikken. Vul de naam in voor de nieuwe Autorisatie en ken vervolgens de nieuwe Autorisatie toe aan ‘Alle gebruikers’ of ‘Specifieke gebruikers’. Voeg de applicatie Bestandsuitwisseling toe aan de nieuwe Autorisatie met de volgende rechten:
Toegang tot Bestandsuitwisseling
Zend testbestanden naar Bestandsuitwisseling
Ontvang testbestanden van Bestandsuitwisseling
Met deze rechten hebben de gebruikers, aan wie de nieuwe Autorisatie is toegekend, toegang tot Bestandsuitwisseling, maar alleen voor de testbestanden en nog geen rechten voor applicatie specifieke bestanden.
Stap 2: Voeg alle gewenste applicaties en hun specifieke rechten toe aan de juiste autorisatiegroepen. Hierbij is het mogelijk om aan één Autorisatie meerdere applicaties inclusief bijbehorende rechten te koppelen:
Betaalmanager
Betaalbestanden aangemaakt vanuit P&B Core:
Ontvang opdrachten van Betaalmanager VIPS Disbursements
Ontvang downloads van Betaalmanager VIPS Disbursements
Betaalbestanden aangemaakt vanuit Payroll Gemal:
Ontvang downloads van Betaalmanager Gemal
Ontvang opdrachten van Betaalmanager Gemal
VIPS Disbursements (P&B Core)
Zend bestanden naar VIPS Disbursements
Ontvang bestanden van VIPS Disbursements
Payroll Gemal Direct
Ontvang bestanden van Payroll Gemal Direct
Payroll Gemal Direct Zenden
Zend EHRM bestanden naar Payroll Gemal Direct
Zend WIG Integratiebestanden naar Payroll Gemal Direct
Salarisdossier Gemal
Ontvang bestanden van Salarisdossier Gemal
Stap 3. Autoriseer ook je gebruikers die reeds gebruik maken van Bestandsuitwisseling
Stap 4. Aanvullend dient in de applicaties ‘Betaalmanager’ en ‘Payroll Gemal’ te worden ingesteld dat de bestanden verstuurd worden naar BestandsuitwisselingI in plaats van naar Zenden & Ontvangen. Een overzicht van de acties per applicatie staan op deze community pagina.
Stap 5. De laatste stap is het toekennen van de ‘Bestandsuitwisseling’ -tegel aan de geautoriseerde gebruikers via Toegangsbeheer. Hiermee wordt de tegel ‘Bestandsuitwisseling’ op de Youforce Desktop zichtbaar.
Extra informatie
Gebruikers moeten zich aanmelden via het nieuwe inloggen om gebruik te kunnen maken van Bestandsuitwisseling.
Bestanden kunnen gedurende 1 maand worden opgehaald/ontvangen.
Bestanden kunnen gedurende 1 maand zo nodig meerdere malen worden ontvangen.
Bij verzenden van bestanden wordt er een kopie van de te verzenden bestanden verstuurd. Het verzonden bestand blijft lokaal beschikbaar.
Ontvangen bestanden worden opgeslagen in de Download directory die in je browser is geconfigureerd.
De Nederlandse taal wordt ondersteund. De gebruikte taal volgt de keuze die je bij de persoonlijke instellingen in Mijn Youforce hebt gemaakt.
Het is mogelijk om tegelijkertijd meerdere bestanden te ontvangen. Zie Release-opmerkingen Bestandsuitwisseling update 16-10-2023.
Aan de volgende onderwerpen wordt op dit moment gewerkt. We zullen je hier op de community op de hoogte houden van de voortgang:
Op dit moment wordt nog niet geregistreerd wie een bestand heeft ingezonden of ontvangen. Deze informatie is dus nog niet terug te zien in de betreffende schermen
De basic api heeft de status Controlled Available en is enkel nog beschikbaar in overleg met Visma Raet.
De Basic API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een extern systeem toegang heeft.
Het autorisatie mechanisme bestaat uit de volgende onderdelen:
Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties.
Autorisatie op medewerkers Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen.
Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.
Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd. Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.
Scope
Omschrijving
Endpoints
Get_Basic
Get basic data zoals medewerker- & organisatiedata
GET persons GET employments GET organizationUnits GET roleAssignments GET jobProfiles
GetPrivateContactDetails
Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres.
GET persons
Dit betreft de volgende gegevens: ADRESGEVENS
Home:
P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land
Postal:
P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land
TELEFOONNUMMERS
Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel
EMAILADRES
Prive: P01034 - E-mail adres privé
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
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.
Het was al mogelijk om de HR Datafeed bestanden met de File API powershell scripts op te halen maar vanaf 19/02/2024 is het ook mogelijk om HR Datafeed bestanden via Bestandsuitwisseling te ontvangen.
Hiervoor moet je nog wel in Autorisatiebeheer het juiste recht toekennen.
Volg hier voor de volgende stappen:
1. Ga naar Autorisatiebeheer en zoek de groep waaraan je het Ontvangen HR Datafeed recht wilt toekennen.
2. Klik op de 'Bekijk details'-knop om de bijhorende applicaties in te zien
3. Klik op de knop 'Bewerken'
4a. Als de applicatie Managementinformatie nog niet in de lijst van applicaties voorkomt voeg deze dan toe door op de knop 'Applicatie toevoegen' te klikken.
4b. Selecteer in de popup de applicatie Managementinformatie en zet het vinkje AAN bij het recht 'Ontvang HR Datafeed bestanden van Managementinformatie', en klik vervolgens op de knop 'Toevoegen'. Ga verder met stap 6.
5. Als de applicatie Managementinformatie al wel in de applicatielijst (stap 3) staat klik dan op de knop 'Rechten bewerken' naast de applicatie Managementinformatie en zet in de popup het vinkje AAN bij het recht 'Ontvang HR Datafeed bestanden van Managementinformatie', en klik vervolgens op de knop 'Toevoegen'.
6. Druk op knop 'Opslaan' rechtsonder in het scherm om de wijziging op te slaan.
De Recruitment api heeft de status Controlled Available en is enkel nog beschikbaar in overleg met Visma Raet.
De Recruitment API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een recruitment systeem toegang heeft.
Het autorisatie mechanisme bestaat uit de volgende onderdelen:
Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties.
Autorisatie op medewerkers Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen.
Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.
Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd. Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.
Scope
Omschrijving
Endpoints
Invitation_only
Scope noodzakelijk om de API te kunnen activeren. Tijdens het activering proces wordt de contractafspraken gecontroleerd en vastgelegd. Deze scope geeft nog geen toegang tot enige vorm van data maar is noodzakelijk voor de onboarding van klanten op de API of applicatie
-
Get_Basic
Get basic data zoals medewerker- & organisatiedata
GET persons GET employments GET organizationUnits GET roleAssignments GET jobProfiles
GetPrivateContactDetails
Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres.
GET persons
Dit betreft de volgende gegevens: ADRESGEVENS
Home:
P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land
Postal:
P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land
TELEFOONNUMMERS
Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel
EMAILADRES
Prive: P01034 - E-mail adres privé
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
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.
Note:
De MLM api heeft de status Controlled Available en is enkel nog beschikbaar in overleg met Visma Raet.
De MLM api is een tijdelijke oplossing die op termijn vervangen wordt door de Sivi standaard en specifiek door het Sivi medewerker bericht. Zodra het Sivi medewerker bericht beschikbaar is, moet overgestapt worden op deze marktstandaard en komt de MLM api te vervallen.
De MLM API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een Medical Leave Management systeem toegang heeft.
Het autorisatie mechanisme bestaat uit de volgende onderdelen:
Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties.
Autorisatie op medewerkers Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen.
Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API. Beide autorisatie mechanismes moeten door een consultant ingericht worden.
Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd. Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.
Scope
Omschrijving
Endpoints
Invitation_only
Scope noodzakelijk om de API te kunnen activeren. Tijdens het activering proces wordt de contractafspraken gecontroleerd en vastgelegd. Deze scope geeft nog geen toegang tot enige vorm van data maar is noodzakelijk voor de onboarding van klanten op de API of applicatie
-
Get_Basic
Get basic data zoals medewerker- & organisatiedata
GET persons GET employments
GET employmentTimelines GET organizationUnits GET roleAssignments GET jobProfiles
GetPrivateContactDetails
Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres.
GET persons
Dit betreft de volgende gegevens: ADRESGEVENS
Home:
P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land
Postal:
P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land
TELEFOONNUMMERS
Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel
EMAILADRES
Prive: P01034 - E-mail adres privé
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
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.
Wij proberen continu onze powershell scripts voor de File API te verbeteren en fouten op te lossen. Hierdoor zullen er door ons indien nodig nieuwe scripts worden gemaakt.
De nieuwe scripts vervangen zonder verdere aanpassingen de 'oude' scripts en mogen eenvoudig 'er over heen' gekopieerd worden. Er zijn geen configuratie of andere handelingen nodig. Alle overige scripts en processen blijven ongewijzigd.
Deel de inhoud van dit artikel met jullie ICT mensen zodat zij deze aanpassingen kunnen uitvoeren.
Als je ook zeker wilt weten dat je de nieuwste powershell scripts gebruikt, doorloop dan de volgende stappen om deze scripts te downloaden en te installeren.
1. Controleer welke versie scripts je nu gebruikt door een dagelijks logbestand te openen. De dagelijkse logbestanden vind je in de Log Directory die je in je powershell scripts CONFIG...XML bij sectie <Logs> hebt geconfigureerd. Bij elk begin van een download of upload staan de versies van verschillende componenten genoemd.
2. Ga met je browser naar deze ReadMe URL en controleer wat de laatste versie is van de scripts. Deze staat altijd bovenaan. Als deze versie nieuwer is als wat je zelf gebruikt ga dan verder met de volgende stappen.
3. Selecteer nu in de browser in het linker Files menu het downloadscript 'Downloadfiles.ps1'
4. Download het 'DownloadFiles.ps1 script door op de Download button rechtsboven te drukken. Het bestand wordt direct gedownload en je kunt het terugvinden in de Download directory van je browser.
5. Selecteer nu in de browser in het linker Files menu het uploadscript 'Uploadfile.ps1'
6. Download het 'UploadFile.ps1 script door op de Download button rechtsboven te drukken. Het bestand wordt direct gedownload en je kunt het terugvinden in de Download directory van je browser.
7. Maak een kopie/backup van je Visma Raet Powershell installatie directory
8. Kopieer de 2 nieuwe scripts vanuit je Browser's Download directory naar je geinstalleerde powershell scripts en overschrijf de bestaande scripts, het 'DownloadFiles.ps1' script in de download directory en het 'UploadFile.ps1' script in de upload directory.
Publiceer jouw applicatie in de Visma App Store, op die manier kan een Visma Raet-consultant jouw applicatie koppelen aan een klant zonder invitatiecode.
Voor HR Core OnPremise en Payroll Only klanten is het vanaf 30/04/2024 mogelijk om met Bestandsuitwisseling Organisatie en Roltoewijzing bestanden in te zenden naar Gebruikersbeheer
Hiervoor moet je nog wel in Autorisatiebeheer de juiste rechten toekennen.
Volg hier voor de volgende stappen:
1. Ga naar Autorisatiebeheer en zoek de groep waaraan je de rechten wilt toekennen.
2. Klik op de 'Bekijk details'-knop om de bijhorende applicaties in te zien
3. Klik op de knop 'Bewerken'
4. Klik op de knop 'Rechten bewerken' naast de applicatie Youforce Account Beheer en zet in de popup het vinkje AAN bij de rechten 'Zend Organisatie bestanden naar Gebruikersbeheer' en 'Zend Roltoewijzing bestanden naar Gebruikersbeheer', en klik vervolgens op de knop 'Bewerken'.
6. Druk op knop 'Opslaan' rechtsonder in het scherm om de wijziging op te slaan.
7. Als de wijziging is opgeslagen kan het enkele minuten duren voordat de autorisatie in Bestandsuitwisseling is bijgewerkt.