CHcheckhq

Get a report run

Changed on

Returns the specified report run.

get/report_runs/{report_run}

Request

Path parameters

report_runstring required

ID of the report run to return.

Response

200

idstring

Report run ID.

report'payroll_journal' | 'payroll_summary'

Report to generate. One of payroll_journal or payroll_summary.

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

One of generating, completed, or failed. New report runs start as generating.

companystring nullable

Company ID to scope the report. Required for some report types.

created_atstring date-time

When the report run was created.

completed_atstring date-time nullable

When the report run finished successfully or failed.

metadataobject

Additional loosely structured information associated with the report run.

Example response

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

Changes