List Leave Balances

GET

https://api.salaryboxapp.com/v2/customer/v1/leave/balance

GET

/v2/customer/v1/leave/balance

curl https://api.salaryboxapp.com/v2/customer/v1/leave/balance \
     -H "Authorization: Api-Key  <apiKey>"

200Example

{
  "data": [
    {
      "salarybox_id": "SBHYBSEEIG",
      "leaves": [
        {
          "leave_type": "GENERAL 01",
          "total": "13.000",
          "remaining": "13.000"
        },
        {
          "leave_type": "GENERAL 11",
          "total": "4.000",
          "remaining": "4.000"
        },
        {
          "leave_type": "GENERAL 00",
          "total": "13.000",
          "remaining": "13.000"
        },
        {
          "leave_type": "Birthday",
          "total": "13.000",
          "remaining": "13.000"
        },
        {
          "leave_type": "New 2",
          "total": "0.000",
          "remaining": "0.000"
        }
      ]
    },
    {
      "salarybox_id": "SBXDFJHVMA",
      "leaves": [
        {
          "leave_type": "GENERAL 01",
          "total": "0.000",
          "remaining": "5.000"
        },
        {
          "leave_type": "GENERAL 11",
          "total": "0.000",
          "remaining": "6.000"
        },
        {
          "leave_type": "GENERAL 00",
          "total": "0.000",
          "remaining": "1.000"
        },
        {
          "leave_type": "Birthday",
          "total": "0.000",
          "remaining": "1.000"
        },
        {
          "leave_type": "New 2",
          "total": "0",
          "remaining": "0"
        }
      ]
    }
  ],
  "message": "Success",
  "status": true,
  "count": 2,
  "prev": null,
  "next": null
}

Returns leave balances per employee for the authenticated company.

Authentication

AuthorizationApi-Key

Format: "Api-Key {api-key}"

Query parameters

salarybox_idsstringOptional

Comma-separated SalaryBox IDs to filter by.

pageintegerOptional

Page number to fetch. Defaults to 1.

page_sizeintegerOptional

Number of results per page (max 500). Defaults to 500.

Response

This endpoint returns an object.

datalist of objects

messagestring

statusboolean

countinteger

prevstring or null

nextstring or null