Employee

When using the Zenegy API it is possible to set up CRUD operations for employee profiles in Zenegy.

Each profile consists of three parts: Base, Employment, and Salary Data. All three parts can be managed via the API. Please note that some endpoints handle all three parts simultaneously.

Retrieve employees

The API provides several endpoints to fetch employee data. For general data retrieval, we advise using the following two endpoints:

Get employees list

All employee profile bases can be retrieve as a list via the endpoint for get employee bases list.

It is possible to filter and sort the results in this endpoint, expand the section below to get parameter details.

Parameters have to be added to the request body.

Retrieve full employee details

If data is outside of what is present in the bases is needed, use the endpoint for get employee details.

Some properties in the endpoints above can be retrieved via specific endpoints, so be sure to check if another endpoint might be better in cases where very specific pieces of data is needed.

Create and update employee/s

The API has several endpoints for employee profile creation, making it possible to only create single profiles with simple data, bulk create profiles or create full detailed single profiles.

All endpoints have the same required properties for creation of a profile:

• CPR number of employee.
• Name of employee.
• Employee's address.
• Employee's Postal code.
• Employee's city.
• Employment date.
• Seniority date.

Be aware that if an employee number is not present in the request, the system will automatically generate one using the CPR number. For example, a CPR of 0101991212 will become an employee number like 01-01-91-xxxx.

Create a single employee

To create a single employee profile use the endpoint post employee.

This endpoint can be used for creation of a simple and full employee depending on the values posted in the request.

Bulk create employee profiles

Bulk creation of employee profiles can be posted using the endpoint for post employees

When posting a valid request a response returns a list of the guid, employee number and second employee number for the created employees

Update Employee profile

Each employee can be updated using the endpoint for patch.

The endpoint uses JSON patch format to update an employee, the body of the request should be specified with only the properies that need to be changed.

When a patch request is executed the response will not return any information. This also includes patching Global value properties. Patching a global value will not update the data on the profile, and no error will be returned.

Json request example:

[
    {
        "value": "value",
        "path": "/Property",
        "op": "replace",
    }
]

Delete employees

Deletion of employee profiles can be done via the endpoint for delete employee.

Only employees who has yet to be a part of a payroll run can be deleted. Employees that has been in a payroll run should be handled as a resignation

Deleted data cannot be restored.

Tax cards

All employee tax cards for a company can be read via the endpoint for company tax card messages.

Specific employee profile tax card can be read via the endpoint for employee tax card.

The response from the company-wide endpoint is filtered using OData, and the request query can be adjusted using specific filtering parameters.

API request example using odata filter

http://localhost:55500/api/companies/0551578b-e0a0-4943-8fa6-8ad6d29c33d0/employees/4aefcbc9-9314-4e3e-b3e7-ea8357173ba1/taxcards?$filter=TypeOfCard eq '1'

Enum definitions