Get one user's leave details

This interface returns only the currently available leave details for the requested user.

Get one user's leave details

GET /get-ee-leave-details

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Required
Description

customer_id

string

The unique Marco identifier for your company.

lang

string

Leave type language

email

string

Email of the user

unit_type

string

which leave details unit type do you want to receive? Format as: "Hours" or "Days" If it is empty, default as "Days". *1 day = 8 hours

Parameter Example

{
  "customer_id": "1",
  "lang": "EN",
  "email": "[email protected]",
  "unit_type": "Hours"
}

Response

//If balance_type is "Days":
[
    {
        "id": 2198,
        "customer_id": 1,
        "leave_type": 6,
        "entitlement": 15,
        "effective_date": "2024-01-01",
        "carried_expiry_date": "2024-07-01",
        "carried": 5,
        "notes": "",
        "country": "AR",
        "user": 7,
        "platform_email": "[email protected]",
        "unit_type": "Days",
        "balance": 14,
        "leave_type_name": "Annual Leave",
        "leave_type_notes": "Employees who have worked for an employer for more than 6 months are entitled to 2 weeks’ annual leave. This will increase based on the seniority: 14 calendar days when seniority does not exceed five year, 21 calendar days between 5-10 years, 28 calendar days between 10 -20 years, 35 days for more than 20 years"
    },
    {
        "id": 2197,
        "customer_id": 1,
        "leave_type": 10,
        "entitlement": 10,
        "effective_date": "2024-01-01",
        "carried_expiry_date": "2024-07-01",
        "carried": 2,
        "notes": "",
        "country": "AR",
        "user": 7,
        "platform_email": "[email protected]",
        "unit_type": "Days",
        "balance": -7,
        "leave_type_name": "Bereavement Leave",
        "leave_type_notes": "Employee can be entitled with 3-day paid bereavement leave."
    }
]

//If balance_type is "Hours":
[
    {
        "id": 2198,
        "customer_id": 1,
        "leave_type": 6,
        "entitlement": 120,
        "effective_date": "2024-01-01",
        "carried_expiry_date": "2024-07-01",
        "carried": 40,
        "notes": "",
        "country": "AR",
        "user": 7,
        "platform_email": "[email protected]",
        "unit_type": "Hours",
        "balance": 112,
        "leave_type_name": "Annual Leave",
        "leave_type_notes": "Employees who have worked for an employer for more than 6 months are entitled to 2 weeks’ annual leave. This will increase based on the seniority: 14 calendar days when seniority does not exceed five year, 21 calendar days between 5-10 years, 28 calendar days between 10 -20 years, 35 days for more than 20 years"
    },
    {
        "id": 2197,
        "customer_id": 1,
        "leave_type": 10,
        "entitlement": 80,
        "effective_date": "2024-01-01",
        "carried_expiry_date": "2024-07-01",
        "carried": 16,
        "notes": "",
        "country": "AR",
        "user": 7,
        "platform_email": "[email protected]",
        "unit_type": "Hours",
        "balance": -56,
        "leave_type_name": "Bereavement Leave",
        "leave_type_notes": "Employee can be entitled with 3-day paid bereavement leave."
    }
]

Last updated