--- title: "List of employments with additional entities" method: GET path: "/v2/providers/employers/{employerId}/employees/employments/comprehensive" tags: ["Employment"] --- # List of employments with additional entities `GET /v2/providers/employers/{employerId}/employees/employments/comprehensive` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/{employerId}/employees/employments/comprehensive` - Auth: none required __Activity name :__ GetEmploymentsComprehensiveByEmployerId __Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties Get a list of employments for an employer. With this version we introduced the "Comprehensive" resource which contains additional entities. This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination. ## Path parameters - `employerId` string, uuid, required ## Query parameters - `referenceDate` string, date - `removeEmptyLines` boolean - `includeHistoricAndFutureData` boolean - `filter` string - `orderBy` string - `pageNumber` integer - `pageSize` integer ## Headers - `Authorization` string, required - `Accept` string, required ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `totalSize` integer: Total number of records, taking into account the given filter. - `pageSize` integer: Number of records in the response - `totalPages` integer: Number of pages available - `currentPage` integer: Current page returned in the response - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `_embedded` EmploymentComprehensiveResponse20191216[] - `employee` Employee20210329 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employeeNumber` integer: The employee number to uniquely identify an employee within an employer - `personalDetails` PersonalDetails - `firstName` string, nullable: The first name, given name, forename or Christian name as part of a persons personal name. - `lastName` string: The last name, family name or surname as part of a persons personal name. - `prefix` string, nullable: The prefix to the last name - `initials` string: The initials - `lastNamePartner` string, nullable: The last name of the employee's partner. - `prefixPartner` string, nullable: The prefix to the last name of the employee's partner. - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName` - `dateOfBirth` string, date: The date of birth - `placeOfBirth` string, nullable: The place of birth - `dateOfDeath` string, date, nullable: The date of death - `aowDate` string, date: The date when, according to Dutch law, the person has the right to a state pension. The value is generated by the system based on the date of birth. - `photo` string, url, nullable: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `howToFormatLastName` HowToFormatLastName: Indicates how the system will format the last name. - `key` integer - `value` string - `title` Title, nullable: The title to be used (if any). - `key` integer - `value` string - `nationality` object, nullable - `key` integer: The key for the nationality. Possible values can be aquired via the metadata endpoint - `value` string: Description of the nationality - `gender` Gender: The gender - `key` integer - `value` string - `civilStatus` object, nullable: The civil/marital status of the employee - `key` integer - `value` string - `contactInformation` ContactInformation20210329 - `phoneNumber` string, nullable: The phone number of the employee. - `mobilePhoneNumber` string, nullable: The mobile phone number of the employee. - `faxNumber` string, nullable: The fax number to contact this individual - `emailAddress` string, nullable: The e-mail address of the employee. - `businessPhoneNumber` string, nullable: The business phone number of the employee. - `businessMobilePhoneNumber` string, nullable: The business mobile phone number of the employee. - `businessEmailAddress` string, nullable: The business e-mail address of the employee. - `identityDocument` IdentityDocument, nullable - `typeOfDocument` object - `key` integer: The key for the type of document. Possible values can be aquired via the metadata endpoint - `value` string: Description of the type of document - `documentIdentification` string - `travel` Travel - `travelDistanceToWork` integer, nullable: The one way distance in meters the employee has to travel to work. - `travelDistanceToWorkInKm` number, double, nullable: The one way distance in kilometers the employee has to travel to work. - `address` Address3, nullable - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication ('nadere aanduiding'). Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication ('nadere aanduiding'), the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `deviatingPostalAddress` DeviatingPostalAddress2, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `exclusionFromAbsenceStatus` boolean: Indicates whether the employee is excluded for any information of absence - `statusEmployeeSelfService` StatusEmployeeSelfService, nullable: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint - `key` integer - `value` string - `revokeEmployeeSelfServiceAccessOn` string, date, nullable: The date on which the Employee will be automatically blocked. - `employment` Employment20191216 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this employment starts. NL: DatumInDienst - `historicalStartDate` string, date, nullable: The historical date on which the employee was first employed. This field is used when an employee has multiple employments in time. In most cases this field should be used as the date on which the employee started working for the company. NL: HistorischeDatumInDienst - `commissionUntilDate` string, date, nullable: The date on which the employment will end. NL: AanstellingTot - `endDate` string, date, nullable: The date on which the employment ends. NL: DatumUitDienst - `endOfEmploymentReason` EndOfEmploymentReason2, nullable: The reason for the end of the employment. NL: RedenEindeDienstverband __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. Please set this field to 8 (Others) unless one of the following integrations is used for this employment * UPA-pensioenaangifte * Cordares * APG-pensioenaangifte * Achmea - `key` integer: The key for the reason for the end of the employment. - `value` string: The description of the reason for the end of the employment. - `endOfEmploymentReasonTaxAuthorities` EndOfEmploymentReasonTaxAuthorities2, nullable: The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still. - `key` integer: The key for the reason for the end of the employment. - `value` string: The description of the reason for the end of the employment. - `endOfEmploymentDueToIllness` boolean, nullable: Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst - `firstDayNotification` boolean, nullable: Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding - `payrollAdministration` PayrollAdministration20191216, nullable: Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time) `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the payroll administration - `clientNumber` integer: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `description` string: Description of the administration - `nonPayrollAdministration` NonPayrollAdministration20191216, nullable: Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time) `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the non payroll administration - `description` string: Description of the administration - `administration` Administration20240626, nullable: Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time) `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the payroll administration - `clientNumber` integer, nullable: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `description` string: Description of the administration - `administrationType` 'payrollAdministration' | 'nonPayrollAdministration': The type of administration - `typeOfEmployee` TypeOfEmployee: A selection of pre defined employee-types for the employment. NL: SoortWerknemer - `key` integer - `value` string - `employmentCategoryType` EmploymentCategoryType: A selection of special pre defined employment-types for the employment. NL: Type dienstverband - `key` integer - `value` string - `linkedEmployment` string, uuid, nullable: The unique identifier of an object (GUID/UUID) - `employmentDurationType` EmploymentDurationTypeVerion20191216: A selection of pre defined durations for the employment. NL: SoortDienstverband - `key` integer - `value` string - `startDateContractOfIndefiniteDuration` string, date, nullable: When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start. - `employmentContractType` EmploymentContractType, nullable: The type of employment applicable for the employment. NL: BasisDienstverband - `key` integer - `value` string - `vacationCoupons` VacationCoupons, nullable: Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s. NL: Vakantiebonnen - `key` integer - `value` string - `sendToExternalParty` SendToExternalParty, nullable: Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij - `key` integer - `value` string - `deviatingCLAExternalParty` integer, nullable: CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend - `deviatingCLATaxReturn` integer, nullable: CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV - `incomeRelationshipNumber` integer: The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment. NL: NummerInkomstenVerhouding - `employeeProfileId` EmployeeProfileId, nullable: References to an employeeprofile that is specified in the payroll administration level. NL: WerknemerProfielID `employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `value` string - `professionCode` integer, nullable: A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV - `exemptionWorkRelatedExpenseScheme` boolean: Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting - `exemptionPremiumWaiverMarginalLabour` boolean: Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid - `typeOfParticipation` TypeOfParticipation, nullable: The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension (product required). NL: AardDeelnemerschap - `key` integer - `value` string - `valueOfParticipation` ValueOfParticipation, nullable: The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension (product required). NL: WaardeDeelnemerschap - `key` integer - `value` string - `wachtgeldOldRegulation` boolean: Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling - `participation55plusRegulationUWV` boolean: Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus - `essMutationSet` EssMutationSet: References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. - `key` integer - `value` string - `exemptionInsuranceObligation` ExemptionInsuranceObligation: Indicates whether an exemption applies for the insurance obligation. If NULL than there is no exemption, thus insurance obligation applies in that case (verzekingsplicht). NL: CodeUitzondering - `key` integer - `value` string - `specialIncomeRatio` SpecialIncomeRatio, nullable: Indicates the special income ratio. NL: SpecialeInkomstenVerhouding - `key` integer - `value` string - `emailLeaveRequest` string, nullable: Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag - `temporaryTaxExemption` TemporaryTaxExemption: Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting - `key` integer - `value` string - `periodPayGradeAdjustment` integer, nullable: The values is used for two processes. First off, a message can be configured to notify the user(s) of a upcoming wage raise/negotiation based on the value of this field. Second, the value, in combination with `signalSalaryScaleAdjustment`, is used to signal a wage raises based on the `payScale` and ‘payGrade’. NL: PeriodeSalarisPeriodiek - `signalPayGradeAdjustment` boolean: Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren - `commissionUntilDate1` string, date, nullable: Until date for commision #1. NL: AanstellingTot1 - `commissionUntilDate2` string, date, nullable: Until date for commision #2. NL: AanstellingTot2 - `commissionUntilDate3` string, date, nullable: Until date for commision #3. NL: AanstellingTot3 - `commissionUntilDate4` string, date, nullable: Until date for commision #4. NL: AanstellingTot4 - `commissionUntilDate5` string, date, nullable: Until date for commision #5. NL: AanstellingTot5 - `commissionUntilDate6` string, date, nullable: Until date for commision #6. NL: AanstellingTot6 - `isDirectorAndMajorShareholder` boolean, nullable: Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder - `isPreviousOwner` boolean, nullable: Indicates whether the employment can be classified as a previous owner. This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsVorigeEigenaar - `isFamilyOfOwner` boolean, nullable: Indicates whether the employment can be classified as a previous owner. This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsFamilieVanEigenaar - `isOnCallEmployment` boolean: Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht - `hasOnCallAppearanceObligation` boolean, nullable: In the case of an on-call employment this field indicates whether the employment has an appearance obligation. This field can be `null` in cases where it is unknown whether the employment has an appearance obligation. NL: SoortOproepkrachtOfInvalkracht - `isGemoedsbezwaardNationalInsurance` boolean: Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering - `isGemoedsbezwaardEmployeeInsurance` boolean: Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering - `isAnonymousEmployee` boolean: An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer - `cancellationPeriodEmployee` integer, nullable: The notice period an employee is required to give the employer when resigning. The unit of time that applies to this field is described in the noticePeriodTimeUnit property. NL: OpzegtermijnWerknemer - `cancellationPeriodEmployer` integer, nullable: The notice period an employer is required to give the employee when terminating the contract. The unit of time that applies to this field is described in the noticePeriodTimeUnit property. NL: OpzegtermijnWerkgever - `cancellationPeriodTimeUnit` CancellationPeriodTimeUnit, nullable: The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties. NL: PeriodeOpzegTermijn - `key` integer - `value` string - `cancellationNoticeDate` string, date, nullable: The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging - `startCancellationNoticePeriod` string, date, nullable: The date on which the term of notice period starts. If the agrement states that a notice periode always starts on the first day of the month and the notice was given on the 15th the start notice periode will be the first day of the next month. NL: AanvangOpzegtermijn - `payrollId` integer: The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning - `namePayslip` string, nullable: Name that is visible on payslips for the employment. NL: NaamLoonstrook - `calculateWorkingHours` boolean: Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren - `writtenEmploymentContract` boolean: Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst - `workinghours` Workinghours - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: Start date of the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `shift` object: The shift determines the full-time hours and bonus percentage. `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `shiftNumber` integer: The number for the shift. - `fullTimeHoursPerWeek` number: The full time hours for an employment that is linked to this shift. - `bonusPercentage` number: The bonus percentage used in wage calculations for the hours made in this shift. - `deviatingHoursPerWeek` number, double, nullable: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week. - `averageHoursPerWeek` number, double, nullable: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces. - `deviatingSvDaysPerPeriod` integer, nullable: Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. - `averageParttimeFactor` number, double, nullable: This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used. - `regularWorkPattern` boolean: When the employee works the same amount of hours per day every week, then the workpattern is regular. - `shiftRateSickLeave` object: The shift determines the full-time hours and bonus percentage. `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `shiftNumber` integer: The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte). - `fullTimeHoursPerWeek` number: The full time hours for an employment that is linked to this shift. - `bonusPercentage` number: The bonus percentage used in wage calculations for the hours made in this shift. - `flexibleHoursContract` object, nullable: The field indicates the type of flexible contract. If not applicable, please set to NULL. - `key` integer - `value` string - `workPattern` object, nullable: The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day. - `oddWeeks` object - `monday` number, double - `tuesday` number, double - `wednesday` number, double - `thursday` number, double - `friday` number, double - `saturday` number, double - `sunday` number, double - `evenWeeks` object - `monday` number, double - `tuesday` number, double - `wednesday` number, double - `thursday` number, double - `friday` number, double - `saturday` number, double - `sunday` number, double - `calculateUsingWorkPattern` object: Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern` - `leaveHours` boolean: Indicates whether then leave balances (verlof) are to be calculated based on the workpattern. If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used - `hoursBrokenPeriod` boolean: Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service. - `hoursRegularPeriod` boolean: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. - `daysDailyRate` boolean: Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours. - `deviatingDaysAndHours` boolean: Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)! - `contractCode` object, nullable: This field is specialy made for convenience stores. The field is the type of contract. `contractCode` is a metadata field within the employer context. Possible values can be managed by the user. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `code` integer - `description` string - `aggregatedHoursPerWeek` number, double, nullable: This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable. This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI. - `organizationalEntity` OrganizationalEntity2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `function` object: The function of the employment. `function` is a metadata field within the employer context. Possible values can be managed by the user. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `description` string - `group` string, nullable - `deviatingFunctionGroup` string, nullable: The deviating function group description of the employment. Only applies when a deviating function description is defined. - `deviatingFunctionDescription` string, nullable: The deviating function description of the employment. This description deviates from the value of the `function` field. - `standardFunction` object, nullable: The standard (cao)function of the employment. `standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `value` string - `code` string, nullable - `category` integer, nullable - `department` object: The department of the employment. `department` is a metadata field within the employer context. Possible values can be managed by the user. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `code` integer - `description` string - `distributionUnit` object: Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center. `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `code` integer - `description` string - `placeOfEmployment` string, nullable: The standard working location (standplaats) for the employment. - `internalTelephoneExtensionNumber` string, nullable: The phone number of the standard working location (standplaats) for the employment. - `wage` Wage2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. __Note__ It is possible to have no wage record. - `endDate` string, date, nullable: The end date for the information in the record. - `payrollPeriodType` object: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored. - `key` integer - `value` string - `grossWage` number, double, nullable: The gross wage for the employee - `grossWageType` object, nullable: Indicates whether the `grossWage` is an hourly wage or a Periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType. - `key` integer - `value` string - `isGrossWageFullTime` boolean: Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored. - `netWage` number, double, nullable: Net wage for the employment - `netWageType` object, nullable: Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource. - `key` integer - `value` string - `employerCosts` number, double, nullable: The cost for the employer for this employee. - `employerCostsType` object, nullable: Indicates whether the employer costs are hourly costs or periodic costs. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource. - `key` integer - `value` string - `payScale` object, nullable: A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee's level, rank or status within the employer's organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit. `payScale` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `value` string - `payGrade` object, nullable: The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user. - `key` integer - `value` string - `applyPayGrade` boolean, nullable: Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. - `socialSecurityBenefits` SocialSecurityBenefitsPostGet[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year. A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `supplementation` object - `type` object: Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage. - `key` integer - `value` string - `percentage` number, double: If supplementation is applied then the supplementation percentage (up to) is registered here. - `benefit` BenefitPostGet - `type` object: The type of social security benefit that is applicable. Per type of benefit a so-called closed-chain input validation is used. This field cannot be changed after the initial post. - `key` integer - `value` string - `percentage` number, double: Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0). - `socialSecurityConfiguration` SocialSecurity2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `isInsuredForSicknessBenefitsAct` boolean: Will contributions for the Sickness Benefits Act (ZW) be payed for this employment - `isInsuredForUnemploymentInsuranceAct` boolean: Will contributions for the Unemployment Insurance Act (WW) be payed for this employment - `isInsuredForOccupationalDisabilityInsuranceAct` boolean: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment - `deviatingAwfContribution` DeviatingAwfcontributions - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startPeriod` StartPeriod - `year` integer: The year of the first payroll period for which the record is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `endPeriod` EndPeriod, nullable - `year` integer: The year of the last payroll period for which the record is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `typeOfDeviatingAwfContribution` object - `key` integer: The type of deviating Deviating AWF contribution to be applied for this employment. - `value` string: Description of the nationality - `citizenServiceNumber` CitizenServiceNumber2 - `citizenServiceNumber` string, nullable: The social security number of the employee used in communication with the Dutch tax authorities. The number has to be a valid Dutch citizen service number (BSN). - `statusEmployeeSelfService` EssAccessWithoutEmployee - `hasTwoFactorAuthentication` boolean: Does the employee have two factor authentication enabled - `status` 'HasAccessToClient' | 'NoAccessToClient' | 'UserIsBlocked' | 'AccessToClientIsBlocked' | 'InvitePending' | 'InviteFailed' | 'InviteCancelled' | 'InviteExpired': Description of the status - `employmentCustomFields` EmploymentCustomField[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `customField` object: The custom field as defined at the employer-level. The value can only be set in the POST (it cannot be changed with a PUT). - `id` string, uuid: The unique identifier of the custom field as defined at the employer level - `description` string - `value` string: The value for the custom field for the employment - `employeeCustomFields` EmployeeCustomField[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `customField` object: The custom field as defined at the employer-level. The value can only be set in the POST (it cannot be changed with a PUT). - `id` string, uuid: The unique identifier of the custom field as defined at the employer level - `description` string - `value` string: The value for the custom field for the employee - `paymentInformationSepa` Paymentinformationsepa20180101[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `payrollComponent` object: The payroll component for which the outgoing payment records applies. `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `value` string - `iban` string: International Bank Account Number (IBAN). Only IBAN without spaces are accepted. - `bic` string, nullable: BIC /SWIFT code. Only applicable for a non-Dutch IBAN - `visibleOnPayslip` boolean: Indicates whether the payment-component is visible on a payslip. - `nameBeneficiary` string, nullable: Name of beneficiary. - `cityBeneficiary` string, nullable: City name of beneficiary. - `description1` string, nullable: Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. - `description2` string, nullable: Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. - `fiscalProperties` Fiscal2, nullable - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `annualSalary` number, double: The fiscal annual salary. NL: Fiscaal jaarloon - `deviatingTaxTableCode` DeviatingTaxTableCode, nullable: Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel - `key` integer - `value` string - `deviatingPayrollTaxTableColour` DeviatingPayrollTaxTableColour: Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel - `key` integer - `value` string - `applyDayTables` boolean, nullable: Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen - `deviatingPayrollTaxPercentage` number, double, nullable: Indicates the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage - `applyDeviatingPayrollTaxPercentageOn` ApplyDeviatingPayrollTaxPercentageOn: Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen - `key` integer - `value` string - `applyPayrollTaxDeduction` boolean: Indicates whether payroll tax deduction is appliclable (loonheffingskorting). NL: ArbeidskortingToepassen - `applyStudentDeduction` boolean, nullable: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen - `residentOf` ResidentOf: Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan - `key` integer - `value` string: Description of the type of document - `applySalarysplit` ApplySalarysplit: Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. - `key` unknown - `value` string: Description of the type of document - `percentageForeignIncome` number, double, nullable: Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen - `deviatingCalculationRulePayrollTax` DeviatingCalculationRulePayrollTax: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel - `key` integer - `value` string - `thirtyPercentFacility` ThirtyPercentFacility, nullable: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling). - `key` integer - `value` string - `deviatingPercentageThirtyPercentFacility` number, double, nullable: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling) - `doesWageIncludeAow` boolean: Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering - `doesWageIncludeWajong` boolean: Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong - `hasEmployeeLoan` boolean: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations. - `usesTransportByWithholdingAgent` boolean: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee. - `deviatingSmallJobsArrangement` boolean, nullable: Kleine banenregeling - `contributionReductionEducation` ContributionReductionEducation, nullable: Afdr. verm. onderwijs - `key` unknown - `value` string: Description of the type of education - `specialIndication` SpecialIndication: Indications This field is no longer used sinds 2005 - `one` integer, nullable: Speciale aanduiding 1 - `two` integer, nullable: Speciale aanduiding 2 - `three` integer, nullable: Speciale aanduiding 3 - `four` integer, nullable: Speciale aanduiding 4 - `applySingleElderlyTaxDeduction` boolean: Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong - `healthcareInsuranceActConfiguration` HealthcareInsuranceActConfiguration - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `healthcareInsuranceActType` object: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment - `key` integer - `value` string - `additionalContributionEmployer` number, double, nullable: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet). - `nominalPremium` number, double, nullable: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable. - `additionalPremium` number, double, nullable: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable. - `benefitsInKind` BenefitInKind[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this BenefitInKind starts. So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `benefitInKindType` object: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `description` string - `brand` string, nullable: The brand of the benefit in kind. - `type` string, nullable: The type of the benefit in kind. - `value` number: The value for the selected benefit of kind. - `supplier` string, nullable: The supplier of the benefit in kind. - `particularities` string, nullable: Extra information about the benefit in kind - `companyCars` CompanyCar[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `brand` string, nullable: Brand of the vehicle. - `model` string, nullable: Model of the vehicle. - `licensePlateNumber` string: Vehicle registration number (license plate) of the company car. The number should be provided with or without any hyphens (-). - `fuelCardNumber` string, nullable: Registration number of the fuel card. - `leaseOrBuy` object: Indication of the ownership of the company car. - `key` integer - `value` string - `supplier` string, nullable: Name of the company the delivered the company car. - `lease` object, nullable: Details of the leasecontract - `startDate` string, date, nullable: The start date of the entity. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `contractNumber` string, nullable: Registration number of the lease contract. - `catalogValue` number, double, nullable: The catalog value of the car. - `kilometersPrivateUse` integer, nullable: The number kilometers per year the employee can use the car for private purposes. - `comments` string, nullable: Any comments on the car or the contract. - `fiscalCompanyCars` FiscalCompanyCar[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The start date of the entity. A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `licensePlateNumber` string, nullable: Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-). - `dateOfFirstAdmission` string, date, nullable: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint. - `valueForTaxPurposes` number, double, nullable: The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided. It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint. - `additionalTaxLiabilityGroup` object: Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process. It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint. - `key` integer - `value` string - `reasonForNoAdditionalTaxLiability` object, nullable: In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return. - `key` integer - `value` string - `deviatingAdditionalTaxLiability` number, double, nullable: Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount. - `taxableBenefitForPrivateUse` number, double, nullable: Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process. - `journalAllocation` JournalAllocationObject - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `journalProfileConfiguration` object: Indicates to which journal profiel configuration the record relates - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startPeriod` object - `year` integer: The year of the first payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `endPeriod` object, nullable - `year` integer: The year of the first payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `journalProfile` object - `key` integer - `value` string - `startPeriod` object - `year` integer: The year of the first payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `endPeriod` object, nullable - `year` integer: The year of the last payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `allocationBasedOnActualHours` object, nullable: Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource. So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData, make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!). Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided. - `costCenter` CostCenterAllocationObject: The applicable cost center (=kostenplaats). `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `costUnit` CostUnitAllocationObject, nullable: The applicable cost center (=kostendrager). `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `allocationBasedOnFixedWeights` object[], nullable: Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case. Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. - `costCenter` CostCenterAllocationObject: The applicable cost center (=kostenplaats). `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `costUnit` CostUnitAllocationObject, nullable: The applicable cost center (=kostendrager). `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `weight` integer: The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit. - `basesForCalculation` BasesForCalculationGetPost[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this base starts. A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource. So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `deviations` object, nullable: Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. Set `deviations` to null if no deviations apply. Deviating is done on either all the fields or none. - `percentage` number, double: Deviation from the percentage - `reservationPercentage` number, double: deviation from the reservation percentage - `financialReservationPercentage` number, double: deviation from the financial reservation percentage - `ageBasedMinimum` object: This fields indicates how the age based minimum is applied - `key` integer: The number for the ageBasedMinimum - `value` string: The description of the ageBasedMinimum - `ageBasedMaximum` object: This fields indicates how the age based maximum is applied - `key` integer: The number for the ageBasedMaximum - `value` string: The description of the ageBasedMaximum - `base` object: `base` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer: The number for the base - `value` string: The description of the base - `otherPayrollVariables` OtherPayrollVariables2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this record starts. A (broken chain)[./#section/Data/Date-chains] is maintained with this record. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `productivityPercentage` number, double: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment. - `payrollProperties` object - `deviatingPremiumGroup` object, nullable: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to the employment. Do not specify if there is no deviation from the premium group for the payroll administration the employment is linked to. - `key` integer - `value` string - `wageCostBenefit` object, nullable: Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden. - `key` integer - `value` string - `wajongWithWageDispensation` boolean: wajongWithDispensation (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment. - `phaseClassification` object, nullable: Phase classification (Fase indeling) Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid. - `key` integer - `value` string - `incidentalIncomeDeduction` object, nullable: Incidental income deduction (Incidentele inkomstenvermindering) Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan Loket niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering. In deze rubriek dient dan de juiste waarde ingevuld te worden - `key` integer - `value` string - `terminateIncomenumberFlexibleEmployment` object, nullable: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) - `key` integer - `value` string - `applyMinimumWageVocationalLearningPathway` boolean: Minimum wage vocational learning pathway (Minimumloon BBL) - `occupationalDisabilityPremiumDiscount` object, nullable: Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment. Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert Loket als code 5. - `key` integer - `value` string - `occupationalDisabilityDeductionAfter2009` number, double, nullable: (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting - `occupationalDisabilityDeductionTo2009` number, double, nullable: (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO)) Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting - `collectiveLaborAgreementCodeHiringEmployer` object, nullable: "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party". For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019" - `key` integer - `value` string - `startDate` string, date: The start date of the CAO - `endDate` string, date, nullable: The end date of the CAO - `applyYearlyHoursNorm` boolean: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period. - `pensionProperties` object - `annualCalculationBaseAbp` number, double, nullable: annualCalculationBase (jaargrondslag voor ABP) for ABP. As of 1-1-2026, this field will no longer be used and must be filled with 0. - `leaveAbp` object, nullable: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value - `leaveType` object: Leave type (Verlofsoort ABP) for ABP. - `key` integer - `value` string - `valueOfParticipationDuringLeave` integer: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP) - `deviatingDisabilityInsuranceActPercentageForCordares` object, nullable: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. - `key` integer - `value` string - `applyDispensationRiskFund` boolean: applyDispensationRiskFund (Disp. risicofonds) - `compulsoryEducationDays` integer, nullable: compulsoryEducationDays (Aantal dagen leerplicht) - `occupationalPensionFund` integer, nullable: Occupational Pension Fund (BPF-code) - `specificationOfIncomeRelationshipApg` object, nullable: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. - `key` integer - `value` string - `code` string - `insuranceProperties` object - `applicableForNoRiskPolicy` boolean: Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV. Please check with the UWV to determine when to set the value to true. - `paymentinformationNonSepa` PaymentInformationNonSepa[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `payrollComponent` object: The payroll component for which the outgoing payment records applies. Each payroll component can only be used once per employment. `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer: The number for the payroll component - `value` string: The description of the payroll component - `bankAccountNumber` string: The bank account number - `beneficiary` object: Information regarding the beneficiary coresponding with the bank account number - `name` string: Name of the beneficiary - `city` string: City name of beneficiary - `address` string: Address of beneficiary - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `bank` object: Information regarding the bank coresponding with the bank account number - `bankIdentifierCode` string: BIC /SWIFT code for the bank - `name` string: Name of benificiary bank - `city` string: City name of beneficiary bank - `address` string: Address of beneficiary bank - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `basesForEmploymentFundCalculation` BasesForEmploymentFundCalculationBaseObject[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this base for calculation starts. A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `origin` object: Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists. - `key` integer: The number for the origin - `value` string: The description of the origin - `base` number, double: The base (amount of money) to be used in the fund calculation - `pensionBenefits` PensionBenefits - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this pension benefit starts A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `payout` number, double: The ammount of (gross) pension received - `deviatingHourlyWages` DeviatingHourlyWages[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this DeviatingHouryWage starts. A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time. - `endDate` string, date, nullable: The end date of the entity. The date is up to and including. - `payrollComponent` PayrollComponent2: A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment. `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer: The number for the payroll component. - `description` string: The description of the payroll component - `value` number: The value for the selected payroll component. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)