Get Timeoff Policy | Thera API Docs

{
  "id": "id",
  "policyName": "policyName",
  "payType": "UNPAID",
  "leaveType": "leaveType",
  "allowanceType": {
    "type": "limitedAllowance",
    "allowedNumberOfDays": 1.1
  },
  "midYearJoiningAllowance": "FULL_AMOUNT",
  "accrualType": {
    "EMPLOYEE": "MONTHLY"
  },
  "autoDeductEnabled": {
    "EMPLOYEE": true
  },
  "createdByUserId": "createdByUserId",
  "creationTimestamp": 1000000,
  "lastUpdationTimestamp": 1000000,
  "timeOffPolicyAddedFor": [
    "EMPLOYEE"
  ],
  "deletionDetails": {
    "terminatingUserId": "terminatingUserId",
    "deletionTimestamp": 1000000
  },
  "holidayDefinitions": [
    {
      "id": "id",
      "name": "name",
      "type": "FEDERAL",
      "enabled": true,
      "dateRule": "dateRule",
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "createdBy": "createdBy",
      "createdAt": 1000000
    },
    {
      "id": "id",
      "name": "name",
      "type": "FEDERAL",
      "enabled": true,
      "dateRule": "dateRule",
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "createdBy": "createdBy",
      "createdAt": 1000000
    }
  ],
  "accrualConfigByEmploymentType": {
    "EMPLOYEE": {
      "basis": "CALENDAR",
      "frequency": "DAILY",
      "ratePerPeriod": 1.1,
      "annualAllowance": 1.1,
      "accrualCap": 1.1,
      "waitingPeriodDays": 1,
      "cliffDays": 1,
      "cliffGrantDays": 1.1,
      "anniversaryTiers": [
        {
          "yearsOfService": 1,
          "ratePerPeriod": 1.1
        },
        {
          "yearsOfService": 1,
          "ratePerPeriod": 1.1
        }
      ],
      "accrualHoursEarned": 1.1,
      "accrualPerHoursWorked": 1.1
    }
  },
  "carryoverConfigByEmploymentType": {
    "EMPLOYEE": {
      "type": "NONE",
      "carryoverCapDays": 1.1,
      "rolloverMonthDay": "rolloverMonthDay",
      "carriedDaysExpiryMonthDay": "carriedDaysExpiryMonthDay"
    }
  },
  "negativeBalanceBehaviorByEmploymentType": {
    "EMPLOYEE": "BLOCK"
  }
}

Gets a timeoff policy from company

Authentication

X-Thera-API-Keystring

API Key authentication via header

Path parameters

companyIdstringRequired

policyIdstringRequired

Response

This endpoint returns an object.

idstring

policyNamestring

payTypeenum

Allowed values:

leaveTypestring

allowanceTypeobject

midYearJoiningAllowanceenum

Allowed values:

accrualTypemap from enums to enums

Whether the policy allowance is per month or per year

Allowed values:

autoDeductEnabledmap from enums to booleans

Whether to automatically create deductions for PTO overages

Allowed values:

createdByUserIdstring

creationTimestamplong

lastUpdationTimestamplong

timeOffPolicyAddedForset of enums

Allowed values:

deletionDetailsobjectOptional

holidayDefinitionslist of objectsOptional

accrualConfigByEmploymentTypemap from enums to objectsOptional

Allowed values:

carryoverConfigByEmploymentTypemap from enums to objectsOptional

Allowed values:

negativeBalanceBehaviorByEmploymentTypemap from enums to enumsOptional

Allowed values: