8

Как узнать id в эдо поток

от admin

Идентификатор участника ЭДО

Идентификатор, или ID, — это уникальный номер. Идентификатор участника ЭДО оператор электронного документооборота присваивает пользователям системы. Идентификационный номер выдается организации по ИНН-КПП. Компании с одинаковым ИНН и разными КПП будут работать с электронными документами под своими идентификаторами.

  • Что такое идентификатор
  • Зачем нужен идентификатор
  • Где посмотреть в Диадоке

Что такое идентификатор

Идентификатор участника ЭДО состоит из комбинации цифр и латинских букв разного регистра.

Первые три символа в номере — это ID оператора электронного документооборота. Набор последующих знаков помогает распознавать пользователей ЭДО.

Как определить оператора ЭДО по идентификатору? Если вы хотите узнать, какой провайдер у контрагента, обратите внимание на первую часть идентификационного номера. Найдите на сайте ФНС России список доверенных операторов юридически значимого электронного документооборота. В списке приведены основные сведения об операторах, в том числе идентификаторы ОЭД. Зная идентификатор участника ЭДО, вы легко определите оператора по первым трем символам.

Так, ID участника ЭДО для клиентов оператора СКБ Контур будет начинаться с 2ВМ.

Зачем нужен идентификатор

Для обмена счетами-фактурами и другими формализованными документами организации необходимо получить идентификатор участника ЭДО. В xml-файлах электронных документов должны быть заполнены поля с номерами отправителя и получателя. Использование уникальных кодов дает возможность ФНС и операторам ЭДО определить организацию в своих системах.

Также идентификаторы участников нужны для настройки роуминга между организациями — клиентами разных операторов ЭДО. В процессе подключения оператору понадобится узнать идентификатор контрагента, с которым абонент хочет наладить связь.

Как получить идентификатор

При регистрации в системе ЭДО новый пользователь подписывает заявление об участии в электронном документообороте. В Контур.Диадоке оно создается, когда организация отправляет первый формализованный документ. Пользователю достаточно проверить реквизиты и подтвердить свое намерение подать заявление.

На основе заявления об ЭДО оператор формирует информационное сообщение, в котором и указывает уникальный код участника — идентификатор ЭДО. Вместе с реквизитами организации данные передаются в налоговую, и новый пользователь может начать работу с электронными формализованными документами.

Где посмотреть в Диадоке

Чтобы узнать идентификатор участника ЭДО в Контур.Диадоке, зайдите в веб-интерфейс сервиса. Откройте меню «Настройки». Вы сразу же увидите идентификатор участника ЭДО (GUID).

Если вы перейдете в раздел «Реквизиты организации», тоже сможете посмотреть идентификационный номер своей организации.

Как узнать идентификатор ЭДО контрагента

Откройте вкладку «Контрагенты» в веб-интерфейсе Контур.Диадока. Через поиск найдите бизнес-партнера, идентификатор которого вы хотите узнать. Нажмите на активную ссылку в наименовании организации. Откроется новое окно в виде карточки контрагента. Кликните на ссылку со словом ID в первой строчке.

Узнать идентификатор участника электронного документооборота

Идентификатор участника электронного документооборота — это уникальный код, который оператор ЭДО присваивает отправителям и получателям электронных документов. Идентификатор может потребоваться для настройки роуминга.

ID контрагента

В разделе «Компании» откройте карточку и наведите указатель на значок подключения к СБИС.

Также идентификатор можно получить с помощью API-метода «СБИС.ИнформацияОКонтрагенте».

ID своей компании

В разделе «Настройки/Наша компания» откройте карточку организации и перейдите в раздел «Документооборот».

Программный интерфейс приложений (API)
для работы с ИС «ЭДО.Поток»

Метод позволяет зарегистрироваться в ИС «ЭДО.Поток» и получить логин и пароль. Логин и пароль необходим для авторизации и работы с API .

Используется метод POST следующего вида:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Запрос должен выглядеть следующим образом:

Назначение полей структуры запроса регистрации приведено в таблице 1.1.

Таблица 1.1. Поля структуры запроса регистрации

Параметр Вложенные поля Формат значения Описание
certificate String Сертификат, экспортированный в формате base64
email String Email клиента
fullLegalAddress String Юридический адрес клиента (полный)
fullName String Полное название организации
ifns String Код ИФНС, состоит из 4-х цифр
inn String ИНН
kpp String КПП
legalAddress Структура Юридический адрес клиента (по составляющим)
fullName String Юридический адрес клиента (единое название), например «г Москва, ул Хуторская 2-я, д 38А стр 15»
area String Область
city String Город
street String Улица
houseNumber String Номер здания
building String Строение/корпус
office String Номер офиса
postalCode String Почтовый индекс
region String Регион
settlement String Поселок
mailAddress mailAddress String Адрес компании для корреспонденции (полный, например «г Москва, ул Хуторская 2-я, д 38А стр 15»)
name String ФИО пользователя
ogrn String ОГРН/ОГРИП компании
password String Пароль от личного кабинета EDO.ru
phone String Номер телефона

В ответ на запрос сервер возвращает структуру данных (приведены примеры значений):

Назначение полей структуры ответа на запрос регистрации приведено в таблице 1.2.

Таблица 1.2. Поля структуры ответа на запрос регистрации

Параметр Вложенные поля Формат значения Описание
result Структура Состояние запроса
clientId String логин клиента
password String пароль клиента
status Структура Состояние запроса
code Integer Числовое представление статуса
message String Сообщение с описанием статуса/ошибки

Доступ в ИС «ЭДО.Поток» возможен при использовании учетной записи пользователя.
Для получения доступа к учетной записи пользователя необходимо успешно пройти процедуру авторизации с помощью механизма AuthToken.

После успешной авторизации пользователь получает токен. И далее к каждому HTTP-запросу к ЭДО.Поток требуется добавлять HTTP-заголовок Authorization с параметром Token .

Здесь: — токен, возвращенный в результате авторизации (см. п. 1.1.).

Например, команда получения списка доступных входящих документов транслируется в следующий HTTP-запрос

1.2. Авторизация в сервисе

Авторизация может производиться двумя способами: с помощью логина и пароля или с помощью механизма AuthToken.

После успешной авторизации любым способом пользователь получает токен. И далее к каждому HTTP-запросу к ЭДО.Поток требуется добавлять HTTP-заголовок Authorization с параметром Token .

Здесь: — токен, возвращенный в результате авторизации (см. пп. 1.2.1 Авторизация через AuthToken и 2.2).

Например, команда получения списка доступных входящих документов транслируется в следующий HTTP-запрос

1.2.1 Авторизация через AuthToken

Авторизация посредством механизма AuthToken предполагает использование квалифицированной электронной подписи (КЭП). Для авторизации необходимо проделать следующую последовательность действий.

1. Со стороны клиента должен быть направлен запрос следующего вида:

В ответ на запрос сервер возвращает структуру данных (приведены примеры значений):

Назначение полей структуры ответа на запрос авторизации приведено в таблице 1.3.

Таблица 1.3. Поля структуры ответа на запрос авторизации

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result String Поле с ключом «result» имеет тип данных «Строка», и в нем возвращается строка для подписания, которая будет использована в следующих шагах.
Действителен в течение суток с момента получения

2. Клиент подписывает строку для подписания с помощью КЭП, а затем отправляет ее вместе с подписью (CMS detached container), закодированную по алгоритму “Base64”, на тот же адрес URL с помощью запроса следующего вида:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Тело запроса содержит следующую структуру (приведены примеры значений):

Назначение полей тела запроса на получение токена приведено в таблице 1.4.

Таблица 1.4. Поля структуры запроса на получение токена

Параметр Формат значения Описание
cmsDetached String Результат подписания строки (параметр result в ответе на запрос GET /auth-with-ds), закодированный с помощью “Base64”. Результат, после кодировки должен быть представлен в виде строки (не забудьте удалить символы переноса срок, например '\n' и '\r')
content String Сама строка для подписания, полученная на предыдущем шаге (параметр result в ответе на запрос GET /auth-with-ds)

3. Сервер производит проверку переданной строки, и в случае успешной проверки возвращает структуру данных (приведены примеры значений):

Назначение полей структуры ответа на запрос авторизации приведено в таблице 1.5.

Таблица 1.5. Поля структуры ответа на запрос авторизации

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Параметры авторизации
sessionId String Токен, далее используемый клиентом в качестве дополнительного параметра в последующих запросах к API .
Действителен в течение суток с момента получения
edoOrgId String Ваш идентификатор участника ЭДО

1.2.2 Авторизация с помощью логина и пароля

Для авторизации с помощью логина и пароля применяется HTTP-запрос, в котором передаются логин и пароль в формате JSON. Запрос имеет следующий вид:

Здесь: — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим.

Оба поля являются обязательными для заполнения.

В ответ на запрос сервер возвращает структуру данных (приведены примеры значений):

Таблица 1.6. Поля структуры ответа на запрос авторизации

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Целое число Код ответа на запрос (0 — OK)
message Строка Сообщение в ответе на запрос
result Строка Токен, далее используемый клиентом в качестве дополнительного параметра в последующих запросах к API

2. ЭДО.Поток

Запросы (функции) программного интерфейса приложений ИС «ЭДО.Поток» предназначены для выполнения операций документооборота (пересылка, сохранение, подписание документов) для внешних информационных систем, взаимодействующих с ИС «ЭДО.Поток». Большинство запросов и ответов имеет вид, описанный в разделе 2, если входные и выходные данные будут другого вида, это будет описываться дополнительно. Данные документов при передаче кодируются алгоритмом “Base64”. Запросы API ИС «ЭДО.Поток» можно разделить на три группы: запросы, связанные с документами, запросы связанные с клиентами и запросы, связанные с контрагентами. К запросам, связанным с клиентами относится также и авторизация пользователя в системе, описанная в разделе 3.

2.1. Документооборот

2.1.1. УПД/УКД

Универсальный передаточный документ (УПД) можно использовать как:

Универсальный корректировочный документ (УКД) можно использовать как:

Форматы

Документ Подробное описание Форматы Тип документа
в ЭДО.Поток
Счет-фактура Счет-фактура
УПД с функцией СЧФ		 Приказ №93 (устарел)
Приказ №155 (устарел)
Приказ №820		 1
Счет-фактура (исправительный)
УПД (исправительный) с функцией СЧФ		 Приказ №93 (устарел)
Приказ №155 (устарел)
Приказ №820		 9
Счет-фактура Корректировочный Счет-фактура Корректировочный
УКД с функцией КСЧФ		 Приказ №93 (устарел)
Приказ №189 (устарел)
Приказ №736		 2
Счет-фактура Корректировочный (исправительный)
УКД (исправительный) с функцией КСЧФ		 Приказ №93 (устарел)
Приказ №189 (устарел)
Приказ №736		 10
УПД УПД с функциями СЧФДОП и ДОП Приказ №155 (устарел)
Приказ №820		 8
УПД (исправительный) с функциями СЧФДОП и ДОП Приказ №155 (устарел)
Приказ №820		 30
Титул покупателя УПД Приказ №155 (устарел)
Приказ №820		 11
УКД УКД с функциями КСЧФДИС и ДИС Приказ №189 (устарел)
Приказ №736		 12
УКД (исправительный) с функциями КСЧФДИС и ДИС Приказ №189 (устарел)
Приказ №736		 31
Титул покупателя УКД Приказ №189 (устарел)
Приказ №736		 13

Порядок обмена по приказу 14Н

УПД с функцией СЧФ / УКД с функцией КСЧФ

Рисунок 1. Счет-фактура

УПД с функцией СЧФДОП / УКД с функцией КСЧФДИС

Рисунок 2. УПД

2.1.1. Описание "Action"

«Action»- это список возможных процедур с документами. Список возможных процедур выводится в соответствии с документом. В таблице 2.2. описаны процедуры с документами в соответствие с Action.

Таблица 2.2. Описание процедур с документами в соответствие с Action

Action Документы Действия Описания процедуры
W_BuyerTitle_Accept_Sign_Title_Iop УПД (функция СЧФДОП), УКД (функция КСЧФДИС), в том числе исправительные.
Порядок обмена согласно Приказу 14н		 Подписать Для подписания документа требуется:
1. Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
2. Запросить титул покупателя методом "Сформировать титул покупателя", подписать КЭП и отправить методом "Отправить титул покупателя".
W_BuyerTitle_Accept_Sign_Title Подписать Извещение о получении (ИОП) уже успешно подписано, осталось запросить титул покупателя методом "Сформировать титул покупателя", подписать КЭП и отправить методом "Отправить титул покупателя".
W_BuyerTitle_Accept_Sign_Ukd_Title_Iop Подписать 1. Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
2. Запросить титул покупателя методом "Сформировать титул покупателя", подписать КЭП и отправить методом "Отправить титул покупателя".
W_BuyerTitle_Accept_Sign_Ukd_Title Подписать Извещение о получении (ИОП) уже успешно подписано, осталось запросить титул покупателя методом "Сформировать титул покупателя", подписать КЭП и отправить методом "Отправить титул покупателя".
W_BuyerTitle_Reject_Sign_Uou_Iop Отказать в подписи 1. Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
2. Запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
W_BuyerTitle_Reject_Sign_Uou Отказать в подписи Извещение о получении (ИОП) уже успешно подписано, осталось запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
Wo_BuyerTitle_Reject_Sign_Uou_Iop Счет-фактура, корректировочная счет-фактура, УПД (функция СЧФ), УКД (функция ксчф), в том числе исправительные.
Порядок обмена согласно Приказу 14н		 Запросить уточнение 1. Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
2. Запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
Wo_BuyerTitle_Reject_Sign_Uou Запросить уточнение Извещение о получении (ИОП) уже подписано или по схеме работы с некоторыми операторами ЭДО ИОП не нужен.
Осталось запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
Wo_BuyerTitle_Accept_Sign_Iop Подтвердить получение Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП"
ActionTakeUPD УПД (функция СЧФДОП, ДОП), в том числе исправительные. Подписать
ActionTakeUKD УКД (функция КСЧФДИС), в том числе исправительные. Подписать
ActionSign Неформализованные документы с запросом подписи, например, договор, дополнительное соглашение, акт, акт сверки, накладная. Подписать
ActionSign_FastFinished Подписать
W_2ndSgnRqrd_U10d_Accept_Sign_Orig_Doc_Iop Неформализованные документы с запросом подписи, например, договор, дополнительное соглашение, акт, акт сверки, накладная. Подписать Для подписания документа требуется:
1. Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
2. Подписать сам документ и отправить подпись методом "Отправить подпись на неформализованный документ ".
W_2ndSgnRqrd_U10d_Accept_Sign_Orig_Doc Подписать Извещение о получении (ИОП) уже успешно подписано, осталось подписать сам документ и отправить подпись методом "Отправить подпись на неформализованный документ ".
W_2ndSgnRqrd_U10d_Reject_Sign_Uou_Iop Отказать в подписи Для отказа в подписи требуется:
1. Запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
2. Запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
W_2ndSgnRqrd_U10d_Reject_Sign_Uou Отказать в подписи Извещение о получении (ИОП) уже успешно подписано, для отказа в подписи осталось запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
WO_2ndSgnRqrd_U10d_Accept_Sign_Iop Неформализованные документы без запроса подписи, например счет, письмо. Принять Для принятия документа требуется запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
WO_2ndSgnRqrd_U10d_Reject_Sign_Uou_Iop Запросить уточнение Для запроса уточнения требуется:
1. Запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
2.Затем запросить извещение о получении (ИОП) методом "Сформировать ИОП", подписать КЭП и отправить методом "Отправить ИОП".
WO_2ndSgnRqrd_U10d_Reject_Sign_Uou Запросить уточнение Извещение о получении (ИОП) уже успешно подписано, для запроса уточнения осталось запросить Уведомление об уточнении (УОУ) методом "Сформировать УОУ", подписать КЭП и отправить методом "Отправить УОУ".
ActionRequestRefine_FastFinished Акт (формализованный), Накладная (формализованная), Неформализованные документы с запросом подписи: Произвольный документ, Договор, Дополнительное соглашение, Акт, Акт сверки, Накладная, Счет, Письмо. Отказать в подписи Для отказа в подписи документа требуется:
1. Запросить извещение о получении (ИОП) методом "2.2.14. Получение извещений на документ (для получателя)", подписать КЭП и отправить методом "2.2.2. Отправка документа".
2. Запросить уведомление об уточнении (УОУ) методом "2.2.4. Сформировать ИОП/УОУ/Ответный титул", подписать КЭП и отправить методом "2.2.2. Отправка документа".
ActionRequestRefine Отказать в подписи Извещение о получении (ИОП) уже успешно подписано, осталось запросить уведомление об уточнении (УОУ) методом "2.2.4. Сформировать ИОП/УОУ/Ответный титул", подписать КЭП и отправить методом "2.2.3. Отправка документа".
ActionTakeZAKTPRM_FastFinished Акт (формализованный) Подписать Для подписания документа требуется:
1. Запросить извещение о получении (ИОП) методом "2.2.13. Получение извещений на документ (для получателя)", подписать КЭП и отправить методом "2.2.2. Отправка документа".
2. Запросить ответный титул заказчика методом "2.2.4. Сформировать ИОП/УОУ/Ответный титул", подписать КЭП и отправить методом "2.2.2. Отправка документа".
ActionTakeZAKTPRM Подписать Извещение о получении (ИОП) уже успешно подписано, осталось запросить титул заказчика методом "2.2.4. Сформировать ИОП/УОУ/Ответный титул", подписать КЭП и отправить методом "2.2.2. Отправка документа".
ActionTakeNAKLADN_FastFinished Накладная (формализованная) Подписать Для подписания документа требуется:
1. Запросить извещение о получении (ИОП) методом "2.2.13. Получение извещений на документ (для получателя)", подписать КЭП и отправить методом "2.2.2. Отправка документа".
2. Запросить ответный титул заказчика методом "2.2.4. Сформировать ИОП/УОУ/Ответный титул", подписать КЭП и отправить методом "2.2.2. Отправка документа".
ActionTakeNAKLADN Подписать Извещение о получении (ИОП) уже успешно подписано, осталось запросить титул заказчика методом "2.2.4. Сформировать ИОП/УОУ/Ответный титул", подписать КЭП и отправить методом "2.2.2. Отправка документа".
ActionRemove Доступно для всех неархивированных документов Архивировать
ActionRecover Доступно для всех архивированных документов Восстановить документ из архива

2.2. Работа с документами

2.2.1. Получение списка документов клиента

Для получения списка документов клиента используется HTTP-метод “GET”, в ответ на запрос возвращается список документов клиента, в соответствии с переданным токеном. Список документов клиента может быть запрошен как по всему времени пользования системой, так и по заданному периоду (см. ниже).
Также может быть запрошен как полный список документов, так и его часть (страница), исходя из принципа деления списка на страницы равной длины. Длина страницы и номер выдаваемой страницы определяются в параметрах запроса (см. ниже).
Запрос на получение списка документов клиента имеет вид:

Все параметры в данном запросе приведены в таблице 2.3.

Таблица 2.3. Параметры запроса на получение списка документов

Параметр Заменяемая строка Описание Значение по умолчанию Обязательно в запросе
Версия системы v1 да
direction DIRECTION Направление документооборота. Возможные значения:
in — входящие документы;
out — исходящие документы;
deleted — удаленные документы.		 да
from DATE1 Начальная дата периода поиска документов в формате (dd.mm.yyyy), где dd — день, mm — месяц, yyyy — год нет
to DATE2 Конечная дата периода поиска документов в формате (dd.mm.yyyy) нет
pageIndex INDEX Номер запрашиваемой страницы списка документов; в виде десятичного целого числа 1 нет
pageRecords NUM Количество записей на странице. В виде десятичного целого числа 1000 нет
sortKey KEY1 Столбец для сортировки doc_id нет
sortDirection DIR1 Порядок сортировки. Возможные значения:
asc — восходящая (прямой порядок);
desc — нисходящая (обратный порядок).		 desc нет
typeOfDate TYPE Способ интерпретации даты в полях from и to:
STATUS_CHANGE_DATE — дата изменения статуса;
RECEIVED_DATE — дата получения документа;
CREATION_IN_DOCUMENT_DATE — дата формирования документа.		 RECEIVED_DATE нет

Далее здесь во всех запросах будет указана первая версия API (“v1”).

Пример успешного ответа на запрос (приведены примеры значений, многоточие означает многократно повторяющуюся структуру):

Описание параметров структуры ответа приведены в таблице 2.4.

Таблица 2.4. Описание параметров структуры ответа на запрос списка документов

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Содержащая список документов
data Структура Данные списка документов
direction String Признак документа:
OUT — исходящий;
IN — входящий
docId Integer Идентификационный номер (индекс) документа
fromOrgId String Идентификатор организации-отправителя
fromOrgName String Название организации-отправителя
edoIdFrom String Идентификатор в ЭДО организации-отправителя
edoIdTo String Идентификатор в ЭДО организации-получателя
toOrgId String Идентификатор организации-получателя
docTypeId Integer Идентификатор типа документа
docTypeName String Название типа документа
docStateId Integer Идентификатор статуса (состояния) документа
sfStateName String Статус подписи документа
sfStateId Integer Идентификатор статуса подписи документа
innFrom String ИНН организации-отправителя
innTo String ИНН организации-получателя
kppFrom String КПП организации-отправителя
kppTo String КПП организации-получателя
content String Содержимое документа, закодированное с помощью алгоритма “Base 64”
xmlBody String Содержит тело документа в виде двоичного массива, закодированного с помощью алгоритма «Base 64”
imgBody String Содержит тело документа в виде двоичного массива, закодированного с помощью алгоритма «Base 64”
signature String Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”
certificateSerialNumber String Серийный номер сертификата
fileName String Наименование файла
docName String Наименование документа
docNumber String Номер документа
docDate String Дата генерации документа
sumAll String Общая сумма по документу
sumNds String Общая сумма НДС по документу
updPokupatelyaId String Идентификатор УПД покупателя
marking Boolean Признак наличия маркировки
mcDocState String Стейт отправки документа в ЦРПТ
actions Структура Служебная информация о возможных действиях с документом
forDocument Структура Информация о родительском документе
guid String Уникальный идентификатор
updated String Дата и время последнего обновления, формат ISO, с указанием часов и минут (без секунд, дата и время разделены пробелом)
nds Boolean Признак необходимости расчета НДС
signRequested Boolean Признак необходимости подписания документа
pageInfo Структура Информация о делении списка на страницы и о передаваемой странице списка
pageIndex Integer Номер передаваемой страницы
pageRecords Integer Количество строк списка на странице
pageCount Integer Количество страниц в списке
sortKey String Имя поля ключа сортировки (аналогично запросу)
sortDirection String Направление сортировки (аналогично запросу)

2.2.2. Отправка документа

Для отправки формализованного документа заданному получателю используется запрос на основе метода POST.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры:

Описание параметров запроса на отправку документа приведены в таблице 2.5.

Таблица 2.5. Описание параметров запроса на отправку документа

Параметр Вложенные поля Формат значения Описание Обязательно в запросе
to String Идентификатор получателя да
docType Integer ID типа документа, который требуется отправить.
ID можно получить в методе 2.2.11. Вывод справочника типов документов		 да
content String Содержимое документа, закодированное с помощью алгоритма “Base 64” да
signature String Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64” да
fileName String Имя файла документа да
parentDocId String Идентификатор документа, на основании которого был сгенерирован текущий документ нет
docAttrs Структура Содержит дополнительную информацию о документе нет
docName String Наименование документа нет
docNumber String Номер документа нет
docDate String Дата генерации документа нет
sumAll String Общая сумма по документу, указывается с использованием “.”, например “356.00” нет
sumNds String Общая сумма НДС по документу, указывается с использованием “.”, например “12.10” нет
nds Boolean Признак необходимости расчета НДС нет
signRequested Boolean Признак необходимости подписания документа нет

Пример успешного ответа на запрос описан в разделе "Введение", при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

2.2.3. Получение списка документов для подписания

Для получения клиентом списка документов для подписания используется HTTP-метод “GET”, в ответ на запрос возвращается список документов, в соответствии с переданным токеном.
Запрос на получение списка документов на подписание имеет вид:

Описание параметров запроса приведены в таблице 2.6.

Таблица 2.6. Описание параметров запроса на получение списка документов для подписания

Параметр Заменяемая строка Описание Значение по умолчанию Обязательно в запросе
Версия системы v1 1) да
req-duplex-sign Тип возвращаемых документов:
true — технологические (не требующие второй подписи) и прочие (требующие вторую подпись);
false — только технологические		 false нет

Пример успешного ответа на запрос имеет следующий вид (приведены примеры значений):

Описание параметров ответа на запрос приведены в таблице 2.7.

Таблица 2.6. Описание параметров ответа на запрос списка документов на подписание

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Список документов на подписание
docId Integer Идентификационный номер (индекс) документа
fromOrgId String Идентификатор документа, присвоенный организацией-отправителем
fromOrgName String Название документа, присвоенное организацией-отправителем
toOrgId String Идентификатор документа, присвоенный организацией-получателем
toOrgName String Название документа, присвоенное организацией-отправителем
edoIdFrom String Название системы ЭДО отправителя (в случае передачи документов между различными системами ЭДО)
edoIdTo String Название системы ЭДО получателя (в случае передачи документов между различными системами ЭДО)
docTypeId Integer Идентификатор типа документа
docTypeName String Название типа документа
docStateId Integer Идентификатор статуса (состояния) документа
docStateName String Статус документа
sfStateName String Статус подписи документа
sfStateId Integer Идентификатор статуса подписи документа
content String Содержимое документа, закодированное с помощью алгоритма “Base 64”
signature String Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”
fileName String Имя файла документа
certFingerprint String Отпечаток сертификата
docName String Наименование документа
docNumber String Номер документа
docDate String, описывающая момент времени (дату и время в формате ISO) Дата формирования документа
sumAll String Общая сумма по документу
sumNds String Общая сумма НДС по документу
updated String, описывающая момент времени (дату и время в формате ISO) Дата последнего изменения документа
nds Boolean Признак необходимости расчета НДС

2.2.4. Сформировать ИОП/УОУ/Ответный титул

Метод используется для формирования:

Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

Описание параметров запроса предварительно заполненной формы приведены в таблице 2.8.

Таблица 2.8. Описание параметров запроса предварительно заполненной формы

