Общие сведения
Данный механизм предназначен для получения данных, отображаемых в приложении 1С в разделе "Единый налоговый счет".
В результате выполнения запроса возвращается файл с разметкой JSON, содержащий следующие данные:
- Сальдо ЕНС по данным ФНС на дату актуальности
- Дата актуальности данных
- Сумма предстоящих платежей
- Зарезервированная на ЕНС сумма
- Итоговая сумма к оплате
API Личного кабинета ЕНС построено на механизме Асинхронное получение данных.
- Адрес получения данных - https://{{server}}/a/{{app}}/{{tenant}}/hs/dt/storage/async
- Идентификатор данных – ens_dashboard
Таким образом отправка запросов производится по адресу: https://{{server}}/a/{{app}}/{{tenant}}/hs/dt/storage/async/ens_dashboard
Формат входящих параметров
При выполнении запроса к данным внешняя система должна передать в теле запроса параметры в виде JSON со структурой:
- organization – организация или индивидуальный предприниматель. Если не указано, данные будут получены по основной организации
- inn – ИНН организации (10 символов) или индивидуального предпринимателя (12 символов)
- kpp – КПП организации. Имеет смысл только для юридических лиц. Не заполняется для ИП
Пример передаваемых параметров
{ "organization": { "inn": "779955555519", "kpp": "" } }
Ответы при формировании файла данных
Ответ формируется в задании. В результате запроса состояния задания внешняя система может получить ответ от задания с кодами ответов:
Код ответа | Ответ | Описание |
---|---|---|
10400 | Ошибка данных | Если переданы некорректные настройки или не нашли организацию в области. |
10404 | Данные не найдены | Если данные из личного кабинета ФНС не загружены. |
10500 | Внутренняя ошибка | Если произошла не классифицированная ошибка. |
10200 | Выполнено | Информация о сформированном файле с данными ЛК ЕНС. |
Структура файла ответа
Файл формируется в виде JSON следующей структуры:
- ens_balance – сальдо ЕНС по данным ФНС на дату актуальности
- relevance_date – дата актуальности
- upcoming_payments – сумма предстоящих платежей
- reserved_payments – зарезервированная на ЕНС сумма
- total_payment – итоговая сумма к оплате
- link – ссылка для перехода в 1С (такая же как в других отчётах)
- name – идентификатор ссылки в файле
- type – тип ссылки, значение anchor - "якорь" - ссылка, которая открывает помощник в 1С
- title – надпись ссылки
- address – адрес для вызова из внешней системы
Пример ответа
{ "ens_balance": 49500, "relevance_date ": "2024-12-16T00:00:00", "upcoming_payments": 49500, "reserved_payments": 0, "total_payment": 0, "link": { "name": "goto1C" "type": "anchor" "title": "Единый налоговый счет" "address": "e1cib/app/Обработка.ЕдиныйНалоговыйСчетЛичныйКабинет" } }