DetectDocumentTitles
Определяет возможные типы указанного документа.
Метод можно использовать двумя способами:
POST-запрос с заполненным
Request Body,GET-запрос с параметром
nameOnShelf, если содержимое документа было загружено на полку методом ShelfUpload (V2).
- POST /DetectDocumentTitles
- Query Parameters:
boxId – идентификатор ящика организации.
- Request Body:
Тело запроса должно содержать бинарные данные документа.
- GET /DetectDocumentTitles
- Query Parameters:
boxId – идентификатор ящика организации.
nameOnShelf – имя файла на полке документов.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – не найден ящик с указанным идентификатором.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит список возможных типов документа, представленный структурой
DetectTitleResponse:message DetectTitleResponse { repeated DetectedDocumentTitle DocumentTitles = 1; } message DetectedDocumentTitle { required string TypeNamedId = 1; required string Function = 2; required string Version = 3; required int32 TitleIndex = 4; repeated Events.MetadataItem Metadata = 5; }
DocumentTitles— список возможных типов документа, представленных структуройDetectedDocumentTitleс полями:TypeNamedId— строковый идентификатор типа документа.Function— функция документа.Version— версия документа.TitleIndex— номер титула документа.Metadata— список метаданных документа, представленных структурой MetadataItem.
Метод анализирует содержимое документа и определяет, с какими значениями TypeNamedId можно отправить документ с таким содержимым:
Если таких типов несколько, то метод вернет массив с описанием всех этих типов. Так бывает в случае, когда у нескольких типов документов схожее содержимое. Например, накладную в формате приказа №970 можно отправить с типами
UniversalTransferDocumentиXmlTorg12. В этом случае для накладной в формате приказа №970 вернется массив с двумя типами документов.Если содержимому документа соответствует только один тип, то метод вернет массив с единственным элементом.
Примечание
Метод будет определять только те типы документов, которые доступны в текущей организации.
Примеры использования
Пример HTTP-запроса:
POST /DetectDocumentTitles?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json
Пример тела запроса:
<Файл ИдФайл="ON_NSCHFDOPPR_2BM-9677800047-967701000-202207281004154081709_2BM-9681265956-968101000-202207281000014689156_20250116_8c703486-75df-46f8-8f0a-959b09f807a9_1_1_0_0_1_00" ВерсФорм="5.03" ВерсПрог="Diadoc 1.0">
<Документ КНД="1115131" ВремИнфПр="18.13.16" ДатаИнфПр="16.01.2025" Функция="СЧФДОП" ПоФактХЖ="Документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг)" НаимДокОпр="Документ о передаче товаров (работ, услуг, имущественных прав)" УИД="UID" НаимЭконСубСост="Документ-НаимЭконСубСост" СоглСтрДопИнф="1111.2222.0000">
<СвСчФакт НомерДок="123" ДатаДок="01.02.2023" ИмяФайлИспрПрод="СвСчФакт-ИмяФайлИспрПрод" ИмяФайлИспрПок="СвСчФакт-ИмяФайлИспрПок">
<СвПрод ОКПО="0166273597" КодОПФ="12200" ПолнНаимОПФ="СвПрод-ПолнНаимОПФ" СтруктПодр="СвПрод-СтруктПодр" ИнфДляУчаст="СвПрод-ИнфДляУчаст" СокрНаим="СвПрод-СокрНаим">
<ИдСв>
<СвЮЛУч НаимОрг="СвЮЛУч-НаимОрг" ИННЮЛ="9103624367" КПП="187245452" />
</ИдСв>
<Адрес>
<АдрРФ КодРегион="72" НаимРегион="Тюменская область" Индекс="344249" Район="Тюмень" Город="Тюмень" НаселПункт="АдрРФ-НаселПункт" Улица="АдрРФ-Улица" Дом="АдрРФ-Дом" Корпус="АдрРФ-Корпус" Кварт="АдрРФ-Кварт" ИныеСвед="АдрРФ-ИныеСвед" />
</Адрес>
<БанкРекв НомерСчета="49634485849155">
<СвБанк НаимБанк="СИБИРСКИЙ БАНК ПАО СБЕРБАНК" БИК="045004641" КорСчет="30101810500000000641" />
</БанкРекв>
<Контакт ИнКонт="Контакт-ИнКонт">
<Тлф>8-343-123-4567</Тлф>
<ЭлПочта>email@google.com</ЭлПочта>
</Контакт>
</СвПрод>
<ГрузОт>
<ГрузОтпр ОКПО="76098674" КодОПФ="12000" ПолнНаимОПФ="ГрузОтпр-ПолнНаимОПФ" СтруктПодр="ГрузОтпр-СтруктПодр" ИнфДляУчаст="ГрузОтпр-ИнфДляУчаст" СокрНаим="ГрузОтпр-СокрНаим">
<ИдСв>
<СвИП ИННФЛ="753381367749" СвГосРегИП="СвИП-СвГосРегИП" ОГРНИП="421319982803452" ДатаОГРНИП="12.12.2012" ИныеСвед="СвИП-ИныеСвед">
<ФИО Фамилия="Иванов" Имя="Иван" Отчество="Иванович" />
</СвИП>
</ИдСв>
<Адрес>
<АдрГАР ИдНом="03510210-e5f3-4bc6-bbd2-24d7fe25b3ed" Индекс="450133">
<Регион>72</Регион>
<НаимРегион>Тюменская область</НаимРегион>
<МуниципРайон ВидКод="1" Наим="МуниципРайон-Наим" />
<ГородСелПоселен ВидКод="1" Наим="ГородСелПоселен-Наим" />
<НаселенПункт Вид="НаселенПункт" Наим="НаселенПункт-Наим" />
<ЭлПланСтруктур Тип="ЭлПланСтруктур" Наим="ЭлПланСтруктур-Наим" />
<ЭлУлДорСети Тип="ЭлУлДорСети" Наим="ЭлУлДорСети-Наим" />
<ЗемелУчасток>ЗемелУчасток</ЗемелУчасток>
<Здание Тип="Здание" Номер="Здание-Номер" />
<ПомещЗдания Тип="ПомещЗдания" Номер="ПомещЗдания-Номер" />
<ПомещКвартиры Тип="ПомещКвартиры" Номер="ПомещКвартиры-Номер" />
</АдрГАР>
</Адрес>
</ГрузОтпр>
</ГрузОт>
<ГрузПолуч ОКПО="18989253" КодОПФ="12000" ПолнНаимОПФ="ГрузПолуч-ПолнНаимОПФ" СтруктПодр="ГрузПолуч-СтруктПодр" ИнфДляУчаст="ГрузПолуч-ИнфДляУчаст" СокрНаим="ГрузПолуч-СокрНаим">
<ИдСв>
<СвФЛУч ИННФЛ="518191632595" ИдСтатЛ="1" ИныеСвед="СвФЛУч-ИныеСвед">
<ФИО Фамилия="Петров" Имя="Петр" Отчество="Петрович" />
</СвФЛУч>
</ИдСв>
<Адрес>
<АдрИнф КодСтр="112" НаимСтран="Беларусь" АдрТекст="АдрИнф-АдрТекст" />
</Адрес>
<БанкРекв НомерСчета="569712456874">
<СвБанк НаимБанк="ЗАО Сбербанк России, отделение на Московской 11" БИК="012345671" />
</БанкРекв>
</ГрузПолуч>
<СвПРД НомерПРД="СЧФ/123/456" ДатаПРД="01.02.2023" СуммаПРД="1000.00" />
<ДокПодтвОтгрНом РеквНаимДок="Документ о передаче товаров (работ, услуг, имущественных прав)" РеквНомерДок="123" РеквДатаДок="01.02.2023">
<РеквИдРекСост>
<ИННЮЛ>1978337389</ИННЮЛ>
</РеквИдРекСост>
</ДокПодтвОтгрНом>
<СвПокуп ОКПО="74047744" КодОПФ="12200" ПолнНаимОПФ="СвПокуп-ПолнНаимОПФ" СтруктПодр="СвПокуп-СтруктПодр" ИнфДляУчаст="СвПокуп-ИнфДляУчаст" СокрНаим="СвПокуп-СокрНаим">
<ИдСв>
<СвЮЛУч НаимОрг="СвЮЛУч-НаимОрг" ИННЮЛ="1234567894" КПП="667301001" />
</ИдСв>
<Адрес>
<АдрИнф КодСтр="112" НаимСтран="Беларусь" АдрТекст="АдрИнф-АдрТекст" />
</Адрес>
</СвПокуп>
<ДенИзм КодОКВ="643" НаимОКВ="Российский рубль" КурсВал="12" />
<ДопСвФХЖ1 ИдГосКон="1234567890123456789012345" СпОбстФСЧФДОП="12345">
<ВидОбяз КодВидОбяз="1" НаимВидОбяз="ВидОбяз-НаимВидОбяз" />
<ИнфПродЗаГоскКазн ДатаГосКонт="02.02.2022" НомерГосКонт="5" КодКазначПрод="0160" />
<СвФактор ОКПО="74047744" КодОПФ="12000" ПолнНаимОПФ="СвФактор-ПолнНаимОПФ" СтруктПодр="СвФактор-СтруктПодр" ИнфДляУчаст="СвФактор-ИнфДляУчаст" СокрНаим="СвФактор-СокрНаим">
<ИдСв>
<СвИП ИННФЛ="916363626153" ОГРНИП="421032906553286" ДатаОГРНИП="21.08.2019" ИныеСвед="СвИП-ИныеСвед">
<ФИО Фамилия="ФИО-Фамилия" Имя="ФИО-Имя" Отчество="ФИО-Отчество" />
</СвИП>
</ИдСв>
<Адрес>
<АдрРФ КодРегион="72" НаимРегион="Тюменская область" Индекс="344249" Район="Тюмень" Город="Тюмень" НаселПункт="АдрРФ-НаселПункт" Улица="АдрРФ-Улица" Дом="АдрРФ-Дом" Корпус="АдрРФ-Корпус" Кварт="АдрРФ-Кварт" ИныеСвед="АдрРФ-ИныеСвед" />
</Адрес>
</СвФактор>
<ОснУстДенТреб РеквНаимДок="ОснУстДенТреб-РеквНаимДок" РеквНомерДок="144" РеквДатаДок="04.04.2004">
<РеквИдРекСост>
<ИННФЛ>342265432525</ИННФЛ>
</РеквИдРекСост>
</ОснУстДенТреб>
<СопрДокФХЖ РеквНаимДок="СопрДокФХЖ-РеквНаимДок" РеквНомерДок="876" РеквДатаДок="05.05.2005">
<РеквИдРекСост>
<ДаннИно КодСтр="112" НаимСтран="Беларусь" Наим="ДаннИно-Наим" ИдСтат="ИГ" ИныеСвед="ДаннИно-ИныеСвед" Идентиф="ДаннИно-Идентиф" />
</РеквИдРекСост>
</СопрДокФХЖ>
</ДопСвФХЖ1>
<ИнфПолФХЖ1 ИдФайлИнфПол="5b0a8e80-1a7b-4194-a64d-60ca9f10dd82">
<ТекстИнф Идентиф="ТекстИнф-Идентиф" Значен="ТекстИнф-Идентиф" />
</ИнфПолФХЖ1>
</СвСчФакт>
<ТаблСчФакт>
<СведТов НомСтр="1" НалСт="20%" НаимТов="СведТов-НаимТов" ОКЕИ_Тов="113" НаимЕдИзм="м3" КолТов="16" ЦенаТов="200.00" СтТовБезНДС="654.00" СтТовУчНал="784.80">
<СвДТ КодПроисх="980" НомерДТ="123456" />
<ДопСведТов ПрТовРаб="5" ДопПризн="Приз" НадлОтп="102" СортТов="СортТов" СерияТов="ДопСведТов-СерияТов" ГТИН="10000057074365" КодВидТов="1111111111" КодВидПр="676">
<КрНаимСтрПр>Евросоюз</КрНаимСтрПр>
<СопрДокТов РеквНаимДок="СопрДокТов-РеквНаимДок" РеквНомерДок="144" РеквДатаДок="04.04.2004">
<РеквИдРекСост>
<ИННФЛ>342265432525</ИННФЛ>
</РеквИдРекСост>
</СопрДокТов>
<НалУчАморт АмГруппа="13" КодОКОФ="165" СрПолИспОС="23" ФактСрокИсп="100" />
<СумНалВосст>
<СумНал>550.00</СумНал>
</СумНалВосст>
<СведПрослеж НомТовПрослеж="10001000/010123/1234567/001" ЕдИзмПрослеж="778" КолВЕдПрослеж="30" СтТовБезНДСПрослеж="100" НаимЕдИзмПрослеж="упак" />
<НомСредИдентТов ИдентТрансУпак="НомСредИдентТов-ИдентТрансУпак" КолВедМарк="100" ПрПартМарк="111">
<КИЗ>НомСредИдентТов-КИЗ</КИЗ>
</НомСредИдентТов>
</ДопСведТов>
<Акциз>
<БезАкциз>без акциза</БезАкциз>
</Акциз>
<СумНал>
<СумНал>1000.00</СумНал>
</СумНал>
</СведТов>
<СведТов НомСтр="2" НалСт="20%" НаимТов="Product2 > 2.0 мм" ОКЕИ_Тов="778" НаимЕдИзм="упак" КолТов="114.100" ЦенаТов="516.67" СтТовБезНДС="58951.67" СтТовУчНал="70742.00">
<СвДТ КодПроисх="178" НомерДТ="555555" />
<ДопСведТов ПрТовРаб="5" ДопПризн="ДопП" НадлОтп="505" ХарактерТов="ДопСведТов-ХарактерТов" СортТов="СортТов" СерияТов="ДопСведТов-СерияТов" АртикулТов="ДопСведТов-АртикулТов" КодТов="ДопСведТов-КодТов" ГТИН="10000057074365" КодВидТов="1111111111">
<КрНаимСтрПр>Конго</КрНаимСтрПр>
<НалУчАморт АмГруппа="12" КодОКОФ="165" СрПолИспОС="234" ФактСрокИсп="100" />
<СумНалВосст>
<СумНал>1345.00</СумНал>
</СумНалВосст>
</ДопСведТов>
<Акциз>
<БезАкциз>без акциза</БезАкциз>
</Акциз>
<СумНал>
<СумНал>1000.00</СумНал>
</СумНал>
</СведТов>
<ВсегоОпл СтТовБезНДСВсего="8965.00" СтТовУчНалВсего="10000.00">
<СумНалВсего>
<СумНал>456.00</СумНал>
</СумНалВсего>
</ВсегоОпл>
</ТаблСчФакт>
<СвПродПер>
<СвПер СодОпер="СвПер-СодОпер" ВидОпер="СвПер-ВидОпер" ДатаПер="15.02.2024" ДатаНачПер="16.02.2024" ДатаОконПер="16.02.2024">
<ОснПер РеквНаимДок="ОснПер-РеквНаимДок" РеквНомерДок="567" РеквДатаДок="14.02.2024">
<РеквИдРекСост>
<ИННФЛ>144647873819</ИННФЛ>
</РеквИдРекСост>
</ОснПер>
<СвЛицПер>
<ИнЛицо>
<ПредОргПер Должность="ПредОргПер-Должность" НаимОргПер="ПредОргПер-НаимОргПер" ИныеСвед="ПредОргПер-ИныеСвед">
<ОснДоверОргПер РеквНаимДок="ОснДоверОргПер-РеквНаимДок" РеквНомерДок="098" РеквДатаДок="03.02.2024">
<РеквИдРекСост>
<ИННЮЛ>4620212891</ИННЮЛ>
</РеквИдРекСост>
</ОснДоверОргПер>
<ОснПолнПредПер РеквНаимДок="ОснПолнПредПер-РеквНаимДок" РеквНомерДок="098" РеквДатаДок="03.02.2024">
<РеквИдРекСост>
<ИННЮЛ>4620212891</ИННЮЛ>
</РеквИдРекСост>
</ОснПолнПредПер>
<ФИО Фамилия="Иванов" Имя="Иван" Отчество="Иванович" />
</ПредОргПер>
</ИнЛицо>
</СвЛицПер>
<СвПерВещи>
<ДокПерВещ РеквНаимДок="ДокПерВещ-РеквНаимДок" РеквНомерДок="098" РеквДатаДок="03.02.2024">
<РеквИдРекСост>
<ИННЮЛ>4620212891</ИННЮЛ>
</РеквИдРекСост>
</ДокПерВещ>
</СвПерВещи>
</СвПер>
<ИнфПолФХЖ3 ИдФайлИнфПол="9c3adc2b-a085-4acd-af8c-3494290d782c">
<ТекстИнф Идентиф="Идентиф1в" Значен="Значен1в" />
<ТекстИнф Идентиф="Идентиф2в" Значен="Значен2в" />
</ИнфПолФХЖ3>
</СвПродПер>
<Подписант СпосПодтПолном="6" Должн="Должность">
<ФИО Фамилия="Иванов" Имя="Иван" Отчество="Иванович" />
</Подписант>
<ОснДоверОргСост РеквНаимДок="ОснДоверОргСост-РеквНаимДок" РеквНомерДок="123" РеквДатаДок="01.02.2023">
<РеквИдРекСост>
<ДаннИно КодСтр="112" НаимСтран="Беларусь" Наим="ДаннИно-Наим" ИдСтат="ИГ" ИныеСвед="ДаннИно-ИныеСвед" Идентиф="ДаннИно-Идентиф" />
</РеквИдРекСост>
</ОснДоверОргСост>
</Документ>
</Файл>
Пример тела ответа:
{
"DocumentTitles": [
{
"Function": "СЧФДОП",
"Metadata": [
{
"Key": "FileName",
"Value": "ON_NSCHFDOPPR_2BM-9677800047-967701000-202207281004154081709_2BM-9681265956-968101000-202207281000014689156_20250116_8c703486-75df-46f8-8f0a-959b09f807a9_1_1_0_0_1_00.xml"
},
{
"Key": "DocumentNumber",
"Value": "123"
},
{
"Key": "DocumentDate",
"Value": "01.02.2023"
},
{
"Key": "CurrencyCode",
"Value": "643"
},
{
"Key": "TotalSum",
"Value": "10000.00"
},
{
"Key": "TotalVat",
"Value": "456.00"
},
{
"Key": "TotalVat10",
"Value": "0"
},
{
"Key": "TotalVat18",
"Value": "0"
},
{
"Key": "TotalVat20",
"Value": "2000.00"
},
{
"Key": "Grounds",
"Value": "ОснПер-РеквНаимДок №567 от 14.02.2024"
},
{
"Key": "SellerFnsParticipantId",
"Value": "2BM-9681265956-968101000-202207281000014689156"
},
{
"Key": "BuyerFnsParticipantId",
"Value": "2BM-9677800047-967701000-202207281004154081709"
},
{
"Key": "BuyerInn",
"Value": "1234567894"
},
{
"Key": "BuyerKpp",
"Value": "667301001"
},
{
"Key": "PowerOfAttorneyIssuerInn",
"Value": "9103624367"
},
{
"Key": "SellerInn",
"Value": "9103624367"
}
],
"TitleIndex": 0,
"TypeNamedId": "UniversalTransferDocument",
"Version": "utd970_05_03_01"
}
]
}
См. также
- Инструкции:
- Методы для работы с титулом:
DetectDocumentTitles — определяет возможные типы указанного документа
GenerateTitleXml — генерирует файл титула любого формализованного документа
ParseTitleXml — парсит файл титула любого формализованного документа