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.
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
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.
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.
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.
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
Publiceer jouw applicatie in de Visma App Store, op die manier kan een Visma Raet-consultant jouw applicatie koppelen aan een klant zonder invitatiecode.
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.
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.
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.
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.
Status
De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor HR Core OnPremise gebruikers. Dit betekent dat je zelf de autorisatie kunt toekennen in Autorisatiebeheer. Bestandsuitwisseling is de vervanger van handmatig Zenden/Ontvangen met IBU.
De applicatie Bestandsuitwisseling is standaard beschikbaar in Autorisatiebeheer. In Autorisatiebeheer kan de beheerder rechten geven voor de verschillende filetypes 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. Lees dit kennis artikel hoe je kunt testen met Bestandsuitwisseling.
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:
HR Core OnPremise
Zend EDI INH bestanden naar EDI module
Zend UWV Digi-ZSM bestanden naar UWV
Zend SBFT bestanden naar Payroll Gemal
Ontvang Gemal Salarisregelingen
Ontvang HR Core Upgrades
Betaalmanager
Ontvang downloads van Betaalmanager Gemal
Ontvang opdrachten van Betaalmanager Gemal
Payroll Gemal Direct
Ontvang bestanden van 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
Flex Benefit
Ontvang TE bestanden van Flex Benefits
Self Service
Zend HI CSV bestand naar Self Service
Zend HI XML bestand naar Self Service
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. 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 en Engelse taal worden 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.
Kennisartikelen
Zenden en Ontvangen met de IBU stopt
Youforce-bestanden koppelen aan Bestandsuitwisseling.
Hoe Bestandsuitwisseling testen met dummy-bestanden
Releases voor bestandsuitwisseling
Controlled available: inhoud is niet definitief
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
P01002 - Voornamen
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)
P08259 - Code contract (on)bepaalde tijd
contract.contractType
0=Onbepaalde tijd; 1=Bepaalde tijd;
2=inhuur
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
Scope Extensies (Eigen rubrieken)
HRCoreOnline - veld
Import via ONS Nedap API-veld
Import via Nedap XML- veld
Opmerking
Extentie-velden
WKKRT1 - Weekkaartprofiel
Niet beschikbaar in de koppeling?
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
Niet beschikbaar
COMP01- Compensatie berekenen
Niet beschikbaar
COMP02- Compensatie begindatum
Niet beschikbaar
COMP03 -Compensatie uitbetalen
Niet beschikbaar
ONAN001- Onderaannemer
Niet beschikbaar
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
Overgehevelde verlofrechten van vorig jaar
P01442 verlofrecht vorig jaar in uren
VacationAmount.absolute
Het is niet mogelijk om vorige jaar en huidige jaar uren apart in nedap ONS te krijgen. Wij doen vorige jaar + Huidige Jaar = Totaal -> Nedap ONS
__________________________
Verlofrechten huidig jaar
P01443 verlofrecht huidig jaar in uren
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
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
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
Status
De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor HR Core Education 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:
HR Core Education
Zend aktes naar MI Education
Zend bulk bestanden naar HR Core Education
Ontvang declaratiebestanden van HR Core Education
Ontvang aktes van MI Education
Ontvang datafeed bestanden van MI Education
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 WIG Integratiebestanden naar 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
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 en 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
Filters
Person endpoint
The person endpoint supports the following query string parameters:
changedAfter and
changedUntil
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/persons?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z
Employee endpoint
THIS ENDPOINT HAS BEEN DEPRECATED Use the endpoints Person and Employment.
Employment endpoint
The employee endpoint supports the following query string parameters
Parameter
description
personCode
Returns a list of employment records filtered by personId
https://api.youforce.com/learning/v1.0/employments?personCode=191166
personId
Returns a list of employment records filtered by personId
https://api.youforce.com/learning/v1.0/employments?personId=191166
changedAfter and
changedUnil
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/employments?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z
Cost allocation endpoint
The cost allocation endpoint supports the following query string parameters
Parameter
Description
Id
Returns the cost allocation by id
https://api.youforce.com/learning/v1.0/costAllocations/100028%201%200
Organization unit endpoint
The organizationUnits endpoint supports the following query string parameters
Parameter
Description
shortName
Returns a list of all organizationUnit records filtered by shortName
https://api.youforce.com/learning/v1.0/organizationUnits?shortName=1010A
changedAfter and
changedUnil
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/organizationUnits?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z
Role assignment endpoint
The roleAssignments endpoint supports the following query string parameters
Parameter
Description
personId
Returns a list of all role assignment records filtered by personId
https://api.youforce.com/learning/v1.0/roleAssignments?personId=1010A
shortName
Returns a list of all role assignment records filtered by shortName
https://api.youforce.com/learning/v1.0/roleAssignments?shortName=MGR
changedAfter and
changedUnil
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/roleAssignments?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z
Job profile endpoint
The jobProfiles endpoint supports the following query string parame
Parameter
Description
shortName
Returns a list of all jobProfile records filtered by shortName
https://api.youforce.com/learning/v1.0/jobProfiles?shortName=1010A
changedAfter and
changedUnil
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/jobProfiles?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z
Pagination of the result set
To reduce the load of an endpoint each endpoint supports paging. If the results of an endpoint contain more than 500 records, the results set will end with a nextLink tag. The nextLink indicates that there are more pages to load. If there is no nextLink at the end of the page, it means that it’s the last page of the result set. The default value is 500 records, but it is possible to use less than that.
Hieronder een voorbeeld waarbij 125 records per pagina wordt opgehaald.
GET https://api.youforce.com//iam/v1.0/persons?take=125
In de nextLink wordt deze page size overgenomen, zodat ook de vervolg pagina's maximaal 125 records bevat.
U kunt een page size tot maximaal 1000 records opvragen.
Delete a record
After a record is deleted in the core system, the API will return the record with his id and the flag isDelete = true.
This delete means that the whole record including all version are delete.
For example
{
"id": "907624",
"isDeleted": true,
"shortName": "907624"
}
Swagger documentation
The following swagger pages gives an overview of the endpoint:
IAM endpoints
Filters
Person endpoint
The person endpoint supports the following query string parameters
Parameter
Description
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) person records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/persons?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z
Employee endpoint
THIS ENDPOINT HAS BEEN DEPRECATED Use the endpoints Person and Employment.
The employee endpoint supports the following query string parameters
Parameter
Description
personCode
Returns a list of employee records filtered by personId
https://api.youforce.com/iam/v1.0/employees?personCode=191166
personId
Returns a list of employee records filtered by personId
https://api.youforce.com/iam/v1.0/employees?personId=191166
organizationUnit
Returns a list of all employee records filtered by organizationUnit id
https://api.youforce.com/iam/v1.0/employees?
organizationUnit=13612345
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) employee records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/employees?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z
Employment endpoint
The employee endpoint supports the following query string parameters
Parameter
Description
personCode
Returns a list of employment records filtered by personId
https://api.youforce.com/iam/v1.0/employments?personCode=191166
personId
Returns a list of employment records filtered by personId
https://api.youforce.com/iam/v1.0/employments?personId=191166
organizationUnit
Returns a list of all employment records filtered by organizationUnit id
https://api.youforce.com/iam/v1.0/employments?
organizationUnit=13612345
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) employment records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/employments?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z
Assignment endpoint
The assignments endpoint supports the following query string parameters
Parameter
Description
personId
Returns a list of assignment records filtered by personId
https://api.youforce.com/iam/v1.0/assignments?personId=191166
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) assignment records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/assignments?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z
Cost allocation endpoint
The cost allocation endpoint supports the following query string parameters
Parameter
Description
Id
Returns the cost allocation by id
https://api.youforce.com/iam/v1.0/costAllocations/100028%201%200
Person code
Returns a list of cost allocations for a specific person. The list could contain records for different employments of the employee
https://api.youforce.com/iam/v1.0/costAllocations?personCode=100028
Organization unit endpoint
The organizationUnits endpoint supports the following query string parameters
Parameter
Description
shortName
Returns a list of all organizationUnit records filtered by shortName
https://api.youforce.com/iam/v1.0/organizationUnits?company=1010A
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) organization unit records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/organizationUnits?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z
Role assignment endpoint
The roleAssignments endpoint supports the following query string parameters
Parameter
Description
personId
Returns a list of all role assignment records filtered by personId
https://api.youforce.com/iam/v1.0/roleAssignments?personId=1010A
shortName
Returns a list of all role assignment records filtered by shortName
https://api.youforce.com/iam/v1.0/roleAssignments?shortName=MGR
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) employee records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/roleAssignments?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z
Job profile endpoint
The jobProfiles endpoint supports the following query string parameters
Parameter
Description
shortName
Returns a list of all jobProfile records filtered by shortName
https://api.youforce.com/iam/v1.0/jobProfiles?shortName=1010A
from and to
Date Time stamp filter:
Date Time should be in UTC
Format: YYYY-MM-DDTHH:MM:SS.sssZ
Returns (active) jobProfile records that have changed within the provided date-time range.
https://api.youforce.com/iam/v1.0/jobProfiles?
from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z