MEER WAARDE UIT TIJD |
Dit artikel kun je lezen in: 4 min
Algemene toelichting
De koppeling tussen Beaufort en TimEnterprise is gebaseerd op een REST-API. Op deze pagina staat beschreven welke gegevens er gebruikt kunnen worden in de koppeling tussen Beaufort en TimEnterprise.
Per onderwerp staat in tabelvorm uitgelegd welke gegevens in Tim corresponderen met de gegevens uit Beaufort. Hieronder een toelichting hoe de tabellen zijn opgebouwd:
- Functioneel veld Tim
- Dit is de veldnaam die zichtbaar is in de Swing Client van Tim (en sommige velden ook in de webclient van Tim).
- Rubriekcode Beaufort
- Hiermee verwijzen we naar de rubriekcode die in Beaufort gebruikt wordt.
- Endpoint
- De endpoint geeft weer welke tabel van de API we voor dit onderwerp aanroepen om de informatie op te halen.
- Veld API
- Het veld API beschrijft welk veld uit de eindpoint we hiervoor gebruiken. Het kan zo zijn dat meerdere velden uit de API gezamenlijk gebruikt worden om één veld in Tim te vullen. Een goed voorbeeld hiervan is de naam van een medewerker.
- Opmerkingen
- Hier geven we, indien nodig, nog een toelichting op de velden en het gebruik ervan.
Personen
Bij “Personen” importeren we de medewerkers. In Tim zijn deze terug te vinden via Management > Personen.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | P01001 | Personen (/persons) | Id / personId / PersonCode | |
| Naam | P00303 | Personen (/persons) | Initials | |
| Naam | P01003 | Personen (/persons) | KnownAs | |
| Naam | P01008 | Personen (/persons) | lastName | |
| Naam | P01009 | Personen (/persons) | lastNamePrefix | |
| Geboortedatum | P00321 | Personen (/persons) | dateOfBirth | |
| E-mailadres | P01035 | Personen (/persons) | emailAddressesBusiness | |
| Mobiel telefoonnummer | P01036 | Personen (/persons) | phoneNumbersMobile | |
| Intern telefoonnummer | P01037 | Personen (/persons) | phoneNumbersBusiness | |
| Dienstperiode (startdatum)[1] | P00322 | Dienstverbanden (/employments)[1] | hireDate | Wordt ook gebruikt in afdelingslidmaatschappen |
| Dienstperiode (einddatum)[1] | P00830 | Dienstverbanden (/employments)[1] | dischargeDate | Wordt ook gebruikt in afdelingslidmaatschappen |
Afdelingen
Bij afdelingen worden de verschillende afdelingen / teams van de organisatie geïmporteerd. Deze zijn terug te vinden via Management > Afdelingen. De P-codes van deze tabel zijn P01106 (Hiërarchische organisatorische eenheid) en P01121 (Operationele organisatorische eenheid).
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | ‘Organization units’ (/organizationUnits) | id | ||
| HRMCode | ‘Organization units’ (/organizationUnits) | shortName | ||
| Naam | ‘Organization units’ (/organizationUnits) | fullName | ||
| Deel van | ‘Organization units’ (/organizationUnits) | parentOrgUnit |
Afdelingsleden
Afdelingsleden in Tim geven aan op welke afdeling iemand werkzaam is. In de koppeling is in te stellen of deze informatie uit het dienstverband of de inzet gehaald moet worden.
Let op! Afdelingsleden & criteria moeten uit dezelfde bron worden opgehaald. Wanneer je bij afdelingsleden voor dienstverband kiest, moet je dit bij de criteria ook doen. De gekozen instelling geldt voor alle medewerkers en moet bij de inrichting gemaakt worden. Afhankelijk van de gemaakte keuze wordt een van de onderstaande endpoints gebruikt.
Dienstverband
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | Dienstverbanden (/employments) | Id | ||
| Persoon | P01001 | Dienstverbanden (/employments) | PersonCode/PersonId | |
| HRMCode | P01101 | Dienstverbanden (/employments) | employmentCode / ContractCode / ContractId | |
| Periode (startdatum)[1] | P00322 | Dienstverbanden (/employments) | hireDate | Wordt ook gebruikt als in-dienstdatum bij persoon |
| Periode (einddatum)[1] | P00830 | Dienstverbanden (/employments) | dischargeDate | Wordt ook gebruikt als uit-dienstdatum bij persoon |
| Afdeling | P01106 | Dienstverbanden (/employments) | organizationUnit | |
| WerknemerType | P01102 | Dienstverbanden (/employments) | employmentType |
Inzet
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | Inzetten (/Assignments) | Id | ||
| Persoon | P01001 | Inzetten (/Assignments) | PersonCode/PersonId | |
| HRMCode | P01101 | Inzetten (/Assignments) | employmentCode | |
| Periode (startdatum) | P01125 | Inzetten (/Assignments) | startDate | |
| Periode (einddatum) | P01126 | Inzetten (/Assignments) | endDate | |
| Afdeling | P01121 | Inzetten (/Assignments) | organizationUnit | |
| WerknemerType | P01102 | Dienstverbanden (/employments)[1] | employmentType | [1] Werknemertype zit niet in de inzetten, dus we matchen de employment code en personId in de inzet om het bijbehorende dienstverband te vinden. |
Criteria
Criteria is het aantal te werken uren van een medewerker op een bepaalde afdeling, voor een bepaalde periode. Bijvoorbeeld Medewerker 1, op Afdeling A voor 36:00 uur per week. Het criterium is dus op verschillende plaatsen terug te vinden: Via Management > Criteria, via de Persoon > Tabblad Criteria, Afdelingen > tabblad Criteria.
Let op! Afdelingsleden & criteria moeten uit dezelfde bron worden opgehaald. Wanneer je bij afdelingsleden voor dienstverband kiest, moet je dit bij de criteria ook doen. De gekozen instelling geldt voor alle medewerkers en moet bij de inrichting gemaakt worden. Afhankelijk van de gemaakte keuze wordt een van de onderstaande endpoints gebruikt.
Dienstverband
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| Maximum duur | P01109[1] | Dienstverbanden (/employments) | * workingAmount[2] ** amountOfWork ** unitOfWork ** periodOfWork | [1] Uren per week (De P-code is alleen uren per week) [2] 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” |
| Periode (startdatum) | P00322 | Dienstverbanden (/employments) | hireDate | |
| Periode (einddatum) | P00830 | Dienstverbanden (/employments) | dischargeDate | |
| Afdeling | P01106 | Dienstverbanden (/employments) | organizationUnit | |
| Minimum duur | P01109[1] | Dienstverbanden (/employments) | * workingAmount ** amountOfWork ** unitOfWork ** periodOfWork | [1] Uren inzet per week (De P-code is alleen uren per week) |
Inzet
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| Maximum duur | P01109[1] | Inzetten (/assignments) | * workingAmount[2] ** amountOfWork ** unitOfWork ** periodOfWork | [1] Uren per week (De P-code is alleen uren per week) [2] 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” |
| Periode (startdatum) | P01125 | Inzetten (/assignments) | startDate/validFrom | |
| Periode (einddatum) | P01126 | Inzetten (/assignments) | endDate/ValidUntil | |
| Afdeling | P01121 | Inzetten (/assignments) | organizationUnit | |
| Minimum duur | P01124[1] | Inzetten (/assignments) | * workingAmount ** amountOfWork ** unitOfWork ** periodOfWork | [1] Uren inzet per week (De P-code is alleen uren per week) |
Budgetten (Verlofrechten)
Verlofrechten / budgetten kunnen vanuit Beaufort geïmporteerd worden. Deze budgetten kunnen dan in Tim worden opgenomen door middel van een aanvraag.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| Product | P01430 | Verlofrechten (/leaveEntitlements) | leaveType | Code verlofsoort werknemer |
| Periode | P01440 | Verlofrechten (/leaveEntitlements) | leaveEntitlementYear | Verlofjaar verlofrechten |
| Duur | P01442 | Verlofrechten (/leaveEntitlements) | leaveEntitlementLastYear | * Verlofrecht vorig jaar in uren ** Maakt deel uit van het totaalbudget |
| Duur | P01443 | Verlofrechten (/leaveEntitlements) | leaveEntitlementThisYear | Verlofrecht huidig jaar in uren |
| Omschrijving | P01442/P01443 | Verlofrechten (/leaveEntitlements) | leaveEntitlementLastYearleaveEntitlementThisYear |
Verlofaanvragen (Verlofuren)
Verlofaanvragen die in Beaufort zijn verwerkt worden in Tim getoond in de kalender van de medewerker. Dit is terug te zien in o.a. Mijn Tim, in het bezettingsoverzicht en de Outlook agenda als er gebruik gemaakt wordt van de agenda-koppeling.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | Verlofuren (/leaveHours) | id | ||
| Persoon | P01001 | Verlofuren (/leaveHours) | personCode | |
| Afdeling | P01001/P01101[1] | Verlofuren (/leaveHours) | employmentCode | [1] In Tim refereren verlofaanvragen naar een afdeling. In Beaufort is dit naar een afdelingslidmaatschap. Dus daarom moeten ook tegelijk de afdelingslidmaatschappen worden geïmporteerd. Hier wordt dan de afdeling uitgehaald. |
| Periode | P01470 | Verlofuren (/leaveHours) | leaveDate | Datum verlof |
| Startduur Eindduur | P01471 | Verlofuren (/leaveHours) | leaveHours | Uren verlof * Afhankelijk van periode van de aanvraag * Wordt niet gebruikt bij open einde |
| Deel van werkdag (vaste waarde Begin van de dag) | ||||
| Aanvraagtype (vaste waarde Duur) | ||||
| Roostercategorie | P01465 | Verlofuren (/leaveHours) | leaveType | Code verlofsoort |
Ziekte-aanvragen (Ziekmeldingen)
Ziekmeldingen die in Beaufort zijn verwerkt worden in Tim getoond in de kalender van de medewerker. Dit is terug te zien in o.a. Mijn Tim, in het bezettingsoverzicht en de Outlook agenda als er gebruik gemaakt wordt van de agenda-koppeling.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | Ziekteverzuim (/sickLeaves) | periodId | ||
| Persoon | P01001 | Ziekteverzuim (/sickLeaves) | personCode | |
| Afdeling | P01001/P01101[1] | Ziekteverzuim (/sickLeaves) | employmentCode | [1] In Tim refereren ziekteaanvragen naar een afdeling. In Beaufort is dit naar een afdelingslidmaatschap. Dus daarom moeten ook tegelijk de afdelingslidmaatschappen worden geïmporteerd. Hier wordt dan de afdeling uitgehaald. |
| Periode (startdatum) | P01600 | Ziekteverzuim (/sickLeaves) | startDate | Datum eerste ziekte-dag |
| Periode (einddatum) | P01606 | Ziekteverzuim (/sickLeaves) | recoveryDate | Datum herstel |
| Periode (startdatum) | P01640 | Ziekteverzuim (/sickLeaves) | periodStartDate | Ziektetijdvak vanaf |
| Startpercentage Eindpercentage | P01642 | Ziekteverzuim (/sickLeaves) | percentage | |
| Deel van de werkdag (Vaste waarde Begin van de dag) | Deze waardes zorgen ervoor dat de aanvraag aan het begin van de dag wordt gezet. | |||
| Repeteerpatroon (ma t/m zo) | Deze waardes worden gezet zodat het percentage voor de hele aanvraag geldt i.p.v. alleen de eerste of de laatste dag. | |||
| Aanvraagtype (vaste waarde percentage) | Altijd dezelfde waarde | |||
| Roostercategorie | Deze roostercategorie is in te stellen in de instellingen van de koppeling. |
Zwangerschapsverlofaanvragen
Zwangerschapsverlof wat in Beaufort verwerkt is wordt in Tim getoond in de kalender van de medewerker. Dit is terug te zien in o.a. Mijn Tim, in het bezettingsoverzicht en de Outlook agenda als er gebruik gemaakt wordt van de agenda-koppeling.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRM ID | Zwangerschapsverlof (/maternityLeaves) | id | ||
| Persoon | P01001 | Zwangerschapsverlof (/maternityLeaves) | personCode | |
| Afdeling | P01001/P01101[1] | Zwangerschapsverlof (/maternityLeaves) | employmentCode | [1] In Tim refereren zwangerschapsverlofaanvragen naar een afdeling. In Beaufort is dit naar een afdelingslidmaatschap. Met de personCode en employmentCode wordt de afdelingslidmaatschap teruggezocht. Dus daarom moeten ook tegelijk de afdelingslidmaatschappen worden geïmporteerd. |
| Periode (startdatum) | P01600 | Zwangerschapsverlof (/maternityLeaves) | startDate | Datum eerste zwangerschapsverlof-dag |
| Periode (einddatum) | P01606 | Zwangerschapsverlof (/maternityLeaves) | recoveryDate | Datum herstel Als recoveryDate leeg is, dan wordt er een voorlopige uitdatum ingevuld die is afhankelijk van het aantal dagen dat ingevuld is in de instellingen van de koppeling. |
| Aanvraagtype (Vaste waarde duur) | ||||
| Roostercategorie | Deze roostercategorie is in te stellen in de instellingen van de koppeling. |
Roosters
Bij het importeren van roosters worden de roosterregistraties vanuit Beaufort rechtstreeks in Tim geplaatst. Dit is terug te zien via Mijn Tim / Mijn rooster en in het urenbriefje.
De roosterregistraties worden maximaal 1 jaar vooruit getoond.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| Datum | /employmentWorkSchedules | date | ||
| Persoon | P01001 | /employmentWorkSchedules | personCode | |
| Afdeling | P01001/P01101[1] | /employmentWorkSchedules | employmentCode | [1] In Tim refereren roosters naar een afdeling. In Beaufort is dit naar een afdelingslidmaatschap. Met de personCode en employmentCode wordt de afdelingslidmaatschap teruggezocht. Dus daarom moeten ook tegelijk de afdelingslidmaatschappen worden geïmporteerd. |
| Duur | /employmentWorkSchedules | hours |
Werkpatronen
Bij het importeren van de werkpatronen worden deze op het criterium van de medewerker geplaatst, zie hiervoor het Criterium > Tabblad werkpatroon. Daarna kan in Tim het rooster gegenereerd worden.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| Persoon | P01001 | /workPatterns | personCode | |
| Afdeling | P01001/P01101[1] | /workPatterns | employmentCode | [1] In Tim refereren werkpatronen naar een afdeling. In Beaufort is dit naar een afdelingslidmaatschap. Met de personCode en employmentCode wordt de afdelingslidmaatschap teruggezocht. Dus daarom moeten ook tegelijk de afdelingslidmaatschappen worden geïmporteerd. |
| Periode (startdatum) | /workPatterns | startDate | ||
| Werkpatroon | /workPatterns | patterndayhours | Er kunnen patronen tot twee weken overgenomen worden. Day is 1 t/m 7 * Maandag is altijd nummer 1. |
Werknemertypen
Met werknemertypen kunnen o.a. verschillende soorten dienstverbanden worden weergegeven. De lijst van werknemertypen is terug te vinden via Management > Overig > Werknemertypen. Werknemertypen worden gekoppeld op het afdelingslidmaatschap van de medewerker.
| Functioneel veld Tim | Rubriekcode Beaufort | Endpoint | Veld API | Opmerkingen |
| HRMID | P01102 | /Employments | employmentType | |
| Naam | /Employments | employmentTypeName | In Beaufort kunnen er meerdere “employmenttypes” met dezelfde naam zijn. In Tim moet de naam uniek zijn, om die reden wordt de code ook in de naam getoond. |