Skip to main content

Payroll Workforce API

Summary​

One foundation query exposes the Payroll-local employee projection. It is not an Employee master-data API.

Audience​

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

Reference Content​

Authentication: bearer context is expected for business APIs; service-local enforcement Requires confirmation. Authorization: no endpoint-specific Payroll Service role policy is confirmed. Maturity: Foundation / Shadow.

OperationMethod and public routePurposeAuthenticationTenant contextRequest typeResponse typeSuccessMaturitySource path
List Payroll employee projectionsGET /payroll/employee-profilesRetrieve Payroll-local workforce projections.Bearer context expected; service-local enforcement Requires confirmationForwarded or explicit tenant context; exact missing-context mapping Requires confirmationQuery parametersAnonymous Payroll employee projection array200Foundationmicroservices/src/payroll-service/Api/PayrollFoundationEndpoints.cs

List Payroll employee projections​

  • API family / maturity: Payroll Workforce API; Foundation
  • Authentication / authorization: Bearer context expected; service-local enforcement Requires confirmation. No endpoint-specific role policy is confirmed.
  • Tenant context: Forwarded or explicit tenant context; exact missing-context mapping Requires confirmation.
  • Route parameters: None.
  • Query parameters: Optional tenantId.
  • Request body / type: None; Query parameters.
  • Validation: Only checks stated in the error mapping below are confirmed; model-binding failures are framework behavior and not specified as a stable contract.
  • Response body / type: Anonymous Payroll employee projection array.
  • Success / error responses: 200; No endpoint-specific error response is mapped.
  • Business behavior: Retrieve Payroll-local workforce projections.
  • State and input implications: Read-only. No input projection changes.
  • Audit and event implications: No audit side effect confirmed. No event produced.
  • Compatibility notes: Foundation shadow surface; not the Employee master contract.
  • Safe example: GET /payroll/employee-profiles → 200 []
  • Example error: No stable endpoint-specific error example is confirmed.

Family-level findings​

The projection includes identity links, organizational context, activity/status, joining and Payroll-configuration context, and synchronization metadata. Sensitive employee and compensation fields are intentionally not reproduced. There is no search, paging, active-status query, or mutation endpoint.

Source References​

  • microservices/src/payroll-service/Api/PayrollFoundationEndpoints.cs
  • microservices/src/payroll-service/Domain/PayrollEntities.cs

See Also​

Keywords​

  • Payroll API
  • Payroll Workforce API

Revision Information​

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