Class: KkmCommandCheck

KkmCommandCheck


new KkmCommandCheck( [typeCheck])

Структура запроса к апи для работы с чеком
советую использовать обертку над командой
Parameters:
Name Type Argument Default Description
typeCheck number <optional>
0 Тип чека
See:

Extends

Members


AdditionalProps :Array.<KkmAdditionalCheckProperty>

Дополнительные произвольные реквизиты (не обязательно) пока только 1 строка
Type:
See:

CancelOpenedCheck :boolean

Аннулировать открытый чек если ранее чек небыл завершен до конца (устарело)
Type:
  • boolean
Deprecated:
  • Yes

Cash :number

Наличная оплата
Type:
  • number
See:

CashierName :string|null

ФИО Кассира
Type:
  • string | null
Inherited From:

CashLessType1 :number

Безналичная оплата типа 1 (по умолчанию - Оплата картой)
Type:
  • number
See:

CashLessType2 :number

Безналичная оплата типа 2 (по умолчанию - Оплата кредитом)
Type:
  • number
See:

CashLessType3 :number

Безналичная оплата типа 3 (по умолчанию - Оплата сертификатом)
Type:
  • number
See:

CheckProps :Array.<KkmCheckProperty>

Дополниельные реквизиты чека (не обязательно)
Type:
See:

CheckStrings :Array.<KkmCheckString>

Строки чека
Type:
See:

ClientAddress :string

Телефон или е-Майл покупателя, тег ОФД 1008
Если чек не печатается (NotPrint = true) то указывать обязательно
Type:
  • string
See:

ClientId :string

Это только для тестов
Type:
  • string

Command :string

Название команды, одно из зарегистрированных слов api KkmServer.ru.
необходимые реализованы как методы CommandXXX KkmServer.
Если Вам потребуется не реализованная команда апи LineLength, то ее можно объявить явно.
Type:
  • string
Inherited From:
Example
kkm.execute(new KkmCommand('LineLength')); // не реализованная
// design pattern command
kkm.CommandXReport().setIdCommand('ххх-хххх-ххх').execute();

IdCommand :string

Уникальный идентификатор команды

Любая строока из 40 символов По этому идентификатору можно запросить результат выполнения команды. Поле не обязательно
Type:
  • string
Inherited From:
See:
  • KkmServer#setIdCommand

InnKkm :string

ИНН ККМ. Если "" то ККМ ищется только по NumDevice,
Если NumDevice = 0 а InnKkm заполнено то ККМ ищется только по InnKkm
Type:
  • string
Inherited From:
See:

IsFiscalCheck :boolean

Это фискальный или не фискальный чек
При работе через KkmCheck устанавливается автоматически при вызове методов fiscalXxx(), print() в нужное значение
Type:
  • boolean

KeySubLicensing :string

Kлюч суб-лицензии
Type:
  • string
Inherited From:
See:

KktNumber :string

Заводской номер ККМ для поиска. Если "" то ККМ ищется только по NumDevice
Type:
  • string
Inherited From:
See:
  • KkmServer.setKktNumber

KPP :string

КПП организации, нужно только для ЕГАИС
Type:
  • string
See:

NotPrint :boolean

Не печатать чек на бумагу
Type:
  • boolean
See:

NumberCopies :number

Количество копий документа
Type:
  • number
See:

NumDevice :number|null

Номер устройства 0-9 по умолчанию 0 - первое свободное
Type:
  • number | null
Inherited From:
See:

TaxVariant :null|number

Система налогообложения (СНО) применяемая для чека.

      Если не указанно - система СНО настроенная в ККМ по умолчанию
      0: Общая СНО - ОСН
      1: Упрощенная СНО (Доход)
      2: Упрощенная СНО(Доход минус Расход)
      3: Единый налог на вмененный доход
      4: Единый сельскохозяйственный налог
      5: Патентная система налогообложения
      Комбинация разных СНО не возможна
Надо указываеть если ККМ настроена на несколько систем СНО
Type:
  • null | number
See:

Timeout :number

Время (сек) ожидания выполнения команды.

Если За это время команда не выполнилась в статусе вернется результат "NotRun" или "Run"
Проверить результат еще не выполненной команды можно командой "GetRezult"
Если не указано или 0 - то значение по умолчанию 60 сек.
Это поле можно указвать во всех командах
Type:
  • number
Inherited From:

TypeCheck :number

Тип чека;

Тип чека :
 0 – продажа;                             10 – покупка;
 1 – возврат продажи;                     11 - возврат покупки;
 Для новых ККМ:
 2 – корректировка продажи;               12 - корректировка покупки
 3 – корректировка возврата продажи;      13 - корректировка возврата покупки
