Batch Results

Get batch status

GET /api/v1/batches/{batch_id}

Response

Field	Type	Description
batch_id	string	Batch job ID
status	string	queued, processing, complete, failed, or cancelled
total_rows	integer	Total rows in the uploaded file
processed_rows	integer	Rows processed so far
error_rows	integer	Rows with processing errors
created_at	string (datetime)	When the batch was uploaded
completed_at	string (datetime)	When processing finished (null if still running)

Get batch results

GET /api/v1/batches/{batch_id}/results

Query parameters

Parameter	Type	Default	Description
limit	integer	50	Rows per page (max 200)
offset	integer	0	Pagination offset
status	string	—	Filter by row status: ok, warning, violation, error

Response

Returns a summary object and paginated rows array.

Summary

Field	Type	Description
total_rows	integer	Total rows
status_counts	object	Count by status: {"ok": 45, "warning": 3, "violation": 2, "error": 0}
severity_counts	object	Count by risk severity

Row items

Field	Type	Description
row_index	integer	Row number in original file
employee_ref	string	Employee reference from input
award_code	string	Award code
classification_code	string	Resolved classification
row_status	string	ok, warning, violation, or error
risk_count	integer	Number of compliance risks detected
max_severity	string	Highest risk severity for this row
pay_output	object	Calculated minimum pay (same format as Calculate Pay response)
risks	array	Compliance risk items
pay_comparison	object	Actual vs. minimum pay comparison (if actual_pay was provided)

List all batches

GET /api/v1/batches

Returns paginated list of all batch jobs for your organisation.

Query parameters

Parameter	Type	Default	Description
limit	integer	20	Jobs per page
offset	integer	0	Pagination offset

Export results as CSV

POST /api/v1/batches/{batch_id}/export

Returns the compliance results as a downloadable CSV file.

Cancel a batch

POST /api/v1/batches/{batch_id}/cancel

Cancels a queued or processing batch. Already-processed rows are retained.

Delete a batch

DELETE /api/v1/batches/{batch_id}

Permanently deletes the batch and all its results.