GetDocument (V3)

Возвращает данные документа по указанному идентификатору.

GET /V3/GetDocument

Query Parameters:

boxId – идентификатор ящика организации в формате GUID.
messageId – идентификатор сообщения.
entityId – идентификатор сущности типа LetterAttachment в сообщении.
injectEntityContent – признак того, что в результат нужно включить содержимое документа. Если указано значение true, то содержимое документа будет добавлено в поле ответа Content.Data. Необязательный параметр, по умолчанию равен true. Обратите внимание, что добавление содержимого замедляет работу метода.

Request Headers:

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

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – в указанном ящике не найдено сообщение с идентификатором messageId, или в указанном сообщении нет сущности типа LetterAttachment с идентификатором entityId, или документ удален.
405 Method Not Allowed – используется неподходящий HTTP-метод.
410 Gone – документ удален по причине обнаружения вредоносного ПО.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о документе entityId из сообщения messageId в ящике boxId, представленную структурой Document.

Содержимое документа хранится в поле Document.Content. Формат содержимого зависит от типа документа. Все форматы содержимого описаны на странице Entity.

Размер содержимого в поле Content.Data не должен превышать 1048576 байт. Если размер содержимого документа превышает это значение, то оно не будет включено в ответ независимо от значения параметра injectEntityContent. В этом случае получить содержимое документа можно с помощью метода GetEntityContent (V4).

Для выполнения метода текущий пользователь должен иметь доступ к запрашиваемому документу, иначе метод вернет ошибку 403 (Forbidden).

Примеры использования

Пример HTTP-запроса:

GET /V3/GetDocument?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json

Пример тела ответа:

{
	"TotalCount": 2,
	"Documents": [
		{
			"IndexKey": "0210A9EEEBBEA99AA8EE082212096399BD3E299CD74C11A28B93B9C5E294CC2A1209B4D9F94BE693DA4B1185ED5C83E1B075CB",
			"MessageId": "3ebd9963-9c29-4cd7-a28b-93b9c5e294cc",
			"EntityId": "4bf9d9b4-93e6-4bda-85ed-5c83e1b075cb",
			"CreationTimestampTicks": 638562073531053865,
			"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
			"DocumentType": "UniversalTransferDocument",
			"InitialDocumentIds": [],
			"SubordinateDocumentIds": [],
			"Content": {
				"Size": 11061
			},
			"FileName": "ON_NSCHFDOPPR_2BM-966259685098-20231024083946535138700000000_2BM-9616675014-961601000-202310240839360601227_20240710_b6ee65a3-040e-405c-a2fa-5080df8a3d34_1_1_0_0_1_00.xml",
			"DocumentDate": "01.02.2003",
			"DocumentNumber": "444",
			"IsDeleted": false,
			"DepartmentId": "00000000-0000-0000-0000-000000000000",
			"IsTest": true,
			"FromDepartmentId": "00000000-0000-0000-0000-000000000000",
			"ToDepartmentId": "00000000-0000-0000-0000-000000000000",
			"RevocationStatus": "RequestsMyRevocation",
			"SendTimestampTicks": 638562073531053865,
			"DeliveryTimestampTicks": 638562073540225572,
			"ForwardDocumentEvents": [],
			"RoamingNotificationStatus": "RoamingNotificationStatusNone",
			"HasCustomPrintForm": false,
			"CustomData": [],
			"DocumentDirection": "Outbound",
			"LastModificationTimestampTicks": 638857637640526170,
			"IsEncryptedContent": false,
			"SenderSignatureStatus": "SenderSignatureCheckedAndValid",
			"IsRead": true,
			"PacketIsLocked": false,
			"UniversalTransferDocumentMetadata": {
				"DocumentStatus": "OutboundFinished",
				"Total": "10000.00",
				"Vat": "456.00",
				"Grounds": "ОснПер-РеквНаимДок №567 от 14.02.2020",
				"DocumentFunction": "СЧФ",
				"Currency": 643,
				"ConfirmationDateTimeTicks": 638562181531053865,
				"InvoiceAmendmentFlags": 0
			},
			"ProxySignatureStatus": "ProxySignatureStatusNone",
			"TypeNamedId": "UniversalTransferDocument",
			"Function": "СЧФ",
			"WorkflowId": 17,
			"Title": "УПД №444 от 01.02.03",
			"Metadata": [
				{
					"Key": "FileName",
					"Value": "ON_NSCHFDOPPR_2BM-966259685098-20231024083946535138700000000_2BM-9616675014-961601000-202310240839360601227_20240710_b6ee65a3-040e-405c-a2fa-5080df8a3d34_1_1_0_0_1_00.xml"
				},
				{
					"Key": "DocumentNumber",
					"Value": "444"
				},
				{
					"Key": "DocumentDate",
					"Value": "01.02.2003"
				},
				{
					"Key": "TotalSum",
					"Value": "10000.00"
				},
				{
					"Key": "TotalVat",
					"Value": "456.00"
				},
				{
					"Key": "CurrencyCode",
					"Value": "643"
				},
				{
					"Key": "Grounds",
					"Value": "ОснПер-РеквНаимДок №567 от 14.02.2020"
				},
				{
					"Key": "TotalVat10",
					"Value": "0"
				},
				{
					"Key": "TotalVat18",
					"Value": "0"
				},
				{
					"Key": "TotalVat20",
					"Value": "2000.00"
				},
				{
					"Key": "SellerInn",
					"Value": "9103624367"
				}
			],
			"RecipientReceiptMetadata": {
				"ReceiptStatus": "Finished",
				"ConfirmationMetadata": {
					"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
					"DateTimeTicks": 638747862156232916
				}
			},
			"ConfirmationMetadata": {
				"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
				"DateTimeTicks": 638562073540225572
			},
			"RecipientResponseStatus": "RecipientResponseStatusNotAcceptable",
			"AmendmentRequestMetadata": {
				"AmendmentFlags": 0,
				"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
			},
			"EditingSettingId": "",
			"LockMode": "None",
			"SenderReceiptMetadata": {
				"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
			},
			"Version": "utd970_05_02_01",
			"LastOuterDocflows": [
				{
					"ParentEntityId": "4bf9d9b4-93e6-4bda-85ed-5c83e1b075cb",
					"OuterDocflow": {
						"DocflowNamedId": "PkFns",
						"DocflowFriendlyName": "Прослеживаемость",
						"Status": {
							"NamedId": "Sending",
							"FriendlyName": "Документ с прослеживаемым товаром был отправлен в ПК ФНС",
							"Type": "Normal",
							"Details": []
						}
					}
				}
			],
			"DocflowStatus": {
				"PrimaryStatus": {
					"Severity": "Warning",
					"StatusText": "Требуется аннулирование"
				}
			},
			"TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
			"HasUnreadOutOfWorkflowUniversalMessages": false,
			"Participants": [
				{
					"Participant": {
						"BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
						"DepartmentId": "00000000-0000-0000-0000-000000000000",
						"Role": "default:sender",
						"Flags": {
							"IsRoaming": false,
							"IsCrossborder": false,
							"IsForeign": false
						},
						"Type": "Sender",
						"IsCurrentBox": true
					},
					"RecipientResponseStatus": "RecipientResponseStatusUnknown"
				},
				{
					"Participant": {
						"BoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
						"DepartmentId": "00000000-0000-0000-0000-000000000000",
						"Role": "default:recipient",
						"Flags": {
							"IsRoaming": false,
							"IsCrossborder": false,
							"IsForeign": false
						},
						"Type": "Recipient",
						"IsCurrentBox": false
					},
					"RecipientResponseStatus": "RecipientResponseStatusNotAcceptable"
				}
			],
			"MessageIdGuid": "3ebd9963-9c29-4cd7-a28b-93b9c5e294cc",
			"EntityIdGuid": "4bf9d9b4-93e6-4bda-85ed-5c83e1b075cb",
			"CreationTimestamp": "2024-07-10T11:22:33.1053865Z"
		},
		{
			"IndexKey": "02109EC6E0F19D9CA8EE08221209D1C28EE2EB3ED04F11851E0DA0C487249A2A1209F8081834FB2CD84811A6FA8BB26659F67D",
			"MessageId": "e28ec2d1-3eeb-4fd0-851e-0da0c487249a",
			"EntityId": "341808f8-2cfb-48d8-a6fa-8bb26659f67d",
			"CreationTimestampTicks": 638562139136074526,
			"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
			"DocumentType": "UniversalTransferDocument",
			"InitialDocumentIds": [],
			"SubordinateDocumentIds": [],
			"Content": {
				"Size": 3293
			},
			"FileName": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20240710_d8e20a1a-91e0-4f39-ac5c-4e021378788b.xml",
			"DocumentDate": "10.07.2024",
			"DocumentNumber": "123456",
			"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": 638562139136074526,
			"DeliveryTimestampTicks": 638562139140301838,
			"ForwardDocumentEvents": [],
			"RoamingNotificationStatus": "RoamingNotificationStatusNone",
			"HasCustomPrintForm": false,
			"CustomData": [],
			"DocumentDirection": "Outbound",
			"LastModificationTimestampTicks": 638747862162492383,
			"IsEncryptedContent": false,
			"SenderSignatureStatus": "SenderSignatureCheckedAndValid",
			"IsRead": true,
			"PacketIsLocked": false,
			"UniversalTransferDocumentMetadata": {
				"DocumentStatus": "OutboundWaitingForRecipientSignature",
				"Total": "14000.00",
				"Vat": "",
				"Grounds": "Без документа-основания",
				"DocumentFunction": "СЧФДОП",
				"Currency": 643,
				"ConfirmationDateTimeTicks": 638562247136074526,
				"InvoiceAmendmentFlags": 0
			},
			"ProxySignatureStatus": "ProxySignatureStatusNone",
			"TypeNamedId": "UniversalTransferDocument",
			"Function": "СЧФДОП",
			"WorkflowId": 18,
			"Title": "УПД №123456 от 10.07.24",
			"Metadata": [
				{
					"Key": "FileName",
					"Value": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20240710_d8e20a1a-91e0-4f39-ac5c-4e021378788b.xml"
				},
				{
					"Key": "DocumentNumber",
					"Value": "123456"
				},
				{
					"Key": "DocumentDate",
					"Value": "10.07.2024"
				},
				{
					"Key": "TotalSum",
					"Value": "14000.00"
				},
				{
					"Key": "CurrencyCode",
					"Value": "643"
				},
				{
					"Key": "Grounds",
					"Value": "Без документа-основания"
				},
				{
					"Key": "TotalVat10",
					"Value": "0"
				},
				{
					"Key": "TotalVat18",
					"Value": "0"
				},
				{
					"Key": "TotalVat20",
					"Value": "0"
				},
				{
					"Key": "SellerInn",
					"Value": "6125600340"
				}
			],
			"RecipientReceiptMetadata": {
				"ReceiptStatus": "Finished",
				"ConfirmationMetadata": {
					"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
					"DateTimeTicks": 638747862162492383
				}
			},
			"ConfirmationMetadata": {
				"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
				"DateTimeTicks": 638562139140301838
			},
			"RecipientResponseStatus": "WaitingForRecipientSignature",
			"AmendmentRequestMetadata": {
				"AmendmentFlags": 0,
				"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
			},
			"EditingSettingId": "",
			"LockMode": "None",
			"SenderReceiptMetadata": {
				"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
			},
			"Version": "utd820_05_01_02_hyphen",
			"LastOuterDocflows": [],
			"DocflowStatus": {
				"PrimaryStatus": {
					"Severity": "Warning",
					"StatusText": "Ожидается подпись контрагента"
				},
				"PowerOfAttorneyGeneralStatus": {
					"Severity": "Success",
					"StatusNamedId": "IsValid",
					"StatusText": "Доверенность прошла проверку",
					"Errors": []
				}
			},
			"TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
			"HasUnreadOutOfWorkflowUniversalMessages": false,
			"Participants": [
				{
					"Participant": {
						"BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
						"DepartmentId": "00000000-0000-0000-0000-000000000000",
						"Role": "default:sender",
						"Flags": {
							"IsRoaming": false,
							"IsCrossborder": false,
							"IsForeign": false
						},
						"Type": "Sender",
						"IsCurrentBox": true
					},
					"RecipientResponseStatus": "RecipientResponseStatusUnknown"
				},
				{
					"Participant": {
						"BoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
						"DepartmentId": "00000000-0000-0000-0000-000000000000",
						"Role": "default:recipient",
						"Flags": {
							"IsRoaming": false,
							"IsCrossborder": false,
							"IsForeign": false
						},
						"Type": "Recipient",
						"IsCurrentBox": false
					},
					"RecipientResponseStatus": "WaitingForRecipientSignature"
				}
			],
			"MessageIdGuid": "e28ec2d1-3eeb-4fd0-851e-0da0c487249a",
			"EntityIdGuid": "341808f8-2cfb-48d8-a6fa-8bb26659f67d",
			"CreationTimestamp": "2024-07-10T13:11:53.6074526Z"
		},
		
	],
	"HasMoreResults": false
}

См. также

Методы для работы с документами:

Delete — отмечает указанный документ как удаленный
GetContent — возвращает XSD-схему документа
GetDocument (V3) — возвращает данные документа по указанному идентификатору
GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
GetDocumentsByMessageId — возвращает список документов из указанного сообщения
GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
MoveDocuments — перемещает документы в указанное подразделение организации
Restore — восстанавливает документ из удаленных