API inventory UK: различия между версиями
IronBot (обсуждение | вклад) (Add Ukrainian API docs and trilingual API links) |
IronBot (обсуждение | вклад) (Add Ukrainian API docs and trilingual API links) |
||
| Строка 3: | Строка 3: | ||
Розділ '''[[API]]''' ERP "UserSide" | Розділ '''[[API]]''' ERP "UserSide" | ||
Призначення: Дії с ТМЦ | Призначення: Дії с ТМЦ і складом | ||
Додаткові параметри: | Додаткові параметри: | ||
| Строка 26: | Строка 26: | ||
900 - Списано | 900 - Списано | ||
4 | 4 і 5 цифра - субсчет | ||
01 - Подотчет долгий | 01 - Подотчет долгий | ||
02 - Подотчет короткий | 02 - Подотчет короткий | ||
| Строка 36: | Строка 36: | ||
Последние 7 цифр - это ID об'єкта с ведущими нулями | Последние 7 цифр - это ID об'єкта с ведущими нулями | ||
205031234567 - Счёт абонента id 1234567 | 205031234567 - Счёт абонента id 1234567 і субсчет обычного учета ТМЦ | ||
== Підкатегорії == | == Підкатегорії == | ||
| Строка 60: | Строка 60: | ||
document_number - номер документа прихода | document_number - номер документа прихода | ||
document_date - дата документа прихода | document_date - дата документа прихода | ||
additional_data_ip - IP-адрес (для ТМЦ- | additional_data_ip - IP-адрес (для ТМЦ-обладнання) | ||
additional_data_mac - MAC-адрес (для ТМЦ- | additional_data_mac - MAC-адрес (для ТМЦ-обладнання) | ||
is_check_serial_number - проверять на совпадение серийный номер с уже существующими ТМЦ | is_check_serial_number - проверять на совпадение серийный номер с уже существующими ТМЦ | ||
| Строка 84: | Строка 84: | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
typer - id спецпризнака ''(по-умолчанию: 0)'' | typer - id спецпризнака ''(по-умолчанию: 0)'' | ||
parent_id - id | parent_id - id батьківського раздела каталога | ||
is_show_on_map - прапорець - отображать ли об'єкты этого раздела слоем на карте | is_show_on_map - прапорець - отображать ли об'єкты этого раздела слоем на карте | ||
| Строка 158: | Строка 158: | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
name - найменування | name - найменування | ||
parent_id - id | parent_id - id батьківського раздела каталога | ||
is_show_on_map - прапорець - отображать ли об'єкты этого раздела слоем на карте | is_show_on_map - прапорець - отображать ли об'єкты этого раздела слоем на карте | ||
| Строка 228: | Строка 228: | ||
''Додано у: 3.12.90'' | ''Додано у: 3.12.90'' | ||
Опис: Отримання информации по операциям | Опис: Отримання информации по операциям | ||
Необов'язкові параметри ''(но должно быть хоть | Необов'язкові параметри ''(но должно быть хоть що-то)'': | ||
id - ID операції ''(можно несколько | id - ID операції ''(можно несколько значень через кому)'' | ||
src_account - счёт-кредита ''(откуда)'' | src_account - счёт-кредита ''(откуда)'' | ||
dst_account - счёт-дебита ''(куда)'' | dst_account - счёт-дебита ''(куда)'' | ||
| Строка 244: | Строка 244: | ||
id - id ТМЦ | id - id ТМЦ | ||
amount - требуемое количество | amount - требуемое количество | ||
''В результате разделения в ТМЦ id останется количество равное amount | ''В результате разделения в ТМЦ id останется количество равное amount і будет создано новое ТМЦ (вернётся в переменной new_id) с остаточным количеством.'' | ||
==== transfer_inventory ==== | ==== transfer_inventory ==== | ||
| Строка 257: | Строка 257: | ||
comment - нотатки | comment - нотатки | ||
employee_id - ID співробітника - автора операції | employee_id - ID співробітника - автора операції | ||
operator_id - ID оператора - автора операції ''(до | operator_id - ID оператора - автора операції ''(до версії 3.16dev2)'' | ||
Версия от 08:36, 10 мая 2026
Розділ 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)