Please enable JavaScript to view this site.

Navigation: Schema: Views > Views

EmployerEmploymentPayrollPeriodPayslipComponents

Catalog: LoketNlRest

Schema: Views

This is a read-only view. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.

View Columns

The columns of the view EmployerEmploymentPayrollPeriodPayslipComponents are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

epr_address_city

string(24)

 

City of the address

epr_address_country_isoCode

string(2)

 

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

epr_address_country_key

int32

 

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

epr_address_country_value

string(50)

 

The name of the country

epr_address_furtherIndication_key

int32

 

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

epr_address_furtherIndication_value

string

 

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

epr_address_houseNumber

int32

 

House number of the address

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

epr_address_location

string(35)

 

The location like to further specify the address

epr_address_postalCode

string(9)

 

The postal code of the address

epr_address_province_key

int32

 

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

epr_address_province_value

string(50)

 

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

epr_address_street

string(24)

 

Streetname of the address

epr_branch_key

int32

 

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

epr_branch_value

string(50)

 

Description of the branch. Branch is only available in Dutch

epr_chamberOfCommerceNumber

string(35)

 

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

epr_companyName

string(70)

 

Name of the company

epr_contact_function

string(50)

 

The job title/function of the contact of the employer

epr_contact_name

string(50)

 

Name of the contact of the employer

epr_contact_phoneNumber

string(15)

 

The general phone number of the employer

epr_contactInformation_emailAddress

string(255)

 

The email address of the employer

epr_contactInformation_faxNumber

string(15)

 

The fax number of the employer

epr_contactInformation_phoneNumber

string(15)

 

The telephone number of the employer

epr_contactInformation_website

string(255)

 

The website of the employer

epr_deviatingPostalAddress_city

string(24)

 

City of the address

epr_deviatingPostalAddress_country_isoCode

string(2)

 

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

epr_deviatingPostalAddress_country_key

int32

 

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

epr_deviatingPostalAddress_country_value

string(50)

 

The name of the country

epr_deviatingPostalAddress_furtherIndication_key

int32

 

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

epr_deviatingPostalAddress_furtherIndication_value

string

 

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

epr_deviatingPostalAddress_houseNumber

int32

 

House number of the address

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

epr_deviatingPostalAddress_location

string(35)

 

The location like to further specify the address

epr_deviatingPostalAddress_poBox

int32

 

Post office box

epr_deviatingPostalAddress_postalCode

string(9)

 

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

epr_deviatingPostalAddress_street

string(24)

 

Streetname of the address

epr_employerLogo

string

 

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

 

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

 

The unique identifier of an object (GUID/UUID)

epr_legalForm_key

int32

 

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

epr_legalForm_value

string(50)

 

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

epr_providerLogo

string

 

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

 

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

epr_sbi_sbiCode

string(32)

 

Posible values are the values from the Dutch SBI 2008

epr_sbi_value

string(255)

 

Description of the SBI code

ept_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

ept_cancellationNoticeDate

datetime

 

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

ept_cancellationPeriodEmployee

int32

 

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

 

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)

 

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

ept_employee_dateOfBirth

datetime

 

The date of birth

ept_employee_employeeNumber

int32

 

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

ept_employee_firstName

string(28)

 

The first name of the employee

ept_employee_formattedName

string(82)

 

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

ept_employee_id

guid

 

The unique identifier of an object (GUID/UUID)

ept_employee_initials

string(6)

 

The initials of the employee

ept_employee_lastName

string(25)

 

The last name of the employee

ept_employee_lastNamePartner

string(25)

 

The last name of the partner of the employee

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

ept_employee_prefix

string(10)

 

The prefix of the employee

ept_employee_prefixPartner

string(10)

 

The prefix of the partner of the employee

ept_employeeProfileId_key

int32

 

 

ept_employeeProfileId_value

string

 

 

ept_employmentCategoryType_key

int32

 

 

ept_employmentCategoryType_value

string

 

 

ept_employmentContractType_key

int32

 

 

ept_employmentContractType_value

string

 

 

ept_employmentDurationType_key

int32

 

 

ept_employmentDurationType_value

string

 

 

ept_endDate

datetime

 

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

 

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

 

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

 

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_namePayslip

string(34)

 

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

 

The unique identifier of an object (GUID/UUID)

ept_payrollAdministration_name

string(70)

 

Name of the payroll administration

ept_payrollId

int32

 

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

 

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

 

 

ept_specialIncomeRatio_value

string

 

 

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

 

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

 

 

ept_typeOfEmployee_value

string

 

 

ept_typeOfParticipation_key

int32

 

 

ept_typeOfParticipation_value

string

 

 

ept_vacationCoupons_key

int32

 

 

ept_vacationCoupons_value

string

 

 

ept_valueOfParticipation_key

int32

 

 

ept_valueOfParticipation_value

string

 

 

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

ppa_costCenter_code

string

 

 

ppa_costCenter_description

string

 

 

ppa_costCenter_key

int32

 

 

ppa_costUnit_code

string

 

 

ppa_costUnit_description

string

 

 

ppa_costUnit_key

int32

 

 

ppa_distributionUnit_code

int32

 

 

ppa_distributionUnit_description

string

 

 

ppa_distributionUnit_key

guid

 

The unique identifier of an object (GUID/UUID)

ppa_id

guid

 

The unique identifier of an object (GUID/UUID)

ppa_payrollPeriod_periodEndDate

datetime

 

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

ppa_payrollPeriod_periodNumber

int32

 

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.

ppa_payrollPeriod_periodStartDate

datetime

 

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

ppa_payrollPeriod_year

int32

 

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

ppa_payslipText

string(25)

 

A custom text to be displayed on the payslip.

ppa_payslipType_key

int32

 

 

ppa_payslipType_value

string

 

 

ppa_shift_bonusPercentage

decimal

 

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

ppa_shift_fullTimeHoursPerWeek

decimal

 

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

ppa_shift_shiftNumber

int32

 

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

pre_employmentId

guid

 

The unique identifier of an object (GUID/UUID)

pre_payrollComponent_category_key

int32

 

 

pre_payrollComponent_category_value

string

 

 

pre_payrollComponent_column_key

int32

 

 

pre_payrollComponent_column_value

string

 

 

pre_payrollComponent_costsEmployer_key

int32

 

 

pre_payrollComponent_costsEmployer_value

string

 

 

pre_payrollComponent_countAsNormHours

boolean

 

Indicates whether its value is counted as norm hours (bij bepalen normuren)

pre_payrollComponent_hoursIndication

boolean

 

Only applicable for component in category 6 (eenheden)

pre_payrollComponent_key

int32

 

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

pre_payrollComponent_value

string(14)

 

The description of the payroll component

pre_payrollPeriod_periodEndDate

datetime

 

The last day of the period for which the tax return message was created

pre_payrollPeriod_periodNumber

int32

 

The period number of the payroll period the record relates to

pre_payrollPeriod_periodStartDate

datetime

 

The first day of the period for which the tax return message was created

pre_payrollPeriod_testYear

boolean

 

Indicates whether the payroll periode is part of a test year.In Loket it is possible to run a year of a payrolladministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.

pre_payrollPeriod_year

int32

 

The year of the payroll period the record relates to

pre_payslipType_key

int32

 

 

pre_payslipType_value

string

 

 

pre_value

decimal

 

Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.

pre_valueSpecialTariff

decimal

 

Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.

 

25-05-2022 14:15 Version 22.1.46-BETA+3385