Для AI-агентов: markdown этой страницы — /docs-content/workday/time-control-explain.md индекс документации — /llms.txt

Объяснить отсутствие

POST /v1/workday/time-control/reports/:absenceId

Записывает объяснение к отсутствию из месячного отчёта контроля рабочего времени: текст, тип и при необходимости событие в календаре сотрудника. Повторный вызов заменяет прежнее объяснение, ответ тот же.

Требуется скоуп timeman. Объяснение записывается от имени владельца учётных данных: сотрудник объясняет своё отсутствие, администратор — отсутствие любого сотрудника, передав его userId. Сотруднику нужен доступ к месячному отчёту: пока контроль рабочего времени выключен, active: false в настройках контроля времени, он получает 403 BITRIX_ACCESS_DENIED. Администратора и руководителя подразделения это не касается. Ключ READONLY объяснение не записывает.

Параметры

Параметр Тип Обяз. По умолч. Описание
absenceId (path) integer да — ID отсутствия — report.days[].reports[].id из ответа /v1/workday/time-control/reports на странице Получить месячный отчёт об отсутствиях

Поля запроса (body)

Поле Тип Обяз. По умолч. Описание
text string да — Текст объяснения, не пустой
month integer да — Месяц отсутствия, от 1 до 12. По месяцу и году отсутствие ищется в месячном отчёте сотрудника
year integer да — Год отсутствия, от 1900 до 3000
type string нет PRIVATE Тип объяснения: WORK — рабочее, PRIVATE — личное
calendar boolean нет true Создать событие в календаре сотрудника на время отсутствия с текстом объяснения. При type: PRIVATE событие личное
userId integer нет владелец учётных данных ID сотрудника, чьё отсутствие объясняется. Учитывается только у администратора, у остальных игнорируется. Список: GET /v1/users, сотрудники подразделения — GET /v1/workday/time-control/users

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/workday/time-control/reports/153" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Встреча с клиентом", "month": 10, "year": 2026, "type": "WORK", "calendar": false}'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/workday/time-control/reports/153" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text": "Встреча с клиентом", "month": 10, "year": 2026, "type": "WORK", "calendar": false}'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/time-control/reports/153', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ text: 'Встреча с клиентом', month: 10, year: 2026, type: 'WORK', calendar: false }),
})
const { success } = await res.json()

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/time-control/reports/153', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ text: 'Встреча с клиентом', month: 10, year: 2026, type: 'WORK', calendar: false }),
})
const { success } = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при успешной записи
data boolean Всегда true. Записанное объяснение видно в полях reportType и reportText отсутствия в месячном отчёте

Пример ответа

JSON 
{
  "success": true,
  "data": true
}

Пример ответа при ошибке

404 — отсутствия с таким absenceId нет в отчёте сотрудника за указанный месяц:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Absence not found for this user and month"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS absenceId не положительное целое или text пуст, type не WORK и не PRIVATE, calendar не boolean, month или year не переданы или вне диапазона, userId не положительное целое, тело запроса не объект
404 ENTITY_NOT_FOUND Отсутствия с таким absenceId нет в отчёте сотрудника за указанный месяц: другой месяц, чужое отсутствие или несуществующий userId у администратора
403 BITRIX_ACCESS_DENIED Сотруднику недоступен месячный отчёт: контроль рабочего времени выключен, active: false в настройках контроля времени. Выключенный инструмент учёта времени на портале даёт не этот код, а 409
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
409 TIMEMAN_MODULE_NOT_ENABLED Учёт рабочего времени недоступен на портале: инструмент «Рабочее время и отчёты» выключен в настройках портала или модуль не входит в тариф
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ответ неожиданной формы
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Ключ приложения передан без токена сессии в Authorization: Bearer
401 INVALID_SESSION Токен сессии неверный или истёк
403 SCOPE_DENIED У ключа нет скоупа timeman
429 RATE_LIMITED Превышен общий лимит запросов, срок повтора — в заголовке Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Событие календаря живёт отдельно от объяснения. При calendar: true событие создаётся в личном календаре сотрудника на интервал отсутствия, его ID в ответе не возвращается. Повторное объяснение прежнее событие не меняет и не удаляет, а с calendar: true создаёт ещё одно. Найти события можно в событиях календаря сотрудника по тексту объяснения и времени отсутствия, удалить — через DELETE /v1/calendar-events/:id.

Смотрите также