Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Payrolls

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

post/v1/companies/{company_id}/payrolls

Path parameters

company_idstring required

The UUID of the company

Headers

X-Gusto-API-Version'2026-06-15'

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

off_cycleboolean required

Whether it is an off cycle payroll.

off_cycle_reason'Bonus' | 'Correction' | 'Adhoc' | 'Dismissed employee' | 'Transition from old pay schedule' required

An off cycle payroll reason. Select one from the following list.

start_datestring date required

Pay period start date.

end_datestring date required

Pay period end date.

pay_schedule_uuidstring

A pay schedule is required for transition from old pay schedule payroll to identify the matching transition pay period.

employee_uuidsstring[]

A list of employee UUIDs to include on the payroll. At least one UUID is required for non-termination off-cycle payrolls.

check_datestring date

Payment date.

withholding_pay_period'Every week' | 'Every other week' | 'Twice per month' | 'Monthly' | 'Quarterly' | 'Semiannually' | 'Annually'

The payment schedule tax rate the payroll is based on.

skip_regular_deductionsboolean

Block regular deductions and contributions for this payroll.

fixed_withholding_rateboolean

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.

is_check_only_payrollboolean

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

payroll_deadlinestring date-time

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.

check_datestring

The date on which employees will be paid for the payroll.

processedboolean

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.

processed_datestring nullable

The date at which the payroll was processed. Null if the payroll isn't processed yet.

calculated_atstring date-time nullable

A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.

uuidstring

The UUID of the payroll.

payroll_uuidstring

The UUID of the payroll.

company_uuidstring

The UUID of the company for the payroll.

off_cycleboolean

Indicates whether the payroll is an off-cycle payroll

off_cycle_reason'Adhoc' | 'Benefit reversal' | 'Bonus' | 'Correction' | 'Dismissed employee' | 'Hired employee' | 'Wage correction' | 'Tax reconciliation' | 'Reversal' | 'Disability insurance distribution' | 'Transition from old pay schedule' nullable

The off-cycle reason. Only included for off-cycle payrolls.

auto_payrollboolean

Indicates whether the payroll has automatic payroll enabled

externalboolean

Indicates whether the payroll is an external payroll

final_termination_payrollboolean

Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.

withholding_pay_period'Every week' | 'Every other week' | 'Twice per month' | 'Monthly' | 'Quarterly' | 'Semiannually' | 'Annually' nullable

The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.

skip_regular_deductionsboolean nullable

Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.

fixed_withholding_rateboolean nullable

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.

created_atstring date-time

Datetime for when the resource was created.

partner_owned_disbursementboolean nullable

Will money movement for the payroll be performed by the partner rather than by Gusto?