Программно-технический комплекс Pirit k инструкция по программированию Версия

Скачать 0.81 Mb.

Название	Программно-технический комплекс Pirit k инструкция по программированию Версия
страница	6/13
Тип	Инструкция

rykovodstvo.ru > Руководство эксплуатация > Инструкция

1 2 3 4 5 6 7 8 9 ... 13

3.4 Команды основных операций ККТ

3.4.1 Распечатать отчет без гашения (X-отчет) (0x20)

Функция: int libPrintXReport(const char* nameCashier);

Входные параметры: nameCashier (Имя оператора) Код и/или имя оператора

Ответные параметры: (Целое число) Код ошибки.

3.4.2 Распечатать отчет с гашением (Z-отчет) (0x21)

Функция: int libPrintZReport(const char* nameCashier, int options);

Входные параметры: nameCashier (Имя оператора) Код и/или имя оператора, options (Целое число) Опции отчета.

Если параметр “Опции отчета” равен 11, печатается краткий Z-отчет, иначе параметр игнорируется.

Ответные параметры: (Целое число) Код ошибки.

3.4.3 Открыть документ (0x30)

Функция: int libOpenDocument(unsigned char type, unsigned char numDepart, const char* nameCashier);

Эта команда открывает новый документ и переводит ККТ в режим ввода документа.

После успешного выполнения этой команды во внутренней переменной «статуса документа» устанавливается соответствующий тип текущего документа. Этот статус можно получить по команде “Запрос флагов статуса ККТ”.

Входные параметры: type (Целое число)Режим и тип документа, numDepart (Целое число1..99)Номер отдела, nameCashier (Имя оператора)Код и/или имя оператора, (Целое число)Номер документа

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

Режим и тип документа
№ бита	Значение	Комментарий
0	1-Сервисный документ 2-Чек на продажу 3-Чек на возврат 4-Внесение в кассу 5-Изъятие	Младший полубайт задает тип открываемого документа
1
2
3
4	0	Обычный режим формирования документа
4	1	Пакетный режим формирования документа
5	0	Обычный режим печати реквизитов
5	1	Режим отложенной печати реквизитов

В пакетном режиме формирования документа, при успешном выполнении команд формирования чека (с кодами 40..49,52) , ответ на команду не посылается. Если к.л. команда выполняется с ошибкой, то на нее возвращается стандартный ответ с кодом ошибки и последующие команды формирования чека (с кодами 40..49,52) игнорируются до команд “Завершить документ” или “Аннулировать документ”. Такой документ должен быть аннулирован или повторен, начиная с команды вернувшей ошибку в обычном режиме формирования документа, после подачи команды ”Завершить документ”.

Номер отдела- число от 1 до 99, которое сохраняется в ЭКЛЗ

Номер документа- При установке бита в таблице настроек ККТ «Нумерация чеков со стороны внешней программы» в значение «1», передается номер чека, в других ситуациях параметр игнорируется.

Ответные параметры: (Целое число) Код ошибки.

3.4.4 Завершить документ (0x31)

Функция: MData libCloseDocument(unsigned char cutPaper);

Входные параметры: cutPaper (Целое число) Флаг отрезки.

Если параметр “Флаг отрезки” = 1, отрезка сервисных документов по завершению не выполняется.

Если параметр “Флаг отрезки” = 5, отрезка чеков продажи и возврата по завершению не выполняется.

Ответные параметры: (Структура MData) Ответ от ФР, который содержит: (Целое число) Сквозной номер документа, (Строка) Операционный счетчик, (Строка) Строка КПК.

Строка КПК возвращается только при завершении чеков на продажу и возврат.

В пакетном режиме формирования документа, команда “Завершить документ” выключает пакетный режим, Если в пакетном режиме ошибка возникла ранее команды “Завершить документ”, то ответ команду “Завершить документ” не возвращается. Можно продолжить формирование документа, начиная с команды вернувшей ошибку, обычном режиме.

3.4.5 Аннулировать документ (0x32)

Функция: int libCancelDocument();

Эта команда прерывает формирование текущего документа, данные удаляются из оперативной памяти ККТ и печатается сообщение об аннулировании.

Входные параметры: нет.

Ответные параметры: (Целое число) Код ошибки.

3.4.6 Отложить документ (0x33)

