Расширение “Ferma OFD.ru” для CMS “HostCMS”
Введение
В документе приводятся технические сведения о плагине “Ferma OFD.ru”, предназначенном для CMS “HostCMS”. Модуль тестировался на версии 6.8.6. Модуль предназначен для взаимодействия информационной системы, использующей CMS “HostCMS” с информационными системами оператора фискальных данных “OFD.ru” для генерации фискальных документов с помощью интернет-касс и получения информации о сгенерированных фискальных документах.
1. Назначение расширения “Ferma OFD.ru”
Плагин “Ferma OFD.ru” для CMS “HostCMS” распространяется в виде архива, содержащего программное расширение, позволяющее CMS “HostCMS” взаимодействовать с информационными системами оператора фискальных данных “OFD.ru” с целью генерации чеков, загрузки чеков, а также просмотра реестра чеков и управления ими.
2. Основные принципы работы расширения
При смене статуса заказа клиента на статус, заданный в настройках формирования приходного чека (например, «Доставлено»), компонент «Ferma OFD.ru» автоматически создает в облачной кассе ОФД чек на получение денежных средств от покупателя.
3. Установка и настройка расширения
Расширение “Ferma OFD.ru” распространяется в виде архива, который нужно разархивировать в корень сайта, после разархивирвоания необходимо добавить новый модуль, для этого перейдите “Система” -> “Модули”
И нажать на кнопку «Добавления»
Форму добавления заполнить следующим образом, как на картинке ниже:
После заполнения, нажать «Сохранить», и модуль должен установиться:
3.1 Настройка плагина
Для настройки плагина перейдем на страницу настройки
С помощью пользовательского интерфейса в окне настроек, введите актуальные значения настроек плагина; назначение параметров описано в таблице 1.
После ввода значений в соответствующие поля нажмите кнопку «Сохранить»
Таблица 1. Настроечные параметры, необходимые для работы расширения “Ferma OFD.ru”
| Параметр | Описание |
|---|---|
| Логин | Данные идентификации (имя пользователя) для синхронизации данных через API с облачной кассой ОФД |
| Пароль | Данные аутентификации (пароль) для синхронизации данных через API с облачной кассой ОФД |
| ИНН | ИНН лица, от имени которого генерируется кассовый документ (чек) |
| Адрес электронной почты управляющего. На этот адрес будут отправляться сообщения об ошибках в работе модуля | |
| Система налогообложения | Система налогообложения |
| Свертка | Включение и выключение детализации в чеке всех товарных позиций: список товаров со стоимостями и общая сумма либо только общая сумма и текстовое название (например, «Пакет услуг», «Всего по чеку» и т. п.) |
| Название свертки | Текстовое название в случае выключенной детализации товарных позиций в чеке (например, «Пакет услуг», «Всего по чеку» и т. п.) |
| Статус заказа, для которого формировать чек автоматически | Значение статуса заказа, при котором автоматически запускается процедура формирования чека, в соответствии с настройками, например для статуса «Оплачен» |
| НДС по умолчанию | Вид вычисляемого налога на добавленную стоимость, значение вида НДС по умолчанию, необходимо заполнять в случаях, когда значение НДС не указано для выбранного в заказе товара |
3.2. Добавление автоматического обновление статуса чека
Для автоматического обновления статуса, необходимо создать задачу в модуле «Планировщик задач»
Выбрать наш модуль, действие и интервал выполнения
После заполнения, сохранить задачу.
При этом, сам планировщик должен быть добавлен в cron на сервере, как это сделать читайте тут: если ссылка не работает, то ищите в документации к движку
4. Использование расширения
В общем случае для создания товарного чека в облачной кассе ОФД не требуется никаких дополнительных действий: модуль в автоматическом режиме при смене статуса заказа, созданного клиентом в ИС интернет-магазина, на указанный в настройках создает чек на получение денежных средств от покупателя. Также чеки можно сформировать вручную из административной панели, в том числе чек на возврат сумм производится исключительно вручную, процедура описана в разделе 4.1.
В случае, если чек не сформирован по причине неправильного заполнения полей, то необходимо изменить их значения в заказе клиента или настройках и повторить попытку. Список уже сформированных чеков можно вызвать с помощью пунктов меню: «Ferma OFD.ru»
В списке чеков отображаются идентификаторы чеков в информационных системах “OFD.ru”, дата создания чека, сумма по чеку, тип чека (чек прихода или чек возврата), номер заказа (со ссылкой на страницу заказа), с которым связан чек и статус чека (например, «Чек передан в ОФД»).
Если текущее значение статуса не конечное, то его можно уточнить вручную обновив статус: нажав ссылку «Обновить статус»
Также имеется возможность фильтрации существующих чеков по периоду, типу или ID заказа.
4.1. Создание чеков в ручном режиме
Чек можно создать и в ручном режиме для каждого заказа. Нажав в реестре чеков на номер заказа нужного чека, либо выбрав заказ из списка заказов магазина и перейти к редактирование его
Здесь можно «Сформировать чек прихода» или «Сформировать чек возврата» в ручном режиме.
Чек возврата формируется только в ручном режиме, то есть, только с помощью данного интерфейса. Если формирование чека невозможно или в процессе формирования чека возникли ошибки, выводится сообщение
или в системном логе, который расположен от корня сайта тут:
/hostcmsfiles/logs/
4.2. Просмотр чеков
В таблице реестра чеков, «Ferma OFD.ru»
идентификаторы чеков представляют собой ссылки, по которым расположены изображения чеков; нажатие на ссылку приводит к загрузке страницы с изображением чека
в виде, как бы он при печати был изображен на бумаге. Обычно страница открывается в новой вкладке браузера.
История изменений
Версия 1.0
Выпущена 04 апреля 2019 г.
Первая версия документа.