Проверка задолженности по налогам¶
personDebt¶
Данный метод работает исключительно в режиме асинхронного выполнения. Подробнее, см. асинхронный режим выполнения запросов
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/personDebt
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| inn | String | Да | ИНН |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| status | String | Нет | Статус проверки |
| list | Массив типа list | Нет | Массив объектов – данных о налоговой задолженности. Подробнее см. налоговая задолженность |
Пример асинхронного вызова:
POST /idx/api2/personDebt
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"inn": "123456789012"
}
Пример ответа на асинхронный запрос:
{
"resultCode": 0,
"operationToken": "82e9d47328947457353543565349",
"resultMessage": " "
}
operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.
Пример ответа, получаемого через getAsyncResult, когда задолжность найдена:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "82e9d6ec643242e348bbefbe4d7b",
"status": "found",
"list": [*налоговая задолженность*]
}
Пример ответа, получаемого через getAsyncResult, когда задолжность не найдена:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "82e9d6ec643242e348bbefbe4d7b",
"status": "not_found",
"list": []
}
Налоговая задолженность¶
Объект «Налоговая задолженность» включает следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| date | String | Дата появления задолженности |
| price | String | Сумма задолженности (рубли) |
| info | String | Описание типа задолженности |
Пример объекта «Налоговая задолженность» в формате json:
{
"date": "01.01.2010",
"price": "1000",
"info": "Налог на имущество физических лиц, взимаемый по ставкам, применяемым к объектам налогообложения, расположенным в границах городских округов (пени по соответствующему платежу)"
}