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

Введение

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

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

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

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

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

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

Расширение “Ferma OFD.ru” распространяется в виде плагина, который требуется загрузить в CMS “ Modx Revo” через «Управление приложениями и репозиториями».

Установка состоит из нескольких этапов:

1) Скачанный архив с модулем нужно поместить в директорию /core/packages
2) Перейти в Установщик, выбрав в меню «Приложения» -> «Установщик» (см. рисунок 1).
Рисунок 1. Пункт меню «Установщик»
3) В кнопке «Загрузить дополнения» выбрать «Искать пакеты локально» (см. рисунок 2).
Рисунок 2. Пункт «Искать пакеты локально»
4) В всплывающем окошке, нажать «да» (см. рисунок 3).
Рисунок 3. Всплывающее окно с подтверждением
5) Если все сделали верно, то в списке пакетов, появится наш пакет с модулем (см. рисунок 4).
Рисунок 4. Список пакетов
6) Установим наш модуль, нажав кнопку «установить».
7) Нажмем «продолжить» (см. рисунок 5).
Рисунок 5. Кнопка «продолжить»
8) После того как наш модуль установился, нажмем «ок» и обновим текущую страницу нажав на клавиатуре клавишу «F5» (см. рисунок 6).
Рисунок 6. Результат установки

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

Для настройки плагина выберем его в списке меню «Приложения» (см. рисунок 7). А после этого откроем «настройки» (см. рисунок 8).

Рисунок 7. «Ferma OFD.ru»
Рисунок 8. Настройка плагина «Ferma OFD.ru»

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

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

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

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

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

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

GET <ваш домен>/assets/components/modofdferma/cron.php

или так:

/30 * * * * wget -q -O - <ваш домен>>/assets/components/modofdferma/cron.php /dev/null 2>&1

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

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

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

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

Рисунок 9. Страница сформированных чеков

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

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

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

Чек можно создать и в ручном режиме для каждого заказа. Нажав в реестре чеков на номер заказа нужного чека, либо в процессе работы с других страниц CMS “Modx Revo” открыв нужный выбрав в меню «Приложения» - «Minishop2» (см. рисунок 10). И перейти в режим редактирования, необходимого заказа (см. рисунок 11). Из данного окна, можно «Сформировать чек прихода» или «Сформировать чек возврата» в ручном режиме (см. рисунок 12).

Рисунок 10. Создание чека в ручном режиме
Рисунок 11. Режим редактирования чека
Рисунок 12. «Сформировать чек прихода» и «Сформировать чек возврата»

Чек возврата формируется только в ручном режиме, то есть, только с помощью данного интерфейса. Если формирование чека невозможно или в процессе формирования чека возникли ошибки, сообщения в всплывающем окне (см. рисунок 13) или в журнале CMS Modx Revo - «Управление» - «Отчеты» - «Журнал ошибок».

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

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

В таблице реестра чеков (см. рисунок 14) идентификаторы чеков представляют собой ссылки, по которым расположены изображения чеков; нажатие на ссылку приводит к загрузке страницы с изображением чека (см. рисунок 15) в виде, как бы он при печати был изображен на бумаге. Обычно страница открывается в новой вкладке браузера..

Рисунок 14. Реестр чеков
Рисунок 15. Чек

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

Версия 1.0

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

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