iikoFront Api V6 Code Reference
iikoFront Api V6 Code Reference
Resto.Front.Api
IOperationService Interface
IOperationService Methods
AddClientToOrder Method
AddDonation Method
AddErrorMessage Method
AddNotificationMessage Method
AddWarningMessage Method
AuthenticateByPin Method
BillOrder Method
CalculateDeliveryTerminalWorkload Method
CallExternalOperation Method
CancelBill Method
CancelNewDelivery Method
CancelNewDeliveryAndHideItemsFromOlap Method
CancelReserve Method
CanProductBePaidWithPaymentType Method
ChangeDeliveryOpinion Method
ChangePreliminaryOrder Method
CheckCanEditOrder Method
CheckProductsSellingRestrictions Method
CloseCafeSession Method
CreateDiscountCard Method
CreateEditSession Method
CreatePreliminaryOrder Method
DeleteDonation Method
DeleteOrder Method
DeleteOrderAndHideItemsFromOlap Method
DeletePreliminaryOrder Method
EnablePreliminaryOrdersScreen Method
ExecuteContinuousOperation Method
GetActivePaymentTypes Method
GetActiveProducts Method
GetActiveRemovalTypes Method
GetActiveStreets Method
GetAgentId Method
GetAllProducts Method
GetAllStreets Method
GetCafeSessionByCashRegister Method
GetCafeSessionById Method
GetCashRegisterInfoById Method
GetCashRegisterInfos Method
GetChildGroupsByProductGroup Method
GetChildProductsByProductGroup Method
GetCities Method
GetCityById Method
GetClientById Method
GetCommonGroupModifiersByCompoundItemTemplate Method
GetCommonSimpleModifiersByCompoundItemTemplate Method
GetCompoundItemTemplateById Method
GetCompoundItemTemplates Method
GetConceptionById Method
GetConceptions Method
GetDeletedOrderTypes Method
GetDeliveryCancelCauseById Method
GetDeliveryCancelCauses Method
GetDeliveryOrderById Method
GetDeliveryOrders Method
GetDeliverySection Method
GetDisabledSizesByProduct Method
GetDiscountCardById Method
GetDiscountCards Method
GetDiscountTypeById Method
GetDiscountTypes Method
GetDonationTypesCompatibleWith Method
GetExternalOperations Method
GetGroupModifiersByProduct Method
GetHierarchicalMenu Method
GetHostDeliverySettings Method
GetHostRestaurant Method
GetHostTerminal Method
GetHostTerminalCultureInfo Method
GetHostTerminalPointsOfSale Method
GetHostTerminalsGroup Method
GetInactiveProducts Method
GetIncludedInMenuSectionsByProduct Method
GetKitchenOrderById Method
GetKitchenOrders Method
GetLastChangedOrderTerminal Method
GetMarketingSourceById Method
GetMarketingSources Method
GetOrderAppliedDiscounts Method
GetOrderById Method
GetOrderItemProductGroups Method
GetOrders Method
GetOrderTypeById Method
GetOrderTypes Method
GetOrganizationFingerprint Method
GetParentByProduct Method
GetParentByProductGroup Method
GetPastOrder Method
GetPaymentSystemName Method
GetPaymentTypeById Method
GetPaymentTypes Method
GetPaymentTypesToPayOutOnUser Method
GetPointOfSaleById Method
GetPreliminaryOrderById Method
GetPreliminaryOrders Method
GetPrice Method
GetPriceCategories Method
GetPriceCategoryById Method
GetProductById Method
GetProductCategories Method
GetProductCategoryById Method
GetProductGroupById Method
GetProductGroupMenuImage Method
GetProductGroups Method
GetProductMenuImage Method
GetProducts Method
GetProductScaleById Method
GetProductScales Method
GetProductScaleSizes Method
GetProductSizeById Method
GetProductSizes Method
GetProductsRemainingAmounts Method
GetProductStocksListById Method
GetProductStocksLists Method
GetQuickMenu Method
GetReceiptMarkup Method
GetRegionById Method
GetRegions Method
GetRelatedDeliveryOrders Method
GetRemovalTypeById Method
GetReportPrinter Method
GetReserveById Method
GetReserves Method
GetRestaurantSections Method
GetSectionSchemaById Method
GetSectionSchemaByRestaurantSection Method
GetSectionSchemas Method
GetSelectiveDiscountItemSettings Method
GetSimpleModifiersByProduct Method
GetSplittableGroupModifiersByCompoundItemTemplate Method
GetSplittableSimpleModifiersByCompoundItemTemplate Method
GetStreetById Method
GetSurveyItemById Method
GetSurveyItems Method
GetTableById Method
GetTables Method
GetTaxCategories Method
GetTaxCategoryById Method
GetTemplatedModifiersParamsByProduct Method
GetTerminalDeliveryDuration Method
GetTerminalsGroupPointsOfSale Method
GetTransportSettings Method
GetUpdatedDeliveryOrders Method
GetUser Method
GetUserById Method
GetUsers Method
IsActiveForDeliveries Method
IsAllCafeSessionsOpen Method
IsDeliveryActive Method
IsDeliveryConfirmationActive Method
IsMultiCashRegisterConfiguration Method
IsProductSellingRestricted Method
NeedToSplitOrderBeforePayment Method
OpenCafeSession Method
PayOrder Method
PayOrderAndPayOutOnUser Method
Print Method
PrintBanquet Method
PrintBillCheque Method
PrintOrderItems Method
PrintReceiptCheque Method
PrintTableReservedCheque Method
ProcessPrepay Method
RegisterBillChequeTaskResolver Method
RegisterCashRegisterFactory Method
RegisterChequeTaskProcessor Method
RegisterExternalOperation Method
RegisterPaymentSystem Method
RegisterScaleFactory Method
RemoveOrderClient Method
SearchClients Method
SearchDiscountCardByNumber Method
SearchStreets Method
SendHrsCardTransactionToServer Method
SplitOrderBetweenCashRegisters Method
StartCourseCooking Method
StartProductsCooking Method
StartService Method
StopService Method
SubmitChanges Method
TryGetBillPrinter Method
TryGetCafeSessionById Method
TryGetCashRegisterInfoById Method
TryGetChildGroupsByProductGroup Method
TryGetChildProductsByProductGroup Method
TryGetCityById Method
TryGetClientById Method
TryGetClientByPhone Method
TryGetCommonGroupModifiersByCompoundItemTemplate Method
TryGetCommonSimpleModifiersByCompoundItemTemplate Method
TryGetCompoundItemTemplateById Method
TryGetConceptionById Method
TryGetDeliveryCancelCauseById Method
TryGetDeliveryOrderById Method
TryGetDisabledSizesByProduct Method
TryGetDiscountCardById Method
TryGetDiscountTypeById Method
TryGetDocumentPrinter Method
TryGetGroupModifiersByProduct Method
TryGetIncludedInMenuSectionsByProduct Method
TryGetKitchenOrderById Method
TryGetMarketingSourceById Method
TryGetOrderById Method
TryGetOrderExternalDataByKey Method
TryGetOrderTypeById Method
TryGetParentByProduct Method
TryGetParentByProductGroup Method
TryGetPaymentTypeById Method
TryGetPointOfSaleById Method
TryGetPreliminaryOrderById Method
TryGetPriceCategoryById Method
TryGetProductById Method
TryGetProductCategoryById Method
TryGetProductGroupById Method
TryGetProductScaleById Method
TryGetProductSizeById Method
TryGetProductStocksListById Method
TryGetReceiptChequePrinter Method
TryGetRegionById Method
TryGetRemovalTypeById Method
TryGetReserveById Method
TryGetSectionSchemaById Method
TryGetSectionSchemaByRestaurantSection Method
TryGetSimpleModifiersByProduct Method
TryGetSplittableGroupModifiersByCompoundItemTemplate Method
TryGetSplittableSimpleModifiersByCompoundItemTemplate Method
TryGetStickerPrinter Method
TryGetStreetById Method
TryGetSurveyItemById Method
TryGetTableById Method
TryGetTaxCategoryById Method
TryGetTemplatedModifiersParamsByProduct Method
TryGetUserById Method
UpdateDiscountCard Method

