Skip to main content

Payroll API Overview

Summary​

Payroll Service exposes native minimal APIs, monolith-shaped compatibility APIs, and limited internal/foundation surfaces behind transitional gateway ownership.

Audience​

Frontend and backend developers, QA and support engineers, architects, security reviewers, and implementation partners.

Overview​

Implementation and route surfaces​

ASP.NET Core Minimal API groups map native Payroll run/output/report operations, compatibility operations, and foundation queries. Minimal API delegates call scoped application services or EF Core directly; no MediatR pipeline is present.

  • Direct / Shadow: native /payroll operations used for bounded-context integration and shadow verification.
  • Compatibility: /api contracts preserving existing client behavior during cutover.
  • Internal / Foundation: service identity, health, data diagnostics, periods, workforce, and input-projection inspection.
  • Primary: no separate Primary-only contract exists. Compatibility becomes client-facing when gateway ownership moves.

Bearer-authenticated, tenant-aware requests are expected, but Payroll Service does not register a complete local authentication/authorization pipeline. Exact enforcement and 401/403 behavior therefore Require confirmation. Most responses are plain JSON, files, or raw compatibility values rather than a universal envelope. Only service information uses the Shared Kernel envelope.

Gateway routing controls monolith versus Payroll Service compatibility ownership while native Payroll paths remain available as a shadow/direct surface. No URL API version is present. Swagger/OpenAPI is configured at runtime. Payroll calculation and export do not execute payment.

Source References​

  • microservices/src/payroll-service/Program.cs
  • microservices/src/payroll-service/Api/PayrollRunEndpoints.cs
  • microservices/src/payroll-service/Api/PayrollOutputEndpoints.cs
  • microservices/src/payroll-service/Api/PayrollFoundationEndpoints.cs
  • microservices/src/payroll-service/Api/PayrollCompatEndpoints.cs
  • microservices/src/gateway-api/Program.cs

See Also​

Keywords​

  • Payroll API
  • Payroll API Overview

Revision Information​

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