Deprecation of 'vacation_day_balance' attribute in the GET Employees endpoint deprecation
As of April 8, 2024 the attribute ‘vacation_day_balance’ will be deprecated and removed from the GET Employees endpoint’s response, in favour of retrieving absence data from https://developer.personio.de/reference/get_company-employees-employee-id-absences-balance; This adjustment is aims to enhance usability and accuracy of the retrieved absence data as the original endpoint defaulted to returning only the balance of the highest-order absence type. The alternate endpoint (mentioned above) now offers balances for all absence types where the employee possesses a balance. We strongly advise customers and partners integrating this feature to make use of the dedicated endpoint mentioned above to prevent any integration disruptions.
Absences API - POST absence-periods allows for creation of absences with certificate requirements
The POST Absence Periods endpoint has been upgraded in a graceful manner, to accept hourly absence requests in accordance with the absence certificate requirement set on the Personio application. It is now optional to upload a certificate when creating an absence via the UI for hourly absence types, mirroring the behaviour of daily absence types. So creating an absence through the endpoint wouldn’t require uploading a certificate. However, the capability to upload a certificate itself through the endpoint remains unsupported at this time.
GET Employees endpoint - Addition of 'preferred_name' attribute
As of 8 January 2024, there will be a new field added to the response of the GET Employees endpoint i.e. 'preferred_name'. Please note that this is an additive change and will not break existing integrations.
Attendances POST endpoint - Max batch size of 100 employees per batch
The maximum number of employees whose attendances can be posted in a single POST request to this Attendances endpoint (https://developer.personio.de/reference/post_company-attendances) is set to 100, in order to maintain system stability.
Absences API - Change in pagination of Hourly Absences API endpoint
As of August 25, 2023 the Hourly Absences endpoint i.e. /company/absence-periods, has had an update to the pagination logic of responses, to match the existing API documentation i.e. the 'offset' variable has been updated to refer to a page-level offset rather a per-record-level offset, as was previously the case.
Employee API: Paginate the response of "GET Employee" when `updated_since` filter is used
Starting November 16, 2023, in order to improve the performance of the GET Employees endpoint and ensure system stability, we are introducing pagination as a mandatory feature when the updated_since
filter is used to retrieve the data.
Custom Reports API - Pagination added
Pagination can be used in the GetReport Endpoint via page and limit query parameters. The limit indicates how many employees per page should be returned. Example: /company/custom-reports/reports/{report_id}?page=2&limit=100
Custom Reports API - 'Report status' added
Provision of report status via API
Authentication API - Improved bearer token
Changed the nature of bearer token from one-time use to stable tokens
Attendance API - Added support for open-ended attendances
Changed 'end_time' in POST and PATCH endpoints to be optional