# EmploymentLeaveBalances This is a read-only view. The Loket.nl REST API may not support changing the data, or the Invantive UniversalSQL driver for Loket.nl REST does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the Loket.nl REST API. - Catalog: `LoketNlRest` - Schema: `Views` ## View Columns The columns of the view `EmploymentLeaveBalances` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `epr_address_city` | `string(24)` | City | ☐ | City of the address | | `epr_address_country_isoCode` | `string(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` | `string(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` | `string` | 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` | `string(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` | `string(35)` | Location | ☐ | The location like to further specify the address | | `epr_address_postalCode` | `string(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` | `string(50)` | Address Province Value | ☐ | The name of the province. Only the Dutch provices are supported and not translated | | `epr_address_street` | `string(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` | `string(50)` | Branch Value | ☐ | Description of the branch. Branch is only available in Dutch | | `epr_chamberOfCommerceNumber` | `string(35)` | Chamber of Commerce Number | ☐ | Chamber of commerce number. In Dutch "Kamer van koophandel" number | | `epr_companyName` | `string(70)` | Company Name | ☐ | Company name | | `epr_contact_function` | `string(50)` | Contact Person Position | ☐ | The job title/function of the contact of the employer | | `epr_contact_name` | `string(50)` | Contact Person Name | ☐ | Name of the contact of the employer | | `epr_contact_phoneNumber` | `string(15)` | Phone Number | ☐ | The general phone number of the employer | | `epr_contactInformation_emailAddress` | `string(255)` | Contact Details Email Address | ☐ | The email address of the employer | | `epr_contactInformation_faxNumber` | `string(15)` | Contact Information Fax Number | ☐ | The fax number of the employer | | `epr_contactInformation_phoneNumber` | `string(15)` | Contact Details Telephone Number | ☐ | The telephone number of the employer | | `epr_contactInformation_website` | `string(255)` | Contact Information Website | ☐ | The website of the employer | | `epr_deviatingPostalAddress_city` | `string(24)` | Deviating Postal Address City | ☐ | City of the address | | `epr_deviatingPostalAddress_country_isoCode` | `string(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` | `string(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` | `string` | 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` | `string(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` | `string(35)` | Deviating Postal Address Location | ☐ | The location like to further specify the address | | `epr_deviatingPostalAddress_poBox` | `int32` | Deviating Postal Address PO Box | ☐ | Post office box | | `epr_deviatingPostalAddress_postalCode` | `string(9)` | Deviating Postal Address Postal Code | ☐ | The postal code of the address, only nullable if country is not The Netherlands (NL). | | `epr_deviatingPostalAddress_street` | `string(24)` | Deviating Postal Address Street | ☐ | Streetname of the address | | `epr_employerLogo` | `string` | 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` | `string(50)` | Legal Form Value | ☐ | Description of the legal form. Possible values are the legel forms supported by Dutch law | | `epr_providerLogo` | `string` | 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` | `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 Key | ☐ | 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 Value | ☐ | Description of the SBI code | | `ept_calculateWorkingHours` | `boolean` | 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 Date | ☐ | The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging | | `ept_cancellationPeriodEmployee` | `int32` | Cancellation Statement 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 Statement 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` | | ☐ | | | `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)` | 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` | | ☐ | The employee number to uniquely identify a employee within a employer. | | `ept_employee_firstName` | `string(28)` | Employee First Name | ☐ | The first name of the employee | | `ept_employee_formattedName` | `string(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` | `string(6)` | Employee Initials | ☐ | The initials of the employee | | `ept_employee_lastName` | `string(25)` | Employee Last Name | ☐ | The last name of the employee | | `ept_employee_lastNamePartner` | `string(25)` | | ☐ | The last name of the partner of the employee | | `ept_employee_photo` | `string` | 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` | `string(10)` | Employee Name Prefix | ☐ | The prefix of the employee | | `ept_employee_prefixPartner` | `string(10)` | Employee Partner Name Prefix | ☐ | The prefix of the partner of the employee | | `ept_employeeProfileId_key` | `int32` | Employee Profile ID Key | ☐ | | | `ept_employeeProfileId_value` | `string` | Employee Profile ID Value | ☐ | | | `ept_employmentCategoryType_key` | `int32` | | ☐ | | | `ept_employmentCategoryType_value` | `string` | | ☐ | | | `ept_employmentContractType_key` | `int32` | | ☐ | | | `ept_employmentContractType_value` | `string` | | ☐ | | | `ept_employmentDurationType_key` | `int32` | Employment Duration Type Key | ☐ | | | `ept_employmentDurationType_value` | `string` | Employment Duration Type Value | ☐ | | | `ept_endDate` | `datetime` | End Date | ☐ | 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` | First Day of 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` | `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` | 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` | | ☐ | 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` | | ☐ | Conscientious Objector Employee Insurance. NL: IsGemoedsbezwaardWerknemerverzekering | | `ept_isGemoedsbezwaardNationalInsurance` | `boolean` | | ☐ | Conscientious Objector National Insurance. 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)` | Name on Payslip | ☐ | 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` | Payroll Administration ID | ☐ | The unique identifier of an object (GUID/UUID) | | `ept_payrollAdministration_name` | `string(70)` | Payroll Administration Name | ☐ | Name of the payroll administration | | `ept_payrollId` | `int32` | Payslip 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` | Occupation 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` | | ☐ | | | `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` | Special Income Relationship Key | ☐ | | | `ept_specialIncomeRatio_value` | `string` | Special Income Relationship | ☐ | | | `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` | Start Date | ☐ | 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` | Employee Type Key | ☐ | | | `ept_typeOfEmployee_value` | `string` | Employee Type Value | ☐ | | | `ept_typeOfParticipation_key` | `int32` | | ☐ | | | `ept_typeOfParticipation_value` | `string` | | ☐ | | | `ept_vacationCoupons_key` | `int32` | | ☐ | | | `ept_vacationCoupons_value` | `string` | | ☐ | | | `ept_valueOfParticipation_key` | `int32` | Participation Key Value | ☐ | | | `ept_valueOfParticipation_value` | `string` | Participation Value | ☐ | | | `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 | | `lbe_accrual` | `double` | | ☐ | The amount of leave units accrued for the leave type in the year | | `lbe_balance` | `double` | Balance | ☐ | The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future. | | `lbe_balancePreviousYear` | `double` | Balance Previous Year | ☐ | The remaining leave balance from the previous year for the leave type | | `lbe_expires` | `double` | | ☐ | <ul> <li>This field is only relevant for the following leave types:</li> <li><strong>Wettelijk verlof:</strong> Accrued statutory leave from previous years that expires on July 1 of the selected year.</li> <li><strong>Bovenwettelijk verlof:</strong> Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.</li> <li><strong>Verlof:</strong> The sum of the two leave types above.</li> </ul> | | `lbe_leaveType_balanceExceedsYear` | `boolean` | | ☐ | Indicates whether the balance at the end of the year for this leave type carries over to the next year. | | `lbe_leaveType_key` | `int32` | Leave Type Key | ☐ | The key for the leave type. | | `lbe_leaveType_value` | `string` | Leave Type Value | ☐ | The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type. | | `lbe_unitType_key` | `int32` | Unit Type Key | ☐ | The key for the unit type | | `lbe_unitType_value` | `string` | Unit Type Value | ☐ | The description for the unit type | | `lbe_usageAfterToday` | `double` | | ☐ | The amount of leave units used for the leave type in the year after today | | `lbe_usageThroughToday` | `double` | | ☐ | The amount of leave units used for the leave type starting from the beginning of the year up to and including today | | `lbe_usageTotal` | `double` | Total Used | ☐ | The total amount of leave units used for the leave type in the year. | | `lbe_year` | `int32` | Year | ☐ | The year to which the balance of the leave type applies. |