invantive documentation
Invantive Support ForumsLog In / Sign Up

PayrollAdministrationJournalRuns: Loket.nl REST Payroll Administration Journal Runs

read only

  • Catalog: LoketNlRest
  • Schema: Views
  • Label: Payroll Administration Journal Runs

Can only retrieve data.

Table Columns

The columns of the table PayrollAdministrationJournalRuns 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
jrn_id guid ID The unique identifier of an object (GUID/UUID)
jrn_journalRunStatus_key int32 itgen_loketnl_journalrunstatus_key Possible values for the payroll run status are; * 0 Staat klaar voor journaliseren * 1 Geen journaal resultaten * 2 Fout bij aanmaken * 3 Verwijderd door gebruiker * 4 Journaal gereed * 5 Wordt geëxporteerd * 6 Exporteren mislukt * 7 Journaal geëxporteerd
jrn_journalRunStatus_value varchar2 itgen_loketnl_journalrunstatus_value The value describing the current status of the payroll run.
jrn_methodOfCreation_key int32 Method of Creation Key
jrn_methodOfCreation_value varchar2 Method of Creation Value
jrn_payrollRun_payrollPeriod_periodEndDate datetime itgen_loketnl_payrollrun_payrollperiod_periodenddate The last day of the period for which the tax return message was created
jrn_payrollRun_payrollPeriod_periodNumber int32 itgen_loketnl_payrollrun_payrollperiod_periodnumber The period number of the payroll period the record relates to
jrn_payrollRun_payrollPeriod_periodStartDate datetime itgen_loketnl_payrollrun_payrollperiod_periodstartdate The first day of the period for which the tax return message was created
jrn_payrollRun_payrollPeriod_testYear char itgen_loketnl_payrollrun_payrollperiod_testyear 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 itgen_loketnl_payrollrun_payrollperiod_year The year of the payroll period the record relates to
jrn_payrollRun_payrollRunId guid itgen_loketnl_payrollrun_payrollrunid The unique identifier of an object (GUID/UUID)
jrn_payrollRun_sequenceNumberApproved int32 itgen_loketnl_payrollrun_sequencenumberapproved 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 Finished Time The time at which at which the journal run was finished processing
jrn_removedBy_formattedName varchar2 Removed by Name preformatted user name for displaying. <lastname>", "<initials>" "<prefix>
jrn_removedBy_id guid Removed by ID The unique identifier of an object (GUID/UUID)
jrn_removedBy_initials varchar2(6) Removed by Initials The initials of the user
jrn_removedBy_lastName varchar2(25) Removed by Last Name The last name of the user
jrn_removedBy_prefix varchar2(10) Removed by Prefix The prefix of the user
jrn_removeTime datetime Remove Time The time at which the journal run was removed.
jrn_requestedBy_formattedName varchar2 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 varchar2(6) Requested by Initials The initials of the user
jrn_requestedBy_lastName varchar2(25) Requested by Last Name The last name of the user
jrn_requestedBy_prefix varchar2(10) Requested by 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 varchar2(24) City City of the address
pan_address_country_isoCode varchar2(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 varchar2(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 varchar2 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 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.
pan_address_location varchar2(35) Location The location like to further specify the address
pan_address_postalCode varchar2(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 varchar2(50) Address Province Value The name of the province. Only the Dutch provices are supported and not translated
pan_address_street varchar2(24) Street Streetname of the address
pan_administrationNumber varchar2(15) Administration Number The administration number is a free field commonly used to register the debtors number.
pan_cao_key int32 CAO Key
pan_cao_value varchar2(50) CAO Value
pan_claTaxReturnCBSCode int32 itgen_loketnl_clataxreturncbscode 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 Client 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 varchar2(50) Contact Name Name of the contact of the administration
pan_contact_phoneNumber varchar2(15) Phone Number The general phone number of the administration
pan_description varchar2(50) Description Description of the administration
pan_deviatingPostalAddress_city varchar2(24) Deviating Postal Address City City of the address
pan_deviatingPostalAddress_country_isoCode varchar2(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 varchar2(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 varchar2 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 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.
pan_deviatingPostalAddress_location varchar2(35) Deviating Postal Address Location The location like to further specify the address
pan_deviatingPostalAddress_poBox int32 Deviating Postal Address Post Office Box Post office box
pan_deviatingPostalAddress_postalCode varchar2(9) Deviating Postal Address Postal Code The postal code of the address, only nullable if country is not The Netherlands (NL).
pan_deviatingPostalAddress_street varchar2(24) Deviating Postal Address Street Streetname of the address
pan_employerId guid itgen_loketnl_employerid 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 itgen_loketnl_groupclassification_key
pan_groupClassification_value varchar2 itgen_loketnl_groupclassification_value
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 itgen_loketnl_loonmodel_key
pan_loonmodel_value varchar2(50) itgen_loketnl_loonmodel_value
pan_name varchar2(70) Name Name of the administration
pan_payrollPeriodType_key int32 Payroll Period Type Key
pan_payrollPeriodType_value varchar2(50) Payroll Period Type Value
pan_payrollTaxesNumber varchar2(12) itgen_loketnl_payrolltaxesnumber The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
pan_shortName varchar2(12) Short Name Shortened name of the administration
pan_startDate datetime Start Date The first day the payroll administration is active.

Release Notes

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