The off-cycle options object

Represents benefits and deductions applicable to the off-cycle payroll.

{
  "force_supplemental_withholding": true,
  "apply_benefits": false,
  "apply_post_tax_deductions": true
}

When you send off_cycle_options on a payroll create or update request, all three fields are required; a request that omits one is rejected with This field is required. Omit the object entirely to use the defaults, which are false for each field.

AttributeDescription
force_supplemental_withholding
boolean
True if all earnings for the payroll are being taxed as supplemental earnings.
apply_benefits
boolean
True if benefit deductions and contributions apply to the payroll.
apply_post_tax_deductions
boolean
True if post-tax deductions apply to the payroll.