API employee UK: различия между версиями

Версия от 10:29, 10 мая 2026

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Співробітники

Додаткові параметри:
action - підкатегорія запиту (можливе значення: див. нижче)

Підкатегорії

add_notification

Додано у: 3.18beta1

Опис: Собудівля PUSH-увебудинокления для співробітника
Обов'язкові параметри:
 employee_id - ID співробітника
 body - текст
Необов'язкові параметри:
 color - HTML-колір окна с увебудиноклением

address_access_add

Додано у: 3.18beta1

Опис: Додавання адресного об'єкта в доступні адреса для співробітника
Обов'язкові параметри:
 employee_id - id співробітника
 address_id - id адресного об'єкта (-1 для всіх адрес, -2 для об'єктів без адреса)
 is_write - прапорець - доступ на запись

address_access_list

Додано у: 3.18beta1

Опис: Список доступних адресних об'єктів для співробітника
Обов'язкові параметри:
 employee_id - id співробітника
 is_write - прапорець - доступ на запись

address_access_remove

Додано у: 3.18beta1

Опис: Видалення адресного об'єкта из доступних адрес для співробітника
Обов'язкові параметри:
 employee_id - id співробітника
 address_id - id адресного об'єкта (-1 для всіх адрес, -2 для об'єктів без адреса)

check_pass

Додано у: 3.16dev2

Опис: Проверка совпадения логіна і пароля на вход в UserSide
Обов'язкові параметри:
 login - логін
 pass - пароль

З версії 3.16.28 після успішної автентифікації оновлюється дата активності співробітника

division_employee_add

Додано у: 3.19.44

Опис: Назначення співробітника в подразделение
Обов'язкові параметри:
 division_id - ID підрозділу
 employee_id - ID співробітника
Необов'язкові параметри:
 position_type - тип посади [head|deputy|worker]
 position_name - посада в підрозділі
 date_add - дата призначення

division_employee_remove

Додано у: 3.19.44

Опис: Виключення співробітника из підрозділу
Обов'язкові параметри:
 division_id - ID підрозділу
 employee_id - ID співробітника
Необов'язкові параметри:
 date_remove - дата исключения

edit

Доопрацьовано у: 3.19.40 (додано параметр ip_phone)

Доопрацьовано у: 3.19.33 (додано параметр is_blocked)

Додано у: 3.18beta1

Опис: Редагування запису о співробітнике
Обов'язкові параметри:
 id - id співробітника
Необов'язкові параметри:
 date_birthday - дата рождения
 date_in - дата принятия на работу
 date_out - дата увольнения
 first_name - имя
 gps_id - IMEI gps-треккера
 ip_phone - номер IP-телефона
 is_blocked - прапорець - заблокировать/разблокировать облікову запись
 middle_name - отчество
 last_name - фамабоя
 position - посада
 short_name - сокращенное имя/фамабоя
 messenger_chat_id - telegram/messenger chat_id

get_data

Додано з: 3.16dev2

Опис: Отримання информации о співробітнике
Необов'язкові параметри:
 id - id співробітника для вибірки (можна через кому)

get_division

Додано у: 3.16dev2

Опис: Отримання информации о підрозділі
Необов'язкові параметри:
 id - ID підрозділу (можна через кому)

get_division_list

Додано у: 3.16dev2

Опис: Список підрозділів

get_employee_id

Доопрацьовано у: 3.18.7 (до параметра data_typer додано можливе значення messenger_chat_id)

Додано з: 3.16dev2

Опис: Отримання ID співробітника за вхідними даними
Обов'язкові параметри:
 data_typer - тип даних, які перевіряємо (можливі значення: additional_field_XXX, name, login, messenger_chat_id)
 data_value - значення

get_history

Доопрацьовано у: 3.16dev6 (додано параметр object_id)

Додано у: 3.16dev2

Опис: История дій (лимит 10000 записів в результатах вибірки)
Обов'язкові параметри:
 date_from - дата начала вибірки (з)
 date_to - дата окончания вибірки (по)
Необов'язкові параметри:
 employee_id - id співробітника (можна через кому) 
 type_id - id типа дій (можна через кому)
 object_id - id связанного об'єкта (можна через кому)

get_history_type

Додано у: 3.16dev2

Опис: Типи дій в истории
Необов'язкові параметри:
 id - id типа дій

get_timesheet_data

Додано у: 3.16dev2

