Client Services
The PayrollEngine.Client.Services library is the .NET SDK for Payroll Engine client development.
It provides the complete runtime infrastructure for executing payroll scripting functions locally
against a live backend — enabling local script development and testing without deploying to the server.
Service Layer
The service layer provides typed access to every Payroll Engine REST API resource.
Service Interfaces
| Namespace |
Description |
| PayrollEngine.Client.Service |
Service interfaces for all payroll resources: ICaseService, IEmployeeService, IWageTypeService, ICollectorService, IPayrunService, IReportService, and more. Also contains service context types (CaseServiceContext, EmployeeServiceContext, …) |
Service Implementations
| Namespace |
Description |
| PayrollEngine.Client.Service.Api |
Concrete HTTP-based implementations of all service interfaces. Handles serialization, query parameters, and REST communication with the backend |
Scripting Runtime
The runtime layer bridges the scripting function contract with the live backend.
| Namespace |
Description |
| PayrollEngine.Client.Scripting |
Function classes, runtime interfaces, No-Code action attributes and infrastructure (from PayrollEngine.Client.Scripting) |
| PayrollEngine.Client.Scripting.Runtime.Api |
Concrete runtime implementations for every scripting function type: CaseAvailableRuntime, CaseBuildRuntime, WageTypeValueRuntime, CollectorApplyRuntime, ReportBuildRuntime, and all payrun lifecycle runtimes. Each runtime implements the corresponding IRuntime interface and handles all backend API calls on behalf of the executing script |
Test Infrastructure
Client Infrastructure
| Namespace |
Description |
| PayrollEngine.Client |
HTTP client (PayrollHttpClient), REST API endpoint definitions for all resources, console base classes (ConsoleProgram<TApp>, ConsoleToolBase), and connection configuration |
| PayrollEngine.Client.Model |
Payroll domain model: Tenant, Employee, Division, Regulation, Case, CaseField, WageType, Collector, Payrun, PayrunJob, Report, and all result types |
| PayrollEngine.Client.Exchange |
Exchange import/export model and visitor pattern for bulk regulation data transfer |
| PayrollEngine.Client.QueryExpression |
Fluent query expression builder for constructing REST API filter, order, and pagination parameters |
| PayrollEngine.Client.Command |
CLI command base classes used by Payroll Engine command-line tools |
| PayrollEngine.Client.Script |
Script parsers for extracting and injecting function source code in regulation objects |
Shared Core
| Namespace |
Description |
| PayrollEngine |
Fundamental shared types: enumerations, calendar utilities (CalendarTimeUnit, CalendarWeekMode), value types, and extension methods used across all Payroll Engine libraries |
Links