---
title: "Ferie and permessi balances"
method: GET
path: "/api/v1/rest/timbratura/balances"
tags: ["Time clock"]
---

# Ferie and permessi balances

`GET /api/v1/rest/timbratura/balances`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/timbratura/balances`
- Auth: HTTP bearer

Per employee and balance (ferie, permessi, ROL, banca ore): initial, accrued, adjusted, used, pending and the residual, in minutes and in days of the standard working day.

**Examples**

- Quante ferie mi restano?
  `GET /api/v1/rest/timbratura/balances?balance=ferie`

## Query parameters

- `partyIds` string[]
- `balance` 'ferie' | 'permessi'

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s answer, as described here. Its objects may carry fields this description does not name yet: read the ones you need and ignore the rest.

- object
  - `ok` true, required
  - `data` TimbraturaGetBalancesResult, required
    - `items` object[], required
      - `partyId` string, required
      - `employeeName` string, required
      - `balance` 'ferie' | 'permessi', required
      - `assignmentId` string, nullable, required
      - `templateName` string, nullable, required
      - `startedOn` string, nullable, required
      - `initialMin` number, required
      - `accruedMin` number, required
      - `adjustedMin` number, required
      - `usedMin` number, required
      - `pendingMin` number, required
      - `residualMin` number, required
      - `dayMin` number, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)