api > thera > payroll > Offcycle API

Get Current Offcycle Checks

get/companies/{companyId}/w2-payroll/off-cycle-checks

Request

  • Base URL: https://api.getthera.com
  • URL: https://api.getthera.com/companies/{companyId}/w2-payroll/off-cycle-checks
  • Auth: API key in header X-Thera-API-Key

Path parameters

companyIdstring required

Query parameters

payrollType'OFF_CYCLE' | 'BONUS'

Discriminates the two kinds of Check off_cycle payroll. OFF_CYCLE is a regular off-cycle run. BONUS is tagged in Check metadata, forces supplemental flat-rate withholding, and blocks benefits and post-tax deductions. The two keep independent drafts. Defaults to OFF_CYCLE.

OFF_CYCLE (default) returns the regular off-cycle draft; BONUS returns the bonus draft.

Response

Response with status 200

idstring required
statusstring required
payDatestring required
itemIdByContractIdobject required

Changes

No recorded changes to this operation across all 1 revision of this API.