api > thera > payroll > US Pay Schedule APIs

Get US Pay Schedule

get/companies/{companyId}/w2-payroll/pay-schedules/{checkPayScheduleId}

Request

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

Path parameters

companyIdstring required
checkPayScheduleIdstring required

Response

Response with status 200

idstring required
companystring required
namestring required
payFrequency'weekly' | 'biweekly' | 'semimonthly' | 'monthly' | 'quarterly' | 'annually' required
firstPayDatestring date required
secondPayDatestring date
firstPeriodEndDatestring date required
isEditableboolean required

Whether the cycle's shape can still change: pay frequency, first payday, second payday and first period end. Check refuses those once any payroll exists against the cycle ("Cannot update pay schedule that has been associated with a payroll"). Name, metadata and scheduled hours stay editable either way, so this must not be read as "the cycle cannot be edited".

metadataunknown required
scheduledHoursPerWeeknumber double

Weekly hours seeded onto hourly employees' regular earning lines on this cycle. Unset means the standard full-time week; zero means seed no hours so the employer enters them.

Changes

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