POST https://id.tbank.ru/userinfo/userinfo
\n\n\n#### Пример\
\ ответа\n\n {`\"email\": \"tbank@mail.ru\", \"email_verified\": false,\
\ \"family_name\": \"Иванов\", \"birthdate\": \"2000-01-01\", \"sub\": \"923d4812-148c-45v4-a56b-eed15cdd2857\"\
, \"name\": \"Иванов Олег\", \"gender\": \"male\", \"phone_number\": \"+79998887766\"\
, \"phone_number_verified\" : true, \"middle_name\": \"Юрьевич\", \"given_name\"\
: \"Олег\"`}
"
x-parent-tag: "T-ID"
- name: "T-ID. Делегированная идентификация"
description: "Методы для проверки информации о физическом лице по 115 ФЗ."
x-parent-tag: "T-ID"
- name: "Счета и выписки"
description: "Методы для получения выписок и информации по расчетным и инвестици\
онным счетам организаций."
- name: "Платежи"
description: "Методы для совершения платежей, создания черновиков, платежных пор\
учений и платежей через СБП."
- name: "Зарплатный проект"
description: "Методы для перевода денег сотрудникам и выпуска зарплатных карт."
- name: "Выплаты самозанятым"
description: "Методы для работы с выплатами самозанятым — добавление самозанятых\
\ по реквизитам, создание черновиков анкет и платежных реестров, подписание и\
\ оплата реестров, получение информации о самозанятых.\n\nПеред интеграцией ре\
комендуем изучить сценарии использования методов и последовательность их вызов\
а. Подробнее."
- name: "Самозанятые"
description: "Методы для работы с самозанятыми — привязка самозанятых к Т-Банку\
, проверка статуса, формирование чеков и выполнение других операций от имени с\
амозанятого в налоговой.\n\nВызовы методов [Аннулировать доход самозанятого](/docs/api/post-api-v-1-self-employed-taxpayers-inn-receipts-receiptid-cancel),\
\ [Зарегистрировать доход самозанятого](/docs/api/post-api-v-1-self-employed-taxpayers-inn-receipts)\
\ и [Отправить запрос на подключение самозанятого к Т-Банку](/docs/api/post-api-v-1-self-employed-taxpayers-inn-bind)\
\ платные. Чтобы ознакомиться с тарифами, напишите на [smz_fns_team@tbank.ru](mailto:smz_fns_team@tbank.ru)."
- name: "Выставление счетов"
description: "Методы для работы с выставленными счетами."
- name: "Номинальные счета"
description: "Методы для работы с номинальными счетами."
- name: "Безакцептные списания"
description: "Методы для работы с безакцептными списаниями."
- name: "Специальные счета"
description: "Методы для работы со специальными счетами — тендерными, номинальны\
ми и так далее: получение информации по картотекам, блокировкам, картотекам ЭТ\
П (электронная торговая площадка) и списаниям в бюджет."
- name: "Безопасная сделка"
description: "Методы для поддержания процесса безопасной сделки. Доступно только\
\ в Self-сценарии."
- name: "Торговый эквайринг"
description: "Методы для получения подробной информации по операциям в терминале\
.\n\n\nТорговый эквайринг — услуга банка по приему безналичной оплаты в торгов\
ой точке."
- name: "Проверка контрагентов"
description: "Методы для получения информации о любых юридических лицах и ИП, ко\
гда-либо существовавших в России, по данным из открытых источников — ФНС, СПАР\
К, Госзакупки, ФССП.\n\nЕсли данные неточные, напишите в поддержку Т-Бизнеса."
- name: "Бизнес-карты"
description: "Методы для получения данных по картам компании и установки по ним\
\ лимитов."
- name: "Удаленная идентификация сотрудников"
description: "Методы предназначены для проведения удаленной идентификации сотруд\
ников компании-клиента Т-Бизнеса — без очной встречи с представителем банка.\n\
\n\nДля проведения удаленной идентификации создается заявка, к которой прикреп\
ляются необходимые копии документов — например, скан паспорта.\nПосле этого по\
дготовленную заявку можно использовать в целевом действии,\nдля которого нужен\
\ идентифицированный сотрудник — например, выпуск для него виртуальной бизнес\
-карты.\n\n\nУдаленная идентификация не имеет ценности сама по себе, поэтому з\
аявка запускается в работу в рамках целевого действия."
- name: "Рейтинги продуктов"
description: "Методы для пагинированного получения рейтингов на товары."
- name: "Корзина. Работа с заказом"
description: "Методы для работы с заказами в системе Корзина."
- name: "Кредитные продукты"
description: "Методы для работы с универсальным кредитным адаптером банка."
- name: "Интернет-эквайринг. Диспуты"
description: "Методы для обмена информацией по оспариваемым операциям между банк\
ом и компанией.\n\nДиспут (опротестование) — процесс оспаривания операции клие\
нтом или банком в соответствии с [порядком проведения претензионной работы](https://acdn.tinkoff.ru/static/documents/18e1262d-051a-4e99-b5e1-b8879b4437cc.pdf)."
- name: "Партнерская доставка"
description: "Методы для создания задания представителю Т-Банка: удостоверить ли\
чность, сделать фотографии документов, провести опрос, доставить и активироват\
ь продукты.\n\n\nДоступно только для прямой интеграции.\n\n\nЧтобы подключитьс\
я к линии доставки Т-Банка, напишите на openapi@tinkoff.ru."
- name: "Декларации 3-НДФЛ"
description: "Методы для получения данных, которые нужны партнеру для формирован\
ия налоговой декларации по форме 3-НДФЛ. Для работы с методами нужен уникальны\
й идентификатор заявки — `taxRequestId` (UUID)."
- name: "T-ID"
description: "T-ID — единая точка авторизации для всего Т-Банка, которая упрощае\
т пользователям вход на ваш сайт и в приложение."
- name: "Бенефициары и реквизиты"
description: "Методы для работы с бенефициарами и реквизитами бенефициаров. Дост\
упно для Self-сценария. \n\n\nВажно:\n* Если бенефициар участвует в нескольких\
\ сделках, его данные нужно добавить только 1 раз\n — даже если сделки соверша\
ются в рамках нескольких номинальных счетов.\n* Первые указанные реквизиты бен\
ефициара считаются реквизитами по умолчанию и\n подставляются в сделках автома\
тически.\n* Если вам нужно использовать другие реквизиты, создайте новые и ука\
жите ID этих реквизитов\n у реципиента на этапе сделки.\nЧтобы установить эти\
\ реквизиты как реквизиты по умолчанию, используйте метод\n [Установить банков\
ские реквизиты бенефициара по умолчанию](/docs/api/post-api-v-1-nominal-accounts-beneficiaries-beneficiaryid-bank-details-bankdetailsid-set-default).\n\
\ Если владелец денежных средств меняется, но их нужно оставить на номинальном\
\n счете, вы можете перевести денежные средства на виртуальный счет. Для этого\
\ используйте метод [Создать реципиента в этапе сделки](/docs/api/post-api-v-1-nominal-accounts-deals-dealid-steps-stepid-recipients):\n\
\ в параметре `keepOnVirtualAccount` передайте `true`.\n\n\n\n ⚠️ Если вы испо\
льзуете управление расчетами через номинальные счета, пользоваться другими кан\
алами вывода средств с номинальных счетов — например, личный кабинет, метод пл\
атежа — нельзя.\n Если использовать другие способы, биллинг с учетом средств н\
а виртуальных счетах будет работать некорректно.\n"
x-parent-tag: "Номинальные счета"
- name: "Биллинг"
description: "Методы для работы с номинальными счетами — идентификация пополнени\
й, просмотр остатков и холдов на виртуальных счетах бенефициаров, контроль вып\
олнения операций по сделкам и выплаты с виртуальных счетов на реальные счета б\
ез создания сделок.\n\nОграничение на использование методов — 10 запросов в се\
кунду.\n\nЕсли вы управляете расчетами через номинальные счета, пользоваться д\
ругими каналами вывода средств с номинальных счетов — например, личный кабинет\
\ или метод платежа — нельзя. Если использовать другие способы, биллинг с учет\
ом средств на виртуальных счетах будет работать некорректно."
x-parent-tag: "Номинальные счета"
- name: "Депоненты и реципиенты"
description: "Методы для управления отправителями — депонентами (deponents) и по\
лучателями денежных средств — реципиентами (recipients). Доступно для Self-сце\
нария. \n\n\nВажно:\n* В рамках сделки и этапа может быть несколько отправител\
ей (deponents) и несколько получателей (recipients).\n* Прикрепить одного и то\
го же бенефициара в рамках одного этапа как отправителя (deponent) больше\nодн\
ого раза не получится.\n* Прикрепить одного и того же бенефициара в рамках одн\
ого этапа как получателя (recipient) больше\nодного раза — можно.\n* Идентифик\
ация получателя происходит по ID реципиента (`recipientId`), отправителя — по\
\ ID бенефициара (`beneficiaryId`).\n\n\n\n ⚠️ Если вы используете управление\
\ расчетами через номинальные счета, пользоваться другими каналами вывода сред\
ств с номинальных счетов — например, личный кабинет, метод платежа — нельзя.\n\
\ Если использовать другие способы, биллинг с учетом средств на виртуальных сч\
етах будет работать некорректно.\n"
x-parent-tag: "Номинальные счета"
- name: "Налоговые консультации"
description: "Методы для получения данных, которые нужны партнеру для предоставл\
ения налоговой консультации по вопросу клиента. Для работы с методами нужен ун\
икальный идентификатор заявки — `taxRequestId` (UUID)."
- name: "Партнерские методы для работы с заявкой на выдачу кредита наличными"
description: "Методы для работы с заявкой на на выдачу кредита наличными."
- name: "Партнерские методы для работы с заявкой на покупку в кредит (Prod)"
description: "Методы для работы с заявкой на покупку в кредит в точках продаж."
- name: "Партнерские методы для работы с заявкой на покупку в кредит (Test)"
description: "Демо-методы для тестирования работы с заявкой на пос-кредит в точк\
ах продаж."
- name: "Платежные требования"
description: "Методы для работы с платежными требованиями — создание, получение\
\ списка платежных требований и деталей, отзыв.\n\nПлатежное требование — это\
\ платежный документ, по которому происходит списание денежных средств по треб\
ованию получателя со счета плательщика, в том числе безакцептное."
x-parent-tag: "Безакцептные списания"
- name: "Правила"
description: "Методы для работы с платежными правилами. Доступно для прямой инте\
грации.\n\nПлатежное правило — это принцип, по которому происходит автоматичес\
кое списание денежных средств с плательщика."
x-parent-tag: "Безакцептные списания"
- name: "Соглашения"
description: "Методы для работы с соглашениями о безакцептном списании. Доступно\
\ для прямой интеграции.\n\nБезакцептное списание — это списание денег со счет\
а плательщика без его дополнительного подтверждения в рамках соглашения о зара\
нее данном акцепте.\n\nЕсли вы хотите использовать безакцептные списания со сч\
етов контрагентов, перед началом работы с методами убедитесь, что вы согласова\
ли шаблон соглашения с банком и выбрали счет, на который хотите получать деньг\
и. С этим поможет менеджер в чате.\n\nСоглашение о безакцептном списании — это\
\ юридическое основание для безакцептного списания. В соглашении плательщик за\
ранее дает свое согласие на последующие списания с его счета без дополнительно\
го подтверждения. Соглашение можно заключить как по стандартному шаблону, кото\
рый предлагает банк, так и изменить шаблон под потребности получателя денег. П\
олучатель денег может встроить в свой интерфейс функционал для быстрого подпис\
ания контрагентами своего шаблона соглашения.\n\nЕсли у вас есть вопросы или п\
редложения, напишите на [non_acceptance_debiting@tbank.ru](mailto:non_acceptance_debiting@tbank.ru)."
x-parent-tag: "Безакцептные списания"
- name: "Управление сделками"
description: "Методы для работы с номинальными счетами — управление сделками (CRUD).\n\
\nОграничение на использование методов — 10 запросов в секунду.\n\n[Пример раб\
оты со сделками и этапами](https://business.t-static.ru/static/images/opensme/nominal-accounts/deal-flow.svg)\n\
\nЕсли вы управляете расчетами через номинальные счета, пользоваться другими к\
аналами вывода средств с номинальных счетов — например, личный кабинет или мет\
од платежа — нельзя. Если использовать другие способы, биллинг с учетом средст\
в на виртуальных счетах будет работать некорректно."
x-parent-tag: "Номинальные счета"
- name: "Управление этапами сделок"
description: "Методы для работы с номинальными счетами — управление этапами сдел\
ок (CRUD).\n\nОграничение на использование методов — 10 запросов в секунду.\n\n\
[Пример работы со сделками и этапами](https://business.t-static.ru/static/images/opensme/nominal-accounts/deal-flow.svg)\n\
\nВажно:\n\n* Если платеж не может быть выплачен, статус этапа переходит в `PAYMENT_FAILED`.\
\ На этом статусе этапа можно изменить реквизиты получателя денежных средств —\
\ реципиента — через метод [Обновить банковские реквизиты у реципиента в этапе\
\ сделки](/docs/api/post-api-v-1-nominal-accounts-deals-dealid-steps-stepid-recipients-recipientid-update-bank-details).\n\
\n* Отменить эту сделку нельзя — при попытке совершения платежа на реальный сч\
ет мы считаем, что деньги уже принадлежат получателю и должны быть выплачены е\
му в каком-либо виде. Если деньги должны остаться на номинальном счете, в мето\
де [Создать реципиента на этапе сделки](/docs/api/post-api-v-1-nominal-accounts-deals-dealid-steps-stepid-recipients)\
\ в реквизитах реципиента передайте `keepOnVirtualAccount = true`.\n\nЕсли вы\
\ управляете расчетами через номинальные счета, пользоваться другими каналами\
\ вывода средств с номинальных счетов — например, личный кабинет или метод пла\
тежа — нельзя. Если использовать другие способы, биллинг с учетом средств на в\
иртуальных счетах будет работать некорректно."
x-parent-tag: "Номинальные счета"
paths:
/api/clfm/create:
post:
tags:
- "Партнерские методы для работы с заявкой на выдачу кредита наличными"
summary: "Получить данные о клиенте и создать заявку"
description: "Синхронный метод для предоставления данных о клиенте — по этим\
\ данным будет создана\nзаявка. \n\nВ ответе возвращаются ссылка и идентиф\
икатор заявки — по этой ссылке партнер направляет клиента и запускает проц\
есс \nвыдачи с нашей стороны.\n"
operationId: "postApiV1ClfmAppCreate"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/json:
schema:
type: "object"
properties:
fio:
type: "object"
properties:
lastName:
type: "string"
description: "Фамилия клиента."
format: "string"
firstName:
type: "string"
description: "Имя клиента."
format: "string"
middleName:
type: "string"
description: "Отчество клиента."
format: "string"
description: "ФИО клиента."
birthDate:
type: "string"
description: "Дата рождения клиента в формате `yyyy-MM-dd`."
format: "date"
phone:
pattern: "\\+\\d*"
type: "string"
description: "Номер телефона клиента в международном формате."
format: "string"
example: "+79631111112"
email:
type: "string"
description: "Электронная почта клиента."
format: "email"
required: true
responses:
"200":
description: "Заявка создана"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "id"
- "url"
type: "object"
properties:
id:
type: "string"
description: "Уникальный идентификатор созданной заявки."
format: "string"
url:
type: "string"
description: "Ссылка на созданную заявку. По ней нужно направи\
ть клиента, чтобы начать процесс выдачи."
format: "url"
description: "Успешный ответ"
example:
id: "02xHUBXDYZSMwIlgJhYYz8CLM"
url: "https://forma.tbank.ru/cashloan/applications/02xHUBXDYZSMwIlgJhYYz8CLM"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
INVALID_JSON:
summary: "Некорректный JSON"
value:
errorId: "8f8cb741-a07d-41ea-b2b0-2617937f54e7"
errorMessage: "Получен некорректный JSON."
errorCode: "INVALID_JSON"
INVALID_PHONE:
summary: "Неверный формат номера телефона"
value:
errorId: "c584b8c6-0e78-49e2-8647-69a2751dd035"
errorMessage: "Ошибка валидации. Неверный формат номера телефо\
на."
errorCode: "INVALID_PHONE"
errorDetails:
phone: "Неверный формат номера телефона. Используйте междуна\
родный формат."
INVALID_BIRTHDATE:
summary: "Неверный формат даты рождения"
value:
errorId: "0f79caf4-06d0-4c9b-89ad-55f3b4ba4ba0"
errorMessage: "Ошибка валидации. Неверный формат даты рождения\
."
errorCode: "INVALID_BIRTHDATE"
errorDetails:
birtDate: "Неверный формат даты рождения. Используйте `yyyy-MM-dd`."
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/clfm/demo:
post:
tags:
- "Партнерские методы для работы с заявкой на выдачу кредита наличными"
summary: "Получить данные о клиенте и создать демо-заявку"
description: " Синхронный метод для проверки корректности интеграции, аналог\
ичен методу Получить да\
нные о клиенте и создать заявку. Создает «прозрачную» для продуктового\
\ процесса заявку."
operationId: "postApiV1ClfmAppDemo"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/json:
schema:
type: "object"
properties:
fio:
type: "object"
properties:
lastName:
type: "string"
description: "Фамилия клиента."
format: "string"
firstName:
type: "string"
description: "Имя клиента."
format: "string"
middleName:
type: "string"
description: "Отчество клиента."
format: "string"
description: "ФИО клиента."
birthDate:
type: "string"
description: "Дата рождения клиента в формате `yyyy-MM-dd`."
format: "date"
phone:
pattern: "\\+\\d*"
type: "string"
description: "Номер телефона клиента в международном формате."
format: "string"
example: "+79631111112"
email:
type: "string"
description: "Электронная почта клиента."
format: "email"
required: true
responses:
"200":
description: "Заявка создана"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "id"
- "url"
type: "object"
properties:
id:
type: "string"
description: "Уникальный идентификатор созданной заявки."
format: "string"
url:
type: "string"
description: "Ссылка на созданную заявку. По ней нужно направи\
ть клиента, чтобы начать процесс выдачи."
format: "url"
description: "Успешный ответ"
example:
id: "02xHUBXDYZSMwIlgJhYYz8CLM"
url: "https://forma.tbank.ru/cashloan/applications/02xHUBXDYZSMwIlgJhYYz8CLM"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
INVALID_JSON:
summary: "Некорректный JSON"
value:
errorId: "8f8cb741-a07d-41ea-b2b0-2617937f54e7"
errorMessage: "Получен некорректный JSON."
errorCode: "INVALID_JSON"
INVALID_PHONE:
summary: "Неверный формат номера телефона"
value:
errorId: "c584b8c6-0e78-49e2-8647-69a2751dd035"
errorMessage: "Ошибка валидации. Неверный формат номера телефо\
на."
errorCode: "INVALID_PHONE"
errorDetails:
phone: "Неверный формат номера телефона. Используйте междуна\
родный формат."
INVALID_BIRTHDATE:
summary: "Неверный формат даты рождения"
value:
errorId: "0f79caf4-06d0-4c9b-89ad-55f3b4ba4ba0"
errorMessage: "Ошибка валидации. Неверный формат даты рождения\
."
errorCode: "INVALID_BIRTHDATE"
errorDetails:
birtDate: "Неверный формат даты рождения. Используйте `yyyy-MM-dd`."
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/offline/partners/v1/create:
post:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Prod)"
summary: "Создать новую заявку"
description: "Метод создает кредитную заявку в системе Т-Банк Кредит Брокер\
.\n\nВ ответе возвращается ссылка с ссылочной авторизацией для продолжения\
\ заявочного процесса внутри личного кабинета агента."
operationId: "createTcbAppV1"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/json:
schema:
required:
- "orderNumber"
- "type"
type: "object"
properties:
agentLogin:
pattern: "^[9]{1}[0-9]{9}$"
type: "string"
description: "Номер телефона агента, под которым он заведен в TCB."
orderNumber:
maxLength: 50
minLength: 1
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
order:
required:
- "items"
type: "object"
properties:
firstPayment:
minimum: 0
type: "integer"
description: "Первоначальный взнос."
format: "int32"
items:
maxItems: 99
minItems: 1
type: "array"
items:
required:
- "name"
- "price"
- "quantity"
type: "object"
properties:
name:
maxLength: 255
minLength: 1
type: "string"
description: "Наименование товара."
format: "string"
quantity:
minimum: 0
type: "integer"
description: "Количество товара."
format: "int32"
price:
minimum: 0
type: "number"
description: "Стоимость 1 единицы товара."
format: "double"
externalId:
minLength: 1
type: "string"
description: "Идентификатор товара."
format: "string"
description: "Товары в корзине."
description: "Модель заказа клиента в запросе создания заявки."
type:
required:
- "isCreditCard"
- "isPos"
type: "object"
properties:
isPos:
type: "boolean"
description: "Флаг отправки заявки на POS-кредит."
format: "boolean"
isCreditCard:
type: "boolean"
description: "Флаг отправки заявки на кредитную карту."
format: "boolean"
description: "Объект с информацией по запрашиваемым продуктам."
isCallSigning:
type: "boolean"
description: "Флаг телефонного заполнения. По умолчанию — `false`."
format: "boolean"
isOnlyCredit:
type: "boolean"
description: "Флаг отключения рассрочек, возможно оформление тол\
ько кредитов. По умолчанию — `false`."
format: "boolean"
values:
type: "object"
properties:
contact:
type: "object"
properties:
fio:
required:
- "firstName"
- "lastName"
type: "object"
properties:
firstName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Имя клиента."
format: "string"
lastName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Фамилия клиента."
format: "string"
middleName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Отчество клиента."
format: "string"
description: "ФИО клиента."
mobilePhone:
pattern: "^[9]{1}[0-9]{9}$"
type: "string"
description: "Номер телефона клиента."
birthDate:
type: "string"
description: "Дата рождения клиента."
format: "date"
isResident:
type: "boolean"
description: "Флаг резидента РФ."
format: "boolean"
description: "Модель данных клиента."
description: "Данные клиента."
webhookURL:
pattern: "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\\
.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$"
type: "string"
description: "URL для отправки вебхуков. Если не указан, использ\
уется URL из настроек точки."
format: "url"
pointId:
maxLength: 50
minLength: 1
type: "string"
description: "Внешний идентификатор точки."
format: "string"
companyId:
maxLength: 100
minLength: 1
type: "string"
description: "Внешний идентификатор компании."
format: "string"
agentId:
maxLength: 100
minLength: 1
type: "string"
description: "Внешний идентификатор агента."
format: "string"
creditCards:
type: "object"
additionalProperties:
required:
- "ean"
type: "object"
properties:
ean:
maxLength: 13
pattern: "^\\d{13}$"
type: "string"
description: "Штрихкод кредитной карты. Допускаются только\
\ цифры."
format: "string"
description: "Объект с кредитными картами."
example:
skb-card:
ean: 123456789101
kvk-card:
ean: 123456789101
description: "Модель запроса на создание заявки"
required: true
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "id"
- "link"
type: "object"
properties:
id:
type: "string"
description: "ID заявки в системе TCB."
format: "uuid"
link:
type: "string"
description: "Ссылка для перехода в личный кабинет TCB."
format: "url"
example:
id: "21dc246d-ff4b-451b-a1f6-c746579bfb26"
link: "https://forma.tbank.ru/auth/authorize?auth_token={access_token}&redirect_uri={redirectUrl}&client_id=tcb&response_type=code"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при некорректном запросе:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Выберите хотя бы один тип заявки."
errorCode: "INVALID_REQUEST"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Агент не имеет достаточно прав для создания зая\
вок на текущей компании. Обратитесь в поддержку брокера."
errorCode: "AUTH_FORBIDDEN"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/demo/create:
post:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Test)"
summary: "Создать новую заявку"
description: "Метод создает кредитную заявку в системе Т-Банк Кредит Брокер\
.\n\nВ ответе возвращается ссылка с ссылочной авторизацией для продолжения\
\ заявочного процесса внутри личного кабинета агента."
operationId: "createTcbAppV1Demo"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/json:
schema:
required:
- "orderNumber"
- "type"
type: "object"
properties:
agentLogin:
pattern: "^[9]{1}[0-9]{9}$"
type: "string"
description: "Номер телефона агента, под которым он заведен в TCB."
orderNumber:
maxLength: 50
minLength: 1
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
order:
required:
- "items"
type: "object"
properties:
firstPayment:
minimum: 0
type: "integer"
description: "Первоначальный взнос."
format: "int32"
items:
maxItems: 99
minItems: 1
type: "array"
items:
required:
- "name"
- "price"
- "quantity"
type: "object"
properties:
name:
maxLength: 255
minLength: 1
type: "string"
description: "Наименование товара."
format: "string"
quantity:
minimum: 0
type: "integer"
description: "Количество товара."
format: "int32"
price:
minimum: 0
type: "number"
description: "Стоимость 1 единицы товара."
format: "double"
externalId:
minLength: 1
type: "string"
description: "Идентификатор товара."
format: "string"
description: "Товары в корзине."
description: "Модель заказа клиента в запросе создания заявки."
type:
required:
- "isCreditCard"
- "isPos"
type: "object"
properties:
isPos:
type: "boolean"
description: "Флаг отправки заявки на POS-кредит."
format: "boolean"
isCreditCard:
type: "boolean"
description: "Флаг отправки заявки на кредитную карту."
format: "boolean"
description: "Объект с информацией по запрашиваемым продуктам."
isCallSigning:
type: "boolean"
description: "Флаг телефонного заполнения. По умолчанию — `false`."
format: "boolean"
isOnlyCredit:
type: "boolean"
description: "Флаг отключения рассрочек, возможно оформление тол\
ько кредитов. По умолчанию — `false`."
format: "boolean"
values:
type: "object"
properties:
contact:
type: "object"
properties:
fio:
required:
- "firstName"
- "lastName"
type: "object"
properties:
firstName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Имя клиента."
format: "string"
lastName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Фамилия клиента."
format: "string"
middleName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Отчество клиента."
format: "string"
description: "ФИО клиента."
mobilePhone:
pattern: "^[9]{1}[0-9]{9}$"
type: "string"
description: "Номер телефона клиента."
birthDate:
type: "string"
description: "Дата рождения клиента."
format: "date"
isResident:
type: "boolean"
description: "Флаг резидента РФ."
format: "boolean"
description: "Модель данных клиента."
description: "Данные клиента."
webhookURL:
pattern: "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\\
.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$"
type: "string"
description: "URL для отправки вебхуков. Если не указан, использ\
уется URL из настроек точки."
format: "url"
pointId:
maxLength: 50
minLength: 1
type: "string"
description: "Внешний идентификатор точки."
format: "string"
companyId:
maxLength: 100
minLength: 1
type: "string"
description: "Внешний идентификатор компании."
format: "string"
agentId:
maxLength: 100
minLength: 1
type: "string"
description: "Внешний идентификатор агента."
format: "string"
creditCards:
type: "object"
additionalProperties:
required:
- "ean"
type: "object"
properties:
ean:
maxLength: 13
pattern: "^\\d{13}$"
type: "string"
description: "Штрихкод кредитной карты. Допускаются только\
\ цифры."
format: "string"
description: "Объект с кредитными картами."
example:
skb-card:
ean: 123456789101
kvk-card:
ean: 123456789101
description: "Модель запроса на создание заявки"
required: true
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "id"
- "link"
type: "object"
properties:
id:
type: "string"
description: "ID заявки в системе TCB."
format: "uuid"
link:
type: "string"
description: "Ссылка для перехода в личный кабинет TCB."
format: "url"
example:
id: "21dc246d-ff4b-451b-a1f6-c746579bfb26"
link: "https://forma.tbank.ru/auth/authorize?authToken={accessToken}&redirect_uri={redirectUrl}&client_id=tcb&responseType=code"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при некорректном запросе:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Выберите хотя бы один тип заявки."
errorCode: "INVALID_REQUEST"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Агент не имеет достаточно прав для создания зая\
вок на текущей компании. Обратитесь в поддержку брокера."
errorCode: "AUTH_FORBIDDEN"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/demo/orders/{orderNumber}/cancel:
post:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Test)"
summary: "Отменить заявку"
description: "Метод отменяет заявку по вашему идентификатору — номеру заказа\
. После вызова метода заявка в личном кабинете агента перейдет в статус `О\
тменена`."
operationId: "cancelTcbAppV1Demo"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "orderNumber"
in: "path"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
type: "object"
example: {}
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Не найдена заявка с номером заказа {orderNumber}."
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/demo/orders/{orderNumber}/commit:
post:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Test)"
summary: "Сохранить номер чека под заявкой"
description: "Метод сохраняет номер чека под заявкой в системе TCB."
operationId: "commitTcbAppV1Demo"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "orderNumber"
in: "path"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
requestBody:
content:
application/json:
schema:
required:
- "invoiceNumber"
type: "object"
properties:
invoiceNumber:
maxLength: 250
type: "string"
description: "Номер чека на стороне партнера."
format: "string"
description: "Модель запроса на коммит."
required: true
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
type: "object"
example: {}
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Не найдена заявка с номером заказа {orderNumber}."
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/demo/orders/{orderNumber}/info:
get:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Test)"
summary: "Получить информацию по заявке"
description: "Метод возвращает актуальную информацию по заявке. Набор возвра\
щаемых полей может меняться в зависимости от статуса заявки."
operationId: "infoTcbAppV1Demo"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "orderNumber"
in: "path"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "createdAt"
- "id"
- "orderNumber"
- "status"
type: "object"
properties:
id:
type: "string"
description: "ID заявки в системе TCB."
format: "uuid"
orderNumber:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
status:
type: "string"
description: "Статус заявки."
enum:
- "new"
- "inprogress"
- "wait-offers"
- "approved"
- "signing"
- "signed"
- "rejected"
- "canceled"
- "error"
createdAt:
type: "string"
description: "Дата и время создания заявки."
format: "dateTime"
firstName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Имя клиента."
format: "string"
lastName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Фамилия клиента."
format: "string"
middleName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Отчество клиента."
format: "string"
mobilePhone:
pattern: "^[9]{1}[0-9]{9}$"
type: "string"
description: "Номер телефона клиента."
email:
maxLength: 150
type: "string"
description: "Электронная почта клиента."
format: "string"
chosenPosOfferId:
maxLength: 50
type: "string"
description: "ID выбранного оффера (POS)."
format: "string"
chosenCardOfferId:
maxLength: 50
type: "string"
description: "ID выбранного оффера (карта)."
format: "string"
orderAmount:
type: "number"
description: "Стоимость товаров из корзины."
format: "double"
transferAmount:
type: "number"
description: "Сумма перевода партнеру."
format: "double"
offers:
maxItems: 99
type: "array"
items:
required:
- "bankId"
- "bankName"
- "id"
- "status"
type: "object"
properties:
id:
maxLength: 100
type: "string"
description: "ID оффера."
format: "string"
status:
type: "string"
description: "Статус оффера."
enum:
- "waiting"
- "approved"
- "rejected"
- "error"
- "signing"
- "signed"
- "canceled"
firstPayment:
type: "number"
description: "Первоначальный взнос."
format: "double"
orderAmount:
type: "number"
description: "Стоимость товаров из корзины."
format: "double"
creditAmount:
type: "number"
description: "Сумма кредита."
format: "double"
discount:
type: "number"
description: "Скидка по рассрочке в процентах."
format: "double"
discountAmount:
type: "number"
description: "Скидка по рассрочке в рублях."
format: "double"
limit:
type: "number"
description: "Лимит по кредитной карте."
format: "double"
rate:
type: "number"
description: "Ставка по кредиту."
format: "double"
productCode:
type: "string"
description: "Идентификатор продукта."
format: "string"
product:
type: "string"
description: "Тип продукта."
enum:
- "credit"
- "installment_credit"
- "creditcard"
term:
type: "integer"
description: "Срок кредита."
format: "int32"
monthlyPayment:
type: "number"
description: "Ежемесячный платеж по кредиту."
format: "double"
signingTypes:
maxItems: 5
type: "array"
description: "Типы подписания."
items:
type: "string"
enum:
- "partner"
- "ses"
- "sms"
bankId:
type: "string"
description: "ID банка."
format: "string"
bankName:
type: "string"
description: "Название банка."
format: "string"
chosenServices:
maxItems: 3
type: "array"
description: "Выбранные банковские дополнительные услуги\
."
items:
type: "string"
enum:
- "life_insurance"
- "lost_work_insurance"
- "sms_bank"
loanNumber:
type: "string"
description: "Номер договора."
format: "string"
accountNumber:
pattern: "^\\d{1,20}$"
type: "string"
description: "Номер счета клиента."
format: "string"
description: "Модель оффера от банка."
order:
required:
- "items"
type: "object"
properties:
items:
minimum: 1
maxItems: 99
type: "array"
items:
required:
- "name"
- "price"
- "quantity"
type: "object"
properties:
name:
maxLength: 255
minLength: 1
type: "string"
description: "Наименование товара."
format: "string"
quantity:
minimum: 0
type: "integer"
description: "Количество товара."
format: "int32"
price:
minimum: 0
type: "number"
description: "Стоимость 1 единицы товара."
format: "double"
externalId:
minLength: 1
type: "string"
description: "Идентификатор товара."
format: "string"
description: "Товары в корзине."
boxedServices:
type: "object"
properties:
lifeInsurance:
required:
- "amount"
- "name"
- "term"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
term:
type: "integer"
description: "Срок услуги."
format: "int32"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «Капитал Life»."
pushSms:
required:
- "amount"
- "name"
- "term"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
term:
type: "integer"
description: "Срок услуги."
format: "int32"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «ПУШСМС»."
warranty:
required:
- "amount"
- "name"
- "params"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
params:
maxItems: 99
type: "array"
items:
required:
- "idCertificate"
- "price"
- "term"
type: "object"
properties:
term:
type: "integer"
description: "Срок услуги."
format: "int32"
price:
type: "number"
description: "Стоимость услуги."
format: "double"
idCertificate:
type: "string"
description: "Номер сертификата."
format: "string"
name:
type: "string"
description: "Название товара."
format: "string"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «Гарантия на технику»."
teco:
required:
- "amount"
- "name"
- "tecoId"
- "term"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
term:
type: "integer"
description: "Срок услуги."
format: "int32"
tecoId:
type: "string"
description: "Теко ID."
format: "string"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «ТЕКО»."
description: "Коробочные услуги."
description: "Модель заказа клиента."
example:
id: "21dc246d-ff4b-451b-a1f6-c746579bfb2"
orderNumber: "№12345678"
status: "approved"
createdAt: "2012-04-23T18:25:43.511Z"
firstName: "Иван"
lastName: "Иванов"
middleName: "Иванович"
mobilePhone: "9898882365"
email: "bka@gmail.com"
chosenPosOfferId: "21dc246d-ff4b-451b-a1f6-c746579bfb3"
chosenCardOfferId: "12d8ee08-f08b-45ac-b891-1717ea93506c"
orderAmount: 10000
transferAmount: 10000
order:
items:
- name: "iphone 11"
quantity: 2
price: 60000
- name: "dyson x"
quantity: 1
price: 45000
boxedServices:
warranty:
name: "Услуга-1"
amount: 45
params:
- term: 4
name: "что-то"
price: 11658
idCertificate: "test_id"
pushSms:
name: "Услуга-2"
amount: 40
term: 6
lifeInsurance:
name: "Услуга-3"
amount: 2423
term: 6
discountedAmount: 2423
teco:
name: "Услуга-4"
amount: 2423
term: 6
tecoId: "64c87fda60b2a35a104a6dbb"
discountedAmount: 2423
offers:
- id: "undefined"
status: "rejected"
bankId: "otp"
bankName: "ОТП"
- id: "24dc246d-ff4b-451b-a1f6-c746579bfb7"
status: "signed"
firstPayment: 0
orderAmount: 10000
creditAmount: 10000
product: "credit"
term: 6
discount: 0.0
discountAmount: 0.0
monthlyPayment: 1500
bankId: "kvk"
bankName: "Т-Банк"
loanNumber: "№234234234"
accountNumber: "40701810000010000038"
signingTypes:
- "ses"
- "partner"
chosenServices:
- "sms_bank"
- "life_insurance"
- "lost_work_insurance"
- id: "12d8ee08-f08b-45ac-b891-1717ea93506c"
status: "approved"
limit: 100000
product: "creditcard"
bankId: "kvk-card"
bankName: "Т-Банк"
signingTypes:
- "ses"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Не найдена заявка с номером заказа {orderNumber}."
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/orders/{orderNumber}/cancel:
post:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Prod)"
summary: "Отменить заявку"
description: "Метод отменяет заявку по вашему идентификатору — номеру заказа\
. После вызова метода заявка в личном кабинете агента перейдет в статус `О\
тменена`."
operationId: "cancelTcbAppV1"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "orderNumber"
in: "path"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
type: "object"
example: {}
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Не найдена заявка с номером заказа {orderNumber}."
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/orders/{orderNumber}/commit:
post:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Prod)"
summary: "Сохранить номер чека под заявкой"
description: "Метод сохраняет номер чека под заявкой в системе TCB."
operationId: "commitTcbAppV1"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "orderNumber"
in: "path"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
requestBody:
content:
application/json:
schema:
required:
- "invoiceNumber"
type: "object"
properties:
invoiceNumber:
maxLength: 250
type: "string"
description: "Номер чека на стороне партнера."
format: "string"
description: "Модель запроса на коммит."
required: true
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
type: "object"
example: {}
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Не найдена заявка с номером заказа {orderNumber}."
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/offline/partners/v1/orders/{orderNumber}/info:
get:
tags:
- "Партнерские методы для работы с заявкой на покупку в кредит (Prod)"
summary: "Получить информацию по заявке"
description: " Метод возвращает актуальную информацию по заявке. Набор возвр\
ащаемых полей может меняться в зависимости от статуса заявки.\n\nЧтобы опе\
ративно отслеживать изменения статуса заявки на покупку товаров в кредит,\
\ вы можете воспользоваться вебхуком Статус заявки на товарный кредит."
operationId: "infoTcbAppV1"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "orderNumber"
in: "path"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "createdAt"
- "id"
- "orderNumber"
- "status"
type: "object"
properties:
id:
type: "string"
description: "ID заявки в системе TCB."
format: "uuid"
orderNumber:
maxLength: 50
type: "string"
description: "Номер заказа на стороне продавца."
format: "string"
status:
type: "string"
description: "Статус заявки."
enum:
- "new"
- "inprogress"
- "wait-offers"
- "approved"
- "signing"
- "signed"
- "rejected"
- "canceled"
- "error"
createdAt:
type: "string"
description: "Дата и время создания заявки."
format: "dateTime"
firstName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Имя клиента."
format: "string"
lastName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Фамилия клиента."
format: "string"
middleName:
pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$"
type: "string"
description: "Отчество клиента."
format: "string"
mobilePhone:
pattern: "^[9]{1}[0-9]{9}$"
type: "string"
description: "Номер телефона клиента."
email:
maxLength: 150
type: "string"
description: "Электронная почта клиента."
format: "string"
chosenPosOfferId:
maxLength: 50
type: "string"
description: "ID выбранного оффера (POS)."
format: "string"
chosenCardOfferId:
maxLength: 50
type: "string"
description: "ID выбранного оффера (карта)."
format: "string"
orderAmount:
type: "number"
description: "Стоимость товаров из корзины."
format: "double"
transferAmount:
type: "number"
description: "Сумма перевода партнеру."
format: "double"
offers:
maxItems: 99
type: "array"
items:
required:
- "bankId"
- "bankName"
- "id"
- "status"
type: "object"
properties:
id:
maxLength: 100
type: "string"
description: "ID оффера."
format: "string"
status:
type: "string"
description: "Статус оффера."
enum:
- "waiting"
- "approved"
- "rejected"
- "error"
- "signing"
- "signed"
- "canceled"
firstPayment:
type: "number"
description: "Первоначальный взнос."
format: "double"
orderAmount:
type: "number"
description: "Стоимость товаров из корзины."
format: "double"
creditAmount:
type: "number"
description: "Сумма кредита."
format: "double"
discount:
type: "number"
description: "Скидка по рассрочке в процентах."
format: "double"
discountAmount:
type: "number"
description: "Скидка по рассрочке в рублях."
format: "double"
limit:
type: "number"
description: "Лимит по кредитной карте."
format: "double"
rate:
type: "number"
description: "Ставка по кредиту."
format: "double"
productCode:
type: "string"
description: "Идентификатор продукта."
format: "string"
product:
type: "string"
description: "Тип продукта."
enum:
- "credit"
- "installment_credit"
- "creditcard"
term:
type: "integer"
description: "Срок кредита."
format: "int32"
monthlyPayment:
type: "number"
description: "Ежемесячный платеж по кредиту."
format: "double"
signingTypes:
maxItems: 5
type: "array"
description: "Типы подписания."
items:
type: "string"
enum:
- "partner"
- "ses"
- "sms"
bankId:
type: "string"
description: "ID банка."
format: "string"
bankName:
type: "string"
description: "Название банка."
format: "string"
chosenServices:
maxItems: 3
type: "array"
description: "Выбранные банковские дополнительные услуги\
."
items:
type: "string"
enum:
- "life_insurance"
- "lost_work_insurance"
- "sms_bank"
loanNumber:
type: "string"
description: "Номер договора."
format: "string"
accountNumber:
pattern: "^\\d{1,20}$"
type: "string"
description: "Номер счета клиента."
format: "string"
description: "Модель оффера от банка."
order:
required:
- "items"
type: "object"
properties:
items:
minimum: 1
maxItems: 99
type: "array"
items:
required:
- "name"
- "price"
- "quantity"
type: "object"
properties:
name:
maxLength: 255
minLength: 1
type: "string"
description: "Наименование товара."
format: "string"
quantity:
minimum: 0
type: "integer"
description: "Количество товара."
format: "int32"
price:
minimum: 0
type: "number"
description: "Стоимость 1 единицы товара."
format: "double"
externalId:
minLength: 1
type: "string"
description: "Идентификатор товара."
format: "string"
description: "Товары в корзине."
boxedServices:
type: "object"
properties:
lifeInsurance:
required:
- "amount"
- "name"
- "term"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
term:
type: "integer"
description: "Срок услуги."
format: "int32"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «Капитал Life»."
pushSms:
required:
- "amount"
- "name"
- "term"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
term:
type: "integer"
description: "Срок услуги."
format: "int32"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «ПУШСМС»."
warranty:
required:
- "amount"
- "name"
- "params"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
params:
maxItems: 99
type: "array"
items:
required:
- "idCertificate"
- "price"
- "term"
type: "object"
properties:
term:
type: "integer"
description: "Срок услуги."
format: "int32"
price:
type: "number"
description: "Стоимость услуги."
format: "double"
idCertificate:
type: "string"
description: "Номер сертификата."
format: "string"
name:
type: "string"
description: "Название товара."
format: "string"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «Гарантия на технику»."
teco:
required:
- "amount"
- "name"
- "tecoId"
- "term"
type: "object"
properties:
name:
type: "string"
description: "Наименование услуги."
format: "string"
amount:
type: "number"
description: "Стоимость услуги."
format: "double"
term:
type: "integer"
description: "Срок услуги."
format: "int32"
tecoId:
type: "string"
description: "Теко ID."
format: "string"
discountedAmount:
type: "number"
description: "Сумма услуги с вычетом скидки."
format: "double"
description: "Коробочная услуга «ТЕКО»."
description: "Коробочные услуги."
description: "Модель заказа клиента."
example:
id: "21dc246d-ff4b-451b-a1f6-c746579bfb2"
orderNumber: "№12345678"
status: "approved"
createdAt: "2012-04-23T18:25:43.511Z"
firstName: "Иван"
lastName: "Иванов"
middleName: "Иванович"
mobilePhone: "9898882365"
email: "bka@gmail.com"
chosenPosOfferId: "21dc246d-ff4b-451b-a1f6-c746579bfb3"
chosenCardOfferId: "12d8ee08-f08b-45ac-b891-1717ea93506c"
orderAmount: 10000
transferAmount: 10000
order:
items:
- name: "iphone 11"
quantity: 2
price: 60000
- name: "dyson x"
quantity: 1
price: 45000
boxedServices:
warranty:
name: "Услуга-1"
amount: 45
params:
- term: 4
name: "что-то"
price: 11658
idCertificate: "test_id"
pushSms:
name: "Услуга-2"
amount: 40
term: 6
lifeInsurance:
name: "Услуга-3"
amount: 2423
term: 6
discountedAmount: 2423
teco:
name: "Услуга-4"
amount: 2423
term: 6
tecoId: "64c87fda60b2a35a104a6dbb"
discountedAmount: 2423
offers:
- id: "undefined"
status: "rejected"
bankId: "otp"
bankName: "ОТП"
- id: "24dc246d-ff4b-451b-a1f6-c746579bfb7"
status: "signed"
firstPayment: 0
orderAmount: 10000
creditAmount: 10000
product: "credit"
term: 6
discount: 0.0
discountAmount: 0.0
monthlyPayment: 1500
bankId: "kvk"
bankName: "Т-Банк"
loanNumber: "№234234234"
accountNumber: "40701810000010000038"
signingTypes:
- "ses"
- "partner"
chosenServices:
- "sms_bank"
- "life_insurance"
- "lost_work_insurance"
- id: "12d8ee08-f08b-45ac-b891-1717ea93506c"
status: "approved"
limit: 100000
product: "creditcard"
bankId: "kvk-card"
bankName: "Т-Банк"
signingTypes:
- "ses"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка авторизации агента:
value:
errorId: "170e4a82-9c62-4fb0-8055-45e810630754"
errorMessage: "Не найдена заявка с номером заказа {orderNumber}."
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/agreements:
get:
tags:
- "Соглашения"
summary: "Получить список соглашений"
description: " Метод для получения списка соглашений с актуальными статусами\
, в которых компания является получателем или плательщиком."
operationId: "getApiV1Nonacceptance-AgreementsList"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "limit"
in: "query"
description: "Максимальное количество соглашений, которое нужно вывести. З\
начение по умолчанию — `50`."
required: false
style: "form"
explode: true
schema:
type: "integer"
format: "int32"
default: 50
- name: "offset"
in: "query"
description: "Количество соглашений, которые нужно пропустить. Значение по\
\ умолчанию — `0`."
required: false
style: "form"
explode: true
schema:
type: "integer"
format: "int32"
default: 0
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "limit"
- "offset"
- "size"
- "total"
type: "object"
properties:
offset:
type: "integer"
description: "Количество соглашений, которое было пропущено."
format: "int32"
limit:
type: "integer"
description: "Максимальное количество соглашений, которое могл\
о быть выведено."
format: "int32"
size:
type: "integer"
description: "Количество соглашений в ответе."
format: "int32"
total:
type: "integer"
description: "Общее количество соглашений."
format: "int32"
results:
maxItems: 50
type: "array"
description: "Результат."
nullable: true
items:
required:
- "id"
type: "object"
properties:
id:
type: "string"
description: "ID соглашения."
format: "uuid"
type:
type: "string"
description: " Тип участия в соглашении:\n\n`Recipient`\
\ — в качестве получателя;\n\n`Payer` — в качестве пла\
тельщика."
enum:
- "Recipient"
- "Payer"
status:
type: "string"
description: " Статус соглашения:\n\n* `Pending` — ожида\
ет подписания одной или двумя сторонами.\n\n* `Signed`\
\ — подписано, ожидает регистрации на стороне банка. К\
ак правило, это занимает не больше двух дней.\n\n* `Active`\
\ — соглашение активно, можно производить списания.\n\n\
* `Terminated` — соглашение расторгнуто одной из сторо\
н.\n\n* `Outdated` — срок соглашения истек, производит\
ь списания нельзя.\n\n* `Error` — при обработке соглаш\
ения произошла ошибка. "
enum:
- "Pending"
- "Active"
- "Signed"
- "Terminated"
- "Error"
- "Outdated"
example:
offset: 60
limit: 10
size: 1
total: 61
results:
- id: "4ec482b3-b314-4089-88c2-2b6fba9424ef"
type: "Recipient"
status: "Active"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "bcadsa12"
errorCode: "VALIDATION_ERROR"
errorMessage: "offset: value must be greater than 0"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/agreements/url:
get:
tags:
- "Соглашения"
summary: "Получить URL страницы для контрагента"
description: " Метод для получения URL для создания нового соглашения.\n\nКо\
гда плательщик переходит по URL, открывается окно, в котором он указывает\
\ свои реквизиты и детали соглашения — срок действия, максимальная сумма п\
латежа.\n\nОбсудите предполагаемые суммы платежей со своим контрагентом. В\
\ рамках соглашения с плательщика за раз не может быть списана сумма больш\
е той, которая указана в соглашении."
operationId: "getApiV1Nonacceptance-AgreementUrl"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "url"
type: "object"
properties:
url:
type: "string"
description: "URL для контрагента, который ведет на форму подп\
исания соглашения."
format: "string"
example:
url: "https://business.tbank.ru/nonacceptance-debits/form/3fa85f64-5717-4562-b3fc-2c963f66afa6"
"400":
description: "Не найдена форма для соглашения о безакцептных списаниях"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "bcadsa12"
errorCode: "NOT_FOUND"
errorMessage: "Resource not found"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/agreements/{agreementId}:
get:
tags:
- "Соглашения"
summary: "Получить детали соглашения"
description: " Метод отдает информацию о реквизитах плательщика и получателя\
, статусе соглашения, максимальной сумме платежа по договору. Чтобы измени\
ть детали соглашения, напишите в чат.\n\nЧтобы оперативно отслеживать инфо\
рмацию о создании или обновлении соглашения о безакцептном списании, вы мо\
жете воспользоваться вебхуком Обновление соглашения о безакцептном списании."
operationId: "getApiV1Nonacceptance-AgreementDetails"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "agreementId"
in: "path"
description: "ID соглашения."
required: true
style: "simple"
explode: false
schema:
type: "string"
format: "uuid"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "id"
- "number"
- "payerRequisites"
- "recipientRequisites"
- "startDate"
type: "object"
properties:
id:
type: "string"
description: "ID соглашения."
format: "uuid"
number:
type: "string"
description: "Номер соглашения."
format: "string"
recipientRequisites:
type: "object"
properties:
name:
maxLength: 300
type: "string"
description: "Наименование."
nullable: true
address:
type: "string"
description: "Полный юридический адрес."
format: "string"
nullable: true
inn:
pattern: "^(\\d{10}|\\d{12})$"
type: "string"
description: "ИНН."
nullable: true
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
description: "КПП."
nullable: true
ogrn:
pattern: "^(\\d{13}|\\d{15})$"
type: "string"
description: "ОГРН."
nullable: true
signerName:
type: "string"
description: "ФИО представителя."
format: "string"
nullable: true
signerPosition:
type: "string"
description: "Должность представителя."
format: "string"
nullable: true
signerDocument:
type: "string"
description: "Документ-обоснование должности представителя\
."
format: "string"
nullable: true
accountNumber:
pattern: "^(\\d{20})$"
type: "string"
description: "Расчетный счет."
nullable: true
accountCurrency:
pattern: "^(\\d{3})$"
type: "string"
description: "Валюта расчетного счета."
nullable: true
corAccountNumber:
pattern: "^(\\d{20})$"
type: "string"
description: "Корреспондентский счет."
nullable: true
bic:
pattern: "^(\\d{9})$"
type: "string"
description: "БИК."
nullable: true
bankName:
maxLength: 300
type: "string"
description: "Наименование банка."
nullable: true
description: "Реквизиты получателя."
payerRequisites:
type: "object"
properties:
name:
maxLength: 300
type: "string"
description: "Наименование."
nullable: true
address:
type: "string"
description: "Полный юридический адрес."
format: "string"
nullable: true
inn:
pattern: "^(\\d{10}|\\d{12})$"
type: "string"
description: "ИНН."
nullable: true
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
description: "КПП."
nullable: true
ogrn:
pattern: "^(\\d{13}|\\d{15})$"
type: "string"
description: "ОГРН."
nullable: true
signerName:
type: "string"
description: "ФИО представителя."
format: "string"
nullable: true
signerPosition:
type: "string"
description: "Должность представителя."
format: "string"
nullable: true
signerDocument:
type: "string"
description: "Документ-обоснование должности представителя\
."
format: "string"
nullable: true
accountNumber:
pattern: "^(\\d{20})$"
type: "string"
description: "Расчетный счет."
nullable: true
accountCurrency:
pattern: "^(\\d{3})$"
type: "string"
description: "Валюта расчетного счета."
nullable: true
corAccountNumber:
pattern: "^(\\d{20})$"
type: "string"
description: "Корреспондентский счет."
nullable: true
bic:
pattern: "^(\\d{9})$"
type: "string"
description: "БИК."
nullable: true
bankName:
maxLength: 300
type: "string"
description: "Наименование банка."
nullable: true
description: "Реквизиты плательщика."
startDate:
type: "string"
description: "Дата подписания соглашения."
format: "date-time"
endDate:
type: "string"
description: "Дата окончания действия соглашения."
format: "date-time"
nullable: true
maxSum:
type: "number"
description: "Максимальная сумма платежа."
format: "decimal"
nullable: true
currency:
pattern: "^(\\d{3})$"
type: "string"
description: "Валюта максимальной суммы."
nullable: true
reason:
type: "string"
description: "Документ-основание для заключения соглашения."
format: "string"
nullable: true
status:
type: "string"
description: " Статус соглашения:\n\n* `Pending` — ожидает под\
писания одной или двумя сторонами.\n\n* `Signed` — подписано\
, ожидает регистрации на стороне банка. Как правило, это зан\
имает не больше двух дней.\n\n* `Active` — соглашение активн\
о, можно производить списания.\n\n* `Terminated` — соглашени\
е расторгнуто одной из сторон.\n\n* `Outdated` — срок соглаш\
ения истек, производить списания нельзя.\n\n* `Error` — при\
\ обработке соглашения произошла ошибка. "
enum:
- "Pending"
- "Active"
- "Signed"
- "Terminated"
- "Error"
- "Outdated"
example:
id: "4ec482b3-b314-4089-88c2-2b6fba9424ef"
number: "236383626412/2022-08-05/25.421"
startDate: "2022-08-05T18:08:17.338628Z"
endDate: "2023-08-06T18:00:00Z"
maxSum: 1000.0
currency: "643"
reason: "На основании договора №7345 от 01.02.2018"
status: "Pending"
recipientRequisites:
name: "ООО \"Ромашка\""
address: "г. Москва, ул. Производственная, 12 корпус 3, 067889"
inn: "1234567890"
kpp: "123456789"
ogrn: "1234567891234"
signerName: "Иванов Иван Иванович"
signerPosition: "Главный бухгалтер"
signerDocument: "На основании доверенности №123412355 от 10.05.2018"
accountNumber: "12345678900987654321"
accountCurrency: "643"
corAccountNumber: "30101810145250000974"
bic: "044525974"
bankName: "АО «ТБанк»"
payerRequisites:
name: "ИП Петров Петр Иванович"
address: "г. Москва, ул. Производственная, д.15, 067889"
inn: "1234567890"
kpp: "123456789"
ogrn: "1234567891234"
signerName: "Петров Петр Иванович"
signerPosition: ""
signerDocument: "Выписка из ЕГРЮЛ"
accountNumber: "12345678900987654321"
accountCurrency: "643"
corAccountNumber: "30101810145250000974"
bic: "044525974"
bankName: "АО «ТБанк»"
"400":
description: "Соглашение не найдено"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "bcadsa12"
errorCode: "NOT_FOUND"
errorMessage: "Resource not found"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/agreements/{agreementId}/file:
get:
tags:
- "Соглашения"
summary: "Получить детали соглашения в PDF"
description: "Метод для получения PDF-файла с текстом соглашения. Файл закод\
ирован в `base64`."
operationId: "getApiV1Nonacceptance-AgreementDetails-file"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "agreementId"
in: "path"
description: "ID соглашения."
required: true
style: "simple"
explode: false
schema:
type: "string"
format: "uuid"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "content"
- "filename"
type: "object"
properties:
filename:
type: "string"
description: "Имя файла."
format: "string"
content:
type: "string"
description: "Base64-encoded файл в формате PDF с текстом согл\
ашения."
format: "byte"
example:
content: "UERGIGZpbGUgc2hvdWxkIGJlIGhlcmU="
filename: "1234-010122.pdf"
"400":
description: "Соглашение не найдено"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "bcadsa12"
errorCode: "NOT_FOUND"
errorMessage: "Resource not found"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/chargebacks:
get:
tags:
- "Интернет-эквайринг. Диспуты"
summary: "Получить информацию о диспутах компании"
description: "Метод для получения информации по всем диспутам компании за за\
прашиваемый период. Включает в себя как новые диспуты, так и старые, по ко\
торым были изменения за период."
operationId: "getChargebacks"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "beginDate"
in: "query"
description: "Дата начала."
required: true
style: "form"
explode: true
schema:
type: "string"
format: "date"
- name: "endDate"
in: "query"
description: "Дата окончания."
required: true
style: "form"
explode: true
schema:
type: "string"
format: "date"
responses:
"200":
description: "OK"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "data"
type: "object"
properties:
message:
maxLength: 300
type: "string"
description: "Результат обработки запроса."
data:
maxItems: 500
type: "array"
description: "Информация по каждому диспуту."
items:
required:
- "attachments"
- "cbkAmt"
- "channel"
- "chargebackStage"
- "reasonCode"
- "status"
type: "object"
properties:
channel:
type: "string"
description: "Канал:\n- `ON-US` — карты Т-Банка;\n- `OFF-US`\
\ — карты сторонних банков."
enum:
- "ON-US"
- "OFF-US"
origTrxnDate:
pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$"
type: "string"
description: "Дата и время оригинальной транзакции в фор\
мате `yyyy-mm-dd'T'HH:mm:ss`."
cardNumber:
maxLength: 100
pattern: "\\*{2,}"
type: "string"
description: "Маскированный номер карты клиента."
merchantName:
maxLength: 100
type: "string"
description: "Название мерчанта."
submerchantId:
type: "integer"
description: "Идентификатор точки."
format: "int64"
trxnAmt:
type: "number"
description: "Сумма транзакции в рублях."
cbkAmt:
type: "number"
description: "Сумма оспаривания."
cbkCur:
maxLength: 100
type: "string"
description: "Валюта оспаривания."
paymentId:
maxLength: 100
type: "string"
description: "Идентификатор платежа (orderId)."
terminalId:
maxLength: 100
type: "string"
description: "Идентификатор терминала."
arn:
maxLength: 100
type: "string"
description: "ARN (Acquirer Reference Number), состоит и\
з 23 цифр."
rrn:
maxLength: 100
type: "string"
description: "Retrieval Reference Number."
reasonCode:
maxLength: 100
type: "string"
description: "Код причины оспаривания."
status:
maxLength: 100
type: "string"
description: "Статус диспута:\n- `Вернули держателю` — д\
испут проиграли и сумма вернулась физическому лицу.\n\
- `Нужен ответ` — Т-Банк требует от вас ответа на дисп\
ут: согласны с претензией или нет, а также документы,\
\ подтверждающие позицию компании в случае несогласия\
\ с диспутом.\n- `В работе` — ответ от компании получе\
н, диспут в обработке на стороне Т-Банка или стороне э\
митента.\n- `Выиграли` — диспут закрыт в пользу компан\
ии.\n- `Решение по Арбитражу` — диспут закрыт по итога\
м рассмотрения в Арбитражном комитете платежной систем\
ы. Решение ПС может быть передано по запросу."
chargebackStage:
maxLength: 100
type: "string"
description: "Стадия диспута."
retentionDate:
type: "string"
description: "Дата удержания средств с ТСП."
format: "date"
moneyTransferDate:
type: "string"
description: "Дата зачисления средств в ТСП."
format: "date"
text:
maxLength: 5000
type: "string"
description: "Текст сообщения."
deadline:
type: "string"
description: "Дата, до которой ожидаем получить ответ."
format: "date"
attachments:
maxItems: 100
type: "array"
description: "Файлы, прикрепленные к диспуту."
items:
maxLength: 100
type: "string"
description: "Ссылка на файл в data.tinkoff."
firstCbkDate:
pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$"
type: "string"
description: "Дата и время открытия спора в формате `yyyy-mm-dd'T'HH:mm:ss`."
description: "Информация о диспуте."
firstCbkDate:
type: "string"
description: "Дата и время открытия спора."
format: "datetime"
description: "Общий формат ответа."
example:
message: "OK"
data:
- channel: "ON-US"
origTrxnDate: "2023-01-31T17:25:14"
cardNumber: "553691******6876"
merchantName: "WIldberries"
submerchantId: 123456
trxnAmt: 5000.5
cbkAmt: 4000
cbkCur: "RUB"
paymentId: "klkjhgfdsdtyuio1kjh2g"
terminalId: "1234567"
arn: "12345678909876543212451"
rrn: "987654321234"
reasonCode: "4837"
status: "Нужен ответ"
chargebackStage: "Чарджбэк"
retentionDate: "2023-02-10"
moneyTransferDate: "2023-02-10"
text: "Добрый день! По указанной ниже операции поступила претенз\
ия от держателя карты. Он утверждает, что данную операцию не с\
овершал."
deadline: "2023-02-14"
attachments:
- "d7cf8082-8f8c-47a8-v80a-51aac30ba315/example.png"
- "80b5a5c0-5a48-4bb8-9f71-0ed9bf8d1955/example.pdf"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b"
errorMessage: "Мерчант не подключен к интернет-эквайрингу"
errorCode: "INVALID_DATA"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/v1/chargebacks/download/files:
post:
tags:
- "Интернет-эквайринг. Диспуты"
summary: "Получить файлы по мерчанту"
description: "Метод для получения файлов по определенному мерчанту."
operationId: "getFiles"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/json:
schema:
required:
- "files"
type: "object"
properties:
files:
maxItems: 20
type: "array"
description: "Список ссылок на файлы."
items:
type: "string"
required: true
responses:
"200":
description: ""
headers:
Content-Disposition:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Файл для скачивания."
example: "attachment; filename=\"files.zip\""
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/octet-stream:
schema:
type: "string"
format: "binary"
example: "binary data"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b"
errorMessage: "Мерчант не подключен к интернет-эквайрингу"
errorCode: "INVALID_DATA"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b"
errorMessage: "Файл не найден"
errorCode: "NOT_FOUND"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/v1/chargebacks/replies:
post:
tags:
- "Интернет-эквайринг. Диспуты"
summary: "Отправить ответы по диспутам"
description: "Метод для отправки ответов по диспутам компании. Возвращает ре\
зультаты обработки по каждому ответу."
operationId: "saveChargebackReplies"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/json:
schema:
required:
- "chargebacksReply"
type: "object"
properties:
chargebacksReply:
maxItems: 100
type: "array"
description: "Ответы компании на диспуты."
items:
required:
- "arn"
- "channel"
- "isAccepted"
- "paymentId"
- "replyText"
type: "object"
properties:
channel:
type: "string"
description: "Канал:\n- `ON-US` — карты Т-Банка;\n- `OFF-US`\
\ — карты сторонних банков."
enum:
- "ON-US"
- "OFF-US"
arn:
maxLength: 100
type: "string"
description: "ARN (Acquirer Reference Number), состоит из\
\ 23 цифр."
paymentId:
maxLength: 100
type: "string"
description: "Идентификатор платежа (orderId)."
isAccepted:
type: "boolean"
description: "Флаг, согласна ли компания с чарджбэком. Для\
\ `true` передайте сумму в параметре `acceptedAmount`."
acceptedAmount:
type: "number"
description: "Сумма, которую компания готова возместить кл\
иенту."
replyText:
maxLength: 5000
type: "string"
description: "Текст ответа на диспут."
replyAttachments:
maxItems: 100
type: "array"
description: "Файлы, прикрепленные к ответу."
items:
maxLength: 1000
type: "string"
description: "В процессе доработок. Передайте ссылки на\
\ файлы в любом облачном хранилище или сами файлы поба\
йтово."
description: "Ответ компании на диспут."
description: "Запрос от компании по отправке ответов на диспуты."
required: true
responses:
"200":
description: "OK"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "data"
type: "object"
properties:
message:
maxLength: 300
type: "string"
description: "Результат обработки запроса."
data:
maxItems: 100
type: "array"
description: "Информация по каждому диспуту."
items:
required:
- "channel"
- "paymentId"
- "result"
type: "object"
properties:
channel:
type: "string"
description: "Канал:\n- `ON-US` — карты Т-Банка;\n- `OFF-US`\
\ — карты сторонних банков."
enum:
- "ON-US"
- "OFF-US"
arn:
maxLength: 100
type: "string"
description: "ARN (Acquirer Reference Number), состоит и\
з 23 цифр."
paymentId:
maxLength: 100
type: "string"
description: "Идентификатор платежа (orderId)."
result:
type: "string"
description: "Результат обработки ответа по конкретному\
\ диспуту."
enum:
- "OK"
- "ERROR"
resultMessage:
maxLength: 300
type: "string"
description: "Текст ошибки."
description: "Результат обработки каждого ответа компании на\
\ диспут."
description: "Информация по каждому диспуту."
example:
message: "OK"
data:
- channel: "ON-US"
arn: "12345678909876543212345"
paymentId: "rtyuio2hj34k5h6lgee"
result: "OK"
- channel: "OFF-US"
arn: "0987654321234567890987"
paymentId: "1111udfifjdj9922jjl"
result: "ERROR"
resultMessage: "acceptedAmt больше, чем сумма чарджбэка"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b"
errorMessage: "Мерчант не подключен к интернет-эквайрингу"
errorCode: "INVALID_DATA"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/chargebacks/upload-files:
post:
tags:
- "Интернет-эквайринг. Диспуты"
summary: "Загрузить файлы"
description: "Метод для загрузки файлов мерчантом."
operationId: "uploadFiles"
parameters:
- name: "Content-Disposition"
in: "header"
required: true
style: "simple"
explode: false
schema:
pattern: "^[a-zA-Z0-9\\._-]+$"
type: "string"
description: "Имя загружаемого файла."
example: "attachment; filename=\"file.pdf\""
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
requestBody:
content:
application/octet-stream:
schema:
type: "string"
format: "binary"
example: "binary data"
responses:
"200":
description: "OK"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
maxItems: 10
type: "array"
items:
required:
- "fileName"
- "path"
type: "object"
properties:
fileName:
maxLength: 300
type: "string"
description: "Оригинальное название файла."
path:
maxLength: 300
type: "string"
description: "ID файла в нашей системе."
examples:
Ссылки на файлы:
value:
- fileName: "order.jpg"
path: "ba73db63-7b54-4e3c-822c-480f65e09124.jpg"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b"
errorMessage: "Мерчант не подключен к интернет-эквайрингу"
errorCode: "INVALID_DATA"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/company:
get:
tags:
- "T-Business ID. Информация о компании"
summary: "Получить информацию о компании"
description: "Метод для получения информации о компании — название, город, р\
еквизиты, банк, ОПФ, система налогообложения."
operationId: "getApiV1Company"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
responses:
"200":
description: "Информация о компании"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "bank"
- "city"
- "name"
- "requisites"
type: "object"
properties:
name:
maxLength: 1000
type: "string"
description: "Название компании."
city:
maxLength: 1000
type: "string"
description: "Город."
requisites:
required:
- "address"
- "fullName"
- "inn"
type: "object"
properties:
fullName:
maxLength: 1000
type: "string"
description: "Полное название компании."
foreignName:
maxLength: 1000
type: "string"
description: "Зарубежное название компании."
address:
maxLength: 3000
type: "string"
description: "Адрес."
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
kpp:
maxLength: 20
type: "string"
description: "КПП."
ogrn:
maxLength: 100
type: "string"
description: "ОГРН."
description: "Реквизиты компании."
bank:
required:
- "bankAddress"
- "bankBic"
- "bankInn"
- "bankName"
- "corrAccount"
type: "object"
properties:
bankName:
maxLength: 1000
type: "string"
description: "Название банка."
bankAddress:
maxLength: 3000
type: "string"
description: "Адрес банка."
corrAccount:
maxLength: 100
type: "string"
description: "Корреспондентский счет."
bankInn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
bankBic:
maxLength: 100
type: "string"
description: "БИК."
description: "Информация о банке."
registrationDate:
type: "string"
description: "Дата регистрации."
format: "date"
opf:
maxLength: 100
type: "string"
description: "Организационно-правовая форма."
taxationScheme:
type: "string"
description: "Система налогообложения: \n\n* `USN_INCOMES` — у\
прощенная система налогообложения;\n * `USN_INCOMES_MINUS_EXPENSES`\
\ — УСН «Доходы минус расходы»;\n * `AUSN_INCOMES` — автомат\
изированная УСН;\n * `AUSN_INCOMES_MINUS_EXPENSES` — автомат\
изированная УСН «Доходы минус расходы»;\n * `OSNO` — общая с\
истема налогообложения;\n * `NPD` — налог на профессиональны\
й доход;\n * `ESHN` — единый сельскохозяйственный налог;\n *\
\ `ENVD` — единый налог на вмененный доход для отдельных вид\
ов деятельности."
enum:
- "USN_INCOMES"
- "USN_INCOMES_MINUS_EXPENSES"
- "AUSN_INCOMES_MINUS_EXPENSES"
- "AUSN_INCOMES"
- "OSNO"
- "NPD"
- "ESHN"
- "ENVD"
example:
name: "ООО \"Рога и Копыта\""
city: "Москва"
requisites:
fullName: "Общество с ограниченной ответственностью \"Рога и Коп\
ыта\""
address: "г. Москва"
inn: "1234567890"
kpp: "123456789"
ogrn: "5183493905840938503"
bank:
bankName: "Воскресенье"
bankAddress: "г. Москва, ул. Правобережная 8"
corrAccount: "85452134134134"
bankInn: "1234567890"
bankBic: "68590468905486"
registrationDate: "2019-01-01"
taxationScheme: "OSNO"
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/v1/company/signer/status:
get:
tags:
- "T-Business ID. Информация о компании"
summary: "Получить информацию о статусе подписанта"
description: "Метод возвращает информацию о том, является ли пользователь по\
дписантом.\nПользователь должен дать согласие на доступ к просмотру информ\
ации о статуcе подписанта.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/signer/get
\
\ — Информация о статусе подписанта в компании с ИНН {inn} и КПП {kpp}
.\n\
\ "
operationId: "getApiV1CompanySignerStatus"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/SignerStatusResponse"
example:
isSigner: true
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidRequestResponse"
examples:
Ошибка при неправильно заполненном ИНН:
value:
errorId: "retw6789"
errorMessage: "Некорректно заполнен ИНН"
errorCode: "VALIDATION_ERROR"
Ошибка при неправильно переданном значении поля fieldName:
value:
errorId: "cde4zxc5"
errorMessage: "Ваш запрос невалиден"
errorCode: "INVALID_DATA"
errorDetails:
fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\
\ but got \"0\""
Ошибка при неправильно переданной дате платежа:
value:
errorId: "cde4zxc5"
errorMessage: "Данные не соответствуют формату платежного пору\
чения"
errorCode: "INVALID_DATA"
errorDetails:
Дата платежа: "Дата исполнения платежа не может быть в прошл\
ом"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/AuthenticationFailedResponse"
example:
errorMessage: "Не хватает учетных данных"
errorCode: "UNAUTHORIZED"
errorId: "asdq3412"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationFailedResponse"
example:
errorMessage: "Неправильный Tls сертификат"
errorCode: "FORBIDDEN"
errorId: "rtbe4567"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/BusinessErrorResponse"
example:
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
errorId: "bcde3412"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsErrorResponse"
example:
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
errorId: "acdf000"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorResponse"
example:
errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже"
errorCode: "INTERNAL_ERROR"
errorId: "asdq3412"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/v1/consult/requests/attachments:
get:
tags:
- "Налоговые консультации"
summary: "Скачать вложение (файл) из чата"
description: "Метод возвращает файл из чата по заявке (`taxRequestId`) по ег\
о идентификатору — `attachmentId`.\n\nЕсли файл не будет найден или будет\
\ недоступен для скачивания (после закрытия запроса), вернется ошибка."
operationId: "consultDownloadAttachment"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "attachmentId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "ID вложения."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
Content-Disposition:
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Файл для скачивания."
example: "attachment; filename=\"mockAttachment.txt\""
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/octet-stream:
schema:
type: "string"
format: "binary"
example: "binary data"
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/attachments/upload:
post:
tags:
- "Налоговые консультации"
summary: "Загрузить произвольный файл"
description: "Метод для загрузки произвольного файла, который можно прикрепи\
ть как вложение к заявке с ID `taxRequestId`. После успешной загрузки верн\
ется ID файла — `attachmentId`."
operationId: "consultUploadAttachment"
parameters:
- name: "X-Content-File-Name"
in: "header"
description: "Имя файла."
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Имя файла."
example: "mockAttachment.txt"
- name: "X-Content-File-Type"
in: "header"
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Тип файла."
example: "text/plain"
- name: "X-Idempotency-Key"
in: "header"
required: true
style: "simple"
explode: false
schema:
type: "string"
description: "Ключ идемпотентности. Подробнее."
format: "uuid"
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "ID заявки."
format: "uuid"
requestBody:
content:
application/octet-stream:
schema:
type: "string"
format: "binary"
example: "binary data"
required: true
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "attachmentId"
type: "object"
properties:
attachmentId:
type: "string"
description: "ID вложения."
format: "uuid"
example:
attachmentId: "54593069-1789-4a7d-b729-37406bd1fc0e"
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment:
get:
tags:
- "Налоговые консультации"
summary: "Получить данные о заявке"
description: "Метод возвращает актуальные данные о заявке."
operationId: "consultGetRequestInfo"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "clientFullName"
- "clientId"
- "createdAt"
- "hasUnreadMessages"
- "requestType"
- "status"
type: "object"
properties:
clientId:
type: "string"
description: "Идентификатор клиента."
format: "uuid"
clientFullName:
maxLength: 200
type: "string"
description: "ФИО клиента."
requestType:
type: "string"
description: "Тип заявки."
enum:
- "Comment"
- "Declaration"
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
hasUnreadMessages:
type: "boolean"
description: "Флаг наличия непрочитанных сообщений в чате."
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
createdAt:
type: "string"
description: "Дата создания в формате `ISO-8601`."
format: "dateTime"
example:
clientId: "1453dd48-53ea-4aab-a200-597b57daf809"
clientFullName: "Иванов Иван Иванович"
requestType: "Declaration"
status: "New"
hasUnreadMessages: false
casVersion: 1
createdAt: "2023-02-21T07:14:04.622Z"
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/chat:
get:
tags:
- "Налоговые консультации"
summary: "Получить список сообщений по налоговой консультации"
description: "Возвращает список сообщений чата с клиентом по налоговой консу\
льтации по ID заявки `taxRequestId`."
operationId: "consultGetChatHistory"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "limit"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "integer"
description: "Желаемое количество элементов."
- name: "offset"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "integer"
description: "Позиция начала списка."
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "meta"
- "values"
type: "object"
properties:
meta:
required:
- "count"
- "offset"
- "total"
type: "object"
properties:
offset:
type: "integer"
description: "Позиция начала списка."
count:
type: "integer"
description: "Количество элементов в ответе."
total:
type: "integer"
description: "Общее количество элементов."
description: "Информация для пагинации."
values:
maxItems: 1000
type: "array"
description: "Сообщения в чате."
items:
required:
- "authorType"
- "createdAt"
- "id"
type: "object"
properties:
id:
type: "string"
description: "ID сообщения."
format: "uuid"
authorType:
type: "string"
description: "Тип автора сообщения."
enum:
- "Manager"
- "Client"
text:
maxLength: 1000
type: "string"
description: "Текст сообщения."
attachments:
maxItems: 1000
type: "array"
description: "ID вложений, приложенных к сообщению."
items:
required:
- "createdAt"
- "id"
- "mime"
- "name"
- "size"
type: "object"
properties:
id:
maxLength: 100
type: "string"
description: "ID вложения."
name:
maxLength: 100
type: "string"
description: "Название файла."
mime:
maxLength: 100
type: "string"
description: "Тип содержимого файла."
size:
type: "integer"
description: "Размер файла в байтах."
createdAt:
type: "string"
description: "Дата загрузки документа в формате `ISO-8601`."
format: "dateTime"
createdAt:
type: "string"
description: "Дата создания сообщения в формате `ISO-8601`."
format: "dateTime"
example:
meta:
offset: 0
count: 10
total: 100
values:
- id: "17cf5b26-a9b4-4531-bd19-186dbfc64a0a"
authorType: "Client"
text: "Прикладываю справку"
attachments:
- id: "cb4bc60f-101d-4ba2-a4fb-94dcf1208d31"
name: "mockAttachment.txt"
mime: "text/plain"
size: 10
createdAt: "2023-11-22T14:12:37.933204Z"
createdAt: "2023-11-22T14:12:37.933204Z"
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/chat/send:
post:
tags:
- "Налоговые консультации"
summary: "Отправить сообщение в чат с клиентом"
description: "Метод отправляет сообщение с возможными вложениями в чат с кли\
ентом."
operationId: "consultSendChat"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "ID заявки."
format: "uuid"
requestBody:
content:
application/json:
schema:
type: "object"
properties:
text:
maxLength: 1000
type: "string"
description: "Текст сообщения."
attachments:
maxItems: 1000
type: "array"
description: "Вложения. Значение не передается, либо передается\
\ список ID вложений."
items:
type: "string"
description: "ID вложения."
format: "uuid"
example:
message:
text: "Прикладываю справку"
attachments:
- "cb4bc60f-101d-4ba2-a4fb-94dcf1208d30"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
type: "object"
example: {}
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при недостатке средств:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "На балансе недостаточно средств"
errorCode: "INSUFFICIENT_FUNDS"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/cancel:
post:
tags:
- "Налоговые консультации"
summary: "Отменить заявку"
description: "Метод переводит заявку типа «Комментарий» в статус `Cancelled`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `Cancelled`, метод вернет данные в\
\ 200 ответе. Если актуальная версия заявки не совпадает с версией, переда\
нной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusCancelled"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "Cancelled"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/clarification:
post:
tags:
- "Налоговые консультации"
summary: "Требуются уточнения по заявке"
description: "Метод переводит заявку типа «Комментарий» в статус `Clarification`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `Clarification`, метод вернет данны\
е в 200 ответе. Если актуальная версия заявки не совпадает с версией, пере\
данной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusClarification"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "Clarification"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/decline:
post:
tags:
- "Налоговые консультации"
summary: "Отклонить заявку"
description: "Метод переводит заявку типа «Комментарий» в статус `Declined`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `Declined`, метод вернет данные в 200\
\ ответе. Если актуальная версия заявки не совпадает с версией, переданной\
\ в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusDeclined"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "Declined"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/payment-done:
post:
tags:
- "Налоговые консультации"
summary: "Отметить оплату заявки"
description: "Метод переводит заявку типа «Комментарий» в статус `PaymentDone`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `PaymentDone`, метод вернет данные\
\ в 200 ответе. Если актуальная версия заявки не совпадает с версией, пере\
данной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusPaymentDone"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "PaymentDone"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/pending-payment:
post:
tags:
- "Налоговые консультации"
summary: "Отметить необходимость оплаты заявки"
description: "Метод переводит заявку типа «Комментарий» в статус `PendingPayment`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `PendingPayment`, метод вернет данн\
ые в 200 ответе. Если актуальная версия заявки не совпадает с версией, пер\
еданной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusPendingPayment"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "PendingPayment"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/ready:
post:
tags:
- "Налоговые консультации"
summary: "Завершить заявку"
description: "Метод переводит заявку типа «Комментарий» в статус `PartnerReady`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `PartnerReady`, метод вернет данные\
\ в 200 ответе. Если актуальная версия заявки не совпадает с версией, пере\
данной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusReady"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "PartnerReady"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/start-review:
post:
tags:
- "Налоговые консультации"
summary: "Взять заявку в анализ"
description: "Метод переводит заявку типа «Комментарий» в статус `Preprocess`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `Preprocess`, метод вернет данные в\
\ 200 ответе. Если актуальная версия заявки не совпадает с версией, переда\
нной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusStartReview"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "Preprocess"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/consult/requests/comment/workflow/start-work:
post:
tags:
- "Налоговые консультации"
summary: "Взять заявку в работу"
description: "Метод переводит заявку типа «Комментарий» в статус `PartnerInProgress`.\n\
\nЕсли заявка не будет найдена или ее нельзя перевести в этот статус, верн\
ется ошибка. Если заявка уже в статусе `PartnerInProgress`, метод вернет д\
анные в 200 ответе. Если актуальная версия заявки не совпадает с версией,\
\ переданной в HTTP-заголовке, вернется 422 ошибка."
operationId: "consultUpdateStatusPartnerInProgress"
parameters:
- name: "If-Match"
in: "header"
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Версия заявки в формате `ETag`, которая используется для о\
птимистичных блокировок. Другое название — casVersion."
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "taxRequestId"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "string"
description: "Уникальный ID заявки."
format: "uuid"
responses:
"200":
description: ""
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "casVersion"
- "status"
type: "object"
properties:
status:
type: "string"
description: "Статус заявки."
enum:
- "Assigned"
- "InProgress"
- "Answered"
- "SeenByClient"
- "NeedsClarification"
- "Closed"
- "SentToPartner"
- "Draft"
- "New"
- "Preprocess"
- "PartnerGeneratingReportData"
- "PartnerInProgress"
- "PendingPassport"
- "PendingPayment"
- "PaymentDone"
- "Ready"
- "PartnerReady"
- "Acknowledge"
- "Cancelled"
- "Declined"
- "Clarification"
casVersion:
type: "integer"
description: "Актуальный номер версии заявки."
format: "int64"
example:
status: "PartnerInProgress"
casVersion: 2
"400":
description: "Заявка не найдена"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Заявка не найдена"
errorCode: "REQUEST_NOT_FOUND"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Неверные данные заявки"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "868d646e609f5339"
errorMessage: "Переход между статусами невозможен"
errorCode: "ILLEGAL_WORKFLOW_TRANSITION"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi/sandbox/secured"
description: "Sandbox"
- url: "https://secured-openapi.tbank.ru"
description: "Production"
/api/v1/counterparty/contracts:
get:
tags:
- "Проверка контрагентов"
summary: "Получить список контрактов"
description: "Метод для получения списка контрактов."
operationId: "getApiV1CounterpartyContracts"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "limit"
in: "query"
required: true
style: "form"
explode: true
schema:
maximum: 100
minimum: 1
type: "integer"
format: "int32"
- name: "offset"
in: "query"
required: true
style: "form"
explode: true
schema:
type: "integer"
format: "int32"
- name: "ogrn"
in: "query"
description: "Основной государственный регистрационный номер."
required: true
style: "form"
explode: true
schema:
pattern: "^\\d{13,15}$"
type: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "companyCard"
- "data"
type: "object"
properties:
companyCard:
required:
- "pages"
- "requisites"
- "statusType"
type: "object"
properties:
statusType:
type: "string"
description: "Статус компании."
enum:
- "active"
- "reorganizing"
- "liquidating"
- "liquidated"
- "bankrupting"
- "unknown"
requisites:
required:
- "ogrn"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
shortName:
type: "string"
format: "string"
nullable: true
fullName:
type: "string"
format: "string"
nullable: true
dateReg:
type: "string"
format: "date"
nullable: true
terminationDt:
type: "string"
format: "date"
nullable: true
status:
type: "string"
format: "string"
nullable: true
authorizedCapitalAmount:
type: "number"
format: "double"
nullable: true
ogrnAssignDate:
type: "string"
format: "date"
nullable: true
legalAddress:
type: "string"
format: "string"
nullable: true
city:
type: "string"
format: "string"
nullable: true
description: "Реквизиты."
pages:
maxItems: 20
type: "array"
items:
required:
- "page"
type: "object"
properties:
page:
type: "string"
description: "Код страницы."
enum:
- "okved"
- "contract"
- "license"
- "history"
- "trafficLight"
- "relatedCompanies"
- "feedback"
- "financialStatements"
- "enforcementProceedings"
- "inspections"
description: "Информация о странице."
description: "Карточка компании."
data:
required:
- "items"
- "total"
type: "object"
properties:
total:
type: "integer"
format: "int64"
items:
maxItems: 100
type: "array"
items:
required:
- "contractId"
- "counterpartyOgrn"
- "role"
type: "object"
properties:
contractId:
pattern: "^(\\d{19})$"
type: "string"
counterpartyOgrn:
pattern: "^\\d{13,15}$"
type: "string"
purchaseObjectTypeName:
type: "string"
format: "string"
nullable: true
stageCode:
type: "string"
description: "Статус контракта:\n\n\n* `execution` —\
\ исполнение;\n\n* `stopped` — аннулировано;\n\n*\
\ `completed` — исполнение завершено;\n\n* `canceled`\
\ — исполнение прекращено;\n\n* `unknown` — неизве\
стный статус."
enum:
- "execution"
- "completed"
- "canceled"
- "stopped"
- "unknown"
role:
type: "string"
description: "Роль в контракте."
enum:
- "supplier"
- "customer"
price:
type: "number"
format: "double"
nullable: true
description: "Гос. контракты компании."
example:
companyCard:
statusType: "active"
requisites:
inn: "000000000000"
ogrn: "1000000000000"
kpp: "000000000"
shortName: "ПАО \"НАЗВАНИЕ\""
fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\""
dateReg: "1996-06-21"
terminationDt: "2020-11-20"
status: "Действующая организация"
authorizedCapitalAmount: 3975771140
ogrnAssignDate: "2000-01-01"
legalAddress: "119019, г Москва, ул Арбат"
city: "Москва"
pages:
- page: "okved"
- page: "contract"
- page: "license"
- page: "history"
- page: "trafficLight"
- page: "feedback"
- page: "financialStatements"
data:
total: 164
items:
- contractId: "0173200000000000071"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "completed"
role: "supplier"
price: 612000
- contractId: "1490000000000000006"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "execution"
role: "supplier"
price: 664976
- contractId: "1870000000000000002"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "execution"
role: "supplier"
price: 6000000
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "1b3c8ae867bc100d"
errorCode: "INVALID"
errorMessage: "Некорректный ОГРН: 1000000000000"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "1b3c8ae867bc100d"
errorCode: "NO_DATA"
errorMessage: "Данные не найдены: ОГРН 000000000000000"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/v1/counterparty/excerpt:
get:
tags:
- "Проверка контрагентов"
summary: "Получить общую выписку для проверки контрагента по ОГРН/ОГРНИП"
description: "Метод для получения выписки по контрагенту — тип компании, вып\
иска по организации, выписка по ИП, общая информация о компании."
operationId: "getApiV1CounterpartyExcerpt"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "ogrn"
in: "query"
description: "Основной государственный регистрационный номер."
required: true
style: "form"
explode: true
schema:
pattern: "^\\d{13,15}$"
type: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "companyCard"
- "companyType"
- "excerpt"
type: "object"
properties:
companyType:
type: "string"
description: "Тип компании."
enum:
- "entrepreneur"
- "company"
companyExcerpt:
required:
- "address"
- "bankruptcyMessage"
- "expressExcerpt"
- "fts"
- "includeInList"
- "leaders"
- "okved"
- "phones"
type: "object"
properties:
shortName:
maxLength: 1000
type: "string"
description: "Краткое наименование компании."
nullable: true
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
description: "ОГРН."
nullable: true
okpo:
pattern: "^(\\d{8}|\\d{10})$"
type: "string"
description: "ОКПО."
nullable: true
isActing:
type: "boolean"
description: "Признак действующей компании."
nullable: true
normName:
maxLength: 1000
type: "string"
description: "Нормализованное наименование компании."
nullable: true
shortNameRus:
maxLength: 1000
type: "string"
description: "Краткое наименование компании."
nullable: true
shortNameEn:
maxLength: 1000
type: "string"
description: "Краткое наименование компании на английском\
\ языке."
nullable: true
dateFirstReg:
type: "string"
description: "Дата регистрации."
format: "date"
nullable: true
fullNameRus:
maxLength: 1000
type: "string"
description: "Полное наименование компании на русском."
nullable: true
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
description: "КПП."
nullable: true
bik:
pattern: "^(\\d{9}|0)$"
type: "string"
description: "БИК."
nullable: true
email:
type: "string"
description: "Электронная почта."
format: "email"
nullable: true
www:
maxLength: 512
type: "string"
description: "Веб-сайт."
nullable: true
registerNumber:
maxLength: 512
type: "string"
description: "Регистрационный номер."
nullable: true
okato:
required:
- "value"
type: "object"
properties:
value:
type: "string"
format: "string"
code:
pattern: "^(\\d{2,11})$"
type: "string"
nullable: true
regionName:
maxLength: 512
type: "string"
description: "Название региона."
nullable: true
regionCode:
type: "integer"
description: "Код региона."
format: "int32"
nullable: true
description: "ОКАТО."
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
phones:
maxItems: 200
type: "array"
items:
type: "object"
properties:
code:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора)."
nullable: true
number:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
description: "Номера телефонов."
finance:
type: "object"
properties:
balanceType:
type: "integer"
format: "int64"
nullable: true
periods:
maxItems: 200
type: "array"
description: "Бухгалтерская отчетность."
nullable: true
items:
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
description: "Отчетный период."
nullable: true
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Начало периода."
format: "string"
nullable: true
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Конец периода."
format: "string"
nullable: true
data:
maxItems: 200
type: "array"
nullable: true
items:
type: "object"
properties:
form:
maxLength: 512
type: "string"
description: "Форма."
nullable: true
section:
maxLength: 512
type: "string"
description: "Раздел."
nullable: true
name:
maxLength: 512
type: "string"
description: "Наименование."
nullable: true
code:
maxLength: 512
type: "string"
description: "Код."
nullable: true
value:
maxLength: 512
type: "string"
description: "Значение."
nullable: true
id:
type: "integer"
description: "Идентификатор списка."
format: "int32"
nullable: true
leaders:
maxItems: 500
type: "array"
description: "Руководители."
items:
type: "object"
properties:
actualDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Дата актуальности."
format: "string"
nullable: true
name:
type: "string"
description: "Наименование."
format: "string"
nullable: true
position:
type: "string"
description: "Должность."
format: "string"
nullable: true
managementCompany:
type: "string"
format: "string"
nullable: true
managementCompanyINN:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
structure:
type: "object"
properties:
countCoownerFCSM:
type: "integer"
description: "Количество совладельцев (данные компании\
/ФСФР)."
format: "int32"
nullable: true
countCoownerRosstat:
type: "integer"
description: "Количество совладельцев (Росстат)."
format: "int32"
nullable: true
countCoownerEGRUL:
type: "integer"
description: "Количество совладельцев (ЕГРЮЛ)."
format: "int32"
nullable: true
countBranch:
type: "integer"
description: "Количество филиалов (данные компании)."
format: "int32"
nullable: true
countBranchRosstat:
type: "integer"
description: "Количество филиалов (Росстат)."
format: "int32"
nullable: true
countBranchEGRUL:
type: "integer"
description: "Количество филиалов (ЕГРЮЛ)."
format: "int32"
nullable: true
countCoownerDKCPFR:
type: "integer"
format: "int32"
nullable: true
countCoownerUkrStat:
type: "integer"
format: "int32"
nullable: true
countAffiliatedCompany:
type: "integer"
format: "int32"
nullable: true
countAffiliatedCompanyFCSM:
type: "integer"
description: "Количество дочерних компаний (данные ком\
пании)."
format: "int32"
nullable: true
countAffiliatedCompanyRosstat:
type: "integer"
description: "Количество дочерних компаний (Росстат)."
format: "int32"
nullable: true
countAffiliatedCompanyEGRUL:
type: "integer"
description: "Количество дочерних компаний (ЕГРЮЛ)."
format: "int32"
nullable: true
nonprofitOrganizationRosstat:
type: "integer"
description: "Количество некоммерческих партнерств (Ро\
сстат)."
format: "int32"
nullable: true
activeBranchesRosstatNumber:
type: "integer"
format: "int32"
nullable: true
activeAffiliatedCompaniesNumber:
type: "integer"
format: "int32"
nullable: true
proceedings:
required:
- "active"
- "executed"
type: "object"
properties:
active:
type: "integer"
description: "Количество непогашенных обязательств."
format: "int32"
executed:
type: "integer"
description: "Количество погашенных обязательств."
format: "int32"
charterCapital:
type: "object"
properties:
value:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
currencyCode:
maxLength: 512
type: "string"
nullable: true
currencyName:
maxLength: 512
type: "string"
nullable: true
charterCapitalHistory:
maxItems: 200
type: "array"
description: "История изменения уставного капитала."
nullable: true
items:
type: "object"
properties:
value:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
currencyCode:
maxLength: 512
type: "string"
nullable: true
currencyName:
maxLength: 512
type: "string"
nullable: true
companyWithSameInfo:
type: "object"
properties:
telephoneCount:
required:
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int32"
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
phoneList:
maxItems: 500
type: "array"
nullable: true
items:
required:
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int32"
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора\
)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
addressCount:
type: "integer"
format: "int32"
nullable: true
addressWithoutRoomCount:
type: "integer"
format: "int32"
nullable: true
addressNotAffiliatedCount:
type: "integer"
format: "int32"
nullable: true
addressFTSCount:
type: "integer"
format: "int32"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerCountInRegion:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
companyLiquidatedWithSameInfo:
type: "object"
properties:
addressCount:
type: "integer"
format: "int32"
nullable: true
addressWithoutRoomCount:
type: "integer"
format: "int32"
nullable: true
arbitrationCases:
type: "object"
properties:
cases:
maxItems: 200
type: "array"
nullable: true
items:
required:
- "defendant"
- "plaintiff"
- "thirdOrOtherPerson"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
plaintiff:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
defendant:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
thirdOrOtherPerson:
required:
- "casesNumber"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
total:
type: "integer"
format: "int32"
nullable: true
considered:
type: "integer"
format: "int32"
nullable: true
appealed:
type: "integer"
format: "int32"
nullable: true
decisionsAndRulings:
type: "integer"
format: "int32"
nullable: true
completed:
type: "integer"
format: "int32"
nullable: true
federalTaxRegistrationPayment:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
federalTaxRegistrationCurrent:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
okved:
maxItems: 2500
type: "array"
description: "ОКВЭД."
items:
required:
- "isMain"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description: "Код."
nullable: true
name:
maxLength: 1000
type: "string"
description: "Наименование."
nullable: true
isMain:
type: "boolean"
description: "Признак основного ОКВЭД."
isMainEgrul:
type: "boolean"
description: "Признак основного ОКВЭД по данным ЕГРЮ\
Л."
nullable: true
isMainRosstat:
type: "boolean"
description: "Признак основного ОКВЭД по данным Росс\
тата."
nullable: true
stateContracts:
type: "object"
properties:
federalLaw94:
maxItems: 200
type: "array"
description: "Данные о госконтрактах за соответствующи\
й год."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
federalLaw223:
maxItems: 200
type: "array"
description: "Данные о тендерах за соответствующий год\
."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
address:
maxItems: 200
type: "array"
description: "Местонахождение."
items:
type: "object"
properties:
postCode:
pattern: "^(\\d{6})$"
type: "string"
nullable: true
address:
maxLength: 1000
type: "string"
nullable: true
streetName:
maxLength: 1000
type: "string"
nullable: true
buildingNumber:
maxLength: 512
type: "string"
nullable: true
fiasGUID:
type: "string"
format: "uuid"
nullable: true
isHouseFiasGUID:
type: "boolean"
nullable: true
fiasCode:
maxLength: 512
type: "string"
nullable: true
fiasRegion:
maxLength: 512
type: "string"
nullable: true
fiasArea:
maxLength: 512
type: "string"
nullable: true
fiasCity:
maxLength: 512
type: "string"
nullable: true
fiasPlace:
maxLength: 512
type: "string"
nullable: true
fiasPlan:
maxLength: 512
type: "string"
nullable: true
fiasStreet:
maxLength: 512
type: "string"
nullable: true
actualDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
buildingType:
maxLength: 512
type: "string"
nullable: true
businessCenterName:
maxLength: 512
type: "string"
nullable: true
fts:
maxItems: 200
type: "array"
items:
type: "object"
properties:
endDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Контрактов подписано на сумму, рубли."
format: "string"
nullable: true
income:
type: "string"
format: "string"
nullable: true
expenses:
type: "string"
format: "string"
nullable: true
taxes:
type: "object"
properties:
sum:
type: "string"
format: "string"
nullable: true
tax:
maxItems: 200
type: "array"
nullable: true
items:
type: "object"
properties:
id:
type: "integer"
format: "int32"
nullable: true
name:
type: "string"
format: "string"
nullable: true
sum:
type: "string"
format: "string"
nullable: true
taxArrears:
type: "object"
properties:
tax:
maxItems: 200
type: "array"
nullable: true
items:
required:
- "id"
type: "object"
properties:
id:
type: "integer"
description: "Идентификатор налога/сбора."
format: "int64"
name:
type: "string"
description: "Наименование налога/сбора."
format: "string"
nullable: true
finesSum:
type: "string"
description: "Сумма задолженности по пени."
format: "string"
nullable: true
penaltiesSum:
type: "string"
description: "Сумма задолженности по штраф\
ам."
format: "string"
nullable: true
sum:
type: "string"
format: "string"
nullable: true
taxPenalties:
type: "object"
properties:
sum:
type: "string"
format: "string"
nullable: true
includeInList:
maxItems: 200
type: "array"
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
bankruptcyMessage:
maxItems: 3000
type: "array"
items:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
expressExcerpt:
required:
- "companyType"
- "frozenAccountDecisions"
- "negativeLists"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
nullable: true
companyType:
type: "string"
description: "Тип компании."
enum:
- "entrepreneur"
- "company"
companyWithSameInfo:
required:
- "sameAddress"
- "sameManager"
- "samePhone"
type: "object"
properties:
sameManager:
type: "object"
properties:
manager:
maxLength: 512
type: "string"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
sameAddress:
type: "object"
properties:
address:
maxLength: 1000
type: "string"
nullable: true
addressCount:
type: "integer"
format: "int32"
nullable: true
samePhone:
type: "object"
properties:
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператор\
а)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
phoneCount:
type: "integer"
format: "int32"
nullable: true
negativeLists:
maxItems: 200
type: "array"
description: "Негативные списки, в которых состоит ком\
пания."
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
okvedInfo:
required:
- "okvedCount"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
nullable: true
name:
type: "string"
format: "string"
nullable: true
okvedCount:
type: "integer"
format: "int32"
netIncome:
required:
- "dateBegin"
- "dateEnd"
- "periodName"
- "sum"
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
sum:
maxLength: 512
type: "string"
taxYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
financeYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
stateContractYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
activeProceedingsCount:
type: "integer"
description: "Количество активных исполнительных произ\
водств (долгов)."
format: "int32"
nullable: true
bankruptcyMessage:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
frozenAccountDecisions:
maxItems: 200
type: "array"
description: "Есть решение о приостановлении операций\
\ по счетам."
items:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
reason:
type: "object"
properties:
id:
type: "integer"
format: "int32"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
taxAuthority:
type: "object"
properties:
code:
maxLength: 512
type: "string"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
bank:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
bik:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
name:
maxLength: 512
type: "string"
nullable: true
number:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
arbitrationCasesInfo:
required:
- "count"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
count:
type: "integer"
format: "int32"
description: "Выписка по организации."
entrepreneurExcerpt:
required:
- "bankruptcyMessage"
- "expressExcerpt"
- "includeInList"
- "okved"
- "phoneList"
- "submittedStatements"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
ogrnip:
pattern: "^\\d{15}$"
type: "string"
nullable: true
okpo:
pattern: "^(\\d{8}|\\d{10})$"
type: "string"
nullable: true
birthDate:
type: "string"
format: "date"
nullable: true
birthPlace:
type: "string"
format: "string"
nullable: true
fullNameRus:
type: "string"
format: "string"
nullable: true
sex:
type: "string"
enum:
- "man"
- "woman"
- "undefined"
dateReg:
type: "string"
format: "date"
nullable: true
okato:
required:
- "value"
type: "object"
properties:
value:
type: "string"
format: "string"
code:
pattern: "^(\\d{2,11})$"
type: "string"
nullable: true
regionName:
maxLength: 512
type: "string"
description: "Название региона."
nullable: true
regionCode:
type: "integer"
description: "Код региона."
format: "int32"
nullable: true
description: "ОКАТО."
okopf:
type: "object"
properties:
code:
pattern: "^(\\d{5})$"
type: "string"
nullable: true
name:
maxLength: 512
type: "string"
nullable: true
phoneList:
maxItems: 200
type: "array"
items:
type: "object"
properties:
code:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора)."
nullable: true
number:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
description: "Номера телефонов."
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
includeInList:
maxItems: 200
type: "array"
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
federalTaxRegistrationPayment:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
federalTaxRegistrationCurrent:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
citizenship:
required:
- "code"
- "name"
type: "object"
properties:
code:
type: "integer"
format: "int32"
name:
type: "string"
format: "string"
okved:
maxItems: 2500
type: "array"
items:
required:
- "isMain"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description: "Код."
nullable: true
name:
maxLength: 1000
type: "string"
description: "Наименование."
nullable: true
isMain:
type: "boolean"
description: "Признак основного ОКВЭД."
isMainEgrul:
type: "boolean"
description: "Признак основного ОКВЭД по данным ЕГРЮ\
Л."
nullable: true
isMainRosstat:
type: "boolean"
description: "Признак основного ОКВЭД по данным Росс\
тата."
nullable: true
registrationInFunds:
type: "object"
properties:
pensionFund:
required:
- "regAuthority"
- "registerNumber"
- "registrationDate"
type: "object"
properties:
registrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
deregistrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
registerNumber:
type: "string"
format: "string"
regAuthority:
type: "string"
format: "string"
socialInsuranceFund:
required:
- "regAuthority"
- "registerNumber"
- "registrationDate"
type: "object"
properties:
registrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
deregistrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
registerNumber:
type: "string"
format: "string"
regAuthority:
type: "string"
format: "string"
compulsoryMedicalInsuranceFund:
required:
- "regAuthority"
- "registerNumber"
- "registrationDate"
type: "object"
properties:
registrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
deregistrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
registerNumber:
type: "string"
format: "string"
regAuthority:
type: "string"
format: "string"
submittedStatements:
maxItems: 200
type: "array"
items:
type: "object"
properties:
form:
type: "string"
format: "string"
nullable: true
submissionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
availabilityDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
grn:
type: "string"
format: "string"
nullable: true
decisionType:
type: "string"
format: "string"
nullable: true
stateContracts:
type: "object"
properties:
federalLaw94:
maxItems: 200
type: "array"
description: "Данные о госконтрактах за соответствующи\
й год."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
federalLaw223:
maxItems: 200
type: "array"
description: "Данные о тендерах за соответствующий год\
."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
arbitrationCases:
type: "object"
properties:
cases:
maxItems: 200
type: "array"
nullable: true
items:
required:
- "defendant"
- "plaintiff"
- "thirdOrOtherPerson"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
plaintiff:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
defendant:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
thirdOrOtherPerson:
required:
- "casesNumber"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
total:
type: "integer"
format: "int32"
nullable: true
considered:
type: "integer"
format: "int32"
nullable: true
appealed:
type: "integer"
format: "int32"
nullable: true
decisionsAndRulings:
type: "integer"
format: "int32"
nullable: true
completed:
type: "integer"
format: "int32"
nullable: true
executionProceedings:
required:
- "active"
- "executed"
type: "object"
properties:
active:
type: "integer"
description: "Количество непогашенных обязательств."
format: "int32"
executed:
type: "integer"
description: "Количество погашенных обязательств."
format: "int32"
bankruptcyMessage:
maxItems: 3000
type: "array"
items:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
expressExcerpt:
required:
- "companyType"
- "frozenAccountDecisions"
- "negativeLists"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
nullable: true
companyType:
type: "string"
description: "Тип компании."
enum:
- "entrepreneur"
- "company"
companyWithSameInfo:
required:
- "sameAddress"
- "sameManager"
- "samePhone"
type: "object"
properties:
sameManager:
type: "object"
properties:
manager:
maxLength: 512
type: "string"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
sameAddress:
type: "object"
properties:
address:
maxLength: 1000
type: "string"
nullable: true
addressCount:
type: "integer"
format: "int32"
nullable: true
samePhone:
type: "object"
properties:
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператор\
а)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
phoneCount:
type: "integer"
format: "int32"
nullable: true
negativeLists:
maxItems: 200
type: "array"
description: "Негативные списки, в которых состоит ком\
пания."
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
okvedInfo:
required:
- "okvedCount"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
nullable: true
name:
type: "string"
format: "string"
nullable: true
okvedCount:
type: "integer"
format: "int32"
netIncome:
required:
- "dateBegin"
- "dateEnd"
- "periodName"
- "sum"
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
sum:
maxLength: 512
type: "string"
taxYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
financeYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
stateContractYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
activeProceedingsCount:
type: "integer"
description: "Количество активных исполнительных произ\
водств (долгов)."
format: "int32"
nullable: true
bankruptcyMessage:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
frozenAccountDecisions:
maxItems: 200
type: "array"
description: "Есть решение о приостановлении операций\
\ по счетам."
items:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
reason:
type: "object"
properties:
id:
type: "integer"
format: "int32"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
taxAuthority:
type: "object"
properties:
code:
maxLength: 512
type: "string"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
bank:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
bik:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
name:
maxLength: 512
type: "string"
nullable: true
number:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
arbitrationCasesInfo:
required:
- "count"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
count:
type: "integer"
format: "int32"
description: "Выписка по ИП."
companyCard:
required:
- "pages"
- "requisites"
- "statusType"
type: "object"
properties:
statusType:
type: "string"
description: "Статус компании."
enum:
- "active"
- "reorganizing"
- "liquidating"
- "liquidated"
- "bankrupting"
- "unknown"
requisites:
required:
- "ogrn"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
shortName:
type: "string"
format: "string"
nullable: true
fullName:
type: "string"
format: "string"
nullable: true
dateReg:
type: "string"
format: "date"
nullable: true
terminationDt:
type: "string"
format: "date"
nullable: true
status:
type: "string"
format: "string"
nullable: true
authorizedCapitalAmount:
type: "number"
format: "double"
nullable: true
ogrnAssignDate:
type: "string"
format: "date"
nullable: true
legalAddress:
type: "string"
format: "string"
nullable: true
city:
type: "string"
format: "string"
nullable: true
description: "Реквизиты."
pages:
maxItems: 20
type: "array"
items:
required:
- "page"
type: "object"
properties:
page:
type: "string"
description: "Код страницы."
enum:
- "okved"
- "contract"
- "license"
- "history"
- "trafficLight"
- "relatedCompanies"
- "feedback"
- "financialStatements"
- "enforcementProceedings"
- "inspections"
description: "Информация о странице."
description: "Карточка компании."
excerpt:
required:
- "checkResult"
- "contractSummary"
- "contracts"
- "financialStatementsResponse"
- "founders"
- "history"
- "leaders"
- "licenseSummary"
- "licenses"
- "okvedSummary"
- "relatedCompanies"
- "relationSummary"
- "requisites"
- "trafficLightColors"
type: "object"
properties:
requisites:
type: "object"
properties:
legalForm:
type: "string"
format: "string"
nullable: true
organizationSizeDesc:
type: "string"
format: "string"
nullable: true
entityRegistrationDate:
type: "string"
format: "date"
nullable: true
regAuthorityAddressTxt:
type: "string"
format: "string"
nullable: true
regAuthorityName:
type: "string"
format: "string"
nullable: true
pfrRegistrationNumber:
type: "string"
format: "string"
nullable: true
pfrAuthorityName:
type: "string"
format: "string"
nullable: true
pfrRegistrationDate:
type: "string"
format: "date"
nullable: true
insRegistrationNumber:
type: "string"
format: "string"
nullable: true
insAuthorityName:
type: "string"
format: "string"
nullable: true
insRegistrationDate:
type: "string"
format: "date"
nullable: true
description: "Дополнительные реквизиты."
okvedSummary:
required:
- "additional"
- "count"
- "main"
type: "object"
properties:
count:
type: "integer"
format: "int64"
main:
maxItems: 100
type: "array"
items:
required:
- "code"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description:
type: "string"
format: "string"
nullable: true
description: "ОКВЭД."
additional:
maxItems: 100
type: "array"
items:
required:
- "code"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description:
type: "string"
format: "string"
nullable: true
description: "ОКВЭД."
description: "ОКВЭДы."
contractSummary:
required:
- "admittedCount"
- "count"
- "notAdmittedCount"
type: "object"
properties:
count:
type: "integer"
format: "int64"
admittedCount:
type: "integer"
format: "int64"
notAdmittedCount:
type: "integer"
format: "int64"
totalValue:
type: "number"
format: "double"
nullable: true
description: "Гос. контракты."
licenseSummary:
required:
- "active"
- "inactive"
- "total"
type: "object"
properties:
total:
type: "integer"
format: "int64"
active:
type: "integer"
format: "int64"
inactive:
type: "integer"
format: "int64"
description: "Количество лицензий."
trafficLightColors:
required:
- "greenCount"
- "redCount"
- "yellowCount"
type: "object"
properties:
redCount:
type: "integer"
format: "int32"
yellowCount:
type: "integer"
format: "int32"
greenCount:
type: "integer"
format: "int32"
description: "Результаты экспресс-проверки."
innerCheckResult:
required:
- "activeProceedings"
- "bankruptcyMessage"
- "defendant"
- "defendantDynamic"
- "disqualifiedPersons"
- "executedProceedings"
- "finance"
- "invalidLegalAddress"
- "isNegative"
- "plaintiff"
- "sameAddressNumber"
- "sameManager"
- "taxDebt"
- "taxReport"
- "thirdOrOtherPerson"
- "unfairSupplier"
type: "object"
properties:
bankruptcyMessage:
required:
- "color"
type: "object"
properties:
value:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\
d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\
d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
plaintiff:
required:
- "color"
type: "object"
properties:
value:
required:
- "maxDate"
- "minDate"
- "totalCases"
type: "object"
properties:
minDate:
type: "integer"
description: "Наименьший год с судебными делам\
и."
format: "int32"
maxDate:
type: "integer"
description: "Наибольший год с судебными делам\
и."
format: "int32"
totalCases:
type: "integer"
format: "int32"
description: "Статистика по судебным делам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
thirdOrOtherPerson:
required:
- "color"
type: "object"
properties:
value:
required:
- "maxDate"
- "minDate"
- "totalCases"
type: "object"
properties:
minDate:
type: "integer"
description: "Наименьший год с судебными делам\
и."
format: "int32"
maxDate:
type: "integer"
description: "Наибольший год с судебными делам\
и."
format: "int32"
totalCases:
type: "integer"
format: "int32"
description: "Статистика по судебным делам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
defendant:
required:
- "color"
type: "object"
properties:
value:
required:
- "maxDate"
- "minDate"
- "totalCases"
type: "object"
properties:
minDate:
type: "integer"
description: "Наименьший год с судебными делам\
и."
format: "int32"
maxDate:
type: "integer"
description: "Наибольший год с судебными делам\
и."
format: "int32"
totalCases:
type: "integer"
format: "int32"
description: "Статистика по судебным делам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
defendantDynamic:
required:
- "color"
type: "object"
properties:
value:
required:
- "lastYear"
- "percent"
- "prevLastYear"
type: "object"
properties:
lastYear:
type: "integer"
format: "int32"
prevLastYear:
type: "integer"
format: "int32"
percent:
type: "number"
format: "double"
description: "Динамика судебных дел в качестве отв\
етчика."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
executedProceedings:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
activeProceedings:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
sameManager:
required:
- "color"
type: "object"
properties:
value:
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
sameManager:
type: "object"
properties:
manager:
maxLength: 512
type: "string"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
description: "Массовый руководитель."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
sameAddressNumber:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
finance:
required:
- "color"
type: "object"
properties:
value:
type: "object"
properties:
balanceType:
type: "integer"
format: "int64"
nullable: true
periods:
maxItems: 200
type: "array"
description: "Бухгалтерская отчетность."
nullable: true
items:
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
description: "Отчетный период."
nullable: true
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\
d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Начало периода."
format: "string"
nullable: true
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\
d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Конец периода."
format: "string"
nullable: true
data:
maxItems: 200
type: "array"
nullable: true
items:
type: "object"
properties:
form:
maxLength: 512
type: "string"
description: "Форма."
nullable: true
section:
maxLength: 512
type: "string"
description: "Раздел."
nullable: true
name:
maxLength: 512
type: "string"
description: "Наименование."
nullable: true
code:
maxLength: 512
type: "string"
description: "Код."
nullable: true
value:
maxLength: 512
type: "string"
description: "Значение."
nullable: true
id:
type: "integer"
description: "Идентификатор списка\
."
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
isNegative:
required:
- "color"
- "value"
type: "object"
properties:
value:
required:
- "negativeListsCount"
type: "object"
properties:
negativeListsCount:
type: "integer"
format: "int32"
description: "Статистика негативных списков."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
unfairSupplier:
required:
- "color"
type: "object"
properties:
value:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
invalidLegalAddress:
required:
- "color"
type: "object"
properties:
value:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
disqualifiedPersons:
required:
- "color"
type: "object"
properties:
value:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
taxReport:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
taxDebt:
required:
- "color"
type: "object"
properties:
value:
required:
- "statDate"
- "sum"
type: "object"
properties:
sum:
type: "number"
format: "double"
statDate:
type: "string"
format: "date"
description: "Налоговая задолженность."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
description: "Результат внутренней проверки компании:\n\n\
* `BankruptcyMessage` — сообщения о банкротстве;\n\n* `Plaintiff`\
\ — судебные дела в качестве истца;\n\n* `ThirdOrOtherPerson`\
\ — судебные дела в качестве третьего лица;\n\n* `Defendant`\
\ — судебные дела в качестве ответчика;\n\n* `DefendantDynamic`\
\ — динамика судебных дел в качестве ответчика;\n\n* `ExecutedProceedings`\
\ — завершенные исполнительные производства;\n\n* `ActiveProceedings`\
\ — активные исполнительные производства;\n\n* `SameManager`\
\ — массовый руководитель;\n\n* `SameAddressNumber` — ма\
ссовый юридический адрес;\n\n* `Finance` — бухгалтерская\
\ отчетность;\n\n* `IsNegative` — негативные списки;\n\n\
* `UnfairSupplier` — реестр недобросовестных поставщиков\
;\n\n* `InvalidLegalAddress` — список компаний, отсутств\
ующих по юридическому адресу;\n\n* `DisqualifiedPersons`\
\ — реестр дисквалифицированных лиц;\n\n* `ReferenceCheckRecommended`\
\ — рекомендация проверки в справочных источниках;\n\n*\
\ `DueDiligenceRecommended` — рекомендация проведения до\
кументальной проверки (Due Diligence);\n\n* `TaxReport`\
\ — налоговая отчетность;\n\n* `TaxDebt` — налоговая зад\
олженность."
checkResult:
required:
- "admittedContractsAsSupplier"
- "authorizedCapitalAmount"
- "confidantChangeDate"
- "founderChangeDate"
- "legalAddressChangeDate"
- "legalForm"
- "licensedOkvedCount"
- "okvedCount"
- "registrationDate"
- "riskLevel"
- "status"
type: "object"
properties:
status:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
registrationDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
legalAddressChangeDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
founderChangeDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
confidantChangeDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
authorizedCapitalAmount:
required:
- "color"
type: "object"
properties:
value:
type: "number"
format: "double"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
admittedContractsAsSupplier:
required:
- "color"
- "value"
type: "object"
properties:
value:
required:
- "count"
type: "object"
properties:
count:
type: "integer"
format: "int64"
totalValue:
type: "number"
format: "double"
nullable: true
description: "Статистика по контрактам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
legalForm:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
okvedCount:
required:
- "color"
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int64"
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
licensedOkvedCount:
required:
- "color"
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int64"
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
riskLevel:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
description: "Результат проверки компании:\n\n* `Status` —\
\ статус компании;\n\n* `RegistrationDate` — проверка да\
ты регистрации на превышение трех лет;\n\n* `LegalAddressChangeDate`\
\ — проверка изменения юридического адреса за последний\
\ год;\n\n* `FounderChangeDate` — проверка изменения учр\
едителя за последний год;\n\n* `ConfidantChangeDate` — п\
роверка изменения руководителя за последний год;\n\n* `AuthorizedCapitalAmount`\
\ — проверка превышения уставного капитала минимального\
\ порога;\n\n* `AdmittedContractsAsSupplier` — участие в\
\ государственных закупках;\n\n* `LegalForm` — организац\
ионно-правовая форма организации;\n\n* `OkvedCount` — ко\
личество видов деятельности, превышающих порог;\n\n* `LicensedOkvedCount`\
\ — проверка соответствия лицензии коду ОКВЭД;\n\n* `RiskLevel`\
\ — уровень риска."
relationSummary:
required:
- "relatedByConfidant"
- "relatedByFounder"
- "total"
type: "object"
properties:
total:
type: "integer"
format: "int32"
relatedByFounder:
type: "integer"
format: "int32"
relatedByConfidant:
type: "integer"
format: "int32"
description: "Связанные компании."
relatedCompanies:
maxItems: 4
type: "array"
items:
required:
- "ogrn"
type: "object"
properties:
name:
type: "string"
format: "string"
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
description: "Короткое описание связанной компании."
leaders:
maxItems: 100
type: "array"
items:
required:
- "name"
type: "object"
properties:
actualDate:
type: "string"
format: "date"
nullable: true
name:
type: "string"
format: "string"
position:
type: "string"
format: "string"
nullable: true
description: "Руководитель."
founders:
maxItems: 10000
type: "array"
items:
required:
- "name"
type: "object"
properties:
name:
type: "string"
format: "string"
nominalCostAmount:
type: "number"
format: "double"
nullable: true
sharePercent:
type: "number"
format: "double"
nullable: true
description: "Учредители."
history:
maxItems: 3
type: "array"
items:
required:
- "oldParamValue"
- "paramName"
- "paramText"
- "paramValue"
type: "object"
properties:
paramText:
type: "string"
format: "string"
changeDate:
type: "string"
format: "date"
nullable: true
paramName:
type: "string"
format: "string"
oldParamValue:
type: "string"
format: "string"
paramValue:
type: "string"
format: "string"
description: "Измененные данные."
licenses:
maxItems: 3
type: "array"
items:
required:
- "activity"
- "address"
- "status"
type: "object"
properties:
"no":
type: "string"
format: "string"
nullable: true
authorityName:
type: "string"
format: "string"
nullable: true
date:
type: "string"
format: "date"
nullable: true
startDate:
type: "string"
format: "date"
nullable: true
endDate:
type: "string"
format: "date"
nullable: true
address:
maxItems: 1200
type: "array"
items:
type: "string"
format: "string"
activity:
maxItems: 100
type: "array"
items:
type: "string"
format: "string"
status:
type: "string"
description: "Статус лицензии."
enum:
- "active"
- "inactive"
- "unknown"
description: "Лицензия."
contracts:
maxItems: 3
type: "array"
items:
required:
- "contractId"
- "counterpartyOgrn"
- "role"
type: "object"
properties:
contractId:
pattern: "^(\\d{19})$"
type: "string"
counterpartyOgrn:
pattern: "^\\d{13,15}$"
type: "string"
purchaseObjectTypeName:
type: "string"
format: "string"
nullable: true
stageCode:
type: "string"
description: "Статус контракта:\n\n\n* `execution` —\
\ исполнение;\n\n* `stopped` — аннулировано;\n\n*\
\ `completed` — исполнение завершено;\n\n* `canceled`\
\ — исполнение прекращено;\n\n* `unknown` — неизве\
стный статус."
enum:
- "execution"
- "completed"
- "canceled"
- "stopped"
- "unknown"
role:
type: "string"
description: "Роль в контракте."
enum:
- "supplier"
- "customer"
price:
type: "number"
format: "double"
nullable: true
description: "Гос. контракты компании."
financialStatementsResponse:
type: "object"
properties:
reason:
required:
- "reasonCode"
- "reasonText"
type: "object"
properties:
reasonCode:
type: "string"
description: "Коды для причин отсутствия финансово\
й отчетности."
enum:
- "isEntrepreneur"
- "lessThanYear"
- "noData"
reasonText:
maxLength: 512
type: "string"
description: "Данные о причине отсутствия финансовой о\
тчетности."
financialStatementsData:
required:
- "accountsPayable"
- "accountsReceivable"
- "profit"
- "revenue"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
revenue:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Выручка."
profit:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Прибыль."
accountsPayable:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Кредиторский долг."
accountsReceivable:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Дебиторский долг."
description: "Финансовая отчетность для excerpt."
description: "Обертка для данных по финансовой отчетности\
\ или для причины их отсутствия."
description: "Общая информация о компании."
description: "Выписка по компании."
example:
companyType: "company"
companyExcerpt:
shortName: ""
inn: "000000000000"
ogrn: "1000000000000"
okpo: "0000000000"
isActing: true
normName: "Название, ОАО"
shortNameRus: "ОАО \"Название\""
shortNameEn: "OAO \"Name\""
dateFirstReg: "1999-01-01"
fullNameRus: "ОТКРЫТОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\""
kpp: "000000000"
bik: "000000000"
email: "example@example.ru"
www: "www.example.ru"
registerNumber: ""
okato:
value: ""
code: "00086552000"
regionName: "Москва"
regionCode: 45
status:
isActing: true
date: "2023-04-24+03:00"
text: ""
type: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
phones:
- code: "342"
number: "0000000"
- code: "384"
number: "0000000"
- code: "385"
number: "0000000"
finance:
balanceType: 1
periods:
- periodName: "2015"
dateBegin: "2015-01-01+03:00"
dateEnd: "2015-12-31+03:00"
data:
- form: "Баланс"
section: "Актив"
name: "Нематериальные активы"
code: "1110"
value: "554779000"
id: 1
- form: "Баланс"
section: "Актив"
name: "Основные средства"
code: "1150"
value: "11502405000"
id: 5
- form: "Баланс"
section: "Актив"
name: "Долгосрочные финансовые вложения"
code: "1170"
value: "13980027000"
id: 12
- periodName: "2016"
dateBegin: "2016-01-01+03:00"
dateEnd: "2016-12-31+03:00"
data:
- form: "Баланс"
section: "Актив"
name: "Нематериальные активы"
code: "1110"
value: "50345000"
id: 1
- form: "Баланс"
section: "Актив"
name: "Основные средства"
code: "1150"
value: "10687759000"
id: 5
- form: "Баланс"
section: "Актив"
name: "Доходные вложения в материальные ценности"
code: "1160"
value: "636050000"
id: 9
- periodName: "2017"
dateBegin: "2017-01-01+03:00"
dateEnd: "2017-12-31+03:00"
data:
- form: "Баланс"
section: "Актив"
name: "Нематериальные активы"
code: "1110"
value: "69825000"
id: 1
- form: "Баланс"
section: "Актив"
name: "Основные средства"
code: "1150"
value: "11072450000"
id: 5
- form: "Баланс"
section: "Актив"
name: "Доходные вложения в материальные ценности"
code: "1160"
value: "566919000"
id: 9
leaders:
- actualDate: "2020-12-01+03:00"
name: "Фамилия Имя Отчество"
position: "генеральный директор"
managementCompany: ""
managementCompanyINN: "000000000000"
structure:
countCoownerFCSM: 1
countCoownerRosstat: 1
countCoownerEGRUL: 1
countBranch: 0
countBranchRosstat: 36
countBranchEGRUL: 139
countAffiliatedCompanyFCSM: 0
countAffiliatedCompanyRosstat: 22
countAffiliatedCompanyEGRUL: 23
nonprofitOrganizationRosstat: 3
proceedings:
active: 65
executed: 1326
charterCapital:
value: "1110616000"
date: "2000-01-01+04:00"
currencyCode: ""
currencyName: ""
companyWithSameInfo:
telephoneCount:
value: 1
phoneCode: "342"
phoneNumber: "2901202"
phoneList: []
addressCount: 51
addressWithoutRoomCount: 60
addressNotAffiliatedCount: 51
addressFTSCount: 26
managerCountInCountry: 1
managerCountInRegion: 1
managerInnCount: 0
companyLiquidatedWithSameInfo:
addressCount: 10
addressWithoutRoomCount: 10
arbitrationCases:
cases:
- year: 2006
plaintiff:
casesNumber: 2
sum: "17369466"
defendant:
casesNumber: 0
sum: "0"
thirdOrOtherPerson:
casesNumber: 0
- year: 2005
plaintiff:
casesNumber: 2
sum: "0"
defendant:
casesNumber: 0
sum: "0"
thirdOrOtherPerson:
casesNumber: 0
- year: 2004
plaintiff:
casesNumber: 2
sum: "0"
defendant:
casesNumber: 0
sum: "0"
thirdOrOtherPerson:
casesNumber: 0
total: 703
considered: 35
appealed: 4
decisionsAndRulings: 13
completed: 651
federalTaxRegistrationPayment:
regDate: "2010-01-25+03:00"
regAuthority: "Инспекция Федеральной налоговой службы"
regAuthorityAddress: "119048, Москва г, Доватора ул"
regAuthorityCode: "7704"
federalTaxRegistrationCurrent:
regDate: "2008-10-12+04:00"
regAuthority: "Межрайонная инспекция Федеральной налоговой слу\
жбы"
regAuthorityAddress: "125373, Москва г, Походный проезд"
regAuthorityCode: "7746"
okved:
- code: "51.10.1"
name: "Перевозка"
isMain: true
isMainEgrul: true
isMainRosstat: true
- code: "18.12"
name: "Прочие виды полиграфической деятельности"
isMain: false
isMainEgrul: false
isMainRosstat: false
- code: "33.16"
name: "Ремонт и техническое обслуживание"
isMain: false
isMainEgrul: false
isMainRosstat: false
stateContracts:
federalLaw94:
- year: 2013
tenders:
admittedNumber: 69
notAdmittedNumber: 0
winnerNumber: 69
contracts:
signedNumber: 69
sum: "91800339"
- year: 2012
tenders:
admittedNumber: 75
notAdmittedNumber: 0
winnerNumber: 75
contracts:
signedNumber: 75
sum: "4172264976"
- year: 2011
tenders:
admittedNumber: 45
notAdmittedNumber: 0
winnerNumber: 39
contracts:
signedNumber: 39
sum: "2956994583"
federalLaw223: []
address:
- postCode: "119002"
address: "г. Москва, ул. Арбат"
streetName: "ул. Арбат"
buildingNumber: "10"
fiasGUID: "b30b63a1-c2be-4efc-9d0c-c9b6d7438e15"
isHouseFiasGUID: false
fiasCode: "770000000000000000000000000"
fiasRegion: "77"
fiasArea: "000"
fiasCity: "000"
fiasPlace: "000"
fiasPlan: "0000"
fiasStreet: "0758"
actualDate: "2018-03-21+03:00"
buildingType: "дом"
businessCenterName: "Бизнес-центр"
fts: []
includeInList:
- isNegative: false
id: 6
listName: "Компании, сдающие отчетность"
- isNegative: false
id: 7
listName: "Предприятия"
- isNegative: false
id: 8
listName: "Компании"
bankruptcyMessage: []
expressExcerpt:
inn: "000000000000"
companyType: "company"
companyWithSameInfo:
sameManager:
manager: "Фамилия Имя Отчество"
managerCountInCountry: 1
managerInnCount: 0
sameAddress:
address: "г. Москва, ул. Арбат"
addressCount: 51
samePhone:
phoneCode: "342"
phoneNumber: "0000000"
phoneCount: 1
negativeLists: []
status:
isActing: true
date: "2023-04-24+03:00"
type: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
okvedInfo:
code: "50.00.0"
name: "Перевозка"
okvedCount: 21
netIncome:
periodName: "2020"
dateBegin: "2020-01-01+03:00"
dateEnd: "2020-12-31+03:00"
sum: "-96527133000"
taxYears:
minYear: 2015
maxYear: 2020
financeYears:
minYear: 2015
maxYear: 2020
stateContractYears:
minYear: 2006
maxYear: 2013
activeProceedingsCount: 65
bankruptcyMessage:
idType: 7
messageType: "Тип сообщения"
date: "2021-10-26Z"
decisionDate: "2021-10-19Z"
caseNumber: "А56-13391/2020"
caseId: 23040734
frozenAccountDecisions: []
arbitrationCasesInfo:
year: 2018
count: 23
entrepreneurExcerpt:
inn: "000000000000"
ogrnip: "300000000000000"
okpo: "0000000000"
sex: "man"
okato:
value: ""
code: "00000000000"
regionName: "Московская область"
regionCode: 46
okopf:
code: "50102"
name: "Индивидуальные предприниматели"
phoneList: []
status:
isActing: true
date: "2017-07-06+03:00"
text: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
includeInList:
- isNegative: false
id: 26
listName: "Реестр субъектов"
federalTaxRegistrationPayment:
regAuthority: "Межрайонная ИФНС России №23 по Московской облас\
ти"
regAuthorityAddress: "144000, Московская обл, г Электросталь"
regAuthorityCode: "5081"
federalTaxRegistrationCurrent:
regDate: "2017-07-06+03:00"
regAuthority: "Межрайонная инспекция Федеральной налоговой слу\
жбы"
regAuthorityAddress: "140000, Московская обл, Люберцы г"
regAuthorityCode: "5027"
citizenship:
code: 643
name: "Российская Федерация"
okved:
- code: "63.91"
name: "Деятельность информационных агентств"
isMain: true
registrationInFunds:
pensionFund:
registrationDate: "2017-07-07+03:00"
registerNumber: "060027069206"
regAuthority: "Государственное учреждение"
submittedStatements:
- form: "Р21001"
submissionDate: "2017-07-03+03:00"
availabilityDate: "2017-07-06+03:00"
grn: "000000000000000"
decisionType: "Решение о государственной регистрации"
stateContracts:
federalLaw94:
- year: 2018
tenders:
admittedNumber: 0
notAdmittedNumber: 1
winnerNumber: 0
contracts:
signedNumber: 0
sum: "0"
bankruptcyMessage: []
expressExcerpt:
inn: "000000000000"
companyType: "company"
companyWithSameInfo:
sameManager:
manager: "Фамилия Имя Отчество"
managerCountInCountry: 1
managerInnCount: 0
sameAddress:
address: "г. Москва, ул. Арбат"
addressCount: 51
samePhone:
phoneCode: "342"
phoneNumber: "0000000"
phoneCount: 1
negativeLists: []
status:
isActing: true
date: "2023-04-24+03:00"
type: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
okvedInfo:
code: "51.10.1"
name: "Перевозка"
okvedCount: 21
netIncome:
periodName: "2020"
dateBegin: "2020-01-01+03:00"
dateEnd: "2020-12-31+03:00"
sum: "-96527133000"
taxYears:
minYear: 2015
maxYear: 2020
financeYears:
minYear: 2015
maxYear: 2020
stateContractYears:
minYear: 2006
maxYear: 2013
activeProceedingsCount: 65
bankruptcyMessage:
idType: 7
messageType: "Тип сообщения"
date: "2021-10-26Z"
decisionDate: "2021-10-19Z"
caseNumber: "А56-13391/2020"
caseId: 23040734
frozenAccountDecisions: []
arbitrationCasesInfo:
year: 2018
count: 23
companyCard:
statusType: "active"
requisites:
inn: "000000000000"
ogrn: "1000000000000"
kpp: "000000000"
shortName: "ПАО \"НАЗВАНИЕ\""
fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\""
dateReg: "1996-06-21"
terminationDt: "2020-11-20"
status: "Действующая организация"
authorizedCapitalAmount: 3975771140
ogrnAssignDate: "2000-01-01"
legalAddress: "119019, г Москва, ул Арбат"
city: "Москва"
pages:
- page: "okved"
- page: "contract"
- page: "license"
- page: "history"
- page: "trafficLight"
- page: "feedback"
- page: "financialStatements"
excerpt:
requisites:
legalForm: "ПУБЛИЧНЫЕ АКЦИОНЕРНЫЕ ОБЩЕСТВА"
organizationSizeDesc: "Описание"
entityRegistrationDate: "2010-01-25"
regAuthorityAddressTxt: "125373, гор. Москва, Походный Проезд"
regAuthorityName: "Межрайонная Инспекция Федеральной Налоговой\
\ Службы"
pfrRegistrationNumber: "0000000000000"
pfrAuthorityName: "Отделение Фонда Пенсионного и Социального С\
трахования"
pfrRegistrationDate: "2010-06-18"
insRegistrationNumber: "000000000000000"
insAuthorityName: "Отделение Фонда Пенсионного и Социального С\
трахования"
insRegistrationDate: "2000-10-01"
okvedSummary:
count: 22
main:
- code: "51.10.1"
description: "Перевозка."
additional:
- code: "18.12.1"
description: "Прочие виды деятельности."
- code: "33.16.1"
description: "Ремонт и техническое обслуживание."
- code: "41.20.1"
description: "Строительство."
contractSummary:
count: 164
admittedCount: 40
notAdmittedCount: 94
totalValue: 3.2823479357625E10
licenseSummary:
total: 10
active: 10
inactive: 0
trafficLightColors:
redCount: 1
yellowCount: 5
greenCount: 14
innerCheckResult:
bankruptcyMessage:
value:
idType: 7
messageType: "Тип сообщения"
date: "2011-10-26Z"
decisionDate: "2011-10-19Z"
caseNumber: "А56-00000/2010"
caseId: 0
color: "green"
plaintiff:
value:
minDate: 2004
maxDate: 2018
totalCases: 470
color: "yellow"
thirdOrOtherPerson:
value:
minDate: 2007
maxDate: 2018
totalCases: 85
color: "yellow"
defendant:
value:
minDate: 2007
maxDate: 2018
totalCases: 157
color: "yellow"
defendantDynamic:
value:
lastYear: 2019
prevLastYear: 2018
percent: 50
color: "none"
executedProceedings:
value: 1326
color: "yellow"
activeProceedings:
value: 65
color: "red"
sameManager:
value:
inn: "000000000000"
sameManager:
manager: "Фамилия Имя Отчество"
managerCountInCountry: 1
managerInnCount: 1
color: "red"
sameAddressNumber:
value: 51
color: "yellow"
finance:
value:
balanceType: 1
periods:
- periodName: "2015"
dateBegin: "2015-01-01+03:00"
dateEnd: "2015-12-31+03:00"
data: []
- periodName: "2016"
dateBegin: "2016-01-01+03:00"
dateEnd: "2016-12-31+03:00"
data: []
- periodName: "2017"
dateBegin: "2017-01-01+03:00"
dateEnd: "2017-12-31+03:00"
data: []
color: "green"
isNegative:
value:
negativeListsCount: 0
color: "green"
unfairSupplier:
value:
isNegative: true
id: 1
listName: "Название"
color: "green"
invalidLegalAddress:
value:
isNegative: true
id: 1
listName: "Название"
color: "green"
disqualifiedPersons:
value:
isNegative: true
id: 1
listName: "Название"
color: "green"
taxReport:
value: "2023-04-25"
color: "none"
taxDebt:
value:
sum: 10
statDate: "2000-01-01"
color: "green"
checkResult:
status:
value: "Действующая организация"
color: "none"
registrationDate:
value: "1994-06-21"
color: "green"
legalAddressChangeDate:
value: "2019-07-10"
color: "green"
founderChangeDate:
value: "2021-10-25"
color: "green"
confidantChangeDate:
value: "2022-04-18"
color: "green"
authorizedCapitalAmount:
value: 3975771140
color: "green"
admittedContractsAsSupplier:
value:
count: 40
totalValue: 27523079541
color: "green"
legalForm:
value: "Публичные акционерные общества"
color: "green"
okvedCount:
value: 22
color: "none"
licensedOkvedCount:
value: 0
color: "none"
riskLevel:
value: 0
color: "none"
relationSummary:
total: 10
relatedByFounder: 0
relatedByConfidant: 0
relatedCompanies:
- name: "ООО \"Название\""
ogrn: "1000000000000"
inn: "000000000000"
leaders:
- actualDate: "2022-01-01"
name: "Фамилия Имя Отчество"
position: "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР"
founders: []
history:
- paramText: "организации"
changeDate: "2022-09-06"
paramName: "auth_cap"
oldParamValue: "2444535550.00"
paramValue: "3975771140.00"
- paramText: "организации"
changeDate: "2022-06-11"
paramName: "lic_new"
oldParamValue: "Л041-01162-50/00369716 от 9 апреля 2020"
paramValue: "Л041-01162-50/00369716|2020-04-09|2020-04-09"
licenses:
- "no": "14761-АТ"
authorityName: "МИНИСТЕРСТВО"
date: "2020-07-29"
startDate: "2020-07-30"
address: []
activity:
- "РАЗРАБОТКА"
status: "active"
- "no": "Л041-01162-50/00369716"
authorityName: "ФЕДЕРАЛЬНАЯ СЛУЖБА ПО НАДЗОРУ В СФЕРЕ ЗДРАВООХ\
РАНЕНИЯ"
date: "2020-04-09"
startDate: "2020-04-09"
address: []
activity:
- "МЕДИЦИНСКАЯ ДЕЯТЕЛЬНОСТЬ"
status: "active"
- "no": "Л042-01137-77/00283899"
authorityName: "ДЕПАРТАМЕНТ ЗДРАВООХРАНЕНИЯ"
date: "2019-10-03"
startDate: "2019-10-03"
address: []
activity:
- "ФАРМАЦЕВТИЧЕСКАЯ ДЕЯТЕЛЬНОСТЬ"
status: "active"
contracts:
- contractId: "0173200000000000071"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "completed"
role: "supplier"
price: 612000
- contractId: "1490000000000000006"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "execution"
role: "supplier"
price: 664976
- contractId: "1870000000000000002"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "execution"
role: "supplier"
price: 6000000
financialStatementsResponse:
reason:
reasonCode: "lessThanYear"
reasonText: "Компании меньше года"
financialStatementsData:
year: 2021
revenue:
name: "Выручка"
value: 378657216000
valueDiff: 148890851000
values:
- year: 2019
value: 551767420000
- year: 2020
value: 229766365000
valueDiff: -322001055000
- year: 2021
value: 378657216000
valueDiff: 148890851000
profit:
name: "Прибыль"
value: -45639139000
valueDiff: 50887994000
values:
- year: 2019
value: 5286800000
- year: 2020
value: -96527133000
valueDiff: -101813933000
- year: 2021
value: -45639139000
valueDiff: 50887994000
accountsPayable:
name: "Кредиторский долг"
value: 100062394000
valueDiff: -7293171000
values:
- year: 2019
value: 95785513000
- year: 2020
value: 107355565000
valueDiff: 11570052000
- year: 2021
value: 100062394000
valueDiff: -7293171000
accountsReceivable:
name: "Дебиторский долг"
value: 83489186000
valueDiff: 1918241000
values:
- year: 2019
value: 104635508000
- year: 2020
value: 81570945000
valueDiff: -23064563000
- year: 2021
value: 83489186000
valueDiff: 1918241000
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "1b3c8ae867bc100d"
errorCode: "INVALID"
errorMessage: "Некорректный ОГРН: 1000000000000"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\
\ реквизиты. Если реквизиты изменились, необходимо перевыпус\
тить токен."
errorCode: "UNAUTHORIZED"
"403":
description: "Ошибка авторизации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при отсутствии доступов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "У вас неподходящие скопы для данной операции, т\
ребуемые скопы: scope"
errorCode: "FORBIDDEN"
Ошибка при запросе с неизвестного IP:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49"
errorMessage: "Запрос был отправлен с IP-адреса, который не бы\
л указан при получении токена. Пожалуйста, укажите этот IP-а\
дрес при получении нового токена"
errorCode: "FORBIDDEN"
Ошибка при отсутствии прав на использование продукта:
value:
errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb"
errorMessage: "Недостаточно прав на совершаемое действие. Свяж\
итесь с вашим менеджером, чтобы подключить данную функционал\
ьность. "
errorCode: "FORBIDDEN"
"422":
description: "Ошибка при обработке данных"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "1b3c8ae867bc100d"
errorCode: "NO_DATA"
errorMessage: "Данные не найдены: ОГРН 000000000000000"
"429":
description: "Слишком много запросов"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при превышении лимитов запросов:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Слишком много запросов. Попробуйте позже"
errorCode: "TOO_MANY_REQUESTS"
"500":
description: "Ошибка сервера"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Непредвиденная ошибка:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Непредвиденная ошибка. Попробуйте позже"
errorCode: "INTERNAL_ERROR"
security:
- httpAuth: []
servers:
- url: "https://business.tbank.ru/openapi"
description: "Production"
- url: "https://business.tbank.ru/openapi/sandbox"
description: "Sandbox"
/api/v1/counterparty/excerpt/by-inn:
get:
tags:
- "Проверка контрагентов"
summary: "Получить общую выписку для проверки контрагента по ИНН"
description: "Метод для получения выписки по контрагенту — тип компании, вып\
иска по организации, выписка по ИП, общая информация о компании."
operationId: "getApiV1CounterpartyExcerptByInn"
parameters:
- name: "X-Request-Id"
in: "header"
description: "Уникальный идентификатор для трассировки запроса. Не влияет\
\ на логику исполнения запроса."
required: false
allowEmptyValue: false
style: "simple"
explode: false
schema:
type: "string"
description: "Идентификатор запроса."
format: "uuid"
- name: "inn"
in: "query"
description: "Идентификационный номер налогоплательщика."
required: true
style: "form"
explode: true
schema:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
responses:
"200":
description: "Успешный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "companyCard"
- "companyType"
- "excerpt"
type: "object"
properties:
companyType:
type: "string"
description: "Тип компании."
enum:
- "entrepreneur"
- "company"
companyExcerpt:
required:
- "address"
- "bankruptcyMessage"
- "expressExcerpt"
- "fts"
- "includeInList"
- "leaders"
- "okved"
- "phones"
type: "object"
properties:
shortName:
maxLength: 1000
type: "string"
description: "Краткое наименование компании."
nullable: true
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
description: "ОГРН."
nullable: true
okpo:
pattern: "^(\\d{8}|\\d{10})$"
type: "string"
description: "ОКПО."
nullable: true
isActing:
type: "boolean"
description: "Признак действующей компании."
nullable: true
normName:
maxLength: 1000
type: "string"
description: "Нормализованное наименование компании."
nullable: true
shortNameRus:
maxLength: 1000
type: "string"
description: "Краткое наименование компании."
nullable: true
shortNameEn:
maxLength: 1000
type: "string"
description: "Краткое наименование компании на английском\
\ языке."
nullable: true
dateFirstReg:
type: "string"
description: "Дата регистрации."
format: "date"
nullable: true
fullNameRus:
maxLength: 1000
type: "string"
description: "Полное наименование компании на русском."
nullable: true
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
description: "КПП."
nullable: true
bik:
pattern: "^(\\d{9}|0)$"
type: "string"
description: "БИК."
nullable: true
email:
type: "string"
description: "Электронная почта."
format: "email"
nullable: true
www:
maxLength: 512
type: "string"
description: "Веб-сайт."
nullable: true
registerNumber:
maxLength: 512
type: "string"
description: "Регистрационный номер."
nullable: true
okato:
required:
- "value"
type: "object"
properties:
value:
type: "string"
format: "string"
code:
pattern: "^(\\d{2,11})$"
type: "string"
nullable: true
regionName:
maxLength: 512
type: "string"
description: "Название региона."
nullable: true
regionCode:
type: "integer"
description: "Код региона."
format: "int32"
nullable: true
description: "ОКАТО."
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
phones:
maxItems: 200
type: "array"
items:
type: "object"
properties:
code:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора)."
nullable: true
number:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
description: "Номера телефонов."
finance:
type: "object"
properties:
balanceType:
type: "integer"
format: "int64"
nullable: true
periods:
maxItems: 200
type: "array"
description: "Бухгалтерская отчетность."
nullable: true
items:
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
description: "Отчетный период."
nullable: true
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Начало периода."
format: "string"
nullable: true
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Конец периода."
format: "string"
nullable: true
data:
maxItems: 200
type: "array"
nullable: true
items:
type: "object"
properties:
form:
maxLength: 512
type: "string"
description: "Форма."
nullable: true
section:
maxLength: 512
type: "string"
description: "Раздел."
nullable: true
name:
maxLength: 512
type: "string"
description: "Наименование."
nullable: true
code:
maxLength: 512
type: "string"
description: "Код."
nullable: true
value:
maxLength: 512
type: "string"
description: "Значение."
nullable: true
id:
type: "integer"
description: "Идентификатор списка."
format: "int32"
nullable: true
leaders:
maxItems: 500
type: "array"
description: "Руководители."
items:
type: "object"
properties:
actualDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Дата актуальности."
format: "string"
nullable: true
name:
type: "string"
description: "Наименование."
format: "string"
nullable: true
position:
type: "string"
description: "Должность."
format: "string"
nullable: true
managementCompany:
type: "string"
format: "string"
nullable: true
managementCompanyINN:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
structure:
type: "object"
properties:
countCoownerFCSM:
type: "integer"
description: "Количество совладельцев (данные компании\
/ФСФР)."
format: "int32"
nullable: true
countCoownerRosstat:
type: "integer"
description: "Количество совладельцев (Росстат)."
format: "int32"
nullable: true
countCoownerEGRUL:
type: "integer"
description: "Количество совладельцев (ЕГРЮЛ)."
format: "int32"
nullable: true
countBranch:
type: "integer"
description: "Количество филиалов (данные компании)."
format: "int32"
nullable: true
countBranchRosstat:
type: "integer"
description: "Количество филиалов (Росстат)."
format: "int32"
nullable: true
countBranchEGRUL:
type: "integer"
description: "Количество филиалов (ЕГРЮЛ)."
format: "int32"
nullable: true
countCoownerDKCPFR:
type: "integer"
format: "int32"
nullable: true
countCoownerUkrStat:
type: "integer"
format: "int32"
nullable: true
countAffiliatedCompany:
type: "integer"
format: "int32"
nullable: true
countAffiliatedCompanyFCSM:
type: "integer"
description: "Количество дочерних компаний (данные ком\
пании)."
format: "int32"
nullable: true
countAffiliatedCompanyRosstat:
type: "integer"
description: "Количество дочерних компаний (Росстат)."
format: "int32"
nullable: true
countAffiliatedCompanyEGRUL:
type: "integer"
description: "Количество дочерних компаний (ЕГРЮЛ)."
format: "int32"
nullable: true
nonprofitOrganizationRosstat:
type: "integer"
description: "Количество некоммерческих партнерств (Ро\
сстат)."
format: "int32"
nullable: true
activeBranchesRosstatNumber:
type: "integer"
format: "int32"
nullable: true
activeAffiliatedCompaniesNumber:
type: "integer"
format: "int32"
nullable: true
proceedings:
required:
- "active"
- "executed"
type: "object"
properties:
active:
type: "integer"
description: "Количество непогашенных обязательств."
format: "int32"
executed:
type: "integer"
description: "Количество погашенных обязательств."
format: "int32"
charterCapital:
type: "object"
properties:
value:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
currencyCode:
maxLength: 512
type: "string"
nullable: true
currencyName:
maxLength: 512
type: "string"
nullable: true
charterCapitalHistory:
maxItems: 200
type: "array"
description: "История изменения уставного капитала."
nullable: true
items:
type: "object"
properties:
value:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
currencyCode:
maxLength: 512
type: "string"
nullable: true
currencyName:
maxLength: 512
type: "string"
nullable: true
companyWithSameInfo:
type: "object"
properties:
telephoneCount:
required:
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int32"
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
phoneList:
maxItems: 500
type: "array"
nullable: true
items:
required:
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int32"
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора\
)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
addressCount:
type: "integer"
format: "int32"
nullable: true
addressWithoutRoomCount:
type: "integer"
format: "int32"
nullable: true
addressNotAffiliatedCount:
type: "integer"
format: "int32"
nullable: true
addressFTSCount:
type: "integer"
format: "int32"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerCountInRegion:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
companyLiquidatedWithSameInfo:
type: "object"
properties:
addressCount:
type: "integer"
format: "int32"
nullable: true
addressWithoutRoomCount:
type: "integer"
format: "int32"
nullable: true
arbitrationCases:
type: "object"
properties:
cases:
maxItems: 200
type: "array"
nullable: true
items:
required:
- "defendant"
- "plaintiff"
- "thirdOrOtherPerson"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
plaintiff:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
defendant:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
thirdOrOtherPerson:
required:
- "casesNumber"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
total:
type: "integer"
format: "int32"
nullable: true
considered:
type: "integer"
format: "int32"
nullable: true
appealed:
type: "integer"
format: "int32"
nullable: true
decisionsAndRulings:
type: "integer"
format: "int32"
nullable: true
completed:
type: "integer"
format: "int32"
nullable: true
federalTaxRegistrationPayment:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
federalTaxRegistrationCurrent:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
okved:
maxItems: 2500
type: "array"
description: "ОКВЭД."
items:
required:
- "isMain"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description: "Код."
nullable: true
name:
maxLength: 1000
type: "string"
description: "Наименование."
nullable: true
isMain:
type: "boolean"
description: "Признак основного ОКВЭД."
isMainEgrul:
type: "boolean"
description: "Признак основного ОКВЭД по данным ЕГРЮ\
Л."
nullable: true
isMainRosstat:
type: "boolean"
description: "Признак основного ОКВЭД по данным Росс\
тата."
nullable: true
stateContracts:
type: "object"
properties:
federalLaw94:
maxItems: 200
type: "array"
description: "Данные о госконтрактах за соответствующи\
й год."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
federalLaw223:
maxItems: 200
type: "array"
description: "Данные о тендерах за соответствующий год\
."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
address:
maxItems: 200
type: "array"
description: "Местонахождение."
items:
type: "object"
properties:
postCode:
pattern: "^(\\d{6})$"
type: "string"
nullable: true
address:
maxLength: 1000
type: "string"
nullable: true
streetName:
maxLength: 1000
type: "string"
nullable: true
buildingNumber:
maxLength: 512
type: "string"
nullable: true
fiasGUID:
type: "string"
format: "uuid"
nullable: true
isHouseFiasGUID:
type: "boolean"
nullable: true
fiasCode:
maxLength: 512
type: "string"
nullable: true
fiasRegion:
maxLength: 512
type: "string"
nullable: true
fiasArea:
maxLength: 512
type: "string"
nullable: true
fiasCity:
maxLength: 512
type: "string"
nullable: true
fiasPlace:
maxLength: 512
type: "string"
nullable: true
fiasPlan:
maxLength: 512
type: "string"
nullable: true
fiasStreet:
maxLength: 512
type: "string"
nullable: true
actualDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
buildingType:
maxLength: 512
type: "string"
nullable: true
businessCenterName:
maxLength: 512
type: "string"
nullable: true
fts:
maxItems: 200
type: "array"
items:
type: "object"
properties:
endDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Контрактов подписано на сумму, рубли."
format: "string"
nullable: true
income:
type: "string"
format: "string"
nullable: true
expenses:
type: "string"
format: "string"
nullable: true
taxes:
type: "object"
properties:
sum:
type: "string"
format: "string"
nullable: true
tax:
maxItems: 200
type: "array"
nullable: true
items:
type: "object"
properties:
id:
type: "integer"
format: "int32"
nullable: true
name:
type: "string"
format: "string"
nullable: true
sum:
type: "string"
format: "string"
nullable: true
taxArrears:
type: "object"
properties:
tax:
maxItems: 200
type: "array"
nullable: true
items:
required:
- "id"
type: "object"
properties:
id:
type: "integer"
description: "Идентификатор налога/сбора."
format: "int64"
name:
type: "string"
description: "Наименование налога/сбора."
format: "string"
nullable: true
finesSum:
type: "string"
description: "Сумма задолженности по пени."
format: "string"
nullable: true
penaltiesSum:
type: "string"
description: "Сумма задолженности по штраф\
ам."
format: "string"
nullable: true
sum:
type: "string"
format: "string"
nullable: true
taxPenalties:
type: "object"
properties:
sum:
type: "string"
format: "string"
nullable: true
includeInList:
maxItems: 200
type: "array"
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
bankruptcyMessage:
maxItems: 3000
type: "array"
items:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
expressExcerpt:
required:
- "companyType"
- "frozenAccountDecisions"
- "negativeLists"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
nullable: true
companyType:
type: "string"
description: "Тип компании."
enum:
- "entrepreneur"
- "company"
companyWithSameInfo:
required:
- "sameAddress"
- "sameManager"
- "samePhone"
type: "object"
properties:
sameManager:
type: "object"
properties:
manager:
maxLength: 512
type: "string"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
sameAddress:
type: "object"
properties:
address:
maxLength: 1000
type: "string"
nullable: true
addressCount:
type: "integer"
format: "int32"
nullable: true
samePhone:
type: "object"
properties:
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператор\
а)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
phoneCount:
type: "integer"
format: "int32"
nullable: true
negativeLists:
maxItems: 200
type: "array"
description: "Негативные списки, в которых состоит ком\
пания."
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
okvedInfo:
required:
- "okvedCount"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
nullable: true
name:
type: "string"
format: "string"
nullable: true
okvedCount:
type: "integer"
format: "int32"
netIncome:
required:
- "dateBegin"
- "dateEnd"
- "periodName"
- "sum"
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
sum:
maxLength: 512
type: "string"
taxYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
financeYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
stateContractYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
activeProceedingsCount:
type: "integer"
description: "Количество активных исполнительных произ\
водств (долгов)."
format: "int32"
nullable: true
bankruptcyMessage:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
frozenAccountDecisions:
maxItems: 200
type: "array"
description: "Есть решение о приостановлении операций\
\ по счетам."
items:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
reason:
type: "object"
properties:
id:
type: "integer"
format: "int32"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
taxAuthority:
type: "object"
properties:
code:
maxLength: 512
type: "string"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
bank:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
bik:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
name:
maxLength: 512
type: "string"
nullable: true
number:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
arbitrationCasesInfo:
required:
- "count"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
count:
type: "integer"
format: "int32"
description: "Выписка по организации."
entrepreneurExcerpt:
required:
- "bankruptcyMessage"
- "expressExcerpt"
- "includeInList"
- "okved"
- "phoneList"
- "submittedStatements"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
ogrnip:
pattern: "^\\d{15}$"
type: "string"
nullable: true
okpo:
pattern: "^(\\d{8}|\\d{10})$"
type: "string"
nullable: true
birthDate:
type: "string"
format: "date"
nullable: true
birthPlace:
type: "string"
format: "string"
nullable: true
fullNameRus:
type: "string"
format: "string"
nullable: true
sex:
type: "string"
enum:
- "man"
- "woman"
- "undefined"
dateReg:
type: "string"
format: "date"
nullable: true
okato:
required:
- "value"
type: "object"
properties:
value:
type: "string"
format: "string"
code:
pattern: "^(\\d{2,11})$"
type: "string"
nullable: true
regionName:
maxLength: 512
type: "string"
description: "Название региона."
nullable: true
regionCode:
type: "integer"
description: "Код региона."
format: "int32"
nullable: true
description: "ОКАТО."
okopf:
type: "object"
properties:
code:
pattern: "^(\\d{5})$"
type: "string"
nullable: true
name:
maxLength: 512
type: "string"
nullable: true
phoneList:
maxItems: 200
type: "array"
items:
type: "object"
properties:
code:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператора)."
nullable: true
number:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
description: "Номера телефонов."
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
includeInList:
maxItems: 200
type: "array"
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
federalTaxRegistrationPayment:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
federalTaxRegistrationCurrent:
type: "object"
properties:
regDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
regAuthority:
maxLength: 1000
type: "string"
nullable: true
regAuthorityAddress:
maxLength: 1000
type: "string"
nullable: true
regAuthorityCode:
maxLength: 512
type: "string"
nullable: true
citizenship:
required:
- "code"
- "name"
type: "object"
properties:
code:
type: "integer"
format: "int32"
name:
type: "string"
format: "string"
okved:
maxItems: 2500
type: "array"
items:
required:
- "isMain"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description: "Код."
nullable: true
name:
maxLength: 1000
type: "string"
description: "Наименование."
nullable: true
isMain:
type: "boolean"
description: "Признак основного ОКВЭД."
isMainEgrul:
type: "boolean"
description: "Признак основного ОКВЭД по данным ЕГРЮ\
Л."
nullable: true
isMainRosstat:
type: "boolean"
description: "Признак основного ОКВЭД по данным Росс\
тата."
nullable: true
registrationInFunds:
type: "object"
properties:
pensionFund:
required:
- "regAuthority"
- "registerNumber"
- "registrationDate"
type: "object"
properties:
registrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
deregistrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
registerNumber:
type: "string"
format: "string"
regAuthority:
type: "string"
format: "string"
socialInsuranceFund:
required:
- "regAuthority"
- "registerNumber"
- "registrationDate"
type: "object"
properties:
registrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
deregistrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
registerNumber:
type: "string"
format: "string"
regAuthority:
type: "string"
format: "string"
compulsoryMedicalInsuranceFund:
required:
- "regAuthority"
- "registerNumber"
- "registrationDate"
type: "object"
properties:
registrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
deregistrationDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
registerNumber:
type: "string"
format: "string"
regAuthority:
type: "string"
format: "string"
submittedStatements:
maxItems: 200
type: "array"
items:
type: "object"
properties:
form:
type: "string"
format: "string"
nullable: true
submissionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
availabilityDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
nullable: true
grn:
type: "string"
format: "string"
nullable: true
decisionType:
type: "string"
format: "string"
nullable: true
stateContracts:
type: "object"
properties:
federalLaw94:
maxItems: 200
type: "array"
description: "Данные о госконтрактах за соответствующи\
й год."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
federalLaw223:
maxItems: 200
type: "array"
description: "Данные о тендерах за соответствующий год\
."
nullable: true
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
description: "Значение года."
format: "int32"
tenders:
type: "object"
properties:
admittedNumber:
type: "integer"
description: "Число допусков к тендеру."
format: "int32"
nullable: true
notAdmittedNumber:
type: "integer"
description: "Число недопусков к тендеру."
format: "int32"
nullable: true
winnerNumber:
type: "integer"
description: "Число выигрышей тендеров."
format: "int32"
nullable: true
contracts:
type: "object"
properties:
signedNumber:
type: "integer"
description: "Число подписанных контрактов."
format: "int32"
nullable: true
sum:
type: "string"
description: "Контрактов подписано на сумму\
, рубли."
format: "string"
nullable: true
arbitrationCases:
type: "object"
properties:
cases:
maxItems: 200
type: "array"
nullable: true
items:
required:
- "defendant"
- "plaintiff"
- "thirdOrOtherPerson"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
plaintiff:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
defendant:
required:
- "casesNumber"
- "sum"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
sum:
type: "string"
format: "string"
thirdOrOtherPerson:
required:
- "casesNumber"
type: "object"
properties:
casesNumber:
type: "integer"
format: "int32"
total:
type: "integer"
format: "int32"
nullable: true
considered:
type: "integer"
format: "int32"
nullable: true
appealed:
type: "integer"
format: "int32"
nullable: true
decisionsAndRulings:
type: "integer"
format: "int32"
nullable: true
completed:
type: "integer"
format: "int32"
nullable: true
executionProceedings:
required:
- "active"
- "executed"
type: "object"
properties:
active:
type: "integer"
description: "Количество непогашенных обязательств."
format: "int32"
executed:
type: "integer"
description: "Количество погашенных обязательств."
format: "int32"
bankruptcyMessage:
maxItems: 3000
type: "array"
items:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
expressExcerpt:
required:
- "companyType"
- "frozenAccountDecisions"
- "negativeLists"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
description: "ИНН."
nullable: true
companyType:
type: "string"
description: "Тип компании."
enum:
- "entrepreneur"
- "company"
companyWithSameInfo:
required:
- "sameAddress"
- "sameManager"
- "samePhone"
type: "object"
properties:
sameManager:
type: "object"
properties:
manager:
maxLength: 512
type: "string"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
sameAddress:
type: "object"
properties:
address:
maxLength: 1000
type: "string"
nullable: true
addressCount:
type: "integer"
format: "int32"
nullable: true
samePhone:
type: "object"
properties:
phoneCode:
pattern: "^\\d{3,5}$"
type: "string"
description: "Зоновый код (код города/оператор\
а)."
nullable: true
phoneNumber:
pattern: "^\\d{5,7}$"
type: "string"
description: "Местный номер."
nullable: true
phoneCount:
type: "integer"
format: "int32"
nullable: true
negativeLists:
maxItems: 200
type: "array"
description: "Негативные списки, в которых состоит ком\
пания."
items:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
status:
required:
- "code"
- "isActing"
type: "object"
properties:
isActing:
type: "boolean"
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
text:
type: "string"
format: "string"
nullable: true
type:
type: "string"
format: "string"
nullable: true
code:
type: "integer"
format: "int32"
groupId:
type: "integer"
format: "int32"
nullable: true
groupName:
type: "string"
format: "string"
nullable: true
description: "Статус."
okvedInfo:
required:
- "okvedCount"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
nullable: true
name:
type: "string"
format: "string"
nullable: true
okvedCount:
type: "integer"
format: "int32"
netIncome:
required:
- "dateBegin"
- "dateEnd"
- "periodName"
- "sum"
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
sum:
maxLength: 512
type: "string"
taxYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
financeYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
stateContractYears:
required:
- "maxYear"
- "minYear"
type: "object"
properties:
minYear:
type: "integer"
format: "int32"
maxYear:
type: "integer"
format: "int32"
activeProceedingsCount:
type: "integer"
description: "Количество активных исполнительных произ\
водств (долгов)."
format: "int32"
nullable: true
bankruptcyMessage:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
frozenAccountDecisions:
maxItems: 200
type: "array"
description: "Есть решение о приостановлении операций\
\ по счетам."
items:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
reason:
type: "object"
properties:
id:
type: "integer"
format: "int32"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
taxAuthority:
type: "object"
properties:
code:
maxLength: 512
type: "string"
nullable: true
name:
maxLength: 1000
type: "string"
nullable: true
bank:
type: "object"
properties:
sparkId:
required:
- "isEven"
- "isOne"
- "isPowerOfTwo"
- "isZero"
- "sign"
type: "object"
properties:
isPowerOfTwo:
type: "boolean"
readOnly: true
isZero:
type: "boolean"
readOnly: true
isOne:
type: "boolean"
readOnly: true
isEven:
type: "boolean"
readOnly: true
sign:
type: "integer"
format: "int32"
readOnly: true
bik:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
name:
maxLength: 512
type: "string"
nullable: true
number:
maxLength: 512
type: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
arbitrationCasesInfo:
required:
- "count"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
count:
type: "integer"
format: "int32"
description: "Выписка по ИП."
companyCard:
required:
- "pages"
- "requisites"
- "statusType"
type: "object"
properties:
statusType:
type: "string"
description: "Статус компании."
enum:
- "active"
- "reorganizing"
- "liquidating"
- "liquidated"
- "bankrupting"
- "unknown"
requisites:
required:
- "ogrn"
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
kpp:
pattern: "^(\\d{9}|0)$"
type: "string"
nullable: true
shortName:
type: "string"
format: "string"
nullable: true
fullName:
type: "string"
format: "string"
nullable: true
dateReg:
type: "string"
format: "date"
nullable: true
terminationDt:
type: "string"
format: "date"
nullable: true
status:
type: "string"
format: "string"
nullable: true
authorizedCapitalAmount:
type: "number"
format: "double"
nullable: true
ogrnAssignDate:
type: "string"
format: "date"
nullable: true
legalAddress:
type: "string"
format: "string"
nullable: true
city:
type: "string"
format: "string"
nullable: true
description: "Реквизиты."
pages:
maxItems: 20
type: "array"
items:
required:
- "page"
type: "object"
properties:
page:
type: "string"
description: "Код страницы."
enum:
- "okved"
- "contract"
- "license"
- "history"
- "trafficLight"
- "relatedCompanies"
- "feedback"
- "financialStatements"
- "enforcementProceedings"
- "inspections"
description: "Информация о странице."
description: "Карточка компании."
excerpt:
required:
- "checkResult"
- "contractSummary"
- "contracts"
- "financialStatementsResponse"
- "founders"
- "history"
- "leaders"
- "licenseSummary"
- "licenses"
- "okvedSummary"
- "relatedCompanies"
- "relationSummary"
- "requisites"
- "trafficLightColors"
type: "object"
properties:
requisites:
type: "object"
properties:
legalForm:
type: "string"
format: "string"
nullable: true
organizationSizeDesc:
type: "string"
format: "string"
nullable: true
entityRegistrationDate:
type: "string"
format: "date"
nullable: true
regAuthorityAddressTxt:
type: "string"
format: "string"
nullable: true
regAuthorityName:
type: "string"
format: "string"
nullable: true
pfrRegistrationNumber:
type: "string"
format: "string"
nullable: true
pfrAuthorityName:
type: "string"
format: "string"
nullable: true
pfrRegistrationDate:
type: "string"
format: "date"
nullable: true
insRegistrationNumber:
type: "string"
format: "string"
nullable: true
insAuthorityName:
type: "string"
format: "string"
nullable: true
insRegistrationDate:
type: "string"
format: "date"
nullable: true
description: "Дополнительные реквизиты."
okvedSummary:
required:
- "additional"
- "count"
- "main"
type: "object"
properties:
count:
type: "integer"
format: "int64"
main:
maxItems: 100
type: "array"
items:
required:
- "code"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description:
type: "string"
format: "string"
nullable: true
description: "ОКВЭД."
additional:
maxItems: 100
type: "array"
items:
required:
- "code"
type: "object"
properties:
code:
pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$"
type: "string"
description:
type: "string"
format: "string"
nullable: true
description: "ОКВЭД."
description: "ОКВЭДы."
contractSummary:
required:
- "admittedCount"
- "count"
- "notAdmittedCount"
type: "object"
properties:
count:
type: "integer"
format: "int64"
admittedCount:
type: "integer"
format: "int64"
notAdmittedCount:
type: "integer"
format: "int64"
totalValue:
type: "number"
format: "double"
nullable: true
description: "Гос. контракты."
licenseSummary:
required:
- "active"
- "inactive"
- "total"
type: "object"
properties:
total:
type: "integer"
format: "int64"
active:
type: "integer"
format: "int64"
inactive:
type: "integer"
format: "int64"
description: "Количество лицензий."
trafficLightColors:
required:
- "greenCount"
- "redCount"
- "yellowCount"
type: "object"
properties:
redCount:
type: "integer"
format: "int32"
yellowCount:
type: "integer"
format: "int32"
greenCount:
type: "integer"
format: "int32"
description: "Результаты экспресс-проверки."
innerCheckResult:
required:
- "activeProceedings"
- "bankruptcyMessage"
- "defendant"
- "defendantDynamic"
- "disqualifiedPersons"
- "executedProceedings"
- "finance"
- "invalidLegalAddress"
- "isNegative"
- "plaintiff"
- "sameAddressNumber"
- "sameManager"
- "taxDebt"
- "taxReport"
- "thirdOrOtherPerson"
- "unfairSupplier"
type: "object"
properties:
bankruptcyMessage:
required:
- "color"
type: "object"
properties:
value:
type: "object"
properties:
idType:
type: "integer"
format: "int64"
nullable: true
messageType:
type: "string"
format: "string"
nullable: true
date:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\
d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
decisionDate:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\
d{2})|Z)?)$"
type: "string"
format: "string"
nullable: true
caseNumber:
type: "string"
format: "string"
nullable: true
caseId:
type: "integer"
format: "int64"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
plaintiff:
required:
- "color"
type: "object"
properties:
value:
required:
- "maxDate"
- "minDate"
- "totalCases"
type: "object"
properties:
minDate:
type: "integer"
description: "Наименьший год с судебными делам\
и."
format: "int32"
maxDate:
type: "integer"
description: "Наибольший год с судебными делам\
и."
format: "int32"
totalCases:
type: "integer"
format: "int32"
description: "Статистика по судебным делам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
thirdOrOtherPerson:
required:
- "color"
type: "object"
properties:
value:
required:
- "maxDate"
- "minDate"
- "totalCases"
type: "object"
properties:
minDate:
type: "integer"
description: "Наименьший год с судебными делам\
и."
format: "int32"
maxDate:
type: "integer"
description: "Наибольший год с судебными делам\
и."
format: "int32"
totalCases:
type: "integer"
format: "int32"
description: "Статистика по судебным делам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
defendant:
required:
- "color"
type: "object"
properties:
value:
required:
- "maxDate"
- "minDate"
- "totalCases"
type: "object"
properties:
minDate:
type: "integer"
description: "Наименьший год с судебными делам\
и."
format: "int32"
maxDate:
type: "integer"
description: "Наибольший год с судебными делам\
и."
format: "int32"
totalCases:
type: "integer"
format: "int32"
description: "Статистика по судебным делам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
defendantDynamic:
required:
- "color"
type: "object"
properties:
value:
required:
- "lastYear"
- "percent"
- "prevLastYear"
type: "object"
properties:
lastYear:
type: "integer"
format: "int32"
prevLastYear:
type: "integer"
format: "int32"
percent:
type: "number"
format: "double"
description: "Динамика судебных дел в качестве отв\
етчика."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
executedProceedings:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
activeProceedings:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
sameManager:
required:
- "color"
type: "object"
properties:
value:
type: "object"
properties:
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
sameManager:
type: "object"
properties:
manager:
maxLength: 512
type: "string"
nullable: true
managerCountInCountry:
type: "integer"
format: "int32"
nullable: true
managerInnCount:
type: "integer"
format: "int32"
nullable: true
description: "Массовый руководитель."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
sameAddressNumber:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
finance:
required:
- "color"
type: "object"
properties:
value:
type: "object"
properties:
balanceType:
type: "integer"
format: "int64"
nullable: true
periods:
maxItems: 200
type: "array"
description: "Бухгалтерская отчетность."
nullable: true
items:
type: "object"
properties:
periodName:
maxLength: 512
type: "string"
description: "Отчетный период."
nullable: true
dateBegin:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\
d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Начало периода."
format: "string"
nullable: true
dateEnd:
pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\
d{2}:\\d{2})|Z)?)$"
type: "string"
description: "Конец периода."
format: "string"
nullable: true
data:
maxItems: 200
type: "array"
nullable: true
items:
type: "object"
properties:
form:
maxLength: 512
type: "string"
description: "Форма."
nullable: true
section:
maxLength: 512
type: "string"
description: "Раздел."
nullable: true
name:
maxLength: 512
type: "string"
description: "Наименование."
nullable: true
code:
maxLength: 512
type: "string"
description: "Код."
nullable: true
value:
maxLength: 512
type: "string"
description: "Значение."
nullable: true
id:
type: "integer"
description: "Идентификатор списка\
."
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
isNegative:
required:
- "color"
- "value"
type: "object"
properties:
value:
required:
- "negativeListsCount"
type: "object"
properties:
negativeListsCount:
type: "integer"
format: "int32"
description: "Статистика негативных списков."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
unfairSupplier:
required:
- "color"
type: "object"
properties:
value:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
invalidLegalAddress:
required:
- "color"
type: "object"
properties:
value:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
disqualifiedPersons:
required:
- "color"
type: "object"
properties:
value:
required:
- "id"
- "isNegative"
type: "object"
properties:
isNegative:
type: "boolean"
id:
type: "integer"
format: "int32"
listName:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
taxReport:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
taxDebt:
required:
- "color"
type: "object"
properties:
value:
required:
- "statDate"
- "sum"
type: "object"
properties:
sum:
type: "number"
format: "double"
statDate:
type: "string"
format: "date"
description: "Налоговая задолженность."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
description: "Результат внутренней проверки компании:\n\n\
* `BankruptcyMessage` — сообщения о банкротстве;\n\n* `Plaintiff`\
\ — судебные дела в качестве истца;\n\n* `ThirdOrOtherPerson`\
\ — судебные дела в качестве третьего лица;\n\n* `Defendant`\
\ — судебные дела в качестве ответчика;\n\n* `DefendantDynamic`\
\ — динамика судебных дел в качестве ответчика;\n\n* `ExecutedProceedings`\
\ — завершенные исполнительные производства;\n\n* `ActiveProceedings`\
\ — активные исполнительные производства;\n\n* `SameManager`\
\ — массовый руководитель;\n\n* `SameAddressNumber` — ма\
ссовый юридический адрес;\n\n* `Finance` — бухгалтерская\
\ отчетность;\n\n* `IsNegative` — негативные списки;\n\n\
* `UnfairSupplier` — реестр недобросовестных поставщиков\
;\n\n* `InvalidLegalAddress` — список компаний, отсутств\
ующих по юридическому адресу;\n\n* `DisqualifiedPersons`\
\ — реестр дисквалифицированных лиц;\n\n* `ReferenceCheckRecommended`\
\ — рекомендация проверки в справочных источниках;\n\n*\
\ `DueDiligenceRecommended` — рекомендация проведения до\
кументальной проверки (Due Diligence);\n\n* `TaxReport`\
\ — налоговая отчетность;\n\n* `TaxDebt` — налоговая зад\
олженность."
checkResult:
required:
- "admittedContractsAsSupplier"
- "authorizedCapitalAmount"
- "confidantChangeDate"
- "founderChangeDate"
- "legalAddressChangeDate"
- "legalForm"
- "licensedOkvedCount"
- "okvedCount"
- "registrationDate"
- "riskLevel"
- "status"
type: "object"
properties:
status:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
registrationDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
legalAddressChangeDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
founderChangeDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
confidantChangeDate:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "date"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
authorizedCapitalAmount:
required:
- "color"
type: "object"
properties:
value:
type: "number"
format: "double"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
admittedContractsAsSupplier:
required:
- "color"
- "value"
type: "object"
properties:
value:
required:
- "count"
type: "object"
properties:
count:
type: "integer"
format: "int64"
totalValue:
type: "number"
format: "double"
nullable: true
description: "Статистика по контрактам."
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
legalForm:
required:
- "color"
type: "object"
properties:
value:
type: "string"
format: "string"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
okvedCount:
required:
- "color"
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int64"
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
licensedOkvedCount:
required:
- "color"
- "value"
type: "object"
properties:
value:
type: "integer"
format: "int64"
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
riskLevel:
required:
- "color"
type: "object"
properties:
value:
type: "integer"
format: "int32"
nullable: true
color:
type: "string"
description: "Цвет поля."
enum:
- "red"
- "yellow"
- "green"
- "none"
description: "Значение с цветом."
description: "Результат проверки компании:\n\n* `Status` —\
\ статус компании;\n\n* `RegistrationDate` — проверка да\
ты регистрации на превышение трех лет;\n\n* `LegalAddressChangeDate`\
\ — проверка изменения юридического адреса за последний\
\ год;\n\n* `FounderChangeDate` — проверка изменения учр\
едителя за последний год;\n\n* `ConfidantChangeDate` — п\
роверка изменения руководителя за последний год;\n\n* `AuthorizedCapitalAmount`\
\ — проверка превышения уставного капитала минимального\
\ порога;\n\n* `AdmittedContractsAsSupplier` — участие в\
\ государственных закупках;\n\n* `LegalForm` — организац\
ионно-правовая форма организации;\n\n* `OkvedCount` — ко\
личество видов деятельности, превышающих порог;\n\n* `LicensedOkvedCount`\
\ — проверка соответствия лицензии коду ОКВЭД;\n\n* `RiskLevel`\
\ — уровень риска."
relationSummary:
required:
- "relatedByConfidant"
- "relatedByFounder"
- "total"
type: "object"
properties:
total:
type: "integer"
format: "int32"
relatedByFounder:
type: "integer"
format: "int32"
relatedByConfidant:
type: "integer"
format: "int32"
description: "Связанные компании."
relatedCompanies:
maxItems: 4
type: "array"
items:
required:
- "ogrn"
type: "object"
properties:
name:
type: "string"
format: "string"
nullable: true
ogrn:
pattern: "^\\d{13,15}$"
type: "string"
inn:
pattern: "^(\\d{12}|\\d{10})$"
type: "string"
nullable: true
description: "Короткое описание связанной компании."
leaders:
maxItems: 100
type: "array"
items:
required:
- "name"
type: "object"
properties:
actualDate:
type: "string"
format: "date"
nullable: true
name:
type: "string"
format: "string"
position:
type: "string"
format: "string"
nullable: true
description: "Руководитель."
founders:
maxItems: 10000
type: "array"
items:
required:
- "name"
type: "object"
properties:
name:
type: "string"
format: "string"
nominalCostAmount:
type: "number"
format: "double"
nullable: true
sharePercent:
type: "number"
format: "double"
nullable: true
description: "Учредители."
history:
maxItems: 3
type: "array"
items:
required:
- "oldParamValue"
- "paramName"
- "paramText"
- "paramValue"
type: "object"
properties:
paramText:
type: "string"
format: "string"
changeDate:
type: "string"
format: "date"
nullable: true
paramName:
type: "string"
format: "string"
oldParamValue:
type: "string"
format: "string"
paramValue:
type: "string"
format: "string"
description: "Измененные данные."
licenses:
maxItems: 3
type: "array"
items:
required:
- "activity"
- "address"
- "status"
type: "object"
properties:
"no":
type: "string"
format: "string"
nullable: true
authorityName:
type: "string"
format: "string"
nullable: true
date:
type: "string"
format: "date"
nullable: true
startDate:
type: "string"
format: "date"
nullable: true
endDate:
type: "string"
format: "date"
nullable: true
address:
maxItems: 1200
type: "array"
items:
type: "string"
format: "string"
activity:
maxItems: 100
type: "array"
items:
type: "string"
format: "string"
status:
type: "string"
description: "Статус лицензии."
enum:
- "active"
- "inactive"
- "unknown"
description: "Лицензия."
contracts:
maxItems: 3
type: "array"
items:
required:
- "contractId"
- "counterpartyOgrn"
- "role"
type: "object"
properties:
contractId:
pattern: "^(\\d{19})$"
type: "string"
counterpartyOgrn:
pattern: "^\\d{13,15}$"
type: "string"
purchaseObjectTypeName:
type: "string"
format: "string"
nullable: true
stageCode:
type: "string"
description: "Статус контракта:\n\n\n* `execution` —\
\ исполнение;\n\n* `stopped` — аннулировано;\n\n*\
\ `completed` — исполнение завершено;\n\n* `canceled`\
\ — исполнение прекращено;\n\n* `unknown` — неизве\
стный статус."
enum:
- "execution"
- "completed"
- "canceled"
- "stopped"
- "unknown"
role:
type: "string"
description: "Роль в контракте."
enum:
- "supplier"
- "customer"
price:
type: "number"
format: "double"
nullable: true
description: "Гос. контракты компании."
financialStatementsResponse:
type: "object"
properties:
reason:
required:
- "reasonCode"
- "reasonText"
type: "object"
properties:
reasonCode:
type: "string"
description: "Коды для причин отсутствия финансово\
й отчетности."
enum:
- "isEntrepreneur"
- "lessThanYear"
- "noData"
reasonText:
maxLength: 512
type: "string"
description: "Данные о причине отсутствия финансовой о\
тчетности."
financialStatementsData:
required:
- "accountsPayable"
- "accountsReceivable"
- "profit"
- "revenue"
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
revenue:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Выручка."
profit:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Прибыль."
accountsPayable:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Кредиторский долг."
accountsReceivable:
required:
- "name"
- "values"
type: "object"
properties:
name:
maxLength: 512
type: "string"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
values:
maxItems: 5
type: "array"
items:
required:
- "year"
type: "object"
properties:
year:
type: "integer"
format: "int32"
value:
type: "integer"
format: "int64"
nullable: true
valueDiff:
type: "integer"
format: "int64"
nullable: true
description: "Данные за отчетный период."
description: "Дебиторский долг."
description: "Финансовая отчетность для excerpt."
description: "Обертка для данных по финансовой отчетности\
\ или для причины их отсутствия."
description: "Общая информация о компании."
description: "Выписка по компании."
example:
companyType: "company"
companyExcerpt:
shortName: ""
inn: "000000000000"
ogrn: "1000000000000"
okpo: "0000000000"
isActing: true
normName: "Название, ОАО"
shortNameRus: "ОАО \"Название\""
shortNameEn: "OAO \"Name\""
dateFirstReg: "1999-01-01"
fullNameRus: "ОТКРЫТОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\""
kpp: "000000000"
bik: "000000000"
email: "example@example.ru"
www: "www.example.ru"
registerNumber: ""
okato:
value: ""
code: "00086552000"
regionName: "Москва"
regionCode: 45
status:
isActing: true
date: "2023-04-24+03:00"
text: ""
type: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
phones:
- code: "342"
number: "0000000"
- code: "384"
number: "0000000"
- code: "385"
number: "0000000"
finance:
balanceType: 1
periods:
- periodName: "2015"
dateBegin: "2015-01-01+03:00"
dateEnd: "2015-12-31+03:00"
data:
- form: "Баланс"
section: "Актив"
name: "Нематериальные активы"
code: "1110"
value: "554779000"
id: 1
- form: "Баланс"
section: "Актив"
name: "Основные средства"
code: "1150"
value: "11502405000"
id: 5
- form: "Баланс"
section: "Актив"
name: "Долгосрочные финансовые вложения"
code: "1170"
value: "13980027000"
id: 12
- periodName: "2016"
dateBegin: "2016-01-01+03:00"
dateEnd: "2016-12-31+03:00"
data:
- form: "Баланс"
section: "Актив"
name: "Нематериальные активы"
code: "1110"
value: "50345000"
id: 1
- form: "Баланс"
section: "Актив"
name: "Основные средства"
code: "1150"
value: "10687759000"
id: 5
- form: "Баланс"
section: "Актив"
name: "Доходные вложения в материальные ценности"
code: "1160"
value: "636050000"
id: 9
- periodName: "2017"
dateBegin: "2017-01-01+03:00"
dateEnd: "2017-12-31+03:00"
data:
- form: "Баланс"
section: "Актив"
name: "Нематериальные активы"
code: "1110"
value: "69825000"
id: 1
- form: "Баланс"
section: "Актив"
name: "Основные средства"
code: "1150"
value: "11072450000"
id: 5
- form: "Баланс"
section: "Актив"
name: "Доходные вложения в материальные ценности"
code: "1160"
value: "566919000"
id: 9
leaders:
- actualDate: "2020-12-01+03:00"
name: "Фамилия Имя Отчество"
position: "генеральный директор"
managementCompany: ""
managementCompanyINN: "000000000000"
structure:
countCoownerFCSM: 1
countCoownerRosstat: 1
countCoownerEGRUL: 1
countBranch: 0
countBranchRosstat: 36
countBranchEGRUL: 139
countAffiliatedCompanyFCSM: 0
countAffiliatedCompanyRosstat: 22
countAffiliatedCompanyEGRUL: 23
nonprofitOrganizationRosstat: 3
proceedings:
active: 65
executed: 1326
charterCapital:
value: "1110616000"
date: "2000-01-01+04:00"
currencyCode: ""
currencyName: ""
companyWithSameInfo:
telephoneCount:
value: 1
phoneCode: "342"
phoneNumber: "2901202"
phoneList: []
addressCount: 51
addressWithoutRoomCount: 60
addressNotAffiliatedCount: 51
addressFTSCount: 26
managerCountInCountry: 1
managerCountInRegion: 1
managerInnCount: 0
companyLiquidatedWithSameInfo:
addressCount: 10
addressWithoutRoomCount: 10
arbitrationCases:
cases:
- year: 2006
plaintiff:
casesNumber: 2
sum: "17369466"
defendant:
casesNumber: 0
sum: "0"
thirdOrOtherPerson:
casesNumber: 0
- year: 2005
plaintiff:
casesNumber: 2
sum: "0"
defendant:
casesNumber: 0
sum: "0"
thirdOrOtherPerson:
casesNumber: 0
- year: 2004
plaintiff:
casesNumber: 2
sum: "0"
defendant:
casesNumber: 0
sum: "0"
thirdOrOtherPerson:
casesNumber: 0
total: 703
considered: 35
appealed: 4
decisionsAndRulings: 13
completed: 651
federalTaxRegistrationPayment:
regDate: "2010-01-25+03:00"
regAuthority: "Инспекция Федеральной налоговой службы"
regAuthorityAddress: "119048, Москва г, Доватора ул"
regAuthorityCode: "7704"
federalTaxRegistrationCurrent:
regDate: "2008-10-12+04:00"
regAuthority: "Межрайонная инспекция Федеральной налоговой слу\
жбы"
regAuthorityAddress: "125373, Москва г, Походный проезд"
regAuthorityCode: "7746"
okved:
- code: "51.10.1"
name: "Перевозка"
isMain: true
isMainEgrul: true
isMainRosstat: true
- code: "18.12"
name: "Прочие виды полиграфической деятельности"
isMain: false
isMainEgrul: false
isMainRosstat: false
- code: "33.16"
name: "Ремонт и техническое обслуживание"
isMain: false
isMainEgrul: false
isMainRosstat: false
stateContracts:
federalLaw94:
- year: 2013
tenders:
admittedNumber: 69
notAdmittedNumber: 0
winnerNumber: 69
contracts:
signedNumber: 69
sum: "91800339"
- year: 2012
tenders:
admittedNumber: 75
notAdmittedNumber: 0
winnerNumber: 75
contracts:
signedNumber: 75
sum: "4172264976"
- year: 2011
tenders:
admittedNumber: 45
notAdmittedNumber: 0
winnerNumber: 39
contracts:
signedNumber: 39
sum: "2956994583"
federalLaw223: []
address:
- postCode: "119002"
address: "г. Москва, ул. Арбат"
streetName: "ул. Арбат"
buildingNumber: "10"
fiasGUID: "b30b63a1-c2be-4efc-9d0c-c9b6d7438e15"
isHouseFiasGUID: false
fiasCode: "770000000000000000000000000"
fiasRegion: "77"
fiasArea: "000"
fiasCity: "000"
fiasPlace: "000"
fiasPlan: "0000"
fiasStreet: "0758"
actualDate: "2018-03-21+03:00"
buildingType: "дом"
businessCenterName: "Бизнес-центр"
fts: []
includeInList:
- isNegative: false
id: 6
listName: "Компании, сдающие отчетность"
- isNegative: false
id: 7
listName: "Предприятия"
- isNegative: false
id: 8
listName: "Компании"
bankruptcyMessage: []
expressExcerpt:
inn: "000000000000"
companyType: "company"
companyWithSameInfo:
sameManager:
manager: "Фамилия Имя Отчество"
managerCountInCountry: 1
managerInnCount: 0
sameAddress:
address: "г. Москва, ул. Арбат"
addressCount: 51
samePhone:
phoneCode: "342"
phoneNumber: "0000000"
phoneCount: 1
negativeLists: []
status:
isActing: true
date: "2023-04-24+03:00"
type: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
okvedInfo:
code: "50.00.0"
name: "Перевозка"
okvedCount: 21
netIncome:
periodName: "2020"
dateBegin: "2020-01-01+03:00"
dateEnd: "2020-12-31+03:00"
sum: "-96527133000"
taxYears:
minYear: 2015
maxYear: 2020
financeYears:
minYear: 2015
maxYear: 2020
stateContractYears:
minYear: 2006
maxYear: 2013
activeProceedingsCount: 65
bankruptcyMessage:
idType: 7
messageType: "Тип сообщения"
date: "2021-10-26Z"
decisionDate: "2021-10-19Z"
caseNumber: "А56-13391/2020"
caseId: 23040734
frozenAccountDecisions: []
arbitrationCasesInfo:
year: 2018
count: 23
entrepreneurExcerpt:
inn: "000000000000"
ogrnip: "300000000000000"
okpo: "0000000000"
sex: "man"
okato:
value: ""
code: "00000000000"
regionName: "Московская область"
regionCode: 46
okopf:
code: "50102"
name: "Индивидуальные предприниматели"
phoneList: []
status:
isActing: true
date: "2017-07-06+03:00"
text: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
includeInList:
- isNegative: false
id: 26
listName: "Реестр субъектов"
federalTaxRegistrationPayment:
regAuthority: "Межрайонная ИФНС России №23 по Московской облас\
ти"
regAuthorityAddress: "144000, Московская обл, г Электросталь"
regAuthorityCode: "5081"
federalTaxRegistrationCurrent:
regDate: "2017-07-06+03:00"
regAuthority: "Межрайонная инспекция Федеральной налоговой слу\
жбы"
regAuthorityAddress: "140000, Московская обл, Люберцы г"
regAuthorityCode: "5027"
citizenship:
code: 643
name: "Российская Федерация"
okved:
- code: "63.91"
name: "Деятельность информационных агентств"
isMain: true
registrationInFunds:
pensionFund:
registrationDate: "2017-07-07+03:00"
registerNumber: "060027069206"
regAuthority: "Государственное учреждение"
submittedStatements:
- form: "Р21001"
submissionDate: "2017-07-03+03:00"
availabilityDate: "2017-07-06+03:00"
grn: "000000000000000"
decisionType: "Решение о государственной регистрации"
stateContracts:
federalLaw94:
- year: 2018
tenders:
admittedNumber: 0
notAdmittedNumber: 1
winnerNumber: 0
contracts:
signedNumber: 0
sum: "0"
bankruptcyMessage: []
expressExcerpt:
inn: "000000000000"
companyType: "company"
companyWithSameInfo:
sameManager:
manager: "Фамилия Имя Отчество"
managerCountInCountry: 1
managerInnCount: 0
sameAddress:
address: "г. Москва, ул. Арбат"
addressCount: 51
samePhone:
phoneCode: "342"
phoneNumber: "0000000"
phoneCount: 1
negativeLists: []
status:
isActing: true
date: "2023-04-24+03:00"
type: "Действующее"
code: 24
groupId: 1
groupName: "Действующее"
okvedInfo:
code: "51.10.1"
name: "Перевозка"
okvedCount: 21
netIncome:
periodName: "2020"
dateBegin: "2020-01-01+03:00"
dateEnd: "2020-12-31+03:00"
sum: "-96527133000"
taxYears:
minYear: 2015
maxYear: 2020
financeYears:
minYear: 2015
maxYear: 2020
stateContractYears:
minYear: 2006
maxYear: 2013
activeProceedingsCount: 65
bankruptcyMessage:
idType: 7
messageType: "Тип сообщения"
date: "2021-10-26Z"
decisionDate: "2021-10-19Z"
caseNumber: "А56-13391/2020"
caseId: 23040734
frozenAccountDecisions: []
arbitrationCasesInfo:
year: 2018
count: 23
companyCard:
statusType: "active"
requisites:
inn: "000000000000"
ogrn: "1000000000000"
kpp: "000000000"
shortName: "ПАО \"НАЗВАНИЕ\""
fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\""
dateReg: "1996-06-21"
terminationDt: "2020-11-20"
status: "Действующая организация"
authorizedCapitalAmount: 3975771140
ogrnAssignDate: "2000-01-01"
legalAddress: "119019, г Москва, ул Арбат"
city: "Москва"
pages:
- page: "okved"
- page: "contract"
- page: "license"
- page: "history"
- page: "trafficLight"
- page: "feedback"
- page: "financialStatements"
excerpt:
requisites:
legalForm: "ПУБЛИЧНЫЕ АКЦИОНЕРНЫЕ ОБЩЕСТВА"
organizationSizeDesc: "Описание"
entityRegistrationDate: "2010-01-25"
regAuthorityAddressTxt: "125373, гор. Москва, Походный Проезд"
regAuthorityName: "Межрайонная Инспекция Федеральной Налоговой\
\ Службы"
pfrRegistrationNumber: "0000000000000"
pfrAuthorityName: "Отделение Фонда Пенсионного и Социального С\
трахования"
pfrRegistrationDate: "2010-06-18"
insRegistrationNumber: "000000000000000"
insAuthorityName: "Отделение Фонда Пенсионного и Социального С\
трахования"
insRegistrationDate: "2000-10-01"
okvedSummary:
count: 22
main:
- code: "51.10.1"
description: "Перевозка."
additional:
- code: "18.12.1"
description: "Прочие виды деятельности."
- code: "33.16.1"
description: "Ремонт и техническое обслуживание."
- code: "41.20.1"
description: "Строительство."
contractSummary:
count: 164
admittedCount: 40
notAdmittedCount: 94
totalValue: 3.2823479357625E10
licenseSummary:
total: 10
active: 10
inactive: 0
trafficLightColors:
redCount: 1
yellowCount: 5
greenCount: 14
innerCheckResult:
bankruptcyMessage:
value:
idType: 7
messageType: "Тип сообщения"
date: "2011-10-26Z"
decisionDate: "2011-10-19Z"
caseNumber: "А56-00000/2010"
caseId: 0
color: "green"
plaintiff:
value:
minDate: 2004
maxDate: 2018
totalCases: 470
color: "yellow"
thirdOrOtherPerson:
value:
minDate: 2007
maxDate: 2018
totalCases: 85
color: "yellow"
defendant:
value:
minDate: 2007
maxDate: 2018
totalCases: 157
color: "yellow"
defendantDynamic:
value:
lastYear: 2019
prevLastYear: 2018
percent: 50
color: "none"
executedProceedings:
value: 1326
color: "yellow"
activeProceedings:
value: 65
color: "red"
sameManager:
value:
inn: "000000000000"
sameManager:
manager: "Фамилия Имя Отчество"
managerCountInCountry: 1
managerInnCount: 1
color: "red"
sameAddressNumber:
value: 51
color: "yellow"
finance:
value:
balanceType: 1
periods:
- periodName: "2015"
dateBegin: "2015-01-01+03:00"
dateEnd: "2015-12-31+03:00"
data: []
- periodName: "2016"
dateBegin: "2016-01-01+03:00"
dateEnd: "2016-12-31+03:00"
data: []
- periodName: "2017"
dateBegin: "2017-01-01+03:00"
dateEnd: "2017-12-31+03:00"
data: []
color: "green"
isNegative:
value:
negativeListsCount: 0
color: "green"
unfairSupplier:
value:
isNegative: true
id: 1
listName: "Название"
color: "green"
invalidLegalAddress:
value:
isNegative: true
id: 1
listName: "Название"
color: "green"
disqualifiedPersons:
value:
isNegative: true
id: 1
listName: "Название"
color: "green"
taxReport:
value: "2023-04-25"
color: "none"
taxDebt:
value:
sum: 10
statDate: "2000-01-01"
color: "green"
checkResult:
status:
value: "Действующая организация"
color: "none"
registrationDate:
value: "1994-06-21"
color: "green"
legalAddressChangeDate:
value: "2019-07-10"
color: "green"
founderChangeDate:
value: "2021-10-25"
color: "green"
confidantChangeDate:
value: "2022-04-18"
color: "green"
authorizedCapitalAmount:
value: 3975771140
color: "green"
admittedContractsAsSupplier:
value:
count: 40
totalValue: 27523079541
color: "green"
legalForm:
value: "Публичные акционерные общества"
color: "green"
okvedCount:
value: 22
color: "none"
licensedOkvedCount:
value: 0
color: "none"
riskLevel:
value: 0
color: "none"
relationSummary:
total: 10
relatedByFounder: 0
relatedByConfidant: 0
relatedCompanies:
- name: "ООО \"Название\""
ogrn: "1000000000000"
inn: "000000000000"
leaders:
- actualDate: "2022-01-01"
name: "Фамилия Имя Отчество"
position: "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР"
founders: []
history:
- paramText: "организации"
changeDate: "2022-09-06"
paramName: "auth_cap"
oldParamValue: "2444535550.00"
paramValue: "3975771140.00"
- paramText: "организации"
changeDate: "2022-06-11"
paramName: "lic_new"
oldParamValue: "Л041-01162-50/00369716 от 9 апреля 2020"
paramValue: "Л041-01162-50/00369716|2020-04-09|2020-04-09"
licenses:
- "no": "14761-АТ"
authorityName: "МИНИСТЕРСТВО"
date: "2020-07-29"
startDate: "2020-07-30"
address: []
activity:
- "РАЗРАБОТКА"
status: "active"
- "no": "Л041-01162-50/00369716"
authorityName: "ФЕДЕРАЛЬНАЯ СЛУЖБА ПО НАДЗОРУ В СФЕРЕ ЗДРАВООХ\
РАНЕНИЯ"
date: "2020-04-09"
startDate: "2020-04-09"
address: []
activity:
- "МЕДИЦИНСКАЯ ДЕЯТЕЛЬНОСТЬ"
status: "active"
- "no": "Л042-01137-77/00283899"
authorityName: "ДЕПАРТАМЕНТ ЗДРАВООХРАНЕНИЯ"
date: "2019-10-03"
startDate: "2019-10-03"
address: []
activity:
- "ФАРМАЦЕВТИЧЕСКАЯ ДЕЯТЕЛЬНОСТЬ"
status: "active"
contracts:
- contractId: "0173200000000000071"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "completed"
role: "supplier"
price: 612000
- contractId: "1490000000000000006"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "execution"
role: "supplier"
price: 664976
- contractId: "1870000000000000002"
counterpartyOgrn: "1000000000000"
purchaseObjectTypeName: "Услуги"
stageCode: "execution"
role: "supplier"
price: 6000000
financialStatementsResponse:
reason:
reasonCode: "lessThanYear"
reasonText: "Компании меньше года"
financialStatementsData:
year: 2021
revenue:
name: "Выручка"
value: 378657216000
valueDiff: 148890851000
values:
- year: 2019
value: 551767420000
- year: 2020
value: 229766365000
valueDiff: -322001055000
- year: 2021
value: 378657216000
valueDiff: 148890851000
profit:
name: "Прибыль"
value: -45639139000
valueDiff: 50887994000
values:
- year: 2019
value: 5286800000
- year: 2020
value: -96527133000
valueDiff: -101813933000
- year: 2021
value: -45639139000
valueDiff: 50887994000
accountsPayable:
name: "Кредиторский долг"
value: 100062394000
valueDiff: -7293171000
values:
- year: 2019
value: 95785513000
- year: 2020
value: 107355565000
valueDiff: 11570052000
- year: 2021
value: 100062394000
valueDiff: -7293171000
accountsReceivable:
name: "Дебиторский долг"
value: 83489186000
valueDiff: 1918241000
values:
- year: 2019
value: 104635508000
- year: 2020
value: 81570945000
valueDiff: -23064563000
- year: 2021
value: 83489186000
valueDiff: 1918241000
"400":
description: "Некорректный запрос"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
example:
errorId: "1b3c8ae867bc100d"
errorCode: "INVALID"
errorMessage: "Некорректный ОГРН: 1000000000000"
"401":
description: "Ошибка аутентификации"
headers:
X-Request-Id:
required: true
style: "simple"
explode: false
schema:
maxLength: 50
type: "string"
description: "Идентификатор запроса."
content:
application/json:
schema:
required:
- "errorCode"
- "errorId"
- "errorMessage"
type: "object"
properties:
errorCode:
maxLength: 50
type: "string"
description: "Код ошибки."
errorDetails:
type: "object"
description: "Дополнительные данные об ошибке."
errorId:
maxLength: 50
type: "string"
description: "Уникальный идентификатор ошибки."
errorMessage:
maxLength: 400
type: "string"
description: "Текст ошибки."
examples:
Ошибка при неактивном токене:
value:
errorId: "60324c74-e4b9-477d-baae-786956876a28"
errorMessage: "Токен недействителен"
errorCode: "UNAUTHORIZED"
Ошибка при неправильно заданной компании:
value:
errorId: "efc04138-7d50-40f9-a367-0e1ca4d7