Функция: int libPostponeDocument(const char* info);

Эта команда работает аналогично команде “Аннулировать документ”, но подается в случаях, когда документ отменяется не на всегда, а будет обязательно повторно введен, в течении данной смены. Данные документа удаляются из оперативной памяти ККТ и печатается причина отказа от чека.

Используя параметры печати Z-отчета в “Таблица настроек ККТ”, можно настроить в Z-отчете печать информации по отложенным за смену чекам. При этом, если команда «Отложить чек» выполняется без параметра(пустая строка), то такие чеки учитываются в Z-отчете, если с параметром – не учитываются.

Входные параметры: info (Строка[40]) Причина отказа от чека.

Ответные параметры: (Целое число) Код ошибки.

3.4.6 Отрезать документ (0x34)

Функция: int libCutDocument();

Эта команда выполняет принудительную отрезку документа с предпечатью.

Входные параметры: нет.

Ответные параметры: (Целое число) Код ошибки.

3.4.8 Печать текста (0x40)

Функция: int libPrintString(char* textStr, unsigned char attribute);

C помощью данной команды печатается текст внутри открытого сервисного документа.

Входные параметры: textStr (Строка[1..72]) Текст, attribute (Целое число)Атрибуты текста

Атрибуты текста – опциональный параметр, представляющий собой битовую маску, значения которой приведены в таблице:

№ бита	Значения атрибутов текста
0..3 (N:шрифта)	0 –Шрифт 13х24
	1 –Шрифт 10х20
	2–Шрифт 13х24 жирный
	3 –Шрифт 10х20 жирный
	4 –Шрифт 8х14
	5 –Шрифт 24х45
	6 –Шрифт 24х45 жирный
4	Печать двойной высоты текста
5	Печать двойной ширины текста
6	Не используется
7	Не используется

Ответные параметры: (Целое число) Код ошибки.

3.4.9 Печатать штрих-код (0x41)

Функция: int libPrintBarCode(unsigned char posText, unsigned char widthBarCode, unsigned char heightBarCode, unsigned char typeBarCode, const char* barCode);

С помощью данной команды можно распечатать штрих-код товара.

Входные параметры: posText (Целое число)Вывод текста, widthBarCode (Целое число)Ширина штрих-кода, heightBarCode (Целое число)Высота штрих-кода, typeBarCode (Целое число)Тип штрих-кода, barCode (Строка)Штрих-код.

Вывод текста (только для линейных кодов):

0-не выводить;

1-вывести наверху штрих-кода;

2-вывести внизу;

3-вывести наверху и внизу;

Ширина штрих-кода - значение задается в точках и может быть от 2 до 8.

Для UPC-A и EAN-13 максимальная ширина штрих-кода = 6, для остальных кодов зависит от длины параметра “Штрих-код”.

Высота штрих-кода - значение задается в точках и может принимать значения от 1 до 255 (только для линейных кодов).

Тип штрих-кода - Определяет, какой штрих-код будет напечатан. Длина и набор символов определяется типом штрих-кода:

0 - UPC-A;

1 - UPC-E;

2 - EAN-13;

3 - EAN-8;

4 - Code 39;

5 - Interleaved 2 of 5;

6 - Codabar.

7 – PDF417.

8 – QR CODE.

Штрих-код- строка содержащая штрих-код, причем контрольная сумма может и не указываться.

Ответные параметры: (Целое число) Код ошибки.

3.4.10 Добавить товарную позицию (0x42)

Функция: int libAddPosition(const char* goodsName, const char* barcode, long quantity, long price, unsigned char taxNumber, int numGoodsPos, unsigned char numDepart);

Эта команда может быть вызвана сразу после открытия чека и может повторяться любое количество раз внутри текущего документа для отражения всего списка товаров. Если позиция не может быть добавлена в ЭКЛЗ, на чеке после данных о позиции печатается строка ”ОПЕРАЦИЯ ОТМЕНЕНА” и возвращается соответствующий код ошибки ЭКЛЗ.

Входные параметры: goodsName (Строка[0..224]) Название товара, barcode (Строка[0..18]) Артикул или штриховой код товара/ номер ТРК, quantity (Целое число) Количество товара в товарной позиции в 1/1000, price (Целое число) Цена товара по данному артикулу в копейках, taxNumber (Целое число 0..5) Номер ставки налога, numGoodsPos (Целое число 0..4) Номер товарной позиции, numDepart (Целое число 1..16) Номер секции.

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

