GET
/
api
/
v1
/
attendance
/
leave
/
balance
Get Leave Balance
curl --request GET \
  --url https://api.jobsim.work/api/v1/attendance/leave/balance \
  --header 'Authorization: Bearer <token>'
{
  "year": 123,
  "period": "yearly",
  "count_pending_against_balance": false,
  "balances": [
    {
      "entitled_days": 123,
      "approved_days": 0,
      "pending_days": 0,
      "remaining_days": 123,
      "utilization_percent": 123,
      "is_unlimited": false
    }
  ],
  "total_approved_days": 0,
  "total_pending_days": 0,
  "generated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Leave balance summary for a user in the current policy period.

year
integer
required
period
string
default:yearly
count_pending_against_balance
boolean
default:false
balances
LeaveBalanceItem · object[]
total_approved_days
number
default:0
total_pending_days
number
default:0
generated_at
string<date-time>