# PayrollAdministrationJournalRuns 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 `PayrollAdministrationJournalRuns` 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 | | `jrn_id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `jrn_journalRunStatus_key` | `int32` | | ☐ | Possible values for the payroll run status are; * 0 Ready for journalising * 1 No journal results * 2 Error during creation * 3 Deleted by user * 4 Journal ready * 5 Being exported * 6 Export failed * 7 Journal exported | | `jrn_journalRunStatus_value` | `string` | | ☐ | The value describing the current status of the payroll run. | | `jrn_methodOfCreation_key` | `int32` | Creation Method Key | ☐ | | | `jrn_methodOfCreation_value` | `string` | Creation Method Value | ☐ | | | `jrn_payrollRun_payrollPeriod_periodEndDate` | `datetime` | | ☐ | The last day of the period for which the tax return message was created | | `jrn_payrollRun_payrollPeriod_periodNumber` | `int32` | | ☐ | The period number of the payroll period the record relates to | | `jrn_payrollRun_payrollPeriod_periodStartDate` | `datetime` | | ☐ | The first day of the period for which the tax return message was created | | `jrn_payrollRun_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. | | `jrn_payrollRun_payrollPeriod_year` | `int32` | | ☐ | The year of the payroll period the record relates to | | `jrn_payrollRun_payrollRunId` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `jrn_payrollRun_sequenceNumberApproved` | `int32` | | ☐ | Ascending sequence number related to an approved payrol run. A payroll run may have more than one journal run. With this number the journal run may be linked to the specific payroll run. | | `jrn_processingFinishedTime` | `datetime` | Processing Time | ☐ | The time at which at which the journal run was finished processing | | `jrn_removedBy_formattedName` | `string` | Deleted By Name | ☐ | preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `jrn_removedBy_id` | `guid` | Deleted By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `jrn_removedBy_initials` | `string(6)` | Deleted By Initials | ☐ | The initials of the user | | `jrn_removedBy_lastName` | `string(25)` | Deleted By Last Name | ☐ | The last name of the user | | `jrn_removedBy_prefix` | `string(10)` | Deleted By Name Prefix | ☐ | The prefix of the user | | `jrn_removeTime` | `datetime` | Deletion Time | ☐ | The time at which the journal run was removed. | | `jrn_requestedBy_formattedName` | `string` | Requested By Formatted Name | ☐ | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `jrn_requestedBy_id` | `guid` | Requested By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `jrn_requestedBy_initials` | `string(6)` | Requested By Initials | ☐ | The initials of the user | | `jrn_requestedBy_lastName` | `string(25)` | Requested By Last Name | ☐ | The last name of the user | | `jrn_requestedBy_prefix` | `string(10)` | Requested By Name Prefix | ☐ | The prefix of the user | | `jrn_requestTime` | `datetime` | Request Time | ☐ | The time at which the payroll run was requested by the user | | `jrn_sequenceNumber` | `int32` | Sequence Number | ☐ | Ascending sequence number over ALL journal runs for the payroll administration. | | `pan_address_city` | `string(24)` | City | ☐ | City of the address | | `pan_address_country_isoCode` | `string(2)` | Country ISO Code | ☐ | The ISO 3166-1 alpha-2 value for the country | | `pan_address_country_key` | `int32` | Country Key | ☐ | The key for the country. Possible values can be aquired via the metadata endpoint | | `pan_address_country_value` | `string(50)` | Country Value | ☐ | The name of the country | | `pan_address_furtherIndication_key` | `int32` | Address Further Indication Key | ☐ | The key of the further indication. Possible values can be aquired via the metadata endpoint | | `pan_address_furtherIndication_value` | `string` | Address Further Indication Value | ☐ | The description of the further indication, the possible values are "WW" and "AB" | | `pan_address_houseNumber` | `int32` | House Number | ☐ | House number of the address | | `pan_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. | | `pan_address_location` | `string(35)` | Location | ☐ | The location like to further specify the address | | `pan_address_postalCode` | `string(9)` | Postal Code | ☐ | The postal code of the address | | `pan_address_province_key` | `int32` | Address Province Key | ☐ | The key for the province. Possible values can be aquired via the metadata endpoint | | `pan_address_province_value` | `string(50)` | Address Province Value | ☐ | The name of the province. Only the Dutch provices are supported and not translated | | `pan_address_street` | `string(24)` | Street | ☐ | Streetname of the address | | `pan_administrationNumber` | `string(15)` | Administration Number | ☐ | The administration number is a free field commonly used to register the debtors number. | | `pan_cao_key` | `int32` | Collective Labour Agreement Key | ☐ | | | `pan_cao_value` | `string(50)` | Collective Labour Agreement Value | ☐ | | | `pan_claTaxReturnCBSCode` | `int32` | | ☐ | The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes. If no CLA is applicable than is field may be filled with value 9999. Please also note that this value might be empty (this is not recommended but it's possible). | | `pan_clientNumber` | `int32` | Customer Number | ☐ | 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. | | `pan_contact_name` | `string(50)` | Contact Person Name | ☐ | Name of the contact of the administration | | `pan_contact_phoneNumber` | `string(15)` | Phone Number | ☐ | The general phone number of the administration | | `pan_description` | `string(50)` | Description | ☐ | Description of the administration | | `pan_deviatingPostalAddress_city` | `string(24)` | Deviating Postal Address City | ☐ | City of the address | | `pan_deviatingPostalAddress_country_isoCode` | `string(2)` | Deviating Postal Address Country ISO Code | ☐ | The ISO 3166-1 alpha-2 value for the country | | `pan_deviatingPostalAddress_country_key` | `int32` | Deviating Postal Address Country Key | ☐ | The key for the country. Possible values can be aquired by the metadata endpoint | | `pan_deviatingPostalAddress_country_value` | `string(50)` | Deviating Postal Address Country Value | ☐ | The name of the country | | `pan_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 | | `pan_deviatingPostalAddress_furtherIndication_value` | `string` | Deviating Postal Address Further Indication Value | ☐ | The description of the further indication, the possible values are "WW" and "AB" | | `pan_deviatingPostalAddress_houseNumber` | `int32` | Deviating Postal Address House Number | ☐ | House number of the address | | `pan_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. | | `pan_deviatingPostalAddress_location` | `string(35)` | Deviating Postal Address Location | ☐ | The location like to further specify the address | | `pan_deviatingPostalAddress_poBox` | `int32` | Deviating Postal Address PO Box | ☐ | Post office box | | `pan_deviatingPostalAddress_postalCode` | `string(9)` | Deviating Postal Address Postal Code | ☐ | The postal code of the address, only nullable if country is not The Netherlands (NL). | | `pan_deviatingPostalAddress_street` | `string(24)` | Deviating Postal Address Street | ☐ | Streetname of the address | | `pan_employerId` | `guid` | | ☐ | The id of the employer to which this payrolladministration belongs. | | `pan_endDate` | `datetime` | End Date | ☐ | The last day the payroll administration is active. | | `pan_groupClassification_key` | `int32` | | ☐ | | | `pan_groupClassification_value` | `string` | | ☐ | | | `pan_groupCode` | `int32` | Group Code | ☐ | Number (integer) used for grouping administrations. | | `pan_id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `pan_loonmodel_key` | `int32` | | ☐ | | | `pan_loonmodel_value` | `string(50)` | | ☐ | | | `pan_name` | `string(70)` | Name | ☐ | Name of the administration | | `pan_payrollPeriodType_key` | `int32` | Payroll Processing Period Type Key | ☐ | | | `pan_payrollPeriodType_value` | `string(50)` | Payroll Processing Period Type Value | ☐ | | | `pan_payrollTaxesNumber` | `string(12)` | | ☐ | The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst. | | `pan_shortName` | `string(12)` | Short Name | ☐ | Shortened name of the administration | | `pan_startDate` | `datetime` | Start Date | ☐ | The first day the payroll administration is active. |