# IOperationService Methods

The IOperationService type exposes the following members.

Methods

| Name | Description
--- | --- | ---
| AddClientToOrder | Returns true if client is bound to the order.
| AddDonation | Adds new donation to order.
| AddErrorMessage(String, String) | Shows non-modal error message in the left top corner of the screen.
| AddErrorMessage(String, String, Nullable TimeSpan ) | Shows non-modal error message in the left top corner of the screen.
| AddNotificationMessage(String, String) | Shows non-modal notification message in the left top corner of the screen.
| AddNotificationMessage(String, String, Nullable TimeSpan ) | Shows non-modal notification message in the left top corner of the screen.
| AddWarningMessage(String, String) | Shows non-modal warning message in the left top corner of the screen.
| AddWarningMessage(String, String, Nullable TimeSpan ) | Shows non-modal warning message in the left top corner of the screen.
| AuthenticateByPin |
| BillOrder | Changes the order to Bill status and returns text of bill cheque.
| CalculateDeliveryTerminalWorkload | Returns terminal workload.
| CallExternalOperation | Calls an operation which is implemented in another plugin.
| CancelBill | Сhanges the order to the New status and prints the bill cancellation cheque.
| CancelNewDelivery | Cancels new delivery.
| CancelNewDeliveryAndHideItemsFromOlap | Cancels new delivery and hides delivery order items from OLAP reports.
| CancelReserve | Cancels reservation due to some reason
| CanProductBePaidWithPaymentType | Function describes if the product is compatible with payment type, i.e. payment type can be used to pay for the product.
| ChangeDeliveryOpinion | Changes client's opinion on closed delivery.
| ChangePreliminaryOrder | Changes preliminary order.
| CheckCanEditOrder | If current user has permissions to view order.
| CheckProductsSellingRestrictions | If current user can add these products with such amounts.
| CloseCafeSession | Closes cafe session.
| CreateDiscountCard | Creates a new discount card.
| CreateEditSession | Creates an edit session. All changes made with this session will be accumulated without affecting entities. Use SubmitChanges(ICredentials, IEditSession) method to apply all changes or do nothing to discard them.
| CreatePreliminaryOrder | Create new preliminary order.
| DeleteDonation | Deletes existing donation from the order.
| DeleteOrder | Deletes order. Order must have no printed items. User must have rights to edit orders.
| DeleteOrderAndHideItemsFromOlap | Deletes order and hides order items from OLAP reports. Order must have no printed items, no payment items and no removed with writeoff items. User must have rights to edit orders.
| DeletePreliminaryOrder | Deletes preliminary order
| EnablePreliminaryOrdersScreen | Enable preliminary orders screen for iikoFront user.
| ExecuteContinuousOperation | Executes the callback function as one continuous operation by providing temporary instance of IOperationService, which holds internal locks taken on lockable entities (such as order) until the operation ends. It's strongly recommended to avoid potentially obstructive calls in the callback, i.e network calls, heavy I/O or CPU-bound calls, thread blocking and so on, because touched entities will remain locked for a long time.
| GetActivePaymentTypes | Returns active payment types bound to the specified processor.
| GetActiveProducts |
| GetActiveRemovalTypes | Gets removal types which are allowed to use.
| GetActiveStreets | Obsolete.
| GetAgentId |
| GetAllProducts | Gets all products (both active and inactive).
| GetAllStreets | Obsolete.
| GetCafeSessionByCashRegister | Returns current open cafe session on cash register.
| GetCafeSessionById | Returns cafeSession by id.
| GetCashRegisterInfoById | Returns cashRegisterInfo by id.
| GetCashRegisterInfos |
| GetChildGroupsByProductGroup | Returns childGroups of the specified productGroup.
| GetChildProductsByProductGroup | Returns childProducts of the specified productGroup.
| GetCities |
| GetCityById | Returns city by id.
| GetClientById | Returns client by id.
| GetCommonGroupModifiersByCompoundItemTemplate | Returns commonGroupModifiers of the specified compoundItemTemplate.
| GetCommonSimpleModifiersByCompoundItemTemplate | Returns commonSimpleModifiers of the specified compoundItemTemplate.
| GetCompoundItemTemplateById | Returns compoundItemTemplate by id.
| GetCompoundItemTemplates |
| GetConceptionById | Returns conception by id.
| GetConceptions |
| GetDeletedOrderTypes |
| GetDeliveryCancelCauseById | Returns deliveryCancelCause by id.
| GetDeliveryCancelCauses |
| GetDeliveryOrderById | Returns deliveryOrder by id.
| GetDeliveryOrders |
| GetDeliverySection | Returns section of current group where delivery orders are created. Is determined by default table of group.
| GetDisabledSizesByProduct | Returns disabledSizes of the specified product.
| GetDiscountCardById | Returns discountCard by id.
| GetDiscountCards |
| GetDiscountTypeById | Returns discountType by id.
| GetDiscountTypes |
| GetDonationTypesCompatibleWith | Gets donation types which are allowed to use with the order.
| GetExternalOperations | Returns currently registered external operations grouped by service name.
| GetGroupModifiersByProduct | Returns groupModifiers of the specified product.
| GetHierarchicalMenu |
| GetHostDeliverySettings | Returns delivery settings of restaurant
| GetHostRestaurant |
| GetHostTerminal | Returns info about the current terminal.
| GetHostTerminalCultureInfo |
| GetHostTerminalPointsOfSale | Returns list of points of sale attached to current terminal. Empty list means that current terminal is not cash terminal.
| GetHostTerminalsGroup |
| GetInactiveProducts | Obsolete.
| GetIncludedInMenuSectionsByProduct | Returns includedInMenuSections of the specified product.
| GetKitchenOrderById | Returns kitchenOrder by id.
| GetKitchenOrders |
| GetLastChangedOrderTerminal | Returns termnal that changed order last time.
| GetMarketingSourceById | Returns marketingSource by id.
| GetMarketingSources |
| GetOrderAppliedDiscounts |
| GetOrderById |
| GetOrderItemProductGroups | Returns product groups from the specified order. Products in each group are intended to be cooked together.
| GetOrders |
| GetOrderTypeById | Returns orderType by id.
| GetOrderTypes |
| GetOrganizationFingerprint | Returns a fingerprint which can be used to identify an iikoRMS server instance.
| GetParentByProduct | Returns parent of the specified product.
| GetParentByProductGroup | Returns parent of the specified productGroup.
| GetPastOrder | Get closed order data from server, and returns it.
| GetPaymentSystemName | Tries to return a string for matching the payment type to the payment system if it exists, elseway returns empty string.
| GetPaymentTypeById | Returns paymentType by id.
| GetPaymentTypes |
| GetPaymentTypesToPayOutOnUser | Returns payment types that can be processed “silently”, without user interface.
| GetPointOfSaleById | Returns pointOfSale by id.
| GetPreliminaryOrderById | Returns preliminaryOrder by id or null if preliminaryOrder with specified id doesn't exist.
| GetPreliminaryOrders | Get all preliminary orders.
| GetPrice | Returns price for the product according to the given client price category.
| GetPriceCategories |
| GetPriceCategoryById | Returns priceCategory by id.
| GetProductById | Returns product by id.
| GetProductCategories |
| GetProductCategoryById | Returns productCategory by id.
| GetProductGroupById | Returns productGroup by id.
| GetProductGroupMenuImage | Returns a byte sequence presenting an image to be shown as a background on a menu button for the specified product group. If the product group doesn't have an image, null will be returned.
| GetProductGroups |
| GetProductMenuImage | Returns a byte sequence presenting an image to be shown as a background on a menu button for the specified product. If the product doesn't have an image, null will be returned.
| GetProducts | Obsolete.
| GetProductScaleById | Returns productScale by id.
| GetProductScales |
| GetProductScaleSizes |
| GetProductSizeById | Returns productSize by id.
| GetProductSizes |
| GetProductsRemainingAmounts | Gets remaining amounts of products in stop list.
| GetProductStocksListById | Returns productStocksList by id.
| GetProductStocksLists |
| GetQuickMenu | Returns quick menu for specified restaurant section and day.
| GetReceiptMarkup | Get reciept markup of the payment.
| GetRegionById | Returns region by id.
| GetRegions |
| GetRelatedDeliveryOrders | Gets all deliveries that are related with argument through splitting between cash registers. Delivery itself is also returned. If delivery was not split, returns delivery passed as argument.
| GetRemovalTypeById | Returns removalType by id.
| GetReportPrinter | Get instance of report printer
| GetReserveById | Returns reserve by id.
| GetReserves |
| GetRestaurantSections | Gets list of restaurant sections of the current terminals group.
| GetSectionSchemaById | Returns sectionSchema by id.
| GetSectionSchemaByRestaurantSection | Returns sectionSchema of the specified restaurantSection.
| GetSectionSchemas |
| GetSelectiveDiscountItemSettings | Returns order items to which the specified selective discount item is applied or null if the discount item is applied to the whole order.
| GetSimpleModifiersByProduct | Returns simpleModifiers of the specified product.
| GetSplittableGroupModifiersByCompoundItemTemplate | Returns splittableGroupModifiers of the specified compoundItemTemplate.
| GetSplittableSimpleModifiersByCompoundItemTemplate | Returns splittableSimpleModifiers of the specified compoundItemTemplate.
| GetStreetById | Returns street by id.
| GetSurveyItemById | Returns surveyItem by id.
| GetSurveyItems |
| GetTableById | Returns table by id.
| GetTables |
| GetTaxCategories |
| GetTaxCategoryById | Returns taxCategory by id.
| GetTemplatedModifiersParamsByProduct | Returns templatedModifiersParams of the specified product.
| GetTerminalDeliveryDuration | Returns courier and self-service delivery duration time set on a delivery terminal.
| GetTerminalsGroupPointsOfSale | Returns list of points of sale in group.
| GetTransportSettings | Returns iikoTransport settings.
| GetUpdatedDeliveryOrders |
| GetUser | Get user corresponding to specified credentials.
| GetUserById | Returns user by id.
| GetUsers |
| IsActiveForDeliveries |
| IsAllCafeSessionsOpen | Returns true if all cafe sessions is open.
| IsDeliveryActive | Returns whether delivery is active.
| IsDeliveryConfirmationActive | Returns whether delivery confirmation is active.
| IsMultiCashRegisterConfiguration | Returns true if multi cash register configuration allowed.
| IsProductSellingRestricted | Checks remaining amount of the product and determines whether selling of that product is restricted.
| NeedToSplitOrderBeforePayment | Checks if order should be splitted between cash registers before payment. Method also returns estimated point of sale for order if it can be determinated at the moment.
| OpenCafeSession | Opens cafe session.
| PayOrder | Pay order with included processed payment items.
| PayOrderAndPayOutOnUser | Pay order and pay out on user.
| Print | Print document on specified printer.
| PrintBanquet | Prints preliminary document with estimated event date and time, planned menu, guests count, client contacts, prepay info, etc.
| PrintBillCheque | Changes the order to Bill status if it is not Bill and prints bill cheque.
| PrintOrderItems | Prints service cheque for defined order item products.
| PrintReceiptCheque | Printing receipts to a printer.
| PrintTableReservedCheque | Prints short “Table reserved” document with estimated event date and time, guests count and client contacts. Can be used to place onto reserved table as a hint not to occupy it.
| ProcessPrepay | Processes existing payment item. Payment item should be processed externally or supports silent processing.
| RegisterBillChequeTaskResolver | Registers the bill cheque task resolver.
| RegisterCashRegisterFactory | Registers cash register factory.
| RegisterChequeTaskProcessor | Registers chequeTaskProcessor for extansion the functionality of the cash register.
| RegisterExternalOperation | Exposes a custom operation to be available for call by other plugins. The registration is not permanent, it holds true until disposing the return value, or plugin shutdown.
| RegisterPaymentSystem | Registers payment system.
| RegisterScaleFactory | Registers scale factory.
| RemoveOrderClient | Returns true if client is unbound of the order.
| SearchClients | Search clients. The number of results is limited.
| SearchDiscountCardByNumber | Searches a discount card by given card number.
| SearchStreets | Searches streets and returns limited number of results.
| SendHrsCardTransactionToServer | Sends guest data to the server.
| SplitOrderBetweenCashRegisters | Split order between cash registers according to the current point of sale mapping.
| StartCourseCooking | Starts cooking for all order item products of the specified course.
| StartProductsCooking | Starts cooking for the specified order item products.
| StartService | Starts the specified service.
| StopService | Stops the specified service.
| SubmitChanges | Applies all changes made with specified edit session.
| TryGetBillPrinter | Try get bill printer for specified restaurant section.
| TryGetCafeSessionById | Returns cafeSession by id or null if cafeSession with specified id doesn't exist.
| TryGetCashRegisterInfoById | Returns cashRegisterInfo by id or null if cashRegisterInfo with specified id doesn't exist.
| TryGetChildGroupsByProductGroup | Returns childGroups of the specified productGroup or null if productGroup doesn't exist.
| TryGetChildProductsByProductGroup | Returns childProducts of the specified productGroup or null if productGroup doesn't exist.
| TryGetCityById | Returns city by id or null if city with specified id doesn't exist.
| TryGetClientById | Returns client by id or null if client with specified id doesn't exist.
| TryGetClientByPhone | Returns client by phone.
| TryGetCommonGroupModifiersByCompoundItemTemplate | Returns commonGroupModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
| TryGetCommonSimpleModifiersByCompoundItemTemplate | Returns commonSimpleModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
| TryGetCompoundItemTemplateById | Returns compoundItemTemplate by id or null if compoundItemTemplate with specified id doesn't exist.
| TryGetConceptionById | Returns conception by id or null if conception with specified id doesn't exist.
| TryGetDeliveryCancelCauseById | Returns deliveryCancelCause by id or null if deliveryCancelCause with specified id doesn't exist.
| TryGetDeliveryOrderById | Returns deliveryOrder by id or null if deliveryOrder with specified id doesn't exist.
| TryGetDisabledSizesByProduct | Returns disabledSizes of the specified product or null if product doesn't exist.
| TryGetDiscountCardById | Returns discountCard by id or null if discountCard with specified id doesn't exist.
| TryGetDiscountTypeById | Returns discountType by id or null if discountType with specified id doesn't exist.
| TryGetDocumentPrinter | Try get document printer for specified restaurant section.
| TryGetGroupModifiersByProduct | Returns groupModifiers of the specified product or null if product doesn't exist.
| TryGetIncludedInMenuSectionsByProduct | Returns includedInMenuSections of the specified product or null if product doesn't exist.
| TryGetKitchenOrderById | Returns kitchenOrder by id or null if kitchenOrder with specified id doesn't exist.
| TryGetMarketingSourceById | Returns marketingSource by id or null if marketingSource with specified id doesn't exist.
| TryGetOrderById |
| TryGetOrderExternalDataByKey |
| TryGetOrderTypeById | Returns orderType by id or null if orderType with specified id doesn't exist.
| TryGetParentByProduct | Returns parent of the specified product or null if product doesn't exist.
| TryGetParentByProductGroup | Returns parent of the specified productGroup or null if productGroup doesn't exist.
| TryGetPaymentTypeById | Returns paymentType by id or null if paymentType with specified id doesn't exist.
| TryGetPointOfSaleById | Returns pointOfSale by id or null if pointOfSale with specified id doesn't exist.
| TryGetPreliminaryOrderById | Returns preliminaryOrder by id.
| TryGetPriceCategoryById | Returns priceCategory by id or null if priceCategory with specified id doesn't exist.
| TryGetProductById | Returns product by id or null if product with specified id doesn't exist.
| TryGetProductCategoryById | Returns productCategory by id or null if productCategory with specified id doesn't exist.
| TryGetProductGroupById | Returns productGroup by id or null if productGroup with specified id doesn't exist.
| TryGetProductScaleById | Returns productScale by id or null if productScale with specified id doesn't exist.
| TryGetProductSizeById | Returns productSize by id or null if productSize with specified id doesn't exist.
| TryGetProductStocksListById | Returns productStocksList by id or null if productStocksList with specified id doesn't exist.
| TryGetReceiptChequePrinter | Try get receipt cheque printer for default cash register.
| TryGetRegionById | Returns region by id or null if region with specified id doesn't exist.
| TryGetRemovalTypeById | Returns removalType by id or null if removalType with specified id doesn't exist.
| TryGetReserveById | Returns reserve by id or null if reserve with specified id doesn't exist.
| TryGetSectionSchemaById | Returns sectionSchema by id or null if sectionSchema with specified id doesn't exist.
| TryGetSectionSchemaByRestaurantSection | Returns sectionSchema of the specified restaurantSection or null if restaurantSection doesn't exist.
| TryGetSimpleModifiersByProduct | Returns simpleModifiers of the specified product or null if product doesn't exist.
| TryGetSplittableGroupModifiersByCompoundItemTemplate | Returns splittableGroupModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
| TryGetSplittableSimpleModifiersByCompoundItemTemplate | Returns splittableSimpleModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
| TryGetStickerPrinter | Try get sticker printer for specified restaurant section.
| TryGetStreetById | Returns street by id or null if street with specified id doesn't exist.
| TryGetSurveyItemById | Returns surveyItem by id or null if surveyItem with specified id doesn't exist.
| TryGetTableById | Returns table by id or null if table with specified id doesn't exist.
| TryGetTaxCategoryById | Returns taxCategory by id or null if taxCategory with specified id doesn't exist.
| TryGetTemplatedModifiersParamsByProduct | Returns templatedModifiersParams of the specified product or null if product doesn't exist.
| TryGetUserById | Returns user by id or null if user with specified id doesn't exist.
| UpdateDiscountCard | Updates an existing discount card.

