Общие сведения
Данный механизм позволяет получить набор консолидированных данных по оплате фиксированных взносов, а также возвращает ссылки на получения данных,
необходимых для формирования платежных поручений на уплату страховых взносов.
В результате выполнения запроса возвращается файл с разметкой JSON, содержащий следующие данные:
- Таблица с информацией по взносам с суммой к оплате.
- Общая сумма взносов к оплате
- Массив публикуемых ссылок
- Ссылка для перехода в приложение 1С для проверки расчета.
- Ссылка на закрытие соответствующей задачи в списке задач.
- Ссылки для вызова веб-сервиса Получение реквизитов для уплаты налогов и взносов, необходимых для формирования платежных поручений.
Помощник построен на механизме Асинхронное получение данных.
- Адрес получения данных - https://{{server}}/a/{{app}}/{{tenant}}/hs/dt/storage/async.
- Идентификатор данных - self_insurance_payments .
Таким образом отправка запросов на получение данных помощника производится по адресу: https://{{server}}/a/{{app}}/{{tenant}}/hs/dt/storage/async/ self_insurance_payments.
Формат входящих параметров
При выполнении запроса к данным помощника внешняя система должна передать в теле запроса параметры в виде JSON со структурой:
- organization – необязательный – организация или индивидуальный предприниматель. Если не указано, данные будут получены по основной организации
- inn – ИНН организации (10 символов) или индивидуального предпринимателя (12 символов)
- kpp – КПП организации. Имеет смысл только для юридических лиц. Не заполняется для ИП
- date – дата, на которую необходимо рассчитать страховые взносы к уплате.
Пример настроек
{ "organization": { "inn": "501800056008", "kpp": "" }, "date": "2018-01-01T00:00:00" }
Ответы при формировании файла данных
Ответ формируется в задании. В результате запроса состояния задания внешняя система может получить ответ от задания с кодами ответов:
Код ответа | Ответ | Описание |
---|---|---|
10200 | Выполнено | Если все рассчитали и не возникло предупреждений, то ответ будет содержать информацию о сформированном файле с данными помощника (см. ниже). |
10240 | Выполнено с предупреждениями | Если не заполнены реквизиты, необходимые для оплаты взносов. В результате также будет возвращена информация о сформированном файле с данными помощника (см. ниже). |
10400 | Ошибка данных | Если переданы некорректные настройки или не нашли организацию в области. |
10500 | Внутренняя ошибка | Если расчет страховых взносов за указанный период не поддерживается. |
Структура файла ответа
Файл формируется с разметкой JSON следующей структуры:
- links – массив публикуемых ссылок. Содержит ссылки для перехода в 1С и на публикуемый API, связанный с помощником.
- name – идентификатор ссылки в файле
- type – тип ссылки - одно из значений: anchor - "якорь" - ссылка, которая открывает помощник в 1С; endpoint - публикуемый сервис внешнего API)
- title - надпись ссылки
- address - адрес для вызова из внешней системы
- settings - настройки, связанные с публикуемым endpoint'ом. Состав настроек свой для каждого endpoint'а
- payments – массив взносов с суммой к оплате.
- type - тип взноса: ПФР, ПФРсДоходов, ФФОМС, ФСС
- title - интерфейсное представление типа взноса
- description - доп. описание к взносу. К примеру, формула расчета взноса. Необязательное
- sum - сумма взноса к оплате
- link - описание ссылки получения реквизитов платежа для уплаты взноса:
- name – идентификатор ссылки в файле
- type – тип ссылки - значение "endpoint" - публикуемый сервис внешнего API
- title - надпись ссылки
- address - адрес для вызова из внешней системы
- settings - настройки, связанные с публикуемым endpoint'ом. Состав настроек см. в API реквизитов уплаты налогов и взносов
- total - общая сумма взносов к оплате
Пример ответа
Пример визуализации в клиентском коде