# PayrollProcessOverviewByPayrollAdministrationId Process Information about a payroll on administration level __Activity name :__ GetPayrollProcessOverviewByPayrollAdministrationId Get an overview of the status and possible actions for the specified period, including the preceding and subsequent period. The overview contains information about: payroll runs, payroll tax return and pension. __Metadata :__ Possible options for the query string parameters can be acquired (GET) via the `/metadata` endpoint. The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata`. __Defaults :__ Default values for the query string parameters can be acquired via the `/defaults` endpoint. The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults`. 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: `PayrollAdministrationProcessOverview` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `payrollAdministrationId` | `guid` | ☑ | | The unique identifier of an administration | | `payrollPeriodIdEnd` | `int32` | ☐ | | The unique identifier of the last payroll period to return | | `payrollPeriodIdStart` | `int32` | ☑ | | The unique identifier of the first payroll period to return | ## Columns The columns of the table `PayrollProcessOverviewByPayrollAdministrationId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `journal_journalPossibleActions_journalPossibleActionsAdditionalInfo_key` | `string` | | ☐ | | | `journal_journalPossibleActions_journalPossibleActionsAdditionalInfo_value` | `string` | | ☐ | | | `journal_journalPossibleActions_key` | `int32` | | ☐ | | | `journal_journalPossibleActions_value` | `string` | | ☐ | | | `journal_journalStatus_journalStatusAdditionalInfo_key` | `string` | | ☐ | | | `journal_journalStatus_journalStatusAdditionalInfo_value` | `string` | | ☐ | | | `journal_journalStatus_key` | `int32` | | ☐ | | | `journal_journalStatus_value` | `string` | | ☐ | | | `pawwDeclaration_pawwDeclarationPossibleActions_key` | `int32` | | ☐ | | | `pawwDeclaration_pawwDeclarationPossibleActions_pawwDeclarationPossibleActionsAdditionalInfo_key` | `string` | | ☐ | | | `pawwDeclaration_pawwDeclarationPossibleActions_pawwDeclarationPossibleActionsAdditionalInfo_value` | `string` | | ☐ | | | `pawwDeclaration_pawwDeclarationPossibleActions_value` | `string` | | ☐ | | | `pawwDeclaration_pawwDeclarationStatus_key` | `int32` | | ☐ | | | `pawwDeclaration_pawwDeclarationStatus_pawwDeclarationStatusAdditionalInfo_key` | `string` | | ☐ | | | `pawwDeclaration_pawwDeclarationStatus_pawwDeclarationStatusAdditionalInfo_value` | `string` | | ☐ | | | `pawwDeclaration_pawwDeclarationStatus_value` | `string` | | ☐ | | | `pawwDeclaration_pensionAdministratorType` | `string` | | ☐ | The type of Pension declaration | | `payroll_payrollPossibleActions_key` | `int32` | | ☐ | | | `payroll_payrollPossibleActions_payrollPossibleActionsAdditionalInfo_key` | `string` | | ☐ | | | `payroll_payrollPossibleActions_payrollPossibleActionsAdditionalInfo_value` | `string` | | ☐ | | | `payroll_payrollPossibleActions_value` | `string` | | ☐ | | | `payroll_payrollStatus_key` | `int32` | | ☐ | | | `payroll_payrollStatus_payrollStatusAdditionalInfo_key` | `string` | | ☐ | | | `payroll_payrollStatus_payrollStatusAdditionalInfo_value` | `string` | | ☐ | | | `payroll_payrollStatus_value` | `string` | | ☐ | | | `payroll_typeOfInitiationLastPayrollRun` | `string` | | ☐ | Indicates whether the run is completed with or withour employments. | | `payrollPeriod_payrollPeriodId` | `int32` | | ☐ | The year and period of the payroll period | | `payrollPeriod_periodEndDate` | `datetime` | Payroll Period End Date | ☐ | The last day of the period to which the payroll period data applies | | `payrollPeriod_periodNumber` | `int32` | Payroll Period Number | ☐ | The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) | | `payrollPeriod_periodStartDate` | `datetime` | Payroll Period Start Date | ☐ | The first day of the period to which the payroll period data applies | | `payrollPeriod_year` | `int32` | Payroll Processing Year Period | ☐ | The year of the payroll period | | `payrollTaxReturn_initiateIdealPayment_key` | `int32` | | ☐ | | | `payrollTaxReturn_initiateIdealPayment_value` | `string` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnPossibleActions_key` | `int32` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnPossibleActions_payrollTaxReturnPossibleActionsAdditionalInfo_key` | `string` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnPossibleActions_payrollTaxReturnPossibleActionsAdditionalInfo_value` | `string` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnPossibleActions_value` | `string` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnStatus_key` | `int32` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnStatus_payrollTaxReturnStatusAdditionalInfo_key` | `string` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnStatus_payrollTaxReturnStatusAdditionalInfo_value` | `string` | | ☐ | | | `payrollTaxReturn_payrollTaxReturnStatus_value` | `string` | | ☐ | | | `payrollTaxReturnPeriod_lastPayrollPeriodId` | `int32` | | ☐ | The year and period identifying the last payroll period that is part of the payroll tax return period. | | `payrollTaxReturnPeriod_payrollTaxReturnPeriodId` | `int32` | | ☐ | The year and period of the payroll tax return period | | `payrollTaxReturnPeriod_periodEndDate` | `datetime` | | ☐ | The last day of the period to which the payroll tax return period data applies | | `payrollTaxReturnPeriod_periodNumber` | `int32` | | ☐ | The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 13]) | | `payrollTaxReturnPeriod_periodStartDate` | `datetime` | | ☐ | The first day of the period to which the payroll tax return period data applies | | `payrollTaxReturnPeriod_year` | `int32` | | ☐ | The year of the payroll tax return period | | `pensionDeclaration_pensionAdministratorType` | `string` | | ☐ | The type of Pension declaration | | `pensionDeclaration_pensionDeclarationPossibleActions_key` | `int32` | | ☐ | | | `pensionDeclaration_pensionDeclarationPossibleActions_pensionDeclarationPossibleActionsAdditionalInfo_key` | `string` | | ☐ | | | `pensionDeclaration_pensionDeclarationPossibleActions_pensionDeclarationPossibleActionsAdditionalInfo_value` | `string` | | ☐ | | | `pensionDeclaration_pensionDeclarationPossibleActions_value` | `string` | | ☐ | | | `pensionDeclaration_pensionDeclarationStatus_key` | `int32` | | ☐ | | | `pensionDeclaration_pensionDeclarationStatus_pensionDeclarationStatusAdditionalInfo_key` | `string` | | ☐ | | | `pensionDeclaration_pensionDeclarationStatus_pensionDeclarationStatusAdditionalInfo_value` | `string` | | ☐ | | | `pensionDeclaration_pensionDeclarationStatus_value` | `string` | | ☐ | |