EmployerEmploymentPayrollPeriodComponents

epr_address_city

string(24)

Plaats

☐

City of the address

epr_address_country_isoCode

string(2)

Land ISO-code

☐

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

epr_address_country_key

int32

Landsleutel

☐

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

epr_address_country_value

string(50)

Landwaarde

☐

The name of the country

epr_address_furtherIndication_key

int32

Adres Verdere Indicatiesleutel

☐

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

epr_address_furtherIndication_value

string

Adres Verdere Indicatiewaarde

☐

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

epr_address_houseNumber

int32

Huisnummer

☐

House number of the address

epr_address_houseNumberAddition

string(4)

Huisnummertoevoeging

☐

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.

epr_address_location

string(35)

Locatie

☐

The location like to further specify the address

epr_address_postalCode

string(9)

Postcode

☐

The postal code of the address

epr_address_province_key

int32

Adres Provinciesleutel

☐

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

epr_address_province_value

string(50)

Adres Provinciewaarde

☐

The name of the province. Only the Dutch provices are supported and not translated

epr_address_street

string(24)

Straat

☐

Streetname of the address

epr_branch_key

int32

Filiaal Sleutel

☐

The key of the branch. Possible values can be aquired via the metadata endpoint

epr_branch_value

string(50)

Filiaalwaarde

☐

Description of the branch. Branch is only available in Dutch

epr_chamberOfCommerceNumber

string(35)

KvK-nummer

☐

Chamber of commerce number. In Dutch "Kamer van koophandel" number

epr_companyName

string(70)

Naam bedrijf

☐

Naam van het bedrijf

epr_contact_function

string(50)

Contactpersoon Functie

☐

The job title/function of the contact of the employer

epr_contact_name

string(50)

Contactpersoon Naam

☐

Name of the contact of the employer

epr_contact_phoneNumber

string(15)

Telefoonnummer

☐

The general phone number of the employer

epr_contactInformation_emailAddress

string(255)

Contactgegevens E-mailadres

☐

The email address of the employer

epr_contactInformation_faxNumber

string(15)

Contactinformatie Faxnummer

☐

The fax number of the employer

epr_contactInformation_phoneNumber

string(15)

Contactgegevens Telefoonnummer

☐

The telephone number of the employer

epr_contactInformation_website

string(255)

Contactinformatie Website

☐

The website of the employer

epr_deviatingPostalAddress_city

string(24)

Afwijkend Postadres Stad

☐

City of the address

epr_deviatingPostalAddress_country_isoCode

string(2)

Afwijkend Postadres Land ISO-code

☐

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

epr_deviatingPostalAddress_country_key

int32

Afwijkend Postadreslandsleutel

☐

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

epr_deviatingPostalAddress_country_value

string(50)

Afwijkende Postadres Landwaarde

☐

The name of the country

epr_deviatingPostalAddress_furtherIndication_key

int32

Afwijkend Postadres Verdere Indicatiesleutel

☐

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

epr_deviatingPostalAddress_furtherIndication_value

string

Afwijkende Postadres Verdere Indicatiewaarde

☐

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

epr_deviatingPostalAddress_houseNumber

int32

Afwijkend Postadres Huisnummer

☐

House number of the address

epr_deviatingPostalAddress_houseNumberAddition

string(4)

Afwijkend Postadres Huisnummertoevoeging

☐

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.

epr_deviatingPostalAddress_location

string(35)

Afwijkend Postadres Locatie

☐

The location like to further specify the address

epr_deviatingPostalAddress_poBox

int32

Afwijkend Postadres Postbus

☐

Post office box

epr_deviatingPostalAddress_postalCode

string(9)

Afwijkend Postadres Postcode

☐

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

epr_deviatingPostalAddress_street

string(24)

Afwijkende Postadresstraat

☐

Streetname of the address

epr_employerLogo

string

Logo Werkgever

☐

The location of the logo of the employer. 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.

epr_employerNumber

int32

Werkgevernummer

☐

The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API).

epr_id

guid

ID

☐

The unique identifier of an object (GUID/UUID)

epr_legalForm_key

int32

Rechtsvorm Sleutel

☐

The key of the legal form. Possible values can be aquired via the metadata endpoint

epr_legalForm_value

string(50)

Rechtsvormwaarde

☐

Description of the legal form. Possible values are the legel forms supported by Dutch law

epr_providerLogo

string

Providerlogo

☐

This logo is displayed in the interface of loket.nl. if null no deviating logo is present and the normal provider logo should be used (aquire the URL to the logo via ../v2/providers)

epr_providerSettings_administrationNumber

string(15)

☐

A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices.

epr_providerSettings_groupCode

int32

☐

The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report).

epr_providerSettings_parentEmployerForConsolidatedOverviews

