GuidesReferenceChangelogAPI Upgrades
Reference

Run Payroll

post
https://sandbox.checkhq.com/companies//components/run_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:

  • At least one employee or contractor associated with it
  • At least one pay schedule associated with it (Pay Schedule API)
  • Company Onboarding status in "completed" state
    • Learn how to embed Components in our guide.

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

    ID of the company for which a component link will be generated

    Query Params
    string

    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.

    Responses

    Updated 7 months ago

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

    Updated 7 months ago