Команды

Параметр authenticate определяет необходимость подтверждения перехода в режим возврата:

• при значении true требуется подтверждение операции, необходимо ввести пароль пользователя,
• при значении false подтверждение не требуется. Значение по умолчанию.

Параметром backReasons задается код причины возврата (можно указать через запятую)

главное меню, формирование документа, возврат

Параметр authenticate определяет необходимость подтверждения перехода в режим возврата:

• при значении true требуется подтверждение операции, необходимо ввести пароль пользователя,
• при значении false подтверждение не требуется. Значение по умолчанию.

Параметром backReasons задается код причины возврата (можно указать через запятую).

Параметр department указывает код отдела

Параметром valutcode задается код валюты.

Параметр showPrintSlipDialog позволяет задавать поведение программы при запросе баланса:

• при значении true после получения баланса на экран будет выведен диалог с балансом карты и вопросом необходимо ли распечатать банковскую квитанцию,
• при значении false банковская квитанция печатается автоматически, на экран сообщение о балансе не выводится. Значение по умолчанию.

главное меню, формирование документа, подытог

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

• при значении single после добавления товара в чек касса переходит в режим формирования чека,
• при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

• при значении single после добавления товара в чек касса переходит в режим формирования чека,
• при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

Параметр substring определяет правило поиска (по умолчанию true):

• при значении true поиск осуществляется по вхождению,
• при значении false поиск выполняется по началу слов.

формирование документа, инвентаризация

COMMAND_CARD

Параметр cardNumber –  номер карты.

Параметр phoneNumber – номер телефона.

Параметра paymentCode – платежный код.

Параметр сardMode – тип карты.

Значения параметра сardMode:

• 0 – Дисконтная,
• 1 – Артикс Бонус,
• 2 – Артикс:Дисконт,
• 5 – Карта Террасофт,
• 6 – Социальная карта,
• 7 – RS.Loyalty,
• 8 – CardLab,
• 9 – Золотая корона,
• 10 – EPS,
• 11 – Loymax,
• 12 – ABMLoyalty,
• 17 – UDS,
• 18 – Plazius,
• 19 – Manzana2019,
• 20 – KilBil,
• 21 – Единая Карта Петербуржца,
• 23 – Manzana Loyalty Online,
• 24 – Mindbox.

Параметр source – источник ввода.

Значения параметра source:

• 0 – не определено,
• 1 – вручную,
• 2 – сканер штрих-кода,
• 4 – ридер магнитных карт,
• 8 – банковский терминал,
• 16 – получение данных с удаленного сервера,
• 32 – получение данных от процессинга.

Параметр cardNumberType – параметр для идентификации способа ввода информации о клиенте в системе лояльности.

Значения параметра cardNumberType. Идентифицировать по:

• 0 – номеру карты лояльности,
• 1 – номеру телефона клиента (11 цифр, номер начинается с 7),
• 2 – номеру купона,
• 4 – номеру карты, полученному через банковский терминал (используется при наличии параметра valutcode),
• 5 – карте, добавленной через процессинг (используется при наличии параметра valutcode),
• 6 – платежному коду,
• 7 – номеру карты/номеру телефона/платежному коду.

Параметр valutcode – код валюты.

Параметр dialogtitle – заголовок диалога ввода номера карты.

Параметр dialogmessage – текст сообщения диалога ввода номера карты.

Параметр dialoginputmask – маска ввода номера карты.

Параметр dialoginputpattern – шаблон ввода.

Параметр dialogokbuttonmsgid – текст на кнопке подтверждения.

Параметр dialogcancelbuttonmsgid – текст на кнопке отмены.

Параметр forcedverifiedinput – принудительный ввод верифицированного значения (true/false).

Параметр fillCardOwnerInfo – определяет необходимость заполнения данных о владельце карты лояльности (true/false).

Параметр allowScanCard – включение сканера при отображении диалога ввода карты в подытоге при запрете сканирования данных в подытоге (forbidScanInSubtotal = true). Работает только со значением 1

формирование документа, сдача по документу, подытог

формирование документа

Параметр display определяет способ вывода информации о балансе карты:

• 1 – информация о балансе карты будет выведена на экран,
• 2 – информация о балансе будет напечатана на квитанции,
• 3 – информация о балансе будет выведена на экран и напечатана на квитанции,
• другие значения – информация о балансе будет выведена на экран.

Параметры cardNumberType и cardMode используются для получения информации о клиенте онлайн.

Параметр cardNumberType – способ ввода карты:

• 0 или не указано – по номеру карты лояльности,
• 1 – по номеру телефона клиента (11 цифр, номер начинается с 7).

Параметр cardMode – тип карты:

• 1 – Артикс Бонус.

формирование документа, сдача по документу, подытог

Параметр clientNotRequired определяет, требуется ли заполнение полей клиента (true/false).

Параметр phoneNumber – номер телефона клиента

Параметр url (со значением http://<хост>:<порт>/v1/changecard/src_cardnumber) – адрес сервиса замены карт, является обязательным.

Параметр timeout – таймаут ожидания ответа от сервера в секундах. Значение по умолчанию 5 секунд

формирование документа

Параметр display определяет способ вывода информации о балансе сертификата:

• 1 – информация о балансе сертификата будет выведена на экран,
• 2 – информация о балансе будет напечатана на квитанции,
• 3 – информация о балансе будет выведена на экран и напечатана на квитанции,
• другие значения – информация о балансе будет выведена на экран.

формирование документа

Параметр kkm используется для указания ФР, на котором будет сделана коррекция расхода (число, если не указано значение single):

• single – использовать первый ФР,
• конкретный номер ФР.

COMMAND_CORRECTION_SALE

Параметр kkm используется для указания ФР, на котором будет сделана коррекция расхода (число, если не указано значение single):

• single – использовать первый ФР,
• конкретный номер ФР.

Параметр deleteAllCoupons – определяет возможность удаления всех купонов в чеке, которые были добавлены на гашение:

• при значении параметра true удаляются все купоны в чеке. Значение по умолчанию,
• при значении параметра false необходимо ввести штрих-код купона для удаления.

формирование документа

Параметр mode со значением last аннулирует последний закрытый документ продажи в смене (если такой есть).

При других значениях (или если параметр mode не задан) – открывается список документов текущей смены для выбора документа для аннулирования

главное меню, формирование документа, работа с закрытым документом

Параметр type – тип транспортного модуля.

Значения параметра:

• excise – для приема ТТН акцизного алкоголя,
• nonexcise – для приема ТТН неакцизного алкоголя.

Если работа с ТТН ведется через один транспортный модуль, то указывать параметр type не требуется

главное меню

Применяется для системы лояльности EPS.

Параметр cardmode = 10

главное меню

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

Параметр hotKeyCode задается кодом горячей клавиши.

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

• при значении true на месте таких товаров будут проставлены прочерки. Значение по умолчанию,
• при значении false такие товары будут скрыты.

формирование документа, инвентаризация

Параметр code — код скидки.

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

• при значении true используется код скидки,
• при значении false используется код акции.

Параметр message – выводимое сообщение при подтверждении скидки

Параметр kkm используется для указания ФР, в который будет сделано внесение:

• single – использовать первый ФР,
• конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню

Параметр kkm используется для указания ФР, из которого будет сделан выем:

• single – использовать первый ФР,
• конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню

Параметр kkm используется для указания ФР, из которого будет сделан выем:

• single – использовать первый ФР,
• конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

Параметр kkm используется для указания ФР, из которого будет сделан выем:

• single – использовать первый ФР,
• конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню

Параметр dialogtitle – заголовок диалога ввода идентификатора онлайн-чека.

Параметр dialogmessage – текст сообщения диалога идентификатора онлайн-чека

формирование документа

формирование документа

Параметр roles определяет список ролей, для которых доступно выполнение операции.

Параметр url определяет действие, задаваемое командой

Параметр showProgress отвечает за отображение прогресс-бара при выгрузке продаж при закрытии смены:

• при значении true прогресс-бар отображается,
• при значении false прогресс-бар не отображается.

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

Параметр mode определяет возможность применения модификатора "Цена" автоматически:

• при значении 1 – модификатор будет применен автоматически,
• при других значениях (или если параметр mode не задан) – модификатор необходимо применить вручную.

Параметр discType определяет тип ставки при применении скидки в модификаторе цены товара:

• при значении 1 (или если параметр не задан)– процентная,
• при значении 2 – суммовая.

Параметр precision определяет точность округления цены после расчета скидки – число знаков после запятой. Принимает значения 0,1,2. Если параметр не задан, то будет использована точность округления со значением 2.

формирование документа

Параметр catalogCode – код каталога, который содержит товары из прайс-листа

формирование документа

Параметр canceled определяет вид последнего документа, копию которого необходимо распечатать:

• при значении 1 или true при печати учитывается наличие сторнированных документов,
• при значениях 0, false или отсутствии параметра печатаются только закрытые документы, сторнированные чеки не учитываются.

главное меню, формирование документа, работа с закрытым документом

Параметр reportName определяет тип отчета, копия которого будет распечатана:

• при значении frzreport будет распечатана копия сохраненного фискального Z-отчета,
• при значении frxreport будет распечатана копия сохраненного фискального X-отчета.

главное меню

Параметр useLastDocument определяет, какой документ будет напечатан:

• при значении true будет напечатан УПД для последнего закрытого чека,
• при значении false / отсутствии параметра будет предложено выбрать смену и документ.

все режимы

Параметр status определяет, какие электронные рецепты будут отображены в окне просмотра:

• при значении active будет сформирован список активных электронных рецептов,
• при значении completed будет сформирован список электронных рецептов, по которым лекарственные препараты были отпущены полностью.

формирование документа

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

На данный момент используется только для СПБ Альфа-Банк.

главное меню

Параметр authenticate определяет необходимость подтверждения перехода в режим возврата:

• при значении true требуется подтверждение операции, необходимо ввести пароль пользователя,
• при значении false подтверждение не требуется. Значение по умолчанию.

Параметр device — имя весов.

Параметр taracatalog – код каталога, который содержит товары, являющиеся упаковкой (Продажа товара с выбором упаковки).

Параметр addTaraPosition определяет возможность добавления в чек выбранной упаковки отдельной позицией:

• при значении true упаковка будет добавлена отдельной позицией,
• при значении false упаковка не будет добавлена отдельной позицией. Значение по умолчанию.

Параметр base – группа весового товара (передается в систему распознавания товаров только при отключенном асинхронном режиме, см. Системы распознавания товаров)

формирование документа, инвентаризация

Параметр substring определяет правило поиска:

• при значении true поиск осуществляется по вхождению,
• при значении false поиск выполняется по началу слов.

формирование документа

Параметр orderBy со значением name определяет сортировку списка товаров в алфавитном порядке.

Если параметр не указан, то сортировка осуществляется по штрих-коду

формирование документа, инвентаризация

Параметр choiceType задает способ выбора товара:

• byname – выбор товара по наименованию,
• bybarcode – выбор товара по штрих-коду.

Параметр substring определяет правило поиска:

• при значении true поиск осуществляется по вхождению,
• при значении false поиск выполняется по началу слов.

все режимы

Параметр notAskConfirm — сторнировать все позиции без диалога-подтверждения (true/false).

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

Параметр sumRestrictions определяет список ограничений для каждой из ролей по сумме позиции или чека. Используется формат "код роли:сумма"

возврат, операции с деньгами, формирование документа, подытог, инвентаризация, главное меню, заказ

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

Параметр sumRestrictions определяет список ограничений для каждой из ролей по сумме позиции или чека. Используется формат "код роли:сумма"

возврат, операции с деньгами, формирование документа, подытог, инвентаризация, главное меню, заказ

Параметр kkm используется для указания ФР, из которого будет сделан выем:

• single – использовать первый ФР,
• конкретный номер ФР.

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

• при значении single после добавления товара в чек касса переходит в режим формирования чека,
• при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

Параметр substring определяет правило поиска:

• при значении true поиск осуществляется по вхождению,
• при значении false поиск выполняется по началу слов.

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

• при значении single после добавления товара в чек касса переходит в режим формирования чека,
• при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

• при значении single после добавления товара в чек касса переходит в режим формирования чека,
• при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

Параметр orderBy со значением name определяет сортировку списка товаров в алфавитном порядке.

Если параметр не указан, то сортировка осуществляется по штрих-коду.

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

• при значении single после добавления товара в чек касса переходит в режим формирования чека,
• при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

Параметр nofiscalreport (не имеет значений) позволяет запретить печать программного и фискального X-отчетов при закрытии покупюрной ведомости:

• если параметр указан, то при закрытии покупюрной ведомости печать программного и фискального X-отчетов не осуществляется,
• если параметр не указан, то при закрытии покупюрной ведомости осуществляется печать программного и фискального X-отчетов.

Параметр valutcode – код валюты для выполнения сверки итогов.

Параметр ignoreErrors определяет игнорирование ошибок во время выполнения сверки итогов:

• при значении true ошибки будут игнорироваться,
• при значении false на экран будут выведены сообщения об ошибках. Значение по умолчанию.

Если параметры не указаны, то сверка итогов выполняется для всех настроенных процессингов до первой ошибки

главное меню, формирование документа, закрытие смены

Параметр url – ссылка на стартовую страницу.

Параметр showCursor определяет отображение курсора мыши:

• при значении true курсор мыши отображается. Значение по умолчанию,
• при значении false курсор мыши не отображается.

Параметр codePage – кодовая страница, используется для отображения локальных файлов. Значение по умолчанию "UTF-8".

Параметр printService используется для работы сервиса печати xml-документа в браузере. В качестве значения параметра указывается порт, на котором будет работать сервис.

Параметр showDigitalKeyboard позволяет использовать в touch-интерфейсе цифровую клавиатуру вместо полноразмерной:

• при значении true используется цифровая клавиатура,
• при значении false используется полноразмерная клавиатура. Значение по умолчанию.

Параметр lockDelay позволяет не блокировать работу кассы в браузере:

• при значении true не срабатывает автоматическая блокировка кассы,
• при значении false срабатывает автоматическая блокировка кассы. Значение по умолчанию.

сдача по документу, формирование документа, подытог, главное меню