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

GenerateReceiptXml

warning

Метод устарел и будет удален из API после 30 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — GenerateReceiptXml (V2).

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

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

POST /GenerateReceiptXml

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

  • boxId — идентификатор ящика организации в формате GUID.
  • messageId — идентификатор сообщения.
  • attachmentId — идентификатор сущности, для которой требуется сформировать извещение о получении.

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

Тело запроса

Тело запроса должно содержать данные о подписанте генерируемого извещения в виде сериализованной структуры 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.

warning

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


См. также

Инструкции:

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

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

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