Опис: Отримання информации из табеля работ
Обов'язкові параметри:
 date_from - дата начала вибірки
 date_to - дата окончания вибірки
Необов'язкові параметри:
 employee_id - id співробітника (можна через кому)
 division_id - id підрозділу (можна через кому)

get_work_time_data

Додано у: 3.17dev1

Опис: Отримання информации о рабочем часу співробітников
Обов'язкові параметри:
 date_from - дата начала вибірки
 date_to - дата окончания вибірки
Необов'язкові параметри:
 employee_id - id співробітника (можна через кому)

get_unavailable_data

Додано у: 3.18beta1

Опис: Отримання информации о недоступности співробітника (відпустка, лікарняний)
Обов'язкові параметри:
 немає
Необов'язкові параметри:
 employee_id - id співробітника
 date_from - дата начала періоду
 date_to - дата окончания періоду

set_timesheet_data

Доопрацьовано у: 3.17dev1 (изменена логика параметра value)

Додано у: 3.16dev2

Опис: Додавання/зміна/видалення запису в табель работ
Обов'язкові параметри:
 employee_id - id співробітника
 date - дата
 type_id - id типа запису (1 - основное час, 2 - сверхурочное, 3 - прочее)
 value - кількість годин (після 3.17dev1: кількість годин або текстова літера для позначення неробочого періоду, або порожнє значення для видалення запису; до 3.17dev1: ціле значення, або: 994 - черговий, 995 - не вийшов, 996 - відпустка, 997 - вихідний, 998 - лікарняний, 999 - відрядження, або 0 для видалення запису)

set_unavailable_data

Додано у: 3.17dev1

Опис: Додавання/зміна/видалення запису о недоступности співробітника (відпустка, лікарняний)
Обов'язкові параметри:
 employee_id - ID співробітника
 date_from - дата начала періоду
 date_to - дата окончания періоду
Необов'язкові параметри:
 type_id - id типа запису (1 - відпустка, 2 - лікарняний, не заполнено - удалить запись)

task_address_access_add

Додано у: 3.18beta1

Опис: Додавання адресного об'єкта в список адрес, куда може бути назначен співробітник на роботи
Обов'язкові параметри:
 employee_id - id співробітника
 address_id - id адресного об'єкта (-1 для всіх адрес, -2 для об'єктів без адреса)

task_address_access_list

Додано у: 3.18beta1

Опис: Список адрес, куда може бути назначен співробітник на роботи
Обов'язкові параметри:
 employee_id - id співробітника

task_address_access_remove

Додано у: 3.18beta1

Опис: Видалення адресного об'єкта зі списку адрес, куди співробітника можна призначити на роботи
Обов'язкові параметри:
 employee_id - id співробітника
 address_id - id адресного об'єкта (-1 для всіх адрес, -2 для об'єктів без адреса)

work_time_finish

Додано у: 3.16dev5

Опис: Фіксація момента окончания рабочего часу співробітника 
Обов'язкові параметри:
 employee_id - id співробітника
 date - дата і час
Необов'язкові параметри:
 comment - нотатки

work_time_start

Додано у: 3.16dev5

Опис: Фіксація момента начала рабочего часу співробітника 
Обов'язкові параметри:
 employee_id - id співробітника
 date - дата і час
Необов'язкові параметри:
 comment - нотатки

@@ Строка 25: / Строка 25: @@
 ''Додано у: 3.18beta1''
-  Опис: Додавання адресного об'єкта в доступные адреса для співробітника
+  Опис: Додавання адресного об'єкта в доступні адреса для співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для усіх адресов, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
    is_write - прапорець - доступ на запись
@@ Строка 35: / Строка 35: @@
 ''Додано у: 3.18beta1''
-  Опис: Список доступных адресных об'єктів для співробітника
+  Опис: Список доступних адресних об'єктів для співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
@@ Строка 44: / Строка 44: @@
 ''Додано у: 3.18beta1''
-  Опис: Видалення адресного об'єкта из доступных адресов для співробітника
+  Опис: Видалення адресного об'єкта из доступних адрес для співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для усіх адресов, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
 ==== check_pass ====
@@ Строка 56: / Строка 56: @@
    pass - пароль
-С версії 3.16.28 при успешной аутентификации обновляется дата активности у співробітника
+З версії 3.16.28 після успішної автентифікації оновлюється дата активності співробітника
 ==== division_employee_add ====