Параметры ”Номер ставки налога”, ”Номер товарной позиции” и “Номер секции” не являются обязательными и могут, быть пустыми. Если номер секции отсутствует (или равен нулю), учет ведется на номер отдела, указанный при открытии документа.

Ответные параметры: (Целое число) Код ошибки.

3.4.11 Сторнировать товарную позицию (0x43)

Функция: int libDelPosition(const char* goodsName, const char* barcode, long quantity, long price, unsigned char taxNumber, int numGoodsPos, unsigned char numDepart);

Эта команда может сторнировать любую товарную позицию в чеке. Если позиция не может быть сторнирована в ЭКЛЗ, на чеке после данных о позиции печатается строка ”ОПЕРАЦИЯ ОТМЕНЕНА” и возвращается соответствующий код ошибки ЭКЛЗ.
Входные параметры: goodsName (Строка[0..224]) Название товара, barcode (Строка[0..18]) Артикул или штриховой код товара/ номер ТРК, quantity (Целое число) Количество товара в товарной позиции в 1/1000, price (Целое число) Цена товара по данному артикулу в копейках, taxNumber (Целое число 0..5) Номер ставки налога, numGoodsPos (Целое число 0..4) Номер товарной позиции, numDepart (Целое число 1..16) Номер секции.

Параметры ”Номер ставки налога”, ”Номер товарной позиции” и “Номер секции” не являются обязательными и могут отсутствовать. Если номер секции отсутствует (или равен нулю), учет ведется на номер отдела, указанный при открытии документа.

Ответные параметры: (Целое число) Код ошибки.

3.4.12 Подытог (0x44)

Функция: int libSubTotal();

Эта команда заканчивает ввод товаров в чеке. Команда «Подитог» может даваться дважды.

После первой команды «Подитог» становится невозможно добавлять новые позиции в чек. Далее можно установить скидки/наценки на весь чек, зарегистрировать суммы налогов, распечатать дополнительные реквизиты, прервать оформление чека командами «Отложить чек» и «Аннулировать чек» или продолжить оформление с использованием повторной команды «Подитог» или команды «Оплата».

После повторной команды «Подитог», документ переходит в состояние оплаты. Далее мы можем распечатать дополнительные реквизиты, прервать оформление чека командами «Отложить чек» и «Аннулировать чек», либо продолжить оформление документа, выполнив команду «Оплата» и команду «Завершить документ».

Входные параметры: нет.

Ответные параметры: (Целое число) Код ошибки.

3.4.13 Скидка на товар/чек (0x45)

Функция: int libAddDiscount(unsigned char typeDiscount, const char* nameDiscount, long sum);

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

Для установки скидки на товар команда должна быть вызвана непосредственно после команды “Добавить товарную позицию” и для отмены скидки, после команды “ Сторнировать товарную позицию”.

Для установки скидки на весь чек команда вызывается после первой команды “Подитог ”

Входные параметры: typeDiscount (Целое число) Тип скидки, nameDiscount (Строка[0..38]) Название скидки, sum (Дробное число) Процент (в тысячных долях процента) или сумма скидки(в копейках).

Тип скидки:

0- процентная скидка;

1- скидка на сумму;

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

Ответные параметры: (Целое число) Код ошибки.

3.4.14 Наценка на товар/чек (0x46)

Функция: int libAddMargin(unsigned char typeDiscount, const char* nameDiscount, long sum);

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

Для установки наценки на товар команда должна быть вызвана непосредственно после команды “Добавить товарную позицию” и для отмены наценки, после команды “ Сторнировать товарную позицию”.

Для установки наценки на весь чек команда вызывается после первой команды “Подитог ”

Входные параметры: typeDiscount (Целое число) Тип скидки, nameDiscount (Строка[0..38]) Название скидки, sum (Целое число) Процент (в сотых долях процента) или сумма скидки(в копейках).

Тип наценки:

0- процентная наценка;

1- наценка на сумму;

Ответные параметры: (Целое число) Код ошибки.

3.4.15 Оплата (0x47)

