---
title: "Retrieve the consolidated workforce compliance overview"
method: GET
path: "/accounts/{account}/gestoria/workforce-summary"
tags: ["Companies"]
---

# Retrieve the consolidated workforce compliance overview

`GET /accounts/{account}/gestoria/workforce-summary`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/accounts/{account}/gestoria/workforce-summary`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Return the consolidated time-tracking compliance panel: one row per `active` company in your credential scope (the owner company excluded).
- Each row projects the latest monthly close: closed status, last closed period, balance, overtime and `employee_count`.
- Scope-bound: rows come from the tax IDs your credential reaches, never from the payload.

## Path parameters

- `account` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` ConsolidatedWorkforce[], required
    - `id` string, uuid, required: UUID v7 of the tax ID this row belongs to (the resource has no id of its own).
    - `name` string, required: Trade name / legal name of the tax ID.
    - `tax_id` string, required: Spanish fiscal identifier (NIF/CIF) of the tax ID.
    - `current_period_closed` boolean, required: true when the current (last closable) period is closed for this company.
    - `current_period_status` 'closed' | 'reopened' | 'null', nullable, required: Status of the current period close: `closed`, `reopened`, or `null` when the company has no close for it.
    - `last_closed_year` integer, nullable, required: Year of the company’s latest existing monthly close, or `null` when it has none.
    - `last_closed_month` integer, nullable, required: Month (1-12) of the company’s latest existing monthly close, or `null` when it has none.
    - `total_balance_minutes` integer, required: Total balance in minutes from the snapshot of the latest close (may be negative).
    - `total_overtime_minutes` integer, required: Total overtime in minutes from the snapshot of the latest close.
    - `employee_count` integer, required: Number of employees in the snapshot of the latest close.
    - `account` object, nullable, required: Account the tax ID belongs to: `{id, name}` (your own account for a tax ID of your account), or `null` when the tax ID has no account.
      - `id` string, uuid, required: Opaque identifier (UUID v7) of the account.
      - `name` string, required: Visible name of the account.
    - `relation_origin` 'granted' | 'provisioned' | 'null', nullable, required: How the tax ID reaches you: `granted` (access granted to you), `provisioned` (a managed account your account provisioned) or `null` (a tax ID of your own account).
    - `access_level` 'view' | 'operate', required: Level you hold on the tax ID: `view` (read-only) or `operate`. For a credential, the level of its portfolio.

## 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. `account_not_found`: the account in the path does not exist or is not the account of the API key.
- `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)