@@ Строка 65: / Строка 65: @@
    employee_id - ID співробітника
   Необов'язкові параметри:
-   position_type - тип должности [head|deputy|worker]
+   position_type - тип посади [head|deputy|worker]
-   position_name - должность в подразделении
+   position_name - посада в підрозділі
-   date_add - дата назначення
+   date_add - дата призначення
 ==== division_employee_remove ====
 ''Додано у: 3.19.44''
-  Опис: Исключение співробітника из підрозділу
+  Опис: Виключення співробітника из підрозділу
   Обов'язкові параметри:
    division_id - ID підрозділу
@@ Строка 86: / Строка 86: @@
 ''Додано у: 3.18beta1''
-  Опис: Редагування записи о співробітнике
+  Опис: Редагування запису о співробітнике
   Обов'язкові параметри:
    id - id співробітника
@@ Строка 96: / Строка 96: @@
    gps_id - IMEI gps-треккера
    ip_phone - номер IP-телефона
-   is_blocked - прапорець - заблокировать/разблокировать учётную запись
+   is_blocked - прапорець - заблокировать/разблокировать облікову запись
    middle_name - отчество
-   last_name - фамилия
+   last_name - фамабоя
-   position - должность
+   position - посада
-   short_name - сокращенное имя/фамилия
+   short_name - сокращенное имя/фамабоя
    messenger_chat_id - telegram/messenger chat_id
@@ Строка 107: / Строка 107: @@
   Опис: Отримання информации о співробітнике
   Необов'язкові параметри:
-   id - id співробітника для выборки ''(можна через кому)''
+   id - id співробітника для вибірки ''(можна через кому)''
 ==== get_division ====
 ''Додано у: 3.16dev2''
-  Опис: Отримання информации о подразделении
+  Опис: Отримання информации о підрозділі
   Необов'язкові параметри:
    id - ID підрозділу ''(можна через кому)''
@@ Строка 120: / Строка 120: @@
 ==== get_employee_id ====
-''Доопрацьовано у: 3.18.7 (в параметр data_typer добавлено возможное значення messenger_chat_id)''
+''Доопрацьовано у: 3.18.7 (до параметра data_typer додано можливе значення messenger_chat_id)''
 ''Додано з: 3.16dev2''
-  Опис: Отримання ID співробітника по входящим данным
+  Опис: Отримання ID співробітника за вхідними даними
   Обов'язкові параметри:
-   data_typer - тип данных, которые проверяем ''(возможные значення: additional_field_XXX, name, login, messenger_chat_id)''
+   data_typer - тип даних, які перевіряємо ''(можливі значення: additional_field_XXX, name, login, messenger_chat_id)''
    data_value - значення
@@ Строка 133: / Строка 133: @@
 ''Додано у: 3.16dev2''
-  Опис: История действий ''(лимит 10000 записей в результатах выборки)''
+  Опис: История дій ''(лимит 10000 записів в результатах вибірки)''
   Обов'язкові параметри:
-   date_from - дата начала выборки ''(с)''
+   date_from - дата начала вибірки ''(з)''
-   date_to - дата окончания выборки ''(по)''
+   date_to - дата окончания вибірки ''(по)''
   Необов'язкові параметри:
    employee_id - id співробітника ''(можна через кому)''
-   type_id - id типа действий ''(можна через кому)''
+   type_id - id типа дій ''(можна через кому)''
    object_id - id связанного об'єкта ''(можна через кому)''
 ==== get_history_type ====
 ''Додано у: 3.16dev2''
-  Опис: Типы действий в истории
+  Опис: Типи дій в истории
   Необов'язкові параметри:
-   id - id типа действий
+   id - id типа дій
 ==== get_timesheet_data ====
@@ Строка 152: / Строка 152: @@
   Опис: Отримання информации из табеля работ
   Обов'язкові параметри:
-   date_from - дата начала выборки
+   date_from - дата начала вибірки
-   date_to - дата окончания выборки
+   date_to - дата окончания вибірки
   Необов'язкові параметри:
    employee_id - id співробітника ''(можна через кому)''
@@ Строка 160: / Строка 160: @@
 ==== get_work_time_data ====
 ''Додано у: 3.17dev1''
-  Опис: Отримання информации о рабочем времени співробітников
+  Опис: Отримання информации о рабочем часу співробітников
   Обов'язкові параметри:
