api > thera > timeoff > Time Off Management

Get Timeoff Policy

Gets a timeoff policy from company

get/companies/{companyId}/timeoff-policy/{policyId}

Request

  • Base URL: https://api.getthera.com
  • URL: https://api.getthera.com/companies/{companyId}/timeoff-policy/{policyId}
  • Auth: API key in header X-Thera-API-Key

Path parameters

companyIdstring required
policyIdstring required

Response

Response with status 200

idstring required
policyNamestring required
payType'UNPAID' | 'PAID' | 'US_HOLIDAY' required
leaveTypestring required
midYearJoiningAllowance'FULL_AMOUNT' | 'PRORATED_AMOUNT' required
accrualTypeobject required

Whether the policy allowance is per month or per year

autoDeductEnabledobject required

Whether to automatically create deductions for PTO overages

createdByUserIdstring required
creationTimestampinteger required
lastUpdationTimestampinteger required
timeOffPolicyAddedForModelTheraContractEmploymentType[] required
accrualConfigByEmploymentTypeobject
carryoverConfigByEmploymentTypeobject
negativeBalanceBehaviorByEmploymentTypeobject

Changes

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