GetDocumentsByMessageId
Возвращает список документов из указанного сообщения.
- GET /GetDocumentsByMessageId
- Query Parameters:
- Request Headers:
Authorization – данные, необходимые для авторизации.
- 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:
Тело ответа содержит список документов из указанного сообщения, представленный структурой DocumentList.
В ответе вернутся только те документы, к которым у пользователя есть доступ. Признак DocumentList.HasMoreResults всегда будет принимать значение false.
Примеры использования
Пример HTTP-запроса:
GET /GetDocumentsByMessageId?boxId={{boxId}}&messageId={{messageId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json charset=utf-8
Accept: application/json
Пример тела ответа:
{
"Documents": [
{
"AmendmentRequestMetadata": {
"AmendmentFlags": 0,
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"ConfirmationMetadata": {
"DateTimeTicks": 638745087772041933,
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"Content": {
"Size": 2512
},
"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"CreationTimestamp": "2025-02-07T07:06:16.8452096Z",
"CreationTimestampTicks": 638745087768452096,
"CustomData": [
],
"DeliveryTimestampTicks": 638745087772041933,
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"DocflowStatus": {
"PowerOfAttorneyGeneralStatus": {
"Errors": [
],
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"StatusText": "Не приложена доверенность"
},
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Ожидается подпись контрагента"
}
},
"DocumentDate": "07.02.2025",
"DocumentDirection": "Outbound",
"DocumentNumber": "123123",
"DocumentType": "UniversalTransferDocument",
"EditingSettingId": "",
"EntityId": "da7cd73e-ff49-4a23-a018-42d27487e536",
"EntityIdGuid": "da7cd73e-ff49-4a23-a018-42d27487e536",
"FileName": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d.xml",
"ForwardDocumentEvents": [
{
"Timestamp": {
"Ticks": 638806439880369912
},
"ToBoxId": "efc0c4deaa81428998732035ce4c2bac@diadoc.ru"
},
{
"Timestamp": {
"Ticks": 638806440596039464
},
"ToBoxId": "efc0c4deaa81428998732035ce4c2bac@diadoc.ru"
}
],
"FromDepartmentId": "00000000-0000-0000-0000-000000000000",
"Function": "СЧФДОП",
"HasCustomPrintForm": false,
"InitialDocumentIds": [
],
"IsDeleted": false,
"IsEncryptedContent": false,
"IsRead": true,
"IsTest": false,
"LastModificationTimestampTicks": 638806440596039464,
"LastOuterDocflows": [
],
"LockMode": "None",
"MessageId": "ba04162c-e26f-448f-a370-299b4f15b6d1",
"MessageIdGuid": "ba04162c-e26f-448f-a370-299b4f15b6d1",
"Metadata": [
{
"Key": "FileName",
"Value": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d.xml"
},
{
"Key": "DocumentNumber",
"Value": "123123"
},
{
"Key": "DocumentDate",
"Value": "07.02.2025"
},
{
"Key": "TotalSum",
"Value": "1.00"
},
{
"Key": "TotalVat",
"Value": "1.00"
},
{
"Key": "CurrencyCode",
"Value": "643"
},
{
"Key": "Grounds",
"Value": "Без документа-основания"
},
{
"Key": "TotalVat10",
"Value": "0"
},
{
"Key": "TotalVat18",
"Value": "0"
},
{
"Key": "TotalVat20",
"Value": "0"
},
{
"Key": "SellerInn",
"Value": "6125600340"
}
],
"PacketIsLocked": false,
"ProxySignatureStatus": "ProxySignatureStatusNone",
"RecipientReceiptMetadata": {
"ConfirmationMetadata": {
"DateTimeTicks": 638747862192156432,
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"ReceiptStatus": "Finished"
},
"RecipientResponseStatus": "WaitingForRecipientSignature",
"RevocationStatus": "RevocationStatusNone",
"RoamingNotificationStatus": "RoamingNotificationStatusNone",
"SenderReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"SenderSignatureStatus": "SenderSignatureCheckedAndValid",
"SendTimestampTicks": 638745087768452096,
"SubordinateDocumentIds": [
],
"Title": "УПД №123123 от 07.02.25",
"ToDepartmentId": "00000000-0000-0000-0000-000000000000",
"TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
"TypeNamedId": "UniversalTransferDocument",
"UniversalTransferDocumentMetadata": {
"ConfirmationDateTimeTicks": 638745195768452096,
"Currency": 643,
"DocumentFunction": "СЧФДОП",
"DocumentStatus": "OutboundWaitingForRecipientSignature",
"Grounds": "Без документа-основания",
"InvoiceAmendmentFlags": 0,
"Total": "1.00",
"Vat": "1.00"
},
"Version": "utd820_05_01_02_hyphen",
"WorkflowId": 18
}
],
"HasMoreResults": false,
"TotalCount": 1
}
См. также
- Инструкции:
- Методы для работы с документами:
Delete — отмечает указанный документ как удаленный
GetContent — возвращает XSD-схему документа
GetDocument (V3) — возвращает данные документа по указанному идентификатору
GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
GetDocumentsByMessageId — возвращает список документов из указанного сообщения
GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
MoveDocuments — перемещает документы в указанное подразделение организации
Restore — восстанавливает документ из удаленных