---
title: The leave object
slug: api/leave-object
description: API reference for the leave object.
docTags: 
createdAt: 2023-11-30T06:28:23.350Z
---

Represents a leave item's balance details. The leave object is returned by the get leave items endpoint.



**Object parameters**

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**balance** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The total balance available for the leave item.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**carried** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The carried over amount for the leave item. Includes both expired and non-expired days.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**entitlement** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The entitlement amount for the leave item.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**taken** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The total number of leave days consumed for the leave item.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**expired** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The amount of expired carried leave.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**carried\_can\_use** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The amount of available carried balance.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**entitlement\_can\_use** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The amount of available leave, excluding the carried balance.
:::
::::

***



:::CodeblockTabs
The leave object

```json
{
  "balance": -3,
  "carried": 1,
  "entitlement": 1,
  "taken": 2,
  "expired": 3,
  "carried_can_use": 0,
  "entitlement_can_use": -3
}
```
:::