НЕБО Паблик

h1. API - Номенклатура

{{toc}}

h2. Перечисление

h3. Тип номенклатуры

* 1 - товар
* 2 - услуга

h2. Ресурс: Номенклатура

Все операции в рамках ресурса "Контрагенты" требуют [[API#Аутентификация-внешнего-приложения|аутентификации]] и [[API#Рабочая-организация|установки рабочей организации]]

h3. Модель номенклатуры

<pre>
<code class="json">
{
"id": 1234,
"nomenclature_type": 1,
"code": "Код",
"name": "Наименование номенклатурной позиции",
"measurement_unit": {"id": 100, "name": "Метр"},
"comment": ""

}
</code>
</pre>

* @id@ - идентификатор позиции;
* @nomenclature_type@ - значение перечисления [[API - Номенклатура#Тип-номенклатуры|Тип номенклатуры]] (обязательно);
* @code@ - код номенклатуры (макс. 50 символов, необязательно);
* @name@ - наименование (макс. 300 символов, обязательно);
* @measurement_unit@ - [[API - Номенклатура#Ресурс-Единица-измерения|Единица измерения]] (обязательно);
* @comment@: - комментарий (макс. 150 символов, необязательно).

Кроме этого, для номенклатуры с типом "Товар" в модель добавляются следующие поля:

<pre>
<code class="json">
{
"article": "01012223",
"barcode": "46012304230435",
"tmc_type": {"id":184, "name": "Товары"}
}
</code>
</pre>

* @article@ - артикул товара (макс. 25 символов, необязательно);
* @barcode@ - штрих-код товара (макс. 200 символов, необязательно);
* @tmc_type@ - [[API - Номенклатура#Ресурс-Тип-запасов|Тип запасов]] (обязательно).

h3. Операции

*name*: Получение списка номенклатуры
*desc*: Возвращает список объектов из справочника номенклатуры рабочей организации
*url*: @/buh/nomenclature/list@
*params*: Стандартные параметры операции [[API#Операция-LIST|LIST]]

*name*: Чтение данных номенклатуры
*desc*: Возвращает объект номенклатуры по указанному первичному ключу
*url*: @/buh/nomenclature/read@
*params*: @nomenclature_type@ для нового (пустого) объекта; @nomenclature_type@ и @id@ для существующего объекта

*name*: Создание номенклатуры
*desc*: Создает новый объект номенклатуры в рабочей организации
*url*: @/buh/nomenclature/create@
*params*: модель номенклатуры без указанного @id@

*name*: Изменение номенклатуры
*desc*: Изменяет данные номенклатуры
*url*: @/buh/nomenclature/update@
*params*: модель номенклатуры с указанным @id@

*name*: Удаление номенклатуры
*desc*: Удаляет позицию номенклатуры с указанным id (см. [[API#Операция-DELETE|DELETE]])
*url*: @/buh/nomenclature/delete@
*params*: модель номенклатуры, либо объект @{"id": 123, "nomenclature_type": 1}@.

h2. Ресурс: Единица измерения

h2. Ресурс: Тип запасов