Общие сведения
Данный механизм позволяет получать данные, связанные с ключевыми показателями организации (данные Монитора руководителя), а также список задач по налогам и отчетности. Механизм является синхронным и возвращает результат по рассчитанным данным сразу при обращении.
К показателям деятельности организации относятся:
- Остатки денежных средств
- Остатки денежных средств детально (детально)
- Поступление денежных средств
- Расход денежных средств
- Продажи по контрагентам
- Задолженность покупателей
- Задолженность поставщикам
Для каждого показателя помимо названия и значения возвращается навигационная ссылка на отчет в приложении 1С, который может быть открыт в приложении и использован для расшифровки показателя. При необходимости, данные показателей могут быть актуализированы, но в общем случае этого не требуется. В состав возвращаемого набора данных всегда входит дата актуальности.
Помимо сведений о показателях деятельности организации, данный механизм позволяет получить список актуальных задач по уплате налогов и сдаче отчетности по организации – как просроченных, так и запланированных. Помимо списка задач с наименованием и сроком выполнения, возвращается число просроченных задач, дата последнего обновления списка и навигационная ссылка на Монитор налогов и отчетов.
Для задач по уплате налогов и сдаче отчетности поддерживается возможность помещения задачи в архив. В этом случае она перестанет отображаться в общем списке задач.
Используемые переменные
Переменная | Описание | Пример |
|---|---|---|
| server | Адрес сервера облачного сервиса Фреш. | https://1cfresh.com/ |
| app | Приложение в сервисе. | bs |
| tenant | Номер области данных пользователя. | 26 |
| baseURL | Полный адрес к API, включая имя сервиса, приложения и номера области: {{server}}/a/{{app}}/{{tenant}}/hs/api/v1 | https://1cfresh.com/a/bs/10420/hs/api/v1 |
api_authorization | Данные авторизации пользователя обслуживающей организации для доступа к API приложения абонента. | Basic bank.api 123Qwer |
Запрос значений показателей монитора руководителя
Метод позволяет получить значения показателей, как они представлены в мониторе руководителя.
В качестве показателей выводятся
№ | Показатель | Идентификатор |
|---|---|---|
| 1 | Остатки денежных средств | ОстаткиДенежныхСредств |
| 2 | Остатки денежных средств (детально) | ОстаткиДенежныхСредствДетально |
| 3 | Поступление денежных средств | ПоступлениеДенежныхСредств |
| 4 | Расход денежных средств | РасходДенежныхСредств |
| 5 | Продажи по контрагентам | ПродажиПоКонтрагентам |
| 6 | Задолженность покупателей | ЗадолженностьПокупателей |
| 7 | Задолженность поставщикам | ЗадолженностьПоставщикам |
Запрос
GET {{baseURL}}/kpi/
Authorization: {{api_authorization}}
Запрос выполняется от имени служебного пользователя обслуживающей организации.
Поля ответа:
- organizations – данные по организациям
- organization – организация
- inn – ИНН организации
- kpp – КПП организации
- name – представление организации
- organization – организация
- last_update – дата последнего обновления (дата актуалности)
- kpi – данные показателей
- id – строковый идентификатор группы показателей
- name – представление группы показателей
- ref – якорь на отчет в 1С для расшифровки показателя
- indicators – данные значений показателей
- indicator – представление показателя
- value – значение показателя
https://1cfresh.com/a/bs/10420/hs/api/v1/kpi/
Метод всегда возвращает статус 200 и данные в разметке JSON.
Актуализация данных монитора руководителя
Для актуализации результата можно выполнить запрос:
POST {{baseURL}}/kpi/update
Authorization: {{api_authorization}}
Будет выполнен пересчет значений показателей. Пересчет выполняется по всем организациям. Запрос является асинхронным. Если начинается выполнение актуализации, то возвращается код ответа 202 без данных.
Если выполнение актуализации не требуется, возвращается ответ с кодом 200 и данными ответа.
В общем случае показатели должны быть актуальны и их актуализация перед получением не требуется. Дата актуальности выводится в результатах в основном запросе.
Предполагается, что вызов POST запроса обновления показателей должен выполняться пользователем по кнопке, если его не устроит дата актуальности, также, как это происходит внутри в мониторе руководителя в 1С:БизнесСтарте.
Запрос задач по уплате налогов и сдаче отчетности
Метод позволяет получить список актуальных задач по уплате налогов и сдаче отчетности по организации.
Данные о задачах периодических платежей и проверках контролирующими органами данным сервисом не возвращаются.
Сервис имеет 2 метода:
- tasks/taxes - возвращает список актуальных задач бухгалтера и количество просроченных задач
- tasks/taxes/last_update/ - возвращает дату актуальности задач бухгалтера - дату, по которую сформированы задачи. Как правило, задачи формируются на 2 недели вперед.
Предоставляет данные о будущих задачах и о количестве просроченных
Запрос:
GET {{baseURL}}/tasks/taxes
Authorization: {{api_authorization}}
Параметры:
- tenant - номер приложения пользователя.
Запрос выполняется от имени служебного пользователя обслуживающей организации.
Поля ответа:
- organizations – данные по организациям
- organization – организация
- inn – ИНН организации
- kpp – КПП организации
- name – представление организации
- organization – организация
- expired – количество просроченных задач
- last_update – дата последнего обновления
- ref - ссылка на монитор налогов и отчетности
- tasks – актуальные задачи
- id - идентификатор задачи в 1С
- name – наименование задачи
- deadline – срок выполнения задачи
Пример запроса
https://1cfresh.com/a/bs/10420/hs/api/v1/tasks/taxes
Метод всегда возвращает 200 и данные json. При вызове метода срабатывает та же механика, что и при получении списка задач интерактивно: в сервисе планируется задание на ночь по пересчету календаря бухгалтера.
Пример ответа
{
"organizations": [{
"organization": {
"inn": "7721049904",
"kpp": "772101001",
"name": "ООО \"Конфетпром\""
},
"expired": 142,
"last_update": "2017-11-01T00:00:00",
"ref": "e1cib/command/ОбщаяКоманда.МониторНалоговИОтчетности",
"tasks": [{
"id": "7c08d1e0-f912-495d-9a7f-ade9875016f5",
"name": "Налог на прибыль, авансовый платеж за 3 квартал 2017 г.",
"deadline": "2017-10-30T00:00:00"
},
{
"id": "a0e51361-e49d-4c9e-ae5b-28c0f9651c84",
"name": "Налог на прибыль, декларация за 9 месяцев 2017 г.",
"deadline": "2017-10-30T00:00:00"
},
{
"id": "f2e459b4-a25b-4456-ace0-475e59722e31",
"name": "Страховые взносы, уплата за октябрь 2017 г.",
"deadline": "2017-11-15T00:00:00"
}
]
}]
}
Список задач всегда актуален на 2 недели вперед.
Изменение статуса задачи
Задачу можно пометить выполненной и поместить в архив, чтобы она не отображалась в общем списке задач. Для этого нужно выполнить запрос:
POST {{baseURL}}/tasks/status
Authorization: {{api_authorization}}
В теле запроса необходимо передать параметры в виде JSON со структурой:
- id – идентификатор задачи в 1C
- done – признак того, что задача выполнена и нужно поместить ее в архив. Возможные значения: true; false.
Если переданы некорректные параметры метод вернет 400. В остальных случаях возвращает статус 200.
Запрос даты обновления
Если требуется получить только информацию об актуальности данных без получения самих данных, можно отправить запрос на адрес:
Для задач
GET {{baseURL}}/tasks/taxes/last_update/
Authorization: {{api_authorization}}
Для показателей
GET {{baseURL}}/kpi/last_update/
Authorization: {{api_authorization}}
Поля ответа:
- organizations – данные по организациям
- organization – организация
- inn – ИНН организации
- kpp – КПП организации
- name – представление организации
- last_update – дата последнего обновления (дата актуальности календаря бухгалтера)
- organization – организация
Пример запроса
https://1cfresh.com/a/bs/10420/hs/api/v1/tasks/taxes/last_update/
Пример ответа
{
"organizations":[
{
"organization":{
"inn":"7725895602",
"kpp":"772501001",
"name":"Ромашка, ООО"
},
"last_update":"2017-09-20T17:39:49"
}
]
}