The leave object

Represents a leave item's balance details. The leave object is returned by the get leave items endpoint.
﻿
Object parameters
﻿
balance
integer﻿
The total balance available for the leave item.
﻿
carried
integer﻿
The carried over amount for the leave item. Includes both expired and non-expired days.
﻿
entitlement
integer﻿
The entitlement amount for the leave item.
﻿
taken
integer﻿
The total number of leave days consumed for the leave item.
﻿
expired
integer﻿
The amount of expired carried leave.
﻿
carried_can_use
integer﻿
The amount of available carried balance.
﻿
entitlement_can_use
integer﻿
The amount of available leave, excluding the carried balance.
﻿
﻿
The leave object
{
  "balance": -3,
  "carried": 1,
  "entitlement": 1,
  "taken": 2,
  "expired": 3,
  "carried_can_use": 0,
  "entitlement_can_use": -3
}
{
  "balance": -3,
  "carried": 1,
  "entitlement": 1,
  "taken": 2,
  "expired": 3,
  "carried_can_use": 0,
  "entitlement_can_use": -3
}
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿

Updated 25 Mar 2024

Did this page help you?

Bulk create or update user information

Get leave items