v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Accrual Policy

get/accrualPolicy

Query parameters

companyIDstring required

ID of the company, will return all company's accrual policies if solely passed

policy_codestring

Unique code assigned to a policy

policy_statusstring

Status of the policy (accepts live or terminated)

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "companyID": "234eeeee53534tererec",
    "policy_type": "pto",
    "policy_name": "test name",
    "policy_code": "001",
    "policy_effective_date": "2023-03-01",
    "accrual_rate_hours": 10,
    "accrual_period_hours": 40,
    "include_doubletime": true,
    "include_overtime": true,
    "accrual_cap": 40,
    "rollover_cap": 40,
    "rollover_date": "01-01",
    "policy_status": "live"
  }
}