EmploymentsComprehensiveByEmployerId__embeddedBenefitsInKind

employerId

guid

☑

The unique identifier of the employer

referenceDate

datetime

☐

Set a reference date for choosing the date dependent data.

removeEmptyLines

boolean

☐

When true and combined with a X-ReportInput header, the output only contains employments for which selected underlying data, such as wage, is available.

benefitInKindType_description

string

☐

benefitInKindType_id

guid

☐

The unique identifier of an object (GUID/UUID)

brand

string(30)

☐

The brand of the benefit in kind.

calculateWorkingHours

boolean

Werkuren Berekenen

☐

Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren

cancellationNoticeDate

datetime

Annuleringsdatum

☐

The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging

cancellationPeriodEmployee

int32

Annuleringsverklaring voor Werknemer

☐

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

int32

Annuleringsverklaring voor Werkgever

☐

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_key

int32

☐

cancellationPeriodTimeUnit_value

string

☐

citizenServiceNumber_citizenServiceNumber

string(9)

☐

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).

commissionUntilDate

datetime

☐

The date on which the employment will end. NL: AanstellingTot

commissionUntilDate1

datetime

☐

Until date for commision #1. NL: AanstellingTot1

commissionUntilDate2

datetime

☐

Until date for commision #2. NL: AanstellingTot2

commissionUntilDate3

datetime

☐

Until date for commision #3. NL: AanstellingTot3

commissionUntilDate4

datetime

☐

Until date for commision #4. NL: AanstellingTot4

commissionUntilDate5

datetime

☐

Until date for commision #5. NL: AanstellingTot5

commissionUntilDate6

datetime

☐

Until date for commision #6. NL: AanstellingTot6

deviatingAwfContribution_endPeriod_periodEndDate

datetime

☐

The last day of the payroll period.

deviatingAwfContribution_endPeriod_periodNumber

int32

☐

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.

deviatingAwfContribution_endPeriod_periodStartDate

datetime

☐

The first day of the payroll period.

deviatingAwfContribution_endPeriod_year

int32

☐

The year of the last payroll period for which the record is applicable.

deviatingAwfContribution_id

guid

☐

The unique identifier of an object (GUID/UUID)

deviatingAwfContribution_startPeriod_periodEndDate

datetime

☐

The last day of the payroll period.

deviatingAwfContribution_startPeriod_periodNumber

int32

☐

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.

deviatingAwfContribution_startPeriod_periodStartDate

datetime

☐

The first day of the payroll period.

deviatingAwfContribution_startPeriod_year

int32

☐

The year of the first payroll period for which the record is applicable.

deviatingAwfContribution_typeOfDeviatingAwfContribution_key

int32

☐

The type of deviating Deviating AWF contribution to be applied for this employment.

deviatingAwfContribution_typeOfDeviatingAwfContribution_value

string(50)

☐

Description of the nationality

deviatingCLAExternalParty

int32

☐

CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend

deviatingCLATaxReturn

int32

☐

CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV

emailLeaveRequest

string(255)

E-mailadres voor Verlofaanvragen

☐

Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag

employee_address_city

string(24)

☐

City of the address

employee_address_country_isoCode

string(2)

☐

The ISO 3166-1 alpha-2 value for the country

employee_address_country_key

int32

☐

The key for the country. Possible values can be aquired via the metadata endpoint

employee_address_country_value

string(50)

☐

The name of the country

employee_address_furtherIndication_key

int32

☐

The key of the further indication ('nadere aanduiding'). Possible values can be aquired via the metadata endpoint

employee_address_furtherIndication_value

string

☐

The description of the further indication ('nadere aanduiding'), the possible values are "WW" and "AB"

employee_address_houseNumber

int32

☐

House number of the address

employee_address_houseNumberAddition

string(4)

☐

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.

employee_address_location

string(35)

☐

The location like to further specify the address

employee_address_postalCode

string(9)

☐

The postal code of the address, only nullable if country is not The Netherlands (NL).

employee_address_street

string(24)

☐

Streetname of the address

employee_contactInformation_businessEmailAddress

string(255)

☐

The business e-mail address of the employee.

employee_contactInformation_businessMobilePhoneNumber

string(15)

☐

The business mobile phone number of the employee.

employee_contactInformation_businessPhoneNumber

string(15)

☐

The business phone number of the employee.

employee_contactInformation_emailAddress