-   date_from - дата начала выборки
+   date_from - дата начала вибірки
-   date_to - дата окончания выборки
+   date_to - дата окончания вибірки
   Необов'язкові параметри:
    employee_id - id співробітника ''(можна через кому)''
@@ Строка 170: / Строка 170: @@
 ''Додано у: 3.18beta1''
-  Опис: Отримання информации о недоступности співробітника ''(отпуск, больничный)''
+  Опис: Отримання информации о недоступности співробітника ''(відпустка, лікарняний)''
   Обов'язкові параметри:
-   нет
+   немає
   Необов'язкові параметри:
    employee_id - id співробітника
-   date_from - дата начала периода
+   date_from - дата начала періоду
-   date_to - дата окончания периода
+   date_to - дата окончания періоду
 ==== set_timesheet_data ====
@@ Строка 183: / Строка 183: @@
 ''Додано у: 3.16dev2''
-  Опис: Додавання/зміна/видалення записи в табель работ
+  Опис: Додавання/зміна/видалення запису в табель работ
   Обов'язкові параметри:
    employee_id - id співробітника
    date - дата
-   type_id - id типа записи ''(1 - основное час, 2 - сверхурочное, 3 - прочее)''
+   type_id - id типа запису ''(1 - основное час, 2 - сверхурочное, 3 - прочее)''
-   value - количество часов ''(после 3.17dev1: количество часов или текстовая буква для отметки нерабочего периода, або пустое значення для удаления записи; до 3.17dev1: целое значення, або: 994 - дежурный, 995 - не вышел, 996 - отпуск, 997 - выходной, 998 - больничный, 999 - командировка, або 0 для удаления записи)''
+   value - кількість годин ''(після 3.17dev1: кількість годин або текстова літера для позначення неробочого періоду, або порожнє значення для видалення запису; до 3.17dev1: ціле значення, або: 994 - черговий, 995 - не вийшов, 996 - відпустка, 997 - вихідний, 998 - лікарняний, 999 - відрядження, або 0 для видалення запису)''
 ==== set_unavailable_data ====
 ''Додано у: 3.17dev1''
-  Опис: Додавання/зміна/видалення записи о недоступности співробітника ''(отпуск, больничный)''
+  Опис: Додавання/зміна/видалення запису о недоступности співробітника ''(відпустка, лікарняний)''
   Обов'язкові параметри:
    employee_id - ID співробітника
-   date_from - дата начала периода
+   date_from - дата начала періоду
-   date_to - дата окончания периода
+   date_to - дата окончания періоду
   Необов'язкові параметри:
-   type_id - id типа записи ''(1 - отпуск, 2 - больничный, не заполнено - удалить запись)''
+   type_id - id типа запису ''(1 - відпустка, 2 - лікарняний, не заполнено - удалить запись)''
 ==== task_address_access_add ====
@@ Строка 205: / Строка 205: @@
 ''Додано у: 3.18beta1''
-  Опис: Додавання адресного об'єкта в список адресов, куда может быть назначен співробітник на работы
+  Опис: Додавання адресного об'єкта в список адрес, куда може бути назначен співробітник на роботи
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для усіх адресов, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
 ==== task_address_access_list ====
@@ Строка 214: / Строка 214: @@
 ''Додано у: 3.18beta1''
-  Опис: Список адресов, куда может быть назначен співробітник на работы
+  Опис: Список адрес, куда може бути назначен співробітник на роботи
   Обов'язкові параметри:
    employee_id - id співробітника
@@ Строка 222: / Строка 222: @@
 ''Додано у: 3.18beta1''
-  Опис: Видалення адресного об'єкта из списка адресов, куда может быть назначен співробітник на работы
+  Опис: Видалення адресного об'єкта зі списку адрес, куди співробітника можна призначити на роботи
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для усіх адресов, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
 ==== work_time_finish ====
 ''Додано у: 3.16dev5''
-  Опис: Фиксация момента окончания рабочего времени співробітника
+  Опис: Фіксація момента окончания рабочего часу співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
@@ Строка 238: / Строка 238: @@
 ==== work_time_start ====
 ''Додано у: 3.16dev5''
-  Опис: Фиксация момента начала рабочего времени співробітника
+  Опис: Фіксація момента начала рабочего часу співробітника
   Обов'язкові параметри:
    employee_id - id співробітника