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.

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.

Backend Data Import

HTTP POST data to the backend endpoints.

• External onwed data to lookups
• Company and Employee data as case values

Console Import

Payroll Console Import with Json.

• File-Splitting
• Zip Support

.NET Client Import

Payroll-Import Komponente mit den Console-Features.

Use the exchange tools from the Client Core package (.NET only).

Backend Data Export

• GET data from backend endpoints
• Using a regulation Data Set Report

Data Report

Komplexere Datenauszüge können in einem Regulation Report gescripted werden. Mit der Web Methode ExecuteReport werden der Reportdaten in einem Data Set aufbereitet.

Console Export

• Export to Json (selective Export)
• Export Data Report to XML

.NET Client Export

Payroll-Export Komponente mit den Console-Features.

Use the exchange tools from the Client Core package (.NET only).