Time Balances

Retrieve the team time balance summary

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.
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

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

monthstring nullable

Summary month in YYYY-MM format; defaults to the current month.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "object": "team_time_balance_summary",
    "month": "2026-05",
    "employees": [
      {
        "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
        "employee_name": "Lucía Fernández Ruiz",
        "total_expected_minutes": 9600,
        "total_worked_minutes": 7290,
        "total_balance_minutes": -2310,
        "total_overtime_minutes": 60,
        "to_date": {
          "through_date": "2026-05-24",
          "expected_minutes": 7200,
          "worked_minutes": 7290,
          "balance_minutes": 90,
          "overtime_minutes": 60
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.