Get work time stats for a user with a daily breakdown for a given date range.

Stats will include:

  • date
  • actual (logged) work time, in minutes
  • mandatory working time, in minutes
  • absence time, in minutes
  • flex absence time, in minutes — only present when the user's effective LAT set contains a flex_leave type
  • paid overtime time, in minutes — only present when the user's work-time group has allow_paid_overtime; excluded from work_time_balance
  • work time balance, in minutes — actual − paid_overtime − mandatory
  • is the date locked, boolean

Permissions. User's work time balance can be accessed by:

  • user themselves
  • user's approvers
  • company's managers and accountants

Examples

[
   {
    "date": "2025-03-25",
    "actual_worked_time": 900,
    "mandatory_working_time": 450,
    "absence_time": 0,
    "paid_overtime_time": 450,
    "work_time_balance": 0,
    "is_locked": false
  },
  {
    "date": "2025-03-26",
    "actual_worked_time": 0,
    "mandatory_working_time": 450,
    "absence_time": 0,
    "work_time_balance": -450,
    "is_locked": true
  }
]

Params

Param name Description
user_id
optional

User ID. Default: current user ID.

Validations:

  • Must be a Integer

start_date
optional

Date to start the balance calculations from. Default: date of the user’s first time entry. If start date has not been passed explicitly and user has no time entries, time balance will not be calculated.

Validations:

  • Must be a String

end_date
optional

Date to end the balance calculations with, inclusive. Default: today.

Validations:

  • Must be a String

date_range
optional

Get stats within the specified date range.Either pass date_range or start/end dates. Date range format: "DD/MM/YYYY - DD/MM/YYYY" (e.g. 15/02/2025 - 28/02/2025).

Validations:

  • Must be a String