Альтернативаное распознавание формы 2-НДФЛ¶

/parseAsync/parseNdfl2Alter¶

Данный вызов недоступен в личном кабинете

Для подключения обратитесь на support@iidx.ru

Данный метод работает исключительно в режиме асинхронного выполнения. Подробнее, см. асинхронный режим выполнения запросов

Тип HTTP запроса: multipart POST

URL вызова: https://api.id-x.org/idx/api2/parseAsync/parseNdfl2Alter

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
file	File	Да	Фотография документа

Проверка распознает следующие форматы: JPG, JPEG, PNG, BMP, TIFF, GIF, PDF, DJVU

Фотография должна соответствовать требованиям к качеству

Функция возвращает:

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
taskFinished	Boolean	Нет	Статус проверки
explained	Объект типа Explained	Нет	Массив распознанных документов Подробнее см. Поле распознынных документов

Пример асинхронного вызова:

POST /idx/api2/parseAsync/parseNdfl2Alter
Host: api.id-x.org
Content-Type: multipart/form-data; boundary=----
Accept: application/json

------
Content-Disposition: form-data; name="accessKey"

Выданный accessKey
------
Content-Disposition: form-data; name="secretKey"

Выданный secretKey
------
Content-Disposition: form-data; name="file"; filename="ndfl2.jpg"
Content-Type: image/jpeg

[File data]
------

Пример ответа на асинхронный запрос:

{
    "resultCode": 0,
    "operationToken": "82e9d47328947457353543565349",
    "resultMessage": " "
}

operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.

Поле распознынных документов¶

Тип объекта Explained:

Параметр	Тип	Описание
ndfl2	Объект типа Ndfl2	Объект содержащий в себе документ формы 2-НДФЛ Подробнее см. Поле документа формы 2-НДФЛ

Поле документа формы 2-НДФЛ¶

Тип объекта Ndfl2:

Параметр	Тип	Описание
present	Bool	Предоставлен ли документ 2-НДФЛ
pages	Объект типа Pages	Объект содержащий в себе распознанные поля документа формы 2-НДФЛ Подробнее см. Поля считанные с формы 2-НДФЛ

Поля считанные с формы 2-НДФЛ¶

Тип объекта Pages:

Параметр	Тип	Описание
inn	String	ИНН
sign	String	Есть подпись представителя
year	String	Год
oktmo	String	Код по ОКТМО
phone	String	Телефон
stamp	String	Есть печать организации
number	String	Номер
incomes	Income	Доход Подробнее см. Поле доход
fullName	String	Полное имя
incomes1	Income	Доход первой таблицы Подробнее см. Поле доход
incomes2	Income	Доход второй таблицы Подробнее см. Поле доход
incomes3	Income	Доход третьей таблицы Подробнее см. Поле доход
lastName	String	Фамилия
birthDate	String	Дата рождения
firstName	String	Имя
issueDate	String	Дата выдачи
nameAgent	String	Налоговый агент
secondName	String	Отчество
countryCode	String	Гражданство (код страны)
digitalSign	String	Есть печать электронной цифровой подписи
innEmployer	String	ИНН налогового агента
kppEmployer	String	КПП
documentCode	String	Код документа, удостоверяющего личность
hasCorrections	String	Есть исправления
numberPassport	String	Серия и номер документа
statusTaxPayer	String	Статус налогоплательщика
incomesTaxBase1	String	Налоговая база
incomeTable1Rate	String	Ставка первой таблицы
incomeTable2Rate	String	Ставка второй таблица
incomeTable3Rate	String	Ставка третий таблица
incomeTable2Exists	String	Есть вторая таблица
incomeTable3Exists	String	Есть третья таблица
reorganizationCode	String	Форма реорганизации(ликвидации, код)
incomesTotalIncome1	String	Общая сумма дохода
innKppReorganization	String	ИНН/КПП реорганизованной организации
incomeTable1LastMonth	String	Последний месяц первой таблицы
incomeTable2LastMonth	String	Последний месяц второй таблицы
incomeTable3LastMonth	String	Последний месяц третьей таблицы
incomeTable1FirstMonth	String	Первый месяц первой таблицы
incomeTable2FirstMonth	String	Первый месяц второй таблицы
incomeTable3FirstMonth	String	Первый месяц третьей таблицы
incomesCalculationTaxAmount1	String	Сумма налога исчисленная

Поля доход¶

Тип объекта Income:

Параметр	Тип	Описание
code	String	Код
month	String	Месяц
rowId	String	Номер строки
amount	String	Сумма дохода
taxRate	String	Оценка оплаты
codeDeduction	String	Код вычета
amountDeduction	String	Сумма вычета

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

Пример успешного ответа, получаемого через getAsyncResult:

{
"taskFinished": true,
"resultCode": 0,
"operationToken": "...",
"resultMessage": "",
"fields": {
    "explained": {
    "ndfl2": {
        "present": true,
        "pages": [
        {
            "inn": "...",
            "sign": "...",
            "year": "...",
            "oktmo": "...",
            "phone": "...",
            "stamp": "...",
            "fileId": "...",
            "number": "...",
            "incomes": [
            {
                "code": "...",
                "month": "...",
                "rowId": "...",
                "amount": "...",
                "taxRate": "...",
                "codeDeduction": "...",
                "amountDeduction": "..."
            }
            ],
            "fullName": "...",
            "incomes1": [
            {
                "code": "...",
                "month": "...",
                "rowId": "...",
                "amount": "...",
                "taxRate": "...",
                "codeDeduction": "...",
                "amountDeduction": "..."
            }
            ],
            "incomes2": null,
            "incomes3": null,
            "lastName": "...",
            "birthDate": "...",
            "firstName": "...",
            "issueDate": "...",
            "nameAgent": "...",
            "secondName": "...",
            "countryCode": "...",
            "digitalSign": "...",
            "innEmployer": "...",
            "kppEmployer": "...",
            "documentCode": "...",
            "hasCorrections": "...",
            "numberPassport": "...",
            "statusTaxPayer": "...",
            "incomesTaxBase1": "...",
            "incomeTable1Rate": "...",
            "incomeTable2Rate": null,
            "incomeTable3Rate": null,
            "incomeTable2Exists": "...",
            "incomeTable3Exists": "...",
            "reorganizationCode": "...",
            "incomesTotalIncome1": "...",
            "innKppReorganization": "...",
            "incomeTable1LastMonth": "...",
            "incomeTable2LastMonth": null,
            "incomeTable3LastMonth": null,
            "incomeTable1FirstMonth": "...",
            "incomeTable2FirstMonth": null,
            "incomeTable3FirstMonth": null,
            "incomesCalculationTaxAmount1": "..."
        }
        ],
        "errors": [
        {}
        ]
    }
    }
}
}

Пример неуспешного ответа, получаемого через getAsyncResult:

{
    "resultCode": -100,
    "resultMessage": "Информация не найдена"
}