LeaveBalance

Overview

Once a staff member is configured with a leave profile and employment type, they should be assigned as set of leave balance objects that relate the staff member to each relevant leave type and the balance of leave hours that they’ve accrued for it. To call the leave balance endpoint, refer to the following table:

GET

The following table illustrates which fields can be included when receiving a GET response.

{
    "@odata.context": "https://api.mypcorp.com/$metadata#LeaveBalance",
    "value": [
        {
            "StaffGuid": "a42f65e7-a029-eb11-a824-000d3acb64f8",
            "LeaveType": "Annual leave",
            "LeaveCode": "ANL",
            "Balance": 0.71
        },
        {
            "StaffGuid": "a42f65e7-a029-eb11-a824-000d3acb64f8",
            "LeaveType": "Personal leave",
            "LeaveCode": "PEL",
            "Balance": 0.43
        }
    ]
}

PUT

The following indicates the fields that can be included in PUT requests. To receive a successful response, at least balance object must be provided, and either LeaveType or LeaveCode must be included (both can be included but suggested use is to choose one as the primary identifier and not provide the other). The leave request does not need to specify every leave type assigned to the staff member, any not provided will not be updated. Similarly, new records cannot be added, updates can only be made to existing records.

{
  "value": [
    {
        "LeaveType":"Annual Leave",
        "Balance":5
    },
    {
        "LeaveCode":"PaL",
        "Balance":10.5
    },
    {
        "LeaveType":"Time off in lieu",
        "LeaveCode":"TOIL",
        "Balance":20
    }
  ]
}