Create an off-cycle payroll
Creates a new, unprocessed, off-cycle payroll.
off_cycle_reason
By default:
- External benefits and deductions will be included when the off_cycle_reason is set to Correction.
- All benefits and deductions are blocked when the off_cycle_reason is set to Bonus.
These elections can be overridden with the skip_regular_deductions boolean.
scope: payrolls:run
Path parameters
The UUID of the company
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Request body
Whether it is an off cycle payroll.
An off cycle payroll reason. Select one from the following list.
Pay period start date.
Pay period end date.
A pay schedule is required for transition from old pay schedule payroll to identify the matching transition pay period.
A list of employee UUIDs to include on the payroll. At least one UUID is required for non-termination off-cycle payrolls.
Payment date.
The payment schedule tax rate the payroll is based on.
Block regular deductions and contributions for this payroll.
Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages.
When true, all employees in the payroll will be paid by check and the check date can be set to today or any future business day (rather than requiring ACH lead time). Payment methods cannot be changed on check-only payrolls.
Response
Successful
A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.
The date on which employees will be paid for the payroll.
Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.
The date at which the payroll was processed. Null if the payroll isn't processed yet.
A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.
The UUID of the payroll.
The UUID of the payroll.
The UUID of the company for the payroll.
Indicates whether the payroll is an off-cycle payroll
The off-cycle reason. Only included for off-cycle payrolls.
Indicates whether the payroll has automatic payroll enabled
Indicates whether the payroll is an external payroll
Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.
Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.
Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.
Datetime for when the resource was created.
Will money movement for the payroll be performed by the partner rather than by Gusto?