Общие сведения
Данный механизм предназначен для получения данных, отображаемых в приложении 1С в разделе «Монитор налогов и отчетности».
В приложении 1С монитор налогов и отчетности – это наглядная таблица о состоянии уплаты всех налогов и сдачи всей отчетности на настоящий момент в виде цветных прямоугольных блоков (индикаторов). Каждый цвет имеет свое значение:
- Зеленый (success) - за текущий отчетный (налоговый) период налоги уплачены, а отчетность сдана.
- Желтый (warning) - сигнализирует, что пора начинать готовиться в текущем отчетном (налоговом) периоде к уплате налогов (сборов) и формировать отчетность к сдаче.
- Красный (danger) - показывает, что была пропущена уплата какого-либо налога или сдача какого-либо отчета за прошедший отчетный (налоговый) период.
Механизм получения сведений из монитора налогов и отчетности возвращает файл с разметкой JSON, содержащий массив строк, каждая из которых соответствует строке монитора в приложении 1С. Для каждой ячейки может быть предоставлена текстовая информация, а также список навигационных ссылок на соответствующие разделы приложения 1С или ссылки на вызовы веб-методов для получения дополнительных данных.
API Монитора налогов и отчетов построено на механизме Асинхронное получение данных.
- Адрес получения данных - https://{{server}}/a/{{app}}/{{tenant}}/hs/dt/storage/async
- Идентификатор данных - tax_and_reporting_monitor
Таким образом отправка запросов на получение данных производится по адресу: https://{{server}}/a/{{app}}/{{tenant}}/hs/dt/storage/async/tax_and_reporting_monitor
Формат входных параметров
При выполнении запроса к данным помощника внешняя система должна передать в теле запроса параметры.
Формат параметров - JSON со структурой:
- organization – необязательный – организация или индивидуальный предприниматель. Если не указано, данные будут получены по основной организации.
- inn – ИНН организации (10 символов) или индивидуального предпринимателя (12 символов)
- kpp – КПП организации. Имеет смысл только для юридических лиц. Не заполняется для ИП
Пример входных параметров
"organization" : { "inn" : "781600584631" , "kpp" : "" } }
Поле organization является необязательным. Если не указано, данные будут получены по основной организации.
Ответы при формировании файла данных
Ответ формируется в задании. В результате запроса состояния задания внешняя система может получить ответ от задания с кодами ответов:
Код ответа | Ответ | Описание |
---|---|---|
10400 | Ошибка данных | Если переданы некорректные настройки или не нашли организацию в области. |
10500 | Внутренняя ошибка | Если актуализация завершилась с ошибками. |
10200 | Выполнено | Если все рассчитали и не возникло предупреждений возвращается ссылка на файл с данными помощника (см. ниже) |
Структура файла ответа
- link - ссылка для перехода в 1С (такая же как в других отчётах)
- name – идентификатор ссылки в файле
- type – тип ссылки - одно из значений: anchor - "якорь" - ссылка, которая открывает помощник в 1С; endpoint - публикуемый сервис внешнего API)
- title - надпись ссылки
- address - адрес для вызова из внешней системы
- settings - настройки, связанные с публикуемым endpoint'ом. Состав настроек свой для каждого endpoint'а
- rows - массив строк, которые пользователь 1С может видеть при открытии монитора;
- item - порядковый номер строки (строка заголовков имеет порядковый номер 0);
- title - (как элемент rows) - текст слева от строки;
- tax - левая из двух ячеек в строке;
- type - принимает значения: null = пустая ячейка; header = просто текст (для ячеек с item=0); danger = красный цвет ячейки; warning - жёлтый цвет ячейки; success - зелёный цвет ячейки;
- title - название ячейки. Может содержать текст {{smile}} как символ вывода смайлика.
- description - описание ячейки, комментирующее ситуацию.
- deadline - срок описываемого в ячейке события
- links - массив ссылок, открываемые на основании ситуации в ячейке.
- report - правая из двух ячеек в строке;
- type - принимает значения: null = пустая ячейка; header = просто текст (для ячеек с item=0); danger = красный цвет ячейки; warning - жёлтый цвет ячейки; success - зелёный цвет ячейки;
- title - (как элемент tax или report) - название ячейки. Может содержать текст {{smile}} как символ вывода смайлика.
- description - описание ячейки, комментирующее ситуацию.
- deadline - срок описываемого в ячейке события
- links - массив стандартных ссылок на отчёты, открываемые на основании ситуации в ячейке.
- name – идентификатор ссылки в файле
- type – тип ссылки - одно из значений: anchor - "якорь" - ссылка, которая открывает помощник в 1С; endpoint - публикуемый сервис внешнего API)
- title - надпись ссылки
- address - адрес для вызова из внешней системы
- settings - настройки, связанные с публикуемым endpoint'ом. Состав настроек свой для каждого endpoint'а
- check – тип Булево, признак того, что нужно вывести напоминание о необходимости выполнить сверку с ФНС
Пример ответа
{ "link": { "name": "goto1C", "type": "anchor", "title": "Монитор налогов и отчетности", "address": "e1cib/data/РегистрСведений.ПубликуемыеНавигационныеСсылки?Идентификатор=a2594686-1ff9-4987-8969-70d530b8f28d" }, "rows": [{ "item": 0, "title": "", "tax": { "type": "header", "title": "Оплата налогов" }, "report": { "type": "header", "title": "Сдача отчетности" } }, { "item": 1, "title": "УСН", "tax": { "type": "danger", "title": "Мы должны 12 210 руб.", "description": "Задолженность могла образоваться за один или несколько прошлых периодов", "deadline": "2024-05-02", "links": [{ "name": "tax_usn_calculator", "type": "endpoint", "title": "Погашение задолженности", "address": "hs/dt/storage/reports/tax_usn_calculator", "settings": { "organization": { "inn": "781600584631", "kpp": "" }, "date": "2018-05-14T00:00:00" } }] }, "report": { "type": "success", "title": "Отчетность сдана {{smile}}", "description": "Следующая декларация не позднее 30 апреля 2019 г.\n(за 2018 г.)", "deadline": "2019-04-30", "links": [] } }, { "item": 2, "title": "Взносы за себя", "tax": { "type": "warning", "title": "Пора оплатить 19 892,50 руб.", "description": "Не позднее 1 июля 2018 г.", "deadline": "2018-07-01", "links": [{ "name": "self_insurance_payments", "type": "endpoint", "title": "Оплата за 2 квартал 2018 г.", "address": "hs/dt/storage/reports/self_insurance_payments", "settings": { "organization": { "inn": "781600584631", "kpp": "" }, "date": "2018-06-30T23:59:59" } }, { "name": "self_insurance_payments", "type": "endpoint", "title": "Оплата за 2017 г.", "address": "hs/dt/storage/reports/self_insurance_payments", "settings": { "organization": { "inn": "781600584631", "kpp": "" }, "date": "2017-12-31T23:59:59" } } ] }, "report": { "type": "null" } } ], "check": true }
Пример отображения данных в интерфейсе
Пример визуализации в клиентском коде