TargetHour

Changed on
post/targethours

Request

  • Base URL
    https://my.clockodo.com/api
  • URL
    https://my.clockodo.com/api/targethours
  • Auth
    • HTTP basic and API key in header X-Clockodo-External-Application
    • or API key in header X-ClockodoApiUser and API key in header X-ClockodoApiKey and API key in header X-Clockodo-External-Application
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /token

Request body

users_idinteger required
type'weekly' | 'monthly' required

Possible values:

  • weekly: Weekly
  • monthly: Monthly
date_sincestring date required
date_untilstring date nullable required
mondaynumber float
tuesdaynumber float
wednesdaynumber float
thursdaynumber float
fridaynumber float
saturdaynumber float
sundaynumber float
monthly_targetnumber float
workday_mondayboolean
workday_tuesdayboolean
workday_wednesdayboolean
workday_thursdayboolean
workday_fridayboolean
workday_saturdayboolean
workday_sundayboolean
compensation_dailyinteger

Automatic time compensation per day in minutes

compensation_monthlyinteger required

Compensation for monthly target hours in minutes

holiday_fixed_credit0 | 1
surcharge_models_idinteger nullable

Example request

{
  "date_since": "2023-02-28",
  "date_until": "2023-02-28"
}

Response

Successful operation

Example response

{
  "targethoursRow": {
    "id": 10,
    "users_id": 10,
    "surcharge_models_id": 10,
    "type": "weekly",
    "date_since": "2023-02-28",
    "date_until": "2023-03-03",
    "monday": 8.5,
    "tuesday": 8.5,
    "wednesday": 8.5,
    "thursday": 8.5,
    "friday": 8.5,
    "saturday": 8.5,
    "sunday": 8.5,
    "absence_fixed_credit": true,
    "compensation_daily": 30.5,
    "compensation_monthly": 0.5
  }
}

Changes

  • d80ab704f3f6Revision changes
    • info

      api operation id createTargethour removed and replaced with createTargetHour

  • a88d0ed986cfRevision changes
    • breaking

      the request property type changed from number to integer

    • breaking

      the request property type changed from number to integer

    • breaking

      the request property type changed from number to integer

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the request property became nullable