[Sandbox] Refresh filings

Generate filings for a Sandbox company from its payroll data

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Only supported in Sandbox. In production this endpoint returns a 404.

Generates filings and employee tax statements for a company from its approved payroll data, so that the rest of the Filings API can be exercised in Sandbox. 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 company must have completed implementation and have at least one approved payroll. See the Tax Filings: Sandbox Testing guide for the full walkthrough, including how to simulate the filing lifecycle once filings exist.

The request is accepted with a 202 and the work runs asynchronously. Depending on the amount of payroll data and the number of employees, generation can take several minutes. Repeated requests for the same company are added to the in-progress job rather than starting a second one. A company_filing webhook with the created event is sent for each filing that is generated, after which the filings are available through List filings.

Path Params
string
required

ID of the company

Body Params
payroll_ids
array of strings

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

payroll_ids
employee_ids
array of strings

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

employee_ids
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json