Skip to content

Provider Overview

Provider|REST API · OpenAPI 3.1
HR-tech & EOR Platforms
Providers integrate PayrollEngine into their product landscape and deliver payroll as a managed service. Typical providers include EOR platforms, payroll service bureaus, PEOs, and HCM/HRIS vendors.
Provider
REST API · OpenAPI 3.1
HTTP / JSON

What Providers Do

Providers operate the engine and connect it to their ecosystem. The REST API is the primary interface — any HTTP-capable client can integrate directly.

⚙ Deploy & Operate
Run the backend as a Docker stack or on-premise. Configure authentication, rate limiting, CORS, and audit trail settings.
🏢 Manage Tenants
Create and configure multi-tenant environments. Assign users, divisions, calendars, and payrolls per tenant.
🔗 Share Regulations
Publish shared regulations from a provider tenant to consumer tenants. Consumers reference them as payroll layers without duplication.
▶ Execute Payruns
Start synchronous or asynchronous payrun jobs via REST. Use the preview endpoint for single-employee calculations without persistence.
📥 Import & Export
Bulk-import employees and case changes. Query results with OData filters, field selection, and pagination.
📡 Receive Webhooks
Subscribe to engine events: case value changes, payrun job start and completion. Integrate with downstream systems via HTTP POST.

Required Skills

Skill Level
REST API / HTTP Required
JSON Required
Docker / Container operations Required for hosted deployments
SQL Server administration Required for on-premise
OAuth / API key management Required for secured environments

Tools

Tool Purpose
REST API Primary integration interface (OpenAPI 3.1)
Web Application Browser-based tenant and regulation management
Payroll Console CLI for import, export, and scripting operations
Admin App Desktop tool for local installation and DB management
Docker Compose Stack setup: Backend + WebApp + SQL Server

Key Configuration

Setting Description
EnableSwagger Enable Swagger UI (development only)
Authentication None / ApiKey / OAuth
MaxParallelEmployees Parallelism for payrun processing
MaxRetroPayrunPeriods Safety limit for retroactive recalculation
AuditTrail Per-category audit logging (Script, Lookup, Payrun, ...)
RateLimiting Global and per-endpoint request limits

Next Steps