PayrollEngine.Client.Services 0.10.0-beta.1

Payroll Engine Client Services

Part of the Payroll Engine open-source payroll automation framework. Full documentation at payrollengine.org.

The main SDK for Payroll Engine client development. It provides the complete runtime infrastructure for executing payroll scripting functions locally, enabling local script development and testing against a live backend without deploying to the server.

Dependencies included:

• PayrollEngine.Client.Scripting — function API and No-Code actions
• PayrollEngine.Client.Test — case, payrun, and report test runners

Architecture

The library is organized into three areas:

Scripting

Period and cycle implementations used for local function execution:

PayrollPeriodExtensions adds GetDatePeriod(), GetOffsetDatePeriod(), and GetContinuePeriods() to IPayrollPeriod.

Scripting.Function.Api

Controllers and invokers for executing scripting functions locally against a live backend via PayrollHttpClient:

Supported function types:

ReportParameterParser resolves identifier-based report parameters (employee, regulation, payroll, payrun, webhook, report) to their corresponding database IDs before execution.

Scripting.Runtime.Api

Concrete runtime implementations for every scripting function type. Each runtime implements the corresponding IRuntime interface from the Scripting library and handles API calls to the backend:

• Base runtimes: RuntimeBase → PayrollRuntime → CaseRuntimeBase, PayrunRuntimeBase, CollectorRuntimeBase, WageTypeRuntimeBase, ReportRuntime
• Leaf runtimes: one per function event — CaseAvailableRuntime, CaseBuildRuntime, CaseValidateRuntime, CaseRelationBuildRuntime, CaseRelationValidateRuntime, CollectorStartRuntime, CollectorApplyRuntime, CollectorEndRuntime, WageTypeValueRuntime, WageTypeResultRuntime, PayrunStartRuntime, PayrunEndRuntime, PayrunEmployeeAvailableRuntime, PayrunEmployeeStartRuntime, PayrunEmployeeEndRuntime, PayrunWageTypeAvailableRuntime, ReportBuildRuntime, ReportStartRuntime, ReportEndRuntime

Culture and calendar resolution follows the standard priority: employee → division → tenant.

Webhooks are not supported through the client runtime. Calls to InvokeWebhook throw NotSupportedException.

Local Script Development

The SDK is the foundation for running function scripts outside the backend. Usage pattern:

// 1. Configure the scripting context
var config = new ScriptConfiguration
{
    EvaluationDate = DateTime.UtcNow,
    PeriodDate = new DateTime(2026, 3, 1, 0, 0, 0, DateTimeKind.Utc),
    RegulationDate = DateTime.UtcNow,
    CultureName = "de-CH"
};

// 2. Invoke via the function invoker
var httpClient = new PayrollHttpClient(backendUrl);
var invoker = new CaseAvailableFunctionInvoker<MyCaseAvailableFunction>(httpClient, config);
var result = invoker.Available("MySalaryCase");

Console.WriteLine($"Available: {result.Available}");

For report parameter resolution before invoking:

var parser = new ReportParameterParser(httpClient, tenantId, regulationId);
await parser.ParseParametersAsync(parameters); // resolves names → IDs

Developer Reference

The HTML API reference is generated with docfx. Commands in the docfx folder:

NuGet Package

Available on NuGet.org:

dotnet add package PayrollEngine.Client.Services

Build

Environment variable used during build:

Third Party Components

• Documentation generation with docfx — license MIT

See Also

• Client Services — Automator role documentation
• Client Scripting — scripting function API
• Client Test — test library
• Payroll Console — CLI tool using this SDK