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

Материал из WiKi - UserSide
(не показано 38 промежуточных версий этого же участника)
Строка 8: Строка 8:
В учёте ТМЦ используется понятие как "счет учета".  
В учёте ТМЦ используется понятие как "счет учета".  


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


Первые 3 цифры:
Первые 3 цифры:
  101 - Поставщики
  101 - Поставщики
  203 - Сотрудники
  203 - Сотрудники ''(до 3.16dev2)''
  204 - Склад
  204 - Склад
  205 - Абонент
  205 - Абонент
  206 - Узел связи/муфта
  206 - Сооружение связи
  210 - ВОЛС
  210 - Кабельная линия
  211 - Линия связи
  211 - Линия связи ''(с 3.15 вместо неё используется 210)''
  212 - Задание
  212 - Задание
  213 - Дом
  213 - Здания
215 - Сотрудники ''(с 3.16dev2)''
  900 - Списано
  900 - Списано


Строка 29: Строка 30:
  09 - Учет проданного
  09 - Учет проданного


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


20503123456 - Счёт абонента id 123456 и субсчет обычного учета ТМЦ
205031234567 - Счёт абонента id 1234567 и субсчет обычного учета ТМЦ
   
   
== Подкатегории ==
== Подкатегории ==
Строка 52: Строка 53:
   additional_data_ip - IP-адрес (для ТМЦ-оборудования)
   additional_data_ip - IP-адрес (для ТМЦ-оборудования)
   additional_data_mac - MAC-адрес (для ТМЦ-оборудования)
   additional_data_mac - MAC-адрес (для ТМЦ-оборудования)
  Дополнительно возвращаемые данные:
 
   array(
==== add_inventory_assortment ====
  [Id] => ID ТМЦ
''Добавлено в: 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_serial_number ====
==== change_serial_number ====
''Добавлено в: 3.12.52''
''Добавлено в: 3.12.52''
  Описание: Изменение серийного номера у ТМЦ
  Описание: Изменение серийного номера у ТМЦ
Обязательные параметры:
  id - ID ТМЦ
  value - серийный номер
==== delete_inventory ====
''Добавлено в: 3.13.48''
Описание: Удаление СПИСАННОГО ТМЦ
Обязательные параметры:
  id - id ТМЦ ''(ТМЦ обязательно должно быть списанным)''
==== edit_inventory_assortment ====
''Добавлено в: 3.14.1''
Описание: Редактирование наименования ТМЦ
Обязательные параметры:
  id - id наименования
  Необязательные параметры:
  Необязательные параметры:
   location - категория учёта [storage|staff|customer|node]
   name - наименование
   object_id - ID объекта учёта
   unit_name - единица измерения
  is_require_serial_number - флаг - требовать ввода серийного номера при приходе ТМЦ
  is_require_mac - флаг - требовать ввода MAC-адреса при приходе ТМЦ


==== transfer_inventory ====
==== edit_inventory_section ====
  Описание: Перемещение ТМЦ
''Добавлено в: 3.14.1''
 
  Описание: Редактирование раздела каталога товаров
  Обязательные параметры:
  Обязательные параметры:
   inventory_id - ID ТМЦ
   id - id раздела каталога
  dst_account - Счет-получатель
  Необязательные параметры:
  Дополнительно возвращаемые данные:
   name - наименование
   array(
  parent_id - id родительского раздела каталога
  [Id] => ID операции перемещения
   is_show_on_map - флаг - отображать ли объекты этого раздела слоем на карте
   )


==== get_inventory ====
==== get_inventory ====
Строка 78: Строка 148:
  Обязательные параметры:
  Обязательные параметры:
   id - ID ТМЦ
   id - ID ТМЦ
Дополнительно возвращаемые данные:
  array(
  [data] => ID с информацией о ТМЦ
  )


==== get_inventory_id ====
==== get_inventory_amount ====
  Описание: Получение ID ТМЦ по входящим данным
''Доработано в: 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)''
 
  Описание: Получение списка ТМЦ
  Обязательные параметры:
  Обязательные параметры:
   data_typer - тип данных, которые проверяем ''(возможные значения: inventory_number, serial_number)''
   location - категория учёта [storage|employee|customer|node|task] ''(staff - до 3.16dev2)''
  data_value - значение
  Необязательные параметры:
  Дополнительно возвращаемые данные:
   object_id - id объекта учёта ''(можно через запятую)''
   array(
  inventory_type_id - id наименования ТМЦ ''(можно через запятую)''
  [id] => id ТМЦ в случае успеха
   section_id - id секции каталога товаров ''(можно через запятую)''
   )


==== get_inventory_catalog ====
==== get_inventory_catalog ====
''Доработано в: 3.12.74 (добавлен параметр section_id)''
  Описание: Получение списка разделов каталога
  Описание: Получение списка разделов каталога
  Дополнительно возвращаемые данные:
  Необязательные параметры
   array(
   section_id - ID типа ТМЦ ''(можно через запятую)''
  [data] => ID раздела каталога
  )


==== get_inventory_catalog_id_by_name ====
==== get_inventory_catalog_id_by_name ====
  Описание: Получение ID раздела каталога по его наименованию
  Описание: Получение ID наименования ТМЦ по его названию
  Обязательные параметры:
  Обязательные параметры:
   name - наименование
   name - наименование
Дополнительно возвращаемые данные:
  array(
  [Id] => ID раздела каталога
  )


==== get_inventory_amount ====
==== get_inventory_id ====
''Доработано в: 3.12beta27 (добавлен параметр location)''
''Доработано в: 3.14.71 (добавлен параметр is_all_data)''
  Описание: Получение списка ТМЦ
 
''Доработано в: 3.14.34 (для параметра data_typer добавлено возможное значение barcode)''
 
''Доработано в: 3.13.11 (для параметра data_typer добавлено возможное значение mac)''
 
  Описание: Получение ID ТМЦ по входящим данным
  Необязательные параметры:
  Необязательные параметры:
   location - категория учёта [storage|staff|customer|node]
   is_all_data - флаг - возвращать все найденные ТМЦ, а не только одно
   object_id - ID объекта учёта
Обязательные параметры:
  data_typer - тип данных, которые проверяем ''(возможные значения: barcode, inventory_number, serial_number, mac)''
   data_value - значение
 
==== get_inventory_section_catalog ====
Описание: Получение наименований каталога ТМЦ


==== get_inventory_storage ====
==== get_inventory_storage ====
  Описание: Получение списка складов
  Описание: Получение списка складов
Дополнительно возвращаемые данные:
  array(
  [data] => ID раздела каталога
  )


==== get_inventory_section_catalog ====
==== get_operation ====
  Описание: Получение наименований каталога ТМЦ
''Доработано в: 3.15.12 (добавлен параметр inventory_id)''
  Дополнительно возвращаемые данные:
 
   array(
''Добавлено в: 3.12.90''
  [data] => ID раздела каталога
  Описание: Получение информации по операциям
   )
Необязательные параметры ''(но должно быть хоть что-то)'':
  id - ID операции ''(можно несколько значений через запятую)''
  src_account - счёт-кредита ''(откуда)''
  dst_account - счёт-дебита ''(куда)''
  date_start - дата начала периода
  date_finish - дата окончания периода
  inventory_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)''

Версия от 18:38, 16 апреля 2021

Раздел 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 - Учет проданного

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

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

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

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_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_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.12.74 (добавлен параметр section_id)

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

get_inventory_catalog_id_by_name

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

get_inventory_id

Доработано в: 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)
 data_value - значение

get_inventory_section_catalog

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

get_inventory_storage

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

get_operation

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

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

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