Перейти к основному содержимому

Роуминг

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

Роуминг — технология, по которой контрагенты разных операторов ЭДО передают друг другу юридически значимые электронные документы. Технологию роуминга устанавливает ФНС. Общее описание приведено на странице Роуминг.

к сведению

Подробнее про роуминг — на сайте Логистики.

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

Для отправки документа в роуминг API Диадока не предусматривает отдельного метода: отправка контрагенту другого оператора осуществляется по обычному сценарию. После отправки документа в ящик роумингового контрагента Диадок передаст его оператору получателя.

Чтобы отправлять документы в роуминг:

  1. Подготовьте ящик роумингового контрагента.
  2. Проверьте, нужна ли настройка роуминговой пары.
  3. Получите параметры титула, который собираетесь отправить.
  4. Проверьте возможность отправки.
  5. Отправьте титул.
  6. Отследите доставку.

Подготовка ящика роумингового контрагента

Если отправить документ контрагенту, с которым раньше не было обмена, Диадок вернет ошибку «Ящик участника не найден».

Чтобы в Диадоке появился контрагент, создайте для него представление — ящик:

  1. Найдите контрагента с помощью метода SearchFnsParticipants. В параметре myBoxId укажите ящик вашей организации, в теле запроса — ИНН и КПП контрагента. Сохраните идентификатор участника ЭДО FnsParticipantId из списка Participants в ответе метода.
  2. Получите ящик контрагента в Диадоке с помощью метода GetOrCreateRoamingOrganizationByFnsParticipantId. В параметре myBoxId укажите ящик вашей организации, в теле запроса — сохраненный ранее идентификатор FnsParticipantId. Сохраните идентификатор ящика BoxId из списка Boxes в ответе: он понадобится, чтобы отправить документы.

Если идентификатор ящика BoxId контрагента уже известен — из метода GetCounteragents (V3) или из прошлого обмена, — шаг можно пропустить.

Проверка необходимости настройки роуминговой пары

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

Чтобы узнать, требуется ли отправка приглашения для обмена документами, проверьте свойство Sociability у получателя: метод GetOrganization возвращает его в структуре Organization.

Если Sociability = AllOrganizations, получатель принимает документы от всех контрагентов, кроме заблокированных. Переходите к разделу Получение параметров титула.

Если Sociability = CounteragentsOnly, получатель принимает документы только от своих контрагентов. Для сообщений, в которых есть только перевозочные документы, действует исключение: если оператор получателя поддерживает обмен перевозочными документами без приглашений, документы можно отправлять по общим правилам и настраивать пару не нужно.

Если Sociability = CounteragentsOnly и выполняется хотя бы одно из условий ниже, настройте роуминговую пару — в разделе Настройка роуминговой пары:

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

Диадок получает значения полей Sociability, Comment и ReadyForEpdStatus структуры Organization у роуминговых организаций из базы ФНС и обновляет их раз в сутки. Подробнее — на странице Работа с организациями.

Настройка роуминговой пары

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

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

Перед настройкой пары проверьте, поддерживает ли оператор контрагента автороуминг. Вызовите метод GetRoamingOperators и найдите оператора контрагента в ответе: поле FnsId содержит первые три символа идентификатора FnsParticipantId. Автороуминг доступен, если в списке Features этого оператора указана функция SupportsAutoInvitation.

Автороуминг

Подробнее про автороуминг — в разделе Автороуминг.

Если в списке Features оператора контрагента указана функция SupportsAutoInvitation, настройте автороуминг:

  1. Отправьте приглашение к партнерству с помощью метода AcquireCounteragent (V3):
    • передайте ящик вашей организации в параметре myBoxId;
    • передайте ящик контрагента в поле BoxId.
  2. Получите в ответе идентификатор операции taskId и проверьте результат приглашения с помощью метода AcquireCounteragentResult (V3).
  3. Дождитесь, пока контрагент примет приглашение. После принятия приглашения Диадок создаст роуминговую пару.
  4. Проверьте с помощью метода GetCounteragents (V3) статус контрагента: он должен поменяться на IsMyCounteragent.

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

