> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Accrual Policy Object

> Reference for the Accrual Policy object representing a PTO, sick leave, or custom accrual policy assigned to company employees.

The Accrual Policy Object represents a PTO, sick leave, or custom accrual policy that can be created for a company and assigned to respective company employees.

| attribute | type | description |
| - | - | - |
| companyID | string | Zeal Company ID |
| policy\_code | string | Custom code that can be assigned for the policy |
| policy\_type | enum | Type of the accrual policy (accepts: pto, sick\_leave, or custom) |
| policy\_name | string | Custom name that can be assigned for the policy |
| policy\_effective\_date | YYYY-MM-DD | The effective start date of the policy |
| accrual\_rate\_hours | float | The rate at which employees will accrue hours |
| accrual\_period\_hours | float | The number of hours employees need to work to accrue accrual\_rate\_hours |
| immediate\_balance | float | The immediate hour balance the employee would receive |
| include\_doubletime | boolean | Include if double-time work is eligible for hour accrual |
| include\_overtime | boolean | Include if overtime work is eligible for hour accrual |
| include\_flat | boolean | Include if flat earning component is eligible for accrual |
| accrual\_waiting\_period | float | The number of hours the employees need to work before they are eligible to begin accruing time for policy |
| accrual\_cap | float | The maximum number of hours an employee can accrue within a policy year. Once this limit is reached, no additional hours will accrue until the next accrual period or rollover date. |
| rollover\_cap | float | The maximum number of unused hours an employee is allowed to carry over from one policy year to the next on the specified rollover date. |
| rollover\_date | float | Required if the user passes a value for `rollover_cap` or `accrual_cap` |
| balance\_cap | float | The maximum balance an employee is allowed to hold under this policy. Once this limit is reached, no additional hours will accrue until the balance drops below the cap. |
| accrual\_start\_after\_days | float | The number of calendar days after the employees' start date before they begin accruing time for the policy |

<CodeGroup>
  ```bash bash theme={null}
  {
    "companyID": "fc235f012bae46aa8a082f357715bcfa",
    "policy_code": "001",
    "policy_type": "pto",
    "policy_name": "test name",
    "policy_effective_date": "2023-03-01",
    "accrual_rate_hours": 10,
    "accrual_period_hours": 40,
    "immediate_balance": 0,
    "include_doubletime": true,
    "include_overtime": true,
    "include_flat": false,
    "accrual_waiting_period": 0,
    "accrual_cap": 100,
    "rollover_cap": 40,
    "rollover_date": "01-01",
    "policy_status": "live",
    "balance_cap": 100,
    "accrual_start_after_days": 0
  }
  ```
</CodeGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.