GenerateReceiptXml¶

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

Версии метода:

GenerateReceiptXml V2.

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

GenerateReceiptXml V2¶

POST /V2/GenerateReceiptXml¶

Query Parameters:

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

Request Headers:

Authorization – данные, необходимые для авторизации.

Request Body:

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

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. Файл с извещением формируется в соответствии с XSD-схемой. В Диадоке можно отправлять ИоПы на следующие сущности:

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

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

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

GenerateReceiptXml¶

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

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

POST /GenerateReceiptXml¶

Query Parameters:

boxId – идентификатор ящика организации.
messageId – идентификатор сообщения.
attachmentId – идентификатор сущности, для которой требуется сформировать ИоП.

Request Headers:

Authorization – данные, необходимые для авторизации.

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 в структуре Receipts.

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

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