Thera APIPayrollUS Pay Schedule APIs

Get US Pay Schedule

Authentication

X-Thera-API-Keystring
API Key authentication via header

Path parameters

companyIdstringRequired
checkPayScheduleIdstringRequired

Response

This endpoint returns an object.
idstring
companystring
namestring
payFrequencyenum
firstPayDatedate
firstPeriodEndDatedate
isEditableboolean

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”.

metadataany
secondPayDatedateOptional
scheduledHoursPerWeekdoubleOptional

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.