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

В API V9Preview1 класс CashCheque переименован в ShortenedChequeExtensions, чтобы устранить противоречия в семантике. Данный класс используется для расширения содержания документа и используется в callback-уведомлении CashChequePrinting.

В API V9Preview1 класс BillCheque переименован в ChequeExtensions, чтобы устранить противоречия в семантике. Данный класс применяется для расширения содержания документа и используется в callback-уведомлениях BillChequePrinting и DocumentInvoicePrinting.

В API V9Preview1 добавлена функциональность вставки XML разметки в отчет перед печатью, чтобы позволить плагинам расширять содержание печатаемого документа.

В SamplePlugin были обновлены методы AddProduct и AddCompoundItem, используемые для добавления в заказ обычных и составных блюд. Эти методы демонстрируют механизм добавления в заказ блюд, требующих указания некоторых полей (например обязательные модификаторы, размер) исключительно в рамках текущей сессии редактирования. Подробнее см. Редактирование данных.

В INotificationService добавлено уведомление BeforePaymentAdded. Уведомление вызывается перед добавлением платежа в заказ. Если один из подписавшихся плагинов бросит исключение OperationCanceledException добавление платежа будет отменено.

В класс ChequeSale добавлено свойство UzChequeSaleData типа UzChequeSaleData содержащий данные, необходимые для фискализации в Узбекистане.

В информацию о фискальном регистраторе ICashRegisterInfo добавлено свойство TaxCategoryToFiscalRegisterTaxItems список из ITaxCategoryToFiscalRegisterTaxItem. Представляет собой соответсвие налогового регистра ФР TaxId и id налоговой категории TaxCategoryId .

В интерфейс IChequeTaskProcessor добавлены методы BeforeOpenSession и BeforeOpenSession. Методы вызываются до открытия смены на Фискальном регистраторе и после, соответственно, для всех плагинов, реализующих интерфейс IChequeTaskProcessor. Если один из подписчиков бросает исключение, методы для других подписчиков не вызываются и вся операция открытия смены завершается с ошибкой.

В API V9Preview1 был расширен класс KitchenOrderDto с целью добиться наиболее точной настройки создаваемого кухонного заказа через API.

В API V8 появился новый метод GetDefaultCredentials() для получения учётных данных, связанных с новым пользователем (“Пользователь Front.Api”).

На данный момент есть возможность прервать оплату заказа плагинным типом путем выброса исключения в методе Pay и PaySilently.

В API V9Preview1 в класс CardPaymentItemAdditionalData добавлено новое nullable поле CustomData, ограниченное 5000 символов. Заполнение полей CardPaymentItemAdditionalData теперь происходит через конструктор с 2 аргументами:

В API V9Preview1 добавлена возможность добавлять кнопки на экран печати документов во фронте, чтобы плагины могли вызывать собственные окна.

Добавлен метод AddButtonToDocumentsScreen со следующими параметрами:

• caption — текст кнопки,
• iconGeometry — иконка в формате Path Markup (можно без иконки),
• callback — обработчик нажатия на кнопку, в котором можно показывать диалоговые окна и вносить изменения.

В API V9Preview1 был добавлен еще тип IDocument , который передает тип документа и номер, при нажатии на кнопку.

Вышел промежуточный релиз V9Preview1.

В Api V9Preview1 была добавлена возможность печатать товарный чек по PastOrder.

В Api V8Preview7 в PastOrder было добавлено поле WriteoffReason.

В Api V8 была добавлена новая нотификация PastOrderStorned, которая срабатывает после успешного сторнирования PastOrder.

В Api V8 в PastOrder было добавлено поле PublicExternalData.

В API V8 в PastOrder было добавлено поле OriginName.

В API V9Preview1 появилась возможность работать с заказом во время операции DoCheque, используя IOperationService.

В Api V8 для кухонных заказов была добавлена их ревизия - число, которое является номером последнего изменения заказа.

В Api V8 были расширены возможности задания внешней информации (ExternalData) для кухонного заказа. Теперь ее можно давать и для позиций заказа.

В Api V8 было добавлено две новые операции: GetOrderAllExternalData и GetKitchenOrderAllExternalData. Данные операции позволяют получить всю ExternalData у обычного и кухонного заказа соответственно.

В Api V8 были модифицированы методы GetPastOrdersBySum и GetPastOrders.

В API V8 добавлено событие об изменении произвольных данных плагинов CustomDataChanged.

В Api V9Preview1 были добавлены две новые операции - ComplexAddOrUpdateKitchenOrderAndItemsExternalData и ComplexDeleteKitchenOrderAndItemsExternalData.

В Api V8 добавлена возможность изменять комментарии у отпечатанных блюд.

В Api V8 был добавлен метод IsConnectedToMainTerminal для получения статуса подключения к Главному терминалу.

В API V9Preview1 для метода GetKitchenOrders добавлен опциональный параметр includeExternalData, что позволяет выгрузить внешние данные плагинов при получении кухонных заказов.

В API V9Preview1 добавлен метод TryGetKitchenOrderByOrder позволяющий вернуть кухонный заказ для обычного заказа. В случае, если кухонный заказ не был создан для этого заказа в данной группе, будет возвращено значение null.

Вместе с iikoRMS 8.7 выпущена версия API V8. Это LTS-версия, разработанные под V8 плагины будут поддерживаться всеми версиями iikoFront, которые будут выходить в следующие 4 года. Библиотека Resto.Front.Api.V8 доступна в виде NuGet-пакета, примеры использования здесь.

В интерфейсе IPaymentItem появилось свойство CurrencyInfo, которое позволяет хранить данные о дополнительной валюте платежа. Для поддержки использования дополнительных валют в платежах в методы AddPaymentItem, AddExternalPaymentItem, AddExternalFiscalizedPaymentItem была добавлена возможность задавать сумму в дополнительной валюте, а также указывать эту валюту через интерфейс IAdditionalCurrency. Кроме того, был добавлен метод получения списка валют с их текущими курсами GetCurrencyRates, а также список валют с курсами для определенного заказа GetCurrencyRatesForOrder.

