CHcheckhq

[Sandbox] Refresh filings

Changed on

Generate filings and employee tax statements for a company from its approved payroll data. Sandbox-only: in production this endpoint returns a 404.

Pass payroll_ids and employee_ids to limit generation to specific payrolls and employees, or omit both to generate data for the entire company, including employee W-2s. The work runs asynchronously and can take several minutes. A company_filing webhook with the created event is sent for each filing that is generated.

post/companies/{company}/refresh_filings

Request

Path parameters

companystring required

ID of the company

Request body

payroll_idsstring[]

IDs of the approved payrolls to generate filings for. Omit to include all of the company's payrolls.

employee_idsstring[]

IDs of the employees to generate filings and tax statements for. Omit to include all of the company's employees.

Example request

{
  "payroll_ids": [
    "pay_123"
  ],
  "employee_ids": [
    "emp_123"
  ]
}

Response

202

messagestring

Example response

{
  "message": "Successfully started refreshing company's filings (this may take several minutes)"
}

Changes