Skip to main content

Payroll Overtime Compatibility API

Summary​

Two compatibility operations add and retrieve manual overtime entries used as Payroll calculation input.

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: Compatibility / Transitional.

OperationMethod and public routePurposeAuthenticationTenant contextRequest typeResponse typeSuccessMaturitySource path
Add overtime entryPOST /api/overtimePersist a manual overtime input.Bearer expected by the compatibility contract; downstream enforcement Requires confirmationForwarded tenant context expected; no tenant query parameterOvertimeCompatRequestAnonymous overtime object200Compatibilitymicroservices/src/payroll-service/Api/PayrollCompatEndpoints.cs
List employee overtimeGET /api/overtime/{laborId:int}List manual overtime entries for employee and period.Bearer expected by the compatibility contract; downstream enforcement Requires confirmationForwarded tenant context expected; no tenant query parameterRoute and query parametersAnonymous overtime array200Compatibilitymicroservices/src/payroll-service/Api/PayrollCompatEndpoints.cs

Add overtime entry​

  • API family / maturity: Payroll Overtime Compatibility API; Compatibility
  • Authentication / authorization: Bearer expected by the compatibility contract; downstream enforcement Requires confirmation. No endpoint-specific role policy is confirmed.
  • Tenant context: Forwarded tenant context expected; no tenant query parameter.
  • Route parameters: None.
  • Query parameters: None.
  • Request body / type: laborId, hours, date; OvertimeCompatRequest.
  • 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 overtime object.
  • Success / error responses: 200; 400 raw string for invalid employee or non-positive hours.
  • Business behavior: Persist a manual overtime input.
  • State and input implications: Adds a local overtime input used on later calculation. No input projection changes.
  • Audit and event implications: No audit side effect confirmed. No event produced.
  • Compatibility notes: Monolith-shaped compatibility contract.
  • Safe example: Illustrative body: { "laborId":"<employee reference>", "hours":"<positive duration>", "date":"2026-07-01" }; success → 200 entry metadata
  • Example error: "Request could not be completed." (illustrative raw compatibility wording)

List employee overtime​

  • API family / maturity: Payroll Overtime Compatibility API; Compatibility
  • Authentication / authorization: Bearer expected by the compatibility contract; downstream enforcement Requires confirmation. No endpoint-specific role policy is confirmed.
  • Tenant context: Forwarded tenant context expected; no tenant query parameter.
  • Route parameters: Required integer employee reference.
  • Query parameters: Required month, year.
  • Request body / type: None; Route and 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 overtime array.
  • Success / error responses: 200; No endpoint-specific error response is mapped.
  • Business behavior: List manual overtime entries for employee and period.
  • State and input implications: Read-only. No input projection changes.
  • Audit and event implications: No audit side effect confirmed. No event produced.
  • Compatibility notes: Monolith-shaped compatibility contract.
  • Safe example: GET /api/overtime/{laborId:int}?month=7&year=2026 → 200 []
  • Example error: No stable endpoint-specific error example is confirmed.

Family-level findings​

There is no update/delete endpoint, approval operation, or rate API. These entries supplement Attendance-projected overtime; they do not mutate Attendance.

Source References​

  • microservices/src/payroll-service/Api/PayrollCompatEndpoints.cs
  • microservices/src/payroll-service/Application/PayrollCompatService.cs
  • Controllers/OvertimeController.cs

See Also​

Keywords​

  • Payroll API
  • Payroll Overtime Compatibility API

Revision Information​

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