string(255)

☐

The e-mail address of the employee.

employee_contactInformation_faxNumber

string(15)

☐

The fax number to contact this individual

employee_contactInformation_mobilePhoneNumber

string(15)

☐

The mobile phone number of the employee.

employee_contactInformation_phoneNumber

string(15)

☐

Het telefoonnummer van de werknemer.

employee_deviatingPostalAddress_city

string(24)

☐

City of the address

employee_deviatingPostalAddress_country_isoCode

string(2)

☐

The ISO 3166-1 alpha-2 value for the country

employee_deviatingPostalAddress_country_key

int32

☐

The key for the country. Possible values can be aquired by the metadata endpoint

employee_deviatingPostalAddress_country_value

string(50)

☐

The name of the country

employee_deviatingPostalAddress_furtherIndication_key

int32

☐

The key of the further indication. Possible values can be aquired by the metadata endpoint

employee_deviatingPostalAddress_furtherIndication_value

string

☐

The description of the further indication, the possible values are "WW" and "AB"

employee_deviatingPostalAddress_houseNumber

int32

☐

House number of the address

employee_deviatingPostalAddress_houseNumberAddition

string(4)

☐

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.

employee_deviatingPostalAddress_location

string(35)

☐

The location like to further specify the address

employee_deviatingPostalAddress_postalCode

string(9)

☐

The postal code of the address, only nullable if country is not The Netherlands (NL).

employee_deviatingPostalAddress_street

string(24)

☐

Streetname of the address

employee_employeeNumber

int32

☐

The employee number to uniquely identify an employee within an employer

employee_exclusionFromAbsenceStatus

boolean

☐

Indicates whether the employee is excluded for any information of absence

employee_id

guid

Werknemer ID

☐

The unique identifier of an object (GUID/UUID)

employee_identityDocument_documentIdentification

string

☐

employee_identityDocument_typeOfDocument_key

int32

☐

The key for the type of document. Possible values can be aquired via the metadata endpoint

employee_identityDocument_typeOfDocument_value

string(50)

☐

Description of the type of document

employee_personalDetails_aowDate

datetime

☐

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.

employee_personalDetails_civilStatus_key

int32

☐

employee_personalDetails_civilStatus_value

string(50)

☐

employee_personalDetails_dateOfBirth

datetime

☐

The date of birth

employee_personalDetails_dateOfDeath

datetime

☐

The date of death

employee_personalDetails_firstName

string(28)

☐

The first name, given name, forename or Christian name as part of a persons personal name.

employee_personalDetails_formattedName

string(82)

☐

Formatted name of the employee based on the value of `howToFormatLastName`

employee_personalDetails_gender_key

int32

☐

employee_personalDetails_gender_value

string(50)

☐

employee_personalDetails_howToFormatLastName_key

int32

☐

employee_personalDetails_howToFormatLastName_value

string(50)

☐

employee_personalDetails_initials

string(6)

☐

The initials

employee_personalDetails_lastName

string(25)

☐

The last name, family name or surname as part of a persons personal name.

employee_personalDetails_lastNamePartner

string(25)

☐

The last name of the employee's partner.

employee_personalDetails_nationality_key

int32

☐

The key for the nationality. Possible values can be aquired via the metadata endpoint

employee_personalDetails_nationality_value

string(50)

☐

Description of the nationality

employee_personalDetails_photo

string

☐

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.

employee_personalDetails_placeOfBirth

string(24)

☐

The place of birth

employee_personalDetails_prefix

string(10)

☐

The prefix to the last name

employee_personalDetails_prefixPartner

string(10)

☐

The prefix to the last name of the employee's partner.

employee_personalDetails_title_key

int32

☐

employee_personalDetails_title_value

string(50)

☐

employee_revokeEmployeeSelfServiceAccessOn

datetime

☐

The date on which the Employee will be automatically blocked.

employee_statusEmployeeSelfService_key

int32

☐

employee_statusEmployeeSelfService_value

string(50)

☐

employee_travel_travelDistanceToWork

int32

☐

The one way distance in meters the employee has to travel to work.

employee_travel_travelDistanceToWorkInKm

double

☐

The one way distance in kilometers the employee has to travel to work.

employeeProfileId_key

int32

Werknemersprofiel ID Sleutel

☐

employeeProfileId_value

string

Werknemersprofiel ID Waarde

☐

employmentCategoryType_key

