---
title: "Retrieve the team time balance summary"
method: GET
path: "/companies/{company}/time-balances/team-summary"
tags: ["Time Balances"]
---

# Retrieve the team time balance summary

`GET /companies/{company}/time-balances/team-summary`

## Request

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

Return the team time balance summary for a month: one row per active employee with a schedule, with expected, worked, balance and overtime minutes.
- `month` (`YYYY-MM`) defaults to the current month.
- `total_*` cover the whole month (a projection in the current one); `to_date` accumulates closed days. Computed resource: no `id`.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `month` string, nullable

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` TeamTimeBalanceSummary, required: The team time balance summary (manager view) for a month for the Control Horario (time tracking) module. A computed resource with no entity identity: it is keyed by company + month and holds one row per active employee with their monthly totals and their accumulation of the closed days (`to_date`). Totals are in minutes.
    - `object` 'team_time_balance_summary', required: Always `team_time_balance_summary`.
    - `month` string, required: Month of the summary (YYYY-MM).
    - `employees` TeamTimeBalanceRow[], required: One row per active employee with their monthly totals.
      - `employee_id` string, uuid, required: UUID v7 of the employee.
      - `employee_name` string, required: Display name of the employee.
      - `total_expected_minutes` integer, required: Total expected working minutes of the whole month, including today and the remaining days (projection).
      - `total_worked_minutes` integer, required: Total worked minutes of the month so far, today included.
      - `total_balance_minutes` integer, required: Month balance in minutes as the sum of the daily balances. In the current month it is a projection that already subtracts the expected minutes of today and of the remaining days; use `to_date.balance_minutes` for the actual balance.
      - `total_overtime_minutes` integer, required: Total overtime minutes of the month.
      - `to_date` TimeBalanceToDate, required: The month-to-date accumulation of the closed days (every day before today) for the Control Horario (time tracking) module. It is computed from the same daily breakdown as the `total_*` fields, which instead cover the whole month and are a projection: in the current month they already subtract the expected minutes of today and of the remaining days. Today is left out because its workday is still in progress. In a finished month it equals the `total_*` fields; when no day of the month has closed yet (its first day, or a future month), `through_date` is `null` and the four figures are 0.
        - `through_date` string, date, nullable, required: Last closed day included in the accumulation (YYYY-MM-DD), normally yesterday; `null` when no day of the month has closed yet.
        - `expected_minutes` integer, required: Expected working minutes of the closed days.
        - `worked_minutes` integer, required: Worked minutes of the closed days.
        - `balance_minutes` integer, required: Balance of the closed days in minutes: the sum of the daily `balance_minutes`, so days without a schedule or outside the employment period add 0.
        - `overtime_minutes` integer, required: Overtime minutes of the closed days.

## 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. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `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)