Interface requirements Lohnergebnisdatenservice

DATEV Lohnergebnisdatenservice is a DATEV online API. This interface can be used to automatically transfer wage results data from LODAS or Lohn und Gehalt to a third-party system. The third-party system user logs on to the DATEV datacenter to use this API. An access medium provided by the tax consultant takes over the registration. The third-party system user then automatically retrieves payroll data directly from their application. 


 

API WORKFLOW

  1. Check the authorizations for the data service
  2. Retrieving information about personnel master data
  3. Retrieval of other information required in the 3rd party app
MUST: The retrievals should be in a healthy ratio. Producing another 30 GET requests for one successful request is not a sign of efficient integration.

ONLINE API & ENDPOINTS for SANDBOX

(Base URL: https://api-name.api.datev.de/platform-sandbox/)

Check the authorizations for the data service

GET https://hr-exports.../clients
GET https://hr-exports.../clients/client-id

The databases to which the customer has the necessary authorizations can be queried here. The 3rd party app can determine for itself which of the two endpoints it uses. If the first endpoint is used, the API returns all available databases. This can lead to hundreds or thousands of data values, especially for larger companies. It can therefore also make sense to only use the second endpoint. In this case, however, the customer must be given an input option in the 3rd party app for the consultant and client number.

MUST: One of the two endpoints for querying the authorizations for a dataset must be used. If the first endpoint is used, we expect a scrollable display (paging) of the available client databases. If the second endpoint is used, it must be shown where the customer enters their details for the dataset.


Challenges:

  • Consultant enters an invalid consultant & client number and queries authorization.


 

Retrieval of personnel master data

GET https://hr-exports.../clients/{client-id}...masterdata

Returns all HR master data available in the datacenter for the requested client. If access to the specified client ID is not possible, the status code 403 is returned.

MUST: The HR master data query must be used. The challenges listed below must be used as a guide here. show where the client provides their details for the database.


Challenges:

  • Show that the data is assigned to the correct company.
  • Show that the data is assigned to the correct employee
  • Show that the data is assigned to the correct month.
  • Show that the values are displayed in your system. Are the values transferred correctly.

Retrieve other information that is required in the 3rd party app

GET https://hr-exports.../clients/{client-id}/...
MUST: Show us the other data retrieved.



 

ONLINE API & END POINTS for PRODUCTION

(Base URL: https://api-name.api.datev.de/platform/)

Check the authorizations for the data service

GET https://hr-exports.../clients
GET https://hr-exports.../clients/client-id

The databases to which the customer has the necessary authorizations can be queried here. The 3rd party app can determine for itself which of the two endpoints it uses. If the first endpoint is used, the API returns all available databases. This can lead to hundreds or thousands of data values, especially for larger companies. It can therefore also make sense to only use the second endpoint. In this case, however, the customer must be given an input option in the 3rd party app for the consultant and client number.

MUST: One of the two endpoints for querying the authorizations for a dataset must be used. If the first endpoint is used, we expect a scrollable display (paging) of the available client databases. If the second endpoint is used, it must be shown where the customer enters their details for the dataset.


 

Retrieval of personnel master data

GET https://hr-exports.../clients/{client-id}...masterdata

Returns all HR master data available in the datacenter for the requested client. If access to the specified client ID is not possible, the status code 403 is returned.

MUST: The HR master data query must be used. The challenges listed below must be used as a guide here. show where the client provides their details for the database.


Challenges:

  • Show that the data is assigned to the correct company.
  • Show that the data is assigned to the correct employee
  • Show that the data is assigned to the correct month.
  • Show that the values are displayed in your system. Are the values transferred correctly.


 

Retrieval of other information required in the 3rd party app

GET https://hr-exports.../clients/{client-id}/...
MUST: Show us the other data retrieved.



 

CHANGELOG

Version

Date

Changes

1.011.04.2024First release