GetForwardedDocuments (V2)
Предупреждение
Метод устарел.
Возвращает список пересланных документов в указанный ящик по указанным идентификаторам.
- POST /V2/GetForwardedDocuments
- Query Parameters:
boxId – идентификатор ящика организации.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Request Body:
Тело запроса должно содержать запрос на получение списка пересланных документов в виде структуры
GetForwardedDocumentsRequest:message GetForwardedDocumentsRequest { repeated ForwardedDocumentId ForwardedDocumentIds = 1; optional bool InjectEntityContent = 2 [default = false]; }
ForwardedDocumentIds— список идентификаторов пересланных документов, представленных структурой ForwardedDocumentId.InjectEntityContent— признак того, что в результат нужно включить содержимое документа и относящихся к нему сущностей.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – не найдено сообщение с указанным идентификатором.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит список пересланных документов, представленный структурой
GetForwardedDocumentsResponse:message GetForwardedDocumentsResponse { repeated ForwardedDocument ForwardedDocuments = 1; }
ForwardedDocuments— список пересланных документов, представленных структурой ForwardedDocument.
Примеры использования
Пример HTTP-запроса:
POST /V2/GetForwardedDocuments?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json
Пример тела запроса:
{
"ForwardedDocumentIds": [
{
"FromBoxId": "09ae254c-5cd0-4082-84de-7ccb46d86f82",
"DocumentId": {
"MessageId": "53f4b690-62bc-4af7-bbed-442b1ab1e3a4",
"EntityId": "be5f9dd0-ed17-4b2d-b147-5cd7a8d38e3a"
},
"ForwardEventId": "075c7801-d925-4a62-8b8d-e2f75beb8ccf"
}
]
}
Пример тела ответа:
{
"ForwardedDocuments": [
{
"ForwardTimestamp": {
"Ticks": 638920448311894222
},
"ForwardedDocumentId": {
"ForwardEventIdGuid": "075c7801-d925-4a62-8b8d-e2f75beb8ccf",
"FromBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"DocumentId": {
"MessageId": "53f4b690-62bc-4af7-bbed-442b1ab1e3a4",
"EntityId": "be5f9dd0-ed17-4b2d-b147-5cd7a8d38e3a"
},
"ForwardEventId": "075c7801-d925-4a62-8b8d-e2f75beb8ccf"
},
"DocumentWithDocflow": {
"DocumentId": {
"MessageId": "53f4b690-62bc-4af7-bbed-442b1ab1e3a4",
"EntityId": "be5f9dd0-ed17-4b2d-b147-5cd7a8d38e3a"
},
"LastEventId": "552ea0d2-849f-11f0-8000-000214efb30b",
"LastEventTimestamp": {
"Ticks": 638920448312271058
},
"DocumentInfo": {
"DocumentType": "UniversalTransferDocument",
"DocumentDirection": "Inbound",
"IsTest": true,
"FromDepartmentId": "00000000-0000-0000-0000-000000000000",
"ToDepartmentId": "00000000-0000-0000-0000-000000000000",
"CounteragentBoxId": "75337378b1dd4eb68b08210f175b31a8@diadoc.ru",
"DocumentDateAndNumber": {
"DocumentDate": "21.02.2025",
"DocumentNumber": "445"
},
"UniversalTransferDocumentInfo": {
"Total": "10000.00",
"Vat": "456.00",
"CurrencyCode": 643,
"Grounds": "",
"Function": "Basic"
},
"Version": "utd970_05_03_01"
},
"Docflow": {
"IsFinished": false,
"DocumentAttachment": {
"Attachment": {
"Entity": {
"EntityId": "be5f9dd0-ed17-4b2d-b147-5cd7a8d38e3a",
"CreationTimestamp": {
"Ticks": 638920448156991747
},
"Content": {
"Size": 5416
}
},
"AttachmentFilename": "ON_NSCHFDOPPR_2BM-6125600340-732644841-202407101103418496883_2BM-6699000000-2012052807205326661080000000000_20250221_122f7691-feae-4d6b-b495-8c7f0853665d_0_1_1_0_0_00.xml",
"DisplayFilename": "УПД №445 от 21.02.25"
},
"Signature": {
"Entity": {
"EntityId": "1b374e29-b6d4-4f96-b899-d017c7f2d3ff",
"CreationTimestamp": {
"Ticks": 638920448159720288
},
"Content": {
"Size": 6844
}
},
"SignerBoxId": "75337378b1dd4eb68b08210f175b31a8@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true
}
},
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"DocumentIsDeleted": false,
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Требуется подпись",
"StatusHint": ""
}
},
"SendTimestamp": {
"Ticks": 638920448156991747
},
"DeliveryTimestamp": {
"Ticks": 638920448159720288
},
"CanDocumentBeRevokedUnilaterallyBySender": true,
"CustomData": [],
"InboundUniversalTransferDocumentDocflow": {
"IsFinished": false,
"ConfirmationDocflow": {
"IsFinished": true,
"ConfirmationAttachment": {
"Attachment": {
"Entity": {
"EntityId": "70c98fbe-9fc7-43ff-8d1d-7519f52d4ef8",
"CreationTimestamp": {
"Ticks": 638920448159720288
},
"Content": {
"Size": 5338
}
},
"AttachmentFilename": "DP_PDOTPR_2BM-6125600340-732644841-202407101103418496883_2BM_20250829_70c98fbe-9fc7-43ff-8d1d-7519f52d4ef8.xml",
"DisplayFilename": "Подтверждение даты отправки"
},
"Signature": {
"Entity": {
"EntityId": "1d09eee0-f7c9-4615-a58c-d47e60cdab13",
"CreationTimestamp": {
"Ticks": 638920448159720288
},
"Content": {
"Size": 3532
}
},
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true
}
}
},
"ConfirmationTimestamp": {
"Ticks": 638920448159720288
},
"IsAmendmentRequested": false,
"IsRevised": false,
"IsCorrected": false,
"IsReceiptRequested": false,
"IsRecipientSignatureRequested": true,
"IsDocumentSignedByRecipient": false,
"IsDocumentRejectedByRecipient": false,
"CanDocumentBeReceipted": true,
"CanDocumentBeSignedOrRejectedByRecipient": true
}
},
"InitialDocumentIds": [],
"SubordinateDocumentIds": [],
"ForwardDocumentEvents": [
{
"Timestamp": {
"Ticks": 638920448311894222
},
"ToBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru"
}
]
}
}
]
}
См. также
- Инструкции:
- Методы для работы с пересланными документами:
ForwardDocument (V2) — пересылает документ в указанный ящик
GenerateForwardedDocumentPrintForm — генерирует печатную форму пересланного документа
GenerateForwardedDocumentProtocol (V2) — генерирует печатную форму протокола передачи документа для адресата пересылки
GetForwardedDocumentEvents (V2) — возвращает список событий пересылки документов в указанный ящик
GetForwardedDocuments (V2) — возвращает список пересланных документов по указанным идентификаторам
GetForwardedEntityContent (V2) — возвращает содержимое указанной сущности пересланного сообщения
- Методы для работы с документами:
Delete — отмечает указанный документ как удаленный
GetContent — возвращает XSD-схему документа
GetDocument (V3) — возвращает данные документа по указанному идентификатору
GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
GetDocumentsByMessageId — возвращает список документов из указанного сообщения
GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
MoveDocuments — перемещает документы в указанное подразделение организации
Restore — восстанавливает документ из удаленных