Значение передается в конструктор класса KkmCheck
Type:
  • number
Default Value:
  • 0

Methods


addAdditionalProps(print, printInHeader, name, value)

Добавить дополнительное свойство чека
Parameters:
Name Type Description
print boolean печатать
printInHeader boolean печатать в шапке
name string наименование
value string значение тега
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmAdditionalCheckProperty

addBarcodeString(barcodeType, barcode)

Добавление печати штрихкода.
Parameters:
Name Type Description
barcodeType string "EAN13", "CODE39", "CODE128", "QR", "PDF417"
barcode string Значение
Since:
  • 0.2.5 перенесено в базовый класс
See:
Returns:
Type
KkmCheckString
Example
var barString = check.addBarcodeString("EAN13", "1254789547853");
// можно модифицировать сформированную строку
barString.BarcodeType = '';
barString.Barcode = '';

addCheckProps(print, printInHeader, teg, value)

Добаляет данные по тегам
  • 1005 Адрес оператора по переводу денежных средств (Строка 100)
  • 1016 ИНН оператора по переводу денежных средств (Строка 12)
  • 1026 Наименование оператора по переводу денежных средств (Строка 64)
  • 1044 Операция банковского агента (Строка 24)
  • 1045 Операция банковского субагента (Строка 24)
  • 1073 Телефон банковского агента (Строка 19)
  • 1074 Телефон платежного агента (Строка 19)
  • 1075 Телефона оператора по переводу денежных средств (Строка 19)
  • 1082 Телефон банковского субагента (Строка 19)
  • 1083 Телефон платежного субагента (Строка 19)
  • 1119 Телефон оператора по приему платежей (Строка 19)
  • 1117 адрес электронной почты отправителя чека
Parameters:
Name Type Description
print boolean печатать
printInHeader boolean печатать в шапке
teg number номер тега
value string значение тега
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCheckProperty

addImageString(image)

Строка с печатью картинки
Parameters:
Name Type Description
image string Картинка в Base64.
Картинка будет преобразована в 2-х цветное изображение - поэтому лучше посылать 2-х цветный bmp
Since:
  • 0.2.5 перенесено в базовый класс
See:
Returns:
Type
KkmCheckString
Example
check.addImageString('').setImage(demoImage); // можно модифицировать
check.addTextString('текст').setImage(demoImage); // добавить к текстовой строке

addRegisterString(name, quantity, price, amount [, tax] [, department] [, ean13])

Фискальная строка чека
в базовом классе (KkmCommandCheck) только добавление. В KkmCheck с накоплением Total
Parameters:
Name Type Argument Description
name string Название товара
quantity number Количество
price number цена
amount number сумма
tax number <optional>
НДС 0 (НДС 0%), 10 (НДС 10%), 18 (НДС 18%), -1 (НДС не облагается), 118 (НДС 18/118), 110 (НДС 10/110)
department number <optional>
отдел магазина
ean13 string <optional>
штрих код
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCheckString

addTextString(text [, font] [, intensity])

Добавляем текстовую строку
  • <#10#> - При вставке в текст в середину строки символов "<#10#>" Левая часть строки будет выравнена по левому краю, правая по правому, где 10 - это на сколько меньше станет строка ККТ
  • <#10#>> - При вставке в текст в середину строки символов "<#10#>>" Левая часть строки будет выравнена по правому краю, правая по правому, где 10 - отступ от правого края
  • >#10#<текст - сделать строку на 10 символов уже и отцентрировать текст
Parameters:
Name Type Argument Description
text string текст для вывода с управляющими кодами
font number <optional>
Шрифт 1-4 , 0 - по настройкам ККМ
intensity number <optional>
Интесивность 1-15 , 0 - по настройкам ККМ
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCheckString
Example
var string4edit =  check.addTextString('ЗАГОЛОВОК');
string4edit.Text = '>#0#<' + string4edit.Text; // Добавляем центрирование
string4edit.Font=1; // Самый крупный шрифт
string4edit.Intensity = 15;

b(barcodeType, barcode)

Шорткат к addBarcodeString. Поддерживает цепочку вызовов.
Parameters:
Name Type Description
barcodeType string
barcode string
Since:
  • 0.2.5 перенесено в базовый класс
See:
Returns:
Type
KkmCheck

execute( [successHook])

Выполнить

Выполнить для патерна проектирования Команда.
Parameters:
Name Type Argument Description
successHook <optional>
по умолчанию обработчик объявленый через hookAjaxSuccess
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck | *

i(image)

Шорткат к addImageString . Поддерживает цепочку вызовов.
Parameters:
Name Type Description
image string
Since:
  • 0.2.5 перенесено в базовый класс
