Docs API Reference Detect Risks from Calculation

Detect Risks from Calculation

Run a full pay calculation and validate the output against expected award rules.

POST /api/v1/detect-risks-from-calculation

This is a post-calculation risk analysis — it catches issues like missing penalty rates, missing overtime, and zero-pay results that only become visible after calculation.

Request body

Same as Calculate Pay.

Response

Same structure as Detect Compliance Risks, with additional post-calculation risk codes.

Additional post-calculation risk codes

CodeSeverityDescription
PENALTY_EXPECTED_NOT_APPLIEDhighA penalty rate was expected (e.g. Sunday) but not applied
OVERTIME_EXPECTED_NOT_APPLIEDhighOvertime was expected but not triggered
ZERO_PAY_RESULThighCalculation returned zero pay
ALLOWANCE_REVIEW_NEEDEDinfoAllowance conditions should be reviewed

The detection_mode field will be post_calc for this endpoint.

Use case

Use this endpoint when you want a single call that both calculates pay and checks for compliance issues. This is more comprehensive than calling detect-risks and calculate-pay separately, because it can detect issues that only appear in the calculation output.

Example request

curl -X POST /api/v1/detect-risks-from-calculation \
  -H "Authorization: Bearer ak_KEY:sk_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "award_code": "MA000004",
    "classification_code": "RE1",
    "employment_type": "casual",
    "work_date": "2026-03-22",
    "start_time": "06:00",
    "end_time": "15:00",
    "unpaid_break_minutes": 30
  }'