v1
latestOpenAPI 3.1.02026-07-241642423.7 KBRun Payroll
Run payroll using our white-labeled Run Payroll Component. Set up worker pay, add earnings, and preview payrolls all within one Component. In order to run payroll with the Component, the company must have:<li>At least one employee or contractor associated with it</li><li>At least one pay schedule associated with it (<a href="https://docs.checkhq.com/reference/create-a-pay-schedule">Pay Schedule API</a>)</li><li>Company Onboarding status in "completed" state</li><img style="margin-top: 20px; border-radius: 10px; border: 1px solid #E2E8F0;" src="https://public-component-assets.s3.amazonaws.com/run_payroll_v2.svg" />Learn how to embed Components in our <a target="_blank" href="https://docs.checkhq.com/docs/embedding-a-component">guide</a>.
Path parameters
ID of the company for which a component link will be generated
Query parameters
ID of the payroll. This launches the component directly in edit view. In order to do this, the payroll needs to be formatted in a way the Run Payroll Component expects with a single earning rate tied to hourly or salaried earnings in the payroll item.
Response
200
Example response
{
"url": "{component_url}"
}