Types documents

diadoc · Mar 19, 2018 · 222db7e · 222db7e
2 parents 31cb2ea + c2a3385
commit 222db7e
Show file tree

Hide file tree

Showing 15 changed files with 113 additions and 31 deletions.
diff --git a/docs/source/Obrabotat'Sobytiye.rst b/docs/source/Obrabotat'Sobytiye.rst
@@ -14,7 +14,7 @@
 
 Опреляется, какую функцию вызвать в зависимости от имени события.
 
-Параметры:
+*Параметры:*
 
 * **ИмяСобытия** (тип Строка) - название события, которое требуется обработать.
 * **Параметры** (тип Структура) - структура, элементы которой будут использоваться в функции-обработчике конкретного события.
diff --git a/docs/source/Paket.rst b/docs/source/Paket.rst
@@ -4,13 +4,13 @@
 
 Пакет - структура, содержащая сведения о пакете документов. Создание пустой структуры происходит в функции основного модуля ЭДО_ПакетДокументовМенеджер_СоздатьНовый().
 
-**Элементы:**
+*Элементы:*
 
 * **Данные1С** (тип Структура) - структура Свойства1С, содержащая общие поля из 1С для всех документов пакета.
 *	**Документы** (тип Массив) - массив структур для хранения сведений о каждом документе пакета: описание контента, тип документа, ссылка на документ в 1С и т.п.
 * **ДополнительныеРеквизиты** (тип Структура) - структура дополнительных данных любого типа, которые могут быть использованы в событие ПодготовкиПакета и после. Допустимо использование не более 5 реквизитов.
 
-Структура **Свойства1С:**
+*Структура Свойства1С:*
 
 * **Организация** - ссылка на организацию в 1С, от лица которой сформирован пакет.
 * **Контрагент** - ссылка на контрагента в 1С, которому предназначен пакет.

diff --git a/docs/source/Podgotovit'ElektronnyyDokument.rst b/docs/source/Podgotovit'ElektronnyyDokument.rst
@@ -8,9 +8,9 @@
 
 **Описание:**
 
-Формирование контента требуемого типа для документа 1С.
+Заполнение контента всех документов, которые необходимо включить в пакет для отправки. Результатом должен быть заполненный XDTO-объект: **Результат.Content**. Структура зависит от типа контента.
 
-Параметры:
+*Параметры:*
 
 * **Результат** (тип Структура)- структура, содержащая ссылку на документ 1С и структуру контента.
 * **ВидДокументаРазвернутый** (тип Структура :doc:`ВидПакетаРазвернутый <VidPaketaRazvernutyy>`)- структура, содержащая определение вида пакета.
@@ -19,7 +19,9 @@
 Для сбора контента формализованных документов из типовой конфигурации 1С можно использовать функцию основной обработки ТиповойМодуль_ПолучитьКонтент.
 Параметрами выступают ссылка на документ в 1С, название требуемого формата контента и дополнительные параметры.
 
-Пример сбора данных для неформализованного документа:
+Для неформализованного документа описание контента происходит вручную.
+
+Пример сбора данных файла pdf, который формируется на основании кода внешней печатной формы 1С:
 
 ::
 

diff --git a/docs/source/Podgotovit'Paket.rst b/docs/source/Podgotovit'Paket.rst
@@ -12,7 +12,7 @@
 
 Для каждого добавляемого в пакет документа происходит вызов процедуры основного модуля ЭДО_ДокументМенеджер_ПодготовитьИДобавитьДокументВПакет, которая заполняет контент электронного документа.
 
-Параметры:
+*Параметры:*
 
 * **ВидПакетаРазвернутый** (тип Структура :doc:`ВидПакетаРазвернутый <VidPaketaRazvernutyy>`)- структура, содержащая определение вида пакета.
 * **СтрокаСписка** (тип Структура) - структура, соответствующая строке из интерфейса списка пакетов для отправки.

diff --git a/docs/source/Podgotovka_Paketa_Dlya_Otpravki.rst b/docs/source/Podgotovka_Paketa_Dlya_Otpravki.rst
@@ -2,9 +2,9 @@
 Как подготовить пакет документов для отправки
 =============================================
 
-Одним из основных объектом работы модуля является :doc:`Пакет <Paket>` документов. Состоять такой объект может из различных типов документов.
+Одним из основных объектов работы модуля является :doc:`Пакет <Paket>` документов. Состоять такой объект может из различных :doc:`типов документов <Tipy_Dokumentov>`.
 
-Аналогично веб-версии, максимальный размер сообщения – 30 документов.
+Аналогично веб-версии, одновременно нельзя отправить более 30 документов.
 
 Для формирования и отправки документов в одном пакете, следует выполнить следующие действия:
 
@@ -22,7 +22,7 @@
       ДобавитьСтрокуВТаблицуЗначений(ТЗ, "ID_УПД", "УПД", Истина);
       ДобавитьСтрокуВТаблицуЗначений(ТЗ, "ID_ОсновнойПакет", "СФ + ТОРГ12/Акт");
 