В Api V8 была добавлена возможность получить ФИО пользователя, заданное в iikoOffice.

В Api V9Preview1 была добавлена возможность сбрасывать нумерацию заказов внутри группы через Api.

В API v8 в интерфейс IReserve добавлено свойство IsBanquet.

В API V9Preview1 у скидки появился признак, определяющий что скидка является лояльностью (скидкой по iikoCard или подобной) IDiscountType.IsCardLoyalty. Также теперь можно получить подробную информацию по скидкам лояльности через IOperationService.GetCardLoyaltyDiscounts. Информацию можно получить только для открытых заказов. После оплаты метод всегда будет возвращать пустую коллекцию.

Релиз версии API V6 состоялся осенью 2019 года. Позже, в январе 2022 года была выпущена версия V7, с тех пор V6 числится устаревшей. Прогресс не остановить, и уже начиная с зимы 2024 года станут выходить сборки iikoRMS с поддержкой V8, а это значит, что V7 станет устаревшей, а V6 перестанет поддерживаться (подробнее см. управление версиями).

В API V8 появился тип обслуживания группы ITerminalsGroup.ServiceMode. Тип обслуживания ServiceMode может быть фастфудом или рестораном.

В API V8 сделали второй шаг к возможности показывать диалоговые окна и навигироваться в заказ по инициативе плагина с разных экранов.

Теперь появилась возможность делать возврат заказов не только из UI iikoFront, но и из API V8Preview7. Для этого необходимо вызвать метод StornoOrder.

Начиная с API V8 мы переименовали параметр hasIikoCardDiscounts методов CreateOrder, CreateDeliveryOrder в hasFixedIikoCardDiscounts, а также добавили возможность изменять его.

Начиная с V8Preview7 в доставочный заказ IDeliveryOrder добавлены новые свойства, заполняющиеся при переносе доставки с точки на точку: идентификатор новой доставки, созданной для переноса текущей, и идентификатор группы новой доставки. Идентификатор старой доставки, из которой образовалась текущая доставка, и идентификатор группы старой доставки.

Вышел промежуточный релиз V8Preview7. Данный SDK поддерживается начиная с версии 8.6.5 и до версии 8.9.1. Подробнее о версиях API тут.

В API V8Preview7 была добавлена информация о том, был ли данный заказ удалён, сторнирован, информация о том, из какого заказа текущий был сторнирован, а также список заказов, которые входят в ту же группу, что и текущий заказ.

В API V8Preview7 стало еще удобнее анализировать ошибки оплаты.

В API V8Preview7 теперь можно подтверждать действия пользователям без ПИН-кода. Но для этого понадобится специальная лицензия.

В API V8Preview7 был добавлен метод CreateKitchenOrder, который позволяет создать кухонный заказ через API.

В API V8Preview7 был добавлен новый метод GetPrintingDeviceInfos, который возвращает список из объектов с интерфейсом PrintingDeviceInfo.

Начиная с API V8PreviewV7 появилась возможность работать с произвольными данными. Эти данные являются оперативными и синхронизируемыми между терминалами для плагинов с конкретным moduleId.

Начиная с API V8PreviewV7:

1. Метод получения всех пользователей IOperationService.GetUsers по умолчанию возвращает только сотрудников текущего предприятия. Чтобы получить всех пользователей iikoChain нужно передать параметр fromAllDepartments = true.
2. Добавлено свойство IUser.AssignedToCurrentDepartment — свойство “принадлежит ли пользователей текущему предприятию”.

Начиная с API V8PreviewV7 появилась возможность возвращать проведенные платежи и предоплаты методом IOperationService.UnprocessPayment. Это может потребоваться для сценариев, когда оплата была начата, но не был распечатан фискальный чек. Или когда оплату проводили методом IOperationService.ProcessPrepay ранее, но теперь её требуется вернуть.

Начиная с V8Preview5 можно упростить заполнение полей при редактировании данных организации. Пользователю будет достаточно ввести только ИНН, а далее плагин выполнит поиск во внешней системе и iikoFront заполнит остальные реквизиты компании.

Вышел промежуточный релиз V8Preview6.

В API v8 в интерфейс IProduct добавлено свойство ItemCategory - признак предмета расчета.

В API V8Preview7 для унификации с OperationServiceExtensions, где параметр типа ICredentials является последним из параметров без значения по умолчанию, и у методов интерфейса IOperationService теперь данный параметр передается последним.

Начиная с API V8PreviewV6:

1. Добавлен параметр IProductSize size со значением по умолчанию null в метод AddOrderCombo.
2. Добавлено свойство размера комбо-блюда: IOrderCombo.Size.
3. Добавлен метод для редактирования размера у комбо-блюда: ChangeComboSize

В API V8Preview6 в новости был описан новый список RemovedItems.

В Api V8Preview6 для кухонных заказов была добавлена формировать дозаказ для кухонных заказов.

Начиная с версии API V8Preview4, в заказ добавлено новое свойство IOrder.ExternalNumber, в котором хранится номер заказа во внешней системе. Изменить значение данного свойства можно при помощи нового метода IEditSession.ChangeOrderExternalNumber.

В API V8Preview6 добавлена возможность получения дополнительных свойств с помощью IOperationService.GetCashRegisterStatus.

В Api V8Preview6 для кухонных заказов была добавлена возможность задавать публичность данных для ExternalData.

В кухонном заказе версии API V8Preview6 появилась возможность узнать подробности о модификаторах, которые должны быть скрыты, и об удаленных модификаторах, которые были бы скрыты, будь они в составе блюда.

В API V8Preview6 в информацию о заказе был добавлен список RemovedItems. Данный список содержит список блюд, которые были удалены из заказа без печати. Для данных блюд был выставлен в API интерфейс IRemovedOrderItem.

