Сервис позволяет получать сообщения регламентированной отчетности, а так же статус подключения 1С-Отчетности.
Сервис доступен по адресу https://{{server}}:443/a/{{app}}/{{tenant}}/hs/api/v1/tax_reports/
Метод tax_reports вызывается GET-запросом и возвращает json со следующей структурой:
- organizations – Массив структур с показателями по организациям
- organization – Структура с данными организации
- inn – ИНН организации
- kpp – КПП организации
- name – наименование организации
- status – Строка – состояние 1С-Отчетности. Может принимать значения
- description – Строка - представление статуса.
- link – Строка – ссылка на помощник подключения (если status="Отключено") или на форму 1С-Отчетности (если status="Подключено")
- messages – Массив структур с сообщениями
- type – Строка - тип сообщения. Принимает следующие значения:
- ОтклоненныйОтчет
- Требование
- ВходящееПисьмо
- ОтветНаЗапрос
- СданныйОтчет
- text – содержимое сообщения
- date – дата сообщения
- priority – приоритет (важность) сообщения. Может принимать значения:
- Важное - важные сообщения, на которые стоит обратить внимание в первую очередь.
- Обычное
Таблица значений статусов их описания и ссылок на открываемый объект
Статус | Представление статуса | Объект, открываемый по ссылке |
|---|---|---|
ПодпискаОтсутствует | Отправляйте отчетность прямо из программы! Подключите в личном кабинете банка | Ссылка на Личный кабинет банка, переданная банком при настройке области |
Отключено | Подключена! Осталось настроить | Новое заявление на подключение |
ЗаявлениеОтправлено | Сейчас подключается... Скоро придет сообщение о подключении | Последнее отправленное заявление на подключение |
ЗаявлениеОтклонено | Заявление отклонено! В заявлении есть ошибки | Последнее отклоненное заявление на подключение |
Подключено | Пока нет ни одного отправленного отчета: Подключена! Теперь можно отправлять отчетность прямо здесь Если хотя бы один отчет отправлен и новых сообщений нет: Новых сообщений нет Если новые сообщения есть: [Пустая строка] | Форма 1С-Отчетность |
В результате запроса данных внешняя система может получить:
- Ответ с кодом возврата 400 (Ошибка данных) и поясняющее сообщение, если возникли ошибки получения информации по организации в области.
- Ответ с кодом возврата 200 вернет сообщение в формате JSON следующего вида:
Пример запроса
https://1cfresh.com/a/bs/10420/hs/api/v1/tax_reports/
Пример ответа, если отчетность не подключена
{
"organization": {
"inn":"771578598630",
"kpp":"",
"name": "ИП Петров С.Н."
},
"status": "Отключено",
"description": " Подключена! Осталось настроить",
"link": "e1cib/data/РегистрСведений.ПубликуемыеНавигационныеСсылки
?Идентификатор=f2e057ff-eaab-452a-8794-713a874f0f9f",
"messages": []
}
Пример ответа, если отчетность подключена
{
"organization": {
"inn":"702408453730",
"kpp":"",
"name": "ИП Сидоров А.А."
},
"status": "Подключено",
"description": "",
"link": "e1cib/data/РегистрСведений.ПубликуемыеНавигационныеСсылки
?Идентификатор=f2e057ff-eaab-452a-8794-713a874f0f9f",
"messages": [
{
"type":"СданныйОтчет",
"text":"Декларация по УСН",
"date":"2019-08-13T11:45:01",
"priority": "Обычное"
}
]
}