Skip to main content

Payroll Periods API

Summary​

One foundation query lists Payroll period records for a tenant. Period creation is an internal calculation side effect, not a dedicated HTTP operation.

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 periodsGET /payroll/periodsList tenant Payroll periods newest first.Bearer context expected; service-local enforcement Requires confirmationForwarded or explicit tenant context; exact missing-context mapping Requires confirmationQuery parametersPayrollPeriod[]200Foundationmicroservices/src/payroll-service/Api/PayrollFoundationEndpoints.cs

List Payroll periods​

  • API family / maturity: Payroll Periods 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: PayrollPeriod[].
  • Success / error responses: 200; No endpoint-specific error response is mapped.
  • Business behavior: List tenant Payroll periods newest first.
  • 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; no monolith-shaped equivalent documented here.
  • Safe example: GET /payroll/periods → 200 []
  • Example error: No stable endpoint-specific error example is confirmed.

Family-level findings​

Exposed fields are period identity, tenant, month, year, status, creation time, and optional close time. No HTTP period create, close, reopen, delete, or statutory-calendar operation exists. Lock/freeze status is exposed separately by compatibility Payroll.

Source References​

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

See Also​

Keywords​

  • Payroll API
  • Payroll Periods API

Revision Information​

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