Функция: int libAddPayment(unsigned char typePayment, long sum, const char* infoStr);

С помощью этой команды производится фиксирование всех взаиморасчетов с клиентом с указанием сумм и типов оплаты. При первом использовании этой команды в чеке печатается «Итоговая сумма», что является окончательной суммой чека. После этого производить скидки на чек нельзя.

При передаче суммы наличными, больше требуемой, ККТ самостоятельно рассчитывает сдачу. Сумма по безналичным типам платежа (с кодами от 1 до 15), не должна превышать итоговой суммы по чеку.

Входные параметры: typePayment (Целое число 0..15) Код типа платежа, sum (Целое число) Сумма, принятая от покупателя по данному платежу в копейках, infoStr (Строка[0..40]) Дополнительный текст.

Код типа платежа должен соответствовать одному из запрограммированных средств оплаты в “Таблице настроек ККТ”.

Ответные параметры: (Целое число) Код ошибки.

3.4.16 Внесение / изъятие суммы (0x48)

Функция: int libCashInOut(const char* infoStr, long sum);

Команда регистрирует внесение или изъятие суммы денег из денежного ящика.

Команда выполняется после команды “Открыть документ”. Если производится внесение денег, тип документа должен быть 4, если изъятие - 5.

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

Входные параметры: infoStr (Строка[0..40]) Название или тип купюры, sum (Целое число) Сумма в копейках.

Ответные параметры: (Целое число) Код ошибки.

3.4.17 Печать реквизита (0x49)

Функция: int libPrintRequsit(unsigned char codeReq, unsigned char attributeText, const char* str1,const char* str2,const char* str3,const char* str4);

C помощью данной команды могут печататься дополнительные реквизиты чека, при открытом чеке на продажу, возврат, внесения или изъятия.

Входные параметры: codeReq (Целое число) Код реквизита, attributeText (Целое число)Атрибуты текста, str1 (Строка[1..72]) Значение реквизита 1-я строка, str2 (Строка[0..72]) Значение реквизита 2-я строка, str3 (Строка[0..72]) Значение реквизита 3-я строка, str4 (Строка[0..72]) Значение реквизита 4-я строка.

Код реквизита должен соответствовать одному из запрограммированных наименований реквизита в “Таблице настроек ККТ”. Если значение реквизита обеспечивает однозначное его толкование, его можно распечатать без предварительно запрограммированного наименования, с кодом реквизита равным нулю. Для печати всех запрограммированных реквизитов поставщика услуг, код реквизита должен быть равен 10.

Атрибуты текста – параметр, представляющий собой битовую маску, значения которой приведены в таблице:

№ бита	Значения атрибутов текста
0..3 (N:шрифта)	0 –Шрифт 13х24
	1 –Шрифт 10х20
	2–Шрифт 13х24 жирный
	3 –Шрифт 10х20 жирный
	4 –Шрифт 8х14
	5 –Шрифт 24х45
	6 –Шрифт 24х45 жирный
4	Печать двойной высоты текста
5	Печать двойной ширины текста
6	Не используется
7	Не используется

Значение реквизита может состоять из 4-х строк, при этом 1-я строка значения реквизита печатается непосредственно за наименованием реквизита в одну строку. Общая длина наименования и значения реквизита составляет не более 4-х строк.

Если значение реквизита состоит из одной строки и первым символом является символ '&', то перевод строки после печати данного реквизита не выполняется, можно на этой же строке начать печать следующего реквизита.

Ответные параметры: (Целое число) Код ошибки.

3.4.18 Зарегистрировать сумму по отделу (0x50)

Функция: int libRegisterSumToDepart(unsigned char typeOperation, unsigned char numberDepart, long sum);

Команда регистрирует сумму по указанному отделу для одного из типов операции продажа или возврат. Эта команда может быть вызвана после любой команды.

Для печати итоговых сумм по отделам на Z-отчете необходимо запрограммировать заголовок группы отделов в “Таблице настроек ККТ”.

Входные параметры: typeOperation (Целое число)Тип операции, numberDepart (Целое число)Номер отдела в “Таблице настроек ККТ”, sum (Целое число) Сумма в копейках.

Тип операции указывает, для какого типа операций регистрируется сумма по товарной группе:

0 – продажи;

1 – возвраты;

