> ## Documentation Index
> Fetch the complete documentation index at: https://api.tipee.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# Clock

> Clocks timechecks and/or activities in and out, each entry of "content" being one clocking at the given time (now when omitted).

<Warning>This endpoint is in preview: it may change without notice until it becomes part of a stable version.</Warning>


## OpenAPI

````yaml preview post /api/timeclock/timechecks.clock
openapi: 3.1.0
info:
  title: tipee
  version: preview
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Security
    description: Security
  - name: Timeclock
    description: Timeclock
paths:
  /api/timeclock/timechecks.clock:
    post:
      tags:
        - Timeclock
      summary: Clock
      description: >-
        Clocks timechecks and/or activities in and out, each entry of "content"
        being one clocking at the given time (now when omitted).
      operationId: post_app_ui_api_timeclock_timeclockcommand_clocktimecheck
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClockTimecheckCommand'
      responses:
        '204':
          description: Clocking recorded
        '409':
          description: Clocking not fully recorded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClockTimeConflictDTO'
components:
  schemas:
    ClockTimecheckCommand:
      required:
        - content
      properties:
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        content:
          type: array
          items:
            $ref: '#/components/schemas/DeviceClockTime'
          minItems: 1
      type: object
      additionalProperties: false
    ClockTimeConflictDTO:
      required:
        - error
        - body
      properties:
        error:
          type: string
          enum:
            - multiple_errors
        body:
          description: The time ranges left unrecorded, indexed by error type
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/LocalDateTimeInterval'
          propertyNames:
            $ref: '#/components/schemas/ClockTimeErrorTypes'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    DeviceClockTime:
      properties:
        time:
          $ref: '#/components/schemas/LocalDateTime'
        name:
          type: string
        beacon:
          $ref: '#/components/schemas/BeaconStatus'
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        activity:
          anyOf:
            - $ref: '#/components/schemas/ClockOut'
            - $ref: '#/components/schemas/ClockActivity'
        timecheck:
          anyOf:
            - $ref: '#/components/schemas/ClockOut'
            - $ref: '#/components/schemas/ClockTimecheck'
      type: object
      additionalProperties: false
    LocalDateTimeInterval:
      type: string
      format: local-date-time-interval
      example: 2019-11-11T12:34:56/2019-12-12T23:59:59
    LocalDateTime:
      type: string
      format: local-date-time
      example: '2019-11-11T12:34:56'
    BeaconStatus:
      required:
        - serial
      properties:
        serial:
          type: string
          maxLength: 255
        battery:
          type: integer
      type: object
      additionalProperties: false
    Geolocation:
      required:
        - latitude
        - longitude
        - accuracy
      properties:
        latitude:
          type:
            - number
            - 'null'
          format: float
          default: null
        longitude:
          type:
            - number
            - 'null'
          format: float
          default: null
        accuracy:
          type:
            - number
            - 'null'
          format: float
          default: null
      type: object
      additionalProperties: false
    ClockOut:
      required:
        - direction
      properties:
        direction:
          type: string
          enum:
            - out
      type: object
      additionalProperties: false
    ClockActivity:
      required:
        - task_id
        - direction
      properties:
        task_id:
          $ref: '#/components/schemas/Snowflake'
        remark:
          type: string
        direction:
          type: string
          enum:
            - in
      type: object
      additionalProperties: false
    ClockTimecheck:
      required:
        - direction
        - tag_ids
      properties:
        direction:
          type: string
          enum:
            - in
        tag_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        mode:
          $ref: '#/components/schemas/TaggingMode'
          description: Defaults to "inherit-all" when omitted.
        remark:
          type: string
      type: object
      additionalProperties: false
    TaggingMode:
      type: string
      example: override-adding-inherit
      enum:
        - override-adding-inherit
        - inherit-all
        - override-all
        - ignore-missing-inherit

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.