int32

☐

employmentCategoryType_value

string

☐

employmentContractType_key

int32

☐

employmentContractType_value

string

☐

employmentDurationType_key

int32

Dienstverbandduursoortsleutel

☐

employmentDurationType_value

string

Dienstverbandduursoortwaarde

☐

endDate_1

datetime

☐

The end date of the entity. The date is up to and including.

endDate

datetime

Einddatum

☐

The date on which the employment ends. NL: DatumUitDienst

endOfEmploymentDueToIllness

boolean

☐

Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst

endOfEmploymentReason_key

int32

☐

The key for the reason for the end of the employment.

endOfEmploymentReason_value

string

☐

The description of the reason for the end of the employment.

endOfEmploymentReasonTaxAuthorities_key

int32

☐

The key for the reason for the end of the employment.

endOfEmploymentReasonTaxAuthorities_value

string

☐

The description of the reason for the end of the employment.

essMutationSet_key

int32

☐

essMutationSet_value

string

☐

exemptionInsuranceObligation_key

int32

☐

exemptionInsuranceObligation_value

string

☐

exemptionPremiumWaiverMarginalLabour

boolean

☐

Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid

exemptionWorkRelatedExpenseScheme

boolean

☐

Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting

firstDayNotification

boolean

Eerste Dag Melding

☐

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

fiscalProperties_annualSalary

double

☐

The fiscal annual salary. NL: Fiscaal jaarloon

fiscalProperties_applyDayTables

boolean

☐

Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen

fiscalProperties_applyDeviatingPayrollTaxPercentageOn_key

int32

☐

fiscalProperties_applyDeviatingPayrollTaxPercentageOn_value

string(50)

☐

fiscalProperties_applyPayrollTaxDeduction

boolean

☐

Indicates whether payroll tax deduction is appliclable (loonheffingskorting). NL: ArbeidskortingToepassen

fiscalProperties_applySalarysplit_key

int32

☐

fiscalProperties_applySalarysplit_value

string(50)

☐

Description of the type of document

fiscalProperties_applySingleElderlyTaxDeduction

boolean

☐

Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong

fiscalProperties_applyStudentDeduction

boolean

☐

Apply the "Scholierenregeling". NL; ArbeidskortingToepassen

fiscalProperties_contributionReductionEducation_key

int32

☐

fiscalProperties_contributionReductionEducation_value

string(50)

☐

Description of the type of education

fiscalProperties_deviatingCalculationRulePayrollTax_key

int32

☐

fiscalProperties_deviatingCalculationRulePayrollTax_value

string(50)

☐

fiscalProperties_deviatingPayrollTaxPercentage

double

☐

Indicates the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage

fiscalProperties_deviatingPayrollTaxTableColour_key

int32

☐

fiscalProperties_deviatingPayrollTaxTableColour_value

string(50)

☐

fiscalProperties_deviatingPercentageThirtyPercentFacility

double

☐

Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)

fiscalProperties_deviatingSmallJobsArrangement

boolean

☐

Kleine banenregeling

fiscalProperties_deviatingTaxTableCode_key

int32

☐

fiscalProperties_deviatingTaxTableCode_value

string(80)

☐

fiscalProperties_doesWageIncludeAow

boolean

☐

Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering

fiscalProperties_doesWageIncludeWajong

boolean

☐

Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong

fiscalProperties_endDate

datetime

☐

The end date of the entity. The date is up to and including.

fiscalProperties_hasEmployeeLoan

boolean

☐

Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.

fiscalProperties_id

guid

☐

The unique identifier of an object (GUID/UUID)

fiscalProperties_percentageForeignIncome

double

☐

Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen

fiscalProperties_residentOf_key

int32

☐

fiscalProperties_residentOf_value

string(80)

☐

Description of the type of document

fiscalProperties_specialIndication_four

int32

☐

Speciale aanduiding 4

fiscalProperties_specialIndication_one

int32

☐

Speciale aanduiding 1

fiscalProperties_specialIndication_three

int32

☐

Speciale aanduiding 3

fiscalProperties_specialIndication_two

int32

☐

Speciale aanduiding 2

fiscalProperties_startDate

datetime

☐

The start date of the entity.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.

fiscalProperties_thirtyPercentFacility_key

int32

☐

fiscalProperties_thirtyPercentFacility_value

string(50)

☐

fiscalProperties_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.

