hr:exports

1.0.1

Information about the API

Information about the API

Introduction

The REST API hr:exports (DATEV Lohnergebnisdatenservice) enables the user to securely download payroll result data from the DATEV salary system (Lohn und Gehalt or LODAS). The available data can be used for analytics – for example to assess salary development of an employee.

Description

Many companies and their tax consultants want to run evaluations of their overall development within different timespans. The REST API hr:exports enables the companies themselves to make a conclusive statement based on data from DATEV regarding this issue. The available data comes from the DATEV payroll programs Lohn und Gehalt and LODAS. The scope of data includes master data (Stammdaten), wage types (Lohnarten), net deductions (Nettoabzüge), net payments (Nettobezüge) and result data (tax, social security, payment amount).

Implementation Information

Support for the implementation

Registration for the integration of our online APIs is possible via our registration form. The technical integration of the DATEV data services can be implemented by all interested software vendors, relevant information is available under the following link:

How to integrate a DATEV dataservice

GoBD compliance

The user has to digitize and archive documents in a GoBD-compliant manner. The data sets and electronic documents that were created at the client’s site or that were sent digitally to the user’s company have to be kept unmodifiable and in their original form within the third-party solution of the software provider as soon as they are transferred via hr:exports.

DATEV is not responsible for informing the user that a new document has been transferred to DATEV Unternehmen online or that a mistake has occurred during the transfer. After each request, the third-party solution receives a response by DATEV that has to be checked by and reported to the user.

Requirements of authorization using the OAuth procedure

Logging out of the software provider’s application must also sever the connection to the DATEV system. Following each log out, the user must sign in again to the application of the software provider and go through authentication again with DATEV. In terms of browser-based applications, this also applies every time the browser is closed.

The application of the software provider must ensure that the access token becomes invalid following a log out and that a new access token needs to be obtained. The access token must not be stored for multiple users and for multiple http-sessions. Logging in a software provider’s application in a further Browser window or another device must also go through authentication again with DATEV.

Even after the user logs out of the software provider’s application, the application can still use the access token to complete requests that have already been started. Nevertheless, the user must repeat the authentication process following a new login if the user transfers data to DATEV.

Backward-compatibility considerations

The application of the software provider must be implemented in a backward-compatible manner so that it continues to work after the following changes:

A new resource with a new URI is added.An existing resource supports a new http verb.A resource supports an additional media type that can be selected via content negotiation.The URI is changed for an existing resource, and a corresponding redirect is offered.Introduction of new, optional headers.A new, optional attribute is added to a representation.

User requirements

The user requires a DATEV authentication medium (e.g. SmartLogin) and the DATEV Lohnergebnisdatenservice contract. The tax consultant configures the user’s DATEV authentication medium accordingly to facilitate data transfer from DATEV via hr:exports.

After successful authentication and authorization, the client can fetch the desired data from the DATEV data center.