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

GenerateReceiptXml (V2)

Генерирует файл извещения о получении (ИоП).

POST /V2/GenerateReceiptXml

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.

Заголовки запроса

Тело запроса

Тело запроса должно содержать структуру ReceiptGenerationRequestV2.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — невозможно сформировать извещения о получении для указанной сущности.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Заголовки ответа

  • Content-Disposition — имя файла с извещением.

Тело ответа

Тело ответа содержит XML-файл извещения о получении для сущности attachmentId из сообщения messageId в ящике boxId. Файл с извещением формируется в соответствии с XSD-схемой. В Диадоке можно отправлять извещения о получении на следующие сущности:

Тип ИоПAttachmentType соответствующей сущностиКто отправляет ИоПКто получает ИоП
На титул отправителяTitle или старый точечный титул отправителяПолучатель документаОтправитель документа
На титул получателяTitle или старый точечный титул получателяОтправительПолучатель
На уведомление об уточненииInvoiceCorrectionRequestОтправительПолучатель

Для каждого типа документа возможность отправки извещения о получении задается в свойствах вида документооборота документа: свойства «ИоП на титул участника» для отправителя и получателя (TitleReceiptBehavior), «Ответное действие на УоУ» (AmendmentRequestResponseBehavior).

Сгенерированный файл можно загрузить в Диадок, передав его в структуре Receipts с помощью метода PostMessagePatch (V4). Инструкция приведена в разделе Отправка извещения о получении.

Примеры использования

Пример HTTP-запроса:

POST /V2/GenerateReceiptXml?boxid={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/xml

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

{
"MessageId": "bbcedb0d-ce34-4e0d-b321-3f600c920935",
"AttachmentId": "30cf2c07-7297-4d48-bc6f-ca7a80e2cf95",
"SignerContent": "PD94bWwgdmVyc2l...LDQudC7Pg==" // содержимое XML-файла с данными подписанта в кодировке Base-64
}

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

<?xml version="1.0" encoding="windows-1251"?>
<Файл ИдФайл="DP_IZVPOL_2BM-9616675014-961601000-201906250926373816603_2BM-7770357771-2012082810454029703720000000000_20230904_54c96f37-a745-4e02-8dda-41404992952f" ВерсПрог="Diadoc 1.0" ВерсФорм="1.03">
<Документ КНД="1115110">
<УчастЭДО ИдУчастЭДО="2BM-7770357771-2012082810454029703720000000000">
<ЮЛ НаимОрг="ОАО" ИННЮЛ="7770357771" КПП="770101001"/>
</УчастЭДО>
<СвИзвПолуч ДатаПол="04.09.2023" ВремяПол="13.32.26">
<СведПолФайл ИмяПолФайла="ON_NSCHFDOPPR_2BM-7770357771-2012082810454029703720000000000_2BM-9616675014-961601000-201906250926373816603_20200826_6efc7ad3-88ff-485d-86bb-c84c2262caf2">
<ЭППолФайл>MIINB3RI=...</ЭППолФайл>
</СведПолФайл>
</СвИзвПолуч>
<ОтпрДок ИдУчастЭДО="2BM-9616675014-961601000-201906250926373816603">
<ЮЛ НаимОрг="ООО" ИННЮЛ="9616675014" КПП="961601000"/>
</ОтпрДок>
<Подписант ТипПодпис="1" СтатПодп="2" Должн="Подписант-Должн">
<ФИО Фамилия="Петров" Имя="Петр" Отчество="Петрович"/>
<СвДоверЭл СпособПредставл="1" НомДовер="4a743152-e772-4249-9a47-e2e290258e79" ДатаВыдДовер="17.09.2018" ВнНомДовер="123" ДатаВнРегДовер="18.09.2018" ИдСистХран="СвДоверЭл-ИдСистХран"/>
</Подписант>
</Документ>
</Файл>

См. также

Инструкции:

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

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

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