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

Введение

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

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

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

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

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

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

Расширение “Ferma OFD.ru” распространяется в виде пакета, который требуется загрузить с помощью страницы «Модули / Расширения — Установка расширений» CMS “OpenCart” и далее установить в CMS “OpenCart”.

Для установки расширения необходимо загрузить страницу «Модули / Расширения — Установка расширений», выбрав соответствующие пункты иерархического меню, расположенного в левой части страницы (см. рисунок 1), затем нажать кнопку «Загрузить» в подразделе «Загрузите ваше расширение», после чего на экране отобразится типовое диалоговое окно открытия файла, в котором следует выбрать файл архива, содержащий устанавливаемое расширение, и подтвердить установку, нажав затем на кнопку «Открыть».

После выбора файла индикатор «Процесс», расположенный ниже на странице, начинает показывать долю загруженного объема расширения и по мере загрузки файла увеличивается от 0 до 100%.

Под индикатором «Процесс» расположена таблица, в которой перечислены последние расширения, добавленные в CMS “OpenCart”, после успешной загрузки файла и добавления пакета расширения в данной таблице появится строка с названием файла расширения, датой добавления данного расширения и кнопками выключения или удаления данного расширений (например, кнопка « Деактивировать»).

Далее необходимо перейти на страницу «Модули / Расширения — Модули / Расширения» (см. рисунок 2).

В выпадающем списке «Выберите тип расширения» необходимо выбрать строку «Модули», ниже отобразится список модулей в виде таблицы, в которой перечислены загруженные, установленные и запущенные модули, и для каждого модуля отображается статус («Включен», «Отключен», и т. п.) и кнопки действий, которые можно в текущий момент произвести над каждым модулем: « Редактировать», « Добавить» « Активировать», « Деактивировать», « Удалить».

В списке модулей следует найти название “Ferma OFD.ru”, и нажать на кнопку
« Добавить» в правой колонке — добавить модуль в систему; после этого нажать на кнопку
«Редактировать», чтобы перейти к интерфейсу ввода настроек (см. рисунок 3), далее необходимо ввести актуальные значения в настройках компонента (см. таблицу 1, рисунок 6).

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

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

Если после настроек модуль был запущен (параметру «Статус» присвоено значение «Включен»), то он начнет работать, и на странице «Модули / Расширения — Модули / Расширения» напротив названия “Ferma OFD.ru” отобразятся пиктограммы такие же, как на рисунке 2. Если же модуль запущен не был, необходимо на странице «Модули / Расширения — Модули / Расширения» напротив того же названия нажать кнопку « Активировать».

После вышеописанных действий модуль начинает работать в составе CMS “OpenCart”.

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

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

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

Обработка чека в облачной кассе происходит асинхронно и получить текущее состояние чека можно двумя способами — вручную (по запросу) и автоматическим (по расписанию). Для обновления состояния чека ручным способом необходимо установить флажок слева от каждого интересующего чека и нажать кнопку « Обновить». (см. рисунок 4). Такая же кнопка расположена в правой части строки таблицы со списком чеков (см. рисунок 4). Справа от кнопки обновления выбранных чеков расположена кнопка отмены операции по выбранным чекам — « Отменить».

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

Чек можно создать и в ручном режиме для каждого заказа. Нажав в реестре чеков на номер заказа нужного чека, либо в процессе работы с других страниц CMS “OpenCart” выбрав ссылку на страницу заказа, пользователь CMS “OpenCart” в окне будет наблюдать страницу заказа (см. рисунок 5).

В верхней части страницы присутствуют кнопки «Чек прихода (OFD.ru)» и «Чек возврата (OFD.ru)», нажатие на которые приводят к генерации соответственно чеков прихода или возврата по текущему заказу; генерация чеков будет производится только если статус заказа предполагает такую возможность. Как было указано выше, формирование чека на возврат возможно только в ручном режиме, то есть, только с помощью кнопки на данной странице.

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

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

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

Версия 1.0

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

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