Docs API Reference Calculate Pay (Audited)

Calculate Pay (Audited)

Calculate minimum award pay with a full audit trail showing every rule considered, applied, and rejected.

POST /api/v1/calculate-pay-audited

Request body

Identical to Calculate Pay. Same fields, same validation.

Response

Returns a pay_result (same as Calculate Pay response) plus a full audit payload:

FieldTypeDescription
pay_resultobjectFull Calculate Pay response
audit_idstringUnique identifier for this audit record
calculated_atstring (datetime)Timestamp of calculation
engine_versionstringEngine version used
versionobjectAward version resolution details
rateobjectRate derivation audit with all intermediate values
rules_consideredarrayAll rules evaluated (including those not applied)
rules_appliedarrayRules that were used in the final calculation
rounding_appliedarrayRounding operations performed
day_classificationstringHow the day was classified (e.g. weekday, saturday, public_holiday)
rate_pathstringRate calculation path taken
pay_modestringPay calculation mode used

rules_considered / rules_applied items

FieldTypeDescription
rule_tablestringDatabase table the rule came from
rule_idintegerRule record ID
rule_descriptionstringHuman-readable rule description
priorityintegerRule priority in conflict resolution
statusstringapplied, skipped, or superseded
reasonstringWhy the rule was applied/skipped
superseded_bystring or nullWhich rule took precedence (if superseded)
source_clausesarrayAward clause references

Use cases

  • Compliance audits — prove exactly which award rules produced a pay figure
  • Dispute resolution — show the precedence chain when multiple rules applied
  • Integration testing — verify your system matches the engine’s rule-by-rule logic

Example request

curl -X POST /api/v1/calculate-pay-audited \
  -H "Authorization: Bearer ak_KEY:sk_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "award_code": "MA000009",
    "classification_code": "HI1",
    "employment_type": "casual",
    "work_date": "2026-03-21",
    "start_time": "18:00",
    "end_time": "23:00",
    "unpaid_break_minutes": 0
  }'

Errors

Same as Calculate Pay.