GenerateReceiptXml
Метод устарел и будет удален из API после 30 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — GenerateReceiptXml (V2).
Метод GenerateReceiptXml генерирует извещения о получении (ИоП) на различные сущности в системе.
Версия метода не поддерживает заполнение всех полей извещения о получении формата, утвержденного приказом № ЕД-7-26/133@.
POST /GenerateReceiptXml
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.messageId— идентификатор сообщения.attachmentId— идентификатор сущности, для которой требуется сформировать извещение о получении.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать данные о подписанте генерируемого извещения в виде сериализованной структуры Signer.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомboxIdзакончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.405— используется неподходящий HTTP-метод.409— формирование извещения о получении для данной сущности невозможно.500— при обработке запроса возникла непредвиденная ошибка.
Заголовки ответа
Content-Disposition— имя файла с извещением.
Тело ответа
Тело ответа содержит XML-файл извещения о получении для сущности attachmentId из сообщения messageId в ящике boxId. На текущий момент в Диадоке можно отправлять извещения о получении на следующие сущности:
| Тип ИоП | AttachmentType соответствующей сущности | Кто отправляет ИоП | Кто получает ИоП |
|---|---|---|---|
| На титул отправителя | Title (или старый точечный титул отправителя) | Получатель документа | Отправитель документа |
| На титул получателя | Title (или старый точечный титул получателя) | Отправитель | Получатель |
| На уведомление об уточнении | InvoiceCorrectionRequest | Отправитель | Получатель |
Для каждого типа документа возможность отправки ИоП задается в свойствах вида документооборота DocumentWorkflow документа: свойства «ИоП на титул участника» для отправителя и получателя (TitleReceiptBehavior), «Ответное действие на УоУ» (AmendmentRequestResponseBehavior).
Файл с извещением формируется в соответствии с XSD-схемой.
После успешной генерации файла его можно загрузить в систему, передав в методе PostMessagePatch (V3) в структуре Receipts.
Методы GenerateDocumentReceiptXml и GenerateInvoiceDocumentReceiptXml расширены и поддерживают весь функционал нового метода, но считаются устаревшими и не рекомендуются к использованию.
См. также
Инструкции: