This article provides all the information necessary for Personio customers participating in the alpha test for the Payroll API. Thank you for your participation.
To find out more about Personio's Alpha Testing Program, visit the article on Personio's early access opportunities, or sign up for current alpha tests and join our alpha-tester pool here: Early access to Personio product updates.
What is a public API in Personio?
APIs allow data to be exchanged between Personio and another service or tool. This way, you can build connections between Personio and your databases, or set up integrations with third-party providers that are available in the Personio Marketplace.
The Alpha Testing Procedure
|Calendar Week 2
Start of the alpha phase:
What can you do with the Payroll API in its alpha state?
The Payroll API allows you to access and leverage compensation data programmatically. This data can then be merged with other datasets, stored in a data warehouse, and/or processed in a business intelligence (BI) tool.
What data can you transfer?
In its alpha state, the API includes a “List compensations” endpoint, which allows you to retrieve a list of the following compensation and their metadata per employee for a selected interval in JSON format:
- Fixed Salary (100%)
- Recurring Compensations
- One-Time Compensations
- Filter for compensations for a specific legal entity or employee
▶︎ Filter employees by legal entity: For this, the respective legal entity ID is required. As this information is not available in any endpoint yet, you can find this ID in the URL (after “/details”) when selecting the legal entity in Settings > Legal Entities (Subcompanies).
▶︎ Calculate the effective salary: If needed, you can calculate the effective salary with the employee's weekly hours and the department's weekly hours. For this, you can retrieve the employee's weekly hours from the Employee endpoint of the Personnel data API. In addition, you can access the department's weekly hours via Settings > Departments and Teams > Departments > [Specific department]. This data is unfortunately not accessible via API yet.
What are the restrictions?
In this alpha state, the endpoint is also subject to certain restrictions:
- Hourly wages and bonuses are not supported
- The compensation data does not include any proration
Generate API Credentials
- Go to Settings > Integrations > API Credentials.
- Click Generate new credential. The new credential sidebar will appear. In the Name field, enter a meaningful name (for example, Payroll Credentials).
- Select the Read checkbox for the Payroll API.
Read more about the different checkboxes in our article on generating and managing API credentials.
- Click Generate new credential.
A message will display confirming that the new API credentials have been created.
- For the Authentication, please follow the instructions outlined in our Developer Hub.
Alternatively, you can also activate the Payroll API Read endpoint for an existing API credential. Go to Settings > Integrations > API credentials, click on a credential and select the Payroll API checkbox.
The documentation for our Payroll API alpha version is available in our Developer Hub.
As an Alpha customer, you have the opportunity to actively shape the experience for the Personio Payroll API. The feature you are testing is in the development stage, and we would love to hear your thoughts about it. The sooner we receive your feedback, we can analyze and further consider it for future improvements.
Every Alpha Tester needs to submit feedback at least ONE time during the test phase using the Typeform form below.
Provide Feedback or raise a bug via Typeform
To share your feedback with us, fill out this Typeform below.