В API V8Preview6 в IKitchenOrder было выставлено свойство ExternalNumber, которое представляет собой номер заказа во внешней системе.

В API V8Preview6 для метода ChangeSelectiveDiscount была добавлена перегрузка. Данная перегрузка позволяет передавать список пар, состоящих из Id элементов заказа и соответствующих им размеров скидок, которые нужно им присвоить.

В API V8Preview6 добавлены методы для работы непостредственно с ФР

Вышла очередная версия iikoRms 8.4, а вместе с ней и промежуточный релиз V8Preview5. Эта версия будет поддерживаться в 8.4 и 8.5.

В Api V8 появилась возможность добавить в стоп-лист блюдо только в одном размере или без указания размера AddProductToStopList.

В Api V8Preview6 добавлено свойство IUser.PublicExternalData. Эти данные не задаются с UI в RMS. Предполагается, что они назначаются под бизнес-задачи конкретного клиента. Эти данные запишутся напрямую в RMS-объект user через API сервера или через спец.плагины iikoWeb.

В Api V8 в добавлен метод получения суммы наличных в кассе для ICafeSession текущего терминала методом GetHostTerminalCafeSessionCashSum.

В Api V8 в ICafeSession было выставлено свойство ResponsibleManager, которое показывает, какой пользователь открыл выбранный сеанс работы ресторана.

В Api V8 в IKitchenOrder было выставлено свойство OriginName, которое представляет собой название внешнего источника заказа.

В Api V8 был добавлен метод GetHostTerminalRestaurantSections который возвращает список отделений ресторана, к которым относится данный терминал.

В Api V8 была добавлена возможность записывать ExternalData для кухонных заказов. Это позволит хранить и передавать необходимую дополнительную информацию, связанную с заказом.

Уведомление о печати чека при оплате CashChequePrinting, позволяющее расширить разметку чека в шапке и подвале, начиная с версии iikoFront 8.5.1 будет генерироваться также и при сторнировании (возврате) заказа.

В API V8 в класс CashRegisterResult добавлены свойства FnSerialNumber и DocumentSign, содержащие номер ФН и фискальный признак документа (ФПД).

Теперь появилась возможность делать возврат товаров или заказов закрытых кассовых смен не только из UI iikoFront, но и из API V8.

В API V8 были выставлены пользовательские свойства для продуктов IProduct.ProductTags, а так же появилась возможность получить все пользовательские свойства и их группы с помощью вызовов GetProductTags и GetProductTagGroups соответственно.

В API V8 в метод CreateOrder добавлено необязательное поле hasIikoCardDiscounts, которое является признаком того, что у заказа есть предрассчитанные скидки iikoCard. Значение по умолчанию - false.

В API V8Preview4 был добавлен метод ChangeOrderItemsCookingPlace, с помощью которого можно менять место приготовления у неотпечатанных блюд.

В API V8Preview2 появилась возможность узнать адрес соседнего терминала.

В API V8Preview4 была расширена возможность получения информации о закрытых заказах.

В API V8Preview4 появилась возможность редактировать заказ непосредственно перед печатью сервисного чека.

В API V8 в методы CreateReserve и CreateBanquet добавлено поле ActivityType, которое позволяет задать описание типа предстоящего события в свободной форме, например, “Свадьба”, “День рождения” и т.д.

В API V8 добавлено свойство FastCode для IProductGroup, которое позволяет осуществить сортировку по существующему полю “Код быстрого набора в iikoFront” для групп товаров по аналогии с товарами.

Добавлена возможность получения настроек, связанных с весовыми товарами.

В API V8 добавлен метод MarkOrderAsAdditional , который позволяет назначить заказ current дозаказом к заказу parent. Свойство GroupOrderId заказа current устанавливается равным свойству Id заказа parent, или равным null если parent == null.

В iikoFront версии 8.4.4 и выше появилась возможность закрывать заказ, содержащий в себе оплату типом “Без выручки”, дистанционно с помощью метода PayOrder.

Ранее из API заказ можно было оплачивать только на главном терминале. При этом главный терминал должен был быть кассовым (с подключенным фискальным регистратором). В одной из предыдущих версий мы сделали попытку избавиться от термина “Главная касса”, отвязав главный терминал от точки продаж и, как следствие, от фискального регистратора. В API V8 сделали следующий шаг, разрешив оплату заказа на локальном терминале.

В API V8 сделали первый шаг к возможности навигироваться между экранами iikoFront по инициативе плагина. Пока поддерживается только навигация в заказ по плагинным кнопкам или с экрана редактирования заказа.

В API V8 стало возможным переопределять тексты «Да», «Нет», «OK», «Отмена», «Закрыть», «Повторить», «Продолжить» на кнопках стандартных диалогов.

Начиная с API V8 появилась возможность получить принтер блюд.

Вышла очередная версия iikoRms 8.3, а вместе с ней и промежуточный релиз V8Preview4. Эта версия будет поддерживаться в 8.3 и 8.4.

В API V8Preview3 добавлен опциональный IOrder.ParentOrderId для возможности обращения к “исходному заказу” для сценариев, когда новый заказ появился в результате разделения заказа или переноса гостя из исходного заказа в новый.

В API V8 стало возможным отличать заказ, созданный в режиме быстрого чека, от заказа на столик. А также создавать тот или иной заказ или конвертировать их.

В API V8 появилась возможность различать скидочные оплаты.

Начиная с API V8 появилась возможность прерывать оплату / сторнирование заказа, внесение / возврат предоплаты.

Вышла очередная версия iikoRms 8.2, а вместе с ней и промежуточный релиз V8Preview3. Эта версия будет поддерживаться в 8.2 и 8.3.

В API V8Preview4 были добавлены новые свойства для валюты: ICurrencySettings

• IsoName
• ShortNameForGui
• ShortName
• CentName
• Code

В V8Preview2 добавлено понятие связанной с доставкой поездки (Ride), а также несколько методов по работе с новой сущностью.