-**2.** Определить типы используемых документов в функции :doc:`ПолучитьТаблицуИспользуемыхВидовДокументов <Poluchit'TablitsuIspol'zuyemykhVidovDokumentov>`
+**2.** Определить :doc:`типы используемых документов <Tipy_Dokumentov>` в функции :doc:`ПолучитьТаблицуИспользуемыхВидовДокументов <Poluchit'TablitsuIspol'zuyemykhVidovDokumentov>`
 
 Пример определения типов документов: УПД (формализованный файл в формате ФНС) и Протокол согласования цен (неформализованный pdf файл):
 

diff --git a/docs/source/Poluchit'TablitsuIspol'zuyemykhPaketov.rst b/docs/source/Poluchit'TablitsuIspol'zuyemykhPaketov.rst
@@ -12,8 +12,10 @@
 
 **Описание:**
 
-Определяет список используемых исходящих видов пакетов. Состав колонок возвращаемой таблицы:
+Определяет список используемых исходящих видов пакетов, которые необходимо отправить за указанный период в рамках, сопоставленных с ящиками Диадок, организаций и контрагентов.
+
+*Состав колонок возвращаемой таблицы:*
 
 * **ID** (тип Строка) — внутренний идентификатор пакета. Наименование не должно содержать пробелы и другие служебные символы, кроме «_».
-* **Наименование** (тип Строка) — пользовательское представление пакета в списке «Пакеты на отправку».
+* **Наименование** (тип Строка, 150) — пользовательское представление пакета в списке «Пакеты на отправку».
 * **УПД** (тип Булево) — признак содержания в пакете документа типа «Универсальный передаточный документ» (UniversalTransferDocument).
diff --git a/docs/source/Poluchit'TablitsuIspol'zuyemykhVidovDokumentov.rst b/docs/source/Poluchit'TablitsuIspol'zuyemykhVidovDokumentov.rst
@@ -12,8 +12,10 @@
 
 **Описание:**
 
-Определяет список исходящих видов документов, которые включаются в пакет. Состав колонок возвращаемой таблицы:
+Определяет список исходящих видов документов, которые включаются в пакет.
+
+*Состав колонок возвращаемой таблицы:*
 
 * **ID** (тип Строка) — внутренний идентификатор типа документа. Наименование не должно содержать пробелы и другие служебные символы, кроме «_».
-* **Наименование** (тип Строка) — пользовательское представление типа документа в списке «Отправленные документы».
-* **ТипДокумента** (тип Строка) — название типа документа, соответствующего данной настройке.
+* **Наименование** (тип Строка, 150) — пользовательское представление типа документа в списке «Отправленные документы».
+* **ТипДокумента** (тип Строка) — название :doc:`типа документа <Tipy_Dokumentov>`, соответствующего данной настройке.
diff --git a/...ource/Poluchit'TekstZaprosaDlyaSpiskaPaketovNaOtpravkuPoMassivuVidovPaketov.rst b/...ource/Poluchit'TekstZaprosaDlyaSpiskaPaketovNaOtpravkuPoMassivuVidovPaketov.rst
@@ -12,13 +12,16 @@
 
 **Описание:**
 
-      Формируется текст запроса, в котором происходит определение списка основных документов 1С, без которых отправлять данный вид пакета не имеет смысла.
+Описывается текст запроса для выборки основных документов, характеризующих готовность пакетов к отправке.
 
-Параметры:
+*Параметры:*
 
-* **МассивВидовПакетов** (тип Массив) — массив видов пакетов.
+* **МассивВидовПакетов** (тип Массив) — массив внутренних идентификаторов, определенных в функции :doc:`ПолучитьТаблицуИспользуемыхПакетов <Poluchit'TablitsuIspol'zuyemykhPaketov>`.
 
-Обязательные поля запроса:
+В случае использования объектов 1С-ЭДО - массив строк.
+В случае использования подсистемы Диадок - массив ссылок на все элементы справочника Диадок_ДополнительныеСправочники с отбором по имени справочника "ВидыПакетов".
+
+*Обязательные поля запроса:*
 
 * **Документ** — ссылка на документ 1С, который является основным для формирования определяемого пакета.
 * **НомерДокумента** — номер документа 1С.

diff --git a/docs/source/PoslePodgotovkiPaketa.rst b/docs/source/PoslePodgotovkiPaketa.rst
@@ -10,6 +10,6 @@
 
 В процедуре можно изменить любые свойства подготовленного пакета до его отправки. Например, переопределить отправителя, получателя, подразделение, заблокированность, тестовость и т.д.
 
-Параметры:
+*Параметры:*
 
 * **Пакет** (тип Структура :doc:`Пакет <Paket>`) - структура, которая содержит основные сведения о подготовленном пакете и его составе.
diff --git a/docs/source/Support_Objects.rst b/docs/source/Support_Objects.rst
@@ -6,3 +6,4 @@
   :maxdepth: 1
 
   ВидПакетаРазвернутый <VidPaketaRazvernutyy>
+  Типы документов <Tipy_Dokumentov>
diff --git a/docs/source/Tipy_Dokumentov.rst b/docs/source/Tipy_Dokumentov.rst
@@ -0,0 +1,65 @@
+
+Типы документов
+===============
+
+Поддерживаются следующие типы документов:
+
+* **XmlTorg12** - товарная накладная ТОРГ-12 в XML-формате
+* **XmlAcceptanceCertificate** - акт о выполнении работ / оказании услуг в XML-формате
+* **Invoice** - счет-фактура
+* **InvoiceRevision** - исправление счета-фактуры
+* **InvoiceCorrection** - корректировочный счет-фактура
+* **InvoiceCorrectionRevision** - исправление корректировочного счета-фактуры
+* **UniversalTransferDocument** - универсальный передаточный документ
+* **UniversalTransferDocumentRevision** - универсальный передаточный документ (исправление)
+* **UtdInvoice** - счет-фактура в формате УПД
+* **UtdInvoiceRevision** - исправление счета-фактура в формате УПД
+* **UtdAcceptanceCertificate** - акт о выполнении работ / оказании услуг в формате УПД
+* **UtdTorg12** - товарная накладная ТОРГ-12 в формате УПД
+* **UniversalCorrectionDocument** - универсальный корректировочный документ
+* **UcdInvoiceCorrection** - корректировочный счет-фактура в формате УКД
+* **XmlAcceptanceCertificate552** - акт о выполнении работ / оказании услуг в формате 552
+* **TovTorg** - товарная накладная ТОРГ-12 в формате 551
+* **ProformaInvoice** - счет на оплату
+* **Nonformalized** - неформализованный документ
+* **NonformalizedProforma** - неформализованный счет на оплату
+* **TrustConnectionRequest** - запрос на инициацию канала обмена документами через Диадок
+* **Torg12** - товарная накладная ТОРГ-12
+* **AcceptanceCertificate** - акт о выполении работ / оказании услуг (неформализованный)
+* **PriceList** - ценовой лист
+* **PriceListAgreement** - протокол согласования цены
+* **CertificateRegistry** - реестр сертификатов
+* **ReconciliationAct** - акт сверки
+* **Contract** - договор
+* **Torg13** - накладная ТОРГ-13
+* **ServiceDetails** - детализация
+* **SupplementaryAgreement** - дополнительное соглашение к договору
+
+Актуальный список типов документов, которые можно получать/отправлять в модуле Диадок, хранится в **макете «ТипыДокументов»** основного модуля. **Изменять запрещено!**
+
+**Список колонок макета:**
+
+* **Тип** — название типа документа пакета, которое используется при определении схемы составления контента при отправки/получении документа
+* **Описание** — расшифровка назначения типа документа
+* **Формализованный** — признак документов, которые отправлены/получены в формате xml утвержденном ФНС
+* **Тип контента (отправитель)** — название структуры, содержащей титул продавца
+* **Тип контента (получатель)** — название структуры, содержащей титул покупателя
+* **Подписание** — признак обязательного наличия подписи документа с каждой стороны, либо только со стороны отправителя
+* **Контент отказа** — название структуры, которая заполняется в случае отказа в подписи документа данного типа
+* **Контент запроса уточнения** — название структуры, которая заполняется в случае запроса на уточнение данного типа документа
+* **Тип меты** — название структуры, которая заполняется основными реквизиты формализованных документов (сумма, основание документа и т.п. в зависимости от типа документа)
+* **Реквизиты метаданных** — список реквизитов структуры неформализованных электронного документа (контента), которые будут отображаться в веб-версии Диадок
+* **Краткое представление** — краткое описание типа документа. Отображается в настройках группировки полученных документов при выборе списка типов документов
+* **Группировка полученных документов (по умолчанию)** — название группы входящих документов, которое будет отображаться для пользователей в блоке «Полученные документы»
+* **Тип документа в HTTP API** — название типа документа пакета, которое используется при определении схемы составления контента при отправки/получении документа
+* **Формат XML документа ("Version")** - идентификатор версии документа. Обязательно при отправке зашифрованных документов
+
+**Реквизиты метаданных:**
+
+* **FileName** (тип Строка) – представление неформализованного документа
+* **NeedRecipientSignature** (тип Булево) — признак необходимости запроса подписи получателя
+* **DocumentDate** (тип Дата) — дата документа
+* **DocumentNumber** (тип Строка) — номер документа
+* **Total** (тип Число) — сумма документа с НДС
+* **Vat** (тип Число) — сумма НДС
+* **Grounds** (тип Строка) — основание документа (договор, счет и т.п.)