Absence Balances

Retrieve an absence balance

Retrieve a single absence balance by its id (UUID v7), including its accrued, carried-over, consumed and available days for the employee, absence type and year. A balance belonging to another company returns 404 absence_balance_not_found (anti-enumeration).

get/companies/{company}/absence-balances/{absence_balance}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/absence-balances/{absence_balance}
  • 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).

absence_balancestring uuid required

Public identifier (UUID v7) of the absence balance.

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": {
    "id": "01933a33-f398-72a4-8ab1-8b9c0d1e2f01",
    "object": "absence_balance",
    "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
    "absence_type_id": "01933a30-c065-7f71-9d8e-5e6f7a8b9c01",
    "absence_policy_id": "01933a31-d176-7082-8e9f-6f7a8b9c0d01",
    "year": 2026,
    "accrued_days": "23.00",
    "carried_over_days": "3.00",
    "carryover_expires_on": "2027-03-31",
    "consumed_days": "7.50",
    "available_days": "19.00",
    "measurement_unit": "days",
    "updated_at": "2026-05-04T09:03:01Z"
  }
}

Changes

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