---
title: "JournalRunsByPayrollAdministrationId (Loket.nl REST)"
description: "itgen_loketnl_journalrunsbypayrolladministrationid_plural"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/loketnl/LoketNlRest.JournalRun.JournalRunsByPayrollAdministrationId
original: https://documentation.invantive.eu/en/datamodels/loketnl/LoketNlRest.JournalRun.JournalRunsByPayrollAdministrationId
updated: 2024-06-10T18:51:26Z
license: https://documentation.invantive.eu/en/
---

# JournalRunsByPayrollAdministrationId: Loket.nl REST itgen_loketnl_journalrunsbypayrolladministrationid_plural

`read only` `REST`

- Catalog: `LoketNlRest`
- Schema: `JournalRun`
- Label: itgen_loketnl_journalrunsbypayrolladministrationid_plural

List of journal runs for an administration
__Activity name :__ GetJournalRunsByPayrollAdministrationId

Returns the journal runs for a payroll administration.


Can only retrieve data.

## API Source

- Endpoint: `/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns`
- Operation: `get /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns`

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `payrollAdministrationId` | `` | [x] |  | The unique identifier of an administration |

## Table Columns

The columns of the table `JournalRunsByPayrollAdministrationId` 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) |
| `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  |
| `journalRunStatus_value` | `varchar2` | itgen_loketnl_journalrunstatus_value | [ ] |  | The value describing the current status of the payroll run. |
| `methodOfCreation_key` | `int32` | Method of Creation Key | [ ] |  |  |
| `methodOfCreation_value` | `varchar2` | Method of Creation Value | [ ] |  |  |
| `payrollRun_payrollPeriod_periodEndDate` | `datetime` | itgen_loketnl_payrollrun_payrollperiod_periodenddate | [ ] |  | The last day of the period for which the tax return message was created |
| `payrollRun_payrollPeriod_periodNumber` | `int32` | itgen_loketnl_payrollrun_payrollperiod_periodnumber | [ ] |  | The period number of the payroll period the record relates to |
| `payrollRun_payrollPeriod_periodStartDate` | `datetime` | itgen_loketnl_payrollrun_payrollperiod_periodstartdate | [ ] |  | The first day of the period for which the tax return message was created |
| `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. |
| `payrollRun_payrollPeriod_year` | `int32` | itgen_loketnl_payrollrun_payrollperiod_year | [ ] |  | The year of the payroll period the record relates to |
| `payrollRun_payrollRunId` | `guid` | itgen_loketnl_payrollrun_payrollrunid | [ ] |  | The unique identifier of an object (GUID/UUID) |
| `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.  |
| `processingFinishedTime` | `datetime` | Processing Finished Time | [ ] |  | The time at which at which the journal run was finished processing |
| `removedBy_formattedName` | `varchar2` | Removed by Name | [ ] |  | preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
| `removedBy_id` | `guid` | Removed by ID | [ ] |  | The unique identifier of an object (GUID/UUID) |
| `removedBy_initials` | `varchar2(6)` | Removed by Initials | [ ] |  | The initials of the user |
| `removedBy_lastName` | `varchar2(25)` | Removed by Last Name | [ ] |  | The last name of the user |
| `removedBy_prefix` | `varchar2(10)` | Removed by Prefix | [ ] |  | The prefix of the user |
| `removeTime` | `datetime` | Remove Time | [ ] |  | The time at which the journal run was removed. |
| `requestedBy_formattedName` | `varchar2` | Requested by Formatted Name | [ ] |  | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
| `requestedBy_id` | `guid` | Requested by ID | [ ] |  | The unique identifier of an object (GUID/UUID) |
| `requestedBy_initials` | `varchar2(6)` | Requested by Initials | [ ] |  | The initials of the user |
| `requestedBy_lastName` | `varchar2(25)` | Requested by Last Name | [ ] |  | The last name of the user |
| `requestedBy_prefix` | `varchar2(10)` | Requested by Prefix | [ ] |  | The prefix of the user |
| `requestTime` | `datetime` | Request Time | [ ] |  | The time at which the payroll run was requested by the user |
| `sequenceNumber` | `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:

- [Loket.nl REST](/en/release-notes/drivers?driver=loket-nl-rest)

