Перейти к основному содержимому

GetDocuments (V4)

Возвращает список документов, соответствующих заданным параметрам.

POST /V4/GetDocuments

Параметры запроса

  • boxId — идентификатор ящика организации, в котором осуществляется поиск документов, в формате GUID.

Заголовки запроса

Тело запроса

Тело запроса должно содержать запрос на получение документов по заданным параметрам GetDocumentsV4Request.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 404 — не найден ящик с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит список документов, соответствующих указанным параметрам, представленный структурой DocumentList.

В ответе вернутся только те документы, к которым у пользователя есть доступ.

С помощью этого метода нельзя получить шаблон или черновик. О том, как получить шаблон, написано в разделе Получение шаблонов и событий, а получение черновика — на странице Работа с черновиками.

Элементы в списке DocumentList.Documents идут в порядке возрастания соответствующих меток времени, хранящихся в полях с именем Document.[...]TimestampTicks:

Содержимое документов не включается в ответ метода: поле Document.Content.Data документов в ответе будет иметь значение null. Получить содержимое документа можно с помощью метода GetEntityContent (V4).

Список документов Documents в ответе DocumentList может содержать не больше 100 элементов. Поэтому:

  • Если найденных документов меньше 100, то метод вернет их полностью.

  • Если найденных документов больше 100, то в ответе Documents вернутся только первые 100 элементов. При этом параметр TotalCount будет содержать общее количество найденных документов.

    В этом случае получить весь список найденных документов можно постранично. Для этого вызывайте метод GetDocuments с теми же параметрами запроса и с указанием параметра AfterIndexKey в теле запроса до тех пор, пока список документов не будет вычитан полностью. В качестве параметра AfterIndexKey нужно указывать ключ документа из поля Document.IndexKey.

В зависимости от значения параметра AfterIndexKey метод работает следующим образом:

  • Если в запросе отсутствует параметр AfterIndexKey, то метод вернет начало списка найденных документов.
  • Если в запросе указан параметр AfterIndexKey, то метод вернет список документов, следующих за документом с ключом AfterIndexKey; документ с ключом AfterIndexKey в этот список не попадает.

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

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

POST /V4/GetDocuments?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Пример тела запроса:

{
"CounteragentBoxIds": ["72c3b5bf-3a9f-4fb5-a3ef-112cb2b3a8dc", "7e78d486-a9d8-49ea-ba46-62ae88fff59e"],
"FromDepartmentIds": ["00000000-0000-0000-0000-000000000000"],
"ToDepartmentIds": ["00000000-0000-0000-0000-000000000000"],
"DocumentTypeNamedIds": ["UniversalTransferDocument", "Nonformalized"],
"DocumentCategory": "Outgoing",
"DocumentStatuses": ["WaitingForRecipientSignature", "WithRecipientSignature", "WaitingForReceipt"],
"FromDocumentDate": "01.12.2025",
"ToDocumentDate": "01.03.2026",
"TotalSums": ["150.00","1002"],
"ToTotalSum": "150.00",
"CustomData": [
{
"Key": "Key",
"Value": "Value"
},
],
"SortDirection": "Descending",
"Count": "100"
}

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

{
"TotalCount": 1,
"Documents": [
{
"IndexKey": "021086E2A08BC2DC9AEF08221209484530ABC7DDEA42119FB78730A4F622362A12093CBB9376C905184711A43A7EAD18A48030",
"MessageId": "ab304548-ddc7-42ea-9fb7-8730a4f62236",
"EntityId": "7693bb3c-05c9-4718-a43a-7ead18a48030",
"CreationTimestampTicks": 639065725178753286,
"CounteragentBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DocumentType": "UniversalTransferDocument",
"InitialDocumentIds": [],
"SubordinateDocumentIds": [],
"Content": {
"Size": 2305
},
"FileName": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20260213_c3194e50-8653-4ca1-884c-49fb713e154d_0_0_0_0_0_00.xml",
"DocumentDate": "05.02.2026",
"DocumentNumber": "5",
"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": 639065725178753286,
"DeliveryTimestampTicks": 639065725181475491,
"ForwardDocumentEvents": [],
"RoamingNotificationStatus": "RoamingNotificationStatusNone",
"HasCustomPrintForm": false,
"CustomData": [
{
"Key": "Key",
"Value": "Value"
},
],
"DocumentDirection": "Outbound",
"LastModificationTimestampTicks": 639065725181475491,
"IsEncryptedContent": false,
"SenderSignatureStatus": "SenderSignatureCheckedAndValid",
"IsRead": true,
"PacketIsLocked": false,
"UniversalTransferDocumentMetadata": {
"DocumentStatus": "OutboundWaitingForRecipientSignature",
"Total": "1.00",
"Vat": "",
"Grounds": "",
"DocumentFunction": "ДОП",
"Currency": 643,
"ConfirmationDateTimeTicks": 639065833178753286,
"InvoiceAmendmentFlags": 0
},
"ProxySignatureStatus": "ProxySignatureStatusNone",
"TypeNamedId": "UniversalTransferDocument",
"Function": "ДОП",
"WorkflowId": 19,
"Title": "УПД №5 от 05.02.26",
"Metadata": [
{
"Key": "FileName",
"Value": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20260213_c3194e50-8653-4ca1-884c-49fb713e154d_0_0_0_0_0_00.xml"
},
{
"Key": "DocumentNumber",
"Value": "5"
},
{
"Key": "DocumentDate",
"Value": "05.02.2026"
},
{
"Key": "TotalSum",
"Value": "150.00"
},
{
"Key": "CurrencyCode",
"Value": "643"
}
],
"RecipientReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"DateTimeTicks": 0
}
},
"ConfirmationMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
"DateTimeTicks": 639065725181475491
},
"RecipientResponseStatus": "WaitingForRecipientSignature",
"AmendmentRequestMetadata": {
"AmendmentFlags": 0,
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"EditingSettingId": "",
"LockMode": "None",
"SenderReceiptMetadata": {
"ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
},
"Version": "utd970_05_03_01",
"LastOuterDocflows": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Ожидается подпись контрагента"
},
"PowerOfAttorneyGeneralStatus": {
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"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": "ab304548-ddc7-42ea-9fb7-8730a4f62236",
"EntityIdGuid": "7693bb3c-05c9-4718-a43a-7ead18a48030",
"CreationTimestamp": "2026-02-13T09:41:57.8753286Z"
}
],
"HasMoreResults": false
}

См. также

Инструкции:

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

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

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года