Client Tutorials
Code-level examples for working with the Payroll Engine via Client Services. All tutorials are available in the PayrollEngine.Client.Tutorials repository.
Getting Started
| Tutorial |
Description |
| HelloPayrollEngineWorld |
Minimal console program that connects to the backend, reads a tenant, and prints the result — the simplest possible starting point for SDK development |
| ConsoleApplication |
Structured console application with configuration, logging, and dependency injection — the recommended starting template for custom Automator tools |
Data Access
| Tutorial |
Description |
| ClientObjectsAndServices |
Demonstrates how to query payroll objects (tenants, employees, payrolls) using typed service classes and the client object model |
| BuildDataQuery |
Shows how to construct OData-style queries with filters, field selection, ordering, and paging using the SDK query builder |
| CreateAndModifyObjects |
Covers creating, updating, and deleting payroll objects (cases, employees, regulations) through the typed service layer |
| ImportExchangeData |
Imports a full payroll exchange file (JSON) into the backend using the Exchange component — covers tenant setup, regulation import, and employee data |
Customization
| Tutorial |
Description |
| CustomCaseActions |
Implements a custom case validation action in C# with metadata attributes, digit-check logic, and integration into a regulation — see also Custom Actions |
| ExtendedObjectModel |
Extends the SDK object model with custom attributes using inheritance, enabling domain-specific properties without modifying the core model |
| PayrollConsoleExtension |
Adds a custom command to the Payroll Console by implementing the extension interface — enables automation-specific CLI commands within the standard toolchain |
Scripting
| Tutorial |
Description |
| ScriptingDevelopment |
Sets up a local scripting development environment in Visual Studio with IntelliSense, breakpoint debugging, and test execution for case and report scripts |
Reports
| Tutorial |
Description |
| TransformReportData |
Transforms and reshapes report query results in the ReportEnd script — useful for aggregations, pivots, and custom output formats |
Integration
| Tutorial |
Description |
| PayrollTestRunner |
Integrates the SDK test runner into a custom host application — enables programmatic execution of case, payrun, and report tests from within any .NET process |
| WebhookConsumer |
Receives and processes webhook events from the Payroll Engine, demonstrating event routing, payload parsing, and delegated action execution |