See:
Returns:
Type
KkmCheck

injectDependencies(kkm)

Внедрение исполнителя команды
Parameters:
Name Type Description
kkm KkmServer
Since:
  • 0.2.5
Inherited From:

r(name, quantity, price, amount [, tax] [, department] [, ean13])

Шоркат к addRegisterString. Поддерживает цепочку вызовов.
Parameters:
Name Type Argument Description
name string
quantity number
price number
amount number
tax number <optional>
department number <optional>
ean13 string <optional>
Since:
  • 0.2.5 перенесено в базовый класс
See:
Returns:
Type
KkmCheck

setAdditionalProps(props)

Установить дополнительные свойства чека
Parameters:
Name Type Description
props Array.<KkmAdditionalCheckProperty>
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck

setCash(cash)

Parameters:
Name Type Description
cash number
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck | KkmCheck

setCashierName(cashierName)

ФИО кассира
Parameters:
Name Type Description
cashierName string
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandCheck

setCashLessType1(cashLessType1)

Parameters:
Name Type Description
cashLessType1 number
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck | KkmCheck

setCashLessType2(cashLessType2)

Parameters:
Name Type Description
cashLessType2 number
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck | KkmCheck

setCashLessType3(cashLessType3)

Parameters:
Name Type Description
cashLessType3 number
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck | KkmCheck

setCheckProps(props)

Установить данные по тегам
Parameters:
Name Type Description
props Array.<KkmCheckProperty>
Since:
  • 0.2.5
Returns:
Type
KkmCommandCheck

setClientAddress(clientAddress)

Телефон или емайл покупателя
Parameters:
Name Type Description
clientAddress string
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCommandCheck | KkmCheck

setIdCommand(idCommand)

Любая строока из 40 символов. По этому идентификатору можно запросить результат выполнения команды.
Parameters:
Name Type Description
idCommand string
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck

setInnKkm(innKkm)

ИНН ККМ. Если "" то ККМ ищется только по NumDevice
Parameters:
Name Type Description
innKkm string
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck

setIsFiscalCheck(isFiscal)

Это фискальный или не фискальный чек
Parameters:
Name Type Description
isFiscal boolean
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCommandCheck | KkmCheck

setKeySubLicensing(keySubLicensing)

Kлюч суб-лицензии
Parameters:
Name Type Description
keySubLicensing string
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand

setKktNumber(kktNumber)

Заводской номер ККМ для поиска. Если "" то ККМ ищется только по NumDevice
Parameters:
Name Type Description
kktNumber string
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck

setKpp(Kpp)

КПП организации, нужно только для ЕГАИС
Parameters:
Name Type Description
Kpp string
Returns:
Type
KkmCheck

setNotPrint(notPrint)

Не печатать чек на бумагу
Parameters:
Name Type Description
notPrint boolean
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCommandCheck | KkmCheck

setNumberCopies(numberCopies)

Количество копий документа
Parameters:
Name Type Description
numberCopies number
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCommandCheck | KkmCheck

setNumDevice(numDevice)

Номер устройства 0-9 по умолчанию 0 - первое свободное
Parameters:
Name Type Description
numDevice number
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck

setSno(sno)

Система налогообложения. где sno
  • 0 | «osn» – общая СН;
  • 1 | «usn_income» – упрощенная СН(доходы);
  • 2 | «usn_income_outcome» – упрощенная СН (доходы минус расходы);
  • 3 | «envd» – единый налог на вмененный доход;
  • 4 | «esn» – единый сельскохозяйственный налог;
  • 5 | «patent» – патентная СН.
Parameters:
Name Type Description
sno number | string Система налогообложения (см. KkmCommandCheck#TaxVariant)
Since:
  • 0.2.5 перенесено в базовый класс
Returns:
Type
KkmCommandCheck | KkmCheck
Example
check.setSno(0);// check.setSno('osn')

setTaxVariant()

Синоним к setSno
Since:
  • 0.2.5 перенесено в базовый класс
See:

setTimeout(timeout)

Максимальное время за которое должна исполниться команда на сервере
Parameters:
Name Type Description
timeout number
Since:
  • 0.2.5
Inherited From:
Returns:
Type
KkmCommand | KkmCommandWithCashier | KkmCommandWithAmount | KkmCommandList | KkmCommandCheck

t(Text, Font, Intensity)

Шорткат к addTextString. Поддерживает цепочку вызовов.
Parameters:
Name Type Description
Text string
Font number
Intensity number
Since:
  • 0.2.5 перенесено в базовый класс
See:
Returns:
Type
KkmCheck