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

Материал из WiKi - UserSide
Строка 52: Строка 52:
   additional_data_ip - IP-адрес (для ТМЦ-оборудования)
   additional_data_ip - IP-адрес (для ТМЦ-оборудования)
   additional_data_mac - MAC-адрес (для ТМЦ-оборудования)
   additional_data_mac - MAC-адрес (для ТМЦ-оборудования)
==== add_inventory_to_operation ====
''Добавлено в: 3.13.38''
Описание: Добавление ТМЦ в операцию
Обязательные параметры:
  operation_id - id операции
  inventory_id - id ТМЦ ''(оно должно находится на счёте-источнике операции)''
Необязательные параметры:
  amount - количество ТМЦ ''(если более 1 единицы в ТМЦ)''


==== change_arg_ip ====
==== change_arg_ip ====

Версия от 20:20, 22 октября 2019

Раздел API ERP "UserSide"

Назначение: Действия с ТМЦ и складом

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

В учёте ТМЦ используется понятие как "счет учета".

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

Первые 3 цифры:

101 - Поставщики
203 - Сотрудники
204 - Склад
205 - Абонент
206 - Узел связи/муфта
210 - ВОЛС
211 - Линия связи
212 - Задание
213 - Дом
900 - Списано

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

01 - Подотчет долгий
02 - Подотчет короткий
03 - ТМЦ
08 - Аренда
09 - Учет проданного

Последние 6 или 7 цифр - это ID объекта с ведущими нулями

20503123456 - Счёт абонента id 123456 и субсчет обычного учета ТМЦ

Подкатегории

add_inventory

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

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_serial_number

Добавлено в: 3.12.52

Описание: Изменение серийного номера у ТМЦ
Обязательные параметры:
 id - ID ТМЦ
 value - серийный номер

delete_inventory

Добавлено в: 3.13.48

Описание: Удаление СПИСАННОГО ТМЦ
Обязательные параметры:
 id - id ТМЦ (ТМЦ обязательно должно быть списанным)

get_inventory

Описание: Получение информации о ТМЦ
Обязательные параметры:
 id - ID ТМЦ

get_inventory_amount

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

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

Доработано в: 3.12beta27 (добавлен параметр location)

Описание: Получение списка ТМЦ
Необязательные параметры:
 location - категория учёта [storage|staff|customer|node|task]
 object_id - ID объекта учёта (можно через запятую)

get_inventory_catalog

Доработано в: 3.12.74 (добавлен параметр section_id)

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

get_inventory_catalog_id_by_name

Описание: Получение ID раздела каталога по его наименованию
Обязательные параметры:
 name - наименование

get_inventory_id

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

Описание: Получение ID ТМЦ по входящим данным
Обязательные параметры:
 data_typer - тип данных, которые проверяем (возможные значения: inventory_number, serial_number, mac)
 data_value - значение

get_inventory_section_catalog

Описание: Получение наименований каталога ТМЦ

get_inventory_storage

Описание: Получение списка складов

get_operation

Добавлено в: 3.12.90

Описание: Получение информации по операциям
Необязательные параметры:
 id - ID операции (можно несколько значений через запятую)
 src_account - счёт-кредита (откуда)
 dst_account - счёт-дебита (куда)
 date_start - дата начала периода
 date_finish - дата окончания периода

split_inventory

Добавлен в: 3.13.35

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

В результате разделения в ТМЦ id останется количество равное amount и будет создано новое ТМЦ (вернётся в переменной new_id) с остаточным количеством.

transfer_inventory

Доработано в: 3.12.89 (добавлены параметры operator_id, comment)

Описание: Перемещение ТМЦ
Обязательные параметры:
 inventory_id - ID ТМЦ
 dst_account - Счет-получатель
Необязательные параметры
 operator_id - ID оператора - автора операции
 comment - заметки