Запрос результата проверки документов от участника ИО в системе «Вычеты»

Инициатор вызова: участник ИО.

Процедура вызывается для получения результата обработки документов по применению инвестиционных и имущественных налоговых вычетов физическим лицом в упрощенном порядке. Данный метод не предназначен для получения статуса регистрации участника ИО.

URL: /taxbenefits/v1/application/status/{requestId}

Method: GET

Query-parameters запроса (GetStatusTaxDeductionRequest)

Содержание	Тип	Обязательность	Описание
requestId	String	Обязательно	Идентификатор сообщения, указанный при создании запроса. Если участник ИО, указал X-Request_Id при создании запроса, то requestId будет совпадать с X-Request_Id.

Ответ (GetStatusTaxDeductionResponse)

Содержание	Тип	Обязательность	Описание
requestId	String	Обязательно	Идентификатор сообщения. Совпадает с requestId из запроса
acknowledgeTime	String	Не обязательно	Дата получения документа
updateTime	String	Не обязательно	Дата последнего обновления статуса вычета в системе
status	String	Обязательно	Статус обработки запроса. Возможные значения: IN_PROGRESS – запрос находится в обработке OK – ответ сформирован ERROR – ошибка технического характера
error	Struct	Не обязательно	Обязательно при значении атрибута status = ERROR. Иначе передается null
· code	String	Обязательно	Код ошибки
· message	String	Обязательно	Описание ошибки
· additionalInfo	Struct, string	Не обязательно	Набор дополнительных атрибутов ошибки. Может быть использован для составления более детального запроса в службу технической поддержки. Пример: "additionalInfo": { "tpFio": "Иванов Иван Иванович", "tpInn": "5212345678" }
result	Struct	Не обязательно	Обязательно при значении атрибута status = OK. Иначе передается null
· contentBase64	String, Base64	Обязательно	XML файл с данными ответа (при наличии в системе «Вычеты») в разрезе кода документа, закодированный в base64
· contentSignatureBase64	String, Base64	Обязательно	Отсоединенная подпись документа, закодированная в Base64

Бизнес-логика

Запрос о статусе направляется в компонент системы «Вычеты» с использованием технологии синхронного взаимодействия. Описание схемы взаимодействия при получении результата проверки документов от участника ИО в системе «Вычеты» представлено на рисунке 3.

Участник ИО создает унифицированный запрос (Request) для всех типов налогового вычета, где указывает идентификатор запроса в качестве query-параметра.

Система «Вычеты» проводит проверку по аналогии с 2.1. Регистрация участника ИО в системе «Вычеты».

Затем запрос проходит следующие проверки:

1. Наличие информации об участнике ИО в системе «Вычеты»

Проводится соответствие указанного в запросе FNS-OpenApi-AppId по реестру участников ИО в системе «Вычеты»

Если указанный партнер не найден, то участнику ИО направляется следующее сообщение:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

  "acknowledgeTime": null,

"updateTime": null,

"status": "ERROR",

"result": null,

"error": {

"code": "partner.not.found",

"message": "Участник ИО не найден",

"additionalInfo": {}

}

}

Если в реестре найден пользователь с указанным FNS-OpenApi-AppId проверяется признак подтверждения регистрации в системе. При его отсутствии передается ответ формата:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"acknowledgeTime": null,

"updateTime": null,

"status": "ERROR",

"result": null,

"error": {

"code": "partner.not.registered",

"message": "Участник ИО не зарегистрирован"

}

}

2. Поиск идентификатора запроса в системы «Вычеты»

Осуществляется поиск запроса по идентификатору requestId.

Если запрос с таким идентификатором не найден, то возвращается ответ:

{

"requestId": "b4e2a539344a451c0d725f2acdc1c61e",

"acknowledgeTime": null,

"updateTime": null,

"status": "ERROR",

"result": null,

"error": {

   "code": "application.by.request.not.found",

   "message": "Заявление по запросу b4e2a539344a451c0d725f2acdc1c61e не найдено",

   "additionalInfo": {

       "X_REQUEST_ID": "b4e2a539344a451c0d725f2acdc1c61e"

   }

}

}

Если запись с указанным идентификатором в очереди ответов найдена, тогда передается результат обработки документа согласно указанному выше формату. При отсутствии ошибок технического характера направляется кодированный в base64 ответ (answer), подписанный на стороне системы «Вычеты» КЭП МИ по ЦОД ФНС России. Запроса может иметь одно из 3 представленных ниже состояний:

1. ERROR – в направленном документе/запросе выявлены технические ошибки. Это финальное состояние обработки запроса, далее статус запроса меняться не будет.

Примеры возможных ошибок приведены в приложении. Пример сообщения:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"acknowledgeTime": null,

"updateTime": null,

"status": "ERROR",

"result": null,

"error": {

"code": "application.xsd.failed.base64",

"message": "Документ из запроса не прошел контроль по XSD схеме",

"additionalInfo": [

{

   "cvc-pattern-valid": "Value 'SOOBSCHTYPEB_3625665875_20200916_a1Bad4233f638e0454340f80beDE31Ea' is not facet-valid with respect to pattern 'SOOBSCHTYPEА_([0-9]{10})_([1-2]{1}[0-9]{3})(0[1-9]{1}|1[0-2]{1})(0[1-9]|[1-2]{1}[0-9]{1}|3[0-1]{1})_[0-9a-fA-F]{32}' for type '#AnonType_ИдДокФайл'"

}

]

}

}

