Please enable JavaScript to view this site.

Navigation: » No topics above this level «

JournalRunsByPayrollAdministrationId

List of journal runs for an administration__Activity name :__ GetJournalRunsByPayrollAdministrationIdReturns the journal runs for a payroll administration.

Catalog: LoketNlRest

Schema: JournalRun

This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.

Select loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns

Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns

Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns

Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns

Table Function Parameters

The following parameters can be used to control the behaviour of the table function JournalRunsByPayrollAdministrationId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

payrollAdministrationId

guid

 

The unique identifier of an administration

 

Table Function Columns

The columns of the table function JournalRunsByPayrollAdministrationId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

id

guid

 

The unique identifier of an object (GUID/UUID)

journalRunStatus_key

int32

 

Possible values for the payroll run status are;* 0Staat klaar voor journaliseren* 1Geen journaal resultaten* 2Fout bij aanmaken* 3Verwijderd door gebruiker* 4Journaal gereed* 5Wordt geëxporteerd* 6Exporteren mislukt* 7Journaal geëxporteerd

journalRunStatus_value

string

 

The value describing the current status of the payroll run.

methodOfCreation_key

int32

 

 

methodOfCreation_value

string

 

 

payrollRun_payrollPeriod_periodEndDate

datetime

 

The last day of the period for which the tax return message was created

payrollRun_payrollPeriod_periodNumber

int32

 

The period number of the payroll period the record relates to

payrollRun_payrollPeriod_periodStartDate

datetime

 

The first day of the period for which the tax return message was created

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.

payrollRun_payrollPeriod_year

int32

 

The year of the payroll period the record relates to

payrollRun_payrollRunId

guid

 

The unique identifier of an object (GUID/UUID)

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.

processingFinishedTime

datetime

 

The time at which at which the journal run was finished processing

removedBy_formattedName

string

 

preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>

removedBy_id

guid

 

The unique identifier of an object (GUID/UUID)

removedBy_initials

string(6)

 

The initials of the user

removedBy_lastName

string(25)

 

The last name of the user

removedBy_prefix

string(10)

 

The prefix of the user

removeTime

datetime

 

The time at which the journal run was removed.

requestedBy_formattedName

string

 

preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>

requestedBy_id

guid

 

The unique identifier of an object (GUID/UUID)

requestedBy_initials

string(6)

 

The initials of the user

requestedBy_lastName

string(25)

 

The last name of the user

requestedBy_prefix

string(10)

 

The prefix of the user

requestTime

datetime

 

The time at which the payroll run was requested by the user

sequenceNumber

int32

 

Ascending sequence number over ALL journal runs for the payroll administration.

 

13-05-2022 15:37 Version 22.1.40-BETA+3374