# PayrollAdministrationPayrollRuns 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 `PayrollAdministrationPayrollRuns` 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 | | `prn_approvalTime` | `datetime` | Approval Time | ☐ | The time at which the payroll run was approved by the user | | `prn_approvedBy_formattedName` | `string` | Approved By Formatted Name | ☐ | preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `prn_approvedBy_id` | `guid` | Approved By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `prn_approvedBy_initials` | `string(6)` | Approved By Initials | ☐ | The initials of the user | | `prn_approvedBy_lastName` | `string(25)` | Approved By Last Name | ☐ | The last name of the user | | `prn_approvedBy_prefix` | `string(10)` | Approved By Name Prefix | ☐ | The prefix of the user | | `prn_availableForEmployeeDate` | `datetime` | Date Available to Employee | ☐ | The date on which the pay slips will be available to employees. | | `prn_errorsAndWarnings_hasErrors` | `boolean` | | ☐ | Indicates whether the payrollrun has errors | | `prn_errorsAndWarnings_hasWarnings` | `boolean` | | ☐ | Indicates whether the payrollrun has warnings | | `prn_errorsAndWarningsHasErrors` | `boolean` | | ☑ | | | `prn_errorsAndWarningsHasWarnings` | `boolean` | | ☑ | | | `prn_id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `prn_methodOfCreation_key` | `int32` | Creation Method Key | ☐ | The key indicating how the payroll run was created. | | `prn_methodOfCreation_value` | `string` | Creation Method Value | ☐ | The value describing how the payroll run was created. | | `prn_payrollPeriod_periodNumber` | `int32` | Payroll Period Number | ☐ | The period number of the payroll period the record relates to | | `prn_payrollPeriod_year` | `int32` | Payroll Processing Year Period | ☐ | The year of the payroll period the record relates to | | `prn_payrollRunStatus_key` | `int32` | Payroll Processing Status Key | ☐ | The key indicating the current status of the payroll run. | | `prn_payrollRunStatus_value` | `string` | Payroll Processing Status Value | ☐ | The value describing the current status of the payroll run. * Ready for payroll processing. (key = 0) * Payroll processing completed. (key = 1) * Pro forma payroll processing completed. (key = 2) * Deleted by user (key = 5) * Payroll processing cancelled by user. (key = 6) * Error during payroll processing. (key = 7) * No payroll results, payroll processing cancelled. (key = 8) * Payroll processing approved. (key = 9) | | `prn_payrollTaxReturnPeriod_periodNumber` | `int32` | | ☐ | The period number of the payroll period the record relates to | | `prn_payrollTaxReturnPeriod_year` | `int32` | | ☐ | The year of the payroll period the record relates to | | `prn_processingFinishedTime` | `datetime` | Processing Time | ☐ | Date-time when the calculations of the wages was finished | | `prn_removedBy_formattedName` | `string` | Deleted By Name | ☐ | preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `prn_removedBy_id` | `guid` | Deleted By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `prn_removedBy_initials` | `string(6)` | Deleted By Initials | ☐ | The initials of the user | | `prn_removedBy_lastName` | `string(25)` | Deleted By Last Name | ☐ | The last name of the user | | `prn_removedBy_prefix` | `string(10)` | Deleted By Name Prefix | ☐ | The prefix of the user | | `prn_removeTime` | `datetime` | Deletion Time | ☐ | The time at which the pay roll run was removed. | | `prn_requestedBy_formattedName` | `string` | Requested By Formatted Name | ☐ | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `prn_requestedBy_id` | `guid` | Requested By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `prn_requestedBy_initials` | `string(6)` | Requested By Initials | ☐ | The initials of the user | | `prn_requestedBy_lastName` | `string(25)` | Requested By Last Name | ☐ | The last name of the user | | `prn_requestedBy_prefix` | `string(10)` | Requested By Name Prefix | ☐ | The prefix of the user | | `prn_requestTime` | `datetime` | Request Time | ☐ | The time at which the payroll run was requested by the user | | `prn_sendEmailToEmployee` | `boolean` | Send Email to Employee | ☐ | Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false | | `prn_sequenceNumber` | `int32` | Sequence Number | ☐ | An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages". | | `prn_sequenceNumberApproved` | `int32` | Approved Sequence Number | ☐ | An incremental number with a payrolling year to uniquely identify an approved payroll run. | | `prn_textPayment` | `string(32)` | Payment Text | ☐ | An optional text provided by an authorized user that will be displayed as a description for the payment. | | `prn_textPaySlip` | `string(25)` | Payslip Text | ☐ | An optional text provided by an authorized user that will be displayed on the pay slip. | | `prn_textTariffPaySlip` | `string(25)` | Payslip Rate Text | ☐ | An additional text to be displayed on the tariff payslip. |