Параметр Формат значения Описание Обязательно в запросе
docTypeId Integer ID типа документа, который хотим получить в ответе на данный метод.
ID можно получить в методе 2.2.11. Вывод справочника типов документов		 да
parentDocId Integer Идентификатор «родительского» документа, на который хотим получить ИОП/УОУ/Ответный титул. да
serviceAcceptanceDate String Дата принятия работ/услуг.
Используется и является обязательным только для формирования Акта-заказчика (формализованный)
(идентификатор типа документа в ответ на полученный Акт (формализованный) (id=32).		 Условно обязательный
commentForAct String Содержание действий. Указывается «Результаты работ переданы (услуги оказаны)» или иное.
Используется и является обязательным только для формирования Акта-заказчика (формализованный)
(идентификатор типа документа в ответ на полученный Акт (формализованный) (id=32).		 Условно обязательный
textRefinement String Текстовый комментарий да
fingerprint String Отпечаток сертификата да

Пример успешного ответа на запрос имеет следующий вид (приведены примеры значений):

Описание параметров структуры ответа на запрос предварительно заполненной формы приведено в таблице 2.9.

Таблица 2.9. Описание параметров структуры ответа на запрос предварительно заполненной формы

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result String Содержимое предварительно заполненной формы, закодированное с помощью алгоритма “Base 64”

2.2.5. Подписание документа

Для отправки формализованного документа заданному получателю используется запрос на основе метода POST.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

Описание параметров запроса на отправку документа приведены в таблице 2.10.

Таблица 2.10 . Описание параметров запроса на отправку документа

Параметр Формат значения Описание Обязательно в запросе
docId String Идентификатор подписываемого документа да
signature String Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64” да

Пример успешного ответа на запрос описан в разделе "Введение", при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

2.2.6. Удаление документа

Для удаления документа используется запрос на основе метода POST.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

Параметр docId — идентификатор удаляемого документа.
Пример успешного ответа на запрос описан в разделе "Введение", при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

2.2.7. Восстановление документа

Для восстановления удаленного документа используется запрос на основе метода POST.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

Параметр docId — идентификатор удаляемого документа.
Пример успешного ответа на запрос описан в разделе "Введение", при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

2.2.8. Получение детализированной информации о документе

Для получения детализированной информации о документе используется запрос на основе метода GET; запрос имеет следующий вид:

Пример успешного ответа на запрос имеет следующий вид (приведены примеры значений):

Описание параметров ответа описаны в таблице 2.5., п. 2.1.3..

2.2.9. Получение комплекта документов

Запросить комплект связанных документов можно с помощью запроса на основе метода GET, при этом в ответе будут присутствовать все документы комплекта (СФ, ИСФ, КСФ, ИКСФ).
Запрос имеет следующий вид:

Пример успешного ответа на запрос, приведён в п. 2.1.3.

2.2.10. Вывод справочника типов документов

Запросить справочник типов документов, определенных в системе, с указанием их названия, внутреннего идентификатора и признака формализованности можно с помощью запроса на основе метода GET.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Успешный ответ на запрос имеет следующий вид (приведены примеры значений):

Описание параметров ответа на запрос справочника типов документов приведены в таблице 2.11.

Таблица 2.11. Описание параметров ответа на запрос справочника типов документов

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Список документов
id Integer Внутренний идентификатор типа документа
name String Название типа документа
formalized Boolean Признак формализованности шаблона документа
technical Boolean Признак технического документа
primary Boolean Признак первичного документа
pokTitle Boolean Признак вторичного документа

2.2.11. Загрузка документа

Запросить содержимое документа можно с помощью запроса на основе метода GET, при этом в ответе будут присутствовать все документы комплекта (СФ, ИСФ, КСФ, ИКСФ).
Запрос имеет следующий вид:

Описание параметров запроса приведены в таблице 2.12.

Таблица 2.12. Описание параметров запроса загрузки документа

Параметр Заменяемая строка Описание Значение по умолчанию Обязательно в запросе
Версия системы v1 2) да
docId Идентификатор загружаемого документа да
downloadType Тип загрузки:
CURRENT — загрузка только текущего документа с заданным идентификатором;
WITH_SERVICE — загрузка документа с дополнительными служебными документами в архивном файле (.zip)		 CURRENT нет

В ответ на данный запрос начинается загрузка файла в двоичном виде. В заголовках ответа (response headers) указывается имя загружаемого файла.

2.2.12. Получение извещения на подтверждение оператора (для отправителя)

После того как организация отправила документ, Оператор ЭДО создает подтверждение оператора о дате получение документа, подписывает его и направляет организации. Затем, когда организация получила подтверждение оператора, она должна отправить в ответ подписанное извещение о получении данного подтверждения.

Для получения извещения о подтверждении оператора о дате получения документа используется запрос на основе метода GET.
Запрос имеет следующий вид:

Пример успешного ответа на запрос (приведены примеры значений, многоточие означает многократно повторяющуюся структуру):

Параметры структуры ответа приведены в п. 2.2.1. в таблице 2.4.

2.2.13. Получение извещений на документ (для получателя)

После того как организация отправила документ, Оператор ЭДО создает подтверждение оператора о дате получение документа, подписывает его и направляет организации. Затем, когда организация получила подтверждение оператора, она должна отправить в ответ подписанное извещение о получении данного подтверждения.

Для получения извещений для получателя используется запрос на основе метода GET.
Запрос имеет следующий вид:

Пример успешного ответа на запрос, в случае отсутствия извещений:

Пример успешного ответа на запрос, в случае наличия извещений, требующих подписания со стороны получателя:

Параметры структуры ответа приведены в таблице 2.13.

Таблица 2.13. Параметры структуры ответа на запрос

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Содержащая список документов
parentDocPossibleFinished Логический тип Наличие извещений для подписания: false — есть извещения, true — нет извещений
techDocument Структура Данные списка документов
direction String Признак документа:
OUT — исходящий;
IN — входящий
docId Integer Идентификационный номер (индекс) документа
fromOrgId String Идентификатор организации-отправителя
fromOrgName String Название организации-отправителя
edoIdFrom String Идентификатор в ЭДО организации-отправителя
edoIdTo String Идентификатор в ЭДО организации-получателя
toOrgId String Идентификатор организации-получателя
docTypeId Integer Идентификатор типа документа
docTypeName String Название типа документа
docStateId Integer Идентификатор статуса (состояния) документа
sfStateName String Статус подписи документа
sfStateId Integer Идентификатор статуса подписи документа
innFrom String ИНН организации-отправителя
innTo String ИНН организации-получателя
kppFrom String КПП организации-отправителя
kppTo String КПП организации-получателя
content String Содержимое документа, закодированное с помощью алгоритма “Base 64”
signature String Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”
certificateSerialNumber String Серийный номер сертификата
fileName String Наименование файла
docName String Наименование документа
docNumber String Номер документа
docDate String Дата генерации документа
sumAll String Общая сумма по документу
sumNds String Общая сумма НДС по документу
updPokupatelyaId String Идентификатор УПД покупателя
marking Boolean Признак наличия маркировки
mcDocState String Стейт отправки документа в ЦРПТ
actions Структура Служебная информация о возможных действиях с документом
forDocument Структура Информация о родительском документе
guid String Уникальный идентификатор
updated String Дата и время последнего обновления, формат ISO, с указанием часов и минут (без секунд, дата и время разделены пробелом)
nds Boolean Признак необходимости расчета НДС
signRequested Boolean Признак необходимости подписания документа

2.2.14. Сформировать ИОП

Для того чтобы получить извещение о получении документа (далее ИОП) применяется запрос, построенный на HTTP-методе POST и имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса ИОП, приведены в таблице 2.14.

Таблица 2.14. Описание параметров запроса ИОП

Параметр Формат значения Описание Обязательно в запросе
parentDocId Integer Идентификатор родительского документа да
fingerprint String Отпечаток сертификата да

Приведен пример ответа на запрос:

Таблица 2.15. Описание параметров ответа на запрос ИОП

Параметр Формат значения Описание
contentBase64 String Содержимое документа зашифрованное в формате Base64
uuid String Уникальный идентификатор черновика
docTypeId Integer Идентификатор типа документа черновика

2.2.15. Отправить ИОП

Для того чтобы отправить подписанный ИОП, применяется запрос построенный на HTTP-методе POST и имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса на опубликование ИОП, приведены в таблице 2.16.

Таблица 2.16. Описание параметров запроса на опубликование ИОП

Параметр Формат значения Описание Обязательно в запросе
uuid String Идентификатор черновика документа (UUID) да
signatureBase64 String Открепленная подпись содержимого документа. (Строка зашифрованная в формате Base64) да

Приведен пример ответа на запрос:

Таблица 2.17. Описание параметров ответа на запрос опубликования ИОП

Параметр Формат значения Описание
docId Integer Идентификатор подписанного документа (Number)
docUuid String Идентификатор подписанного документа (UUID)

2.2.16. Получение любых извещений на документы

После того как организация отправила документ, Оператор ЭДО создает подтверждение оператора о дате получение документа, подписывает его и направляет организации. Затем, когда организация получила подтверждение оператора, она должна отправить в ответ подписанное извещение о получении данного подтверждения.

Для получения извещений по всем документам используется запрос на основе метода GET.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Пример успешного ответа на запрос, в случае наличия извещений, которые требуется подписать организации:

Описание параметров структуры ответа приведены в в разделе 2.2.13. в таблице 2.13.

Пример успешного ответа на запрос, в случае отсутствия извещений:

2.2.17. Получение PDF-представления формализованного документа

Документ в формате “Adobe PDF” удобен для просмотра и печати, возможность генерации такого документа присутствует в ИС «ЭДО.Поток», это действие возможно произвести с помощью запроса на основе HTTP-метода GET.
Запрос имеет следующий вид:

В ответ на данный запрос начинается загрузка файла в двоичном виде. В заголовках ответа (response headers) указывается имя загружаемого файла.

2.2.18. Сформировать титул покупателя УПД/УКД

Для того чтобы получить черновик титула УПД или черновика титула УКД, применяется запрос построенный на HTTP-методе POST и имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса для получения черновика титула УПД и УКД, приведены в таблице 2.19.

Таблица 2.19. Параметры запроса для получения черновика титула УПД и УКД

Параметр Вложенный параметр Формат значения Описание Обязательно в запросе
parentDocId Integer Идентификатор родительского документа да
fingerprint String Отпечаток сертификата. (Строка SHA1 hash) да
additionalParams Структура да
fingerprint String Отпечаток сертификата. (Строка SHA1 hash) да
parentDocId String Идентификатор родительского документа да
docTypeId String Для получения титула УПД покупателя (для УПД со значением Type 8 и УПД исправительный со значением Type 8) ставим значение 11,
Для получения титула УКД покупателя (для УПД со значением Type 12 и УПД исправительный со значением Type 31), ставим значение 13		 да
svPrinSodOper String Указывается действия, например:
— «Товары принял без претензий»;
— «Результаты работ принял без претензий»;
— «Услуги получены, претензий нет»; или другое.		 да
svPrinDataPrin String Дата принятия УПД. да
textRefinement String Текстовый комментарий. да

Приведен пример ответа на запрос:

Таблица 2.20. Описание параметров ответа на запрос получения черновика титула УПД-ПОК

Параметр Формат значения Описание
contentBase64 String Содержимое документа в формате Base64.
uuid String Уникальный идентификатор черновика(заготовки). (UUID)
id Integer Идентификатор типа документа черновика(заготовки). (Number)

2.2.19. Отправить титул покупателя УПД/УКД

Для того чтобы опубликовать подписанный черновик титула УПД или подписанный черновик титула УКД, применяется запрос построенный на HTTP-методе POST и имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса опубликования подписанного черновика титула УПД или подписанного черновика титула УКД, приведены в таблице 2.21.

Таблица 2.21. Параметры запроса опубликования подписанного черновика титула УПД или подписанного черновика титула УКД

Параметр Формат значения Описание Обязательно в запросе
uuid String Идентификатор черновика(заготовки) документа. (UUID), да
signatureBase64 String Открепленная подпись содержимого документа в формате Base64) да

Приведен пример ответа на запрос:

Таблица 2.22. Описание параметров ответа на запрос опубликования подписанного черновика титула УПД или подписанного черновика титула УКД

Параметр Формат значения Описание
docId Integer Идентификатор подписанного документа. (Number)
docUuid String Идентификатор подписанного документа. (UUID)

2.2.20. Сформировать УОУ

Для того чтобы получить черновик УОУ, применяется запрос построенный на HTTP-методе POST и имеющий следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса для получения черновик УОУ, приведены в таблице 2.23.

Таблица 2.23. Параметры запроса для получения черновика УОУ

Параметр Вложенный параметр Формат значения Описание Обязательно в запросе
provisionalDocParams Структура да
parentDocId Integer Идентификатор родительского документа да
fingerprint String Отпечаток сертификата. (Строка SHA1 hash) да
additionalParams Структура да
fingerprint String Отпечаток сертификата. (Строка SHA1 hash) да
parentDocId String Идентификатор родительского документа да
docTypeId String 6 — это уведомление об уточнении. да
textRefinement String Текстовый комментарий. да

Приведен пример ответа на запрос:

Таблица 2.24. Описание параметров ответа на запрос получения черновика УОУ

Параметр Формат значения Описание
contentBase64 String Содержимое документа в формате Base64. (Подписывать требуется данные после снятия base64)
uuid String Уникальный идентификатор черновика(заготовки). (UUID)
id String Идентификатор типа документа черновика(заготовки). (Number)

2.2.21. Отправить УОУ

Для того чтобы опубликовать подписанный черновик для УОУ, применяется запрос построенный на HTTP-методе POST и имеющий следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса опубликование подписанного черновика для УОУ, приведены в таблице 2.25.

Таблица 2.25. Параметры запроса опубликование подписанного черновика для УОУ

Параметр Формат значения Описание Обязательно в запросе
uuid String Идентификатор черновика(заготовки) документа. (UUID) да
signatureBase64 String Открепленная подпись содержимого документа. (Строка в формате Base64) да

Приведен пример ответа на запрос:

Таблица 2.26. Описание параметров ответа на запрос опубликования подписанного черновика для УОУ

Параметр Формат значения Описание
docId Integer Идентификатор подписанного документа. (Number)
docUuid String Идентификатор подписанного документа. (UUID)

2.3. Методы работы с черновиками

2.3.1 Метод загрузки черновика

Для загрузки черновика используется запрос на основе метода POST.
Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Таблица 2.29. Параметры запроса

Параметр Формат значения Описание Обязательно в запросе
content String Содержимое документа, закодированное с помощью алгоритма “Base 64”,
в одну строку (без переноса строк)		 да
docType Integer Тип документа (параметр id в ответе на запрос) Вывод справочника типов документов. да
fileName String Наименование документа да
signRequested Boolean Запрос подписи у контрагента:
true — требуется подпись,
false — подпись не требуется.
Подпись контрагента запрашивается всегда по:
УПД, УКД, Накладная (формализованная), Акт (формализованный).
Подпись никогда не запрашивается по любым счет-фактурам.		 да
to String Идентификатор клиента в ИС «ЭДО.Поток».
Можно получить используя метод Поиск контрагентов		 да

Пример успешного ответа на запрос

Описание параметров структуры ответа приведены в таблице 2.30.

Таблица 2.30. Описание параметров структуры ответа

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Содержащая список документов
data Структура Данные списка документов
draftId String Идентификатор черновика в системе «ЭДО.Поток»
fromOrgId String Идентификатор организации-отправителя
fromOrgName String Название организации-отправителя
edoIdFrom String Идентификатор в ЭДО организации-отправителя
edoIdTo String Идентификатор в ЭДО организации-получателя
toOrgId String Идентификатор организации-получателя
toOrgName String Название организации-получателя
docTypeId Integer Идентификатор типа документа
docTypeName String Название типа документа
innFrom String ИНН организации-отправителя
innTo String ИНН организации-получателя
kppFrom String КПП организации-отправителя
kppTo String КПП организации-получателя
content String Содержимое документа, закодированное с помощью алгоритма “Base 64”
fileName String Наименование файла
docName String Наименование документа
docNumber String Номер документа
docDate String Дата генерации документа
sumAll String Общая сумма по документу
sumNds String Общая сумма НДС по документу
statusId Integer Идентификатор статуса (состояния) документа:
0 — не готов, не заполнены параметры , обязательные для отправки;
1 — готов к отправке.
statusName String Наименование статуса (состояния) документа
nds Boolean Признак необходимости расчета НДС
signRequested Boolean Признак необходимости подписания документа
updated String Дата и время загрузки черновика
errorCode Массив Ошибки, которые могли возникнуть при загрузке черновика

2.3.2 Метод получения списка черновиков

Для получения списка черновиков используется запрос на основе метода POST.

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса приведены в таблице 2.31.

Таблица 2.31. Описание параметров запроса

Параметр Формат значения Описание Обязательно в запросе
from String Начальная дата периода поиска черновиков в формате (dd.MM.yyyy HH:mm), где dd — день, mm — месяц, yyyy — год, HH — часы, mm — минуты. нет
to String Конечная дата периода поиска черновиков в формате (dd.MM.yyyy HH:mm), где dd — день, mm — месяц, yyyy — год, HH — часы, mm — минуты. нет
orgNameTo String Наименование компании получателя нет
orgInnTo String ИНН получателя нет
docTypeId Array[integer] Тип документа (параметр id в ответе на запрос) Вывод справочника типов документов. нет
status Array[integer] Статус черновика:
1 — «Готов», черновик готов к отправке;
0 — «Не готов», значит, что черновик не может быть отправлен, например ошибка: «Не найден предполагаемый получатель файла».		 нет
pageIndex Integer Номер страницы выдачи (по умолчанию — 1) нет
pageRecords Integer Количество записей на странице (по умолчанию — 1000) нет
pageCount Integer Всего страниц нет
sortKey String Столбец для сортировки.
По умолчанию — docDate.		 нет
sortDirection String Порядок сортировки. Возможные значения:
asc — восходящая (прямой порядок);
desc — нисходящая (обратный порядок).
По умолчанию — desc		 нет

Пример ответа на запрос

Описание параметров структуры ответа приведены в таблице 2.32.

Таблица 2.32. Описание параметров структуры ответа

Параметр Вложенные поля Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Содержащая список черновиков
data Структура Данные списка черновиков и страниц выдачи
data Структура Данные списка черновиков
draftId String Идентификатор черновика в системе «ЭДО.Поток»
fromOrgId String Идентификатор организации-отправителя
fromOrgName String Название организации-отправителя
edoIdFrom String Идентификатор в ЭДО организации-отправителя
edoIdTo String Идентификатор в ЭДО организации-получателя
toOrgId String Идентификатор организации-получателя
toOrgName String Название организации-получателя
docTypeId Integer Идентификатор типа документа
docTypeName String Название типа документа
innFrom String ИНН организации-отправителя
innTo String ИНН организации-получателя
kppFrom String КПП организации-отправителя
kppTo String КПП организации-получателя
content String Содержимое документа, закодированное с помощью алгоритма “Base 64”
fileName String Наименование файла
docName String Наименование документа
docNumber String Номер документа
docDate String Дата генерации документа
sumAll String Общая сумма по документу
sumNds String Общая сумма НДС по документу
statusId Integer Идентификатор статуса (состояния) документа:
0 — не готов, не заполнены параметры, обязательные для отправки;
1 — готов к отправке.
statusName String Наименование статуса (состояния) документа
nds Boolean Признак необходимости расчета НДС
signRequested Boolean Признак необходимости подписания документа
updated String Дата и время загрузки черновика
errorCode Массив Ошибки, которые могли возникнуть при загрузке черновика
pageInfo Структура Информация о делении списка на страницы и о передаваемой странице списка
pageIndex Integer Номер страницы выдачи
pageRecords Integer Количество записей на странице
pageCount Integer Всего страниц
sortKey String Столбец для сортировки.
По умолчанию — docDate.
sortDirection String Порядок сортировки. Возможные значения:
asc — восходящая (прямой порядок);
desc — нисходящая (обратный порядок).
По умолчанию — desc

2.3.3 Метод скачивания черновика

Для скачивания черновика используется запрос на основе метода POST.

В ответ на данный запрос начинается загрузка файла в двоичном виде.

2.3.6 Метод удаления черновика

Для удаления черновика используется запрос на основе метода POST.

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

Параметр draftId — идентификатор удаляемого черновика в «ЭДО.Поток». Пример успешного ответа на запрос описан в разделе "Введение", при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

2.4. Работа с контрагентами

Перед началом работы с контрагентами, проверьте возможность обмена документами с организациями. Для этого используйте метод "Поиск контрагентов". Если ваш контрагент зарегистрирован в ЭДО.Поток, то вы можете сразу обмениваться с ним электронными документами. Если организация еще не пользуется сервисом ЭДО.Поток, вы можете отправить ей приглашение на почту, методом "Отправка контрагенту на почту ссылку с приглашением в ЭДО.Поток". Если контрагент пользуется другим оператором ЭДО — вам понадобится разово настроить роуминг с ним.

Роуминг можно настроить несколькими способами:

Для настройки роуминга с использованием приглашений необходимо:

2.4.1. Поиск контрагентов

Метод позволяет искать контрагентов, с которыми можно сразу начать обмен документами: контрагент или зарегистрирован и работает в ЭДО.Поток или с контрагентом успешно настроен роуминг через стороннего оператора ЭДО.

Поиск контрагентов в ИС «ЭДО.Поток» осуществляется HTTP-метода GET и имеет следующий вид:

Описание параметров запроса на поиск контрагента приведены в таблице 2.33.

