Payroll API Documentation
Summary
Payroll Service exposes 54 verified HTTP operations across native direct/shadow, compatibility, and internal/foundation surfaces. Payment execution is outside this API.
Audience
Frontend/backend developers, QA and support engineers, architects, security reviewers, and implementation partners.
Overview
API scope and ownership
The API covers Payroll runs and calculation, reversible freeze, periods and projections, advance/overtime compatibility inputs, payslips and exports, reports, audit/timeline evidence, salary components, diagnostics, and monolith-compatible Salary/Payroll contracts.
- Direct / Shadow: 16 operations.
- Compatibility: 31 operations.
- Internal / Foundation: 7 operations.
- Primary: no separate Primary-only contract is implemented.
Business operations expect bearer and tenant context through the gateway. Complete service-local authentication, role authorization, and uniform missing-tenant behavior Require confirmation. Gateway ownership remains Transitional between the monolith and Payroll Service.
Verified exclusive endpoint inventory
| Documentation family | Unique operations |
|---|---|
| Payroll Runs API | 3 |
| Payroll Calculation API | 1 |
| Payroll Freeze and Unfreeze API | 2 |
| Payroll Periods API | 1 |
| Payroll Workforce API | 1 |
| Payroll Input Projection APIs | 2 |
| Advance and Recovery Compatibility API | 4 |
| Payroll Overtime Compatibility API | 2 |
| Structured Payslip API | 1 |
| Payslip PDF API | 1 |
| Payroll Run CSV Export API | 1 |
| Bank Export API | 2 |
| Payroll Timeline and Audit API | 2 |
| Payroll Reports API | 7 |
| Payroll Diagnostics API | 3 |
| Compatibility Payroll and Salary API | 15 |
| Compatibility Payslip APIs | 2 |
| Compatibility Salary Components API | 4 |
| Total | 54 |
Capability counts can overlap exclusive families: 3 calculation triggers, 6 freeze/unfreeze commands, 2 period/lock queries, 1 workforce query, 4 salary-component operations, 0 standalone adjustment operations, 4 advance operations, 3 structured/compatibility payslip operations, 2 PDF-capable operations, 2 bank-export operations, 3 audit/timeline operations, 3 diagnostics, 31 compatibility operations, and 7 internal/foundation operations.
Documentation map
- Payroll API Overview
- Payroll API Authentication and Context
- Payroll API Response and Error Model
- Payroll API Compatibility and Routing
- Payroll OpenAPI and Discovery
- Payroll API Testing Guide
- Payroll Runs API
- Payroll Calculation API
- Payroll Freeze and Unfreeze API
- Payroll Periods API
- Payroll Workforce API
- Payroll Input Projection APIs
- Advance and Recovery Compatibility API
- Payroll Overtime Compatibility API
- Structured Payslip API
- Payslip PDF API
- Payroll Run CSV Export API
- Bank Export API
- Payroll Timeline and Audit API
- Payroll Reports API
- Payroll Diagnostics API
- Compatibility Payroll and Salary API
- Compatibility Payslip APIs
- Compatibility Salary Components API
Current limitations
No standalone Payroll-adjustment API, run delete operation, period mutation API, API version, committed OpenAPI artifact, payment execution/reconciliation API, accounting API, Document Service storage API, payslip history API, or formal Payroll .NET test project is confirmed. Native and compatibility lifecycle/error behavior differs.
Related documentation
Source References
microservices/src/payroll-service/Program.csmicroservices/src/payroll-service/Api/PayrollRunEndpoints.csmicroservices/src/payroll-service/Api/PayrollOutputEndpoints.csmicroservices/src/payroll-service/Api/PayrollFoundationEndpoints.csmicroservices/src/payroll-service/Api/PayrollCompatEndpoints.csmicroservices/src/gateway-api/Program.cs
Related Articles
See Also
Keywords
- Payroll API
- Payroll API Documentation
Revision Information
- Status: Draft
- Last reviewed: 2026-07-15
- Review cycle: Quarterly