hasOnCallAppearanceObligation

boolean

☐

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

healthcareInsuranceActConfiguration_additionalContributionEmployer

double

☐

If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).

healthcareInsuranceActConfiguration_additionalPremium

double

☐

Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.

healthcareInsuranceActConfiguration_endDate

datetime

☐

The end date of the entity. The date is up to and including.

healthcareInsuranceActConfiguration_healthcareInsuranceActType_key

int32

☐

healthcareInsuranceActConfiguration_healthcareInsuranceActType_value

string(50)

☐

healthcareInsuranceActConfiguration_id

guid

☐

The unique identifier of an object (GUID/UUID)

healthcareInsuranceActConfiguration_nominalPremium

double

☐

A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.

healthcareInsuranceActConfiguration_startDate

datetime

☐

The start date of the entity.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.

historicalStartDate

datetime

Historische Startdatum

☐

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

id_1

guid

☐

The unique identifier of an object (GUID/UUID)

id

guid

ID

☐

The unique identifier of an object (GUID/UUID)

incomeRelationshipNumber

int32

☐

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

isAnonymousEmployee

boolean

☐

An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer

isDirectorAndMajorShareholder

boolean

☐

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

isFamilyOfOwner

boolean

☐

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

isGemoedsbezwaardEmployeeInsurance

boolean

☐

Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering

isGemoedsbezwaardNationalInsurance

boolean

☐

Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering

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

isPreviousOwner

boolean

☐

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

journalAllocation_allocationBasedOnActualHours_costCenter_code

string

☐

journalAllocation_allocationBasedOnActualHours_costCenter_description

string

☐

journalAllocation_allocationBasedOnActualHours_costCenter_key

int32

☐

journalAllocation_allocationBasedOnActualHours_costUnit_code

string

☐

journalAllocation_allocationBasedOnActualHours_costUnit_description

string

☐

journalAllocation_allocationBasedOnActualHours_costUnit_key

int32

☐

journalAllocation_endPeriod_periodEndDate

datetime

☐

The last day of the payroll period.

journalAllocation_endPeriod_periodNumber

int32

☐

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.

journalAllocation_endPeriod_periodStartDate

datetime

☐

The first day of the payroll period.

journalAllocation_endPeriod_year

int32

☐

The year of the last payroll period for which the journal allocation is applicable.

journalAllocation_id

guid

☐

The unique identifier of an object (GUID/UUID)

journalAllocation_journalProfileConfiguration_endPeriod_periodEndDate

datetime

☐

The last day of the payroll period.

journalAllocation_journalProfileConfiguration_endPeriod_periodNumber

int32

☐

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.

journalAllocation_journalProfileConfiguration_endPeriod_periodStartDate

datetime

☐

The first day of the payroll period.

journalAllocation_journalProfileConfiguration_endPeriod_year

int32

☐

The year of the first payroll period for which the journal allocation is applicable.

journalAllocation_journalProfileConfiguration_id

guid

☐

The unique identifier of an object (GUID/UUID)

journalAllocation_journalProfileConfiguration_journalProfile_key

int32

☐

journalAllocation_journalProfileConfiguration_journalProfile_value

string

☐

journalAllocation_journalProfileConfiguration_startPeriod_periodEndDate

datetime

☐

The last day of the payroll period.

journalAllocation_journalProfileConfiguration_startPeriod_periodNumber

int32

☐

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.

journalAllocation_journalProfileConfiguration_startPeriod_periodStartDate

datetime

☐

The first day of the payroll period.

journalAllocation_journalProfileConfiguration_startPeriod_year

int32

☐

The year of the first payroll period for which the journal allocation is applicable.

journalAllocation_startPeriod_periodEndDate

datetime

☐

The last day of the payroll period.

journalAllocation_startPeriod_periodNumber

int32

☐

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.

journalAllocation_startPeriod_periodStartDate

datetime

☐

The first day of the payroll period.

journalAllocation_startPeriod_year

int32

☐

The year of the first payroll period for which the journal allocation is applicable.

linkedEmployment

guid

☐

The unique identifier of an object (GUID/UUID)

namePayslip

string(34)

Naam op Loonstrook

☐

Name that is visible on payslips for the employment. NL: NaamLoonstrook

nonPayrollAdministration_description

string(50)

☐

Description of the administration

nonPayrollAdministration_id

guid

☐

The unique identifier of an object (GUID/UUID)

