Time clock

Ferie and permessi balances (status)

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

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/status?balance=ferie
get/api/v1/rest/timbratura/balances/status

Request

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

Query parameters

partyIdsstring[]

Default: everybody the person may see.

balance'ferie' | 'permessi'

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

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.

oktrue required

Changes

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