Ответные параметры: (Целое число) Код ошибки.

3.4.19 Зарегистрировать сумму налога (0x51)

Функция: int libRegisterTaxSum(unsigned char numberTax, long sum);

Команда регистрирует суммы налогов по запрограммированным налоговым ставкам. Эта команда может быть вызвана после любой команды, если документ открыт.

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

При этом, печать налогов на чеке возможна только при использовании команды «Установить сумму налога» после первой команды «Подитог» и при включении соответствующего параметра в “Таблице настроек ККТ”
Входные параметры: numberTax (Целое число) Номер ставки налога в “Таблице настроек ККТ”, sum (Целое число) Сумма в копейках.

Ответные параметры: (Целое число) Код ошибки.

3.4.19 Сравнить сумму по чеку(0x52)

Функция: int libCompareSum(long sum);

Команда сравнивает текущую сумму по чеку с переданной в параметре и возвращает ошибку “Некорректный формат или параметр команды”, если суммы не совпадают. Эта команда может быть вызвана после любой команды, если документ открыт.

Входные параметры: (Целое число) Сумма в копейках для сравнения.

Ответные параметры: (Целое число) Код ошибки.

3.4.20 Открыть копию чека (0x53)

Функция: int libOpenCopyReceipt(unsigned char type, unsigned char numDepart, const char* nameCashier, int numCheck, int numCash, MPiritDate mpDate, MPiritTime mpTime);

Эта команда открывает копию чека, как сервисный документ, с печатью необходимых реквизитов оригинала чека. Реквизиты оригинала чека передаются во входных параметрах команды. Для формирования тела копии доступны команды: “Печать текста”, “Добавить товарную позицию”, “Подитог”, “Скидка на товар/чек”, “Наценка на товар/чек”, “Оплата”.

Входные параметры: type (Целое число)Тип чека, numDepart (Целое число1..99)Номер отдела, nameCashier (Имя оператора)Код и/или имя оператора, numCheck (Целое число)Номер чека, numCash (Целое число1..9999)Логический номер кассы, mpDate (Дата)Дата чека, mpTime (Время)Время чека.

Тип чека: 2- продажа, 3- возврат.

Ответные параметры: (Целое число) Код ошибки.

3.4.21 Обнулить наличные в денежном ящике (0x54)

Функция: int libSetToZeroCashInCashDrawer ();

Команда обнуляет счетчик наличных в денежном ящике.

Входные параметры: нет.

Ответные параметры: (Целое число) Код ошибки.

3.4.22 Печать графики в документе (0x55)

Функция: int libPrintPictureInDocument(int width, int height, int sm, unsigned char* data);

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

Максимальная ширина изображения при использовании бумаги шириной 80мм – 512 точек(64 мм). Максимальная ширина изображения при использовании бумаги шириной 57мм – 336 точек точек(42 мм). 176 точек слева должны быть без изображения(как показано на рис. 1).

Графика печатается прижатой к левому краю, вне зоны печати фискального логотипа.

Команда выполняется в два этапа.

На первом передается параметры графики для печати.

Входные параметры: width (Целое число) Ширина картинки, height (Целое число) Высота картинки, sm (Целое число) Смещение от левого края, data (Массив байт) изображение аналогичное монохромному BMP.

Если параметр смещение равен 0, картинка прижимается влево. Если параметр смещение равен 1, картинка выравнивается по центру. Если параметр смещение равен 2, картинка прижимается к правой границе зоны печати графики(512 точек).

После печати изображения возвращается стандартный ответ с кодом ошибки.

Ответные параметры: (Целое число) Код ошибки.

3.4.23 Печать загруженной картинки (0x56)

Функция: int libPrintPreloadedPicture(int sm, int number);

Функция используется для печати графики загруженной ранее в память устройства командой “Загрузить графическое изображение (0x18)”.

Входные параметры: sm (Целое число) Смещение, number (Целое число) Номер(всегда =1).

Если параметр смещение равен 0, картинка прижимается влево. Если параметр смещение равен 1, картинка выравнивается по центру. Если параметр смещение равен 2, картинка прижимается к правой границе зоны печати графики(512 точек). Если параметр смещение равен 3 – используется значение смещения, заданное при загрузке.

Ответные параметры: (Целое число) Код ошибки.