Compare Scenario

POST /api/v1/compare-scenario

Request body

Field	Type	Required	Description
award_a	string	Yes	First award code
award_b	string	Yes	Second award code
classification_a	string	Yes	Classification from award A
classification_b	string	Yes	Classification from award B
employment_type	string	Yes	full_time, part_time, or casual
work_date	string (date)	Yes	Shift date YYYY-MM-DD
start_time	string	No	Shift start HH:MM
end_time	string	No	Shift end HH:MM
unpaid_break_minutes	integer	No	Break minutes
total_hours_worked	number	No	Alternative to start/end
is_public_holiday	boolean	No	Public holiday flag

Response

Returns the same structure as Compare Awards, with an additional scenario_comparison object:

Field	Type	Description
scenario_comparison.award_a	object	Full pay result for award A
scenario_comparison.award_b	object	Full pay result for award B
scenario_comparison.gross_pay_difference	number	Dollar difference
scenario_comparison.gross_pay_difference_percent	number	Percentage difference
scenario_comparison.higher_paying_award	string	Award code that pays more, or equal
scenario_comparison.scenario_description	string	Human-readable scenario summary

Each award result includes gross_pay, ordinary_earnings, overtime_earnings, penalty_earnings, allowance_total, pay_components, and derivation_formula.

Example request

curl -X POST /api/v1/compare-scenario \
  -H "Authorization: Bearer ak_KEY:sk_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "award_a": "MA000009",
    "award_b": "MA000004",
    "classification_a": "HI1",
    "classification_b": "RE1",
    "employment_type": "casual",
    "work_date": "2026-03-21",
    "start_time": "09:00",
    "end_time": "17:00",
    "unpaid_break_minutes": 30
  }'