Time Balances

Retrieve an employee’s time balance for a period

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

Path parameters

companystring uuid required

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

employeestring uuid required

Public identifier (UUID v7) of the employee.

Query parameters

fromstring date required

Period start date (YYYY-MM-DD).

tostring date required

Period end date (YYYY-MM-DD).

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": "time_balance",
    "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
    "from": "2026-05-01",
    "to": "2026-05-31",
    "total_expected_minutes": 9600,
    "total_worked_minutes": 9720,
    "total_balance_minutes": 120,
    "total_overtime_minutes": 90,
    "days": [
      {
        "date": "2026-05-04",
        "expected_minutes": 480,
        "worked_minutes": 510,
        "balance_minutes": 30,
        "overtime_minutes": 15
      }
    ]
  }
}

Changes

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