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

• Содержание
• API - Номенклатура
  • Перечисление
    • Тип номенклатуры
  • Ресурс: Номенклатура
    • Модель номенклатуры
    • Операции
  • Ресурс: Единица измерения
  • Ресурс: Тип запасов

Перечисление¶

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

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

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

Все операции в рамках ресурса "Номенклатура" требуют аутентификации и установки рабочей организации

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

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

}

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

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

{
    "article": "01012223",
    "barcode": "46012304230435",
    "tmc_type": {"id":184, "name": "Товары"}
}

• article - артикул товара (макс. 25 символов, необязательно);
• barcode - штрих-код товара (макс. 200 символов, необязательно);
• tmc_type - Тип запасов (обязательно).

Операции¶

name: Получение списка номенклатуры
desc: Возвращает список объектов из справочника номенклатуры рабочей организации
url: /buh/nomenclature/list
params: Стандартные параметры операции 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 (см. DELETE)
url: /buh/nomenclature/delete
params: модель номенклатуры, либо объект {"id": 123, "nomenclature_type": 1}.

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

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

Модель единицы измерения:

{
    "code": "642",
    "name": "Единица",
    "okei": "123",
    "shortname": "ед",
    "id": 12
}

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

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

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

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

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

{
    "id": 3,
    "code": 5, 
    "name": "Готовая продукция" 
}

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