TransformTemplateToMessage
Создает из шаблона исходящее неотправленное сообщение.
После создания сообщения пользователь может подписать документы и отправить это сообщение с помощью метода PostMessagePatch (V4).
- POST /TransformTemplateToMessage
- Query Parameters:
operationId – идентификатор операции. Необязательный параметр, нерегистрочувствительный. Если вызов с указанным идентификатором операции завершился успехом, то и все последующие вызовы с тем же идентификатором операции так же завершатся успехом. Результат всех последующих вызовов будет равен результату первого успешного вызова. По умолчанию в качестве идентификатора операции используется MD5-хэш тела запроса.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Request Body:
Тело запроса должно содержать информацию о преобразуемых документах, представленную структурой TemplateTransformationToPost.
- Status Codes:
200 OK – операция успешно завершена.
204 No Content – операция еще не завершена. В HTTP-заголовке ответа
Retry-Afterуказано время в секундах, через которое нужно повторить запрос.400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – не найден шаблон документов.
405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – осуществляется попытка отправить дубликат сообщения.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Headers:
Retry-After – если в ответе содержится HTTP-заголовок
Retry-After, то предыдущий вызов этого метода с таким же идентификатором операции еще не завершен. В этом случае следует повторить вызов через указанное в заголовке время (в секундах), чтобы убедиться, что операция завершилась без ошибок.
- Response Body:
Тело ответа содержит созданное сообщение, сериализованное в протобуфер Message.
Примеры использования
Пример HTTP-запроса:
POST /TransformTemplateToMessage HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json
Пример тела запроса:
{
"BoxId": "{{boxId_sender}}",
"TemplateId": "{{templateId}}",
"DocumentTransformations": [
{
"DocumentId": "{{documentId}}"
}
]
}
Пример тела ответа:
{
"MessageId": "6a0f932f-f3b3-44bc-b98a-5d40f49c863a",
"TimestampTicks": 639089728975211330,
"LastPatchTimestampTicks": 639089728975211330,
"FromBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"FromTitle": "Организация-отправитель",
"ToBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"ToTitle": "Организация-получатель",
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "54518e37-53e4-459e-96ce-d21c019d70cf",
"AuthorUserId": "",
"ParentEntityId": "",
"Content": {
"Size": 3680
},
"AttachmentType": "UniversalCorrectionDocument",
"FileName": "ON_NKORSCHFDOPPR_1f208d032a604f6491b1b7aad54cfaf3_09ae254c5cd0408284de7ccb46d86f82_54518e37-53e4-459e-96ce-d21c019d70cf.xml",
"NeedRecipientSignature": false,
"DocumentInfo": {
"MessageId": "6a0f932f-f3b3-44bc-b98a-5d40f49c863a",
"EntityId": "54518e37-53e4-459e-96ce-d21c019d70cf",
"CreationTimestampTicks": 639089728975211330,
"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DocumentType": "UniversalCorrectionDocument",
"InitialDocumentIds": [],
"SubordinateDocumentIds": [],
"Content": {
"Size": 3680
},
"FileName": "ON_NKORSCHFDOPPR_1f208d032a604f6491b1b7aad54cfaf3_09ae254c5cd0408284de7ccb46d86f82_54518e37-53e4-459e-96ce-d21c019d70cf.xml",
"DocumentDate": "15.08.2025",
"DocumentNumber": "1",
"IsDeleted": false,
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"IsTest": false,
"FromDepartmentId": "00000000-0000-0000-0000-000000000000",
"ToDepartmentId": "00000000-0000-0000-0000-000000000000",
"RevocationStatus": "RevocationStatusNone",
"SendTimestampTicks": 639089728975211330,
"DeliveryTimestampTicks": 0,
"ForwardDocumentEvents": [],
"RoamingNotificationStatus": "RoamingNotificationStatusNone",
"HasCustomPrintForm": false,
"CustomData": [],
"DocumentDirection": "Outbound",
"LastModificationTimestampTicks": 639089728975211330,
"IsEncryptedContent": false,
"SenderSignatureStatus": "SenderSignatureUnchecked",
"IsRead": true,
"PacketIsLocked": false,
"UniversalCorrectionDocumentMetadata": {
"DocumentStatus": "OutboundWaitingForInvoiceReceiptAndRecipientSignature",
"TotalInc": "0.00",
"TotalDec": "4680.00",
"VatInc": "0.00",
"VatDec": "780.00",
"DocumentFunction": "КСЧФДИС",
"Currency": 643,
"ConfirmationDateTimeTicks": 0,
"InvoiceAmendmentFlags": 0,
"OriginalInvoiceNumber": "000081873",
"OriginalInvoiceDate": "14.08.2025",
"OriginalInvoiceRevisionNumber": "",
"OriginalInvoiceRevisionDate": ""
},
"ProxySignatureStatus": "ProxySignatureStatusNone",
"TypeNamedId": "UniversalCorrectionDocument",
"Function": "КСЧФДИС",
"WorkflowId": 18,
"Title": "УКД №1 от 15.08.25",
"Metadata": [
{
"Key": "FileName",
"Value": "ON_NKORSCHFDOPPR_1f208d032a604f6491b1b7aad54cfaf3_09ae254c5cd0408284de7ccb46d86f82_54518e37-53e4-459e-96ce-d21c019d70cf.xml"
},
{
"Key": "DocumentNumber",
"Value": "1"
},
{
"Key": "DocumentDate",
"Value": "15.08.2025"
},
{
"Key": "CurrencyCode",
"Value": "643"
},
{
"Key": "OriginalDocumentNumber",
"Value": "000081873"
},
{
"Key": "OriginalDocumentDate",
"Value": "14.08.2025"
},
{
"Key": "CorrectionTotalInc",
"Value": "0.00"
},
{
"Key": "CorrectionVatInc",
"Value": "0.00"
},
{
"Key": "CorrectionTotalDec",
"Value": "4680.00"
},
{
"Key": "CorrectionVatDec",
"Value": "780.00"
}
],
"RecipientReceiptMetadata": {
"ReceiptStatus": "WaitingForReceipt",
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"DateTimeTicks": 0
}
},
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"DateTimeTicks": 0
},
"RecipientResponseStatus": "WaitingForRecipientSignature",
"AmendmentRequestMetadata": {
"AmendmentFlags": 0,
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"Origin": {
"MessageType": "Draft",
"MessageId": "5df1eb0b-122e-421e-8548-24fd80c63d5a"
},
"EditingSettingId": "",
"LockMode": "None",
"SenderReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"Version": "ucd736_05_01_02",
"LastOuterDocflows": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Ожидается уведомление о получении"
},
"PowerOfAttorneyGeneralStatus": {
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"StatusText": "Не приложена доверенность",
"Errors": []
}
},
"TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
"MessageIdGuid": "6a0f932f-f3b3-44bc-b98a-5d40f49c863a",
"EntityIdGuid": "54518e37-53e4-459e-96ce-d21c019d70cf",
"CreationTimestamp": "2026-03-13T04:28:17.521133Z"
},
"RawCreationDate": 639089728975211330,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"Version": "ucd736_05_01_02",
"ContentTypeId": "ucd736_kschfdis_orig_t1_05_01_02"
},
{
"EntityType": "Attachment",
"EntityId": "9a42c5d1-2c61-4c6e-8f46-1cbd0e9e2a12",
"AuthorUserId": "",
"ParentEntityId": "54518e37-53e4-459e-96ce-d21c019d70cf",
"Content": {
"Size": 42
},
"AttachmentType": "AttachmentComment",
"NeedRecipientSignature": false,
"RawCreationDate": 639089728975211330,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": ""
},
{
"EntityType": "Signature",
"EntityId": "2b9e5f4c-1c62-4d8e-9c7a-7c4a9c43c0e4",
"AuthorUserId": "9aa516d1-eec7-4e09-b11e-8772d081a4fa",
"ParentEntityId": "54518e37-53e4-459e-96ce-d21c019d70cf",
"Content": {
"Size": -1
},
"AttachmentType": "Nonformalized",
"NeedRecipientSignature": false,
"SignerBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"RawCreationDate": 639089728975211330,
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "",
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом физ. лица без МЧД"
}
}
],
"IsDraft": false,
"DraftIsLocked": false,
"DraftIsRecycled": false,
"CreatedFromDraftId": "5df1eb0b-122e-421e-8548-24fd80c63d5a",
"DraftIsTransformedToMessageIdList": [],
"IsDeleted": false,
"IsTest": false,
"IsInternal": false,
"IsProxified": false,
"ProxyBoxId": "",
"ProxyTitle": "",
"PacketIsLocked": false,
"LockMode": "None",
"MessageType": "Letter",
"IsReusable": false
}
См. также
- Инструкции:
- Методы для работы с шаблонами:
PostTemplate — отправляет шаблон документа
PostTemplatePatch — отправляет дополнение к шаблону документа
TransformTemplateToMessage — cоздает из шаблона исходящее неотправленное сообщение
- Методы для работы с сообщением:
GetMessage (V6) — возвращает данные сообщения по указанному идентификатору
PostMessage (V3) — отправляет сообщение
PostMessagePatch (V4) — отправляет дополнение к сообщению
TransformTemplateToMessage — создает из шаблона исходящее неотправленное сообщение