EmployerEmployees

epe_address_city

string(24)

☐

City of the address

epe_address_country_isoCode

string(2)

☐

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

epe_address_country_key

int32

☐

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

epe_address_country_value

string(50)

☐

The name of the country

epe_address_furtherIndication_key

int32

☐

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

epe_address_furtherIndication_value

string

☐

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

epe_address_houseNumber

int32

☐

House number of the address

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

epe_address_location

string(35)

☐

The location like to further specify the address

epe_address_postalCode

string(9)

☐

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

epe_address_street

string(24)

☐

Streetname of the address

epe_contactInformation_businessEmailAddress

string(255)

☐

The business e-mail address of the employee.

epe_contactInformation_businessMobilePhoneNumber

string(15)

☐

The business mobile phone number of the employee.

epe_contactInformation_businessPhoneNumber

string(15)

☐

The business phone number of the employee.

epe_contactInformation_emailAddress

string(255)

☐

The e-mail address of the employee.

epe_contactInformation_faxNumber

string(15)

☐

The fax number to contact this individual

epe_contactInformation_mobilePhoneNumber

string(15)

☐

The mobile phone number of the employee.

epe_contactInformation_phoneNumber

string(15)

☐

The phone number of the employee.

epe_deviatingPostalAddress_city

string(24)

☐

City of the address

epe_deviatingPostalAddress_country_isoCode

string(2)

☐

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

epe_deviatingPostalAddress_country_key

int32

☐

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

epe_deviatingPostalAddress_country_value

string(50)

☐

The name of the country

epe_deviatingPostalAddress_furtherIndication_key

int32

☐

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

epe_deviatingPostalAddress_furtherIndication_value

string

☐

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

epe_deviatingPostalAddress_houseNumber

int32

☐

House number of the address

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

epe_deviatingPostalAddress_location

string(35)

☐

The location like to further specify the address

epe_deviatingPostalAddress_postalCode

string(9)

☐

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

epe_deviatingPostalAddress_street

string(24)

☐

Streetname of the address

epe_employeeNumber

int32

☐

The employee number to uniquely identify an employee within an employer

epe_exclusionFromAbsenceStatus

boolean

☐

Indicates whether the employee is excluded for any information of absence

epe_id

guid

☐

The unique identifier of an object (GUID/UUID)

epe_identityDocument_documentIdentification

string

☐

epe_identityDocument_typeOfDocument_key

int32

☐

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

epe_identityDocument_typeOfDocument_value

string(50)

☐

Description of the type of document

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

epe_personalDetails_civilStatus_key

int32

☐

epe_personalDetails_civilStatus_value

string(50)

☐

epe_personalDetails_dateOfBirth

datetime

☐

The date of birth

epe_personalDetails_dateOfDeath

datetime

☐

The date of death

epe_personalDetails_firstName

string(28)

☐

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

epe_personalDetails_formattedName

string(82)

☐

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

epe_personalDetails_gender_key

int32

☐

epe_personalDetails_gender_value

string(50)

☐

epe_personalDetails_howToFormatLastName_key

int32

☐

epe_personalDetails_howToFormatLastName_value

string(50)

☐

epe_personalDetails_initials

string(6)

☐

The initials

epe_personalDetails_lastName

string(25)

☐

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

epe_personalDetails_lastNamePartner

string(25)

☐

The last name of the employee's partner.

epe_personalDetails_nationality_key

int32

☐

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

epe_personalDetails_nationality_value

string(50)

☐

Description of the nationality

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

epe_personalDetails_placeOfBirth

string(24)

☐

The place of birth

epe_personalDetails_prefix

string(10)

☐

The prefix to the last name

epe_personalDetails_prefixPartner

string(10)

☐

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

epe_personalDetails_title_key

int32

☐

epe_personalDetails_title_value

string(50)

☐

epe_revokeEmployeeSelfServiceAccessOn

datetime

☐

The date on which the Employee will be automatically blocked.

epe_statusEmployeeSelfService_key

int32

☐

epe_statusEmployeeSelfService_value

string(50)

☐

epe_travel_travelDistanceToWork

int32

☐

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

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