В API V8Preview2 появилась возможность работать с бригадами официантов.

В API V8Preview2 появилась возможность получать налоговые ставки и коды товаров.

Вышла очередная версия iikoRms 8.1, а вместе с ней и промежуточный релиз V8Preview2. Эта версия будет поддерживаться в 8.1 и 8.2.

Вышла очередная версия iikoRms 8.0, а вместе с ней и промежуточный релиз V8Preview1. Эта версия будет поддерживаться в 8.0 и 8.1.

В API V8Preview1 для типа оплаты добавлено новое свойство IPaymentType.IsDiscount, которое показывает, является ли тип оплаты скидочным, т.е. проводящимся как скидка.

При попытке удаления внешней оплаты вызывается метод OnPaymentDeleting у соответствующего IPaymentProcessor.

Вместе с iikoRMS 7.9 выпущена версия API V7. Это LTS-версия, разработанные под V7 плагины будут поддерживаться всеми версиями iikoFront, которые будут выходить в следующие 4 года. Библиотека Resto.Front.Api.V7 доступна в виде NuGet-пакета, примеры использования здесь.

В API V7 для ресторана появилась возможность настроить способ отображения количества групповых модификаторов блюда. Добавлено новое свойство bool IRestaurant.DisplayRelativeNumberOfModifiers, обозначающее, что в случае false количество модификатора блюда должно отображаться в виде абсолютного количества (как было ранее), а в случае true как разница между абсолютным количеством модификатора и его количеством по умолчанию.

Начиная с API V8Preview1 появилась возможность закрыть доставку прямо из плагина.

В API V8 в интерфейс IPaymentType добавлено новое свойство IPaymentType.PrintCheque, которое показывает, является тип оплаты фискальным или нет.

В API V7 метод GetPaymentSystemName переименован в GetPaymentSystemKey, чтобы устранить противорчения в семантике. Данный метод возвращает ключ IPaymentProcessor.PaymentSystemKey, с которым платежная система регистрируется в iiko.

В API V7 добавлен новый метод IViewManager.ShowExtendedKeyboardDialog, который поддерживает следующие типы ввода:

• произвольная строка.
• скрытая строка, например ввод пароля.
• считывание штрихкода.
• считывание карты.

В API V7 добавлены механизмы работы с штрихкодами продуктов. Теперь можно найти продукт по штрихкоду с помощью метода IOperationService.GetProductByBarcode.
Также можно получить список всех штрихкодов, которые используются продуктом. Для этого в интерфейс IProduct добавлен список фасовок IProduct.BarcodeContainers, из которых можно узнать штрихкоды с помощью свойства IBarcodeContainer.Barcode.

Начиная с API V7, при старте приложения плагины будут автоматически получать языковые настройки из настроек терминала. Также, для отслеживания переключения языка на запущенном терминале, добавлено событие INotificationService.CurrentCultureChanged.

В API V7 добавлено новое свойство, CashRegisterDriverParameters.PrintDatailedChequeWithPrepay, говорящее о том, нужно ли печатать полный чек предоплаты.

Новое свойство LastChangedTerminalId добавлено в заказ (IOrder.LastChangedTerminalId) и в резерв (IReserve.LastChangedTerminalId), оно позволяет определить, на каком терминале было сохранено текущее состояние этих объектов.

В интерфейс ITable добавлено свойство RestaurantSection, возвращающее ссылку на отделение ресторана.

Функции открытия и закрытия личных смен были добавлены ранее, но они позволяли управлять личной сменой лишь того пользователя, от имени которого, авторизовавшись по пин-коду, действует плагин. Теперь можно управлять личными сменами и других пользователей тоже.

В iikoFront версии 7.8.6 и выше появилась возможность закрывать заказ, содержащий в себе оплату типом iikoCard5, дистанционно с помощью метода PayOrder.

В API V7 появилась возможность получить разметку некоторых фронтовых отчётов GetReportMarkupById.

В версии API V7 мы добавили уведомление об удалении неотпечатанных блюд BeforeDeleteNonPrintedItems, а также пробросили текущего пользователя, ответственного за выполняемую операцию, в некоторые события.

В версии API V7 появились новые свойства у объекта IRestaurant.

В версии API V7 мы внесли изменения в методы получения списка заказов, доставок, резервов и банкетов. В том числе в методы получения данных сущностей по известной ревизии.

В iikoFront версии 7.8.6 и выше добавлен функционал печати сервисного чека в зависимости от настройки опции “Автоматическая сервисная печать”. Печать может быть отключена или производится либо при, либо после оплаты заказа. Никаких дополнительных шагов для включения данного функционала предпринимать не требуется.

В API V7 появилась возможность показать окна запроса даты и времени (см. статью «Окна запроса даты и времени»).

В API V7 вместо операции IOperationService.GetOrderAppliedDiscounts (см. статью) было добавлено свойство заказа IOrder.AppliedDiscounts

Начиная с API V7 iikoFront API собраны под .NET Standard 2.0.

В API V7 добавлен метод ResetOderLastChangeTimeByWaiter(), позволяющий сбросить время последнего редактирования заказа официантом, позволяя тем самым снять с заказа проблему «Официант не подходил к столу более N минут».

В API V7 добавлены методы для проверки прав пользователя (CheckPermission, CheckPermissions) и методы для запроса прав (ShowCheckPermissionPopup, ShowCheckPermissionsPopup) (см. статью «Проверка и запрос прав»).

В API V7 добавлен метод AddButtonToPaymentScreen, который позволяет добавить на экран кассы свою операцию (см. статью «Экран кассы»).

Релиз версии API V5 состоялся осенью 2017 года. Спустя два года, осенью 2019 года была выпущена версия V6, с тех пор V5 числится устаревшей. Прогресс не остановить, и уже начиная с осени 2021 года станут выходить сборки iikoRMS с поддержкой V7, а это значит, что V6 станет устаревшей, а V5 перестанет поддерживаться (подробнее см. управление версиями).

