Skip to main content
POST
/
api
/
v1
/
comparisons
Create Comparison
curl --request POST \
  --url https://api.example.com/api/v1/comparisons \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "year": 123,
  "contractA": {},
  "contractB": {},
  "results": {},
  "winner": 123,
  "diff": 123
}
'
Saves a contract comparison as an immutable snapshot.

​
Request Body

​
name
string
required
Name for the comparison (max 200 chars).
​
year
integer
required
Tax year (YYYY).
​
contractA
object
required
Full contract A data (JSON object).
​
contractB
object
required
Full contract B data (JSON object).
​
results
object
required
Calculation results (JSON object).
​
winner
integer
required
Winning contract index: 0 or 1.
​
diff
integer
required
Weekly take-home difference in cents. Must be ≥ 0.

​
Response

Returns the created comparison with status 201.