Роуминг через заявку

Если функция SupportsAutoInvitation не указана, оператор контрагента не найден или автороуминг завершился ошибкой, настройте роуминг через заявку:

  1. Одна из организаций подает заявку на настройку роуминга своему оператору. Заявку подает только одна сторона: если контрагент уже подал заявку, повторно отправлять ее не нужно.
  2. Дождитесь, пока оператор обработает заявку и подтвердит настройку. Обычно настройка занимает два рабочих дня, но может занять до 8 рабочих дней: процесс двусторонний и зависит от оператора контрагента.
  3. Отправьте контрагенту приглашение с помощью метода AcquireCounteragent (V3), если это нужно для установления партнерских отношений. Проверьте результат операции и дождитесь принятия приглашения.
  4. Проверьте с помощью метода GetCounteragents (V3) статус контрагента: он должен поменяться на IsMyCounteragent.

Отправка титула

Получение параметров титула

Вызовите метод GetDocumentTypes (V3) для своего ящика. Для каждого титула, который планируете отправить контрагенту, получите из ответа метода следующие параметры:

  • DocumentTypes[].Name — идентификатор типа, в запросе отправки это TypeNamedId;
  • DocumentTypes[].Functions[].Name — имя функции, в запросе отправки это Function;
  • DocumentTypes[].Functions[].Versions[].Version — версия, в запросе отправки это Version;
  • DocumentTypes[].SupportedDocflows — виды документооборота, которые поддерживает тип документа: 0 — внешний, 1 — внутренний.

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

Перед тем как отправить титул в новом сообщении, вызовите метод CanPostMessage. Передайте в запрос метода идентификаторы ящиков участников и параметры титула без содержимого документа и подписи.

Если метод вернул ошибки, не отправляйте титул. Исправьте параметры или проверьте, настроена ли роуминговая пара.

Предупреждения изучите отдельно: они не блокируют отправку. Предупреждение о готовности получателя к обмену перевозочными документами появляется в двух случаях. Поле ReadyForEpdStatus структуры Organization принимает значение:

  • UndefinedEpdStatus или UnknownEpdStatus — готовность не определена;
  • NotReady — получатель не готов к обмену перевозочными документами.

Уточните готовность у контрагента и обрабатывайте фактический ответ метода отправки.

CanPostMessage проверяет параметры нового сообщения перед методом PostMessage (V3). Он не заменяет проверки метода PostMessagePatch (V4) и не подтверждает будущую доставку.

Отправка титула

Отправьте титул с помощью метода PostMessage (V3) или PostMessagePatch (V4). Способы отправки для титулов электронных перевозочных документов описаны на странице Перевозочные документы. Метод нужно выбрать по сценарию конкретного титула.

Доставка в роуминг

Ответ метода PostMessage (V3) или PostMessagePatch (V4) подтверждает, что Диадок принял запрос, но не подтверждает доставку оператору получателя.

Чтобы проверить, доставлен ли титул до получателя, проверьте поле RoamingNotification в состоянии титула — оно хранится в DocflowV5.Titles[].ParticipantDocflows[].TitleDelivery.RoamingNotification.

Значение IsSuccess = true означает, что титул доставлен в роуминг.

Если доставка завершилась ошибкой, получите ее детали из поля Notification структуры RoamingNotification. Отследить ошибки роуминга можно в ленте событий. Для электронной транспортной накладной (ЭТрН) и заказа-заявки (ЭЗЗ) доступны подробные описания ошибок — в разделах «Ошибки из роуминга» на страницах ленты событий ЭТрН и ленты событий ЭЗЗ. В краткой информации о документе используйте поля RoamingNotificationStatus и RoamingNotificationStatusDescription структуры Document.

Статусы роуминга не заменяют статусы ГИС ЭПД.

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года