API inventory
Раздел API ERP "UserSide"
Назначение: Действия с ТМЦ и складом
Дополнительные параметры: action - подкатегория запроса (возможное значение: см.ниже)
В учёте ТМЦ используется понятие как "счет учета".
Счета представляют значения вида "205031234567"
Первые 3 цифры:
101 - Поставщики 203 - Сотрудники (до 3.16dev2) 204 - Склад 205 - Абонент 206 - Сооружение связи 210 - Кабельная линия 211 - Линия связи (с 3.15 вместо неё используется 210) 212 - Задание 213 - Здания 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)