Вышла очередная версия iikoRms 7.7, а вместе с ней и промежуточный релиз V7Preview7. Эта версия будет поддерживаться в 7.7 и 7.8.

В версии API V7Preview7 уведомление об операции пречека заказа BeforeOrderBill будет генерироваться и при повторном пречеке.

В версии API V7Preview6 было добавлено новое окно для удобства работы с количеством какой-то группы элементов IViewManager.ShowQuantityChangerPopup.

В версии API V7Preview6 для группы продуктов появилась возможность узнать её артикул IProductGroup.Number. Ранее артикул был доступен только для продукта IProduct.Number.

В iikoFront версии 7.7.5 и выше появилась возможность открывать (OpenCafeSession) и закрывать (CloseCafeSession) кассовую смену любых фискальных регистраторов на любом кассовом терминале. Раньше же такая возможность поддерживалась только для виртуальных фискальных регистраторов на главном кассовом терминале.

В API V7Preview7 в заказ добавлено поле Comment, для изменения значения используется метод IEditSession.ChangeOrderComment.

В API V7 для операции ChangeClientBlacklistInfo добавлена проверка права D_AHR: Добавлять гостя в список «Высокий риск».

Вышла очередная версия iikoRms 7.6, а вместе с ней и промежуточный релиз V7Preview6. Эта версия будет поддерживаться в 7.6 и 7.7.

В API V7 добавлен новый метод, IOperationService.RegisterCustomRoundingHandler, позволяющий регистрировать обработчик применения округления к заказу во фронте.

Начиная с версии API V7Preview6 появится возможность располагать простые и групповые модификаторы блюда в том же порядке, как это сделано в BackOffice.

В API V7 добавлен признак, позволяющий отличить округление от обычной скидки. Если скидка IAppliedDiscountItem.IsRounding == true, значит это служебная скидка для округления заказа.

Вышла очередная версия iikoRms 7.5, а вместе с ней и промежуточный релиз V7Preview5. Эта версия будет поддерживаться в 7.5 и 7.6.

В API V7 в PermissionDeniedException добавлены коды прав и их локализованное наименование для тех прав, проверка которых не прошла.

Теперь, начиная с версии API V7Preview5, в заказ можно добавлять несколько предварительных и внешних оплат одним и тем же типом банковских карт.

В iikoRms 7.5 изменился способ настройки главного терминала в группе, поэтому в API начиная с V7Preview5 главный терминал можно получить напрямую из группы, а не вычислять через точки продаж как раньше.

Начиная с API V7Preview5 появилась возможность оплачивать доставочный заказ прямо из плагина, не входя на экран кассы.

Начиная с API V7Preview5 появилась возможность редактировать заказ непосредственно перед пречеком.

Начиная с API V7Preview5 появилась возможность запрещать переход на экран кассы.

В V7Preview5 в метод ReturnPaymentWithoutOrder был добавлен новый аргумент Nullable<Guid> orderId.

В V7Preview5 в методах Pay и PaySilently заменили несколько аргументов.

Начиная с V7Preview5 с помощью метода CallExternalOperation плагин может вызвать операцию, реализованную другим плагином на другом терминале.

Начиная с V7Preview5 у плагина будет возможность добавить собственную кнопку в нижнюю панель экрана редактирования заказа (кроме доставок).

В недавнем релизе iikoFront 7.4.6 появилась возможность закрывать заказы с оплатами, поддерживающими тихое проведение (silent-оплаты), прямо из API, не входя на экран кассы. Данный функционал поддерживается в указанной версии iikoFront на всех доступных версиях API: V5, V6, V7Preview3, V7Preview4, V7.

В V7Preview4 стало возможным работать с платежами, фискализованными на внешней кассе. Они актуальны, когда предоплата принимается на сайте, и фискальный чек печатается на облачном принтере сайта. При проведении такой оплаты в iikoFront создадутся все транзакции, соответствующие проведению внешнего фискального платежа, но фискального чека напечатано не будет, т.к. чек уже был отпечатан ранее на внешней кассе.

Начиная с V7Preview5 плагин может редактировать через API текущий заказ, не получая EntityAlreadyInUseException :-)

Вышла очередная версия iikoRms 7.4, а вместе с ней и промежуточный релиз V7Preview4. Эта версия будет поддерживаться в 7.4 и 7.5.

По мотивам заявки #143. В V7Preview4 появилась возможность получить список всех групп, а также список отделений любой, не только текущей, группы.

В V7Preview4 мы добавили больше разных экранов в событие ScreenChanged. Актуальный список поддерживаемых экранов здесь.

Начиная с V7 в доставке IDeliveryOrder появляется новое поле IDeliveryOrder.ExternalCourierServiceData, а также методы для назначения внешней курьерской службы PluginContext.Operations.ChangeDeliveryExternalCourierService и внешнего курьера PluginContext.Operations.ChangeDeliveryExternalCourier.

По мотивам заявки #146. В V7Preview4 в группу ITerminalsGroup добавлено новое свойство — стол по умолчанию ITerminalsGroup.DefaultTable, позволяющее узнать указанный в настройках iikoOffice стол по умолчанию для группы.

В V7Preview4 мы переименовали событие возврата заказа в OrderStorned, добавив в него новый аргумент Guid newOrderId — идентификатор нового заказа, который является копией возвращённого, и с которым будет происходить дальнейшая работа. В сам же заказ добавили новое поле StornedOrderId — идентификатор того самого возвращённого заказа, с которого текущий заказ был скопирован во время операции возврата (сторнирования). Данное поле не заполняется, если заказ не был возвращён.

Начиная с V7Preview4 плагин может обрабатывать события прокатки карты или сканирования штрихкода на экране редактирования заказа. Это может быть использовано, например, для интеграции с внешней системой лояльности.

С версии V7Preview4 можно будет указать и получить произвольное название для позиции заказа, в которой есть ссылка на IProduct.

