Technical Integration

Payroll ENgine Technical Integration

---

REST API

Die Payroll Engine basiert auf dem offenen Standard OpenAPI Specification und kann von jedem REST fähigen Client genutzt werden.

---

.NET Client Application

.NET Clients können mit den Client Services die Payroll Engine auf Codebene nutzen. Beispiel für die Nutzung der Client Services sind die Payroll Console und Web Applikation.

---

Payroll Console

Die Payroll Konsole bieten verschiedene Kommandos für den Datenaustausch:

Command	Description
PayrollImport	Regulierungen, Unternehmens- und Mitarbeiterdaten (Falldaten) importieren mit Support von zip-archive
PayrollImportExcel	Regulierungen, Unternehmens- und Mitarbeiterdaten (Falldaten) in Excel-Dokumenten importieren
PayrollExport	Regulierungen, Unternehmens- und Mitarbeiterdaten (Falldaten) selektiv exportieren
Report	Data Reports to XML, Excel, and PDF
DataReport	Data Reports to JSON

---

Webhooks

Webhooks ermöglichen die Bidirektionale Kommunikation zwischen dem API-Client und dem Backend. Bei spezifischen Ereignissen ruft das Backend einen externen Endpunkt auf. Auslöser von Webhooks sind

• Specific system events like a case change or a payrun execution
• Individual trigger in automation script

Für spezfische Ereignisse im Lohnprozess, wie z.B. ein neuer Mitarbeiterfall oder der finale Lohnlauf, lassen sich Webhooks registrieren. Jede Webhook Meldung wird im System mitgeführt. Für Sonderfälle besteht die Möglichkeit einen Webhook aus einem Regulierungs-Script heraus zu initiieren.

Das Webhook Consumer Tutorial zeigt wie Meldungen der Payroll Engine an einen weiteren Dienst geleitet werden.