Get Time Off Policies By Company | Thera

{
  "policies": [
    {
      "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"
      }
    },
    {
      "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"
      }
    }
  ],
  "defaultTimeOffPolicies": [
    "defaultTimeOffPolicies"
  ],
  "associatedUserIdsByPolicyId": {
    "associatedUserIdsByPolicyId": [
      "associatedUserIdsByPolicyId"
    ]
  }
}
Returns all time off policies for a company along with their contractor associations and default policy ids, sourced from the time off policy table. Use this instead of reading timeOffSettings off the company object.
Authentication

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

companyIdstringRequired
Response

This endpoint returns an object.
policieslist of objects
defaultTimeOffPoliciesset of strings
associatedUserIdsByPolicyIdmap from strings to sets of strings