Описание REST-сервиса

  • Данное описание предназначено для разработчиков информационно-учетных систем, с вопросами возможности проверки заявлений через в информационно-учетную систему следует обращаться к поставщикам услуг информационно-учетной системы.
  • REST-сервис реализует один метод, на входе которого - запрос для проверки списка документов (одиночного документа), на выходе - результат проверки.
  • REST-сервис отвечает по адресу http://service.nalog.ru/blrchk/rest.json и использует метод POST
  • Запрос для проверки документов создаётся в виде JSON-объекта, в соответствии с разделом Создание запроса для проверки документов
  • Ответ вернется в виде JSON-объекта, в котором по каждому документу проставлен признак проверки. Описание ответа содержится в разделе Описание ответа сервиса

Создание запроса для проверки документов

  • Запрос по документу - это JSON-объект, содержащий набор атрибутов документа
  • Атрибуты документа перечислены в таблице Перечень атрибутов проверяемых документов
  • Все атрибуты документа являются обязательными
  • Все атрибуты JSON-объекта, кроме атрибутов документа, игнорируются и возвращаются в ответе в неизменном виде. Например, к каждому документу может быть добавлен атрибут id, содержащий уникальный идентификатор документа. Этот атрибут при разборе ответа может быть использован для связи элементов ответа с элементами запроса.
  • Сервису может быть передан для проверки одиночный документ, или массив документов, содержащий не более 1 000 элементов
  • Если массив, переданный для проверки, содержит элементы, отличные от JSON-объектов, они будут проигнорированы.

Перечень атрибутов проверяемых документов:

Имя атрибута Наименование параметра Описание
Имя атрибута
inn
Наименование параметра
Идентификационный код (номер) импортёра
Описание
Строка, от 8 до 14 цифр
Имя атрибута
nom
Наименование параметра
Номер отметки о регистрации заявления, присвоенный налоговым органом
Описание
Строка, от 1 до 18 символов
Имя атрибута
dt
Наименование параметра
Дата отметки о регистрации заявления
Описание
Дата в формате ДД.ММ.ГГГГ

Примеры оформления запросов

Запрос по одиночному документу:
{"dt": "21.09.2010", "inn": "400074854", "nom": "315"}
                
Множественный запрос:
[{"dt": "21.09.2010", "inn": "400074854", "nom": "315"},
{"dt": "22.07.2010", "inn": "451810819661", "nom": "451514072010N00193"},
{"dt": "03.09.2012", "inn": "010100000105", "nom": "010103092012N00023"},
{"dt": "01.09.2010", "inn": "191060746", "nom": "89"}]
                

Описание ответа сервиса

Ответ сервиса представляет собой JSON-объект, структура которого зависит от корректности запроса:

  • Корректный запрос - ответ представляет собой копию структуры запроса, в каждый элемент запроса добавляется атрибут RESULT, содержащий код результата проверки:
    0 - Заявление не найдено (отсутствует в информационном ресурсе ФНС России).
    1 - Заявление найдено (принято в ФНС России успешно).
    2 - Заявление отозвано.
  • Запрос является синтаксически корректным JSON-объектом, однако отдельные его обязательные атрибуты отсутствуют или не удовлетворяют требованиям - ответ представляет собой копию структуры запроса, в который добавляется атрибут ERRORS, содержащий описание результата форматно логического контроля в виде JSON-объекта, ключами в котором являются имена обязательных атрибутов, в значениях которых диагностированы ошибки, а значениями - перечень выявленных ошибок.
  • Запрос является корректным массивом, однако некоторые его элементы некорректны. В этом случае вернется копия массива запроса, в корректные его элементы будет добавлен атрибут RESULT, в некорректные атрибут ERRORS, как описано выше, элементы массива, не являющиеся JSON-объектами (массивы, строки и т.д.) будут проигнорироавны и возвращены в неизменном виде
  • Запрос не является сиетаксически корректной структурой - ответ представляет собой JSON-объект, содержащий три атрибута:
    ERROR - Имеет значение "Ошибка разбора запроса"
    ERR_MSG - Сообщение об ошибке разбора запроса JSON - парсером
    SRC - Исходная строка запроса, которую не удалось разобрать

Примеры ответов

Ответ на корректный запрос по одиночному документу:
{"dt": "21.09.2010", "inn": "400074854", "nom": "315", "RESULT": "1"}
Ответ на множественный запрос, часть элементов которого корректны, часть - нет:
[{"dt": "21.09.2010", "inn": "400074854", "nom": "315", "RESULT": "1"},
{"dt": "21.39.2010", "inn": "400074854X", "nom": "315",
    "ERRORS": {"dt": ["Поле \"Дата отметки о регистрации заявления\" должно содержать дату в формате ДД.ММ.ГГГГ"],
        "inn": ["Поле \"Идентификационный код (номер) импортёра\" должно содержать только цифровые символы"]}},
{"dt": "22.07.2010", "inn": "451810819661", "nom": "451514072010N00193", "RESULT": "1"},
{"dt": "03.09.2012", "inn": "010100000105", "nom": "010103092012N00023", "RESULT": "2"},
{"dt": "01.09.2010", "inn": "191060746", "nom": "89", "RESULT": "2"}]
                
Ответ на некорректный запрос:
{"ERR_MSG": "Expected name at line 1 column 102", "ERROR": "Ошибка разбора запроса", "SRC": "[{\"dt\": \"21.09.2010\", \"inn\": \"400074854\", \"nom\": \"315\"},{\"dt\": \"21.39.2010\", \"inn\": \"400074854X\", \"nom\": \"315\",{\"dt\": \"22.07.2010\", \"inn\": \"451810819661\", \"nom\": \"451514072010N00193\"},{\"dt\": \"03.09.2012\", \"inn\": \"010100000105\", \"nom\": \"010103092012N00023\"},{\"dt\": \"01.09.2010\", \"inn\": \"191060746\", \"nom\": \"89\"}]"}