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

Работа с уведомлением об уточнении

Генерация уведомления об уточнении

Сгенерировать уведомление об уточнении можно с помощью метода GenerateInvoiceCorrectionRequestXml (V2). В запросе нужно передать идентификатор ящика получателя (boxId) и структуру InvoiceCorrectionRequestGenerationRequestV2 со следующими данными:

  • ErrorMessage — текст уведомления об уточнении,
  • messageId — идентификатор сообщения,
  • attachmentId — идентификатор сущности, для которой нужно сформировать уведомление.

Эти значения можно получить из структуры Message.

Данные подписанта нужно передать в универсальном формате в виде XML-файла, сконвертированного в Base64-строку.

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

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

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

{
"ErrorMessage": "Текстовый комментарий",
"MessageId": "{{messageId}}",
"AttachmentId": "{{documentId}}",
"SignerContent": "PD94bWwgdmVyc2l...LDQudC7Pg==" // содержимое XML-файла с данными подписанта в кодировке Base-64
}

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

<?xml version="1.0" encoding="windows-1251"?>
<Файл ИдФайл="DP_UVUTOCH_2BM-1839264655-732644841-202407101103418496883_2BM-9147414342-757645784-202407101104400484330_20250207_8bc3aae6-ce88-459e-943a-37094526c16c" ВерсПрог="Diadoc 1.0" ВерсФорм="1.03">
<Документ КНД="1115113">
<УчастЭДО ИдУчастЭДО="2BM-9147414342-757645784-202407101104400484330">
<ЮЛ НаимОрг="Получатель" ИННЮЛ="8147414342" КПП="857645784" />
</УчастЭДО>
<СвУведУточ ДатаПол="07.02.2025" ВремяПол="10.06.17">
<СведПолФайл ИмяПолФайла="ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-1839264655-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d">
<ЭППолФайл>...</ЭППолФайл>
</СведПолФайл>
<ТекстУведУточ>Текстовый комментарий</ТекстУведУточ>
</СвУведУточ>
<ОтпрДок ИдУчастЭДО="2BM-1839264655-732644841-202407101103418496883">
<ЮЛ НаимОрг="Отправитель" ИННЮЛ="8125600340" КПП="832644841" />
</ОтпрДок>
<Подписант ТипПодпис="1" СтатПодп="2" Должн="Подписант-Должн">
<ФИО Фамилия="Фамилия" Имя="Имя" Отчество="Отчество" />
<СвДоверЭл СпособПредставл="1" НомДовер="c8a8949a-4907-4c36-9f48-7efb2fba1987" ДатаВыдДовер="17.09.2024" ВнНомДовер="123" ДатаВнРегДовер="18.09.2024" СвСистХран="СвДоверЭл-ИдСистХран" />
</Подписант>
</Документ>
</Файл>

В ответе метод вернет сгенерированный XML-файл уведомления. Полученный XML-файл можно подписать электронной подписью и отправить с помощью метода PostMessagePatch (V4), передав его в поле CorrectionRequests структуры MessagePatchToPostV2. Инструкция об отправке документа приведена ниже.

Отправка уведомления об уточнении

Инструкция по созданию уведомления об уточнении приведена выше в разделе Генерация уведомления об уточнении.

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

  • BoxId — идентификатор ящика, в котором находится исходное сообщение;
  • MessageId — идентификатор сообщения, к которому относится дополнение;
  • CorrectionRequests — вложенная структура для передачи XML-файлов уведомлений об уточнении:
    • ParentEntityId — идентификатор документа, к которому относится уведомление;
    • SignedContent.Content — содержимое XML-файла уведомления, сконвертированное в Base64-строку;
    • SignedContent.Signature — содержимое файла подписи уведомления, сконвертированное в Base64-строку;
    • Labels — метки (необязательно).

Пример тела запроса метода PostMessagePatch с уведомлением об уточнении:

{
"BoxId": "{{boxId}}",
"MessageId": "4366e677-38a1-4c42-ad60-caebfdbaed0f",
"CorrectionRequests": [
{
"ParentEntityId": "e33d3903-6125-4542-9548-73000b94d852",
"SignedContent":
{
"Content": "PD94bWwgdmVyc2l...LDQudC7Pg==", // содержимое XML-файла в кодировке base-64
"Signature": "MIIN5QYJKoZIhvc...KsTM6zixgz" // содержимое файла подписи в кодировке base-64
},
"Labels": "label"
}
]
}

Метод вернет в ответе отправленное уведомление об уточнении, представленное структурой MessagePatch.

Получение уведомления об уточнении

После получения документа покупатель может сформировать уведомление об уточнении и отправить его продавцу. Получить уведомление об уточнении можно с помощью метода GetMessage (V6).

В запросе нужно передать:

  • boxId — идентификатор ящика отправителя,
  • messageId — идентификатор отправленного сообщения с документом,
  • entityId — идентификатор отправленного документа.

Эти значения можно получить из структуры Message.

В ответе метод вернет структуру Message с вложенной структурой Entity. Уведомление об уточнении будет представлено структурой Entity со следующими полями:

  • EntityType = Attachment,
  • AttachmentType = InvoiceCorrectionRequest.

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

GET /V5/GetMessage?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

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

{
"EntityType": "Attachment",
"EntityId": "b378a034-3966-4310-bc73-a3e7b42fc9d9",
"ParentEntityId": "bd84007b-c254-4a37-ac64-0b44598b9318",
"Content": "lores ipsum",
"AttachmentType": "InvoiceCorrectionRequest",
"FileName": "DP_UVUTOCH_2BM-6125600340-732644841-202407101103418496883_2BM-9147414342-757645784-202407101104400484330_20250211_a8cd65c9-ee90-467b-bef0-c31a643c8384.xml",
"NeedRecipientSignature": false,
"SignerBoxId": "",
"NotDeliveredEventId": "",
"RawCreationDate": 638932613721445085,
"SignerDepartmentId": "",
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false
}

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

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

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