---
title: "Start a pause"
method: POST
path: "/companies/{company}/time-entries/pause"
tags: ["Time Entries"]
---

# Start a pause

`POST /companies/{company}/time-entries/pause`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/time-entries/pause`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Start a pause in the employee’s current work span. `employee_id` (UUID v7) and `source` are required. Valid only when the employee is `working`; an invalid transition returns 422 in Spanish. Returns 201 with the created `pause_start` entry.

## Path parameters

- `company` string, uuid, required

## Headers

- `Idempotency-Key` string
- `Factuarea-Version` string, date

## Request body

- ClockActionRequest
  - `employee_id` string, uuid, required: Employee ID (UUID v7) clocking in or out.
  - `source` 'web' | 'mobile', required: Origin of the clock entry: `web` or `mobile`.
  - `occurred_at` string, date-time, nullable: Clock entry timestamp in ISO 8601 (defaults to the server instant).

## Response `201`

Pause recorded. The `Location` header contains the canonical URL of the new time entry.

- object
  - `data` TimeEntry, required: A single entry of the immutable time record ledger (a clock event) for the Control Horario (time tracking) module. Every clock-in, pause, resume and clock-out — live or retroactive — is an entry chained by fingerprint. The workday state is derived from these entries; there is no session table. Fingerprints are never exposed.
    - `id` string, uuid, required: Opaque identifier of the time entry, a UUID v7 (e.g. `01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a9b`).
    - `object` 'time_entry', required: Always `time_entry`.
    - `employee_id` string, uuid, required: UUID v7 of the employee the entry belongs to.
    - `entry_type` 'clock_in' | 'pause_start' | 'pause_end' | 'clock_out', required: Type of clock event: `clock_in` (opens a work span), `pause_start`, `pause_end` or `clock_out` (closes the span).
    - `occurred_at` string, date-time, required: When the clock event happened (ISO 8601). For retroactive entries this is the past instant supplied by the manager.
    - `recorded_at` string, date-time, required: When the entry was appended to the ledger (ISO 8601).
    - `source` 'web' | 'mobile' | 'manual', required: Origin of the entry: `web` or `mobile` (live self-service) or `manual` (retroactive entry recorded by a manager).
    - `is_retroactive` boolean, required: Whether the entry was recorded retroactively (a manual entry by a manager) rather than clocked live.
    - `reason` string, nullable, required: Reason for the retroactive entry; `null` for live entries.
    - `created_at` string, date-time, required: Row creation timestamp (ISO 8601).

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `409`: The request conflicts with data that already exists or with a request running at the same time. `resource_conflict`: another request was reserving identifiers for the same kind of record at that moment and this one could not complete its reservation. Nothing was written; send the request again after a few seconds.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)