# PayrollPeriodPayrollRunsByPayrollAdministrationId List of all available payroll periods and runs __Activity name :__ GetPayrollPeriodsByPayrollAdministrationId Returns a list of all payroll periods available for the given payroll administration This is a read-only table function. The Loket.nl REST API may not support changing the data, or the Invantive UniversalSQL driver for Loket.nl REST does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the Loket.nl REST API. - Catalog: `LoketNlRest` - Schema: `PayrollPeriods` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `payrollAdministrationId` | `guid` | ☑ | | The unique identifier of an administration | ## Columns The columns of the table `PayrollPeriodPayrollRunsByPayrollAdministrationId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `automaticProcessing_approvePayrollRunOn` | `datetime` | | ☐ | The date on which the payroll run for this period is automatically approved (if all prerequisite are met). | | `automaticProcessing_createPayrollRunOn` | `datetime` | | ☐ | The date on which the payroll run for this period is automatically created (if all prerequisite are met). | | `automaticProcessing_hasAutomaticPayrollRunApprovalBeenExecuted` | `boolean` | | ☐ | | | `automaticProcessing_hasAutomaticPayrollRunCreationBeenExecuted` | `boolean` | | ☐ | | | `endDate` | `datetime` | End Date | ☐ | The last day of the payroll period | | `id_1` | `int32` | | ☐ | The id for this specific payroll period. | | `id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `payrollPeriodType_key` | `int32` | Payroll Processing Period Type Key | ☐ | | | `payrollPeriodType_value` | `string(50)` | Payroll Processing Period Type Value | ☐ | | | `payrollRunStatus_key` | `int32` | Payroll Processing Status Key | ☐ | The key indicating the current status of the payroll run. | | `payrollRunStatus_value` | `string` | Payroll Processing Status Value | ☐ | The value describing the current status of the payroll run. | | `periodNumber` | `int32` | | ☐ | The period number of the payroll period | | `sequenceNumber` | `int32` | Sequence Number | ☐ | An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages". | | `sequenceNumberApproved` | `int32` | Approved Sequence Number | ☐ | An incremental number with a payrolling year to uniquely identify an approved payroll run. | | `startDate` | `datetime` | Start Date | ☐ | The first day of the payroll period | | `testYear` | `boolean` | | ☐ | Indicates whether the payroll year is 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. | | `year` | `int32` | Year | ☐ | The payroll year |