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: <apiKey>"

200Example

1 {
2   "data": [
3     {
4       "salarybox_id": "SBHYBSEEIG",
5       "leaves": [
6         {
7           "leave_type": "GENERAL 01",
8           "total": "13.000",
9           "remaining": "13.000"
10         },
11         {
12           "leave_type": "GENERAL 11",
13           "total": "4.000",
14           "remaining": "4.000"
15         },
16         {
17           "leave_type": "GENERAL 00",
18           "total": "13.000",
19           "remaining": "13.000"
20         },
21         {
22           "leave_type": "Birthday",
23           "total": "13.000",
24           "remaining": "13.000"
25         },
26         {
27           "leave_type": "New 2",
28           "total": "0.000",
29           "remaining": "0.000"
30         }
31       ]
32     },
33     {
34       "salarybox_id": "SBXDFJHVMA",
35       "leaves": [
36         {
37           "leave_type": "GENERAL 01",
38           "total": "0.000",
39           "remaining": "5.000"
40         },
41         {
42           "leave_type": "GENERAL 11",
43           "total": "0.000",
44           "remaining": "6.000"
45         },
46         {
47           "leave_type": "GENERAL 00",
48           "total": "0.000",
49           "remaining": "1.000"
50         },
51         {
52           "leave_type": "Birthday",
53           "total": "0.000",
54           "remaining": "1.000"
55         },
56         {
57           "leave_type": "New 2",
58           "total": "0",
59           "remaining": "0"
60         }
61       ]
62     }
63   ],
64   "message": "Success",
65   "status": true,
66   "count": 2,
67   "prev": null,
68   "next": null
69 }

Returns leave balances per employee for the authenticated company.

Authentication

Authorizationstring

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

datalist of objects

messagestring

statusboolean

countinteger

prevstring or null

nextstring or null