GenerateReceiptXml

Предупреждение

Эта версия метода устарела. Используйте новую версию метода GenerateReceiptXml (V2).

Метод GenerateReceiptXml генерирует извещения о получении (ИоП) на различные сущности в системе.

Версия метода не поддерживает заполнение всех полей извещения о получении формата, утвержденного приказом № ЕД-7-26/133@.

POST /GenerateReceiptXml
Query Parameters:

  • boxId – идентификатор ящика организации.

  • messageId – идентификатор сообщения.

  • attachmentId – идентификатор сущности, для которой требуется сформировать извещение о получении.

Request Headers:
Request Body:

Тело запроса должно содержать данные о подписанте генерируемого извещения в виде сериализованной структуры Signer.

Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – формирование извещения о получении для данной сущности невозможно.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:

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

Response Body:

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

Тип ИоП

AttachmentType соответствующей сущности

Кто отправляет ИоП

Кто получает ИоП

На титул отправителя

Title (или старый точечный титул отправителя)

Получатель документа

Отправитель документа

На титул получателя

Title (или старый точечный титул получателя)

Отправитель

Получатель

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

InvoiceCorrectionRequest

Отправитель

Получатель

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

Файл с извещением формируется в соответствии с XML-схемой.

После успешной генерации файла его можно загрузить в систему, передав в методе PostMessagePatch (V3) в структуре Receipts.

Предупреждение

Методы GenerateDocumentReceiptXml и GenerateInvoiceDocumentReceiptXml расширены и поддерживают весь функционал нового метода, но считаются устаревшими и не рекомендуются к использованию.

См. также

Инструкции: