Report runs

Generate payroll reports asynchronously over the API.

A report run represents an asynchronous report generation job. Create a report run to start generating a report, poll or list report runs until the status is completed, then download the generated artifact 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.

Supported reports:

  • payroll_journal — a payroll journal report for a payday range.
  • payroll_summary — a payroll summary report for a payday range.

Poll GET /report_runs/{report_run} or listen for report_run webhooks until status is completed or failed.