---
title: "Retrieve an employee’s time balance for a period"
method: GET
path: "/companies/{company}/time-balances/employee/{employee}"
tags: ["Time Balances"]
---

# Retrieve an employee’s time balance for a period

`GET /companies/{company}/time-balances/employee/{employee}`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/time-balances/employee/{employee}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Return an employee's time balance for a period: expected vs worked minutes, balance and overtime per day, and period totals (minutes).
- `from` and `to` (`YYYY-MM-DD`) are required; `to` before `from` returns 422.
- Days flagged `is_unscheduled` or `is_outside_employment` have expected, balance and overtime 0. Computed resource: exposes `employee_id`, no `id`.

## Path parameters

- `company` string, uuid, required
- `employee` string, uuid, required

## Query parameters

- `from` string, date, required
- `to` string, date, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` TimeBalance, required: The time balance of an arbitrary period (`from`/`to`) of an employee for the Control Horario (time tracking) module. A computed resource with no entity identity: it is keyed by employee + period, so it exposes `employee_id` (UUID v7) and never an `id`. It is the same contract the monthly close reuses over closed periods. Totals are in minutes; `days` is the daily breakdown.
    - `object` 'time_balance', required: Always `time_balance`.
    - `employee_id` string, uuid, required: UUID v7 of the employee the balance belongs to.
    - `from` string, date, required: Start of the period (YYYY-MM-DD).
    - `to` string, date, required: End of the period (YYYY-MM-DD).
    - `total_expected_minutes` integer, required: Total expected working minutes of the period (holidays and approved absences already discounted).
    - `total_worked_minutes` integer, required: Total worked minutes of the period.
    - `total_balance_minutes` integer, required: Period balance in minutes as the sum of the daily balances. Days without a schedule in effect or outside the employment period add 0, so it can differ from worked − expected when minutes were clocked on those days.
    - `total_overtime_minutes` integer, required: Total overtime minutes of the period.
    - `days` DayBalance[], required: Daily breakdown of the period. Each day includes `is_unscheduled` and `is_outside_employment`.
      - `date` string, date, required: Day of the breakdown (YYYY-MM-DD).
      - `expected_minutes` integer, required: Expected working minutes of the day derived from the schedule (0 on holidays, approved absences, rest days, days without a schedule in effect and days outside the employment period).
      - `worked_minutes` integer, required: Worked minutes of the day. Always the minutes actually clocked, also on days without a schedule in effect or outside the employment period, except under a `validated` schedule, where a scheduled day counts its expected minutes.
      - `balance_minutes` integer, required: Day balance in minutes (worked − expected); negative when the employee worked less than expected. 0 on days without a schedule in effect or outside the employment period (no reference to compare against).
      - `overtime_minutes` integer, required: Overtime minutes of the day (worked above the configured threshold, with the tolerance applied). 0 on days without a schedule in effect or outside the employment period: minutes clocked on those days never count as overtime.
      - `is_holiday` boolean, required: Whether the day is a public holiday for the employee.
      - `is_approved_absence` boolean, required: Whether the day is covered by an approved absence.
      - `is_rest_day` boolean, required: Whether the day is a rest day (no shift in the schedule).
      - `is_unscheduled` boolean: Whether the day falls within the employment period but no work schedule is in effect for it. Expected, balance and overtime minutes are 0; worked minutes are the minutes actually clocked. Never `true` together with `is_outside_employment`. Absent from the daily detail of a monthly close report.
      - `is_outside_employment` boolean: Whether the day is before the employee’s `hire_date` or after their `termination_date`. Expected, balance and overtime minutes are 0 even if a schedule assignment covers the day; clock entries recorded before this rule existed still show as worked minutes. Absent from the daily detail of a monthly close report.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)