v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Accrual Balance

get/accrualBalance

Query parameters

companyIDstring required

ID of the company

policy_codestring

Filter by the unique code assigned to a policy

employeeIDstring

Filter by the employee assigned to a policy

policy_statusstring

Filter by status of the policy (accepts live or terminated)

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "companyID": "2hw67sd8900fd7hw78fdfhaej",
    "accrualPolicies": [
      {
        "policy_code": "001",
        "employeeID": "ccee4542323errr34345223",
        "policy_type": "pto",
        "policy_name": "executive_pto",
        "accrual_balance": 20,
        "accrual_rate_unit": "hours",
        "policy_status": "live"
      }
    ]
  }
}