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

# RunOverviewByJournalRunId: Loket.nl REST itgen_loketnl_runoverviewbyjournalrunid_plural

`read only` `REST`

- Catalog: `LoketNlRest`
- Schema: `JournalRunOverview`
- Label: itgen_loketnl_runoverviewbyjournalrunid_plural

Get journal run overview for a journal run
__Activity name :__ GetRunOverviewByJournalRunId

Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.


Can only retrieve data.

## API Source

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

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `journalrunId` | `` | [x] |  | The unique identifier of the payroll run |
| `reportDate` | `` | [x] |  | A valid booking date to be shown on the report. |
| `reportDescription` | `` | [ ] |  | Omschrijving to be shown on the overview. |
| `reportJournalNumber` | `` | [x] |  | Dagboeknummer. |
| `reportPeriodNumber` | `` | [x] |  | A valid period number to be shown on the report. |
| `reportVoucherNumber` | `` | [x] |  | Boekstuknummer. |
| `reportYear` | `` | [x] |  | A valid year to be shown on the report. |

## Table Columns

The columns of the table `RunOverviewByJournalRunId` 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 |
|---|---|---|:---:|---|---|
| `DOCUMENT` | `blob` | Document | [ ] |  |  |



## 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)

