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…
    📘

    The Run Payroll Component allows for editing payday and processing periods.

    Since allowing processing period edits are often included in our partner's higher pricing tiers, processing period edits are not on by default. This field can be toggled on by passing in the allowProcessingPeriodEdits field in our SDK. The allowPaydayEdits SDK field, which defaults to true, allows toggling off payday edits if necessary. Learn more here.

    📘

    Editing payday in the Component detaches that payroll from its pay schedule.

    When an employer edits a payroll's payday in the Component, the Component sends pay_schedule: null in the same request, because an off-schedule payday cannot coexist with a pay schedule reference. Only that one payroll is decoupled. The pay schedule itself is untouched in that future payrolls continue to generate from it, and the pay_frequency inherited from the schedule remains on the payroll.


    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

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