invantive documentation
Invantive Support ForumsLog In / Sign Up

EmployerEmploymentPayrollPeriodComponents: Loket.nl REST Employer Employment Payroll Period Components

read only

  • Catalog: LoketNlRest
  • Schema: Views
  • Label: Employer Employment Payroll Period Components

Can only retrieve data.

Table Columns

The columns of the table EmployerEmploymentPayrollPeriodComponents are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
epr_address_city varchar2(24) City City of the address
epr_address_country_isoCode varchar2(2) Country ISO-code The ISO 3166-1 alpha-2 value for the country
epr_address_country_key int32 Country Key The key for the country. Possible values can be aquired via the metadata endpoint
epr_address_country_value varchar2(50) Country Value The name of the country
epr_address_furtherIndication_key int32 Address Further Indication Key The key of the further indication. Possible values can be aquired via the metadata endpoint
epr_address_furtherIndication_value varchar2 Address Further Indication Value The description of the further indication, the possible values are "WW" and "AB"
epr_address_houseNumber int32 House Number House number of the address
epr_address_houseNumberAddition varchar2(4) House Number Addition 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 varchar2(35) Location The location like to further specify the address
epr_address_postalCode varchar2(9) Postal Code The postal code of the address
epr_address_province_key int32 Address Province Key The key for the province. Possible values can be aquired via the metadata endpoint
epr_address_province_value varchar2(50) Address Province Value The name of the province. Only the Dutch provices are supported and not translated
epr_address_street varchar2(24) Street Streetname of the address
epr_branch_key int32 Branch Key The key of the branch. Possible values can be aquired via the metadata endpoint
epr_branch_value varchar2(50) Branch Value Description of the branch. Branch is only available in Dutch
epr_chamberOfCommerceNumber varchar2(35) Chamber of Commerce Number Chamber of commerce number. In Dutch "Kamer van koophandel" number
epr_companyName varchar2(70) Company Name Name of the company
epr_contact_function varchar2(50) Contact Function The job title/function of the contact of the employer
epr_contact_name varchar2(50) Contact Name Name of the contact of the employer
epr_contact_phoneNumber varchar2(15) Phone Number The general phone number of the employer
epr_contactInformation_emailAddress varchar2(255) Contact Information Email Address The email address of the employer
epr_contactInformation_faxNumber varchar2(15) Contact Information Fax Number The fax number of the employer
epr_contactInformation_phoneNumber varchar2(15) Contact Information Phone Number The telephone number of the employer
epr_contactInformation_website varchar2(255) Contact Information Website The website of the employer
epr_deviatingPostalAddress_city varchar2(24) Deviating Postal Address City City of the address
epr_deviatingPostalAddress_country_isoCode varchar2(2) Deviating Postal Address Country ISO-code The ISO 3166-1 alpha-2 value for the country
epr_deviatingPostalAddress_country_key int32 Deviating Postal Address Country Key The key for the country. Possible values can be aquired by the metadata endpoint
epr_deviatingPostalAddress_country_value varchar2(50) Deviating Postal Address Country Value The name of the country
epr_deviatingPostalAddress_furtherIndication_key int32 Deviating Postal Address Further Indication Key The key of the further indication. Possible values can be aquired by the metadata endpoint
epr_deviatingPostalAddress_furtherIndication_value varchar2 Deviating Postal Address Further Indication Value The description of the further indication, the possible values are "WW" and "AB"
epr_deviatingPostalAddress_houseNumber int32 Deviating Postal Address House Number House number of the address
epr_deviatingPostalAddress_houseNumberAddition varchar2(4) Deviating Postal Address House Number Addition 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 varchar2(35) Deviating Postal Address Location The location like to further specify the address
epr_deviatingPostalAddress_poBox int32 Deviating Postal Address Post Office Box Post office box
epr_deviatingPostalAddress_postalCode varchar2(9) Deviating Postal Address Postal Code The postal code of the address, only nullable if country is not The Netherlands (NL).
epr_deviatingPostalAddress_street varchar2(24) Deviating Postal Address Street Streetname of the address
epr_employerLogo varchar2 Employer Logo 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 Employer Number 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 Legal Form Key The key of the legal form. Possible values can be aquired via the metadata endpoint
epr_legalForm_value varchar2(50) Legal Form Value Description of the legal form. Possible values are the legel forms supported by Dutch law
epr_providerLogo varchar2 Provider Logo 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 varchar2(15) itgen_loketnl_providersettings_administrationnumber 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 itgen_loketnl_providersettings_groupcode 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 itgen_loketnl_providersettings_parentemployerforconsolidatedoverviews 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 char itgen_loketnl_providersettings_sendemailwhensalaryslipisavailable 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 Key The key of the SBI code. Possible values can be aquired via the metadata endpoint
epr_sbi_sbiCode varchar2(32) SBI Code Possible values are the values from the Dutch SBI 2008
epr_sbi_value varchar2(255) SBI Value Description of the SBI code
ept_calculateWorkingHours char Calculate Working Hours 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 Cancellation Notice Date The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging
ept_cancellationPeriodEmployee int32 Cancellation Notice for Employee 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 Cancellation Notice for Employer 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 itgen_loketnl_cancellationperiodtimeunit_key
ept_cancellationPeriodTimeUnit_value varchar2 itgen_loketnl_cancellationperiodtimeunit_value
ept_commissionUntilDate datetime itgen_loketnl_commissionuntildate The date on which the employment will end. NL: AanstellingTot
ept_commissionUntilDate1 datetime itgen_loketnl_commissionuntildate1 Until date for commision #1. NL: AanstellingTot1
ept_commissionUntilDate2 datetime itgen_loketnl_commissionuntildate2 Until date for commision #2. NL: AanstellingTot2
ept_commissionUntilDate3 datetime itgen_loketnl_commissionuntildate3 Until date for commision #3. NL: AanstellingTot3
ept_commissionUntilDate4 datetime itgen_loketnl_commissionuntildate4 Until date for commision #4. NL: AanstellingTot4
ept_commissionUntilDate5 datetime itgen_loketnl_commissionuntildate5 Until date for commision #5. NL: AanstellingTot5
ept_commissionUntilDate6 datetime itgen_loketnl_commissionuntildate6 Until date for commision #6. NL: AanstellingTot6
ept_deviatingCLAExternalParty int32 itgen_loketnl_deviatingclaexternalparty CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend
ept_deviatingCLATaxReturn int32 itgen_loketnl_deviatingclataxreturn CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV
ept_emailLeaveRequest varchar2(255) Email Address for Leave Requests Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag
ept_employee_dateOfBirth datetime Employee Date of Birth The date of birth
ept_employee_employeeNumber int32 itgen_loketnl_employee_employeenumber The employee number to uniquely identify a employee within a employer.
ept_employee_firstName varchar2(28) Employee First Name The first name of the employee
ept_employee_formattedName varchar2(82) Employee Formatted Name Formatted name of the employee based on the value of howToFormatLastName
ept_employee_id guid Employee ID The unique identifier of an object (GUID/UUID)
ept_employee_initials varchar2(6) Employee Initials The initials of the employee
ept_employee_lastName varchar2(25) Employee Last Name The last name of the employee
ept_employee_lastNamePartner varchar2(25) itgen_loketnl_employee_lastnamepartner The last name of the partner of the employee
ept_employee_photo varchar2 Employee Photo 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 varchar2(10) Employee Prefix The prefix of the employee
ept_employee_prefixPartner varchar2(10) Employee Prefix Partner The prefix of the partner of the employee
ept_employeeProfileId_key int32 Employee Profile ID Key
ept_employeeProfileId_value varchar2 Employee Profile ID Value
ept_employmentCategoryType_key int32 itgen_loketnl_employmentcategorytype_key
ept_employmentCategoryType_value varchar2 itgen_loketnl_employmentcategorytype_value
ept_employmentContractType_key int32 itgen_loketnl_employmentcontracttype_key
ept_employmentContractType_value varchar2 itgen_loketnl_employmentcontracttype_value
ept_employmentDurationType_key int32 Employment Duration Type Key
ept_employmentDurationType_value varchar2 Employment Duration Type Value
ept_endDate datetime End Date The date on which the employment ends. NL: DatumUitDienst
ept_endOfEmploymentDueToIllness char itgen_loketnl_endofemploymentduetoillness Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst
ept_endOfEmploymentReason_key int32 itgen_loketnl_endofemploymentreason_key The key for the reason for the end of the employment.
ept_endOfEmploymentReason_value varchar2 itgen_loketnl_endofemploymentreason_value The description of the reason for the end of the employment.
ept_endOfEmploymentReasonTaxAuthorities_key int32 itgen_loketnl_endofemploymentreasontaxauthorities_key The key for the reason for the end of the employment.
ept_endOfEmploymentReasonTaxAuthorities_value varchar2 itgen_loketnl_endofemploymentreasontaxauthorities_value The description of the reason for the end of the employment.
ept_essMutationSet_key int32 itgen_loketnl_essmutationset_key
ept_essMutationSet_value varchar2 itgen_loketnl_essmutationset_value
ept_exemptionInsuranceObligation_key int32 itgen_loketnl_exemptioninsuranceobligation_key
ept_exemptionInsuranceObligation_value varchar2 itgen_loketnl_exemptioninsuranceobligation_value
ept_exemptionPremiumWaiverMarginalLabour char itgen_loketnl_exemptionpremiumwaivermarginallabour Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid
ept_exemptionWorkRelatedExpenseScheme char itgen_loketnl_exemptionworkrelatedexpensescheme Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting
ept_firstDayNotification char First Day Notification 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 char itgen_loketnl_hasoncallappearanceobligation 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 Historical Start Date 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 itgen_loketnl_incomerelationshipnumber 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 char itgen_loketnl_isanonymousemployee An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
ept_isDirectorAndMajorShareholder char itgen_loketnl_isdirectorandmajorshareholder 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 char itgen_loketnl_isfamilyofowner 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 char itgen_loketnl_isgemoedsbezwaardemployeeinsurance Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
ept_isGemoedsbezwaardNationalInsurance char itgen_loketnl_isgemoedsbezwaardnationalinsurance Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
ept_isOnCallEmployment char itgen_loketnl_isoncallemployment 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 char itgen_loketnl_ispreviousowner 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 itgen_loketnl_linkedemployment The unique identifier of an object (GUID/UUID)
ept_namePayslip varchar2(34) Name on Payslip Name that is visible on payslips for the employment. NL: NaamLoonstrook
ept_nonPayrollAdministration_description varchar2(50) itgen_loketnl_nonpayrolladministration_description Description of the administration
ept_nonPayrollAdministration_id guid itgen_loketnl_nonpayrolladministration_id The unique identifier of an object (GUID/UUID)
ept_nonPayrollAdministration_name varchar2(70) itgen_loketnl_nonpayrolladministration_name Name of the non payroll administration
ept_participation55plusRegulationUWV char itgen_loketnl_participation55plusregulationuwv Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus
ept_payrollAdministration_clientNumber int32 itgen_loketnl_payrolladministration_clientnumber 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 varchar2(50) itgen_loketnl_payrolladministration_description Description of the administration
ept_payrollAdministration_id guid Payroll Administration ID The unique identifier of an object (GUID/UUID)
ept_payrollAdministration_name varchar2(70) Payroll Administration Name Name of the payroll administration
ept_payrollId int32 Payroll 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 itgen_loketnl_periodpaygradeadjustment 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 Profession Code 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 itgen_loketnl_sendtoexternalparty_key
ept_sendToExternalParty_value varchar2 itgen_loketnl_sendtoexternalparty_value
ept_signalPayGradeAdjustment char itgen_loketnl_signalpaygradeadjustment Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren
ept_specialIncomeRatio_key int32 Special Income Ratio Key
ept_specialIncomeRatio_value varchar2 Special Income Ratio Value
ept_startCancellationNoticePeriod datetime itgen_loketnl_startcancellationnoticeperiod 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 Start Date The date on which this employment starts. NL: DatumInDienst
ept_startDateContractOfIndefiniteDuration datetime itgen_loketnl_startdatecontractofindefiniteduration 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 itgen_loketnl_temporarytaxexemption_key
ept_temporaryTaxExemption_value varchar2 itgen_loketnl_temporarytaxexemption_value
ept_typeOfEmployee_key int32 Type of Employee Key
ept_typeOfEmployee_value varchar2 Type of Employee Value
ept_typeOfParticipation_key int32 itgen_loketnl_typeofparticipation_key
ept_typeOfParticipation_value varchar2 itgen_loketnl_typeofparticipation_value
ept_vacationCoupons_key int32 itgen_loketnl_vacationcoupons_key
ept_vacationCoupons_value varchar2 itgen_loketnl_vacationcoupons_value
ept_valueOfParticipation_key int32 Value of Participation Key
ept_valueOfParticipation_value varchar2 Value of Participation Value
ept_wachtgeldOldRegulation char itgen_loketnl_wachtgeldoldregulation Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling
ept_writtenEmploymentContract char itgen_loketnl_writtenemploymentcontract Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst
ppt_costCenter_code varchar2 Cost Centre Code
ppt_costCenter_description varchar2 Cost Centre Description
ppt_costCenter_key int32 Cost Centre Key
ppt_costUnit_code varchar2 Cost Unit Code
ppt_costUnit_description varchar2 Cost Unit Description
ppt_costUnit_key int32 Cost Unit Key
ppt_distributionUnit_code int32 Distribution Unit Code
ppt_distributionUnit_description varchar2 Distribution Unit Description
ppt_distributionUnit_key guid Distribution Unit Key The unique identifier of an object (GUID/UUID)
ppt_employmentId guid Employment ID
ppt_id guid ID The unique identifier of an object (GUID/UUID)
ppt_isSupplement char Is Supplement 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 char itgen_loketnl_payrollcomponent_canbesupplemented 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 Payroll Component Category Key
ppt_payrollComponent_category_value varchar2 Payroll Component Category Value
ppt_payrollComponent_deductionOrPayment_key int32 itgen_loketnl_payrollcomponent_deductionorpayment_key
ppt_payrollComponent_deductionOrPayment_value varchar2 itgen_loketnl_payrollcomponent_deductionorpayment_value
ppt_payrollComponent_description varchar2(14) Payroll Component Description The description of the payroll component
ppt_payrollComponent_key int32 Payroll Component Key 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 Payroll Period End Date The last day of the period to which the payroll period data applies
ppt_payrollPeriod_periodNumber int32 Payroll Period Number 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 Payroll Period Start Date The first day of the period to which the payroll period data applies
ppt_payrollPeriod_year int32 Payroll Period Year The year of the payroll period in which the payroll data is to be processed
ppt_payrollPeriodDataId guid itgen_loketnl_payrollperioddataid
ppt_payslipText varchar2(25) Text on Payslip A custom text to be displayed on the payslip.
ppt_payslipType_key int32 Payslip Type Key
ppt_payslipType_value varchar2 Payslip Type Value
ppt_shift_bonusPercentage decimal Shift Bonus Percentage The bonus percentage used in wage calculations for the hours made in this shift.
ppt_shift_fullTimeHoursPerWeek decimal Shift Fulltime Hours per Week The full time hours for an employment that is linked to this shift.
ppt_shift_shiftNumber int32 Shift Number The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
ppt_value decimal Value Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: