Маркировка 1.37.MK

Описание изменений в версиях

1.30 от 30.03.2022 23:30:36

1.32 от 22.04.2022 1:07:27

1.36 от 05.05.2022 16:56:47

Описание формата json

Общее описание пакета сообщений

Сообщение всегда передается в составе пакета, т.е. библиотека интеграции на стороне потребителя данных всегда ожидает массив сообщений. В частном случае в массиве может быть одно сообщение. Для каждого сообщения должны быть объявлены поля:

[
    {
        "MsgType": "Loan", // имя типа
        "MsgID": 1, // уникальный номер в пакете
        "MsgData":
        {
            // содержание сообщения, формат определяется типом сообщения
        }
    },
    {
        "MsgType": "Client", // имя типа
        "MsgID": 2, // уникальный номер в пакете
        "MsgData":
        {
            // содержание сообщения, формат определяется типом сообщения
        }
    }
]

postMessage

Пакет сообщений передается в теле запроса POST "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/postMessage". Где "[ИмяБазы]" это наименование информационной базы, указанное при ее публикации. А "[ИдентификаторПоставщика]" это идентификатор поставщика, указанный в поле "Идентификатор" в соответствующем элементе справочника Поставщики данных, по настройкам которого будет загружаться пакет сообщений. Пример ответа от сервера:

{
    "providerID": "ibd1", // Идентификатор поставщика данных
    "taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор запущенного задания загрузки переданных данных
    "taskStarted", "true" // Признак, что задание успешно запущено
    "declineReason", "" // Представление ошибки, в случае если задание не запущено
}

getTaskStatus по заданию загрузки

Получить результат загрузки пакета сообщений можно через запрос GET "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/getTaskStatus?taskID=[ИдентификаторЗаданияПотребителя]" Где "[ИмяБазы]" это наименование информационной базы, указанное при ее публикации. А "[ИдентификаторПоставщика]" это идентификатор поставщика, использованный ранее при выгрузке данных. И "[ИдентификаторЗаданияПотребителя]" это идентификатор, полученный с ответом сервера при выполнении postMessage.

Пример ответа от сервера:

{
    "taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
    "dataToProcess": 150000, // Общее количество сообщений в задании
    "dataProcessed": 150000, // Количество обработанных на момент запроса сообщений
    "dataDeclined": 2, // Количество сообщений с ошибками
    "progress": 1, // Доля выполенных загрузок сообщений
    "isError": "true", // Наличие ошибок во время выполнения
    "startTime": "20200211150000", // Начало выполнения
    "finishTime": "20200211150500", // Окончание выполнения
    "errorMessage": "", // Представление сообщения об ошибке
    "providerID": "ibd1", // Идентификатор поставщика данных
    "taskID": "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания загрузки данных
    "msgIDs": // Массив сообщений, которые не были загружены или были загружены с ошибками
    [
        {
            "msgID": "34" // Идентификатор сообщения с ошибкой
        },
        {
            "msgID": "54792" // Идентификатор сообщения с ошибкой
        }
    ]
}

Сообщения пакета

ДобавитьУИНвСпецификацию pushUINsToSpec - Поместить УИНы в спецификацию

Наименование этого сообщения в журнале регистрации: "ДобавитьУИНвСпецификацию".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Идентификатор операции списания. Если не указать, будет сгенерирован автоматически;
  2. specID (Спецификация) - Строка - Номер спецификации, к которой нужно добавить УИНы;
  3. UINList (СписокУИН) - Массив -
    1. UIN (УИН) - Строка - УИН для списания
  4. BatchList (СписокИдентификаторовПартий) - Массив -
    1. Batch (Партия) - Строка - Идентификатор партии
  5. addMode (РежимДобавления) - Булево - Признак добавления данных в спецификацию ;

Пример пакета с сообщением pushUINsToSpec

[
    {
        "MsgType": "pushUINsToSpec",
        "MsgID": 1,
        "MsgData":
        {
            "id": "2344/2134\/1241",
            "specID": "Т-912939-123-233",
            "UINList":
            [
                {
                    "UIN": "6432200152139957"
                }
            ],
            "BatchList":
            [
                {
                    "Batch": "id1230123"
                }
            ],
            "addMode": "True"
        }
    }
]

ДрагоценныйКамень preciousStone - Партия камней

Наименование этого сообщения в журнале регистрации: "ДрагоценныйКамень".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. stoneType (ВидКамня) - Строка - Вид камня;

    Необязательный параметр. Значение по умолчанию: "PRECIOUS_STONE";

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидыКамней):

  18. stonesBatchType (ВидПартииКамней) - Строка - Тип партии камней;

    Необязательный параметр. Значение по умолчанию: "TREATED_GEMSTONES";

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартииКамней):

  19. quantity (Количество) - Число - Количество;

    Необязательный параметр. Значение по умолчанию: 1

  20. weight (Масса) - Число - Масса в каратах;

  21. shape (Форма) - Строка - Форма огранки из документации к ГИИС;

  22. quality (Качество) - Строка - Качество камня из документации к ГИИС;

  23. color (Цвет) - Строка - Цвет камня из документации к ГИИС;

  24. classCode (КлассификационныйКод) - Строка - Классификационный код камня из документации к ГИИС, можно не указывать, если заполнить Форма, Качество, Цвет;

Пример пакета с сообщением preciousStone

[
    {
        "MsgType": "preciousStone",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "weight": 0.4,
            "shape": "DIAMOND_KR_57",
            "quality": "DIAMOND_3_GROUP",
            "color": "DIAMOND_3",
            "classCode": 
        }
    }
]

ДрагоценныйКаменьОстатки preciousStoneRemains - Партия камней (остатки)

Наименование этого сообщения в журнале регистрации: "ДрагоценныйКаменьОстатки".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. stoneType (ВидКамня) - Строка - Вид камня;

    Необязательный параметр. Значение по умолчанию: "PRECIOUS_STONE";

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидыКамней):

  18. stonesBatchType (ВидПартииКамней) - Строка - Тип партии камней;

    Необязательный параметр. Значение по умолчанию: "TREATED_GEMSTONES";

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартииКамней):

  19. quantity (Количество) - Число - Количество;

    Необязательный параметр. Значение по умолчанию: 1

  20. weight (Масса) - Число - Масса в каратах;

  21. shape (Форма) - Строка - Форма огранки из документации к ГИИС;

  22. quality (Качество) - Строка - Качество камня из документации к ГИИС;

  23. color (Цвет) - Строка - Цвет камня из документации к ГИИС;

  24. classCode (КлассификационныйКод) - Строка - Классификационный код камня из документации к ГИИС, можно не указывать, если заполнить Форма, Качество, Цвет;

Пример пакета с сообщением preciousStoneRemains

[
    {
        "MsgType": "preciousStoneRemains",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "weight": 0.4,
            "shape": "DIAMOND_KR_57",
            "quality": "DIAMOND_3_GROUP",
            "color": "DIAMOND_3",
            "classCode": 
        }
    }
]

Контрагент counterparty - Сведения о контрагенте

Передает базовые сведения о контрагенте.

Необходимо передавать по тем контрагентам, которые используются в сообщениях с владельцами, производителями и держателями партий товаров.

Наименование этого сообщения в журнале регистрации: "Контрагент".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Произвольный идентификатор, используемый в последующем в сообщениях, где применяет контрагент;

  2. description (Наименование) - Строка - Название компании;

  3. ogrn (ОГРН) - Строка - ОГРН или ОГРНИП организации или предпринимателя;

  4. inn (ИНН) - Строка - ;

  5. kpp (КПП) - Строка - КПП организации;

  6. intercompany (ТОП) - Булево - ;

    Необязательный параметр. Значение по умолчанию: Ложь

  7. fn (ФискальныйНакопитель) - Строка - ;

Пример пакета с сообщением counterparty

[
    {
        "MsgType": "counterparty",
        "MsgID": 1,
        "MsgData":
        {
            "id": "1201600090504/166001001",
            "description": "ООО Ромашка",
            "ogrn": "1201600090504",
            "inn": ,
            "kpp": "166001001",
            "fn": 
        }
    }
]

Контракт deal - Сведения о контракте

Наименование этого сообщения в журнале регистрации: "Контракт".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. dealID (Идентификатор) - Строка - Идентификатор контракта;

  2. number (Номер) - Строка - необязателен к заполнению, опционально;

  3. numberOut (НомерВходящий) - Строка - Номер контракта получателя;

  4. dealDate (ДатаКонтракта) - Дата - Дата контракта;

  5. dealType (ТипКонтракта) - Строка - DL_IMPORT_EXPORT Контракт на импорт/экспорт¶DL_IMPORT_EXPORT_TEMP Контракт на временный ввоз/вывоз¶DL_MAIL_ERRAND Письмо-поручение¶DL_PRODUCTION Договор на производство по давальческой схеме¶DL_REALIZATION Договор на реализацию¶DL_RENT Договор аренды¶DL_SALE Договор купли-продажи¶DL_TRANSPORTING Договор подряда¶DL_MINING Договор на добычу;

  6. dealState (СостояниеКонтракта) - Строка - DS_DRAFT Черновик¶DS_ON_SIGNING На подписании¶DS_OPERATE Действует¶DS_COMPLETED Выполнен¶DS_TERMINATED Расторгнут;

    Необязательный параметр. Значение по умолчанию: "DS_OPERATE"

  7. provider (Поставщик) - Строка - Идентификатор поставщика;

  8. recipient (Получатель) - Строка - Идентификатор покупателя (получателя, собственника);

  9. shipper (Грузоотправитель) - Строка - ;

  10. consignee (Грузополучатель) - Строка - ;

  11. currency (Валюта) - Строка - Код валюты;

    Необязательный параметр. Значение по умолчанию: "RUB"

  12. amount (Сумма) - Число - Сумма Контракта;

  13. VATAmount (СуммаНДС) - Число - ;

  14. forceSend (ПринудительнаяОтправка) - Булево - Если установить данный флаг, то следующая отправка любой спецификации по данному контракту обновит данные контракты. ;

    Необязательный параметр. Значение по умолчанию: Истина

  15. giisNumber (НомерВГИИС) - Строка - // служебное поле;

Пример пакета с сообщением deal

[
    {
        "MsgType": "deal",
        "MsgID": 1,
        "MsgData":
        {
            "dealID": "ad2210923",
            "number": "U133-22",
            "numberOut": "АБ-123123-2022",
            "dealDate": "20220101",
            "dealType": "DL_SALE",
            "provider": "123981237/123123123",
            "recipient": "213123/4411231",
            "shipper": "123981237/123123123",
            "consignee": "213123/4411231",
            "amount": 12333.33,
            "VATAmount": ,
            "giisNumber": 
        }
    }
]

ОформлениеИзделий produceProduct - Выпуск изделий из полуфабрикатов

Наименование этого сообщения в журнале регистрации: "ОформлениеИзделий".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - ;
  2. produceList (СписокИдентификаторовИзделий) - Массив -
    1. batchPrepack (ПартияПФ) - Строка - Идентификатор партии полуфабрикатов
    2. batchPoduct (Изделие) - Строка - Идентификатор партии изделия, которое нужно изготовить

Пример пакета с сообщением produceProduct

[
    {
        "MsgType": "produceProduct",
        "MsgID": 1,
        "MsgData":
        {
            "id": ,
            "produceList":
            [
                {
                    "batchPrepack": "id1230123",
                    "batchPoduct": "id3312312"
                }
            ]
        }
    }
]

ПартияИзделийБазовая productBase - Информация о простом изделии без детализации (не остатки)

Наименование этого сообщения в журнале регистрации: "ПартияИзделийБазовая".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;

    Допустимые значения (см. описание типа с перечисляемыми значениями Металл):

  18. hallmark (Проба) - Число - Проба партии;

    Необязательный параметр. Значение по умолчанию: 0

  19. weightFull (ОбщийВес) - Число - Общий вес изделия;

  20. weight (ВесМеталла) - Число - Вес металла в изделии;

  21. subType (ВидПартии) - Строка - Вид партии изделия;

    Необязательный параметр. Значение по умолчанию: "JEWERLY";

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):

  22. productType (ТипИзделия) - Строка - Тип изделия;

    Необязательный параметр. Значение по умолчанию: "JS_OTHER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):

  23. quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;

    Необязательный параметр. Значение по умолчанию: 1

  24. inp (ИНП) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  25. uin (УИН) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  26. parentBatches (РодительскиеПартии) - Массив -

    1. batch (ИдентификаторПартии) - Строка - Идентификатор партии
    2. INP (ИНП) - Строка - УИН, если не заполнена партия
    3. metal (Металл) - Строка - Код металла для партии металла, для ДК не обязательно.
    4. quantity (Количество) - Число - Количество списываемой партии
    5. weight (Масса) - Число - Масса списываемой родительской партии

Пример пакета с сообщением productBase

[
    {
        "MsgType": "productBase",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "baseMetal": "DM_GOLD",
            "weightFull": 5.25,
            "weight": 5.25,
            "parentBatches":
            [
                {
                    "batch": "2333108763616",
                    "INP": ,
                    "metal": "DM_GOLD",
                    "quantity": 1,
                    "weight": 3.33
                }
            ]
        }
    }
]

ПартияИзделийБазоваяОстатки productBaseRemains - Информация о простом изделии без детализации (остатки)

Наименование этого сообщения в журнале регистрации: "ПартияИзделийБазоваяОстатки".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;

    Допустимые значения (см. описание типа с перечисляемыми значениями Металл):

  18. hallmark (Проба) - Число - Проба партии;

    Необязательный параметр. Значение по умолчанию: 0

  19. weightFull (ОбщийВес) - Число - Общий вес изделия;

  20. weight (ВесМеталла) - Число - Вес металла в изделии;

  21. subType (ВидПартии) - Строка - Вид партии изделия;

    Необязательный параметр. Значение по умолчанию: "JEWERLY";

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):

  22. productType (ТипИзделия) - Строка - Тип изделия;

    Необязательный параметр. Значение по умолчанию: "JS_OTHER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):

  23. quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;

    Необязательный параметр. Значение по умолчанию: 1

  24. inp (ИНП) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  25. uin (УИН) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  26. parentBatches (РодительскиеПартии) - Массив -

    1. batch (ИдентификаторПартии) - Строка - Идентификатор партии
    2. INP (ИНП) - Строка - УИН, если не заполнена партия
    3. metal (Металл) - Строка - Код металла для партии металла, для ДК не обязательно.
    4. quantity (Количество) - Число - Количество списываемой партии
    5. weight (Масса) - Число - Масса списываемой родительской партии

Пример пакета с сообщением productBaseRemains

[
    {
        "MsgType": "productBaseRemains",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "baseMetal": "DM_GOLD",
            "weightFull": 5.25,
            "weight": 5.25,
            "parentBatches":
            [
                {
                    "batch": "2333108763616",
                    "INP": ,
                    "metal": "DM_GOLD",
                    "quantity": 1,
                    "weight": 3.33
                }
            ]
        }
    }
]

ПартияИзделийПолная productFull - Полная информация по партии изделий (не остатки)

Наименование этого сообщения в журнале регистрации: "ПартияИзделийПолная".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;

    Допустимые значения (см. описание типа с перечисляемыми значениями Металл):

  18. hallmark (Проба) - Число - Проба партии;

    Необязательный параметр. Значение по умолчанию: 0

  19. weightFull (ОбщийВес) - Число - Общий вес изделия;

  20. weight (ВесМеталла) - Число - Вес металла в изделии;

  21. productType (ТипИзделия) - Строка - Тип изделия;

    Необязательный параметр. Значение по умолчанию: "JS_OTHER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):

  22. quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;

    Необязательный параметр. Значение по умолчанию: 1

  23. inp (ИНП) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  24. uin (УИН) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  25. parentBatches (РодительскиеПартии) - Массив -

    1. batch (ИдентификаторПартии) - Строка - Идентификатор партии
    2. INP (ИНП) - Строка - УИН, если не заполнена партия
    3. metal (Металл) - Строка - Код металла для партии металла, для ДК не обязательно.
    4. quantity (Количество) - Число - Количество списываемой партии
    5. weight (Масса) - Число - Масса списываемой родительской партии
  26. subType (ВидПартии) - Строка - Вид партии изделия;

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):

  27. article (Артикул) - Строка - Артикул изделия;

    Необязательный параметр. Значение по умолчанию: ""

  28. manufacturingDate (ДатаПроизводства) - Дата - Дата производства изделия;

    Необязательный параметр. Значение по умолчанию: ""

  29. brand (ТорговаяМарка) - Строка - Торговая марка производителя изделия;

    Необязательный параметр. Значение по умолчанию: ""

  30. metalList (Сплав) - Массив - Сведения о сплаве изделия

    1. metal (Металл) - Строка - Код основного металла
    2. clearMetalWeight (Вес) - Число - Для основного металла партии значение игнорируется и рассчтывается автоматически
  31. stones (Камни) - Массив -

    1. stoneType (ТипКамня) - Строка - Тип загружаемого камня
    2. shape (ФормаОгранки) - Строка - Форма огранки согласно описания сервиса интеграции ГИИС ДМДК
    3. stoneQuality (КачествоКамня) - Строка - Качество камня согласно описания сервиса интеграции ГИИС ДМДК
    4. stoneColor (ЦветКамня) - Строка - Цвет камня согласно описания сервиса интеграции ГИИС ДМДК
    5. quantity (Количество) - Число - Количество камней этого типа
    6. wieght (Масса) - Число - Масса камней в граммах
  32. INPonly (ТолькоИНП) - Булево - ;

    Необязательный параметр. Значение по умолчанию: Ложь

Пример пакета с сообщением productFull

[
    {
        "MsgType": "productFull",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "baseMetal": "DM_GOLD",
            "weightFull": 5.25,
            "weight": 5.25,
            "parentBatches":
            [
                {
                    "batch": "2333108763616",
                    "INP": ,
                    "metal": "DM_GOLD",
                    "quantity": 1,
                    "weight": 3.33
                }
            ],
            "subType": "JEWERLY"
        }
    }
]

ПартияИзделийПолнаяОстатки productFullRemains - Передача сведений о партии изделий начальный остатков детально

Наименование этого сообщения в журнале регистрации: "ПартияИзделийПолнаяОстатки".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. baseMetal (ОсновнойМеталл) - Строка - Основной металл в партии;

    Допустимые значения (см. описание типа с перечисляемыми значениями Металл):

  18. hallmark (Проба) - Число - Проба партии;

    Необязательный параметр. Значение по умолчанию: 0

  19. weightFull (ОбщийВес) - Число - Общий вес изделия;

  20. weight (ВесМеталла) - Число - Вес металла в изделии;

  21. productType (ТипИзделия) - Строка - Тип изделия;

    Необязательный параметр. Значение по умолчанию: "JS_OTHER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипИзделия):

  22. quantity (Количество) - Число - Количество изделий в партии, если передаются данные по агрегирующим партиям. Поддержка будет закрыта после 01.03.2022;

    Необязательный параметр. Значение по умолчанию: 1

  23. inp (ИНП) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  24. uin (УИН) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

  25. parentBatches (РодительскиеПартии) - Массив -

    1. batch (ИдентификаторПартии) - Строка - Идентификатор партии
    2. INP (ИНП) - Строка - УИН, если не заполнена партия
    3. metal (Металл) - Строка - Код металла для партии металла, для ДК не обязательно.
    4. quantity (Количество) - Число - Количество списываемой партии
    5. weight (Масса) - Число - Масса списываемой родительской партии
  26. subType (ВидПартии) - Строка - Вид партии изделия;

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):

  27. article (Артикул) - Строка - Артикул изделия;

    Необязательный параметр. Значение по умолчанию: ""

  28. manufacturingDate (ДатаПроизводства) - Дата - Дата производства изделия;

    Необязательный параметр. Значение по умолчанию: ""

  29. brand (ТорговаяМарка) - Строка - Торговая марка производителя изделия;

    Необязательный параметр. Значение по умолчанию: ""

  30. metalList (Сплав) - Массив - Сведения о сплаве изделия

    1. metal (Металл) - Строка - Код основного металла
    2. clearMetalWeight (Вес) - Число - Для основного металла партии значение игнорируется и рассчтывается автоматически
  31. stones (Камни) - Массив -

    1. stoneType (ТипКамня) - Строка - Тип загружаемого камня
    2. shape (ФормаОгранки) - Строка - Форма огранки согласно описания сервиса интеграции ГИИС ДМДК
    3. stoneQuality (КачествоКамня) - Строка - Качество камня согласно описания сервиса интеграции ГИИС ДМДК
    4. stoneColor (ЦветКамня) - Строка - Цвет камня согласно описания сервиса интеграции ГИИС ДМДК
    5. quantity (Количество) - Число - Количество камней этого типа
    6. wieght (Масса) - Число - Масса камней в граммах
  32. INPonly (ТолькоИНП) - Булево - ;

    Необязательный параметр. Значение по умолчанию: Ложь

Пример пакета с сообщением productFullRemains

[
    {
        "MsgType": "productFullRemains",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "baseMetal": "DM_GOLD",
            "weightFull": 5.25,
            "weight": 5.25,
            "parentBatches":
            [
                {
                    "batch": "2333108763616",
                    "INP": ,
                    "metal": "DM_GOLD",
                    "quantity": 1,
                    "weight": 3.33
                }
            ],
            "subType": "JEWERLY"
        }
    }
]

ПартияМеталла batchMetal - Партия драгоценных металлов

Наименование этого сообщения в журнале регистрации: "ПартияМеталла".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. subType (ВидПартии) - Строка - ;

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):

  18. quantity (Количество) - Число - ;

    Необязательный параметр. Значение по умолчанию: 1

  19. baseMetal (ОсновнойМеталл) - Строка - ;

    Допустимые значения (см. описание типа с перечисляемыми значениями Металл):

  20. hallmark (Проба) - Число - ;

  21. weight (ВесМеталла) - Число - ;

  22. stamp (НомерСлитка) - Строка - ;

  23. dateManufacture (ГодВыпуска) - Строка - ;

  24. markType (МаркаДрагоценногоМеталла) - Строка - ;

  25. mixMarkType (МаркаСплава) - Строка - ;

  26. nuggetType (КодСамородка) - Строка - ;

  27. metalList (Сплав) - Массив -

    1. metal (Металл) - Строка - Код основного металла
    2. clearMetalWeight (Вес) - Число - Для основного металла партии значение игнорируется и рассчтывается автоматически

Пример пакета с сообщением batchMetal

[
    {
        "MsgType": "batchMetal",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "subType": ,
            "baseMetal": ,
            "hallmark": ,
            "weight": ,
            "stamp": ,
            "dateManufacture": ,
            "markType": ,
            "mixMarkType": ,
            "nuggetType": ,
            "metalList":
            [
                {
                    "metal": "DM_GOLD",
                    "clearMetalWeight": 2.72
                }
            ]
        }
    }
]

ПартияМеталлаОстатки batchMetalRemains - Партия драгоценных металлов (остатки)

Наименование этого сообщения в журнале регистрации: "ПартияМеталлаОстатки".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Внешний идентификатор для партии, с помощью него потом можно сопоставить данные с вашей системой.;

  2. name (Наименование) - Строка - Название партие (Существительное, прилагательное и тд. );

  3. okpd2 (ОКПД2) - Строка - ОКПД2 код, который подгружен в наш сервис, можете посмотреть через онлайн. ;

  4. description (Описание) - Строка - Полное описание партии (description из обмена);

  5. phase (ЭтапОбработки) - Строка - Этап обработки партии;

    Необязательный параметр. Значение по умолчанию: "DOMESTIC_TURNOVER";

    Допустимые значения (см. описание типа с перечисляемыми значениями ЭтапОбработки):

  6. process (СтадияОбработки) - Строка - Стадия обработка партии;

    Необязательный параметр. Значение по умолчанию: "STORED";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтадияОбработки):

  7. tnved (ТНВЭД) - Строка - Код ТНВЭД;

    Необязательный параметр. Значение по умолчанию: ""

  8. producer (Производитель) - Строка - Производитель партии;

    Необязательный параметр. Значение по умолчанию: ""

  9. owner (Собственник) - Строка - Собственник партии изделий;

    Необязательный параметр. Значение по умолчанию: ""

  10. keeper (Владелец) - Строка - Владелец партии, оперделяется при отправке по ЭЦП;

    Необязательный параметр. Значение по умолчанию: ""

  11. costType (ТипСтоимости) - Строка - Тип стоимости партии;

    Необязательный параметр. Значение по умолчанию: "";

    Допустимые значения (см. описание типа с перечисляемыми значениями ТипСтоимости):

  12. sum (Цена) - Число - Цена партии;

    Необязательный параметр. Значение по умолчанию: ""

  13. vatRate (СтавкаНДС) - Строка - Ставка НДС;

    Необязательный параметр. Значение по умолчанию: "NDS_20";

    Допустимые значения (см. описание типа с перечисляемыми значениями СтавкаНДС):

  14. vat (СуммаНДС) - Число - Сумма НДС;

    Необязательный параметр. Значение по умолчанию: ""

  15. outsourse (ИзВнешнегоИсточника) - Булево - Служебное поле;

    Необязательный параметр. Значение по умолчанию: Ложь

  16. specificationID (Спецификация) - Строка - ;

  17. subType (ВидПартии) - Строка - ;

    Допустимые значения (см. описание типа с перечисляемыми значениями ВидПартии):

  18. quantity (Количество) - Число - ;

    Необязательный параметр. Значение по умолчанию: 1

  19. baseMetal (ОсновнойМеталл) - Строка - ;

    Допустимые значения (см. описание типа с перечисляемыми значениями Металл):

  20. hallmark (Проба) - Число - ;

  21. weight (ВесМеталла) - Число - ;

  22. stamp (НомерСлитка) - Строка - ;

  23. dateManufacture (ГодВыпуска) - Строка - ;

  24. markType (МаркаДрагоценногоМеталла) - Строка - ;

  25. mixMarkType (МаркаСплава) - Строка - ;

  26. nuggetType (КодСамородка) - Строка - ;

  27. metalList (Сплав) - Массив -

    1. metal (Металл) - Строка - Код основного металла
    2. clearMetalWeight (Вес) - Число - Для основного металла партии значение игнорируется и рассчтывается автоматически

Пример пакета с сообщением batchMetalRemains

[
    {
        "MsgType": "batchMetalRemains",
        "MsgID": 1,
        "MsgData":
        {
            "id": "АБ00231233",
            "name": "Кольцо золотое 5.25 гр.",
            "okpd2": "32.12.13.110",
            "description": "Кольцо золотое, билет АБ0231233, отделение на Сухаревской, поцарапанное, потертое, помятое, как моя жизнь",
            "specificationID": ,
            "subType": ,
            "baseMetal": ,
            "hallmark": ,
            "weight": ,
            "stamp": ,
            "dateManufacture": ,
            "markType": ,
            "mixMarkType": ,
            "nuggetType": ,
            "metalList":
            [
                {
                    "metal": "DM_GOLD",
                    "clearMetalWeight": 2.72
                }
            ]
        }
    }
]

РегистрацияОтправкиПартий registerSendBatch - Регистрация отправки партий 3.3.1

Наименование этого сообщения в журнале регистрации: "РегистрацияОтправкиПартий".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - ;
  2. BatchList (СписокИдентификаторовПартий) - Массив -
    1. Batch (Партия) - Строка - Идентификатор партии

Пример пакета с сообщением registerSendBatch

[
    {
        "MsgType": "registerSendBatch",
        "MsgID": 1,
        "MsgData":
        {
            "id": ,
            "BatchList":
            [
                {
                    "Batch": "id1230123"
                }
            ]
        }
    }
]

РозничнаяПродажа retailSell - РозничнаяПродажа

Наименование этого сообщения в журнале регистрации: "РозничнаяПродажа".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Идентификатор передаваемого отчета о розничных продажах;

  2. date (ДатаОперации) - Дата - Дата операции продажи;

  3. dept (Подразделение) - Строка - Идентификтор подразделения (counterparty id);

  4. saleMethod (СпособПродажи) - Строка - Способ продажи;

    Необязательный параметр. Значение по умолчанию: "ВМагазине";

    Допустимые значения (см. описание типа с перечисляемыми значениями СпособыПродажи):

  5. BatchList (СписокИдентификаторов) - Массив - Перечень продаваемых идентификаторов

    1. Batch (ИдентификаторПартии) - Строка - Идентификатор партии
    2. fiscalDocumentNumber (НомерДокумента) - Строка - Номер чека или документа передачи курьеру
  6. UINList (СписокУИН) - Массив - Перечень продаваемых УИНов

    1. UIN (УИН) - Строка - УИН к списанию
    2. fiscalDocumentNumber (НомерДокумента) - Строка - Номер документа основания списания
  7. return (Возврат) - Булево - Является возвратом товара;

    Необязательный параметр. Значение по умолчанию: Ложь

Пример пакета с сообщением retailSell

[
    {
        "MsgType": "retailSell",
        "MsgID": 1,
        "MsgData":
        {
            "id": "2022/03/03/22",
            "date": "20210101",
            "dept": "1201600090504/166001001",
            "BatchList":
            [
                {
                    "Batch": "id1230123",
                    "fiscalDocumentNumber": "3312"
                }
            ],
            "UINList":
            [
                {
                    "UIN": "6820332287120991",
                    "fiscalDocumentNumber": "332"
                }
            ]
        }
    }
]

Спецификация Specification - Спецификация

Наименование этого сообщения в журнале регистрации: "Спецификация".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Идентификатор спецификации для обмена с Аскорт:Маркировкой;

  2. specDate (ДатаСпецификации) - Дата - Дата спецификации;

  3. shipper (Отправитель) - Строка - Идентификатор отправителя;

  4. consignee (Получатель) - Строка - Идентификатор получателя;

  5. amount (Сумма) - Число - Сумма по спецификации;

  6. VATAmount (СуммаНДС) - Число - Сумма НДС;

  7. priceType (ТипСтоимости) - Строка - Тип стоимости из перечня ГИИС;

    Необязательный параметр. Значение по умолчанию: "P_CONTRACT"

  8. batchCount (КоличествоПартий) - Число - // Служебное поле;

  9. currency (Валюта) - Строка - Код валюты;

    Необязательный параметр. Значение по умолчанию: "RUB"

  10. contracts (Контракты) - Массив - Перечень контрактов спецификации

    1. contractID (ИдентификаторКонтракта) - Строка - Идентификатор (код) контракта
  11. number (УчетныйНомер) - Строка - Номер в инфомрационной системе участника;

  12. specificationState (СостояниеСпецификации) - Строка - // Служебное поле;

    Необязательный параметр. Значение по умолчанию: "DS_SP_COMPLETE_SET"

  13. giisNumber (НомерГИИС) - Строка - // Служебное поле;

Пример пакета с сообщением Specification

[
    {
        "MsgType": "Specification",
        "MsgID": 1,
        "MsgData":
        {
            "id": "6927861f-13eb-43f1-89c4-531cd2ed1249",
            "specDate": "20220403",
            "shipper": "614ca392-4d87-4d15-a8c5-4029e0cc020e",
            "consignee": "13662c97-d1ef-4a3a-bf1c-675445a0cb5f",
            "amount": 1222,
            "VATAmount": 33,
            "batchCount": ,
            "contracts":
            [
                {
                    "contractID": "C-00-000001325-22"
                }
            ],
            "number": "АМ-0031233",
            "giisNumber": 
        }
    }
]

списаниеПартииВыбытие BatchRemoveDisposal -

Наименование этого сообщения в журнале регистрации: "списаниеПартииВыбытие".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Можно передать для последующей перезаписи перечня списываемых партий;

  2. writeOffReason (ПричинаСписания) - Строка - Указывается причина списания.;

    Необязательный параметр. Значение по умолчанию: "Списание"

  3. UINList (СписокУИН) - Массив - Перечений УИНов / ИНП к списанию

    1. UIN (УИН) - Строка - УИН для списания
  4. BatchList (СписокИдентификаторовПартий) - Массив - Перечень партий к списанию

    1. Batch (Партия) - Строка - Идентификатор партии

Пример пакета с сообщением BatchRemoveDisposal

[
    {
        "MsgType": "BatchRemoveDisposal",
        "MsgID": 1,
        "MsgData":
        {
            "id": ,
            "UINList":
            [
                {
                    "UIN": "6432200152139957"
                }
            ],
            "BatchList":
            [
                {
                    "Batch": "id1230123"
                }
            ]
        }
    }
]

списаниеПартииОшибка batchRemoveMistake -

Наименование этого сообщения в журнале регистрации: "списаниеПартииОшибка".

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

  1. id (Идентификатор) - Строка - Можно передать для последующей перезаписи перечня списываемых партий;

  2. writeOffReason (ПричинаСписания) - Строка - Указывается причина списания.;

    Необязательный параметр. Значение по умолчанию: "Списание"

  3. UINList (СписокУИН) - Массив - Перечений УИНов / ИНП к списанию

    1. UIN (УИН) - Строка - УИН для списания
  4. BatchList (СписокИдентификаторовПартий) - Массив - Перечень партий к списанию

    1. Batch (Партия) - Строка - Идентификатор партии

Пример пакета с сообщением batchRemoveMistake

[
    {
        "MsgType": "batchRemoveMistake",
        "MsgID": 1,
        "MsgData":
        {
            "id": ,
            "UINList":
            [
                {
                    "UIN": "6432200152139957"
                }
            ],
            "BatchList":
            [
                {
                    "Batch": "id1230123"
                }
            ]
        }
    }
]

Методы

Метод может быть вызван синхронно и асинхронно: соответственно через PUT методы syncCall и asyncCall. В случае асинхронного вызова результат выполнения метода может быть получен через GET метод getTaskStatus

ПолучитьСписокУИН getUINs - Получение списка УИНов

В журнале регистрации метод имеет наименование: "ПолучитьСписокУИН".

Синхронный вызов метода осуществляется через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getUINs"

Асинхронный вызов через PUT "[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getUINs"

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

  1. IDList (СписокИдентификаторов) - Массив - Перечень идентификаторов, по которым запрашиваются идентификаторы
    1. ID (Идентификатор) - Строка - Идентифкатор партии

Пример параметров метода getUINs

{
    "IDList":
    [
        {
            "ID": "00123123123"
        }
    ]
}

В случае вызова для асинхронного запуска asyncCall/getUINs возвращает результат со следующими полями (в скобках представление для журнала регистрации):

  1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
  2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
  3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getUINs:

{
    "providerID": "ibd1", // Идентификатор поставщика данных
    "taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
    "taskStarted", "true" // Признак, что метод успешно стартовал
    "declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getUINs возвращают результат со следующими полями (в скобках представление для журнала регистрации):

  1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
  2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
  3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
  4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
  5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
  6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
  7. startTime (ВремяЗапуска) - Дата - Начало выполнения
  8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
  9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
  10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
  11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
  12. UINList (СписокУИНов) - Массив -
    1. ID (Идентификатор) - Строка -
    2. UIN (УИН) - Строка -

Пример результата метода getUINs

{
    "taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
    "dataToProcess": 0, // Количество объектов данных к обработке
    "dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
    "dataDeclined": 2, // Количество объектов данных с ошибками
    "progress": 1, // Доля выполенных загрузок сообщений
    "isError": "true", // Наличие ошибок во время выполнения
    "startTime": "20200211150000", // Начало выполнения
    "finishTime": "20200211150500", // Окончание выполнения
    "errorMessage": "", // Представление сообщения об ошибке
    "providerID": "ibd1", // Идентификатор поставщика данных
    "UINList":
    [
        {
            "ID": ,
            "UIN": 
        }
    ]
    "taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}