Таблица 2.33. Описание параметров запроса на поиск контрагента

Параметр Заменяемая строка Описание
Версия системы, текущая версия равна v1. В дальнейшем версия может измениться
query ИНН клиента, КПП клиента или последовательность символов, искомая в полном названии контрагента 3)

Успешный ответ на запрос имеет следующий вид:

Описание параметров ответа на запрос на поиск контрагента приведены в таблице 2.34.

Таблица 2.34. Описание параметров ответа на запрос поиска контрагента

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Информацию по клиенту
data Структура Записи о контрагентах. Параметры элементов структуры data приведены в таблице 2.35
pageInfo Структура Информация о делении списка на страницы и о передаваемой странице списка
pageIndex Integer Номер передаваемой страницы
pageRecords Integer Количество строк списка на странице
pageCount Integer Количество страниц в списке
sortKey String Имя поля ключа сортировки
sortDirection String Направление сортировки (см. п. 2.2.1., таблица 2.3)

Таблица 2.35. Описание параметров структуры «data»

Параметр Вложенные поля Формат значения Описание
clientId String Идентификатор клиента в ИС «ЭДО.Поток»
fullName String Полное название клиента
phone String Телефонный номер клиента
email String Адрес электронной почты клиента
mailAddress String Фактический почтовый адрес клиента одной строкой
fullLegalAddress String Юридический адрес клиента одной строкой
kpp String КПП клиента
inn String ИНН клиента
ogrn String ОГРН клиента
ifns String Идентификационный номер ФНС, за которой закреплен клиент
certificate String Открытая часть сертификата электронной подписи клиента
stateName String Название государства, к которому относится клиент
legalAddress Структура Информация о юридическом адресе клиента
postalCode String Почтовый индекс
region String Область
area String Район области (если используется)
city String Город
settlement String Населенный пункт
street String Улица
houseNumber String Номер дома
building String Номер корпуса или здания
office String Номер офиса
status String Состояние контрагента
operatorMnemo String Оператор ЭДО контрагента

2.4.2. Получение списка контрагентов с заданным статусом

Для получения списка контрагентов с фильтрацией по статусу применяется запрос, построенный на HTTP-методе GET и имеющий следующий вид:

Описание параметров запроса на поиск контрагента с заданным статусом приведены в таблице 2.36.

Таблица 2.36. Параметры запроса на поиск контрагента с заданным статусом

Параметр Заменяемая строка Описание
Версия системы, текущая версия равна v1. В дальнейшем версия может измениться
status Состояние (статус) контрагента. Возможные значения:
REQUEST_SENT — Отправлена заявка на роуминг ,
REQUEST_RECEIVED — заявка на роуминг получена,
CONFIRMED — роуминг настроен,
NEW — заявка на роуминг сформирована,
BLOCKED — роуминг отключен,
ERROR — Ошибка настройки роуминга

Пример успешного ответа на запрос приведен в разделе. 2.4.1. Структура ответа описана в таблицах 2.34. и 2.35.

2.4.3. Получение списка роуминговых контрагентов и их статуса

Для получения списка роуминговых контрагентов и статусом работы с ними применяется запрос, построенный на HTTP-методе GET и имеющий следующий вид:

Заменяемый параметр — обозначение текущей версии системы, по умолчанию равен v1. Пример запроса:

Приведен пример ответа на запрос:

Таблица 2.37. Описание параметров ответа на запрос роуминговых контрагентов и их статуса

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Информацию по клиенту
data Структура Записи о контрагентах. Параметры элементов структуры data приведены в таблице 2.38
pageInfo Структура Информация о делении списка на страницы и о передаваемой странице списка
pageIndex Integer Номер передаваемой страницы
pageRecords Integer Количество строк списка на странице
pageCount Integer Количество страниц в списке
sortKey String Имя поля ключа сортировки
sortDirection String Направление сортировки (см. п. 2.2.1., таблица 2.3.)

Таблица 2.38. Описание параметров структуры «data»

Параметр Вложенные поля Формат значения Описание
clientId String Идентификатор клиента в ИС «ЭДО.Поток»
fullName String Полное название клиента
phone String Телефонный номер клиента
operatorName String Названия оператора ЭДО
kpp String КПП клиента
inn String ИНН клиента
modifyTime String Дата и время заключения договора с контрагентом, формат ISO
statusType String Статус роуминга:
NEW_CONTRACTORS — «Отправляет заявку», приглашение в процессе отправки,
ARE_CONTRACTORS — «Роуминг настроен»,
ARE_BLOCKED_CONTRACTORS — «Отклонено», роуминг отключен или пришел отказ от контрагента,
RC_INVITE_CONTRACTORS — «Приглашают вас», пришло приглашение на настройку роуминга
RC_REQUEST_CONTRACTORS — «Ожидается ответ», вы отправили приглашение в роуминг, ожидается ответ от контрагента,
RC_ERROR — «Ошибка», настройки роуминга, описание ошибки в errorDescription,
NO_CONNECTION — Нет соединения,
RC_WAITING_FINISH — «В обработке», ожидание окончания настройки роуминга.
invitationErrorDescription Структура Данные об ошибке
errorDescription String Описание ошибки, текст сформирован сторонним оператором ЭДО
messageId String Технический идентификатор ЛС
packageId String Технический идентификатор ТП
actions String мм

2.4.4. Настройка роуминга с контрагентом через ЭДО Лайт

Для настройки роуминга с контрагентом через ЭДО Лайт применяется запрос, построенный на HTTP-методе POST и имеющий следующий вид:

Заменяемый параметр — обозначение текущей версии системы, по умолчанию равен v1.

Описание параметров запроса настройка роуминга с контрагентом приведены в таблице 2.39.

Таблица 2.39. Описание параметров запроса настройки роуминга с контрагентом

Параметр Формат значения Описание Обязательно в запросе
fullName String название контрагента нет
inn String ИНН контрагента да
kpp String КПП контрагента нет

Приведен пример успешного ответа на запрос:

Таблица 2.40. Описание параметров ответа на запрос настройки роуминга с контрагентом

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result String Информация по настройке роуминга с контрагентом

Таблица 2.41. Описания кодов ответа на запрос

Код ответа на запрос Сообщение Описание кода
400 Bad Request неправильный, некорректный запрос
50001 Clients already contractors С клиентом уже настроен роуминг
50002 Contractor not found in EDO LITE Клиент не найден в системе EDO Lite

2.4.5. Отправка приглашения контрагенту

Для отправки приглашения контрагенту применяется запрос, построенный на HTTP-методе POST и имеющий следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса отправка приглашения контрагенту приведены в таблице 2.42.

Таблица 2.42. Описание параметров запроса списка контрагентов выбранного клиента

Параметр Формат значения Описание Обязательно в запросе
clientId String Идентификатор участника ЭДО, в сторонней системе документооборота да
fullName String название организации нет
inn String ИНН контрагента да
kpp String КПП контрагента нет

Приведен пример ответа на запрос:

Таблица 2.43. Описание параметров ответа на запрос списка контрагентов, выбранного клиентам

Параметр Вложенные поля Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result String Статус отправленного приглашения

2.4.6. Отправка контрагенту на почту ссылку с приглашением в ЭДО.Поток

Для отправки приглашения контрагенту на почту ссылку с приглашением в ЭДО.Поток применяется запрос, построенный на HTTP-методе POST и имеющий следующий вид:

Заменяемый параметр — обозначение текущей версии системы, по умолчанию равен v1.

Описание параметров запроса отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток, приведены в таблице 2.44.

Таблица 2.44. Описание параметров запроса отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток

Параметр Формат значения Описание Обязательно в запросе
email String Адрес электронной почты контрагента да

Приведен пример ответа на запрос:

Таблица 2.45. Описание параметров ответа на запрос отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result String Информация по отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток

3. Маркировка

3.1. Авторизация для работы с маркировкой

Для работы с системой маркировки: отправки заказа на эмиссию кодов маркировки, документа ввода в оборот или для обновления статуса обработки этих документов в системе маркировки необходима авторизация со стороны клиента.

Для авторизации потребуется:

3.1.1 Запрос авторизации при единой аутентификации

Запрос имеет следующий вид:

Пример ответа на запрос:

Таблица 3.1. Описание параметров ответа на запрос

Параметр Формат значения Описание
Структура Содержащая контейнеры для подписания
content String Строка на подпись пользователю
id String Уникальный идентификатор запроса на аутентификацию
providerId String Идентификатор провайдера авторизации

3.1.2 Получение ключа сессии при единой аутентификации

Чтобы получить ключ сессии при единой аутентификации, используется метод POST следующего вида:

Таблица 3.2. Описание параметров структуры ответа

Параметр Формат значения Описание
Структура Содержащая контейнеры для подписания
content String Сформированная прикрепленную подпись для контента, полученного ранее: параметр «content» из ответа за запрос метода «Запрос авторизации при единой аутентификации»
id String Уникальный идентификатор запроса на аутентификацию, полученный в методе «Запрос авторизации при единой аутентификации»
providerId String Идентификатор провайдера авторизации, полученный в методе «Запрос авторизации при единой аутентификации»

Пример ответа на запрос:

Таблица 3.3. Описание параметров структуры ответа на запрос

Параметр Формат значения Описание
inn String ИНН клиента
legalAddress Массив данных Профили авторизации
providerId String Идентификатор провайдера авторизации
tokenTtl String Время инвалидации токена (UTC).

3.1.3 Получение состояния авторизации

Чтобы получить состояние авторизации, используется метод GET следующего вида:

Пример ответа на запрос:

Таблица 3.4. Описание параметров структуры ответа на запрос состояния авторизации

Параметр Формат значения Описание
inn String ИНН пользователя
legalAddress Массив данных Профили авторизации
providerId String Идентификатор провайдера авторизации. Параметр будет отсутствовать, если токена авторизации нет или закончился срок его действия
tokenTtl String Время инвалидации токена (UTC). Параметр будет отсутствовать, если токена авторизации нет или закончился срок его действия

3.2. Заказ кодов маркировки

Прежде чем создать и отправить первый заказ в «Честный ЗНАК», настройте работу с заказами. Для этого вам понадобится указать параметр OMS ID — уникальный идентификатор клиента в Станции управления заказами (СУЗ) и получить OmsConnection — уникальный идентификатор соединения.

Шаги по первичной настройке работы с заказами:

Текущие параметры OMS ID и OmsConnection можно получить с помощью метода "Получение параметров OMS ID и OmsConnection".

Порядок действий при заказе кодов маркировки:

Так же существуют методы:

3.2.1 Создание заказа на коды маркировки

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса на создание заказа приведены в таблице 3.5.

Таблица 3.5. Описание параметров запроса на создание заказа

Параметр Вложенные поля Формат значения Описание Обязательно в запросе
orderName String Наименование заказа Да
number String Номер заказа (должен быть уникальным) Да
comment String Комментарий к заказу Нет
positions Структура Список товаров Да
gtin String (14) [0-9]

Код товара (GTIN) Да
name String Наименование товара Да
quantity Integer ($int32) Количество КМ Да
serialNumberType String Способ генерации серийных номеров:
SELF_MADE — самостоятельно;
OPERATOR — оператором ГИС МТ.		 Да
serialNumbers JSON Array of String Массив серийных номеров. Это
поле указывается в случае, если
значение «serialNumber = SELF_MADE»		 Нет
Условно
обязательное
templateId Integer ($int32) Идентификатор шаблона товарной группы:
1 — обувные товары;
10 — предметы одежды, белье постельное, столовое, туалетное и кухонное;
7 — шины и покрышки пневматические резиновые новые;
8 — фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки;
9 — Духи и туалетная вода;
11 — велосипеды и велосипедные рамы;
12 — кресла коляски.		 Да
cisType String Тип кода маркировки:
UNIT — единица товара;
BUNDLE — комплект, используется только для ТГ «Одежда»;
SET — набор.		 Нет
Условно
обязательное
exporterTaxpayerId String ИНН/УНБ (или аналог) экспортера.
Используется только для ТГ «Одежда», «Фото», «Шины», «Духи» и «Обувь».
Становится обязательным для этих ТГ, только если в поле releaseMethod
(способ выпуска товара в оборот) было выбрано
значение «CROSSBORDER» (Ввезен в РФ из стран ЕАЭС)		 Нет
Условно
обязательное
productGroup String Товарная группа:
lp — Легкая промышленность (одежда);
shoes — Обувь;
perfumery — Духи и туалетная вода;
tires — Шины;
electronics — Фототехника;
bicycle — Велосипеды;
wheelchairs — Кресла-коляски.		 Да
clientToken String Да
omsId String Да
createMethodType String Способ изготовления:
SELF_MADE — Самостоятельно;
CEM — ЦЭМ;
CM — Контрактное производство;
CL — Логистический склад;
CA — Комиссионная площадка.
Используется только для ТГ «Одежда», «Фото», «Кресла-коляски», «Велосипеды», «Шины», «Духи» и «Обувь», обязательно для данных ТГ.		 Нет
Условно
обязательное
releaseMethodType String Способ выпуска товаров:
PRODUCTION — производство РФ;
IMPORT — ввезен в РФ (импорт);
COMMISSION — Принят на комиссию от физического лица (доступно для ТГ «Одежда», «Обувь»).
Используется только для ТГ «Одежда» и «Обувь», обязательно для данных ТГ.		 Нет
Условно
обязательное
contactPerson String Контактное лицо.
Используется только для ТГ «Одежда», «Велосипеды», «Кресла-коляски», «Шины», «Фото», «Духи» и «Обувь».		 Нет
productionOrderId String Идентификатор производственного заказа.
Используется только для ТГ «Одежда», «Велосипеды», «Кресла-коляски», «Фото», «Шины», «Духи» и «Обувь».		 Нет
serviceProviderId String (36) UUID Идентификатор сервис-провайдера.
Используется только при наличии сервис-провайдера
в ЛК Честного знака.		 Нет

Пример содержимого заказа кодов по товарной группе «Предметы одежды, белье постельное, столовое, туалетное и кухонное»

Пример содержимого заказа кодов по товарной группе «Обувные товары»

В случае успешной отправки возвращается идентификатор заказа (draftId). Пример успешного ответа на запрос:

Пример неуспешного ответа с кодом ошибки 40032:

В запросе создание заказа на коды маркировки присутствуют элементы совпадающие с GTIN.

3.2.2 Получить контенты заказа для подписания

Для получения контентов заказа для подписания используется запрос на основе метода GET. Запрос имеет следующий вид:

Пример успешного ответа на запрос:

Описание параметров ответа приведены в таблице 3.6.

Таблица 3.6. Описание параметров структуры ответа на запрос

Параметр Формат значения Описание
Структура Содержащая контейнеры для подписания
content String Контент документа в формате base64
id String Идентификатор контента документа

После получения контентов для подписания, нужно подписать их. Для этого требуется перевести данные из формата base64 и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправляем ее, используя метод "2.1.3 Отправка подписанных контентов заказа".

3.2.3 Отправка подписанных контентов заказа

Метод позволяет отправить заказ на обработку в «Честный ЗНАК». Используется после получения контентов из метода "3.1.2 Получить контенты заказа для подписания" и их подписания. Для подписания контента требуется перевести данные параметра «content» из формата base64 и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправить ее в параметре «content» запроса "3.1.3 Отправка подписанных контентов заказа".

Для отправки подписанных контентов заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

Описание параметров запроса на отправку заказа в «Честный ЗНАК» представлены в таблице 3.7.

Таблица 3.7. Описание параметров структуры запроса

Параметр Формат значения Описание
Структура Содержащая подписанные контейнеры
content String Подписанный контент заказа
id String Идентификатор контента заказа

Пример содержимого метода отправки заказа:

В случае успешной отправки возвращается Response Messages: 200 ОК.

Пример неуспешного ответа с кодом ошибки 40031:

Подписанные контейнеры не прошли проверку, подписанные контейнеры не входят в состав заказа.

3.2.4 Получить статус заказа

Метод позволяет получить статус конкретного заказа, используется запрос на основе метода GET. Запрос имеет следующий вид:

Пример успешного ответа на запрос:

