Payroll

Flows and blocks for running and managing payroll across a company's pay schedules.

import { Payroll } from '@gusto/embedded-react-sdk'

🚂 Workflows

Component	Description
DismissalFlow	Guided flow to run a dismissed employee's final payroll.
OffCycleFlow	Guided flow to create and run a bonus or correction payroll.
PayrollExecutionFlow	Guided flow to configure, review, and submit a single payroll.
PayrollFlow	Hub for running and managing all payrolls across a company's pay schedules.
TransitionFlow	Macro flow that runs a transition payroll end to end: resolve or create the payroll, then configure, review, submit, and view receipts.

🧩 Blocks

Component	Description
ConfirmWireDetails	Wire transfer confirmation workflow for payroll funding.
DismissalPayPeriodSelection	Pay period selection step for the dismissal payroll workflow.
OffCycleCreation	Creation form for off-cycle (bonus or correction) payrolls.
OffCycleDeductionsSetting	Radio control for choosing whether an off-cycle payroll skips regular deductions and contributions.
OffCycleReasonSelection	Presents the reason selection UI for choosing between a bonus and correction off-cycle payment.
PayrollBlockerList	Displays the list of blockers preventing payroll from being processed for a company.
PayrollConfiguration	Handles the configuration phase of payroll processing, allowing users to review and modify employee compensation before calculating the payroll.
PayrollEditEmployee	Editor for an individual employee's compensation within a payroll run.
PayrollHistory	Displays historical payroll records with filtering and management capabilities.
PayrollLanding	Main landing surface for payroll operations, with tabs for running payroll and viewing payroll history, plus inline navigation to a payroll's overview and receipt.
PayrollList	Lists upcoming payrolls and lets users start running them.
PayrollOverview	Final review screen for a calculated payroll before submission, with submit, cancel, and edit controls. After submission, tracks processing status and surfaces the receipt and per-employee paystub downloads once complete.
PayrollReceipts	Displays a detailed receipt for a completed payroll, including the debited total, per-category breakdown, tax breakdown, and a per-employee summary of payment method, garnishments, reimbursements, taxes, and net pay.
PrintChecks	Displays a banner prompting the user to print checks for employees paid by check on a processed payroll, and walks them through choosing check stock and generating the check PDF.
RecoveryCases	Displays open recovery cases for a company and provides an in-modal resubmit workflow for resolving them.
TransitionCreation	Creation form for transition payrolls covering the gap between an old and new pay schedule.
TransitionPayroll	Resolves and runs a transition payroll for a pay-schedule change, picking up an existing unprocessed transition payroll when one exists and creating one otherwise.