Расширение “Ferma OFD.ru” для CMS “UmiCMS”

Введение

В документе приводятся технические сведения о плагине “Ferma OFD.ru”, предназначенном для CMS “UmiCms”. Модуль тестировался на версии 20 Модуль предназначен для взаимодействия информационной системы, использующей CMS “UmiCms” с информационными системами оператора фискальных данных “OFD.ru” для генерации фискальных документов с помощью интернет-касс и получения информации о сгенерированных фискальных документах.

1. Назначение расширения “Ferma OFD.ru”

Плагин “Ferma OFD.ru” для CMS “UmiCms” распространяется в виде файла, содержащего программное расширение, позволяющее CMS “UmiCms” взаимодействовать с информационными системами оператора фискальных данных “OFD.ru” с целью генерации чеков, загрузки чеков, а также просмотра реестра чеков и управления ими.

2. Основные принципы работы расширения

При смене статуса заказа клиента на статус, заданный в настройках формирования приходного чека (например, «Оплачено»), компонент «Ferma OFD.ru» автоматически создает в облачной кассе ОФД чек на получение денежных средств от покупателя.

3. Установка и настройка расширения

Расширение “Ferma OFD.ru” распространяется в виде модуля из каталога решений UMI.Market. Установка состоит из нескольких этапов:

1) Распаковать архив umicms.ofd_ferma.zip, закачать его в корень сайта
2) Перейти на страницу (см. рисунок 1).
Рисунок 1. Страница установки модулей
3) В появившемся окне выбрать ранее скачанный архив с модулем «cscart.ofd_ferma.zip» и нажать кнопку «Загрузить и установить» (см. рисунок 2).
Рисунок 2. Установка модуля
4) После того как наш модуль установился, обновим текущую страницу нажав на клавиатуре клавишу «F5».

3.1. Настройка плагина

Для настройки плагина в меню выберем «ОФД Ferma» (см. рисунок 3)

Рисунок 3. «ОФД Ferma»

После клика по названию модуля, у нас откроется окно настроек модуля (см. рисунок 4)

Рисунок 4. Страница настройки

С помощью пользовательского интерфейса в окне настроек, введите актуальные значения настроек плагина; назначение параметров описано в таблице 1.

После ввода значений в соответствующие поля нажмите кнопку «Сохранить»

Таблица 1. Настроечные параметры, необходимые для работы расширения «Ferma OFD.ru»

Параметр Описание
Логин Данные идентификации (имя пользователя) для синхронизации данных через API с облачной кассой ОФД
Пароль Данные аутентификации (пароль) для синхронизации данных через API с облачной кассой ОФД
ИНН ИНН лица, от имени которого генерируется кассовый документ (чек)
Адрес e-mail для уведомлений Адрес электронной почты управляющего. На этот адрес будут отправляться сообщения об ошибках в работе модуля
Система налогообложения Система налогообложения
Свёртка в одну строку Включение и выключение детализации в чеке всех товарных позиций: список товаров со стоимостями и общая сумма либо только общая сумма и текстовое название (например, «Пакет услуг», «Всего по чеку» и т. п.)
Свёртка в одну строку: Название в чеке Текстовое название в случае выключенной детализации товарных позиций в чеке (например, «Пакет услуг», «Всего по чеку» и т. п.)
Статус заказа, при котором отправлять чек Значение статуса заказа, при котором автоматически запускается процедура формирования чека, в соответствии с настройками, например для статуса «Оплачен»
НДС по умолчанию Вид вычисляемого налога на добавленную стоимость, значение вида НДС по умолчанию, необходимо заполнять в случаях, когда значение НДС не указано для выбранного в заказе товара

3.2. Добавление автоматического обновление статуса чека

Для автоматического обновления статуса, необходимо добавить задачу на проверку в Cron. Строка для cron'a:

GET <ваш домен>/cron.php?module=ofdFerma

или так:

/30 * * * * wget -q -O - <ваш домен>/cron.php?module=ofdFerma /dev/null 2>&1

Параметры уточните у вашего хостинг провайдера. Периодичность: 1 раз в 20 - 30 мин.

4. Использование расширения

В общем случае для создания товарного чека в облачной кассе ОФД не требуется никаких дополнительных действий: модуль в автоматическом режиме при смене статуса заказа, созданного клиентом в ИС интернет-магазина, на указанный в настройках создает чек на получение денежных средств от покупателя. Также чеки можно сформировать вручную из административной панели, в том числе чек на возврат сумм производится исключительно вручную, процедура описана в разделе 4.1.

В случае, если чек не сформирован по причине неправильного заполнения полей, то необходимо изменить их значения в заказе клиента или настройках и повторить попытку. Список уже сформированных чеков можно вызвать с помощью пункта меню: «ОФД Ferma» (см. рисунок 5).

Рисунок 5. Страница списка чеков

В списке чеков отображаются идентификаторы чеков в информационных системах “OFD.ru”, дата создания чека, сумма по чеку, тип чека (чек прихода или чек возврата), номер заказа (со ссылкой на страницу заказа), с которым связан чек и статус чека (например, «Чек передан в ОФД»).

Также имеется возможность фильтрации существующих чеков по периоду, типу или номеру заказа.

4.1. Создание чеков в ручном режиме

Чек можно создать и в ручном режиме для каждого заказа. Нажав в реестре чеков на номер заказа нужного чека, либо выбрав заказ из списка заказов магазина и перейти к редактированию (см. рисунок 6).

Рисунок 6. Страница редактирования чека

Из данного окна, можно «Сформировать чек прихода» или «Сформировать чек возврата» в ручном режиме.

Чек возврата формируется только в ручном режиме, то есть, только с помощью данного интерфейса. Если формирование чека невозможно или в процессе формирования чека возникли ошибки, она появится в начале страницы (см. рисунок 7).

Рисунок 7. Ошибка формирования чека возврата

4.2. Просмотр чеков

Выберите чек и нажмите на кнопку «Просмотреть чек» (см. рисунок 8) Нажатие на ссылку приводит к загрузке страницы с изображением чека (см. рисунок 9) в виде, как бы он при печати был изображен на бумаге. Обычно страница открывается в новой вкладке браузера.

Рисунок 8. Реестр чеков
Рисунок 9. Чек

История изменений

Версия 1.0

Выпущена 7 марта 2019 г.

Первая версия документа.