The report run object

A requested payroll report and its result.

A report run tracks the lifecycle of a generated report. After creation, the run moves from generating to completed or failed. Completed runs include a result object with a URL to download the artifact.

{
  "id": "run_Bw6EkMDmxCPeVQ2eYzLu",
  "report": "payroll_journal",
  "status": "completed",
  "company": "com_sx3svU6K8c5ZkSFlOh5p",
  "created_at": "2026-06-24T18:26:56.848920Z",
  "completed_at": "2026-06-24T18:27:12.123456Z",
  "parameters": {
    "payday_from": "2025-01-01",
    "payday_to": "2025-03-31"
  },
  "result": {
    "url": "https://api.checkhq.com/report_runs/run_Bw6EkMDmxCPeVQ2eYzLu/download"
  },
  "metadata": {}
}

Attribute	Description
`id` string	Unique identifier for the report run.
`report` string	The report type. One of `payroll_journal` or `payroll_summary`.
`status` string	One of `generating`, `completed`, or `failed`.
`company` string or null	ID of the company the report is scoped to. Required for some report types.
`created_at` timestamp	Time at which the report run was created.
`completed_at` timestamp or null	Time at which the report run finished generating. `null` while the status is `generating`.
`parameters` object or null	Report-specific parameters supplied at creation. The available parameters depend on the run's `report` type; see the parameter tables below.
`result` object or null	Present when a downloadable artifact exists. Contains `url`, an absolute URL to download the report run. Download URLs are short-lived. `null` while the report is still generating or if generation failed.
`metadata` object	Additional loosely structured information associated with the report run.

Parameters by report

Each report type accepts its own set of parameters. Supply them when you create a report run; they are echoed back on the run, along with the defaults Check applied.

`payroll_journal` parameters

Parameter	Description
`payday_from` string (date)	Required. Inclusive start of the payday range, as `YYYY-MM-DD`.
`payday_to` string (date)	Required. Inclusive end of the payday range, as `YYYY-MM-DD`.
`payroll` string	ID of a single payroll to limit the report to.
`group_by` string	Set to `workplace` to break down employee pay by workplace location.
`contractors` boolean	Include contractor payments. Defaults to `false`.
`taxable_wages` boolean	Include taxable wage columns. Defaults to `false`.
`gross_taxable_wages` boolean	Include gross taxable wage columns. Defaults to `false`.
`additional_columns` array of strings	Extra columns to include. One or more of `employee.id`, `contractor.id`, `payroll.id`, or `employee.metadata.<key>`.

`payroll_summary` parameters

Parameter	Description
`payday_from` string (date)	Required. Inclusive start of the payday range, as `YYYY-MM-DD`.
`payday_to` string (date)	Required. Inclusive end of the payday range, as `YYYY-MM-DD`.
`payroll` string	ID of a single payroll to limit the report to.
`contractors` boolean	Include contractor payments. Defaults to `false`.
`taxable_wages` boolean	Include taxable wage columns. Defaults to `false`.
`gross_taxable_wages` boolean	Include gross taxable wage columns. Defaults to `false`.
`additional_columns` array of strings	Extra columns to include. One or more of `employee.id`, `contractor.id`, or `employee.metadata.<key>`.