С версии V7Preview4 можно будет указать способ отправки чека для методов оплаты заказа: PayOrder и PayOrderAndPayOutOnUser.

С версии V7Preview4 можно будет подписаться на уведомление о смене текущего пользователя на iikoFront: CurrentUserChanged.

Вышла очередная версия iikoRms 7.3, а вместе с ней и промежуточный релиз V7Preview3. Эта версия будет поддерживаться в 7.3 и 7.4.

В V7Preview4 пользователю IUser добавлено свойство IUser.Type, позволяющее определить тип контрагента UserType, указанный в персональной карточке в iikoOffice:

В V7Preview4 для блюд и модификаторов в кухонном заказе добавлены ссылки на соответствующие блюда и модификаторы в исходном заказе.

В V7Preview3 добавлены методы для показа сообщений со следующими сочетаниями кнопок: Close, Ok/Cancel, Retry/Cancel, Yes/No/Cancel и Retry/Ignore/Cancel. Полный список здесь.

Начиная с V7Preview3 появляется возможность подготовить доставку к отправке, напечатать накладную, назначить курьера и отправить его в путь.

Промежуточный релиз V7Preview2 выпущен вместе с iikoRms 7.3.5. Эта версия будет поддерживаться в 7.3.

Начиная с V7Preview2 добавлено уведомление UserSessionChanged, с помощью которого удобно отслеживать изменение свойства IUser.IsSessionOpen.

Начиная с API v7 появилась возможность получить список аллергенов списка продуктов или позиции заказа.

Начиная с V7 добавлена возможность создать доставку без клиента.

Вышла очередная версия iikoRms 7.1, а вместе с ней и промежуточный релиз V7Preview1. Эта версия будет поддерживаться в версиях 7.1 и 7.2.

Начиная с V7 личными сменами можно управлять через API, что позволит пользователям открывать личные смены и переключать роли прямо с мобильных терминалов.

Начиная с версии iikoRms 7.1.3 в режиме фастфуда появилась возможность помечать заказ как таб, дав ему особенное запоминающееся название. В связи с этим в API V7 добавлен функционал, позволяющий работать с табами.

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

Начиная с V7 появится возможность узнать список доступных модификаторов с учётом ценовых категорий для блюда со схемой модификаторов и без. Это позволит отображать состав модификаторов в меню в заведениях, работающих с ценовыми категориями и приказами об изменении прейскуранта, когда тот или иной модификатор в составе блюда может быть доступен или недоступен в зависимости от назначенной заказу или отделению ценовой категории.

В репозитории API SDK появились ещё три примера плагинов: экран покупателя, весы и фискальный регистратор.

Начиная с V7 для продукта IProduct доступно свойство ImmediateCookingStart, показывающее, следует ли запускать услугу или начинать приготовление блюда сразу после добавления в заказ.

Начиная с V7 методы CreateReserve, CreateBanquet и их перегрузки позволяют задать внешний идентификатор (ExternalId) для создаваемого объекта (IReserve). Такой идентификатор удобен для синхронизации со внешней системой. Получить резерв по его внешнему идентификатору можно с помощью метода TryGetReserveByExternalId.

Начиная с V7 появится возможность переключать статусы блюд кухонных заказов. Это позволит реализовать интерактивный кухонный экран (KDS), либо альтернативное управление штатным кухонным экраном (например, голосовое — «окей, айка, пельмени для десятого заказа приготовлены»), либо автоматически переключать статусы блюд по некоему внешнему алгоритму.

Начиная с V7 при навигации на экран оплаты можно будет указать способ формирования чека в соответствии с ФЗ-54 (актуально только для России).

Начиная с iikoRms 7.1.4 обработчик IExternalPaymentProcessor.OnPaymentAdded будет видеть заказ с учётом скидки, привязанной к типу оплаты.

Начиная с V7 графическая схема отделения (ISectionSchema) становится дочерним объектом отделения (IRestaurantSection). При изменении схемы будет сгенерировано общее уведомление RestaurantSectionChanged. Получить схему для отделения, как и прежде, можно с помощью метода restaurantSection.TryGetSectionSchema(). Удалены отдельные методы GetSectionSchemas, GetSectionSchemaById и т. п.

В PluginContext.Operations есть методы для получения связанных объектов — например, получить родительскую группу продукта можно с помощью PluginContext.Operations.TryGetParentByProduct(product). Для удобства вызова эти методы имеют парные extension-методы ко входным аргументам (например, product.TryGetParent(PluginContext.Operations)). Начиная с V7 такой вызов становится проще, не надо указывать PluginContext.Operations: product.TryGetParent().

Вместе с iikoRMS 7.0 выпущена версия API V6. Это LTS-версия, разработанные под V6 плагины будут поддерживаться всеми версиями iikoFront, которые будут выходить в следующие 4 года. Библиотека Resto.Front.Api.V6 доступна в виде NuGet-пакета, примеры использования здесь.

В API V6 добавлен метод (IOperationService.GetTerminalDeliveryDuration()), который позволяет получить данные о продолжительности доставки, установленной на доставочном терминале: продолжительность доставки курьером и продолжительность доставки самовывозом.

В связи с появлением короткоживующих preview-версий и необходимостью частого перехода между ними решено убрать номер версии из пространства имён (namespaces). Сам файл с контрактами будет по-прежнему иметь имя вида Resto.Front.Api.Vx.dll, но все типы внутри будут расположены в пространстве имён Resto.Front.Api, поэтому вместо using Resto.Front.Api.Vx; теперь надо писать using Resto.Front.Api;.

Начиная с V6 появится возможность удалять из заказа чаевые или другие виды пожертвований.

Добавлена возможность превращать предварительный платеж в предоплату по инициативе плагина, с помощью метода IOperationService.ProcessPrepay. Для этого потребуется, чтобы платеж был проведенным вовне, либо поддерживал Silent-оплату. Подробнее см. в статье Оплатные действия.

