Schnittstellenvorgaben Lohnergebnisdatenservice

DATEV Lohnergebnisdatenservice ist eine DATEV online API. Mit dieser Schnittstelle können Lohnergebnisdaten aus LODAS oder Lohn und Gehalt an ein Drittsystem automatisiert übermittelt werden. Der Drittsystem-Anwender meldet sich für die Nutzung dieser API am DATEV-Rechenzentrum an. Ein durch den Steuerberater bereitgestelltes Zugangsmedium übernimmt die Anmeldung. Der Drittsystem-Anwender ruft dann automatisiert Lohnergebnisdaten zu Lohnabrechnungen direkt aus seiner Anwendung ab. 


 

API WORKFLOW

1. Prüfung der Berechtigungen für den Datenservice
2. Abruf der Informationen über Personalstammdaten
3. Abruf von sonstigen Informationen, die in der 3rd-Party App benötigt werden

MUST: Die Abrufe sollten in einem gesunden Verhältnis sein. Auf einen erfolgreichen Request weitere 30 GET-Requests zu produzieren, zeugt nicht von einer effizienten Integration.

ONLINE API & ENDPUNKTE für SANDBOX

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

Prüfung der Berechtigungen für den Datenservice

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

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

Hier können die Datenbestände abgefragt werden, auf die der Kunde die nötigen Berechtigungen hat. Die 3rd-Party App kann dabei für sich selbst festlegen, welche der beiden Endpunkte sie nutzt. Wird der erste Endpunkt genutzt, so gibt die API alle verfügbaren Datenbestände zurück. Dies kann insbesondere bei größeren Unternehmen zu hunderten oder tausenden von Datenwerten führen. Daher kann es auch sinnvoll sein nur den zweiten Endpunkt zu nutzen. Hier muss dann der Kunde aber eine Eingabemöglichkeit in der 3rd-Party-App für die Berater- und Mandantennummer bekommen.

MUST: Einer der beiden Endpunkte zur Abfrage der Berechtigungen für einen Datenbestand muss genutzt werden. Wird der erste Endpunkt genutzt, erwarten wir eine blätterbare Anzeige (Paging) der verfügbaren Mandantenbestände. Bei Verwendung des zweiten Endpunkts ist aufzuzeigen, wo der Kunde seine Angaben für den Datenbestand macht.

Challenges:

• Berater trägt eine ungültige Berater- & Mandantennummer ein und fragt die Berechtigung ab.

Abruf von Personalstammdaten

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

Gibt für den angeforderten Mandanten alle im Rechenzentrum verfügbaren Personalstammdaten zurück. Wenn kein Zugriff auf die angegebene Client-ID möglich ist, wird der Statuscode 403 zurückgegeben.

MUST: Die Abfrage der Personalstammdaten muss genutzt werden. Hier muss sich an die unten aufgelisteten Challenges orientiert werden. aufgezeigt werden, wo der Kunde seine Angaben für den Datenbestand macht. 

Challenges:

• Zeigen Sie, dass die Daten der richtigen Firma zugewiesen werden.
• Zeigen Sie, dass die Daten dem richtigen Mitarbeiter zugewiesen werden.
• Zeigen Sie, dass die Daten dem richtigen Monat zugewiesen werden.
• Zeigen Sie die Darstellung der Werte in Ihrem System. Sind die Werte korrekt übertragen.

Abruf von sonstigen Informationen, die in der 3rd-Party App benötigt werden

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

MUST: Zeigen Sie uns die sonstigen abgerufenen Daten.

ONLINE API & ENDPUNKTE für PRODUKTION

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

Prüfung der Berechtigungen für den Datenservice

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

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

Hier können die Datenbestände abgefragt werden, auf die der Kunde die nötigen Berechtigungen hat. Die 3rd-Party App kann dabei für sich selbst festlegen, welche der beiden Endpunkte sie nutzt. Wird der erste Endpunkt genutzt, so gibt die API alle verfügbaren Datenbestände zurück. Dies kann insbesondere bei größeren Unternehmen zu hunderten oder tausenden von Datenwerten führen. Daher kann es auch sinnvoll sein nur den zweiten Endpunkt zu nutzen. Hier muss dann der Kunde aber eine Eingabemöglichkeit in der 3rd-Party-App für die Berater- und Mandantennummer bekommen.

MUST: Einer der beiden Endpunkte zur Abfrage der Berechtigungen für einen Datenbestand muss genutzt werden. Wird der erste Endpunkt genutzt, erwarten wir eine blätterbare Anzeige (Paging) der verfügbaren Mandantenbestände. Bei Verwendung des zweiten Endpunkts ist aufzuzeigen, wo der Kunde seine Angaben für den Datenbestand macht.

Abruf von Personalstammdaten

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

Gibt für den angeforderten Mandanten alle im Rechenzentrum verfügbaren Personalstammdaten zurück. Wenn kein Zugriff auf die angegebene Client-ID möglich ist, wird der Statuscode 403 zurückgegeben.

MUST: Die Abfrage der Personalstammdaten muss genutzt werden. Hier muss sich an die unten aufgelisteten Challenges orientiert werden. aufgezeigt werden, wo der Kunde seine Angaben für den Datenbestand macht. 

Challenges:

• Zeigen Sie, dass die Daten der richtigen Firma zugewiesen werden.
• Zeigen Sie, dass die Daten dem richtigen Mitarbeiter zugewiesen werden.
• Zeigen Sie, dass die Daten dem richtigen Monat zugewiesen werden.
• Zeigen Sie die Darstellung der Werte in Ihrem System. Sind die Werte korrekt übertragen.

Abruf von sonstigen Informationen, die in der 3rd-Party App benötigt werden

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

MUST: Zeigen Sie uns die sonstigen abgerufenen Daten.

CHANGELOG