absences

Update an existing absence.

PUT

/absence/{absenceId}

curl --request PUT \
  --url https://api-sandbox.timeking.nl/api/external/v1/absence/{absenceId} \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "absence_category_id": 123,
  "add_hours": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "days": [
    123
  ],
  "deleted_at": "2023-11-07T05:31:56Z",
  "deleted_by": 123,
  "description": "<string>",
  "end_date": "2023-12-25",
  "end_time": "2023-11-07T05:31:56Z",
  "entire_day": 123,
  "entries": [
    {
      "absence_id": 123,
      "atv_hours": "<string>",
      "date": "2023-12-25",
      "free_hours": "<string>",
      "id": 123,
      "special_leave_hours": "<string>",
      "tvt_hours": "<string>"
    }
  ],
  "hour_distribution": {},
  "id": 123,
  "internal_description": "<string>",
  "interval": 123,
  "occurrence": "<string>",
  "omission_id": 123,
  "pause_time": 123,
  "review_comment": "<string>",
  "start_date": "2023-12-25",
  "start_time": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "type_distribution": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": 123,
  "user_id": 123
}
'

{
  "data": {
    "absence": {
      "absence_category_id": 123,
      "add_hours": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": 123,
      "days": [
        123
      ],
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": 123,
      "description": "<string>",
      "end_date": "2023-12-25",
      "end_time": "2023-11-07T05:31:56Z",
      "entire_day": 123,
      "entries": [
        {
          "absence_id": 123,
          "atv_hours": "<string>",
          "date": "2023-12-25",
          "free_hours": "<string>",
          "id": 123,
          "special_leave_hours": "<string>",
          "tvt_hours": "<string>"
        }
      ],
      "hour_distribution": {},
      "id": 123,
      "internal_description": "<string>",
      "interval": 123,
      "occurrence": "<string>",
      "omission_id": 123,
      "pause_time": 123,
      "review_comment": "<string>",
      "start_date": "2023-12-25",
      "start_time": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "type_distribution": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": 123,
      "user_id": 123
    },
    "result": "<string>"
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Padparameters

absenceIdstringverplicht

The id of the absence to perform the action on.

Body

Absence object.

absence_category_idintegerverplicht

The ID of the absence category of this absence, or 0 for a leave balance mutation.

add_hoursinteger

Whether this leave balance mutation adds hours to the balance instead of deducting them; only used when absence_category_id is 0. Returned as 1 (yes) or 0 (no).

created_atstring

The date and time this absence was created.

created_byinteger

The ID of the backend user who created this absence, or 0 when it was not created by a backend user.

daysinteger[]

The days of the week this absence applies to, from 1 (Monday) to 7 (Sunday).

deleted_atstring

The date and time this absence was deleted, or null when it is not deleted.

deleted_byinteger

The ID of the backend user who deleted this absence, or 0 when it was not deleted by a backend user.

descriptionstring

The description of this absence.

end_datestringverplicht

The end date of this absence.

end_timestring

The end time of this absence when it does not cover the entire day; only the time of day is used.

entire_dayinteger

Whether this absence covers the entire day. Returned as 1 (yes) or 0 (no).

entriesobject[]

The booked hours of this absence, one entry per day.

child attributes tonen

hour_distributionobject

The absence hours per day as numeric strings, keyed by date in 'd-m-Y' format.

idinteger

The ID of this absence.

internal_descriptionstring

The internal comment on this absence.

intervalinteger

The number of weeks between repetitions when 'occurrence' is 'weekly_interval'.

occurrencestring

The repeat pattern of this absence, either 'weekly' or 'weekly_interval'; with 'weekly_interval' the absence repeats every 'interval' weeks.

omission_idinteger

The ID of the omission (non-attendance) whose waiting days created this absence.

pause_timeinteger

The break time of this absence in minutes when it does not cover the entire day.

review_commentstring

The reason the reviewer gave when rejecting this absence.

start_datestringverplicht

The start date of this absence.

start_timestring

The start time of this absence when it does not cover the entire day; only the time of day is used.

statusstring

The approval status of this absence, either 'open' (submitted), 'confirmed' (approved) or 'denied' (rejected).

type_distributionobject

The hours to book per leave type as numeric strings, keyed by 'free_hours', 'atv_hours' or 'tvt_hours'; empty when the default distribution order is used.

updated_atstring

The date and time this absence was last updated.

updated_byinteger

The ID of the backend user who last updated this absence, or 0 when it was not updated by a backend user.

user_idintegerverplicht

The ID of the user associated with this absence.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team