К методам AddOrderExternalData и TryGetOrderExternalDataByKey, позволявшим сохранять произвольные данные в составе заказа и, соответственно, считывать их оттуда, добавили метод DeleteOrderExternalData, позволяющий удалить из заказа ставшие ненужными внешние данные.

Начиная с V6 клиенты (IClient) и дисконтные карты (IDiscountCard) создаются и редактируются по-отдельности. Для дисконтных карт стало доступно имя владельца (OwnerName).

Помимо больших LTS-версий теперь ежеквартально будут выпускаться промежуточные preview-версии. Вместе с iikoRMS 6.4 выходит V6Preview5.

Начиная с V6/V6Preview5 доступна детализация скидок по блюдам. Метод GetOrderAppliedDiscounts возвращает результаты применения скидок (AppliedDiscountItem), где для каждой скидки можно получить как сумму данной скидки по всему заказу (DiscountSum), так и разбивку по элементам заказа (DiscountSumByOrderItemId). Общее описание скидок и надбавок в отдельной статье.

В PluginContext.Operations добавлен метод SearchDiscountCardByNumber, позволяющий получить дисконтную карту по её номеру. Кроме того, для дисконтных карт теперь доступна информация о привязке к ценовой категории (PriceCategory).

Начиная с V6/V6Preview5 появится возможность добавлять в заказ чаевые или другие виды пожертвований.

Начиная с V6 появится возможность перенести заказ на другой стол.

Начиная с V6/V6Preview5 появилась возможность работать с повременными услугами. Можно узнать тарифную сетку, настройки учёта времени, запустить или остановить услугу, а также задать лимит для автоматической остановки. Детали в отдельной статье.

Начиная с V6 появится возможность изменить ценовую категорию заказа.

Начиная с V6/V6Preview5 объект типа IProgressBar замещается методом IViewManager.ChangeProgressBarMessage(string message).

Релиз версии API V4 состоялся осенью 2015 года. Спустя два года, осенью 2017 года была выпущена версия V5, с тех пор V4 числится устаревшей. Прогресс не остановить, и уже начиная с осени 2019 года станут выходить сборки iikoRMS с поддержкой V6, а это значит, что V5 станет устаревшей, а V4 перестанет поддерживаться (подробнее см. управление версиями).

Начиная с V6/V6Preview5 стали доступны цвет текста, цвет фона и фоновое изображение для продуктов (IProduct) и групп продуктов (IProductGroup), что позволит показывать на мобильных терминалах и веб-сайтах удобное цветное меню как в приложении iikoFront.

Начиная с V6/V6Preview4 добавлена возможность создавать внешние события для журнала событий. Добавлены методы:

Начиная с V6 в папке плагина должен быть файл Manifest.xml, в котором указаны имя файла плагина, имя класса плагина, используемая плагином версия API и прочие параметры, которые раньше указывались с помощью атрибутов на классе плагина. Для V4 и V5 наличие манифеста не требуется, поддерживается прежний вариант с атрибутами, но при наличии манифеста будет использоваться манифест. Подробнее в статье о структуре папок.

Начиная с V6/V6Preview5 добавлен метод IOperationService.GetLastChangedOrderTerminal(IOrder order), который возвращает IHostTerminal.

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

Начиная с V6 появится возможность изменить тип заказа доставки.

В интерфейс IReserve добавлено новое поле CancelReason, содержащее причину отмены резерва ReserveCancelReason (ClientNotAppeared, ClientRefused, Other), либо null, если резерв не отменён.

В API V6 добавлен метод IOperationService.RegisterChequeTaskProcessor(), который позволяет регистрировать свою расширенную версию выполнения операций фискального регистратора (см. статью API расширение функционала фискального регистратора).

В API V6 добавлен метод IOperationService.GetCafeSessionByCashRegister(), который позволяет по кассовому регистратору (ICashRegister) получить данные о текущей открытой кассовой смене: её номер и время открытия.

Начиная с версии iiko 6.4 в API V6 добавлена возможность явно указывать, куда будет печататься чек типа «Счёт‎».

В API V6 добавлен метод AddButtonOnClosedOrderView(), который позволяет добавить на экран закрытого заказа текущей кассовой смены свою операцию (см. статью «Экран закрытого заказа»).

В CashRegisterDriverParameters добавлено свойство IsRegisterStatusSupported. Если задать IsRegisterStatusSupported = true, то iikoFront будет периодически вызывать ICashRegister.GetCashRegisterStatus() с полями SessionStatus и RestaurantMode. Результаты вызова демонстрироваться в трее iikoFront.

В метод PrintBillCheque добавлен необязательный параметр printerSelectionMode, влияющий на выбор принтера. Это позволит плагину выбирать, печатать ли пречек на принтере отделения, где расположен заказ, или на принтере локального терминала.

Начиная с версии iiko 6.4 в API V6 в уведомления о печати сервисного чека (INotificationService.SubscribeOnBeforeServiceCheque и NotificationServiceExtensions.SubscribeOnBeforeServiceCheque) добавлен список печатаемых блюд (IOrderCookingItem).

В IViewManager добавлены функции ShowOkPopup и ShowErrorPopup, которые позволят во время выполнения модальных операций выводить на экран позитивные сообщения (с кнопкой «ОК») и сообщения об ошибках (с кнопкой «Закрыть»).

Начиная с версии iiko 6.3 в API V6 в callback INotificationService.SubscribeOnBeforeDeletePrintedItem и NotificationServiceExtensions.SubscribeOnBeforeDeletePrintedItem добавились новые параметры.

Для модификаторов добавлен признак IsSeparate, готовятся ли они отдельно от своих блюд, а также ссылка Kitchen на отделение, в котором готовится модификатор. Последнее особенно интересно как раз для отдельно готовящихся модификаторов, ибо если модификатор готовится вместе с блюдом, то место приготовления можно было получить из блюда (Kitchen).

