CHcheckhq

Create a report run

Changed on

Creates a report run. Poll GET /report_runs/{id} or listen for report_run webhooks until status is completed or failed. When completed, download the file from result.url. Report generation may take up to 20 minutes. Data that report runs rely on may be up to 10 minutes out of date. Create requests are rate limited to 1 per second per partner, with a maximum of 20 report runs generating at once.

post/report_runs

Request

Headers

X-Idempotency-Keystring

Optional idempotency key. Replays the first response when the same key is reused.

Request body

report'payroll_journal' | 'payroll_summary' required

Report to generate. One of payroll_journal or payroll_summary.

companystring

Company ID to scope the report.

metadataobject

Additional loosely structured information to associate with the report run.

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