# PayrollStatusByBearerToken Payroll status for each administration. __Activity name :__ GetPayrollStatusByBearerToken Returns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payroll run status for an payroll period. 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: `PayrollProcessStatus` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `payrollPeriodId` | `int32` | ☐ | | The unique identifier of the payroll period to return. | ## Columns The columns of the table `PayrollStatusByBearerToken` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `administrationNumber` | `string(15)` | Administration Number | ☐ | The administration number is a free field commonly used to register the debtors number. | | `cao_key` | `int32` | Collective Labour Agreement Key | ☐ | | | `cao_value` | `string(50)` | Collective Labour Agreement Value | ☐ | | | `clientNumber` | `int32` | Customer Number | ☐ | The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. | | `description` | `string` | Description | ☐ | The description is used to identify the administration in Loket.nl at Employerlevel. | | `employerId` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `employerLogo` | `string` | Employer Logo | ☐ | The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. | | `groupClassification_key` | `int32` | | ☐ | | | `groupClassification_value` | `string` | | ☐ | | | `groupCode` | `int64` | Group Code | ☐ | Number (integer) used for grouping administrations. | | `hasAutomaticPayroll` | `boolean` | | ☐ | Indicates whether automatic payrolling is set | | `id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `loonmodel_key` | `int32` | | ☐ | | | `loonmodel_value` | `string(50)` | | ☐ | | | `name` | `string(70)` | Name | ☐ | Name of the administration | | `payroll_methodOfCreation_key` | `int32` | | ☐ | The key indicating how the payroll run was created. | | `payroll_methodOfCreation_value` | `string` | | ☐ | The value describing how the payroll run was created. | | `payroll_possibleActions_additionalInformation_key` | `int32` | | ☐ | The key of the additional information | | `payroll_possibleActions_additionalInformation_value` | `string` | | ☐ | The additional information on the possible action. | | `payroll_possibleActions_key` | `int32` | | ☐ | | | `payroll_possibleActions_value` | `string` | | ☐ | | | `payroll_status_key` | `int32` | | ☐ | | | `payroll_status_value` | `string` | | ☐ | | | `payroll_userRights_hasCalculateWorkingHoursRight` | `boolean` | | ☐ | indicates whether the current user has the right for this administration. | | `payroll_userRights_hasCancelRight` | `boolean` | | ☐ | indicates whether the current user has the right for this administration. | | `payroll_userRights_hasConfirmRight` | `boolean` | | ☐ | indicates whether the current user has the right for this administration. | | `payroll_userRights_hasStartRight` | `boolean` | | ☐ | indicates whether the current user has the right for this administration. | | `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 | | `payrollPeriodType_key` | `int32` | Payroll Processing Period Type Key | ☐ | | | `payrollPeriodType_value` | `string(50)` | Payroll Processing Period Type Value | ☐ | | | `shortName` | `string(12)` | Short Name | ☐ | Shortened name of the administration |