Справочники

Справочники

Справочники: склады, категории и единицы измерения. Их ID и коды нужны в других методах, поэтому интеграцию обычно начинают с них. Методы | Метод | Что возвращает | |---|---| | v1/storages/get_list | Склады компании | | v1/storages/get_entry | Данные склада | | v1/categories/get_list | Категории материалов, продуктов или ресурсов | | v1/units/get_list | Единицы измерения и их коды | Справочники через API только читаются. Склады и категории создаются и настраиваются в Controlata.

Список складов

Возвращает склады компании, отсортированные по названию. v1/storages/get_list.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | limit | int | Нет | Размер страницы, от 1 до 1000 | | offset | int | Нет | Сколько записей пропустить | Поля склада | Поле | Тип | Описание | |---|---|---| | id | int | ID склада | | name | string | Название | | materials | string | Какие материалы хранятся на складе: «all» все, «categories» только выбранные категории, «none» никакие | | products | string | Какие продукты хранятся на складе, те же значения | | notes | string | Заметки | Пример ответа { "success": true, "storages": [ { "id": "3998", "name": "Главный", "materials": "all", "products": "all", "notes": "" } ], "total": 1 } Ошибки | Ошибка | Причина | |---|---| | Invalid limit value. Must be between 1 and 1000 | Неверный limit | | Offset requires limit | Передан offset без limit |

Данные склада

Возвращает данные склада. v1/storages/get_entry.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | storage_id | int | Да | ID склада | Ответ Объект storage с полями склада, как в v1/storages/get_list. Пример ответа { "success": true, "storage": { "id": "3998", "name": "Главный", "materials": "all", "products": "all", "notes": "" } } Ошибки | Ошибка | Причина | |---|---| | No storage_id in input | Не передан storage_id | | Storage ID not found | Склад не найден или удален |

Список категорий

Возвращает категории материалов, продуктов или ресурсов в том порядке, в каком они идут в Controlata. ID категорий передаются в поле categories при создании и редактировании позиций. v1/categories/get_list.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | type | string | Да | Чьи категории: «materials», «products» или «resources» | Категории через API не создаются: добавьте их в Controlata, а затем назначайте по ID. Пример запроса { "type": "materials" } Пример ответа { "success": true, "categories": [ { "id": "12", "name": "Древесина" }, { "id": "13", "name": "Фурнитура" } ] } Ошибки | Ошибка | Причина | |---|---| | No type in input | Не передан type | | Invalid type value. Must be one of: materials, products, resources | Неверный type |

Единицы измерения

Возвращает единицы измерения. Код единицы (code) передается в поле unit при создании и редактировании материалов, продуктов и ресурсов, и в этом же виде приходит в ответах. v1/units/get_list.php Параметров нет. Поля единицы | Поле | Тип | Описание | |---|---|---| | code | string | Код единицы | | name | string | Название | | group | string | Группа: количество, вес, объем и т. д. | | resource_only | int | 1, если единица только для ресурсов (время, энергия) | Код должен совпадать посимвольно, включая точку и пробел: «куб. м», «пог. м». Регистр букв не важен. Группы единиц Единицу материала или продукта можно сменить на единицу из той же группы, например «кг» на «г»: Controlata пересчитает остатки. В строках состава продукта единица тоже должна быть из группы единицы материала или продукта. Пример ответа { "success": true, "units": [ { "code": "шт", "name": "Штуки", "group": "Количество", "resource_only": "0" }, { "code": "ч", "name": "Часы", "group": "Время", "resource_only": "1" } ] } Единицы | Код | Единица | Группа | |---|---|---| | шт | Штуки | Количество | | упак | Упаковки | Количество | | компл | Комплекты | Количество | | кг | Килограммы | Вес | | г | Граммы | Вес | | мг | Миллиграммы | Вес | | ц | Центнеры | Вес | | т | Тонны | Вес | | кар | Караты | Вес | | lbs | Фунты | Вес | | oz | Унции | Вес | | л | Литры | Объем | | мл | Миллилитры | Объем | | мкл | Микролитры | Объем | | дал | Декалитры | Объем | | куб. м | Кубические метры | Объем | | куб. дм | Кубические дециметры | Объем | | куб. см | Кубические сантиметры | Объем | | gal | Галлоны | Объем | | fl oz | Жидкие унции | Объем | | cu ft | Кубические футы | Объем | | cu yd | Кубические ярды | Объем | | м | Метры | Длина | | пог. м | Погонные метры | Длина | | км | Километры | Длина | | дм | Дециметры | Длина | | см | Сантиметры | Длина | | мм | Миллиметры | Длина | | mi | Мили | Длина | | ft | Футы | Длина | | in | Дюймы | Длина | | кв. м | Квадратные метры | Площадь | | кв. дм | Квадратные дециметры | Площадь | | кв. см | Квадратные сантиметры | Площадь | | sq ft | Квадратные футы | Площадь | | сек | Секунды | Время, только для ресурсов | | мин | Минуты | Время, только для ресурсов | | ч | Часы | Время, только для ресурсов | | сут | Сутки | Время, только для ресурсов | | нед | Недели | Время, только для ресурсов | | мес | Месяцы | Время, только для ресурсов | | кВт-ч | Киловатт-часы | Электроэнергия, только для ресурсов | | мВт-ч | Мегаватт-часы | Электроэнергия, только для ресурсов | | ккал | Килокалории | Электроэнергия, только для ресурсов | | кДж | Килоджоули | Электроэнергия, только для ресурсов |