The open-source payroll automation framework.
Build multi-country, multi-industry payroll applications with configurable regulation layers.

Documentation · Quick Start · Releases · Discussions

---

What is the Payroll Engine?

The Payroll Engine is a framework for developing payroll applications. Payroll logic is not hardcoded — business rules are defined in configurable regulation layers that can be stacked, overridden, and shared between tenants. This makes the engine adaptable to any country, any industry, and any HR platform.

Who Is This For?

Role	Description	Interface
Provider	Software vendors and payroll service providers who host and operate the engine	REST API
Regulator	Payroll domain experts who define country- or industry-specific calculation rules	No-Code · C# Scripting
Automator	DevOps and integration engineers who connect the engine to HR platforms and data pipelines	.NET Client SDK

Quick Start

The engine runs as a Docker container stack — Docker is the only prerequisite.

mkdir payroll-engine && cd payroll-engine
echo "DB_PASSWORD=PayrollStrongPass789" > .env
curl -O https://raw.githubusercontent.com/Payroll-Engine/PayrollEngine/main/docker-compose.yml
docker compose up -d

Service	URL
Web Application	http://localhost:8081
Backend API	http://localhost:5001

→ Full setup guide at payrollengine.org/docs/ContainerSetup

.NET Integration

dotnet add package PayrollEngine.Client.Services

→ See Client Services for the full integration guide.

Repositories

Repository	Description
PayrollEngine	Main repo — Docker stack, examples, tests
Backend	REST API server + SQL Server persistence
WebApp	Blazor web application
PayrollConsole	CLI for automation, testing, data import
Client.Services	.NET Client SDK (NuGet entry package)
Client.Scripting	Scripting API for regulation development
Client.Test	Test runner library

→ Full repository map at payrollengine.org/docs/Repositories

License

MIT — free for any use. All third-party dependencies use MIT or Apache 2.0 licenses.