Payroll Reference

Summary

Complete source-backed reference documentation for Payroll, including confirmed implementation, Transitional boundaries, unsupported capabilities, and safe operating guidance.

Audience

Payroll users, developers, QA and support engineers, architects, product owners, and implementation reviewers.

Overview

Scope

This section is the concise catalog for Payroll terminology, lifecycle statuses, permissions, validation, integrations and projections, implementation state, known limitations, and source evidence. Endpoint signatures remain in API documentation, storage objects remain in database documentation, and event payloads remain in events documentation.

Payroll is Transitional because native and compatibility paths coexist. A Foundation entry is confirmed but incomplete as an end-to-end capability. Requires confirmation identifies a boundary the reviewed source does not prove. Not implemented means there is affirmative source evidence that the capability is absent; it must not be presented as planned or merely hidden.

Catalog at a glance

Question	Catalog
What does a Payroll term mean?	Terminology
Which run statuses exist and how do they change?	Statuses and lifecycle
Which UI feature strings are confirmed, and where is enforcement unknown?	Permissions
Which user and lifecycle validations are confirmed?	Validation rules
Which upstream facts are projected and which events leave Payroll?	Integration and projection catalog
What is implemented, transitional, unconfirmed, or absent?	Implementation status
Which gaps constrain production use?	Known limitations
Which source area supports each claim?	Source map

High-impact findings

• Draft, Calculated, Frozen, and native Unfrozen are confirmed run statuses; compatibility unfreeze returns data to Draft.
• Freeze is reversible and does not mean payment, accounting posting, approval, or irreversible finalization.
• UI route and screen checks are confirmed; complete API and gateway authorization enforcement Requires confirmation.
• Employee, Attendance, Leave, and Expense data are local projections. Attendance is required by native calculation; the other calculated inputs have source-defined optional behavior.
• Outbox intent is durable, but relay execution, bounded retry, dead-letter, replay ownership, and complete downstream coverage Require confirmation.
• Payment execution, accounting posting, workflow approval, irreversible finalization, Payroll-specific metrics/caching, and durable external payslip storage are Not implemented in the reviewed source.

Documentation map

• Payroll Terminology Reference
• Payroll Status and Lifecycle Reference
• Payroll Permission Reference
• Payroll Validation Rule Reference
• Payroll Integration and Projection Reference
• Payroll Implementation Status Reference
• Payroll Known Limitations Reference
• Payroll Source Map

Review rule

Use the source map when changing any catalog entry. A route name, UI label, database row, or outbox record alone is not enough to infer authorization, delivery, payment, approval, or accounting completion.

Source References

• microservices/src/payroll-service/Application/PayrollCalculationService.cs
• microservices/src/payroll-service/Application/PayrollCompatService.cs
• microservices/src/payroll-service/Application/PayrollOutputsService.cs
• microservices/src/payroll-service/Messaging/PayrollReadModelConsumer.cs
• UI/salary-ui/apps/client-hrms-portal/src/App.tsx
• UI/salary-ui/apps/client-hrms-portal/src/components/AppLayout.tsx
• UI/salary-ui/apps/client-hrms-portal/src/utils/ProtectedRoute.tsx
• UI/salary-ui/apps/client-hrms-portal/src/pages/salary/CalculateSalaryPage.tsx
• UI/salary-ui/apps/client-hrms-portal/src/pages/salary/AdvanceSalaryPage.tsx
• microservices/src/contracts/Events/PayrollCalculatedEvent.cs
• microservices/src/contracts/Events/PayslipGeneratedEvent.cs
• microservices/src/payroll-service/Infrastructure/PayrollDbContext.cs
• microservices/src/payroll-service/Program.cs
• microservices/src/payroll-service/Infrastructure/Persistence.cs
• microservices/src/shared-kernel/Extensions/ObservabilityExtensions.cs
• UI/salary-ui/apps/client-hrms-portal/src/pages/hr/PayrollFeaturePages.tsx
• UI/salary-ui/apps/client-hrms-portal/src/dashboard/DashboardPages.tsx
• UI/salary-ui/apps/client-hrms-portal/src/ess/EssPages.tsx
• microservices/docs/payroll-cutover-runbook.md
• microservices/scripts/compare-payroll-parity.ps1
• microservices/scripts/payroll-cutover-go-no-go.ps1
• microservices/scripts/smoke-payroll-cutover.ps1
• microservices/scripts/smoke-payroll.ps1
• scripts/validate-payroll-scenarios.ps1

Related Articles

• Payroll technical documentation
• Payroll API documentation

See Also

• Payroll database documentation
• Payroll events documentation

Keywords

• Payroll reference
• Payroll module

Revision Information

• Status: Draft
• Last reviewed: 2026-07-15
• Review cycle: Quarterly