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

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

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Дії с ТМЦ і складом

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

В обліку ТМЦ використовується понятие как "счет учета".

Счета представляют значення вида "205031234567"

Перші 3 цифри:

101 - Постачальники
203 - Співробітники (до 3.16dev2)
204 - Склад
205 - Абонент
206 - Сооружение связи
210 - Кабельная линия
211 - Линия связи (з 3.15 вместо неї використовується 210)
212 - Завдання
213 - Будівлі
214 - Склад (ТМЦ находится на цей момент в транзите)
215 - Співробітники (з 3.16dev2)
900 - Списано

4 і 5 цифра - субсчет

01 - Подотчет долгий
02 - Подотчет короткий
03 - ТМЦ
08 - Аренда
09 - Облік проданого
.. (з 3.17dev1 можна додавати власні субрахунки)

Останні 7 цифр - це ID об'єкта з початковими нулями

205031234567 - Рахунок абонента id 1234567 і субсчет звичайного учета ТМЦ

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

add_inventory

Змінено у 3.19beta1 (параметр storage_id зроблено обов'язковим)

Змінено у 3.18.26 (добавлен входящий параметр is_check_serial_number)

Опис: Приход ТМЦ
Обов'язкові параметри:
 inventory_catalog_id - ID наименования ТМЦ
 trader_id - ID постачальника
 storage_id - ID склада, на який виконати приход
Необов'язкові параметри:
 amount - кількість (по-умолчанию: 1)
 cost - стоимость (по-умолчанию: 0)
 comment - нотатки
 sn - серійний номер
 barcode - штрихкод
 inventory_number - інвентарний номер
 document_number - номер документа прихода
 document_date - дата документа прихода
 additional_data_ip - IP-адрес (для ТМЦ-обладнання)
 additional_data_mac - MAC-адрес (для ТМЦ-обладнання)
 is_check_serial_number - проверять на збіг серійний номер с уже существующими ТМЦ

add_inventory_assortment

Додано у: 3.14.1

Опис: Додавання наименования ТМЦ
Обов'язкові параметри:
 section_id - id секции каталога товаров
 name - найменування
Необов'язкові параметри:
 unit_name - единица измерения
 is_require_serial_number - прапорець - вимагати введення серійного номера під час надходження ТМЦ
 is_require_mac - прапорець - вимагати введення MAC-адреси під час надходження ТМЦ

add_inventory_section

Додано у: 3.14.1

Опис: Додавання раздела каталога товаров
Обов'язкові параметри:
 name - найменування
Необов'язкові параметри:
 typer - id спецпризнака (по-умолчанию: 0)
 parent_id - id батьківського раздела каталога
 is_show_on_map - прапорець - отображать ли об'єкти цього раздела слоем на карте

add_inventory_to_operation

Додано у: 3.13.38

Опис: Додавання ТМЦ в операцию
Обов'язкові параметри:
 operation_id - id операції
 inventory_id - id ТМЦ (воно має перебувати на рахунку-джерелі операції)
Необов'язкові параметри:
 amount - кількість ТМЦ (якщо в ТМЦ більше 1 одиниці)

change_arg_ip

Додано у: 3.12.81

Опис: Зміна IP-адреса до параметраах ТМЦ
Обов'язкові параметри:
 id - ID ТМЦ
 value - IP-адрес

change_arg_mac

Додано у: 3.12.81

Опис: Зміна MAC-адреса до параметраах ТМЦ
Обов'язкові параметри:
 id - ID ТМЦ
 value - MAC-адрес

change_comment

Додано у: 3.12.81

Опис: Зміна нотатки ТМЦ
Обов'язкові параметри:
 id - ID ТМЦ
 value - заметка

change_price

Додано у: 3.19beta1

Опис: Зміна стоимости ТМЦ
Обов'язкові параметри:
 id - ID ТМЦ
 value - стоимость

change_serial_number

Додано у: 3.12.52

Опис: Зміна серийного номера у ТМЦ
Обов'язкові параметри:
 id - ID ТМЦ
 value - серійний номер

delete_inventory

Додано у: 3.13.48

Опис: Видалення СПИСАННОГО ТМЦ
Обов'язкові параметри:
 id - id ТМЦ (ТМЦ обов'язково має бути списаним)

edit_inventory_assortment

Додано у: 3.14.1

Опис: Редагування наименования ТМЦ
Обов'язкові параметри:
 id - id наименования
Необов'язкові параметри:
 name - найменування
 unit_name - единица измерения
 is_require_serial_number - прапорець - вимагати введення серійного номера під час надходження ТМЦ
 is_require_mac - прапорець - вимагати введення MAC-адреси під час надходження ТМЦ

edit_inventory_section

Додано у: 3.14.1

Опис: Редагування раздела каталога товаров
Обов'язкові параметри:
 id - id раздела каталога
Необов'язкові параметри:
 name - найменування
 parent_id - id батьківського раздела каталога
 is_show_on_map - прапорець - отображать ли об'єкти цього раздела слоем на карте

get_inventory

Опис: Отримання информации о ТМЦ
Обов'язкові параметри:
 id - ID ТМЦ

get_inventory_amount

Доопрацьовано у: 3.16dev3 (додано параметри inventory_type_id, section_id)

Доопрацьовано у: 3.16dev2 (до параметра location значення staff заменено на employee)

Доопрацьовано у: 3.12.85 (до параметра location додано можливе значення task)

Доопрацьовано у: 3.12.71 (у параметрі object_id можна подавати значення через кому)

Доопрацьовано у: 3.12beta27 (додано параметр location)

Опис: Отримання списку ТМЦ
Обов'язкові параметри:
 location - категорія обліку [storage|employee|customer|node|task] (staff - до 3.16dev2)
Необов'язкові параметри:
 object_id - id об'єкта обліку (можна через кому)
 inventory_type_id - id наименования ТМЦ (можна через кому)
 section_id - id секции каталога товаров (можна через кому)

get_inventory_catalog

Доопрацьовано у: 3.18beta1 (додано параметр id)

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

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

get_inventory_catalog_id_by_name

Опис: Отримання ID наименования ТМЦ по его названию
Обов'язкові параметри:
 name - найменування

get_inventory_id

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

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

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

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

Опис: Отримання ID ТМЦ за вхідними даними
Необов'язкові параметри:
 is_all_data - прапорець - повертати всі знайдені ТМЦ, а не тільки одне
Обов'язкові параметри:
 data_typer - тип даних, які перевіряємо (можливі значення: barcode, inventory_number, serial_number, mac, ip)
 data_value - значення

get_inventory_section_catalog

Опис: Отримання наименований каталога ТМЦ

get_inventory_storage

Опис: Отримання списку складів

get_operation

Доопрацьовано у: 3.18beta1 (додано параметри employee_id, inventory_assortment_id)

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

Додано у: 3.12.90

Опис: Отримання информации по операциям
Необов'язкові параметри (але має бути хоч щось):
 id - ID операції (можна кілька значень через кому)
 src_account - рахунок-кредита (откуда)
 dst_account - рахунок-дебита (куда)
 date_start - дата начала періоду
 date_finish - дата окончания періоду
 inventory_id - id ТМЦ
 employee_id - id співробітника - инициатора операції
 inventory_assortment_id - id наименования ТМЦ

split_inventory

Добавлен в: 3.13.35

Опис: Розділение ТМЦ
Обов'язкові параметри:
 id - id ТМЦ
 amount - требуемое кількість

У результаті розділення в ТМЦ id залишиться кількість, що дорівнює amount, і буде створено нове ТМЦ (повернеться у змінній new_id) із залишковою кількістю.

transfer_inventory

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.12.89 (додано параметри operator_id, comment)

Опис: Перемещение ТМЦ
Обов'язкові параметри:
 inventory_id - ID ТМЦ
 dst_account - Счет-получатель
Необов'язкові параметри
 comment - нотатки
 employee_id - ID співробітника - автора операції
 operator_id - ID оператора - автора операції (до версії 3.16dev2)

@@ Строка 8: / Строка 8: @@
   action - підкатегорія запиту ''(можливе значення: див. нижче)''
-В учёте ТМЦ используется понятие как "счет учета".
+В обліку ТМЦ використовується понятие как "счет учета".
 Счета представляют значення вида "205031234567"
-Первые 3 цифры:
+Перші 3 цифри:
 - Постачальники
 - Співробітники ''(до 3.16dev2)''
@@ Строка 19: / Строка 19: @@
 - Сооружение связи
 - Кабельная линия
-- Линия связи ''(с 3.15 вместо неё используется 210)''
+- Линия связи ''(з 3.15 вместо неї використовується 210)''
 - Завдання
-- Здания
+- Будівлі
-- Склад ''(ТМЦ находится на данный момент в транзите)''
+- Склад ''(ТМЦ находится на цей момент в транзите)''
-- Співробітники ''(с 3.16dev2)''
+- Співробітники ''(з 3.16dev2)''
 - Списано
@@ Строка 31: / Строка 31: @@
 - ТМЦ
 - Аренда
-- Учет проданного
+- Облік проданого
-  .. ''(с 3.17dev1 можно добавлять собственные субсчета)''
+  .. ''(з 3.17dev1 можна додавати власні субрахунки)''
-Последние 7 цифр - это ID об'єкта с ведущими нулями
+Останні 7 цифр - це ID об'єкта з початковими нулями
-205031234567 - Счёт абонента id 1234567 і субсчет обычного учета ТМЦ
+205031234567 - Рахунок абонента id 1234567 і субсчет звичайного учета ТМЦ
 == Підкатегорії ==
@@ Строка 50: / Строка 50: @@
    inventory_catalog_id - ID наименования ТМЦ
    trader_id - ID постачальника
-   storage_id - ID склада, на который выполнить приход
+   storage_id - ID склада, на який виконати приход
   Необов'язкові параметри:
-   amount - количество ''(по-умолчанию: 1)''
+   amount - кількість ''(по-умолчанию: 1)''
    cost - стоимость ''(по-умолчанию: 0)''
    comment - нотатки
-   sn - серийный номер
+   sn - серійний номер
    barcode - штрихкод
-   inventory_number - инвентарный номер
+   inventory_number - інвентарний номер
    document_number - номер документа прихода
    document_date - дата документа прихода
    additional_data_ip - IP-адрес (для ТМЦ-обладнання)
    additional_data_mac - MAC-адрес (для ТМЦ-обладнання)
-   is_check_serial_number - проверять на совпадение серийный номер с уже существующими ТМЦ
+   is_check_serial_number - проверять на збіг серійний номер с уже существующими ТМЦ
 ==== add_inventory_assortment ====
@@ Строка 73: / Строка 73: @@
   Необов'язкові параметри:
    unit_name - единица измерения
-   is_require_serial_number - прапорець - требовать ввода серийного номера при приходе ТМЦ
+   is_require_serial_number - прапорець - вимагати введення серійного номера під час надходження ТМЦ
-   is_require_mac - прапорець - требовать ввода MAC-адреса при приходе ТМЦ
+   is_require_mac - прапорець - вимагати введення MAC-адреси під час надходження ТМЦ
 ==== add_inventory_section ====
@@ Строка 85: / Строка 85: @@
    typer - id спецпризнака ''(по-умолчанию: 0)''
    parent_id - id батьківського раздела каталога
-   is_show_on_map - прапорець - отображать ли об'єкты этого раздела слоем на карте
+   is_show_on_map - прапорець - отображать ли об'єкти цього раздела слоем на карте
 ==== add_inventory_to_operation ====
@@ Строка 93: / Строка 93: @@
   Обов'язкові параметри:
    operation_id - id операції
-   inventory_id - id ТМЦ ''(оно должно находится на счёте-источнике операції)''
+   inventory_id - id ТМЦ ''(воно має перебувати на рахунку-джерелі операції)''
   Необов'язкові параметри:
-   amount - количество ТМЦ ''(если более 1 единицы в ТМЦ)''
+   amount - кількість ТМЦ ''(якщо в ТМЦ більше 1 одиниці)''
 ==== change_arg_ip ====
 ''Додано у: 3.12.81''
-  Опис: Зміна IP-адреса в параметрах ТМЦ
+  Опис: Зміна IP-адреса до параметраах ТМЦ
   Обов'язкові параметри:
    id - ID ТМЦ
@@ Строка 106: / Строка 106: @@
 ==== change_arg_mac ====
 ''Додано у: 3.12.81''
-  Опис: Зміна MAC-адреса в параметрах ТМЦ
+  Опис: Зміна MAC-адреса до параметраах ТМЦ
   Обов'язкові параметри:
    id - ID ТМЦ
@@ Строка 130: / Строка 130: @@
   Обов'язкові параметри:
    id - ID ТМЦ
-   value - серийный номер
+   value - серійний номер
 ==== delete_inventory ====
@@ Строка 136: / Строка 136: @@
   Опис: Видалення СПИСАННОГО ТМЦ
   Обов'язкові параметри:
-   id - id ТМЦ ''(ТМЦ обязательно должно быть списанным)''
+   id - id ТМЦ ''(ТМЦ обов'язково має бути списаним)''
 ==== edit_inventory_assortment ====
@@ Строка 147: / Строка 147: @@
    name - найменування
    unit_name - единица измерения
-   is_require_serial_number - прапорець - требовать ввода серийного номера при приходе ТМЦ
+   is_require_serial_number - прапорець - вимагати введення серійного номера під час надходження ТМЦ
-   is_require_mac - прапорець - требовать ввода MAC-адреса при приходе ТМЦ
+   is_require_mac - прапорець - вимагати введення MAC-адреси під час надходження ТМЦ
 ==== edit_inventory_section ====
@@ Строка 159: / Строка 159: @@
    name - найменування
    parent_id - id батьківського раздела каталога
-   is_show_on_map - прапорець - отображать ли об'єкты этого раздела слоем на карте
+   is_show_on_map - прапорець - отображать ли об'єкти цього раздела слоем на карте
 ==== get_inventory ====
@@ Строка 169: / Строка 169: @@
 ''Доопрацьовано у: 3.16dev3 (додано параметри inventory_type_id, section_id)''
-''Доопрацьовано у: 3.16dev2 (в параметр location значення staff заменено на employee)''
+''Доопрацьовано у: 3.16dev2 (до параметра location значення staff заменено на employee)''
-''Доопрацьовано у: 3.12.85 (в параметр location добавлено возможное значення task)''
+''Доопрацьовано у: 3.12.85 (до параметра location додано можливе значення task)''
-''Доопрацьовано у: 3.12.71 (в параметре object_id можно подавать значення через кому)''
+''Доопрацьовано у: 3.12.71 (у параметрі object_id можна подавати значення через кому)''
 ''Доопрацьовано у: 3.12beta27 (додано параметр location)''
-  Опис: Отримання списка ТМЦ
+  Опис: Отримання списку ТМЦ
   Обов'язкові параметри:
-   location - категорія учёта [storage|employee|customer|node|task] ''(staff - до 3.16dev2)''
+   location - категорія обліку [storage|employee|customer|node|task] ''(staff - до 3.16dev2)''
   Необов'язкові параметри:
-   object_id - id об'єкта учёта ''(можна через кому)''
+   object_id - id об'єкта обліку ''(можна через кому)''
    inventory_type_id - id наименования ТМЦ ''(можна через кому)''
    section_id - id секции каталога товаров ''(можна через кому)''
@@ Строка 189: / Строка 189: @@
 ''Доопрацьовано у: 3.12.74 (додано параметр section_id)''
-  Опис: Отримання списка разделов каталога
+  Опис: Отримання списку розділів каталогу
   Необов'язкові параметри
    id - ID наименования ТМЦ ''(можна через кому)''
@@ Строка 200: / Строка 200: @@
 ==== get_inventory_id ====
-''Доопрацьовано у: 3.18beta1 (для параметра data_typer добавлено возможное значення ip)''
+''Доопрацьовано у: 3.18beta1 (для параметра data_typer додано можливе значення ip)''
 ''Доопрацьовано у: 3.14.71 (додано параметр is_all_data)''
-''Доопрацьовано у: 3.14.34 (для параметра data_typer добавлено возможное значення barcode)''
+''Доопрацьовано у: 3.14.34 (для параметра data_typer додано можливе значення barcode)''
-''Доопрацьовано у: 3.13.11 (для параметра data_typer добавлено возможное значення mac)''
+''Доопрацьовано у: 3.13.11 (для параметра data_typer додано можливе значення mac)''
-  Опис: Отримання ID ТМЦ по входящим данным
+  Опис: Отримання ID ТМЦ за вхідними даними
   Необов'язкові параметри:
-   is_all_data - прапорець - возвращать усі найденные ТМЦ, а не только одно
+   is_all_data - прапорець - повертати всі знайдені ТМЦ, а не тільки одне
   Обов'язкові параметри:
-   data_typer - тип данных, которые проверяем ''(возможные значення: barcode, inventory_number, serial_number, mac, ip)''
+   data_typer - тип даних, які перевіряємо ''(можливі значення: barcode, inventory_number, serial_number, mac, ip)''
    data_value - значення
@@ Строка 219: / Строка 219: @@
 ==== get_inventory_storage ====
-  Опис: Отримання списка складов
+  Опис: Отримання списку складів
 ==== get_operation ====
@@ Строка 228: / Строка 228: @@
 ''Додано у: 3.12.90''
   Опис: Отримання информации по операциям
-  Необов'язкові параметри ''(но должно быть хоть що-то)'':
+  Необов'язкові параметри ''(але має бути хоч щось)'':
-   id - ID операції ''(можно несколько значень через кому)''
+   id - ID операції ''(можна кілька значень через кому)''
-   src_account - счёт-кредита ''(откуда)''
+   src_account - рахунок-кредита ''(откуда)''
-   dst_account - счёт-дебита ''(куда)''
+   dst_account - рахунок-дебита ''(куда)''
-   date_start - дата начала периода
+   date_start - дата начала періоду
-   date_finish - дата окончания периода
+   date_finish - дата окончания періоду
    inventory_id - id ТМЦ
    employee_id - id співробітника - инициатора операції
@@ Строка 243: / Строка 243: @@
   Обов'язкові параметри:
    id - id ТМЦ
-   amount - требуемое количество
+   amount - требуемое кількість
-''В результате разделения в ТМЦ id останется количество равное amount і будет создано новое ТМЦ (вернётся в переменной new_id) с остаточным количеством.''
+''У результаті розділення в ТМЦ id залишиться кількість, що дорівнює amount, і буде створено нове ТМЦ (повернеться у змінній new_id) із залишковою кількістю.''
 ==== transfer_inventory ====