--- title: "Payroll status for each administration." method: GET path: "/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns/status" tags: ["Payroll process status"] --- # Payroll status for each administration. `GET /v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns/status` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns/status` - Auth: none required __Activity name :__ GetPayrollStatusByBearerToken Returns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payroll run status for an payroll period. ## Path parameters - `payrollPeriodId` integer, required ## Query parameters - `filter` string - `orderBy` string - `pageNumber` integer - `pageSize` integer ## Headers - `Authorization` string, required - `Accept` string, required ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `totalSize` integer: Total number of records, taking into account the given filter. - `pageSize` integer: Number of records in the response - `totalPages` integer: Number of pages available - `currentPage` integer: Current page returned in the response - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `_embedded` PayrollStatus[] - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employerLogo` string, url, nullable: 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. - `employerId` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the administration - `administrationNumber` string, nullable: The administration number is a free field commonly used to register the debtors number. - `description` string: The description is used to identify the administration in Loket at Employerlevel. - `clientNumber` integer: 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. - `payrollPeriodType` object: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). - `key` integer - `value` string - `hasAutomaticPayroll` boolean: Indicates whether automatic payrolling is set - `cao` object: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to. - `key` integer - `value` string - `loonmodel` object: The "loonmodel" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible. `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `groupClassification` object, nullable: The group classification for the payroll administration. This field is used for filtering and grouping within the interface. `groupClassification` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `groupCode` integer, nullable: Number (integer) used for grouping administrations. - `HasPayrollRunStatusOpen` boolean: Indicates whether the administration has an open payrolrun - `shortName` string, nullable: Shortened name of the administration - `payrollPeriod` object - `year` integer: The year of the payroll period - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) - `payrollPeriodId` integer: The year and period of the payroll period - `periodStartDate` string, date: The first day of the period to which the payroll period data applies - `periodEndDate` string, date: The last day of the period to which the payroll period data applies - `payroll` object - `methodOfCreation` object - `key` integer: The key indicating how the payroll run was created. - `value` string: The value describing how the payroll run was created. - `automaticStartDate` string, date, nullable: The set day on which the payroll is automatically started. - `automaticApproveDate` string, date, nullable: The set day on which the payroll is automatically approved. - `status` object: Status of the payroll process in the period. Possible statuses are: - 0 Invalid - 1 Not started - 2 Queued - 3 Waiting for approval - 4 Incorrect and there is an approved preceding payrollrun - 5 Incorrect - 6 Approved - 7 No results - 8 No results and there is an approved preceding payrollrun - `key` integer - `value` string - `possibleActions` object: Possible actions for the payroll process in the period. Possible actions are: - 0 None (no action possible) - 1 Ready to proces - 2 Start - 3 Restart - `key` integer - `value` string - `userRights` object - `hasStartRight` boolean: indicates whether the current user has the right for this administration. - `hasCalculateWorkingHoursRight` boolean: indicates whether the current user has the right for this administration. - `hasCancelRight` boolean: indicates whether the current user has the right for this administration. - `hasConfirmRight` boolean: indicates whether the current user has the right for this administration. - `numberOfUnreadNotifications` integer: Indicates the amount of unread notifications - `numberOfUnreadUnexpiredAnnouncements` integer: Indicates the amount of unread announcements ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)