Описание программного интерфейса модуля интеграции ЭДиН

Общая процедура запуска выполнения функций обмена электронными документами и сообщениями

EDiN_ОбменДокументами()

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

  1. Обработка входящих электронных документов

1.1. Получение электронных документов от отправителей и сохранение в определенной структуре папок в файловой системе.

1.2. Создание на основании полученных электронных документов объектов учетной системы (документы, справочник "Регистрационно-контрольная карточка электронного документа"), назначение начального статуса для созданного объекта. Опционально выполняется формирование исходящих электронных сообщений отправителям электронных документов с изменением статусов объектов учетной системы.

1.3. Формирование ответов на входящие электронные документы в виде исходящих электронных сообщений с изменением статусов объектов учетной системы.

  1. Обработка входящих электронных сообщений

2.1. Получение электронных сообщений от отправителей или провайдера и сохранение в определенной структуре папок в файловой системе.

2.2. Регистрация электронных сообщений в учетной системе с изменением статусов объектов учетной системы.

  1. Обработка исходящих электронных документов

3.1. Формирование исходящих электронных документов на основании объектов учетной системы (документы, справочник "Регистрационно-контрольная карточка электронного документа") и отправка получателям.

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

Процедура формирования на основании объектов учетной системы и отправки получателям исходящих электронных документов

ВыгрузитьСписокОтправляемыхДокументов(СтрокаДереваДокументов, Отменить = Ложь, СтруктураПараметров = Неопределено, эТН = Ложь)

Описание:

В зависимости от переданных параметров процедура формирует и отправляет получателям список исходящих электронных документов или отменяет ранее отправленные. Перед вызовом процедуры в созданном программном объекте внешней обработки "Docu1C" должна быть заполнена табличная часть "ОтправленныеДокументы". Обязательные для заполнения реквизиты табличной части: "Документ", "Тип", "Флажок". Пример вызова процедуры в назначаемых внешних обработках для конфигураций на БСП.

Параметры:

СтрокаДереваДокументов - строка дерева электронных документов, расположенная на ветви "Отправленные" (строка) .

Возможные значения : "Заказы поставщикам", "Ответы на заказы покупателей", "Уведомления об отгрузке (ТТН)", "Возврат товаров поставщику", "ЭТТН", "ЭТТН (перемещения)" , "ЭТТН (возвраты)", "Акты выполненных работ", "PDF".

Отменить - признак отправки отмены электронного документа (булево).

СтруктураПараметров - структура, элементы которой, определяют критерии выполнения процедуры.

Возможные имена и значения элементов : "ПодписьMobileID" (булево) - определяет использование мобильной ЭЦП, "ДокументID" - идентификатор документа (строка), используется для определения отменяемого электронного документа с типом "PDF", в случае, если из документа учетной системы таких было выгружены несколько. Список идентификаторов электронных документов, выгруженных из документа учетной системы может быть получен с  использованием функции ПолучитьСписокВыгруженныхPDF(ТипДокументаСервер, Документ).

Параметры: ТипДокументаСервер - "PDF", Документ - документ учетной системы.

эТН - признак отправки электронной товарной накладной (булево).

Процедура формирования на основании объектов учетной системы и отправки ответов на входящие электронные накладные (эТТН / эТН)

ОтправитьЭТТНОтвет(Корректировка = Ложь, СтруктураПараметровОтвета = Неопределено)

Описание:

Процедура формирует и отправляет ответы на входящие электронные накладные. В зависимости от переданных параметров может быть отправлено подтверждение электронной накладной или запрос на корректировку. Перед вызовом процедуры в созданном программно объекте внешней обработки "Docu1C" должна быть заполнена табличная часть "ВходящиеДокументы". Обязательные для заполнения реквизиты табличной части : "Документ", "Тип" ("BLRWBL") , "Флажок". Пример вызова процедуры в назначаемых внешних обработках для конфигураций на БСП.

Параметры:

Корректировка - признак отправки запроса на корректировку электронной накладной (булево).

СтруктураПараметров - структура, элементы которой, определяют критерии выполнения процедуры.

Возможные имена и значения элементов : "ПодписьMobileID" (булево) - определяет использование мобильной ЭЦП. 

Процедура формирования на основании объектов учетной системы и отправки ответов на прочие юридически значимые электронные накладные

СоздатьОтветыНаВходящиеДокументы(Отказ = Ложь, СтруктураПараметровОтвета = Неопределено)

Описание:

Процедура формирует и отправляет ответы на входящие юридически значимые электронные накладные. В зависимости от переданных параметров может быть отправлено подтверждение электронного документа, удостоверенное ЭЦП со стороны получателя или отказ от подписания. Перед вызовом процедуры в созданном программном объекте внешней обработки "Docu1C" должна быть заполнена табличная часть "ВходящиеДокументы". Обязательные для заполнения реквизиты табличной части : "Документ", "Тип" ("INVOICE , PDF") , "Флажок". Пример вызова процедуры в назначаемых внешних обработках для конфигураций на БСП.

Параметры:

Отказ - признак отправки отказа от подписания электронного документа (булево).

СтруктураПараметров - структура, элементы которой, определяют критерии выполнения процедуры. Возможные имена и значения элементов : "ПодписьMobileID" (булево) - определяет использование мобильной ЭЦП.

Оформление списков документов учетной системы

Примером одного из вариантов оформления списков документов учетной системы для отображения текущего состояния электронных документов, связанных с объектами учетной системы является транзитная конфигурация "ЭДиН".

Дополнительно, в программном интерфейсе модуля интеграции ЭДиН существуют функции получения индекса стандартных пиктограмм электронных накладных (эТТН / эТН) для массива переданных документов учетной системы.

ПолучитьТаблицуДанныхСообщенийОбменаЭТТН_Грузоотправитель(мДокументов) ПолучитьТаблицуДанныхСообщенийОбменаЭТТН_Грузополучатель(мДокументов)

Описание:

Функции возвращают таблицу значений с индексами стандартных пиктограмм электронных накладных в разрезе документов учетной системы.

Параметры:

мДокументов - массив ссылок на документы учетной системы.



ID статьи: 83
Последнее обновление: 23 ноя, 2023
Ревизия: 6
Интеграция, API -> Описание программного интерфейса модуля интеграции ЭДиН
https://base.edn.by/index.php?View=entry&EntryID=83