Leave Balances

Get leave balance by contract and year

get/v1/organizations/{orgId}/leave-balances/contract/{contractId}

Request

  • Base URL
    https://api.timesheet.io
  • URL
    https://api.timesheet.io/v1/organizations/{orgId}/leave-balances/contract/{contractId}
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

orgIdstring required

Organization ID

contractIdstring required

Contract ID

Query parameters

yearinteger required

Year

Response

Leave balance details

idstring
contractIdstring
yearinteger
entitledDaysstring decimal
carriedOverDaysstring decimal
additionalDaysstring decimal
totalAvailableDaysstring decimal
usedDaysstring decimal
pendingDaysstring decimal
remainingDaysstring decimal
carryOverExpiresAtstring
expiredDaysstring decimal
calculatedAtinteger
lastUpdateinteger
createdinteger

Changes

No operation changes recorded.