int32

☐

This field is used to link employers in order to generate reports containing the information of all the linked employers. By applying this method, infinite amount of employers can be linked.

epr_providerSettings_sendEmailWhenSalarySlipIsAvailable

boolean

☐

Indicates whether an e-mail should be sent to an employee if a salary slip becomes available in the employee portal (loket.nl's "werknemer.loket")

epr_sbi_key

int32

SBI-sleutel

☐

The key of the SBI code. Possible values can be aquired via the metadata endpoint

epr_sbi_sbiCode

string(32)

SBI Code

☐

Possible values are the values from the Dutch SBI 2008

epr_sbi_value

string(255)

SBI-waarde

☐

Description of the SBI code

ept_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

ept_cancellationNoticeDate

datetime

Annuleringsdatum

☐

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

ept_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

ept_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

ept_cancellationPeriodTimeUnit_key

int32

☐

ept_cancellationPeriodTimeUnit_value

string

☐

ept_commissionUntilDate

datetime

☐

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

ept_commissionUntilDate1

datetime

☐

Until date for commision #1. NL: AanstellingTot1

ept_commissionUntilDate2

datetime

☐

Until date for commision #2. NL: AanstellingTot2

ept_commissionUntilDate3

datetime

☐

Until date for commision #3. NL: AanstellingTot3

ept_commissionUntilDate4

datetime

☐

Until date for commision #4. NL: AanstellingTot4

ept_commissionUntilDate5

datetime

☐

Until date for commision #5. NL: AanstellingTot5

ept_commissionUntilDate6

datetime

☐

Until date for commision #6. NL: AanstellingTot6

ept_deviatingCLAExternalParty

int32

☐

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

ept_deviatingCLATaxReturn

int32

☐

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

ept_emailLeaveRequest

string(255)

E-mailadres voor Verlofaanvragen

☐

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

ept_employee_dateOfBirth

datetime

Medewerker Geboortedatum

☐

The date of birth

ept_employee_employeeNumber

int32

☐

The employee number to uniquely identify a employee within a employer.

ept_employee_firstName

string(28)

Medewerker Voornaam

☐

The first name of the employee

ept_employee_formattedName

string(82)

Medewerker Geformatteerde Naam

☐

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

ept_employee_id

guid

Werknemer ID

☐

The unique identifier of an object (GUID/UUID)

ept_employee_initials

string(6)

Medewerker Initialen

☐

The initials of the employee

ept_employee_lastName

string(25)

Medewerker Achternaam

☐

The last name of the employee

ept_employee_lastNamePartner

string(25)

☐

The last name of the partner of the employee

ept_employee_photo

string

Medewerkersfoto

☐

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.

ept_employee_prefix

string(10)

Medewerker Voorvoegsel

☐

The prefix of the employee

ept_employee_prefixPartner

string(10)

Medewerker Voorvoegsel Partner

☐

The prefix of the partner of the employee

ept_employeeProfileId_key

int32

Werknemersprofiel ID Sleutel

☐

ept_employeeProfileId_value

string

Werknemersprofiel ID Waarde

☐

ept_employmentCategoryType_key

int32

☐

ept_employmentCategoryType_value

string

☐

ept_employmentContractType_key

int32

☐

ept_employmentContractType_value

string

☐

ept_employmentDurationType_key

int32

Dienstverbandduursoortsleutel

☐

ept_employmentDurationType_value

string

Dienstverbandduursoortwaarde

☐

ept_endDate

datetime

Einddatum

☐

The date on which the employment ends. NL: DatumUitDienst

ept_endOfEmploymentDueToIllness

boolean

☐

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

ept_endOfEmploymentReason_key

int32

☐

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

ept_endOfEmploymentReason_value

string

☐

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

ept_endOfEmploymentReasonTaxAuthorities_key

int32

☐

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

ept_endOfEmploymentReasonTaxAuthorities_value

string

☐

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

ept_essMutationSet_key

int32

☐

ept_essMutationSet_value

string

☐

ept_exemptionInsuranceObligation_key

int32

☐

ept_exemptionInsuranceObligation_value

string

☐

ept_exemptionPremiumWaiverMarginalLabour

boolean

☐

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

ept_exemptionWorkRelatedExpenseScheme

boolean

☐

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

ept_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

ept_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

ept_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

ept_id

guid

ID

☐

The unique identifier of an object (GUID/UUID)

ept_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

ept_isAnonymousEmployee

boolean

☐

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

ept_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

ept_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

ept_isGemoedsbezwaardEmployeeInsurance

boolean

☐

Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering

ept_isGemoedsbezwaardNationalInsurance

boolean

☐

Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering

ept_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

ept_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

ept_linkedEmployment

guid

☐

The unique identifier of an object (GUID/UUID)

ept_namePayslip

string(34)

Naam op Loonstrook

☐

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

ept_nonPayrollAdministration_description

string(50)

☐

Description of the administration

ept_nonPayrollAdministration_id

guid

☐

The unique identifier of an object (GUID/UUID)

ept_nonPayrollAdministration_name

string(70)

☐

Name of the non payroll administration

ept_participation55plusRegulationUWV

boolean

☐

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

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

ept_payrollAdministration_description

string(50)

☐

Description of the administration

ept_payrollAdministration_id

guid

Salarisadministratie ID

☐

The unique identifier of an object (GUID/UUID)

ept_payrollAdministration_name

string(70)

Naam Salarisadministratie

☐

Name of the payroll administration

ept_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

ept_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

ept_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

ept_sendToExternalParty_key

int32

☐

ept_sendToExternalParty_value

string

☐

ept_signalPayGradeAdjustment

boolean

☐

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

ept_specialIncomeRatio_key

int32

Sleutel voor Speciale Inkomensverhouding

☐

ept_specialIncomeRatio_value

string

Speciale Inkomensverhouding

☐

ept_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

ept_startDate

datetime

Startdatum

☐

The date on which this employment starts. NL: DatumInDienst

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

ept_temporaryTaxExemption_key

int32

☐

ept_temporaryTaxExemption_value

string

☐

ept_typeOfEmployee_key

int32

Medewerkersoortsleutel

☐

ept_typeOfEmployee_value

string

Type Werknemerswaarde

☐

ept_typeOfParticipation_key

int32

☐

ept_typeOfParticipation_value

string

☐

ept_vacationCoupons_key

int32

☐

ept_vacationCoupons_value

string

☐

ept_valueOfParticipation_key

int32

Waarde van Participatiesleutel

☐

ept_valueOfParticipation_value

string

Waarde Participatiewaarde

☐

ept_wachtgeldOldRegulation

boolean

☐

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

ept_writtenEmploymentContract

boolean

☐

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

ppt_costCenter_code

string

Kostenplaatscode

☐

ppt_costCenter_description

string

Kostenplaats Omschrijving

☐

ppt_costCenter_key

int32

Kostenplaatssleutel

☐

ppt_costUnit_code

string

Kostendragercode

☐

ppt_costUnit_description

string

Kostendrager Omschrijving

☐

ppt_costUnit_key

int32

Kostensleutelcode

☐

ppt_distributionUnit_code

int32

Code voor Distributie-eenheid

☐

ppt_distributionUnit_description

string

Distributieeenheid Omschrijving

☐

ppt_distributionUnit_key

guid

Distributie-eenheid Sleutel

☐

The unique identifier of an object (GUID/UUID)

ppt_employmentId

guid

Dienstverband ID

☑

ppt_id

guid

ID

☐

The unique identifier of an object (GUID/UUID)

ppt_isSupplement

boolean

Is Aanvulling

☐

This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).* When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.* When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.