nonPayrollAdministration_name

string(70)

☐

Name of the non payroll administration

organizationalEntity_department_code

int32

☐

organizationalEntity_department_description

string

☐

organizationalEntity_department_key

guid

☐

The unique identifier of an object (GUID/UUID)

organizationalEntity_deviatingFunctionDescription

string(50)

☐

The deviating function description of the employment. This description deviates from the value of the `function` field.

organizationalEntity_deviatingFunctionGroup

string(5)

☐

The deviating function group description of the employment. Only applies when a deviating function description is defined.

organizationalEntity_distributionUnit_code

int32

☐

organizationalEntity_distributionUnit_description

string

☐

organizationalEntity_distributionUnit_key

guid

☐

The unique identifier of an object (GUID/UUID)

organizationalEntity_endDate

datetime

☐

The end date of the entity. The date is up to and including.

organizationalEntity_function_description

string(50)

☐

organizationalEntity_function_group

string(5)

☐

organizationalEntity_function_key

guid

☐

The unique identifier of an object (GUID/UUID)

organizationalEntity_id

guid

☐

The unique identifier of an object (GUID/UUID)

organizationalEntity_internalTelephoneExtensionNumber

string(15)

☐

The phone number of the standard working location (standplaats) for the employment.

organizationalEntity_placeOfEmployment

string(24)

☐

The standard working location (standplaats) for the employment.

organizationalEntity_standardFunction_category

int32

☐

organizationalEntity_standardFunction_code

string(6)

☐

organizationalEntity_standardFunction_key

int32

☐

organizationalEntity_standardFunction_value

string

☐

organizationalEntity_startDate

datetime

☐

The start date of the entity.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.

otherPayrollVariables_endDate

datetime

☐

The end date of the entity. The date is up to and including.

otherPayrollVariables_id

guid

☐

The unique identifier of an object (GUID/UUID)

otherPayrollVariables_insuranceProperties_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.

otherPayrollVariables_payrollProperties_applyMinimumWageVocationalLearningPathway

boolean

☐

Minimum wage vocational learning pathway (Minimumloon BBL) <to do>

otherPayrollVariables_payrollProperties_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.

otherPayrollVariables_payrollProperties_collectiveLaborAgreementCodeHiringEmployer_endDate

datetime

☐

The end date of the CAO

otherPayrollVariables_payrollProperties_collectiveLaborAgreementCodeHiringEmployer_key

int32

☐

otherPayrollVariables_payrollProperties_collectiveLaborAgreementCodeHiringEmployer_startDate

datetime

☐

The start date of the CAO

otherPayrollVariables_payrollProperties_collectiveLaborAgreementCodeHiringEmployer_value

string(90)

☐

otherPayrollVariables_payrollProperties_deviatingPremiumGroup_key

int32

☐

otherPayrollVariables_payrollProperties_deviatingPremiumGroup_value

string(50)

☐

otherPayrollVariables_payrollProperties_incidentalIncomeDeduction_key

int32

☐

otherPayrollVariables_payrollProperties_incidentalIncomeDeduction_value

string(50)

☐

otherPayrollVariables_payrollProperties_occupationalDisabilityDeductionAfter2009

double

☐

(OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>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.nl 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

otherPayrollVariables_payrollProperties_occupationalDisabilityDeductionTo2009

double

☐

(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.nl 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

otherPayrollVariables_payrollProperties_occupationalDisabilityPremiumDiscount_key

int32

☐

otherPayrollVariables_payrollProperties_occupationalDisabilityPremiumDiscount_value

string(80)

☐

otherPayrollVariables_payrollProperties_phaseClassification_key

int32

☐

otherPayrollVariables_payrollProperties_phaseClassification_value

string(60)

☐

otherPayrollVariables_payrollProperties_terminateIncomenumberFlexibleEmployment_key

int32

☐

otherPayrollVariables_payrollProperties_terminateIncomenumberFlexibleEmployment_value

string(50)

☐

otherPayrollVariables_payrollProperties_wageCostBenefit_key

int32

☐

otherPayrollVariables_payrollProperties_wageCostBenefit_value

string(50)

☐

otherPayrollVariables_payrollProperties_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.

otherPayrollVariables_pensionProperties_annualCalculationBaseAbp

double

☐

annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>

otherPayrollVariables_pensionProperties_applyDispensationRiskFund

boolean

☐

applyDispensationRiskFund (Disp. risicofonds) <to do>

otherPayrollVariables_pensionProperties_compulsoryEducationDays

int32

☐

compulsoryEducationDays (Aantal dagen leerplicht) <to do>

otherPayrollVariables_pensionProperties_deviatingDisabilityInsuranceActPercentageForCordares_key

int32

☐

otherPayrollVariables_pensionProperties_deviatingDisabilityInsuranceActPercentageForCordares_value

string(50)

☐

otherPayrollVariables_pensionProperties_leaveAbp_leaveType_key

int32

☐

otherPayrollVariables_pensionProperties_leaveAbp_leaveType_value

string(50)

☐

otherPayrollVariables_pensionProperties_leaveAbp_valueOfParticipationDuringLeave

int32

☐

valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)

otherPayrollVariables_pensionProperties_occupationalPensionFund

int32

☐

Occupational Pension Fund (BPF-code) <to do>

otherPayrollVariables_pensionProperties_specificationOfIncomeRelationshipApg_code

string(4)

☐

otherPayrollVariables_pensionProperties_specificationOfIncomeRelationshipApg_key

int32

☐

otherPayrollVariables_pensionProperties_specificationOfIncomeRelationshipApg_value

string(75)

☐

otherPayrollVariables_productivityPercentage

double

☐

productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.

otherPayrollVariables_startDate

datetime

☐

The date on which this record starts.A (broken chain)[./#section/Data/Date-chains] is maintained with this record.

participation55plusRegulationUWV

boolean

☐

Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus

particularities

string(4000)

Bijzonderheden

☐

Extra information about the benefit in kind

payrollAdministration_clientNumber

int32

☐

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.

payrollAdministration_description

string(50)

☐

Description of the administration

payrollAdministration_id

guid

Salarisadministratie ID

☐

The unique identifier of an object (GUID/UUID)

payrollAdministration_name

string(70)

Naam Salarisadministratie

☐

Name of the payroll administration

payrollId

int32

Salarisstrook ID

☐

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

pensionBenefits_endDate

datetime

☐

The end date of the entity. The date is up to and including.

pensionBenefits_id

guid

☐

The unique identifier of an object (GUID/UUID)

pensionBenefits_payout

double

☐

The ammount of (gross) pension received

pensionBenefits_startDate

datetime

☐

The date on which this pension benefit startsA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

periodPayGradeAdjustment

int32

☐

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

professionCode

int32

Beroepscode

☐

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

sendToExternalParty_key

int32

☐

sendToExternalParty_value

string

☐

signalPayGradeAdjustment

boolean

☐

Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren

socialSecurityConfiguration_endDate

datetime

☐

The end date of the entity. The date is up to and including.

socialSecurityConfiguration_id

guid

☐

The unique identifier of an object (GUID/UUID)

socialSecurityConfiguration_isInsuredForOccupationalDisabilityInsuranceAct

boolean

☐

Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment

socialSecurityConfiguration_isInsuredForSicknessBenefitsAct

boolean

☐

Will contributions for the Sickness Benefits Act (ZW) be payed for this employment

socialSecurityConfiguration_isInsuredForUnemploymentInsuranceAct

boolean

☐

Will contributions for the Unemployment Insurance Act (WW) be payed for this employment

socialSecurityConfiguration_startDate

datetime

☐

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.

specialIncomeRatio_key

int32

Sleutel voor Speciale Inkomensverhouding

☐

specialIncomeRatio_value

string

Speciale Inkomensverhouding

☐

startCancellationNoticePeriod

datetime

☐

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

startDate_1

datetime

☐

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.

startDate

datetime

Startdatum

☐

The date on which this employment starts. NL: DatumInDienst

startDateContractOfIndefiniteDuration

datetime

☐

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.

statusEmployeeSelfService_hasTwoFactorAuthentication

boolean

☐

Does the employee have two factor authentication enabled

statusEmployeeSelfService_status

string(50)

☐

Description of the status

supplier

string(30)

☐

The supplier of the benefit in kind.

temporaryTaxExemption_key

int32

☐

temporaryTaxExemption_value

string

☐

type

string(30)

Soort

☐

The type of the benefit in kind.

typeOfEmployee_key

int32

Medewerkersoortsleutel

☐

typeOfEmployee_value

string

Type Werknemerswaarde

☐

typeOfParticipation_key

int32

☐

typeOfParticipation_value

string

☐

vacationCoupons_key

int32

☐

vacationCoupons_value

string

☐

value

decimal

Waarde

☐

The value for the selected benefit of kind.

valueOfParticipation_key

int32

Waarde van Participatiesleutel

☐

valueOfParticipation_value

string

Waarde Participatiewaarde

☐

wachtgeldOldRegulation

boolean

☐

Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling

wage_applyPayGrade

boolean

☐

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.

wage_employerCosts

double

☐

The cost for the employer for this employee.

wage_employerCostsType_key

int32

☐

wage_employerCostsType_value

string(50)

☐

wage_endDate

datetime

☐

The end date for the information in the record.

wage_grossWage

double

☐

The gross wage for the employee

wage_grossWageType_key

int32

☐

wage_grossWageType_value

string(50)

☐

wage_id

guid

☐

The unique identifier of an object (GUID/UUID)

wage_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.nl 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.nl 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.

wage_netWage

double

☐

Net wage for the employment

wage_netWageType_key

int32

☐

wage_netWageType_value

string(50)

☐

wage_payGrade_key

int32

☐

wage_payGrade_value

string(50)

☐

wage_payrollPeriodType_key

int32

☐

wage_payrollPeriodType_value

string(50)

☐

wage_payScale_key

int32

☐

wage_payScale_value

string(50)

☐

wage_startDate

datetime

☐

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.

workinghours_aggregatedHoursPerWeek

double

☐

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.

workinghours_averageHoursPerWeek

double

☐

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.

workinghours_averageParttimeFactor

double

☐

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.

workinghours_calculateUsingWorkPattern_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.

workinghours_calculateUsingWorkPattern_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)!

workinghours_calculateUsingWorkPattern_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.

workinghours_calculateUsingWorkPattern_hoursRegularPeriod

boolean

☐

Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.

workinghours_calculateUsingWorkPattern_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

workinghours_contractCode_code

int32

☐

workinghours_contractCode_description

string

☐

workinghours_contractCode_key

guid

☐

The unique identifier of an object (GUID/UUID)

workinghours_deviatingHoursPerWeek

double

☐

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.

workinghours_deviatingSvDaysPerPeriod

int32

☐

Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value.

workinghours_endDate

datetime

☐

The end date of the entity. The date is up to and including.

workinghours_flexibleHoursContract_key

int32

☐

workinghours_flexibleHoursContract_value

string(50)

☐

workinghours_id

guid

☐

The unique identifier of an object (GUID/UUID)

workinghours_regularWorkPattern

boolean

☐

When the employee works the same amount of hours per day every week, then the workpattern is regular.

workinghours_shift_bonusPercentage

decimal

☐

The bonus percentage used in wage calculations for the hours made in this shift.

workinghours_shift_fullTimeHoursPerWeek

decimal

☐

The full time hours for an employment that is linked to this shift.

workinghours_shift_shiftNumber

int32

☐

The number for the shift.

workinghours_shiftRateSickLeave_bonusPercentage

decimal

☐

The bonus percentage used in wage calculations for the hours made in this shift.

workinghours_shiftRateSickLeave_fullTimeHoursPerWeek

decimal

☐

The full time hours for an employment that is linked to this shift.

workinghours_shiftRateSickLeave_shiftNumber

int32

☐

The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).

workinghours_startDate

datetime

☐

Start date of the record.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.

workinghours_workPattern_evenWeeks_friday

double

☐

workinghours_workPattern_evenWeeks_monday

double

☐

workinghours_workPattern_evenWeeks_saturday

double

☐

workinghours_workPattern_evenWeeks_sunday

double

☐

workinghours_workPattern_evenWeeks_thursday

double

☐

workinghours_workPattern_evenWeeks_tuesday

double

☐

workinghours_workPattern_evenWeeks_wednesday

double

☐

workinghours_workPattern_oddWeeks_friday

double

☐

workinghours_workPattern_oddWeeks_monday

double

☐

workinghours_workPattern_oddWeeks_saturday

double

☐

workinghours_workPattern_oddWeeks_sunday

double

☐

workinghours_workPattern_oddWeeks_thursday

double

☐

workinghours_workPattern_oddWeeks_tuesday

double

☐

workinghours_workPattern_oddWeeks_wednesday

double

☐

writtenEmploymentContract

boolean

☐

Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst