--- title: "Get payroll period data audit trail" method: GET path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/auditTrail/PayrollPeriodData" tags: ["Audit trail"] --- # Get payroll period data audit trail `GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/auditTrail/PayrollPeriodData` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/auditTrail/PayrollPeriodData` - Auth: none required __Activity name :__ GetPayrollPeriodDataAuditTrailByPayrollAdministrationId Get the audit trail for the payroll period data. This endpoint requires either the set of query parameters `startDate` and `endDate` or the query parameter `payrollPeriodId` to be set. Request with none or all of these three query parameters are not supported. ## Path parameters - `payrollAdministrationId` string, uuid, required ## Query parameters - `startDate` string - `endDate` string - `payrollPeriodId` integer - `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` PayrollPeriodDataAuditTrail[] - `field` Field: The application that performed the mutation - `key` integer: The key of the field - `value` string: Description of the field - `payrollComponentCategory` PayrollComponentCategory, nullable: If the field is a payroll component this field will indicate the category of the payroll component otherwise its null. Example categories are, hours/extra hours/net payment/net deduction etc. - `key` integer - `value` string - `oldValue` string, nullable: The value befor the change. Incase of an create the oldValue will be NULL. - `newValue` string, nullable: The value of the field after the change. Incase of an delete the nieuwValue will be NULL. - `timeStamp` string, date-time: The time the mutation was performed - `performedBy` UserBasic, nullable - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `initials` string: The initials of the user - `prefix` string, nullable: The prefix of the user - `lastName` string: The last name of the user - `formattedName` string: preformatted user name for displaying. \\", \"\\" \"\ - `mutationType` MutationType: The type of mutation * create (toevoegen) * update (wijzigen) * delete (verwijderen) - `key` integer: The key of the mutationType - `value` string: Description of the mutationType - `mutationOrigin` MutationOrigin: The origin of the mutation For example: * By user * Automatich process * Collective change * Import - `key` integer: The key of the mutationOrigin - `value` string: Description of the mutationOrigin - `employer` Employer3 - `id` string, uuid, nullable: The unique identifier (GUID/UUID) - `employerNumber` integer: The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API). - `companyName` string: Name of the company - `payrollAdministration` PayrollAdministration2 - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the administration - `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. - `employee` Employee4 - `id` string, uuid, nullable: The unique identifier (GUID/UUID) - `employeeNumber` integer, nullable: The employee number to uniquely identify a employee within an employer. - `name` string, nullable: The name of the employee - `employment` Employment4 - `id` string, uuid, nullable: The unique identifier (GUID/UUID) - `startDate` string, date, nullable: The date on which this employment starts. - `identification` IdentificationPayrollPeriodData, nullable: The identification of the entity record that was changed - `id` string, uuid, nullable: The ID of the entity record that was changed - `payrollPeriod` object, nullable - `year` integer: The year of the payroll period in which the payroll data is to be processed - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed. - `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 - `shift` object, nullable: The shift determines the full-time hours and bonus percentage. - `shiftNumber` integer: The number for the shift. Loket supports a maximum of 15 shifts per payroll administration. - `fullTimeHoursPerWeek` number: The full time hours for an employment that is linked to this shift. - `bonusPercentage` number: The bonus percentage used in wage calculations for the hours made in this shift. - `payslipType` object, nullable: The type of payslip (as defined by the Dutch tax authorities) - `key` integer - `value` string - `distributionUnit` object, nullable: Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center. - `key` string, uuid: The unique identifier of an object (GUID/UUID) - `code` integer - `description` string - `costCenter` object, nullable: The cost center on which the payroll period data for this record will be booked for the ledger. - `key` integer - `code` string - `description` string - `costUnit` object, nullable: The cost unit on which the data for this record will be booked for the ledger - `key` integer - `code` string - `description` string - `description` string, nullable: Extra identifying information for the mutation ## 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)