ppt_payrollComponent_canBeSupplemented

boolean

☐

Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.

ppt_payrollComponent_category_key

int32

Salariscomponent Categoriesleutel

☐

ppt_payrollComponent_category_value

string

Looncomponent Categoriewaarde

☐

ppt_payrollComponent_deductionOrPayment_key

int32

☐

ppt_payrollComponent_deductionOrPayment_value

string

☐

ppt_payrollComponent_description

string(14)

Looncomponentomschrijving

☐

The description of the payroll component

ppt_payrollComponent_key

int32

Salariscomponentsleutel

☐

The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.

ppt_payrollPeriod_periodEndDate

datetime

Einddatum Loonperiode

☐

The last day of the period to which the payroll period data applies

ppt_payrollPeriod_periodNumber

int32

Nummer Verloningsperiode

☐

The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.

ppt_payrollPeriod_periodStartDate

datetime

Startdatum Verloningsperiode

☐

The first day of the period to which the payroll period data applies

ppt_payrollPeriod_year

int32

Loonverwerking Jaarperiode

☐

The year of the payroll period in which the payroll data is to be processed

ppt_payrollPeriodDataId

guid

☑

ppt_payslipText

string(25)

Tekst op Loonstrook

☐

A custom text to be displayed on the payslip.

ppt_payslipType_key

int32

Loonstrooksoortsleutel

☐

ppt_payslipType_value

string

Loonstrooksoortwaarde

☐

ppt_shift_bonusPercentage

decimal

Dienst Bonuspercentage

☐

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

ppt_shift_fullTimeHoursPerWeek

decimal

Weekuren Full-time Dienstverband

☐

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

ppt_shift_shiftNumber

int32

Dienstnummer

☐

The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.

ppt_value

decimal

Waarde

☐

Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).