Описание параметров ответа представлены в таблице 3.8.

Таблица 3.8. Описание параметров структуры ответа на запрос

Формат значения Описание
String Статус заказа:
DRAFT — Черновик,
INPROC — Заказ в обработке,
SUCCESS — Заказа обработан без ошибок,
FAILURE — Заказ обработан: ошибка по всем позициям,
PARTIALFAILURE — Заказ обработан: часть позиций с ошибками.

3.2.5 Список заказов и их статусы

Для получения списка заказов и их статусов используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса приведены в таблице 3.9.
Таблица 3.9.Описание параметров запроса на получение списка заказа

Параметр Формат значения Описание Значение по умолчанию Обязательность в запросе
creationTimeFromIncl String Начальная дата периода поиска документов в формате (yyyy-MM-ddTHH:mm:ssZ), где yyyy — год, mm — месяц, dd — день, T — это долговременный паттерн (константа), HH — часы, mm — минуты, ss — секунды, Z — часовой пояс. Примеры даты: «2021-02-15T18:46:25+03:00» — UTC+03 часа, по Московскому времени, «2021-02-15T18:46:25Z» — UTC. нет
creationTimeToExcl String Конечная дата периода поиска документов в формате (yyyy-MM-ddTHH:mm:ssZ), где yyyy — год, mm — месяц, dd — день, T — это долговременный паттерн (константа), HH — часы, mm — минуты, ss — секунды, Z — часовой пояс. Текущая дата нет
orderName String Наименование заказа нет
draftId String Идентификатор заказа нет
pageSize NUM Количество записей на странице. В виде десятичного целого числа 1000 нет
pageIndex INDEX Номер запрашиваемой страницы списка документов; в виде десятичного целого числа 1 нет

Пример запроса без фильтров:

Пример успешного ответа на запрос:

Описание параметров ответа представлены в таблице 3.10.

Таблица 3.10. Описание параметров структуры ответа на запрос

Параметр Вложенные поля Вложенные поля Формат значения Описание
result Структура Параметры авторизации
data Структура Данные списка заказов
creationtime String Дата создания заказа
draftId String Идентификатор заказа, полученный в ответе на метод «Создание заказа на коды маркировки»
orderName String Наименование заказа
number String Идентификатор заказа, полученный от пользователя
gtincount String Ваш идентификатор участника ЭДО
productgroup String Товарная группа:
lp — Легкая промышленность (Одежда);
shoes — Обувь;
perfumery — Духи и туалетная вода;
tires — Шины;
electronics — Фототехника;
bicycle –Велосипеды;
wheelchairs — Кресла-коляски.
gtinCounty Integer Количество кодов товара/GTIN в заказе
requestedQuantity Integer Заказанное количество кодов маркировки
actualQuantity Integer Фактически полученное количество кодов маркировки
status String Статус заказа:
DRAFT — Черновик,
INPROC — Заказ в обработке,
SUCCESS — Заказа обработан без ошибок,
FAILURE — Заказ обработан: ошибка по всем позициям,
PARTIALFAILURE — Заказ обработан: часть позиций с ошибками
pageInfo Структура Информация о делении списка на страницы и о передаваемой странице списка
pageCount Integer Количество страниц в списке
pageIndex Integer Номер передаваемой страницы
pageRecords Integer Количество строк списка на странице
sortDirection String Порядок сортировки.
Возможные значения: asc — восходящая (прямой порядок);
desc — нисходящая (обратный порядок).
Значение по умолчанию — desc.
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос

3.2.6 Получение кодов маркировки

Метод используется для получения кодов маркировки по заказу. Заказ должен иметь статус Success или PartialFailure. Метод позволяет забрать все доступные коды по заказу или по конкретному коду товара (gtin).
Для получения кодов маркировки используется запрос на основе метода GET.
Запрос имеет следующий вид:

Описание параметров запроса приведены в таблице 3.11.

Таблица 3.11. Описание параметров запроса на получение списка документов

Параметр Заменяемая строка Описание Обязательно в запросе
Обозначение версии системы, текущая версия равна v1 да
draftId Идентификатор заказа да
gtin Код товара нет

Структура успешного ответа на запрос:

Описание параметров ответа представлены в таблице 3.12.

Таблица 3.12. Описание параметров структуры ответа на запрос

Параметр Формат значения Описание
draftId String Идентификатор заказа
markingCodes Массив кодов маркировки

3.2.7 Получение подробной информации о статусе каждого кода товара/GTIN в заказе

Метод позволяет получить информацию о товарных позициях конкретного заказа кодов маркировки, используется запрос на основе метода GET. Запрос имеет следующий вид:

Пример успешного ответа на запрос:

Описание параметров ответа представлены в таблице 3.13.

Таблица 3.13. Описание параметров структуры ответа на запрос

Параметр Вложенные поля Вложенные поля Формат значения Описание
result Структура Содержимое ответа
data Структура Данные контейнера
gtin String Номер gtin
name String Наименование
requestedCodesCnt Integer Количество запрошенных кодов
obtainedCodesCnt Целое число Количество полученных кодов
status Integer Статус заказа по конкретному коду товара/GTIN:
Success — коды получены,
PartialFailure,
Failure — отклонено,
InProс — в обработке,
AwaitingSign — заказ создан, ожидает подписания для отправки в «Честный ЗНАК»
details String Причина ошибки
pageInfo Структура Информация о делении списка на страницы и о передаваемой странице списка
pageCount Integer Количество страниц в списке
pageIndex Integer Номер передаваемой страницы
pageRecords Integer Количество записей на странице.
sortDirection Integer Направление сортировки
sortKey String Порядок сортировки.
Возможные значения:
asc — восходящая (прямой порядок);
desc — нисходящая (обратный порядок).
Значение по умолчанию — desc
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос

3.2.8 Получение информации об общих параметрах заказа

Метод позволяет получить параметры конкретного заказа, используется запрос на основе метода GET. Запрос имеет следующий вид:

Пример успешного ответа на запрос:

Описание параметров ответа представлены в таблице 3.14.

Таблица 3.14. Описание параметров структуры ответа на запрос

Параметр Вложенные поля Вложенные поля Вложенные поля Формат значения Описание
result Структура Параметры авторизации
originalRequest Структура Параметры заказа, полученные при его формировании
number String Номер заказа, указанный клиентом в методе «Создание заказа на коды маркировки»
comment String Комментарий
omsId String Идентификатор клиента в ЧЗ, указанный при создании заказа
clientToken String Токен авторизации, указанный при создании заказа
positions Структура Список товаров
gtin String (14) [0-9]

Код товара (GTIN)
name String Наименование товара
quantity Integer($int32) Количество КМ
serialNumberType String Способ генерации серийных номеров:
SELF_MADE — самостоятельно;
OPERATOR — оператором ГИС МТ.
serialNumbers JSON Array of String Массив серийных номеров. Это
поле указывается в случае, если
значение «serialNumber = SELF_MADE»
templateId Integer ($int32) Идентификатор шаблона товарной группы:
1 — обувные товары;
10 — предметы одежды, белье постельное, столовое, туалетное и кухонное;
7 — шины и покрышки пневматические резиновые новые;
8 — фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки;
9 — Духи и туалетная вода;
11 — велосипеды и велосипедные рамы;
12 — кресла коляски.
cisType String Тип кода маркировки:
UNIT — единица товара;
BUNDLE — комплект;
SET — набор;
GROUP — групповая потребительская упаковка.
Используется только для ТГ «Одежда», обязательно для данной ТГ.
exporterTaxpayerId String ИНН/УНБ (или аналог) экспортера.
Используется только для ТГ «Одежда» и «Обувь».
Становится обязательным для этих ТГ, только если в поле releaseMethod
(способ выпуска товара в оборот) было выбрано
значение «CROSSBORDER» (Ввезен в РФ из стран ЕАЭС)
productGroup String Товарная группа:
lp — Легкая промышленность (одежда);
shoes — Обувь;
perfumery — Духи и туалетная вода;
tires — Шины;
electronics — Фототехника;
bicycle –Велосипеды;
wheelchairs — Кресла-коляски.
clientToken String
omsId String
createMethodType String Способ изготовления:
SELF_MADE — Самостоятельно;
CEM — ЦЭМ;
CM — Контрактное производство;
CL — Логистический склад;
CA — Комиссионная площадка.
Используется только для ТГ «Одежда» и «Обувь», обязательно для данных ТГ.
releaseMethodType String Способ выпуска товаров:
PRODUCTION — производство РФ;
IMPORT — ввезен в РФ (импорт);
REMAINS — маркировка остатков (доступно только для ТГ «Духи и туалетная вода»);
COMMISSION — Принят на комиссию от физического лица (доступно для ТГ «Одежда», «Обувь»).
Используется только для ТГ «Одежда» и «Обувь», обязательно для данных ТГ.
contactPerson String Контактное лицо.
Используется только для ТГ «Одежда» и «Обувь»
productionOrderId String Идентификатор производственного заказа.
Используется только для ТГ «Одежда» и «Обувь»
serviceProviderId String(36) UUID Идентификатор сервис-провайдера.
Используется только при наличии сервис-провайдера
в ЛК Честного знака.
orderName String Наименование заказа
mcOrderInfo Структура Информация об обработке заказа в ЧЗ
comment String Пользовательский комментарий
creationTime String Время создания заказа
finishedProcessingTime String Время получения итогового ответа от ЧЗ по каждому коду товара/GTIN в заказе
orderName String Наименование заказа
startProcessingTime String Время подписания заказа и отправки в ЧЗ
status String Статус заказа:
DRAFT — Черновик,
INPROC — Заказ в обработке,
SUCCESS — Заказа обработан без ошибок,
FAILURE — Заказ обработан: ошибка по всем позициям,
PARTIALFAILURE — Заказ обработан: часть позиций с ошибками
totalObtainedCodesCnt Integer Общее количество полученных КМ для заказа
totalRequestedCodesCnt Integer Общее количество заказанных КМ для заказа
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос

3.2.9 Сохранение OMS ID

Метод позволяет сохранить параметр OMS ID — уникальный идентификатор клиента в Станции управления заказами (СУЗ) Честного ЗНАКа. Как найти этот параметр?
При повторном успешном вызове метода параметр OMS ID пересохраняется.
Используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Параметр Формат значения Описание Обязательно в запросе
omsId String OMS ID — уникальный идентификатор в СУЗ Да

Пример успешного ответа на запрос имеет следующий вид

Описание параметров ответа на запрос авторизации приведено в таблице 3.15.
Таблица 3.15. Описание параметров структуры ответа на запрос авторизации

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Параметры
omsId String OMS ID — уникальный идентификатор в СУЗ

3.2.10 Получить данные для подписи в рамках получения omsConnection

Для получения данных для подписания используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Структура успешного ответа на запрос:

Описание параметров ответа приведены в таблице 3.16.

Таблица 3.16. Описание параметров структуры ответа на запрос

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура Параметры
contentForSignBase64 String Строка для подписания

После получения строки для подписания, нужно подписать ее. Для этого требуется перевести данные из формата base64 и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправить ее, используя метод «5.2.11 Отправка подписанных данных в рамках получения omsConnection».

3.2.11 Отправка подписанных данных в рамках получения omsConnection