2. IN_PROGRESS – запрос находится на стадии обработки. Это промежуточное состояние обработки запроса, необходимо повторно сделать запрос статуса сообщения. Рекомендуемые сроки повторного запроса статуса приведены в Приложение №2. Рекомендуемое расписание опроса статуса обработки заявления на налоговый вычет.

Пример сообщения:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"acknowledgeTime": "2020-09-02T23:21:02.646+03:00",

"updateTime": "2020-09-02T23:21:02.646+03:00",

"status": "IN_PROGRESS",

"error": null,

"result": null,

}

3. OK – документ проверен, сформирован ответ от ФНС. Это финальное состояние обработки запроса, далее статус запроса меняться не будет.

Пример сообщения:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"acknowledgeTime": "2020-09-02T23:21:02.646+03:00",

"updateTime": "2020-09-02T23:21:02.646+03:00",

"status": "OK",

"result": {

"contentBase64": "base64,
"contentSignatureBase64": "base64"

},

"error": null

}

Описание схемы взаимодействия при запросе статуса обработки документа» представлено на рисунке 3.

Рисунок 3 – Схема взаимодействия при запросе результата проверки документов от участника ИО в системе «Вычеты»

Приложение №1. Перечень возможных ошибок по методам взаимодействия с системой Вычеты

Инициатор вызова: участник ИО.

№	Атрибут	Значение
1.	code	partner.not.found
	message	Участник ИО не найден
	additionalInfo
2.	code	partner.not.registered
	message	Участник ИО не зарегистрирован
	additionalInfo
3.	code	application.xsd.failed
	message	Заявление не прошло валидацию по xsd схеме
	additionalInfo	cvc-pattern-valid: Value 'SOOBSCHTYPEB_3625665875_20200916_a1Bad4233f638e0454340f80beDE31Ea' is not facet-valid with respect to pattern 'SOOBSCHTYPEА_([0-9]{10})_([1-2]{1}[0-9]{3})(0[1-9]{1}|1[0-2]{1})(0[1-9]|[1-2]{1}[0-9]{1}|3[0-1]{1})_[0-9a-fA-F]{32}' for type '#AnonType_ИдДокФайл'
4.	code	application.xml.signature.failed
	message	Xml заявление не прошло проверку подписи cryptopro
	additionalInfo	xml_validation_signature_failed=Запрос %APPLICATION_KEY%. Xml заявление не прошло проверку подписи cryptopro
5.	code	application.by.request.not.found
	message	Заявление по запросу не найдено
	additionalInfo
6.	code	request.searching.fail
	message	Ошибочное состояние запроса. Обратитесь в службу технической поддержки
	additionalInfo
7.	code	ERR_INTERNAL
	message	Ответ не может быть сформирован, уточнение пишется в поле message
	additionalInfo
8.	code	partner.message.number
	message	Указанный в документе элемент НомерЗП отличается от ожидаемого
	additionalInfo	{ "ACTUAL_MESSAGE_NUMBER": "001", "EXPECTED_MESSAGE_NUMBER": "006" }
9.	code	application.xsd.failed.base64
	message	Заявление не прошло валидацию по xsd схеме
	additionalInfo	Содержимое поля contentBase64 должно быть закодировано в base64

*Данный список не является фиксируемым и может быть расширен.

Приложение №2. Рекомендуемое расписание опроса статуса обработки заявления на налоговый вычет.

Когда запрос находится в статусе IN_PROGRESS участник ИО направляет повторный запрос 2.3. Запрос результата проверки документов от участника ИО в системе «Вычеты» для получения актуальной информации о прогрессе его обработки.

Для нормализации нагрузки системы «Вычеты» во времени есть рекомендуемы сроки отправки повторного запроса статуса в зависимости от типа налогового вычета, информация о котором была направлена. Рекомендации указаны в таблице ниже:

№	Вид налогового вычета	Номер запроса по счету	Время повторной отправки запроса статуса
1.	Налоговый вычет Тип А и Б	1	через 1 минуту после отправки запроса
		2	через 10 минуту после запроса последнего статуса
		3	через 10 минуту после запроса последнего статуса
		4	через 1 час после запроса последнего статуса
		n	через 1 час после запроса последнего статуса

*Данный список не является окончательным. Рекомендации для запроса статуса по имущественному налоговому вычету будут направлены в последующих версиях документа.

Приложение № 2
Форма заявки на предоставление доступа к сервису

 

 

ФНС России 127381, г. Москва, ул. Неглинная, д. 23

ЗАЯВКА

на информационное взаимодействие в соответствии

с Правилами обмена информацией для

упрощенной процедуры получения налоговых вычетов

Полное наименование налогового агента/банка

ИНН/КПП налогового агента/банка

Прошу:

1) Предоставить доступ к электронным сервисам Цифровой платформы ФНС России для осуществления информационного взаимодействия в соответствии с Правилами обмена информацией для упрощенной процедуры получения налоговых вычетов на следующих контурах: 

Наименование контура	Требуемое действие
Контур интеграционного тестирования (КИТ)	Подключить/Отключить
Контур промышленной эксплуатации (КПЭ)	Подключить/Отключить

 

2) Включить следующие контакты в группу оперативного информирования в коммуникационных каналах о функционировании контуров и проведении технических работ (не менее 1 и не более 2):

№ п/п	Необходимые сведения	Данные пользователя 1	Данные пользователя 2
1	Полностью Фамилия Имя Отчество*
2	Управление/Отдел*
3	Должность*
4	Рабочий электронный адрес (e-mail)*
5	Мобильный телефон*

 

3) Уведомить об обеспечении доступа к запрашиваемому электронному сервису по адресу электронной почты _________________________________.

* обязательно для заполнения