API inventory UK

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)