Absence Balances

List all absence balances

List your company’s absence balances with cursor-based pagination.

  • Each balance is accrued, carried-over and consumed days per employee, absence type and year, plus available_days.
  • Filter by employee_id, absence_type_id (UUID v7) and year.
  • Ledger amounts are decimal strings; available_days is rounded up to a whole day.
get/companies/{company}/absence-balances

Request

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

employee_idstring uuid nullable

Employee ID (UUID v7) to filter balances by.

absence_type_idstring uuid nullable

Absence type ID (UUID v7) to filter balances by.

yearinteger nullable

Accrual year to filter balances by.

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

ending_beforestring uuid

Cursor for backward pagination: pass the id of the first object on the current page.

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

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

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"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

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