GetDocumentTypes (V3)
Возвращает список типов документов, доступных в ящике.
- GET /V3/GetDocumentTypes
- Query Parameters:
boxId – идентификатор ящика организации.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит структуру
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
Content-Type: application/json charset=utf-8
Пример тела ответа:
Так как количество типов документов в Диадоке большое, ниже приведена только часть ответа, описывающая счет-фактуру формата приказа №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) — возвращает данные документа по указанному идентификатору
GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
GetDocumentsByMessageId — возвращает список документов из указанного сообщения
GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике
MoveDocuments — перемещает документы в указанное подразделение организации
Restore — восстанавливает документ из удаленных
- Предыдущие версии метода: