Technical Integration
Die Payroll Engine basiert auf dem offenen Standard OpenAPI Specification und kann von jedem REST fähigen Client genutzt werden.
.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.
Die Payroll Konsole bieten verschiedene Kommandos für den Datenaustausch:
- Data Import from JSON with file-splitting and zip-archive support
- Selective Data Export to JSON
- XML Data Report
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.
🤝 Thank you for supporting this project with a donation.
⚡ This is a pre-relase version of the initial development, please read the restrictions.