Top
Extension Methods

| Name | Description
--- | --- | ---
| AddDiscount | Adds simple discount of known type to existing order. User must have rights to work with discounts. (Defined by OperationServiceExtensions.)
| AddDiscountByCardNumber | Add discount by card number. (Defined by OperationServiceExtensions.)
| AddExternalPaymentItem(Decimal, Boolean, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials) | Overloaded. Add new external payment item to order. (Defined by OperationServiceExtensions.)
| AddExternalPaymentItem(Guid, Decimal, Boolean, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials) | Overloaded. Add new external payment item to order. (Defined by OperationServiceExtensions.)
| AddFlexibleSumDiscount | Adds simple discount of known type to existing order. User must have rights to work with discounts. (Defined by OperationServiceExtensions.)
| AddFlexibleSumDiscountByCardNumber | Add discount by card number. (Defined by OperationServiceExtensions.)
| AddOrderCombo | Create order combo item. Order must contain new combo items. (Defined by OperationServiceExtensions.)
| AddOrderExternalData | Adds external data to the order. Use DeleteOrderExternalData(IOperationService, String, IOrder, ICredentials) to delete the data when it's no longer needed. (Defined by OperationServiceExtensions.)
| AddOrderGuest(String, IOrder, ICredentials) | Overloaded. Adds new guest to existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderGuest(Guid, String, IOrder, ICredentials) | Overloaded. Adds new guest with the given ID to existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderModifierItem(Int32, IProduct, IProductGroup, IOrder, IOrderProductItem, ICredentials, Nullable Decimal ) | Overloaded. Adds order item modifier to the order item in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderModifierItem(Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItem, ICredentials, Nullable Decimal ) | Overloaded. Adds order item modifier to the compound item in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderModifierItem(Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItemComponent, ICredentials, Nullable Decimal ) | Overloaded. Adds order item modifier to the compound item component in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderProductItem, ICredentials, Nullable Decimal ) | Overloaded. Adds order item modifier to the order item in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItem, ICredentials, Nullable Decimal ) | Overloaded. Adds order item modifier to the compound item in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItemComponent, ICredentials, Nullable Decimal ) | Overloaded. Adds order item modifier to the compound item component in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderProductItem(Decimal, IProduct, IOrder, IOrderGuestItem, IProductSize, ICredentials, OrderItemCourse, Nullable Decimal ) | Overloaded. Adds assortment position to the guest in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderProductItem(Guid, Decimal, IProduct, IOrder, IOrderGuestItem, IProductSize, ICredentials, OrderItemCourse, Nullable Decimal ) | Overloaded. Adds assortment position to the guest in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| AddOrderServiceItem | Adds time pay service item to the guest in existing order. User must have permission to edit orders. (Defined by OperationServiceExtensions.)
| AddPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials) | Overloaded. Add new payment item to order. (Defined by OperationServiceExtensions.)
| AddPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials) | Overloaded. Add new payment item to order. (Defined by OperationServiceExtensions.)
| AddPreliminaryPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IDeliveryOrder, ICredentials) | Overloaded. Add new preliminary payment item to order. (Defined by OperationServiceExtensions.)
| AddPreliminaryPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IDeliveryOrder, ICredentials) | Overloaded. Add new preliminary payment item to order. (Defined by OperationServiceExtensions.)
| BindReserveToOrder | Converts exising reserve or banquet without order to banquet with order. (Defined by OperationServiceExtensions.)
| CallExternalOperation TRequest, TResponse | Calls an operation which is implemented in another plugin. (Defined by OperationServiceExtensions.)
| ChangeClientAddresses | Changes client addresses. (Defined by OperationServiceExtensions.)
| ChangeClientBirthDate | Changes client's birth date. (Defined by OperationServiceExtensions.)
| ChangeClientBlacklistInfo | Changes client blacklist info. (Defined by OperationServiceExtensions.)
| ChangeClientCardNumber | Changes client card number. (Defined by OperationServiceExtensions.)
| ChangeClientComment | Changes client comment. (Defined by OperationServiceExtensions.)
| ChangeClientEmails | Changes client emails list. (Defined by OperationServiceExtensions.)
| ChangeClientGender | Change client's gender. (Defined by OperationServiceExtensions.)
| ChangeClientIikoBizId | Changes client's account in iiko.biz. (Defined by OperationServiceExtensions.)
| ChangeClientIikoNetId | Changes client's account in Plazius. (Defined by OperationServiceExtensions.)
| ChangeClientLastOrderDate | Changes client's last order date. (Defined by OperationServiceExtensions.)
| ChangeClientLinkedCounteragent | Changes client linked counter agent. (Defined by OperationServiceExtensions.)
| ChangeClientMainAddressIndex | Changes client main address index. (Defined by OperationServiceExtensions.)
| ChangeClientMarketingSource | Changes client marketing source. (Defined by OperationServiceExtensions.)
| ChangeClientName | Changes client name. (Defined by OperationServiceExtensions.)
| ChangeClientNick | Changes client nickname. (Defined by OperationServiceExtensions.)
| ChangeClientPersonalDataConsent | Changes whether client consented processing their personal data. (Defined by OperationServiceExtensions.)
| ChangeClientPhones | Changes client phones list. (Defined by OperationServiceExtensions.)
| ChangeClientReceivesNotifications | Changes whether client receives notification messages. (Defined by OperationServiceExtensions.)
| ChangeClientSurname | Changes client surname. (Defined by OperationServiceExtensions.)
| ChangeComboAmount | Change combo amount. (Defined by OperationServiceExtensions.)
| ChangeComboPrice | Change combo price. (Defined by OperationServiceExtensions.)
| ChangeCookingPriority | Changes custom cooking priority and top priority flag. (Defined by OperationServiceExtensions.)
| ChangeDeliveryActualDeliverTime | Change time when the order was actually delivered. (Defined by OperationServiceExtensions.)
| ChangeDeliveryAddress | Changes address of delivery (Defined by OperationServiceExtensions.)
| ChangeDeliveryComment | Change the order comment. (Defined by OperationServiceExtensions.)
| ChangeDeliveryConfirmTime | Change when the order was confirmed. (Defined by OperationServiceExtensions.)
| ChangeDeliveryCourier | Assign/Change the order courier. Can use this action only before the order is to be delivered. (Defined by OperationServiceExtensions.)
| ChangeDeliveryCustomApiData | Change the delivery custom data from api. (Defined by OperationServiceExtensions.)
| ChangeDeliveryDuration | Change duration of delivery processing. (Defined by OperationServiceExtensions.)
| ChangeDeliveryEmail | Change the order e-mail. (Defined by OperationServiceExtensions.)
| ChangeDeliveryExpectedDeliverTime | Change time when client wants the order to be delivered. (Defined by OperationServiceExtensions.)
| ChangeDeliveryLastDefaultTerminalDeliveryDurationInMinutes | Set calculated delivery duration without overrided value on terminal. (Defined by OperationServiceExtensions.)
| ChangeDeliveryLastVerifiedRestrictionsHash | Set last verified restirictions hash from server. (Defined by OperationServiceExtensions.)
| ChangeDeliveryLocation | Changes delivery address location. (Defined by OperationServiceExtensions.)
| ChangeDeliveryMarketingSource | Assign/change order marketing source. (Defined by OperationServiceExtensions.)
| ChangeDeliveryOperator | Assign/change the order operator. (Defined by OperationServiceExtensions.)
| ChangeDeliveryOrderPredictedCookingCompleteTime | Change predicted time when the order cooking should be completed. Can change property only for Unconfirmed, New or Waiting delivery. (Defined by OperationServiceExtensions.)
| ChangeDeliveryPhone | Changes the order phone. (Defined by OperationServiceExtensions.)
| ChangeDeliveryPredictedDeliveryTime | Change predicted time when the order should be delivered. Can change property only for Unconfirmed, New or Waiting delivery. (Defined by OperationServiceExtensions.)
| ChangeDeliveryProblemComment | Change the order problem comment. (Defined by OperationServiceExtensions.)
| ChangeDeliveryProblemStatus | Change the order problem status. (Defined by OperationServiceExtensions.)
| ChangeDeliverySplitBetweenPersons | Changes the order property if it should be splitted between persons. (Defined by OperationServiceExtensions.)
| ChangeEstimatedOrderGuestsCount | Changes estimated order guests count. Use this method to set estimated guests count when guests collection doesn't reflect actual state of affairs. (Defined by OperationServiceExtensions.)
| ChangeExternalPaymentItemCustomData | Changes custom data of existing external payment item. (Defined by OperationServiceExtensions.)
| ChangeOrderAppliedIikoCard5ManualConditions | Change iikoCard5 manual conditions applied for order. (Defined by OperationServiceExtensions.)
| ChangeOrderCookingItemAmount | Changes the amount of the assortment position in existing order. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| ChangeOrderCookingItemCourse | Changes the course of the order item. (Defined by OperationServiceExtensions.)
| ChangeOrderCookingItemSize | Changes the product size of the order item. (Defined by OperationServiceExtensions.)
| ChangeOrderIikoCard5Coupon | Change order iikoCard5 coupon, used in iikoCard5 system. (Defined by OperationServiceExtensions.)
| ChangeOrderItemComment | Changes product order item's comment. (Defined by OperationServiceExtensions.)
| ChangeOrderItemWaiter | Changes product order item's waiter. (Defined by OperationServiceExtensions.)
| ChangeOrderModifierItemAmount(Int32, IOrder, IOrderProductItem, IOrderModifierItem, ICredentials) | Overloaded. Changes the amount of the product item modifier. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| ChangeOrderModifierItemAmount(Int32, IOrder, IOrderCompoundItem, IOrderModifierItem, ICredentials) | Overloaded. Changes the amount of the compound item common modifier. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| ChangeOrderModifierItemAmount(Int32, IOrder, IOrderCompoundItemComponent, IOrderModifierItem, ICredentials) | Overloaded. Changes the amount of the compound component modifier. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| ChangeOrderOriginName | Sets order origin — name of the source this order was received from. Specifying origin allows to analyse efficiency of external order sources such as different web-sites, mobile applications and so on. Origin name can be set only once. (Defined by OperationServiceExtensions.)
| ChangeOrderPricingTime | Change order pricing time, which determines the price of products. By default time taken from items print time. (Defined by OperationServiceExtensions.)
| ChangeOrderTables | Changes tables of the order. (Defined by OperationServiceExtensions.)
| ChangeOrderWaiter | Changes order's waiter. (Defined by OperationServiceExtensions.)
| ChangePaymentItemCustomData | Changes custom data of existing payment item. (Defined by OperationServiceExtensions.)
| ChangePaymentItemSum | Changes sum of existing payment item. (Defined by OperationServiceExtensions.)
| ChangePreliminaryPaymentItemCustomData | Changes custom data of existing preliminary payment item. (Defined by OperationServiceExtensions.)
| ChangePreliminaryPaymentItemSum | Changes sum of existing preliminary payment item. (Defined by OperationServiceExtensions.)
| ChangePriceCategory | Changes price category of the order. (Defined by OperationServiceExtensions.)
| ChangeReserveComment | Changes reserve comment. Use empty string to clear comment. (Defined by OperationServiceExtensions.)
| ChangeReserveDuration | Changes estimated reserve duration (amount of time betwen visit's start and end). Default reserve duration is 2 hours, banquet duration is 3 hours. (Defined by OperationServiceExtensions.)
| ChangeReserveEstimatedStartTime | Changes estimated reserve start time. (Defined by OperationServiceExtensions.)
| ChangeReserveGuestsCount | Changes estimated guests count for reserve. Default value is 2. (Defined by OperationServiceExtensions.)
| ChangeReserveReminder | Changes reserve reminder flag. (Defined by OperationServiceExtensions.)
| ChangeReserveTable | Changes reserving tables. (Defined by OperationServiceExtensions.)
| ChangeReserveTables | Changes reserving tables. (Defined by OperationServiceExtensions.)
| ChangeSelectiveDiscount | Change discount item selective application settings. Set both products and modifiers to null if you want the discount item to be applied to the whole order (including future order items), otherwise provide order item products and modifiers for selective discount item application. (Defined by OperationServiceExtensions.)
| ChangeStreetName | Changes street's name. (Defined by OperationServiceExtensions.)
| CreateBanquet(DateTime, IClient, ITable, ICredentials) | Overloaded. Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time. (Defined by OperationServiceExtensions.)
| CreateBanquet(DateTime, IClient, IReadOnlyList ITable , ICredentials) | Overloaded. Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time. (Defined by OperationServiceExtensions.)
| CreateBanquet(DateTime, IClient, IOrder, ICredentials) | Overloaded. Creates reservation for planned event in future. Order's table will be marked as reserved to prevent collision with other events at the same time. (Defined by OperationServiceExtensions.)
| CreateClient | Creates new client. The client must have a card number or at least one phone number. (Defined by OperationServiceExtensions.)
| CreateReserve(DateTime, IClient, ITable, ICredentials) | Overloaded. Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time. (Defined by OperationServiceExtensions.)
| CreateReserve(DateTime, IClient, IReadOnlyList ITable , ICredentials) | Overloaded. Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time. (Defined by OperationServiceExtensions.)
| CreateStreet(String, ICredentials) | Overloaded. Creates new street. (Defined by OperationServiceExtensions.)
| CreateStreet(Guid, String, ICity, ICredentials) | Overloaded. Creates new street. (Defined by OperationServiceExtensions.)
| DeleteDiscount | Removes discount of known type from existing order. User must have rights to work with discounts. (Defined by OperationServiceExtensions.)
| DeleteExternalPaymentItem | Delete existing external payment item from order. (Defined by OperationServiceExtensions.)
| DeleteOrderCombo | Delete order combo item. (Defined by OperationServiceExtensions.)
| DeleteOrderExternalData | Deletes external data from the order. (Defined by OperationServiceExtensions.)
| DeleteOrderGuest | Deletes guest without any products from order. (Defined by OperationServiceExtensions.)
| DeleteOrderItem | Deletes order item from order that represents the assortment position. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| DeleteOrderItemComment | Deletes product order item's comment. (Defined by OperationServiceExtensions.)
| DeleteOrderModifierItem(IOrder, IOrderProductItem, IOrderModifierItem, ICredentials) | Overloaded. Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| DeleteOrderModifierItem(IOrder, IOrderCompoundItem, IOrderModifierItem, ICredentials) | Overloaded. Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| DeleteOrderModifierItem(IOrder, IOrderCompoundItemComponent, IOrderModifierItem, ICredentials) | Overloaded. Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| DeleteOrRestoreStreet | Deletes street. (Defined by OperationServiceExtensions.)
| DeletePaymentItem | Delete existing payment item from order. (Defined by OperationServiceExtensions.)
| DeletePreliminaryPaymentItem | Delete existing preliminary payment item from order. (Defined by OperationServiceExtensions.)
| DeletePrintedOrderItem | Deletes order item that is already printed. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| DeletePrintedOrderModifierItem | Deletes order item modifier that is already printed. User must have rights to edit orders. (Defined by OperationServiceExtensions.)
| ExecuteContinuousOperation(Action IOperationService ) | Overloaded. Executes the callback function as one continuous operation by providing temporary instance of IOperationService, which holds internal locks taken on lockable entities (such as order) until the operation ends. It's strongly recommended to avoid potentially obstructive calls in the callback, i.e network calls, heavy I/O or CPU-bound calls, thread blocking and so on, because touched entities will remain locked for a long time. (Defined by OperationServiceExtensions.)
| ExecuteContinuousOperation T (Func IOperationService, T ) | Overloaded. Executes the callback function as one continuous operation by providing temporary instance of IOperationService, which holds internal locks taken on lockable entities (such as order) until the operation ends. It's strongly recommended to avoid potentially obstructive calls in the callback, i.e network calls, heavy I/O or CPU-bound calls, thread blocking and so on, because touched entities will remain locked for a long time. (Defined by OperationServiceExtensions.)
| GroupOrderCookingItems | Combines the order item products into mix group so that they will be cooked together. Only consecutive products of the same guest can be combined into mix group. (Defined by OperationServiceExtensions.)
| MoveOrderItemToAnotherGuest | Moves product item between guests of the same order. (Defined by OperationServiceExtensions.)
| MoveOrderItemToAnotherOrder | Moves product item between orders. (Defined by OperationServiceExtensions.)
| RegisterBillChequeTaskResolver | Registers the bill cheque task resolver. (Defined by OperationServiceExtensions.)
| RegisterExternalOperation TRequest, TResponse | Exposes a custom operation to be available for call by other plugins. The registration is not permanent, it holds true until disposing the return value, or plugin shutdown. (Defined by OperationServiceExtensions.)
| RenameOrderGuest | Renames order's guest. (Defined by OperationServiceExtensions.)
| ReopenReserve | Reopens previously closed or canceled reserve. (Defined by OperationServiceExtensions.)
| ResetIsPrintedDeliveryBillActual | Resets whether latest printed bill is actual to 'false' value. Use when you want delivery bill to be print again according to settings. For example, if you changed courier and wish to have actual name on the bill, call this action and delivery will automatically printed according to settings. On the contrary, if you don't want bill to be printed again (for example, courier is written to the bill later by hands), you have no need to call this action. (Defined by OperationServiceExtensions.)
| ResetPriceCategory | Resets price category of the order. (Defined by OperationServiceExtensions.)
| ServeOrderCookingItem | Mark order item product as served. (Defined by OperationServiceExtensions.)
| SetDeliveryConfirmed | Change delivery status to confirmed. (Defined by OperationServiceExtensions.)
| SetDeliveryCustomerAuthorizedInIikoBiz | Changes whether the client is already authorized in iiko.biz. WARNING: use with caution! Illegal value can lead to unsuccessful iiko.biz operations. Do NOT set this property to 'true' if you are not sure that all authorization properties are correct and customer is registered in iiko.biz; that will cause iiko.biz payment failure. (Defined by OperationServiceExtensions.)
| SetDeliveryCustomerAuthorizedInIikoNet | Changes whether the client is already authorized in Plazius. WARNING: use with caution! Illegal value can lead to unsuccessful Plazius operations. Do NOT set this property to 'true' if you are not sure that all authorization properties are correct and customer is registered in Plazius; that will cause Plazius payment failure. (Defined by OperationServiceExtensions.)
| SetDeliveryDelivered | Change delivery status to delivered. (Defined by OperationServiceExtensions.)
| SetDeliveryUnconfirmed | Change delivery status to unconfirmed. (Defined by OperationServiceExtensions.)
| SetDeliveryUndelivered | Change delivery status to OnWay from status delivered. (Defined by OperationServiceExtensions.)
| SetOpenPrice | Changes order item open price. (Defined by OperationServiceExtensions.)
| SetOrderType | Sets order type for order. (Defined by OperationServiceExtensions.)
| SplitOrderCookingItem | Cut off specified amount from product to new one. (Defined by OperationServiceExtensions.)
| StartBanquet | Transits banquet to the started status. (Defined by OperationServiceExtensions.)
| UngroupOrderCookingItems | Separates the order item products from mix group so that they will be cooked independently. (Defined by OperationServiceExtensions.)
| UnserveOrderCookingItem | Mark order item product as unserved. (Defined by OperationServiceExtensions.)
| UpdateOrderComboItems | Update existing order combo items. Order must contain new combo items. (Defined by OperationServiceExtensions.)

Top
See Also

#### Reference

IOperationService Interface
Resto.Front.Api Namespace