JS KkmServer

Class: KkmServer

KkmServer

new KkmServer(user, password [, urlServer])

Класс для взаимодействия с API

Методы класса можно разделить на группы
Внутренние:
  • funXxx - встроенные обработчики AJAX
Публичные:
  • CommandXxx - возвращают структуру данных для передачи серверу, которую можно модифицировать
  • doXxx - выполняют сразу нужную операцию
  • hookXxx - установить свои обработчики для AJAX
  • setXxx - устанавливают параметры по умолчанию для команд
  • execute - посылает ajax запрос серверу с тонкой настройкой
Через посредника:
  • чеки - отдельный класс KkmCheck
Конструктор принимает параметры подключения к серверу :
Parameters:
Name Type Argument Description
user string Имя пользователя
password string Пароль
urlServer string <optional>
 Адрес сервера
Example
var kkm = new KkmServer('Admin', '','http://localhost:5893/').hookAjaxSuccess(ExecuteSuccess);
kkm.doOpenShift();

Members

lastCommand :KkmCommand|KkmCommandWithCashier|KkmCommandWithAmount|KkmCommandList|KkmCommandCheck|null

Последняя посланная серверу команда. Только для отладки.
Type:

Methods

CommandCheck(typeCheck)

Регистрация чека с дополнительными методами
см. описание возвращаемого класса
Parameters:
Name Type Description
typeCheck
Since:
  • 0.2.5
Returns:
Type
KkmCheck

CommandDepositingCash(amount [, cashierName] [, numDevice])

Команда Внесение денег в кассу
Parameters:
Name Type Argument Description
amount number Сумма
cashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
See:
  • CommandPaymentCash
Returns:
Type
KkmCommandWithAmount

CommandGetDataKKT( [numDevice])

Команда Получение данных KKT
Parameters:
Name Type Argument Description
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

CommandGetRezult( [idCommand] [, numDevice])

Команда Запрос результата выполнения команды
Parameters:
Name Type Argument Description
idCommand string <optional>
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

CommandList()

Команда Список подключенных устройств
See:
Returns:
Type
KkmCommandList

CommandOfdReport( [numDevice])

Команда Печать состояния обмена с ОФД
Parameters:
Name Type Argument Description
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

CommandOpenCashDrawer( [numDevice])

Команда Открыть денежный ящик
Parameters:
Name Type Argument Description
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

CommandOpenShift( [CashierName] [, numDevice])

Команда Окрыть смену
Parameters:
Name Type Argument Description
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithCashier

CommandPaymentCash(Amount [, CashierName] [, numDevice])

Команда Выемка наличных
Parameters:
Name Type Argument Description
Amount number Сумма
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithAmount

CommandRegisterCheck(typeCheck)

Базовая регистрация чека
см. описание возвращаемого класса
Parameters:
Name Type Description
typeCheck
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck

CommandXReport( [CashierName] [, numDevice])

Команда Печать Х-отчета
Parameters:
Name Type Argument Description
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithCashier

CommandZReport( [CashierName] [, numDevice])

Команда Закрытие смены
Parameters:
Name Type Argument Description
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithCashier

doDepositingCash(Amount [, CashierName] [, numDevice])

Внесение денег в кассу
Parameters:
Name Type Argument Description
Amount number Сумма
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithAmount

doGetDataKKT( [numDevice])

Получение данных KKT
Parameters:
Name Type Argument Description
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

doGetList()

Список ККТ подключенных к серверу
Returns:
Type
KkmCommand

doGetRezult( [idCommand] [, numDevice])

Запрос результата выполнения команды
Parameters:
Name Type Argument Description
idCommand string <optional>
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

doOfdReport( [numDevice])

Печать состояния обмена с ОФД
Parameters:
Name Type Argument Description
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

doOpenCashDrawer( [numDevice])

Открыть денежный ящик
Parameters:
Name Type Argument Description
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

doOpenShift( [cashierName] [, numDevice])

Окрыть смену
Parameters:
Name Type Argument Description
cashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithCashier

doPaymentCash(Amount [, CashierName] [, numDevice])

Выемка наличных
Parameters:
Name Type Argument Description
Amount number Сумма
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommandWithAmount

doXReport( [CashierName] [, numDevice])

Печать Х-отчета
Parameters:
Name Type Argument Description
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

doZReport( [CashierName] [, numDevice])

Закрытие смены
Parameters:
Name Type Argument Description
CashierName string <optional>
 имя кассира
numDevice number <optional>
 устройство
Returns:
Type
KkmCommand

execute(command [, successHook] [, errorHook])

Передача команды серверу .
Parameters:
Name Type Argument Description
command KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck Структура для передачи серверу
successHook <optional>
 по умолчанию обработчик объявленый через hookAjaxSuccess
errorHook <optional>
 по умолчанию обработчик объявленый через hookAjaxFail
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck

hookAjaxFail(errorHook)

Назначить обработчик ошибки запроса
Parameters:
Name Type Description
errorHook funError callback
See:
  • исходный код funError
Returns:
Type
KkmServer

hookAjaxSuccess(successHook)

Назначить обработчик успешного запроса к серверу по умолчанию
Parameters:
Name Type Description
successHook KkmServer~KkmApiСallback функция обработчик
See:
  • исходный код funSuccess
Returns:
Type
KkmServer

setCashierName(cashierName)

Кассир по умолчанию
Parameters:
Name Type Description
cashierName string ФИО
Returns:
Type
KkmServer

setInnKkm(innKkm)

Инн кассы по умолчанию (для исполнения команды ищется ккт, зарегистрированная на этот инн)
Parameters:
Name Type Description
innKkm string
Returns:
Type
KkmServer

setKeySubLicensing(key)

СубЛицензия
Parameters:
Name Type Description
key string
Returns:
Type
KkmServer

setKktNumber(kktNumber)

Для исполнения команды будет использована ккт с этим заводским номером
Parameters:
Name Type Description
kktNumber string
Returns:
Type
KkmServer

setNumDevice(numDevice)

Номер Устройства по умолчанию
Parameters:
Name Type Description
numDevice number целое 0-9
Returns:
Type
KkmServer

<inner> funError(xhr, status)

Встроенный обработчик ошибки сети при запросе к серверу
Parameters:
Name Type Description
xhr
status
See:
  • назначить свой hookAjaxFail

<inner> funSuccess(result)

Встроенный обработчик успешного запроса к серверу
Parameters:
Name Type Description
result KkmResponse | object
See:
  • назначить свой hookAjaxSuccess

Type Definitions

KkmApiСallback(ответ)

Описание интерфейса для функции обратного вызова
Parameters:
Name Type Description
ответ KkmResponse от АПИ
See: