Resources

Resources

Releases

A release contains the following assets:

• Payroll Engine Setup
• Scripting reference help
• Service reference help
• REST API swagger.json

The downloads are located in the Assets section:

👉 Continue to Releases

Reference Help

For runtime programming and client development, the technical reference is available for download. The Service reference help contains the complete help for Payroll client development. The Scripting reference help is a subset of the Service reference help and contains the reference for runtime scripting. After downloading and unzipping the zip file, the help is started via the file index.html.

Documents

Title	Type	Document
Payroll Engine Whitepaper	Documentation	English, German
REST API Endpoints	Documentation	English
Repository Map	Documentation	English
No-code/low-code development platform for Payroll Providers	Blog	English, German
Software for payroll service providers	Blog	English, German
Integration of the Payroll Engine	Blog	English, German
Scaling the Payroll	Blog	English, German
Regulation of wage calculation	Blog	English, German
Wage calculation with time values	Blog	English, German
Test driven payroll software	Blog	English, German
Payroll software rethought	Blog	English, German
Design of a scalable payroll software	Blog	English, German

Examples

The Examples/Setup.all.cmd command installs all examples. To install a specific example, the command <Example>/Setup.cmd can be used (read more).

Example	Description
ActionPayroll	Case Actions
CaseDefPayroll	Case definition
DerivedPayroll	Derived regulations
ExtendedPayroll	GitHub Wiki tutorial
ReportPayroll	Payroll report
SimplePayroll	Simple payroll
StartPayroll	GitHub Wiki tutorial
WeekSimplePayroll	Simple week payroll

Tests

With the command Tests/Test.all.cmd all tests are executed. For individual tests, the command <Test>/Test.cmd can be used (read more).

Test	Description
Aggregation	Period values aggregation types test
Calendar	Calendars test
Cancellation	Case cancellation types test
Case	Simple case test
CountryPayroll	Country specific function test
DerivedPayroll	Derived regulations test
ForecastPayroll	Forecast test
IncrementalPayroll	Incremental payrun results test
LunisoralCalendar	Lunisloar calendar test
Payrun	Payrun test
PayrunEmployee	Payrun employee test
Report	Report data test
RetroManualPayroll	Manual retro payrun job test
RetroPayroll	Retro payrun job test
TimeTracking	Time tracking test
VersionPayroll	Payroll versions test
WageTypeRestart	Calendar test
Calendar	Payrun with wage calculation restart test
WeekCalendar	Week calendar test

Client Tutorials

Tutorial	Description
HelloPayrollEngineWorld	Minimal payroll console program
ConsoleApplication	Payroll console program
ClientObjectsAndServices	Query payroll objects
CreateAndModifyObjects	Modify payroll objects
ImportExchangeData	Import data from JSON
ExtendedObjectModel	Object extension with custom attributes
ScriptingDevelopment	Writting and debugging scripts in Visual Studio
BuildDataQuery	Build advanced data queries
TransformReportData	Transform report queries
CustomCaseActions	Build a custom case action
WebhookConsumer	Consume and delegate webhooks