# JournalRunsByPayrollAdministrationId List of journal runs for an administration __Activity name :__ GetJournalRunsByPayrollAdministrationId Returns the journal runs for a payroll administration. 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 Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns - Catalog: `LoketNlRest` - Schema: `JournalRun` - Field Selection Method: NotRequired - Base Path: `_embedded[*]` 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. ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `payrollAdministrationId` | `guid` | ☑ | | The unique identifier of an administration | ## Columns of Table Function 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; * 0 Ready for journalising * 1 No journal results * 2 Error during creation * 3 Deleted by user * 4 Journal ready * 5 Being exported * 6 Export failed * 7 Journal exported | | `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. |