Skip to content

Payroll Engine Roles

PayrollEngine exposes three APIs, each designed for a specific role in the payroll ecosystem.

Provider
⬡ REST API · OpenAPI 3.1
Hosts and operates the engine. Delivers payroll infrastructure as a managed service to tenants and consumers.
REST API Tenant Mgmt Docker Reg. Sharing
Regulator
⬡ Scripting API · C# 14
Encodes payroll domain knowledge into versioned regulations — Cases, WageTypes, Collectors, Lookups, Reports.
No-Code C# Scripts Regulations Testing
Automator
⬡ Client Services · .NET 10
Integrates the engine into surrounding systems and automates operational workflows using the .NET SDK.
NuGet SDK JSON Exchange CI/CD Webhooks

Roles at a Glance

Criterion Provider Regulator Automator
Audience EOR, Bureau, HCM-Vendor Payroll domain expert DevOps, Tool-Builder
Skills REST / Integration Domain + optional C# .NET / CLI
Goal Payroll as a service Define payroll rules Automate & extend
Perspective Outside-in Inside the engine Around the engine
Typical task Connect HR systems Wage types, scripts Batch runs, pipelines
API REST API No-Code / Low-Code API .NET SDK
Technology HTTP / JSON C# scripting syntax .NET / CLI

Choosing the Right API

I want to... Role API
Integrate payroll into my HR system Provider REST API
Import or export payroll data Provider REST API
Define wage types and calculation rules Regulator Scripting API
Create or review regulation scripts Regulator Scripting API
Build custom actions for payroll cases Regulator Scripting API
Automate payroll runs via CLI Automator Client Services
Build tools or LLM pipelines Automator Client Services
Extend the platform with .NET clients Automator Client Services

How the APIs Relate

The APIs operate at different layers. The REST API is the central gateway to the engine. The .NET SDK wraps the REST API as a convenience layer for .NET consumers. The No-Code and Low-Code APIs live inside the engine and are invoked during payroll processing — they define the calculation behavior.

Provider  ──► REST API ──► PayrollEngine ──► No-Code API  (Regulator)
                                         └── Low-Code API (Regulator)
Automator ──► .NET SDK  ──► REST API

Solution Architecture

Layer Stack
Automator
Client Services SDK .NET 10 · NuGet
↕
Regulator
Scripting API C# 14 · Roslyn
↕
Provider
REST API OpenAPI 3.1 · JSON
↓
Backend
Payroll Engine Backend ASP.NET Core 10
↓
Persistence
SQL Server 2017+ · ~65 Tables

Learn More