API - Номенклатура » История » Версия 7
Александр Кварацхелия, 18.04.2014 14:36
| 1 | 1 | Александр Кварацхелия | h1. API - Номенклатура |
|---|---|---|---|
| 2 | |||
| 3 | {{toc}} |
||
| 4 | |||
| 5 | 2 | Александр Кварацхелия | h2. Перечисление |
| 6 | 1 | Александр Кварацхелия | |
| 7 | h3. Тип номенклатуры |
||
| 8 | |||
| 9 | * 1 - товар |
||
| 10 | * 2 - услуга |
||
| 11 | |||
| 12 | h2. Ресурс: Номенклатура |
||
| 13 | |||
| 14 | 6 | Александр Кварацхелия | Все операции в рамках ресурса "Номенклатура" требуют [[API#Аутентификация-внешнего-приложения|аутентификации]] и [[API#Рабочая-организация|установки рабочей организации]] |
| 15 | 1 | Александр Кварацхелия | |
| 16 | h3. Модель номенклатуры |
||
| 17 | |||
| 18 | <pre> |
||
| 19 | <code class="json"> |
||
| 20 | { |
||
| 21 | "id": 1234, |
||
| 22 | "nomenclature_type": 1, |
||
| 23 | "code": "Код", |
||
| 24 | "name": "Наименование номенклатурной позиции", |
||
| 25 | "measurement_unit": {"id": 100, "name": "Метр"}, |
||
| 26 | "comment": "" |
||
| 27 | |||
| 28 | } |
||
| 29 | </code> |
||
| 30 | </pre> |
||
| 31 | |||
| 32 | * @id@ - идентификатор позиции; |
||
| 33 | * @nomenclature_type@ - значение перечисления [[API - Номенклатура#Тип-номенклатуры|Тип номенклатуры]] (обязательно); |
||
| 34 | * @code@ - код номенклатуры (макс. 50 символов, необязательно); |
||
| 35 | * @name@ - наименование (макс. 300 символов, обязательно); |
||
| 36 | 3 | Александр Кварацхелия | * @measurement_unit@ - [[API - Номенклатура#Ресурс-Единица-измерения|Единица измерения]] (обязательно); |
| 37 | 1 | Александр Кварацхелия | * @comment@: - комментарий (макс. 150 символов, необязательно). |
| 38 | |||
| 39 | Кроме этого, для номенклатуры с типом "Товар" в модель добавляются следующие поля: |
||
| 40 | |||
| 41 | 4 | Александр Кварацхелия | <pre> |
| 42 | <code class="json"> |
||
| 43 | 1 | Александр Кварацхелия | { |
| 44 | "article": "01012223", |
||
| 45 | "barcode": "46012304230435", |
||
| 46 | "tmc_type": {"id":184, "name": "Товары"} |
||
| 47 | } |
||
| 48 | 4 | Александр Кварацхелия | </code> |
| 49 | </pre> |
||
| 50 | 1 | Александр Кварацхелия | |
| 51 | * @article@ - артикул товара (макс. 25 символов, необязательно); |
||
| 52 | * @barcode@ - штрих-код товара (макс. 200 символов, необязательно); |
||
| 53 | 3 | Александр Кварацхелия | * @tmc_type@ - [[API - Номенклатура#Ресурс-Тип-запасов|Тип запасов]] (обязательно). |
| 54 | 2 | Александр Кварацхелия | |
| 55 | 5 | Александр Кварацхелия | h3. Операции |
| 56 | |||
| 57 | *name*: Получение списка номенклатуры |
||
| 58 | *desc*: Возвращает список объектов из справочника номенклатуры рабочей организации |
||
| 59 | *url*: @/buh/nomenclature/list@ |
||
| 60 | *params*: Стандартные параметры операции [[API#Операция-LIST|LIST]] |
||
| 61 | |||
| 62 | *name*: Чтение данных номенклатуры |
||
| 63 | *desc*: Возвращает объект номенклатуры по указанному первичному ключу |
||
| 64 | *url*: @/buh/nomenclature/read@ |
||
| 65 | *params*: @nomenclature_type@ для нового (пустого) объекта; @nomenclature_type@ и @id@ для существующего объекта |
||
| 66 | |||
| 67 | *name*: Создание номенклатуры |
||
| 68 | *desc*: Создает новый объект номенклатуры в рабочей организации |
||
| 69 | *url*: @/buh/nomenclature/create@ |
||
| 70 | *params*: модель номенклатуры без указанного @id@ |
||
| 71 | |||
| 72 | *name*: Изменение номенклатуры |
||
| 73 | *desc*: Изменяет данные номенклатуры |
||
| 74 | *url*: @/buh/nomenclature/update@ |
||
| 75 | *params*: модель номенклатуры с указанным @id@ |
||
| 76 | |||
| 77 | *name*: Удаление номенклатуры |
||
| 78 | *desc*: Удаляет позицию номенклатуры с указанным id (см. [[API#Операция-DELETE|DELETE]]) |
||
| 79 | *url*: @/buh/nomenclature/delete@ |
||
| 80 | 7 | Александр Кварацхелия | *params*: модель номенклатуры, либо объект <code class="json">{"id": 123, "nomenclature_type": 1}</code>. |
| 81 | 5 | Александр Кварацхелия | |
| 82 | |||
| 83 | 2 | Александр Кварацхелия | h2. Ресурс: Единица измерения |
| 84 | |||
| 85 | h2. Ресурс: Тип запасов |