Time Tracking Settings

Update the time tracking settings

Create or partially update your company's time tracking configuration; an omitted field keeps its current value.

  • Fields: overtime_basis (weekly/daily), overtime thresholds in minutes (null derives them from the schedule), overtime_tolerance_minutes and the clock-in reminder settings.
  • A negative threshold or tolerance returns 422.
patch/companies/{company}/time-tracking-settings

Request

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

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

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.

Request body

overtime_basis'weekly' | 'daily'

Overtime computation basis: weekly or daily. Optional: when omitted it keeps its current value.

overtime_daily_threshold_minutesinteger nullable

Daily overtime threshold in minutes (null = derive from the schedule).

overtime_weekly_threshold_minutesinteger nullable

Weekly overtime threshold in minutes (null = derive from the schedule).

overtime_tolerance_minutesinteger

Overtime rounding tolerance in minutes. Optional: when omitted it keeps its current value.

clock_in_reminder_enabledboolean

Whether the missed clock-in reminder is enabled. Optional: when omitted it keeps its current value.

clock_in_reminder_grace_minutesinteger

Grace minutes after the scheduled time before reminding. Optional: when omitted it keeps its current value.

Response

Example response

{
  "data": {
    "id": "01933a23-c060-7a71-8b82-5e6f7a8b9c02",
    "object": "time_tracking_settings",
    "overtime_basis": "weekly",
    "overtime_weekly_threshold_minutes": 2400,
    "overtime_tolerance_minutes": 15,
    "clock_in_reminder_enabled": true,
    "clock_in_reminder_grace_minutes": 30
  }
}

Changes

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