CHcheckhq

List report runs

Changed on

Returns a list of report runs for the authenticated partner, newest first. Expired report runs are omitted.

get/report_runs

Request

Query parameters

companystring

Return report runs for this company ID.

report_type'payroll_journal' | 'payroll_summary'

Return report runs of this report type. One of payroll_journal or payroll_summary.

status'generating' | 'completed' | 'failed'

Return report runs in this status. One of generating, completed, or failed.

limitinteger

Number of report runs returned per page. The maximum value is 100.

Response

200

nextstring nullable
previousstring nullable

Example response

{
  "results": [
    {
      "id": "run_w4wDuqfuSqpMrSXbERrL",
      "report": "payroll_journal",
      "status": "generating",
      "company": "com_MkBYRtUviD6kYO0b85H8"
    }
  ]
}

Changes