GetDocumentTypes (V3)
Различия версий метода GetDocumentTypes
| Версия | Особенности |
|---|---|
| V3 | Возвращает структуру DocumentTypeDescriptionV3 с датой перехода на универсальные сообщения |
| V2 | Возвращает структуру DocumentTypeDescriptionV2 |
Возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения.
GET /V3/GetDocumentTypes
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру GetDocumentTypesResponseV3 с описанием типов документов:
message GetDocumentTypesResponseV3 {
repeated DocumentTypeDescriptionV3 DocumentTypes = 1;
}
DocumentTypes— список типов документов, представленных структурой DocumentTypeDescriptionV3.
Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.
Примеры использования
Пример HTTP-запроса:
GET /V3/GetDocumentTypes?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
Так как количество типов документов в Диадоке большое, ниже приведена только часть ответа, описывающая счет-фактуру формата приказа №970.
{
"DocumentTypes": [
{
"Functions": [
{
"Name": "Invoice",
"Title": "Счет-фактура",
"SupportedDocflows": [
0
],
"RequiresFnsRegistration": true,
"Functions": [
{
"Name": "default",
"Versions": [
{
"Version": "utd970_05_03_01",
"SupportsContentPatching": true,
"SupportsEncrypting": true,
"SupportsPredefinedRecipientTitle": false,
"SupportsAmendmentRequest": true,
"Titles": [
{
"Index": 0,
"IsFormal": true,
"XsdUrl": "/GetContent?typeNamedId=Invoice&function=default&version=utd970_05_03_01&titleIndex=0&contentType=TitleXsd",
"UserDataXsdUrl": "/GetContent?typeNamedId=Invoice&function=default&version=utd970_05_03_01&titleIndex=0&contentType=UserContractXsd",
"SignerInfo": {
"SignerType": 3,
"ExtendedDocumentTitleType": 12,
"SignerUserDataXsdUrl": "/GetContent?typeNamedId=Invoice&function=default&version=utd970_05_03_01&titleIndex=0&contentType=SignerUserContractXsd"
},
"MetadataItems": [
{
"Id": "FileName",
"Type": 0,
"IsRequired": true,
"Source": 0
},
{
"Id": "DocumentNumber",
"Type": 0,
"IsRequired": true,
"Source": 0
},
{
"Id": "DocumentDate",
"Type": 3,
"IsRequired": true,
"Source": 0
},
{
"Id": "CurrencyCode",
"Type": 1,
"IsRequired": true,
"Source": 0
},
{
"Id": "TotalSum",
"Type": 2,
"IsRequired": false,
"Source": 0
},
{
"Id": "TotalVat",
"Type": 2,
"IsRequired": false,
"Source": 0
},
{
"Id": "TotalVat10",
"Type": 2,
"IsRequired": false,
"Source": 0
},
{
"Id": "TotalVat18",
"Type": 2,
"IsRequired": false,
"Source": 0
},
{
"Id": "TotalVat20",
"Type": 2,
"IsRequired": false,
"Source": 0
},
{
"Id": "Grounds",
"Type": 0,
"IsRequired": false,
"Source": 0
},
{
"Id": "SellerFnsParticipantId",
"Type": 0,
"IsRequired": true,
"Source": 0
},
{
"Id": "BuyerFnsParticipantId",
"Type": 0,
"IsRequired": true,
"Source": 0
},
{
"Id": "BuyerInn",
"Type": 0,
"IsRequired": false,
"Source": 0
},
{
"Id": "BuyerKpp",
"Type": 0,
"IsRequired": false,
"Source": 0
},
{
"Id": "PowerOfAttorneyIssuerInn",
"Type": 0,
"IsRequired": false,
"Source": 0
},
{
"Id": "SellerInn",
"Type": 0,
"IsRequired": false,
"Source": 0
}
],
"EncryptedMetadataItems": [
{
"Id": "DocumentNumber",
"Type": 0,
"IsRequired": true,
"Source": 1
},
{
"Id": "DocumentDate",
"Type": 3,
"IsRequired": true,
"Source": 1
},
{
"Id": "TotalSum",
"Type": 2,
"IsRequired": false,
"Source": 1
},
{
"Id": "TotalVat",
"Type": 2,
"IsRequired": false,
"Source": 1
},
{
"Id": "TotalVat10",
"Type": 2,
"IsRequired": false,
"Source": 1
},
{
"Id": "TotalVat18",
"Type": 2,
"IsRequired": false,
"Source": 1
},
{
"Id": "TotalVat20",
"Type": 2,
"IsRequired": false,
"Source": 1
},
{
"Id": "Grounds",
"Type": 0,
"IsRequired": false,
"Source": 1
},
{
"Id": "SellerFnsParticipantId",
"Type": 0,
"IsRequired": true,
"Source": 1
},
{
"Id": "BuyerFnsParticipantId",
"Type": 0,
"IsRequired": true,
"Source": 1
},
{
"Id": "BuyerInn",
"Type": 0,
"IsRequired": false,
"Source": 1
},
{
"Id": "BuyerKpp",
"Type": 0,
"IsRequired": false,
"Source": 1
},
{
"Id": "FileId",
"Type": 0,
"IsRequired": true,
"Source": 1
}
]
}
],
"IsActual": true,
"Workflows": [
{
"Id": 17,
"IsDefault": true
},
{
"Id": 10,
"IsDefault": false
},
{
"Id": 21,
"IsDefault": false
}
]
}
]
}
],
"UniversalMessagesStartDate": "04/01/2026 03:00:00"
}
]
}
]
}
См. также
Инструкции:
Методы для работы с документами:
- Delete — отмечает указанный документ как удаленный
- GetContent — возвращает XSD-схему документа
- GetDocument (V3) — возвращает данные документа по указанному идентификатору
- GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
- GetDocumentHistory — возвращает историю событий по указанному документу, шаблону или черновику
- GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
- GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
- GetDocumentsByMessageId — возвращает список документов из указанного сообщения
- GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
- GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
- MoveDocuments — перемещает документы в указанное подразделение организации
- Restore — восстанавливает документ из удаленных