Get vacation balance (number of vacation days left) this vacation year.

Imported vacation balances will also be taken into account when calculating.

Permissions. User's vacation balance can be accessed by:

  • user themselves
  • user's approvers
  • company's managers and accountants
  • company users configured to approve vacations

Examples

{
  "balance_type": "vacation",
  "value":10,
  "units":"days",
  "start_date":"2025-04-01",
  "end_date":"2026-03-31"
}

Params

Param name Description
user_id
optional

User ID. Default: current user ID.

Validations:

  • Must be a Integer