В IOperationService добавлен метод ExecuteContinuousOperation, позволяющий последовательно выполнить несколько операций редактирования так, чтобы между ними не могли вклиниться чужие операции, которые могли бы спровоцировать EntityAlreadyInUseException или EntityModifiedException. Подробнее в статье про редактирование данных

Добавлена функция поиска улиц по названию или внешнему ключу (ExternalId) с возможностью ограничить область поиска конкретным городом или списком городов.

Resto.Front.Api.SamplePlugin теперь доступен онлайн. Вводная информация по созданию плагинов доступна в разделе «Введение».

Начиная с версии 6.3, добавлена возможность передавать дополнительные атрибуты чека при проведении внешней предоплаты.

Полный список публичных типов вместе с их методами, аргументами и прочей информацией коду вместе с краткими комментариями на англ. языке теперь доступен онлайн.

Входящая в состав SDK библиотека Resto.Front.Api.V5.dll опубликована в виде nuget-пакета.

Начиная с версии 6.2, расширена поддержка точек продаж. Информация о точке продаж стала доступна в проведенных позициях оплаты, при переходе на экран кассы, а так же при разделении заказа между точками продаж. В настройки группы добавлен признак “Спрашивать кассира о разделении заказа на несколько мест печати”. Подробнее отдельная статья.

Начиная с версии 6.2 добавлена возможность работать с произвольными моделями фискальных регистраторов и весов в IikoFront и BackOffice. Раньше система умела работать только с распространенными моделями оборудования, на примере фискальных регистраторов: Спарк, Атол, Штрих, Пирит. Сейчас такого ограничения нет, к IikoFront и BackOffice может быть подключено оборудование любой модели.

Начиная с версии 6.2 добавлена возможность автоматического перезапуска плагинов при аварийном завершении их работы. Если раньше после падения плагина приложение iikoFront продолжало работу без него и для восстановления утраченных функций необходимо было перезапускать целиком приложение iikoFront вместе со всеми остальными плагинами, то теперь упавший плагин может быть запущен повторно на лету, без остановки приложения iikoFront.

Начиная с версии 6.2 плагин, реализующий некую функцию, может зарегистрировать её в API как внешнюю операцию, чтобы другие плагины могли вызывать эту функцию.

В версии V6 появилась возможность делить блюда на части и переносить их между гостями и заказами. Раньше подобные операции можно было выполнять только через UI приложения iikoFront, а теперь раздельный расчёт гостей стал возможен и через API.

Начиная с V6 при отключении плагина занятые им ресурсы будут автоматически освобождаться. Например, если плагин зарегистрировал кнопку (IPluginIntegrationService.AddButton), то при отключении плагина кнопка удалится с экрана приложения iikoFront. То же касается иных ресурсов, подписок и т. д.

Начиная с V6 появится возможность указать официанта при создании заказа, а также сменить официанта позднее.

Начиная с V6 к методу BillOrder добавлен обратный метод CancelBill, позволяющий отменить пречек и вернуть заказ в статус OrderStatus.New.

В версии V6 появится возможность подключать через плагины оборудование (для начала весы и фискальные регистраторы). Плагин сможет регистрировать поддерживаемые им типы устройств, далее пользователь сможет добавлять и настраивать в приложении iikoOffice подключенные через плагин устройства. Это позволит использовать модели устройств, которые приложение iikoFront напрямую не поддерживает.

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

Начиная с V6 события об изменении сущностей (например, INotificationService.OrderChanged) содержат также и тип изменения (EntityEventType), что позволяет узнать об удалении объекта.

Начиная с версии 5.2 при наличии dll-файлов с одинаковыми именами в папке плагина и папке приложения iikoFront будет загружаться файл из папки плагина.

В версии 5.2 приложение iikoFront перешло на использование библиотеки Reactive Extensions (далее Rx) версии 3.1.1 вместо прежней версии 2.2.5. Это может повлиять на работу плагинов, использовавших прежнюю версию Rx.

Механизм поиска и загрузки локализованных строк удалён из библиотеки Resto.Framework.dll. Хотя эта библиотека и не является частью iikoFront API, некоторые плагины всё же могли использовать её, при обновлении приложения iikoFront они могут перестать работать.

В 5.0 добавлено новое понятие — размер блюда (подробнее отдельная статья). Начиная с V5 в API публикуется информация о шкалах и размерах блюд, соответственно, для блюд в заказе можно указывать размер: при добавлении через аргумент size методов AddOrderProductItem/AddOrderCompoundItem, позднее через метод ChangeOrderCookingItemSize.

Иногда, желая временно отключить загрузку плагина, пользователи дописывали что-нибудь к расширению (например, «file.dll_») и удивлялись, что плагин все равно загружается. Теперь плагины с подобными именами будут игнорироваться при поиске.

Плагины следует устанавливать не в папку Plugins непосредственно, а в подпапки. Для V2 и V3 будут работать оба варианта, начиная с V4 — только новый.

Интерфейсы заглушек редактирования (IOrderStub, INewDeliveryStub и прочие), находившиеся рядом с ключевыми типами вроде IEditSession и ISubmittedEntities, выделены в отдельное подпространство имён Editors.Stubs, поскольку представляют значительно меньший интерес.

С целью обеспечения лучшей изоляции плагинов от библиотек, не являющихся частью API, а также для расширения функциональных возможностей запуск плагинов будет выполняться с помощью нового хост-процесса Resto.Front.Api.Host.exe (вместо Resto.CashServer.OutOfProcHost.exe). Для плагинов под V2 и V3 реализована обратная совместимость, начиная с V4 вводится ряд изменений.

В API V4 добавлена возможность подписаться на выполнение определённых операций для их расширения. При выполнении этих операций iikoFront в заранее оговорённых точках останавливается и передаёт управление плагину, который в зависимости от операции может редактировать данные (включая те, над которыми выполняется операция), взаимодействовать с пользователем, показывая диалоговые окна, выполнять печать на принтере и т. п.