Расширение “Ferma OFD.ru” для CMS “Drupal v8.0” с предустановленным модулем “Commerce” или “Ubercart”

Версия 1.0 от 30.10.2018 Открыть pdf-файл Модуль для CMS

Введение

В документе приводятся сведения об установке и эксплуатации модуля “Ferma OFD.ru”, для CMS “Drupal” версии 8.0 с дополнительными модулями “Commerce” или “Ubercart”. Модуль обеспечивает взаимодействие информационной системы (ИС) интернет-магазина, использующего CMS “Drupal”, с информационной системой “Ferma OFD.ru”.

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

Модуль “Ferma OFD.ru”, для CMS “Drupal” версии 8.0, реализует взаимодействие CMS “Drupal” с ИС оператора фискальных данных “OFD.ru” с целью генерации фискальных документов с помощью арендованных интернет-касс, их загрузки и просмотра их реестра. Существуют две версии модуля, которые используют различные расширения CMS “Drupal”: “Commerce” или “Ubercart”.

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

При смене статуса заказа клиента на статус, соответствующий факту успешной оплаты заказа, модуль автоматически создает в облачной кассе “OFD.ru” фискальный документ (чек, БСО) на получение денежных средств от покупателя. Также имеется возможность вручную сформировать документ на возврат средств покупателю.

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

Две версии модуля расширения (для “Drupal” с установленным “Commerce” и “Drupal” с “Ubercart”) распространяются в виде одного архивного файла с расширением “.zip”. Чтобы установить его, необходимо сначала скопировать архивный файл в каталог веб-сервера “drupal/www/sites/all/modules” с помощью системных инструментов сервера или подключенного компьютера администратора. Далее необходимо включить нужное расширение с помощью веб-интерфейса: загрузить начальную страницу CMS “Drupal” (см. рисунок 1), ввести имя и пароль администратора, а затем перейти на страницу «Расширения», выбрав соответствующий пункт меню вверху страницы (см. рисунок 2). В таблице необходимо найти строку “OFD.Ferma Commerce” или “OFD.Ferma Ubercart” (в зависимости от того, какой модуль функционирует) и левой кнопкой мыши установить флажок слева от названия. Таким образом, модуль установлен и включен.

Рисунок 1. Начальная страница CMS "Drupal" версии 8.0
Рисунок 2. Страница установки модулей

Для настройки плагина перейдите на страницу его параметров, выбрав в меню вверху страницы подменю «Конфигурация», затем на загруженной странице “OFD.Ferma Configuration” (см. рисунок 3, обведено красной рамкой); после выбора загрузится страница параметров плагина (см. рисунок 4).

Рисунок 3. Пункт меню “Настройки сервиса OFD.ru Ferma»

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

Рисунок 4. Страница настроек плагина “Ferma OFD.ru”

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

Параметр Описание
Login Данные идентификации (имя пользователя) для синхронизации данных через API с облачной кассой ОФД
Password Данные аутентификации (пароль) для синхронизации данных через API с облачной кассой ОФД
ИНН ИНН лица, от имени которого генерируется кассовый документ (чек)
Система налогообложения Система налогообложения
Ставка налога по умолчанию Вид вычисляемого налога на добавленную стоимость, значение вида НДС по умолчанию, необходимо заполнять в случаях, когда значение НДС не указано для выбранного в заказе товара
Окончательный статус чека Значение статуса чека, при котором операция (платеж, возврат, и т. п.) считается завершенной
Количество чеков в cron Число чеков, для которого будет обновлен статус за один запуск утилиты cron
Адрес электронной почты для отправки уведомлений об ошибках сервиса Адрес электронной почты управляющего. На этот адрес будут отправляться сообщения об ошибках в работе модуля
Пропустить проверку сертификата SSL В случае установленного флажка плагин не будет проверять наличие и подлинность SSL-сертификатов

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

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

В общем случае для создания фискального документа в облачной кассе “OFD.ru” не требуется никаких дополнительных действий: модуль в автоматическом режиме при оплате заказа создает документ (чек или БСО) на получение денежных средств от покупателя. Формирование кассовых документов вручную (в том числе и на возврат сумм) также возможно и описывается в п. 4.1.

Список уже сформированных документов можно вывести с помощью пунктов «Торговля» (для “Ubercart” — «Store») — «Чеки OFD.ru Ferma» меню в верхней части страницы (см. рисунок 5). В списке отображаются идентификаторы документов в ИС “OFD.ru”, дата создания, сумма, тип документа (чек прихода, чек возврата, БСО и т. д.), номер заказа (со ссылкой на страницу заказа), с которым связан документ, а также статус документа (например, «Чек сформирован на кассе», см. рисунок 6).

Рисунок 5. Вызов реестра (списка) чеков
Рисунок 6. Страница реестра чеков OFD.ru
Рисунок 7. Страница с подробными сведениями о платежах по заказу (Commerce)

4.1. Создание фискальных документов в ручном режиме

Фискальный документ можно создать в ручном режиме, обычно это необходимо если производится возврат денежных средств. Нажав в реестре чеков на номер заказа в столбце «ЗАКАЗ», пользователь перейдет к странице заказа (если установлен модуль “Commerce”, см. рисунок 7, если установлен модуль “Ubercart”, см. рисунок 8), далее следует выбрать вкладку «Платежи» (“Payments” для “Ubercart”).

Для формирования чека должна быть определена сумма по чеку, вид и параметры платежа, это вводится в верхней части страницы в форме, подобной показанной на рисунке 8 (форма вызывается по кнопке «+ Добавить платеж», см. рисунок 7) , далее нужно нажать кнопку «Сохранить» (“Record payment” для “Ubercart”). Далее, в нижней части страницы, в разделе «СОЗДАТЬ ЧЕК OFD.RU FERMA». Чтобы сформировать чек, нужно выбрать тип чека, ввести запрашиваемые параметры (адрес электронной почты и (или) телефонный номер покупателя) и нажать кнопку «Cоздать чек»; фискальный документ будет сгенерирован.

Рисунок 8. Страница с подробными сведениями о платежах по заказу (Ubercart)

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

В таблице реестра чеков (см. рисунок 6) имеется столбец «ПРОСМОТР ЧЕКА», в котором расположены ссылки загрузки чеков по каждому совершённому платежу. нажатие на ссылку приводит к загрузке страницы с изображением чека (см. рисунок 9) в виде, как бы он при печати был изображен на бумаге. Обычно страница открывается в новой вкладке браузера.

Рисунок 9. Чек при просмотре

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

Версия 1.0

Выпущена 30 октября 2018 г.

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