JournalRunByJournalRunId: Loket.nl REST itgen_loketnl_journalrunbyjournalrunid_plural
read only REST
- Catalog:
LoketNlRest - Schema:
JournalRun - Label: itgen_loketnl_journalrunbyjournalrunid_plural
Details of a journal run Activity name : GetJournalRunByJournalRunId
Returns the details of a journal run.
Can only retrieve data.
API Source
- Endpoint:
/providers/employers/payrolladministrations/journalruns/{journalrunId} - Operation:
get /providers/employers/payrolladministrations/journalruns/{journalrunId}
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
journalrun |
`` | The unique identifier of the payroll run |
Table Columns
The columns of the table JournalRunByJournalRunId 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 |
|---|---|---|---|---|---|
id |
guid |
ID | The unique identifier of an object (GUID/UUID) | ||
journal |
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 | ||
journal |
varchar2 |
itgen_loketnl_journalrunstatus_value | The value describing the current status of the payroll run. | ||
method |
int32 |
Method of Creation Key | |||
method |
varchar2 |
Method of Creation Value | |||
payroll |
datetime |
itgen_loketnl_payrollrun_payrollperiod_periodenddate | The last day of the period for which the tax return message was created | ||
payroll |
int32 |
itgen_loketnl_payrollrun_payrollperiod_periodnumber | The period number of the payroll period the record relates to | ||
payroll |
datetime |
itgen_loketnl_payrollrun_payrollperiod_periodstartdate | The first day of the period for which the tax return message was created | ||
payroll |
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. | ||
payroll |
int32 |
itgen_loketnl_payrollrun_payrollperiod_year | The year of the payroll period the record relates to | ||
payroll |
guid |
itgen_loketnl_payrollrun_payrollrunid | The unique identifier of an object (GUID/UUID) | ||
payroll |
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. | ||
processing |
datetime |
Processing Finished Time | The time at which at which the journal run was finished processing | ||
removed |
varchar2 |
Removed by Name | preformatted user name for displaying. <lastname>", "<initials>" "<prefix> | ||
removed |
guid |
Removed by ID | The unique identifier of an object (GUID/UUID) | ||
removed |
varchar2 |
Removed by Initials | The initials of the user | ||
removed |
varchar2 |
Removed by Last Name | The last name of the user | ||
removed |
varchar2 |
Removed by Prefix | The prefix of the user | ||
remove |
datetime |
Remove Time | The time at which the journal run was removed. | ||
requested |
varchar2 |
Requested by Formatted Name | preformated user name for displaying. <lastname>", "<initials>" "<prefix> | ||
requested |
guid |
Requested by ID | The unique identifier of an object (GUID/UUID) | ||
requested |
varchar2 |
Requested by Initials | The initials of the user | ||
requested |
varchar2 |
Requested by Last Name | The last name of the user | ||
requested |
varchar2 |
Requested by Prefix | The prefix of the user | ||
request |
datetime |
Request Time | The time at which the payroll run was requested by the user | ||
sequence |
int32 |
Sequence Number | Ascending sequence number over ALL journal runs for the payroll administration. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: