НЕБО Паблик

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*: Получение списка номенклатуры (LIST)


*desc*: Возвращает список объектов из справочника номенклатуры рабочей организации

URL:
*url*: @/buh/nomenclature/list@

Параметры:
*params*: Стандартные параметры операции [[API#Операция-LIST|LIST]]

h3. *name*: Чтение номенклатурной позиции (READ)

данных номенклатуры
*desc*: Возвращает объект номенклатуры по указанному первичному ключу

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

h3. *name*: Создание позиции номенклатуры (CREATE)


*desc*: Создает новый объект номенклатуры в рабочей организации

URL:
*url*: @/buh/nomenclature/create@
Параметры: *params*: модель номенклатуры без указанного @id@

h3. *name*: Изменение номенклатурной позиции

номенклатуры
*desc*: Изменяет данные объекта номенклатуры

URL:
*url*: @/buh/nomenclature/update@
Параметры: *params*: модель номенклатуры с указанным @id@

h3. *name*: Удаление номенклатуры


*desc*: Удаляет позицию номенклатуры с указанным id (см. [[API#Операция-DELETE|DELETE]])

URL:
*url*: @/buh/nomenclature/delete@
Параметры: *params*: модель номенклатуры, либо объект <code class="json">{"id": 123, "nomenclature_type": 1}</code>.



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

Основной URL: @/buh/measurement-units@

Модель единицы измерения:
<pre>
<code class="json">
{
"code": "642",
"name": "Единица",
"okei": "123",
"shortname": "ед",
"id": 12
}
</code>
</pre>

* @code@ - внутренний код единицы измерения;
* @name@ - полное наименование;
* @shortname@ - сокращенное наименование;
* @okei@ - код по ОКЕИ (общероссийский классификатор единиц измерения);

Операции: стандартные операции REST-интерфейса

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

Оcновной URL: @/buh/tmc-type@

Модель типа запаса:

<pre>
<code class="json">
{
"id": 3,
"code": 5,
"name": "Готовая продукция"
}
</code>
</pre>

Операции: стандартные операции в рамках REST-интерфейса