Метод позволяет отправить заказ на обработку в «Честный ЗНАК». Используется после получения строки из метода "3.2.10 Получить данные для подписи в рамках получения omsConnection" и ее подписания. Для подписания строки требуется перевести данные из формата base64 и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправить ее в параметре «contentSignedBase64» запроса [#3.2.10 Получить данные для подписи в рамках получения omsConnection|»3.2.10 Получить данные для подписи в рамках получения omsConnection»]].

Для отправки подписанных данных используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса на отправку данных представлены в таблице 3.17.

Таблица 3.17. Описание параметров структуры запроса

Параметр Формат значения Описание
contentBase64 String Строка для подписания, полученная в параметре «contentForSignBase64» метода "Отправка подписанных данных в рамках получения omsConnection"
contentSignedBase64 String Результат подписания строки: открепленная подпись в формате PKCS#7/CMS , закодированная с помощью алгоритма “Base 64”, без переноса строк.

Пример структуры содержимого метода:

Пример успешного ответа на запрос:

Описание параметров ответа приведены в таблице 3.18.

Таблица 3.18. Описание параметров структуры ответа на запрос

Параметр Вложенные поля Формат значения Описание
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос
result Структура

3.2.12 Получение параметров OMS ID и OmsConnection

Метод позволяет получить информацию о сохраненных параметрах OMS ID (уникальный идентификатор клиента в Станции управления заказами (СУЗ) Честного ЗНАКа) и OmsConnection (уникальный идентификатор соединения), используется запрос на основе метода GET. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Пример успешного ответа на запрос:

Описание параметров ответа представлены в таблице 3.19.

Таблица 3.19. Параметры структуры ответа на запрос

Параметр Вложенные поля Формат значения Описание
result Структура Содержимое ответа
omsConnection String Уникальный идентификатор соединения
omsId String Уникальный идентификатор клиента в СУЗ
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос

3.3. Ввод в оборот

Порядок действий при вводе в оборот:

3.3.1 Создать документ ввода в оборот (Импорт ФТС)

Данный метод позволяет создать документ «Ввод в оборот. Импорт ФТС». В случае успешной отправки возвращается идентификатор документа (documentId).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса на создание заказа приведены в таблице 3.20.

Таблица 3.20. Параметры запроса на создание заказа

Параметр Вложенные поля Формат значения Описание Обязательно в запросе
documentNumber String Номер документа ввода в оборот (должно быть уникальным) Да
declarationDate String Дата декларации имеет вид «YYYY-MM-DD». Пример «2020-02-22» Да
declarationNumber String Номер декларации.
Пример номера декларации: «05100000/220220/0002233», где
«220220» — это дата декларации, которая должна совпадать с датой,
указанной в параметре declarationDate.		 Да
comment String Комментарий к документу Нет
positions Структура Список товаров Да
cis String Код маркировки Да
packtype String Тип упаковки:
UNIT — КИ;
LEVEL1-99 — КИТУ.		 Да
productGroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски.		 Да

В случае успешной отправки возвращается идентификатор документа (documentId).
Пример успешного ответа на запрос:

3.3.2 Создать документ ввода в оборот (Полученных от физических лиц)

Данный метод позволяет создать документ «Ввод в оборот. Полученных от физических лиц». В случае успешной отправки возвращается идентификатор документа (documentId).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса на создание заказа приведены в таблице 3.21.

Таблица 3.21. Описание параметров запроса на создание заказа

Параметр Вложенные поля Формат значения Описание Обязательно в запросе
documentnumber String Номер документа ввода в оборот (должно быть уникальным) Да
comment String Комментарий к документу Нет
positions Структура Список товаров Да
uit String Код маркировки. Обязательный, если не указан «uitu» Условно обязательное
uitu String Уникальный идентификатор транспортной упаковки.
Обязательный, если не указан «uit»		 Условно обязательное
product_receiving_date date Дата получения товара. Параметр присутствует в запросе, если его
значение отличается от значения параметра «product_receiving_date».
Задается в формате yyyy-MMddTHH:mm:ss.SSS’Z		 Нет
productgroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски.		 Да
productReceivingDate String (date-time) Дата получения товара. Задается в формате yyyy-MMddTHH:mm:ss.SSS’Z,
например, «2021-01-19T21:00:00.000Z»		 Да

В случае успешной отправки возвращается идентификатор документа (documentId).
Пример успешного ответа на запрос:

3.3.3 Создать документ ввода в оборот (Производство РФ)

Данный метод позволяет создать документ «Ввод в оборот. Производство РФ». В случае успешной отправки возвращается идентификатор документа (documentId).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1.

Описание параметров запроса на создание заказа приведены в таблице 3.22.

Таблица 3.22. Описание параметров запроса на создание заказа

Параметр Вложенные поля Формат значения Описание Обязательно в запросе
documentnumber String Номер документа ввода в оборот (должно быть уникальным) Да
comment String Комментарий к документу Нет
positions Структура Список товаров Да
productGroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски.		 Да
productionDate date Дата создания продукции. Задается в формате yyyy-MM-dd Да
uit String Код маркировки. Обязательный, если не указан «uitu» Условно обязательное
uitu String Уникальный идентификатор транспортной упаковки.
Обязательный, если не указан «uit»		 Условно обязательное
tnved_code String Код товарной номенклатуры (10 знаков) Нет
certificate_document String Код вида документа обязательной сертификации \\Возможные значения:
CONFORMITY_CERTIFICATE — сертификат соответствия;
CONFORMITY_DECLARATION –декларация соответствия		 Нет
certificate_document_number String Номер документа обязательной сертификации Нет
certificate_document_date String (date-time) Дата документа обязательной сертификации. Задается в формате yyyy-MM-dd. Диапазон даты, начиная с 2000-01-01 по дату создания документа Да
vsd_number string Номер ВСД, указывается для ТГ «Молочная продукция», обязательный, если в карточке НК «veterinaryControl» = true Да

В случае успешной отправки возвращается идентификатор документа (documentId).
Пример успешного ответа на запрос:

3.3.4 Получить данные документа ввода в оборот для подписания

Данный метод позволяет получить данные документа для подписания.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

Таблица 3.23. Описание параметров ответа на запрос

Параметр Формат значения Описание
content string Идентификатор контента документа
id String Контент документа в формате base64

3.3.5 Отправить подписанный документ ввода в оборот в «Честный ЗНАК»

Метод позволяет отправить документ ввода в оборот в «Честный ЗНАК». Используется после получения контента из метода «Получение данных документа ввода в оборот для подписания» и их подписания. Для подписания контента требуется перевести данные параметра «content» из формата base64 и поместить в файл для подписания, после чего создать открепленную/отсоединенную однострочную (без знаков переноса) подпись. Затем закодировать полученную подпись в base64 и отправить ее в параметре «content» запроса «Отправка подписанного документа ввода в оборот в «Честный ЗНАК».

Для отправки документа используется запрос на основе метода POST. Запрос имеет следующий вид:

Таблица 3.24. Коды ответа на запрос

Статус кода HTTP Причина ответа
200 Запрос выполнен успешно
401 Ошибка аутентификации/авторизации

3.3.6 Получить статус документа ввода в оборот

Данный метод позволяет получить статус документа ввода в оборот.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

Таблица 3.25. Описание параметров ответа на запрос создание заказа

Параметр Формат значения Описание Обязательно в запросе
codesIntroductionType string Тип документа на ввод в оборот:
LP_FTS_INTRODUCE — Ввод в оборот. Импорт с ФТС;
LP_INTRODUCE_GOODS — Ввод в оборот. Производство;
LK_INDI_COMMISSIONING — Ввод в оборот. Полученных от физических лиц. 		Да
comment String Комментарий к документу Нет
documentId String Уникальный идентификатор документа в ГИС МТ. Да
documentNumber String Уникальный идентификатор запроса пользователя, задается пользователем Да
documentStatus string Статус документа:
Created — «Требуется подпись», документ ввода создан, требуется подписать документ для отправки его в Честный ЗНАК«;
Sending — «Отправляется»
SentForIntroduction — «Отправлен в ЧЗ»
IntroductionFailed — «Ошибка ввода»
SendingError — «Ошибка отправки документа»
Introduced — «Введено в оборот».		 Да
errors string Ошибки документа по вводу в оборот КМ Нет
productgroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски.		 Да

3.4. Проверка кодов маркировки

Метод возвращает подробную информацию о запрашиваемом списке кодов идентификации товара: в одном запросе указывается как один КИ, так и несколько КИ (не более 1000 КИ). Коды товарной группы «Табачная продукция» и «Альтернативная табачная продукция» по блокам можно указывать в запросах как со скобками, так и без скобок. В ответе код всегда будет со скобками.

Перед вызовом метода рекомендуем проверить, что вы авторизованы в системе маркировки с помощью метода "Получить состояние авторизации", указав в запросе в параметре authType значение introduction. В ответе вы получите Время инвалидации токена (параметр tokenTtl). Если время больше текущего, значит вы авторизованы в системе. Если в ответе параметр отсутствует или время меньше текущего, то требуется авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "3.1. Авторизация для работы с маркировкой". При авторизации в запросах в параметре authType указывайте значение introduction.

Запрос имеет следующий вид:

Таблица 3.26. Описание параметров запроса, проверки кода маркировки

Параметр Формат значения Описание Обязательно в запросе
cisList Array[string] Список КИ для получения по ним информации Да
productgroup String Товарная группа:
lp — Легкая промышленность (одежда);
shoes — Обувь;
tobacco — Табачные изделия;
perfumery — Духи и туалетная вода;
tires — Шины;
electronics — Фототехника;
pharma — Лекарственные препараты для медицинского применения;
milk — Молочная продукция;
bicycle — Велосипеды;
wheelchairs — Кресла-коляски;
alternativeTobacco — Альтернативная табачная продукция;
water — Питьевая вода.		 Нет

Пример положительного ответа (Код 200):

Пример ошибки (Код 400):

Требуется проверить авторизацию в честном знаке, методом "Получение состояния авторизации" или пройти повторную авторизацию в честном знаке. Описание авторизации в честном знаке описаны в разделах 3.1.1, 3.1.2.

Таблица 3.27. Параметры ответа на запрос проверки кода маркировки

Параметр Вложенные поля Вложенные поля Вложенные поля Формат значения Описание
result Структура Array
cisInfo Структура Информация по коду маркировки
agentInn String ИНН агента
child Array[string] Список дочерних кодов маркировки
expirationDate String Срок годности
exporterName String Наименование экспортера
markWithdraw Boolean Состояние кода маркировки
maxRetailPricew Integer Максимальная цена розничной продажи
parent String Родительский код
prVetDocument String Идентификатор производственного или транспортного ветеринарного сопроводительного документа (ВСД)
producedDate String Дата ввода товара в оборот
requestedCis String Код маркировки в запросе
cis String Код маркировки в найденный в базе данных «Честный Знак»
gtin String Код товара (GTIN)
productName String Название товара
productGroupId integer Идентификатор товара
productGroup String Товарная группа:
lp — легкая промышленность;
shoes — обувные товары;
clothes — Предметы одежды, белье постельное, столовое, туалетное и кухонное;
tobacco — Табачные изделия;
perfumery — Духи и туалетная вода;
tires — Шины и покрышки пневматические резиновые новые;
electronics — Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки;
pharma — Лекарственные препараты для медицинского применения;
milk — Молочная продукция;
bicycle — Велосипеды и велосипедные рамы;
wheelchairs — Кресла-коляски;
alternativeTobacco — Альтернативная табачная продукция;
water — Питьевая вода.
brand String Марка товара
emissionDate String Дата ввода в оборот кода маркировки
emissionType String Тип кода маркировки может принимать следующие значения:
LOCAL — производство РФ;
FOREIGN — ввезён в РФ;
REMAINS — маркировка остатков;
CROSSBORDER — ввезён из странЕАЭС/
packageType String Тип упаковки может принимать следующие значения:
UNIT — Единица товара;
GROUP — Групповая упаковка;
LEVEL1 — Упаковка 1-го уровня;
LEVEL2 — Упаковка 2-го уровня;
LEVEL3 — Упаковка 3-го уровня;
LEVEL4 — Упаковка 4-го уровня;
LEVEL5 — Упаковка 5-го уровня;
BUNDLE — Комплект;
ATK — Агрегированный таможенный код;
SET — Набор.
ownerInn String ИНН организации владельца кода маркировки
ownerName String Название организации владельца кода маркировки
status String Статус кода маркировки может принимать следующие значения:
EMITTED — Эмитирован. Выпущен;
APPLIED — Эмитирован. Получен;
INTRODUCED — В обороте;
WRITTEN_OFF — Списан;
RETIRED — Выбыл;
WITHDRAWN — Выбыл (только для ТГ «Табачная продукция» и «Альтернативная табачная продукция»);
INTRODUCED_RETURNED — Возвращён в оборот (только для ТГ «Табачная продукция» и «Альтернативная табачная продукция»);
DISAGGREGATION — Расформирован (только для КИТУ, АТК и набора всех ТГ, кроме «Табачная продукция» и «Альтернативная табачная продукция»);
DISAGGREGATED — Расформирован (только для КИТУ и АТК ТГ «Табачная продукция» и «Альтернативная табачная продукция»).
statusEx String Параметр может принимать значения из таблицы «Актуальные особые состояния».
tnVedEaes String Код ТНВЭД
tnVedEaesGroup String Код группы ТНВЭД
withdrawReasonOther String Друга причина вывода из оборота
producerInn String ИНН организации производителя товара
producerName String Название организации производителя товара
markWithdraw boolean Состояния кода маркировки
certDoc Структура Array Данные по документу обязательной сертификации
number String Номер документа
date String Дата проведения сертификации
type String Тип сертификатов имеет следующие значения:
CONFORMITY_CERTIFICATE — сертификат соответствия;
CONFORMITY_DECLARATION — декларация соответствия.
withdrawReason String Причина вывода из оборота, см. «Справочник причин вывода из оборота»
status Структура Состояние запроса
code Integer Код ответа на запрос (0 — OK)
message String Сообщение в ответе на запрос

Таблица 3.28. «Актуальные особые состояния».

Код Описание Актуальный
EMPTY Значение отсутствует
RESERVED_NOT_USED Зарезервировано. Не использовать INTRODUCED
INDIVIDUAL КиЗ индивидуализирован (только для ТГ»Товары из натурального меха«) EMITTED, APPLIED
NON_INDIVIDUAL КиЗ не индивидуализирован (только для ТГ «Товары из натурального меха») EMITTED, APPLIED
WAIT_SHIPMENT Ожидает подтверждения приёмки INTRODUCED
EXPORTED Используется для документов экспорта
LOAN_RETIRED Выведен из оборота по договору рассрочки RETIRED
REMARK_RETIRED Выведен из оборота при перемаркировке WRITTEN-OFF
WAIT_TRANSFER_TO_OWNER Ожидает передачу собственнику (контрактное производство) INTRODUCED
WAIT_REMARK Товар ожидает перемаркировку или КИ списан после нанесения на товар WRITTEN_OFF
RETIRED_CANCELLATION Списание WRITTEN_OFF
RETIRED_DONATION Безвозмездная передача, применяется в документе «Отгрузка» RETIRED
RETIRED_STATE_ENTERPRISE Приобретение государственным предприятием, применяется в документе «Отгрузка» RETIRED
RETIRED_NO_RETAIL_USE Использование для собственных нужд покупателем, применяется в документе «Отгрузка» RETIRED
RETIRED_BEYOND_EEC_EXPORT Экспорт за пределы стран ЕАЭС, применяется в документе Вывод из оборота RETIRED
RETIRED_REMOTE_SALE Продажа по образцам, дистанционный способ продажи, применяется в документе «Вывод из оборота» RETIRED
RETIRED_EEC_EXPORT Экспорт в страны ЕАЭС, применяется в документе «Вывод из оборота» RETIRED
RETIRED_RETURN Возврат физическому лицу, применяется в документе «Вывод из оборота» RETIRED
RETIRED_DAMAGE_LOSS Утрата или повреждение, применяется в документе «Вывод из оборота» RETIRED
RETIRED_DESTRUCTION Уничтожение, применяется в документе «Вывод из оборота» RETIRED
RETIRED_CONFISCATION Конфискация, применяется в документе «Вывод из оборота» RETIRED
RETIRED_LIQUIDATION Ликвидация предприятия, применяется в документе «Вывод из оборота» RETIRED
RETIRED_ENTERPRISE_USE Использование для собственных нужд RETIRED
FTS_RESPOND_NOT_OK Отрицательное решение ФТС APPLIED
FTS_RESPOND_WAITING Ожидает подтверждение ФТС APPLIED
FTS_CONTROL На контроле ФТС APPLIED
IN_GRAY_ZONE Находится в Серой зоне APPLIED

Таблица 3.29. «Справочник причин вывода из оборота».

Причина Описание
KM_SPOILED испорчен КМ
KM_LOST утерян КМ
KM_DESTROYED уничтожен КМ
DESCRIPTION_ERRORS выявлены ошибки описания товара
RETAIL розничная реализация
EEC_EXPORT экспорт в страны ЕАЭС
BEYOND_EEC_EXPORT экспорт за пределы ЕАЭС
RETURN возврат от физ.лица
REMOTE_SALE продажа по образцам, дистанционный способ продажи
DAMAGE_LOSS утрата или повреждение
DESTRUCTION утилизация или уничтожение
CONFISCATION конфискация
LIQUIDATION ликвидация
DONATION безвозмездная передача
STATE_ENTERPRISE приобретение гос.предприятием
NO_RETAIL_USE использование для собственных нужд покупателем
ENTERPRISE_USE использование для собственных нужд предприятия
KM_SPOILED_OR_LOST испорчено либо утеряно СИ с КМ
KM_CANCELLATION аннулирование не преобразованных в СИ с КИ по истечении срока
RETAIL_RETURN возврат от розничного покупателя
REMOTE_SALE_RETURN возврат в случае дистанционной продажи
KMCANCELATION списание при трансформации
OTHER другая причина

3.5. Вывод из оборота

Создание документа доступно для товарных групп «Альтернативная табачная продукция», Антисептики и дезинфицирующие средства», «Биологически активные добавки к пище», «Велосипеды и велосипедные рамы», «Духи и туалетная вода», «Кресла-коляски», «Молочная продукция», «Обувные товары», «Пиво, напитки, изготавливаемые на основе пива, слабоалкогольные напитки», Предметы одежды, бельё постельное, столовое, туалетное и кухонное«, «Упакованная вода», «Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки», «Шины и покрышки пневматические резиновые новые».

Порядок действий при выводе из оборота:

Список всех заявок на вывод из оборота можно получить методом "Получение списка заявок". Методом "Получение списка кодов маркировки из заявки" можно получить список всех кодов маркировки, которые были в документе вывода.

3.5.1. Создание заявки "Вывод из оборота"

Метод позволят создать заявку на вывод из оборота кодов маркировки.

Заменяемый параметр по умолчанию заменяется на v1.

Таблица 3.30. Описание параметров запроса

Параметр Вложенные поля Вложенные поля Формат значения Описание Обязательность
в запросе
conmment String Комментарий Нет
documentDescription String Наименование заявки Да
payload Структура Заявка на вывод из оборота кодов маркировки
action String Причины вывода из оборота:
RETAIL — розничная реализация;
EEC_EXPORT — экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT — экспорт за пределы ЕАЭС;
RETURN — возврат от физ.лица;
REMOTE_SALE — продажа по образцам, дистанционный способ продажи;
DAMAGE_LOSS — утрата или повреждение;
DESTRUCTION — утилизация или уничтожение;
CONFISCATION — конфискация;
LIQUIDATION — ликвидация;
ENTERPRISE_USE — использование для собственных нужд предприятия;
STATE_SECRET — приобретение гос.предприятием;
OTHER — другая причина		 Да
action_date Date Дата вывода из оборота Да
destination_country_code String Параметр применим, если значение параметра
«action»(«Причина вывода из оборота») =
«EEC_EXPORT» («Экспорт в страны ЕАЭС»).
В случае указания иных причин вывода товара из оборота данный
параметр строго не заполнен.
Код страны назначения:
112 — Республика Беларусь;
417 — Киргизская Республика;
398 — Республика Казахстан;
051 — Республика Армения		 Нет
action_date Date Дата вывода из оборота. Формат даты «DD.MM.YYYY» Да
document_date Date Дата первичного документа.
Формат: 2020-01-14T00:00:00.000Z. Обязательный, если заполнен «document_type» («Тип первичного документа»)		 Условно
обязательное
document_number String Номер первичного документа.
Обязательный, если заполнен «document_type» («Тип первичного документа»)		 Условно
обязательное
document_type String Тип первичного документа.
Обязательный, если в массиве «products» («Массив, содержащий список кодов») не заполнен параметр «primary_document_type» («Тип первичного документа»).
Одновременное заполнение не допускается.
Если заполнен, то обязательно заполнение параметров: «document_number» («Номер первичного документа»), «document_date» («Дата первичного документа»).

Возможные значения: «RECEIPT» — «Кассовый чек»; «SALES_RECEIPT» — «Товарный чек»; «CONSIGNMENT_NOTE» — «Товарная накладная»; «CUSTOMS_DECLARATION» — «Таможенная декларация»; «UTD» — «Универсальный передаточный документ»; «DESTRUCTION_ACT» — «Акт уничтожения (утраты/утилизации)»; «OTHER» — «Другое».

Пример ответа на запрос:

Таблица 3.31. Описание параметров ответа на запрос

Параметр Вложенные поля Формат значения Описание
result Структура Ответ на создание заявки
id Integer ID заявки
userRequestId String Уникальный идентификатор запроса пользователя, передается из параметров запроса
status Структура Статус обработки запроса
code Integer Код ошибки
message String Сообщение с описание статуса/ошибки

3.5.2. Получить данные документа вывода из оборота для подписания

Данный метод позволяет получить данные документа для подписания.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

Таблица 3.32. Описание параметров ответа на запрос

Параметр Формат значения Описание
content string Идентификатор контента документа
id String Контент документа в формате base64

3.5.3. Отправить подписанный документ вывода из оборота в «Честный ЗНАК»

Метод позволяет отправить документ вывода из оборота в «Честный ЗНАК». Используется после получения контента из метода «Получение данных документа ввода в оборот для подписания» и их подписания. Для подписания контента требуется перевести данные параметра «content» из формата base64 и поместить в файл для подписания, после чего создать открепленную/отсоединенную однострочную (без знаков переноса) подпись. Затем закодировать полученную подпись в base64 и отправить ее в параметре «content» запроса «Отправка подписанного документа ввода в оборот в «Честный ЗНАК».

Для отправки документа используется запрос на основе метода POST. Запрос имеет следующий вид:

Таблица 3.33. Коды ответа на запрос

Статус кода HTTP Причина ответа
200 Запрос выполнен успешно
401 Ошибка аутентификации/авторизации

3.5.4. Получение списка заявок

Метод получения списка заявок позволяет получить все заявки с различными статусами, параметрами кодами маркировки

Заменяемый параметр по умолчанию заменяется на v1.

Таблица 3.34. Описание параметров запроса

Параметр Формат значения Описание
action String Причина вывода из оборот.
Параметр может принимать значение:
RETAIL — розничная реализация;
EEC_EXPORT — экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT — экспорт за пределы ЕАЭС;
RETURN — возврат от физ.лица;
REMOTE_SALE — продажа по образцам, дистанционный способ продажи;
DAMAGE_LOSS — утрата или повреждение;
DESTRUCTION — утилизация или уничтожение;
CONFISCATION — конфискация;
LIQUIDATION — ликвидация;
ENTERPRISE_USE — использование для собственных нужд предприятия;
STATE_SECRET — приобретение гос.предприятием;
OTHER — другая причина
creationTimeFromIncl String ​ Нижняя граница фильтра по времени создания заявки. Включая
creationTimeToExcl String Верхняя граница фильтра по времени создания заявки. Исключая
czDocumentId String ​ Идентификатор заявки в ЧЗ
documentDescription String Наименование заявки
documentStatus String ​ Статус заявки. Параметр может принимать значение:
CREATED — «Требуется подпись», документ ввода создан, требуется подписать документ для отправки его в «Честный ЗНАК»;
SENDING — «Отправляется»;
SENT_FOR_INTRODUCTION — «Отправлена в ЧЗ»;
INTRODUCTION_FAILED — «Ошибка вывода»;
SENDING_ERROR — «Успешно обработана»;
INTRODUCED — «Ошибка отправки заявки»;
UNKNOWN_INTRODUCTION_STATUS — «Ошибка».
id Integer ID заявки
markingCodeCount Integer ​ Количество КМ
pageIndex Integer Номер страницы
pageRecords Integer ​ Количество элементов в выдаче на странице
productGroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
milk — Молочная продукция,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски,
water — Питьевая вода,
beer — Пиво и пивные напитки,
antiseptic — Антисептики.
sortType String ​ Правило сортировки заявок может принимать значение:
BY_ORDER_ID_ASC — по ID заказа в порядке возрастания;
BY_ORDER_ID_DESC сортировка по ID заказа в порядке убывания;
BY_DOC_DESCR_ASC — по описанию документа в порядке возрастания;
BY_DOC_DESCR_DESC — описанию документа в порядке убывания;
BY_MC_CNT_ASC — по количеству кодов маркировки в порядке возрастания;
BY_MC_CNT_DESC по количеству кодов маркировки в порядке убывания;
BY_CREATION_TIME_ASC — по дате и времени создания в порядке возрастания;
BY_CREATION_TIME_DESC — по дате и времени создания в порядке убывания;
BY_STATUS_ASC — по статусу в порядке возрастания;
BY_STATUS_DESC — по статусу в порядке убывания

Пример ответа на запрос:

Таблица 3.35. Описание параметров ответа на запрос

Параметр Вложенные поля Вложенные поля Формат значения Описание
result Структура Контейнер ответа
data Array[Структура] Данные контейнера ответа
action String Причина вывода из оборот.
Параметр может принимать значение:
RETAIL — розничная реализация;
EEC_EXPORT — экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT — экспорт за пределы ЕАЭС;
RETURN — возврат от физ.лица;
REMOTE_SALE — продажа по образцам, дистанционный способ продажи;
DAMAGE_LOSS — утрата или повреждение;
DESTRUCTION — утилизация или уничтожение;
CONFISCATION — конфискация;
LIQUIDATION — ликвидация;
ENTERPRISE_USE — использование для собственных нужд предприятия;
STATE_SECRET — приобретение гос.предприятием;
OTHER — другая причина
creationTime String Дата создания
czDocumentId String Идентификатор заявки в ЧЗ
documentDescription String Наименование заявки
id Integer ID заявки
markingCodeCount Integer Количество КМ
productGroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
milk — Молочная продукция,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски,
water — Питьевая вода,
beer — Пиво и пивные напитки,
antiseptic — Антисептики.
status String Статус заявки. Параметр может принимать значение:
CREATED — «Требуется подпись», документ ввода создан, требуется подписать документ для отправки его в «Честный ЗНАК»;
SENDING — «Отправляется»;
SENT_FOR_INTRODUCTION — «Отправлена в ЧЗ»;
INTRODUCTION_FAILED — «Ошибка вывода»;
SENDING_ERROR — «Успешно обработана»;
INTRODUCED — «Ошибка отправки заявки»;
UNKNOWN_INTRODUCTION_STATUS — «Ошибка».
pageInfo Структура Информация о пагинации
pageCount Integer Всего страниц
pageIndex Integer Номер страницы выдачи
pageRecords Integer Количество записей на странице
recordsTotalCount Integer Всего записей в полученной выборке на всех страницах
sortDirection String Направление сортировки
sortKey Boolean
status Структура Статус обработки запроса
code Integer Код ошибки
message String Сообщение с описанием статуса/ошибки

3.5.5. Получение карточки

Заменяемый параметр по умолчанию заменяется на v1.

Для получения карточки обязательной в запросе должен присутствовать параметр orderId

Пример ответа на запрос:

Таблица 3.36. Описание параметров ответа на запрос

Параметр Вложенные поля Формат значения Описание
result Структура Ответ на создание заявки
action String Причина вывода из оборота.
Параметр может принимать значения:
RETAIL — розничная реализация;
EEC_EXPORT — экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT — экспорт за пределы ЕАЭС;
RETURN — возврат от физ.лица;
REMOTE_SALE — продажа по образцам, дистанционный способ продажи;
DAMAGE_LOSS — утрата или повреждение;
DESTRUCTION — утилизация или уничтожение;
CONFISCATION — конфискация;
LIQUIDATION — ликвидация;
ENTERPRISE_USE — использование для собственных нужд предприятия;
STATE_SECRET — приобретение гос.предприятием;
OTHER — другая причина
actionDate String Дата вывода из оборота
creationTime String Дата и время заведения заявки
czDocObtainedTime String Дата и время отправки заявки в Честный знак
destinationCountryCode String Код страны назначения.
Параметр принимает значения:
112 — Республика Беларусь;
417 — Киргизская Республика;
398 — Республика Казахстан;
051 — Республика Армения
documentDate String Дата первичного документа
documentDescription String Наименование заявки
documentNumber String Номер первичного документа
documentType String Тип первичного документа:
RECEIPT — Кассовый чек;
SALES_RECEIPT — Товарный чек;
CONSIGNMENT_NOTE — товарная накладная;
CUSTOMS_DECLARATION — Таможенная декларация;
UTD — Универсальный передаточный документ;
DESTRUCTION_ACT — Акт уничтожения;
STATE_SECRET — Продажа по сделке, составляющей гос.тайну ;
OTHER — Другое ​
errorDetail String Ошибка обработки документа в Честном знаке виде JSON
id Integer ID заявки
inn String ИНН организации
kktNumber String Регистрационный номер контрольно-кассовой техники.
modificationTime String Дата и время последнего обновления статуса
primaryDocumentCustomName String Наименование первичного документа
productGroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
milk — Молочная продукция,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски,
water — Питьевая вода,
beer — Пиво и пивные напитки,
antiseptic — Антисептики.
stateContractId String Идентификатор государственного контракта
status String Статус заявки. Параметр может принимать значение:
CREATED — «Требуется подпись», документ ввода создан, требуется подписать документ для отправки его в «Честный ЗНАК»;
SENDING — «Отправляется»;
SENT_FOR_INTRODUCTION — «Отправлена в ЧЗ»;
INTRODUCTION_FAILED — «Ошибка вывода»;
SENDING_ERROR — «Успешно обработана»;
INTRODUCED — «Ошибка отправки заявки»;
UNKNOWN_INTRODUCTION_STATUS — «Ошибка».
userRequestId String Уникальный идентификатор запроса пользователя, задается пользователем.
withdrawalTypeOther String Другая причина
status Структура Статус обработки запроса
code Integer Код ошибки
message String Сообщение: описание статуса/ошибки

3.5.6. Получение списка кодов маркировки из заявки

Заменяемый параметр по умолчанию заменяется на v1.

Таблица 3.37. Описание параметров запроса

Параметр Формат значения Описание
cis String ​ Код идентификации (код маркировки)
documentDateFromIncl String ​ Нижняя граница даты первичного документ. Включая
documentDateToExcl String ​ Верхняя граница даты первичного документ. Исключая
documentNumber String ​ Номер первичного документа
documentType String ​ Тип первичного документа:
RECEIPT — Кассовый чек;
SALES_RECEIPT — Товарный чек;
CONSIGNMENT_NOTE — товарная накладная;
CUSTOMS_DECLARATION — Таможенная декларация;
UTD — Универсальный передаточный документ;
DESTRUCTION_ACT — Акт уничтожения;
STATE_SECRET — Продажа по сделке, составляющей гос.тайну;
OTHER — Другое
id Integer ​ ID заявки
pageIndex Integer ​ Номер страницы
pageRecords Integer ​ Количество элементов в выдаче на странице

Пример ответа на запрос:

Таблица 3.38. Описание параметров ответа на запрос

Параметр Вложенные поля Вложенные поля Формат значения Описание
result Структура Контейнер ответа ​
data Array[Структура] Данные контейнера ​
cis String Код идентификации (код маркировки) ​
primary_document_custom_name String Наименование первичного документа ​
primary_document_date Date Дата первичного документа ​
primary_document_number String Номер первичного документа ​
primary_document_type String Тип первичного документа:
RECEIPT — Кассовый чек;
SALES_RECEIPT — Товарный чек;
CONSIGNMENT_NOTE — товарная накладная;
CUSTOMS_DECLARATION — Таможенная декларация;
UTD — Универсальный передаточный документ;
DESTRUCTION_ACT — Акт уничтожения;
STATE_SECRET — Продажа по сделке, составляющей гос.тайну ;
OTHER — Другое ​
product_cost String Цена за единицу (руб.)​
pageInfo Структура Информация о пагинации
pageCount Integer Всего страниц
pageIndex Integer Номер страницы выдачи
pageRecords Integer Количество записей на странице
recordsTotalCount Integer Всего записей в полученной выборке на всех страницах
sortDirection String Направление сортировки
sortKey Boolean
status Структура Статус обработки запроса
code Integer Код ошибки
message String Сообщение с описание статуса/ошибки

3.6. Перемаркировка

Создание документа доступно для товарных групп «Антисептики и дезинфицирующие средства», «Биологически активные добавки к пище», «Велосипеды и велосипедные рамы», «Духи и туалетная вода», «Медицинские изделия», «Обувные товары», «Предметы одежды, бельё постельное, столовое, туалетное и кухонное», «Товары из натурального меха», «Упакованная вода», «Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки», «Шины и покрышки пневматические резиновые новые».

Краткое описание причин перемаркировки

Условия перемаркировки КИН:

Перемаркировка КИН или КИ в составе КИН недоступна при следующих условиях (документ будет обработан с ошибкой):

После обработки документа все вложения из предыдущего КИН переходят в новый КИН, при этом предыдущий КИН переходит в статус «Выбыл» (RETIRED), а новый КИН переходит в статус «В обороте» (INTRODUCED). Если статус предыдущего КИН «Выбыл» (RETIRED), то все вложения переходят в новый КИН и вводятся в оборот вместе с КИН.

При перемаркировке КИ в статусе «В обороте» (INTRODUCED) в составе КИН со статусом «В обороте» (INTRODUCED), КИН не расформировывается, предыдущий КИ списывается, исключается из КИН и в состав КИН включается новый КИ, при этом GTIN нового и предыдущего КИ должны совпадать.

При перемаркировке КИ в статусе «Выведен из оборота» (RETIRED) в составе КИН со статусом «Выведен из оборота» (RETIRED), КИН расформировывается (DISAGGREGATION), предыдущий КИ списывается (WRITTEN_OFF), а новый КИ вводится в оборот (INTRODUCED). В результате успешной обработки документа, в котором агентом / комиссионером были указаны предыдущий и новый КИ / КиЗ, полученные на один код товара, новый КИ / КиЗ получит те же самые характеристики, что и предыдущий КИ / КиЗ, а именно о том, что КИ / КиЗ был передан по АКС с указанием того собственника, который передал агенту / комиссионеру этот КИ / КиЗ.

Порядок действий при перемаркировке:

3.6.1 Создать документ перемаркировки

Данный метод позволяет создать документ «Перемаркировки». В случае успешной отправки возвращается идентификатор документа (id).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

Заменяемый параметр — обозначение версии системы, по умолчанию равен v1. Описание параметров запроса на создание заказа приведены в таблице 3.39.

Таблица 3.39. Параметры запроса на создание заказа

Параметр Вложенные поля Вложенные поля Формат значения Описание Обязательно в запросе
comment String Пользовательский комментарий Нет
documentDescription String Наименование заявки Нет
userRequestId String Уникальный идентификатор запроса пользователя, задается пользователем (должно быть уникальным) Да
productGroup String Товарная группа: Да
lp — Легкая промышленность (одежда);
shoes — Обувь;
perfumery — Духи и туалетная вода;
tires — Шины;
electronics — Фототехника;
bicycle — Велосипеды;
wheelchairs — Кресла-коляски.
payload Object Документ для передачи в единый метод создания документов ЦРПТ Да
participant_inn String ИНН участника оборота товара Да
remarking_cause String Причина перемаркировки.Параметр может принимать следующие значения:
KM_SPOILED — испорчено либо утеряно СИ с КМ;
DESCRIPTION_ERRORS — выявлены ошибки описания товара;
RETAIL_RETURN — возврат товаров с повреждённым СИ/без СИ при розничной реализации (возврат от розничного покупателя);
REMOTE_SALE_RETURN — возврат товаров с повреждённым СИ/без СИ при дистанционном способе продажи (возврат в случае дистанционной продажи);
LEGAL_RETURN — возврат от конечного покупателя (юр. лица/ИП);
INTERNAL_RETURN — решение о реализации товаров, приобретённых в целях, не связанных с их реализацией;
EEC_EXPORT_RETURN — возврат ранее экспортированного в ЕАЭС.		 Да
remarking_date String Дата перемаркировки. имеет вид «YYYY-MM-DD». Пример «2022-12-30» Да
products Array Массив перемаркируемых КИ / КиЗ. Да
Object
last_uin String Предыдущий КИ / КиЗ
Допустимые типы упаковок:

UNIT — «Единица товара»;

Параметр обязателен, если «remarking_cause» («Код причины перемаркировки») = DESCRIPTION_ERRORS («Выявлены ошибки описания товара»).
Для КИН параметр обязателен, если «remarking_cause» («Код причины перемаркировки») принимает любое из следующих значений:

KM_SPOILED — испорчено либо утеряно СИ с КМ;

DESCRIPTION_ERRORS — выявлены ошибки описания товара;

RETAIL_RETURN — возврат товаров с повреждённым СИ/без СИ при розничной реализации (возврат от розничного покупателя);

REMOTE_SALE_RETURN — возврат товаров с повреждённым СИ/без СИ при дистанционном способе продажи (возврат в случае дистанционной продажи);

LEGAL_RETURN — возврат товара от конечного покупателя ЮЛ/ИП;

INTERNAL_RETURN — решение о реализации приобретённого ранее товара без цели дальнейшей реализации;

EEC_EXPORT_RETURN — экспорт в страны ЕАЭС.

В случае успешной отправки возвращается идентификатор документа (id).
Пример успешного ответа на запрос:

3.6.2 Получить данные документа перемаркировки для подписания

Данный метод позволяет получить данные документа для подписания.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

Таблица 3.40. Описание параметров ответа на запрос

Параметр Формат значения Описание
content string Идентификатор контента документа
id String Контент документа в формате base64

3.6.3 Отправить подписанный документ перемаркировки в «Честный ЗНАК»

Метод позволяет отправить документ перемаркировки в «Честный ЗНАК». Используется после получения контента из метода «Получение данных документа перемаркировки для подписания» и их подписания. Для подписания контента требуется перевести данные параметра «content» из формата base64 и поместить в файл для подписания, после чего создать открепленную/отсоединенную однострочную (без знаков переноса) подпись. Затем закодировать полученную подпись в base64 и отправить ее в параметре «content» запроса «Отправка подписанного документа ввода в оборот в «Честный ЗНАК».

Для отправки документа используется запрос на основе метода POST. Запрос имеет следующий вид:

Таблица 3.41. Коды ответа на запрос

Статус кода HTTP Причина ответа
200 Запрос выполнен успешно
401 Ошибка аутентификации/авторизации

3.6.4 Получить статус документа перемаркировки

Данный метод позволяет получить статус документа перемаркировки.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

Таблица 3.42. Описание параметров ответа на запрос создание заказа

Параметр Формат значения Описание
codesIntroductionType string Тип документа на ввод в оборот LK_REMARK
comment String Комментарий к документу
documentId String Уникальный идентификатор документа в ГИС МТ.
documentNumber String Уникальный идентификатор запроса пользователя, задается пользователем
documentStatus string Статус документа:
Created — «Требуется подпись», документ ввода создан, требуется подписать документ для отправки его в Честный ЗНАК»;
Sending — «Отправляется»
SentForIntroduction — «Отправлен в ЧЗ»
IntroductionFailed — «Ошибка ввода»
SendingError — «Ошибка отправки документа»
Introduced — «Введено в оборот».
errors string Ошибки документа по вводу в оборот КМ
productgroup String Товарная группа:
lp — Легкая промышленность (одежда),
shoes — Обувь,
perfumery — Духи и туалетная вода,
tires — Шины,
electronics — Фототехника,
bicycle — Велосипеды,
wheelchairs — Кресла-коляски.

4. Порядок тестирования

4.1. Описание

Раздел описывает способ тестирования услуги «ЭДО.Поток». Для тестирования используется демонстрационный личный кабинет клиента (ЛКК), подключенный к тестовой информационной системе «ЭДО.Поток».

4.2. Вход в демо ЛКК

Чтобы войти в личный кабинет клиента (демо), выполнить следующие действия:

Нажимаем кнопку «Войти»;

Теперь вы можете проверить работоспособность функционала ИС «ЭДО.Поток»

История изменений

Версия 2.0
Выпущена 11 января 2019 г.
Первая регистрируемая версия документа.

Версия 2.1
Выпущена 10 апреля 2019 г.
Исправлены ошибки в тексте и в ответах получаемые при выполнении запросов.

Версия 2.2
Выпущена 24 апреля 2020 г.
Изменен адрес сервера, на который необходимо отправлять API -запросы.

Версия 2.3
Выпущена 11 сентября 2020 г.
Исправлена ошибка в методе авторизации в ИС «ЭДО.Поток».

Версия 2.4
Выпущена 25 сентября 2020 г.

Версия 2.5
Выпущена 09 октября 2020 г.

Версия 2.6
Выпущена 12 октября 2020 г.

Версия 2.7
Выпущена 15 октября 2020 г.
Убран блок информации 3.2. Запросы, связанные с клиентами.

Версия 2.8
Выпущена 18 ноября 2020 г.

Версия 2.9
Выпущена 23 декабря 2020 г.

Версия 3.0
Выпущена 03 марта 2021 г.
Добавлен раздел 4. Маркировка

Версия 3.1
Выпущена 04 марта 2021 г.

Версия 3.2
Выпущена 10 марта 2021 г.
Добавлен раздел 2 — Метод регистрации в ИС «ЭДО.Поток»

Версия 3.3
Выпущена 23 марта 2021 г.
Добавлены методы получение информации о товарных позициях заказа КМ, получение информации о параметрах заказа КМ

Версия 3.4
Выпущена 27 апреля 2021 г.
Добавлены разделы:

Версия 3.5
Выпущена 30 июня 2021 г.
Добавлены разделы:

Версия 3.6
Выпущена 16 сентября 2021 г.
Добавлены разделы:

Идентификатор ЭДО

С каждым годом участников электронного документооборота (ЭДО) становится все больше. Для корректной идентификации пользователям выдается уникальный персональный номер. Для чего конкретно он нужен? Как его получить и где посмотреть? Разберем подробнее в статье.

  • Что такое идентификатор
  • Зачем нужен идентификатор
  • Как получить идентификатор
  • Где посмотреть в Диадоке
  • Как узнать идентификатор ЭДО контрагента

Узнайте больше о возможностях ЭДО и начните обмен электронными документами в Диадоке

Что такое идентификатор

Число передаваемых через системы ЭДО документов исчисляется сотнями миллионов. Только клиенты Контур.Диадока отправили за 2020 год 237 млн документов. Пандемия увеличила интерес бизнеса к цифровым технологиям, а значит, в ближайшие годы все больше компаний будет переходить на цифру.

В связи с этим особенно важен вопрос идентификации. Ведь если система электронного документооборота не сможет точно определить, кто и кому отправляет документы, может возникнуть путаница. Это приведет как минимум к сбоям и трате времени пользователей, как максимум — к утере конфиденциальных данных, нарушению коммерческой тайны, ухудшению репутации, финансовым расходам.

В современных сервисах ЭДО этот вопрос решается с помощью идентификатора, или ID, участника ЭДО. Он представляет собой уникальный номер, который получает каждый пользователь системы. Присваивает его при регистрации оператор электронного документооборота, который отвечает за бесперебойную работу и безопасность передачи информации.

Среди особенностей идентификатора:

  • он имеет единообразную структуру у всех пользователей,
  • его нельзя выбирать — он выдается организации по ИНН-КПП,
  • на одну пару ИНН-КПП полагается один код,
  • если у компаний одинаковый ИНН и разный КПП, у каждой будет свой идентификатор участника ЭДО,
  • код представляет собой последовательность цифр и латинских букв разного регистра,
  • первые три символа — это идентификатор (ID) оператора ЭДО, услугами которого пользуется компания, а остальные — непосредственно код пользователя.

Таким образом, идентификационный номер участника электронного документооборота выглядит так: 2BM-9617641160-961701000-201808150446459104749. 2BM — ID поставщика ЭДО, в данном случае — СКБ Контур. Остальные символы (их может быть не более 43) идентифицируют пользователя.

Пример идентификатора ЭДО

Зачем нужен идентификатор

Как уже было сказано выше, уникальные номера участников электронного документооборота позволяют идентифицировать пользователей. С помощью этого цифрового «адреса» операторы и контрагенты всегда могут найти нужную компанию.

Регистрация у оператора ЭДО и получение идентификационного кода необходимы для обмена счетами-фактурами и другими формализованными документами. Идентификатор отправителя и получателя указывается в соответствующих полях xml-файлов:

  • счета-фактуры,
  • накладной,
  • акта приемки-сдачи работ или услуг и любых документов, чей формат утвержден ФНС.

Это требование указано, например, в приказах ФНС России от 19.12.2018 № ММВ-7-15/820@, 30.11.2015 № ММВ-7-10/551@, 30.11.2015 № ММВ-7-10/552@. Благодаря неповторяющимся кодам пользователей налоговая служба, а также провайдеры электронного документооборота определяют конкретную компанию в своих системах. Это позволяет избежать сбоев и ошибок, неверной адресации документов и других сложностей.

Кроме того, идентификатор нужен при настройке роуминга, который позволяет клиентам разных операторов ЭДО наладить обмен юридически значимой документацией друг с другом. Персональный номер контрагента в процессе подключения роуминга — например между системами Диадок и СБИС — потребуется вашему провайдеру для быстрого и корректного налаживания связи.

После настройки роуминга можно вести электронный документооборот с любой компанией. При этом все ключевые возможности электронного документооборота в Диадоке останутся доступны:

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

Стоимость услуг в роуминге тоже не отличается от обмена документами внутри сети.

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

С некоторыми операторами роуминг настраивается автоматически, и список этих провайдеров увеличивается. Узнать о наличии автороуминга можно в разделе поиска контрагентов: у нужной компании с пометкой «Роуминг» будет кнопка «Отправить приглашение». В этом случае заявка не нужна — достаточно отправить обычное приглашение контрагенту. Если его направит контрагент, заявка появится в разделе «Приглашают вас».

Ответим на все вопросы об ЭДО и поможем с подключением

Как получить идентификатор

Перед запуском электронного документооборота каждый пользователь ЭДО должен уведомить ФНС России о начале такого делопроизводства. Для этого заполняется заявление участника ЭДО. После чего формализованные документы, то есть отправляемые и получаемые счета-фактуры, накладные, акты будут иметь юридическую силу и приниматься к учету.

Заявление содержит данные:

  • наименование организации или Ф. И. О. индивидуального предпринимателя,
  • адрес нахождения организации или место жительства ИП,
  • ИНН/КПП,
  • контактные данные,
  • сведения о владельцах и реквизиты сертификатов ключа подписи,
  • данные о налоговом органе, к которому относится компания или ИП.

Пользователи Диадока могут получать код почти незаметно. Заявление в ФНС создается автоматически в тот момент, когда организация впервые отправляет или подписывает формализованный документ. Пользователь проверяет реквизиты и подтверждает подачу заявления, а оператор в течение трех дней формирует специальное информационное сообщение. В нем как раз указываются реквизиты компании и ID участника ЭДО.

Идентификатор вместе с заявлением и реквизитами компании подается в налоговый орган по месту учета компании. Этот процесс регламентируется приказом ФНС России от 12.09.2012 № ММВ-7-6/619@. Так налоговая узнает о наличии у организации электронных документов, которые можно истребовать в цифровом виде, и через какого оператора осуществляется их передача и получение. После этого пользователь может беспрепятственно начать полноценный обмен документами с контрагентами.

Заполнить и отправить заявление участника ЭДО можно самостоятельно при настройке реквизитов или личного кабинета в Диадоке перед началом работы. Для этого нужно открыть меню рядом с наименованием пользователя — «Настройки» — и перейти в «Реквизиты организации». Если заявление уже отправлялось ранее, оно отобразится по ссылке «История заявлений».

Если отправка происходит впервые, проверьте корректность заполненных полей — ОГРН, ИФНС (МРИ), юридический адрес. Если все верно, нажмите «Отправить». Также заявление можно обновить, если вы вошли в сервис с сертификатом, данные о котором не включались в заявление.

В случае изменений в реквизитах — смене наименования, ИНН или КПП — обратитесь в техническую поддержку Диадока, напишите в чат, закажите звонок или выберите другой удобный способ в «Центре поддержки». Это важно, поскольку на основе корректировок будет составлено и отправлено новое заявление в ФНС. В Диадоке для этого не нужно ничего настраивать — все происходит автоматически.

Отметим, что, согласно приказу Минфина РФ от 05.02.2021 № 14Н, участники электронного документооборота в своих заявлениях также должны выражать согласие либо несогласие на предоставление сведений другому оператору ЭДО для обмена документами с контрагентами из роуминга. В Диадоке все пользователи по умолчанию считаются согласными на передачу сведений. Однако это можно изменить: если вы не согласны на предоставление данных другому провайдеру, обратитесь в техподдержку сервиса.

Где посмотреть в Диадоке

В ситуации, когда необходимо узнать свой идентификатор участника электронного документооборота в системе ЭДО Контур.Диадок, нужно выполнить всего несколько действий.

  • Сперва войдите в Диадок для авторизации. Для входа потребуется электронная подпись или логин с паролем.
  • Затем откройте меню «Настройки» в верхнем правом углу экрана. В поле «Идентификатор участника ЭДО (GUID)» будет указан нужный вам ID.

Здесь его можно не только посмотреть, но и скопировать, чтобы передать по назначению. Также найти идентификатор можно по адресу «Настройки» — «Реквизиты организации».

Как узнать идентификатор ЭДО контрагента

Идентификационный код контрагента потребуется для подключения роуминга. Узнавать его можно несколькими способами. Например, можно спросить у самого партнера или клиента. Он найдет свой ID в настройках используемой системы электронного документооборота или в реквизитах организации.

Самостоятельно узнать идентификатор ЭДО контрагента можно так:

  • Авторизуйтесь на портале Диадока с помощью действующего сертификата электронной подписи.
  • В левом меню выберите раздел «Контрагенты», а затем — «Поиск и приглашение».
  • Укажите в появившейся строке поиска ИНН нужной компании и запустите поиск.
  • Нажмите на название организации и откройте ее персональную карточку.

Сразу после наименования компании и уточнения, работает ли она в Диадоке, будет расположена строка с указанием ИНН, КПП и ID. Для того чтобы просмотреть и скопировать код, достаточно нажать на активную ссылку.

Кроме того, по трем первым символам идентификатора легко определить, каким провайдером электронного документооборота пользуется ваш контрагент, например это может быть Такском или Контур.Диадок.

Для того чтобы определить провайдера, следует зайти на сайт Федеральной налоговой службы России. Там размещен список доверенных операторов юридически значимого электронного документооборота, а также сведения о них. Указаны и идентификаторы, которые ФНС присваивает каждому доверенному провайдеру в соответствии с «Положением о Реестре доверенных операторов юридически значимого электронного документооборота», утвержденного приказом ФНС России от 23.10.2020 № ЕД-7-26/775@. Оператор получает идентификатор только после прохождения всех аккредитаций и присвоения официального статуса в ФНС. Если вам известен уникальный код участника ЭДО, по трем первым цифрам вы определите и оператора.

В Диадоке вы легко получите идентификационный код и сможете пользоваться всеми возможностями электронного документооборота. ЭДО в Диадоке — безопасный, быстрый, удобный способ обмениваться электронными документами. Эксперты сервиса помогут с подключением и ответят на все интересующие вопросы.

Обеспечим юридически значимый документооборот с контрагентами в режиме онлайн

Читать:
Что такое валидные картинки

Похожие статьи

Я слышу себя когда говорю в микрофон как...

Юбисофт коннект что это

Яндекс диск пишет что нет места хотя место...

Что такое число армстронга

Что такое юстировка картриджей hp

Что является литералом строкового значения

Что такое хост контроллер

Что такое сопряженное пространство

Что такое программа сервер ответ

Что такое пустая строка