- Created by Юрий Анисимов on 18 Jan 2024
Ниже приведен список объектов, которые могут быть использованы в макросах при редактировании шаблонов документов, текста на экране кассира и т.д.
Окружение
Объект registry
– реестр
Свойство | Тип | Значение |
---|---|---|
checkNumber | числовой | Номер чека |
shiftNumber | числовой | Номер смены |
cashCode | строковый | Код кассы |
shopCode | строковый | Код магазина |
shiftBeg | дата и время | Дата и время начала смены |
Объект shift
– смена
Свойство | Тип | Значение |
---|---|---|
id | числовой | Идентификационный номер смены |
num | числовой | Номер смены |
cashcode | строковый | Код кассы |
shopcode | строковый | Код магазина |
usercode | строковый | Код пользователя (кассира) |
timestart | дата и время | Время начала работы смены |
timeend | дата и время | Время окончания работы смены |
isopened | логический | Смена в кассе:
|
isclosed | логический | Смена в кассе:
|
firstCheckTime | дата и время | Дата и время закрытия первого чека в смене |
Объект status
– текущее состояние работы кассы
Свойство | Тип | Значение |
---|---|---|
userid | строковый | Код пользователя |
username | строковый | Имя пользователя |
usergroup | числовой | Группа (права), в которую входит пользователь |
department | числовой | Отдел |
now | дата и время | Текущая дата и время |
mode | строковый | Режим работы фискального регистратора |
netmode | строковый | Режим работы (сетевой, локальный) |
version | строковый | Версия |
specialState | строковый | Индикатор выполнения специальных функций. Например, если включен режим автоматического взвешивания, то данный параметр имеет значение "ФАСОВКА" |
Документ
Объект document
– документ
Свойство | Тип | Значение |
---|---|---|
id | числовой | Идентификатор документа |
num | строковый | Номер документа |
type | числовой | Тип документа:
|
dept | числовой | Номер отдела |
cashCode | строковый | Код кассы |
cashType | строковый | Тип кассы:
|
shift | числовой | Номер смены документа |
cashierCode | строковый | Код кассира |
dateTimeBeg | дата и время | Дата и время открытия чека |
dateTimeEnd | дата и время | Дата и время закрытия чека |
sum1 | вещественный | Сумма без скидок |
sum2 | вещественный | Сумма без скидок |
sumb | вещественный | Итоговая сумма со скидками |
sumcash | вещественный | Сумма оплаты наличными |
rtext | строковый | Текст для печати на текстовой ленте |
shopOptions | строковый | Опции магазина |
status | числовой | Состояние документа |
workShiftId | числовой | Идентификатор смены |
positionsCount | числовой | Количество позиций |
waresPositionsCount | числовой | Количество позиций товаров |
waresQuantity | числовой | Количество товаров |
urlEgais | строковый | URL ЕГАИС |
digitalSignatureEgais | строковый | Цифровая подпись ЕГАИС |
quantity | вещественный | Суммарное кол-во |
netto | вещественный | Суммарное кол-во весовых товаров без тары |
brutto | вещественный | Суммарное кол-во весовых товаров с тарой |
verifiedAge | строковый | Минимальный возраст покупателя в текущем документе (после подтверждения возраста) |
hasCard | строковый | Карта в чеке:
|
hasActiveCard | строковый | Бонусная карта в чеке:
|
basePaymentName | строковый | Наименование базовой валюты |
identifier | строковый | Идентификатор чека на кассе |
registeredPdfInEgais | строковый | Товар зарегистрирован в ЕГАИС:
|
hasCoupon | строковый | Купон в чеке:
|
hasCouponGiven | строковый | Выдача купона в текущем чеке:
|
shownAlcoholCaution | строковый | Ограничение продажи алкогольной продукции. Если настройка |
basePaymentMode | строковый | Режим базовой валюты |
basePaymentSum | строковый | Сумма оплаты базовой валютой |
consultantName | строковый | Имя консультанта |
currentPosition | строковый | Индекс выделенной пользователем позиции |
frDocNum | строковый | Номер документа из ФР |
frDocCopy | строковый | Копия документа в ФР |
userName | строковый | Имя пользователя |
customerAddress | строковый | Адрес (телефон или email) покупателя |
closeWithoutPrint | строковый | Отказ от печати чека:
Реализовано только на ФР Атол. |
egaisCounter | строковый | Счетчик успешных регистраций в ЕГАИС |
backReasonCode | строковый | Код причины возврата |
actorCode | числовой | Код пользователя, подтверждающего некоторое действие |
sourceIdentifier | строковый | Идентификатор исходного документа при возврате |
addingAllowed | логический | Флаг возможности добавления позиций в документ:
|
databaseStatus | строковый | Статус документа в БД:
|
linkedDocumentId | числовой | Идентификатор связанного документа |
shopLabels | строковый | Получение меток магазина |
shopCode | строковый | Код магазина |
changeSum | вещественный | Сумма сдачи (сумма оплаты – сумма документа) |
paymentSum | вещественный | Сумма оплат в документе |
discWithoutBonus | вещественный | Сумма дисконта без учёта бонусов |
maxSum | вещественный | Максимальная сумма документа |
considerRemain | логический | Флаг учёта остатков:
|
unitePosition | строковый | Настройка объединения позиций (" |
positionsLimit | числовой | Лимит количества позиций в документе |
uniqueIdPattern | строковый | Паттерн образования уникального идентификатора документа |
deptMode | строковый | Настройка разбиения сумм по отделам в возврате по чеку продажи (" |
newCheck | логический | Флаг того, что документ является новым:
|
backMode | логический | Возврата в чеке продажи. Передается "0" независимо от настройки |
wasDeferred | логический | Флаг того, что документ был отложен:
|
deferredSent | логический | Флаг того, что отложенный чек был отправлен на сервер:
|
currentPayableSum | вещественный | Сумма наличной оплаты которая выполняется в данный момент |
currentPaymentSum | вещественный | Сумма оплат в документе + сумма наличной оплаты которая выполняется в данный момент |
countersChanged | строковый | Статус счётчиков дисконта:
|
countersSourceCardNumber | строковый | Номер карты по которой сработали счётчики дисконта |
personalPricesCardNumber | строковый | Номер карты по которой сработали персональные скидки |
fiscalIdentifier | строковый | Фискальный идентификатор документа |
correctionReasonCode | числовой | Код основания документа коррекции |
correctionSourceDocumentNumber | строковый | Идентификатор исходного документа для коррекции |
correctionSourceDocumentDate | дата | Не поддержано логикой форматирования параметров кассы |
correctionType | числовой | Тип коррекции:
|
waybillPrintRequireStatus | числовой | Статус печати счета-фактуры:
|
version | строковый | Версия кассы |
waybillNumber | строковый | Номер счета-фактуры |
discountApplyLimitSum | строковый | Максимально возможная сумма скидки |
discountOnChangeSum | строковый | Сумма скидки на мелочь. Если скидка на мелочь не была применена, то будет записано значение "0". |
internalDiscountFullMode | числовой | Режим работы внутреннего дисконта |
objectName | строковый | Наименование объекта |
Объект checkdiscountitem
– скидка
Свойство | Тип | Значение |
---|---|---|
itemId | числовой | Идентификатор скидки |
positionNum | числовой | Номер позиции товара в документе, к которому применялась скидка |
dateTime | дата и время | Дата и время применения скидки |
isPositionDiscount | числовой | Флаг на что применялась скидка:
|
discMode | числовой | Режим скидки:
|
discType | числовой | Тип скидки:
|
discSize | вещественный | Ставка скидки (проценты в случае процентной скидки, сумма в случае суммовой скидки, |
discSum | вещественный | Сумма скидки |
discName | строковый | Название скидки |
discCode | числовой | Код скидки |
discScheme | числовой | Дисконтная схема |
cardNumber | строковый | Номер дисконтной карты в случае скидки по карте |
cardName | строковый | Название дисконтной карты в случае скидки по карте |
discNumber | числовой | Номер скидки в порядке применения |
minPriceDisabled | логический | Признак запрета учета минимальной цены |
Объект position
– позиция в документе
Свойство | Тип | Значение |
---|---|---|
posnum | числовой | Номер последней добавленной позиции в чек |
dept | числовой | Номер отдела последней добавленной позиции в чек |
item_datetime | дата и время | Дата и время добавления последней добавленной позиции в чек |
opcode | числовой | Код операции:
|
bcode | строковый | Код / Штрих-код товара (зависит от способа добавления) |
additionalBarcode | строковый | Штрих-код позиции по свободной цене |
additionaldata | строковый | Дополнительные данные |
name | строковый | Имя последней добавленной позиции |
articul | строковый | Артикул последней добавленной позиции |
scode | числовой | Код кассира, который добавил последнюю позицию |
extendetoptions | строковый | Дополнительная информация по последней добавленной позиции |
measure | числовой | Код единицы измерения последней добавленной позиции |
bcode_mode | числовой | Код способа добавления последней добавленной позиции:
|
bquant | вещественный | Количество последней добавленной позиции |
bquant_mode | числовой | Способ получения количества последней добавленной позиции:
|
code | строковый | Код товара последней добавленной позиции |
cquant | вещественный | Количество последней добавленной позиции |
pricetype | числовой | Код ценовой схемы добавленной позиции |
pricevcode | числовой | Код типа оплаты добавленной позиции |
price | вещественный | Цена без скидки добавленной позиции |
min_price | вещественный | Минимальная цена добавленной позиции |
price_mode | числовой | Способ ввода цены добавленной позиции |
index | числовой | Индекс цены |
disc_abs | вещественный | Сумма скидки |
sumi | вещественный | Начальная сумма до применения скидок |
sumb | вещественный | Итоговая сумма после применения всех скидок |
sumn | вещественный | Начальная сумма до применения скидок |
sume | вещественный | Начальная сумма до применения скидок |
vatCode1 | числовой | Код налога 1 |
vatCode2 | числовой | Код налога 2 |
vatCode3 | числовой | Код налога 3 |
vatCode4 | числовой | Код налога 4 |
vatCode5 | числовой | Код налога 5 |
vatSum1 | вещественный | Сумма налога 1 |
vatSum2 | вещественный | Сумма налога 2 |
vatSum3 | вещественный | Сумма налога 3 |
vatSum4 | вещественный | Сумма налога 4 |
vatSum5 | вещественный | Сумма налога 5 |
vatRate1 | вещественный | Ставка налога 1 |
vatRate2 | вещественный | Ставка налога 2 |
vatRate3 | вещественный | Ставка налога 3 |
vatRate4 | вещественный | Ставка налога 4 |
vatRate5 | вещественный | Ставка налога 5 |
itemId | числовой | Идентификатор записи позиции в БД |
tmcObject | объект | Ссылка на объект товар |
unitObject | объект | Ссылка на объект единицы измерения |
impactText | строковый | Описание воздействия (Строка: "СО СКИДКОЙ" или "С НАДБАВКОЙ") |
impactPercent | вещественный | Процент воздействия / Размер скидки |
impactSum | вещественный | Сумма воздействия / Сумма скидки |
bonusImpactSum | вещественный | Сумма списанных бонусных баллов |
minRetailPrice | строковый | Минимальная розничная цена |
enteredPrice | строковый | Цена введенная вручную |
hasEnteredPrice | строковый | Цена введена вручную. Если цена была введена вручную, то будет записано значение "1", иначе – "0". |
hasDiscountPrice | строковый | Цена получена из дисконта |
packingMode | строковый | Применен модификатор "расфасовка":
|
index_price | строковый | Индексная цена. Если для товара была применена индексная цена, то будет записано значение "0". |
disc_perc | строковый | Процент скидки в чеке |
disc_abs | строковый | Процент скидки в чеке |
tara_default | строковый | При добавлении товара, который является тарой или может быть отпущен только в тару, значение записано не будет/null. |
groupId | строковый | Идентификатор группы (заполняется после применения модификатора группы) |
recalcable | строковый | В открытом чеке будет записано значение "1", иначе – записано не будет/null. |
button | строковый | Кнопка (скидка по кнопке) |
discountOnChangeSum | строковый | Сумма скидки на мелочь. Если скидка на мелочь не была применена, то будет записано значение "0". |
departmentObject | объект | Ссылка на объект отдел |
departmentCode | строковый | Код отдела |
departmentName | строковый | Наименование отдела |
departmentClientItemId | строковый | Идентификатор записи клиента отдела из БД |
departmentDocumentPrefix | строковый | Префикс документа |
tmcPrice | строковый | Цена товара без скидок |
tmcTaraMode | строковый |
|
tmcTaraCapacity | строковый | Вместимость тары с округлением до целого |
unitCode | строковый | Код единицы измерения |
unitName | строковый | Наименование единицы измерения |
unitFlag | строковый | Флаг весовой единицы измерения:
|
softCheckId | строковый | Идентификатор софт-чека |
hasDiscount | строковый | Цена поучена из дисконта. Если для позиции была применена скидка, то будет записано значение "1", иначе – "0". |
bonusImpactEarn | строковый | При наличии бонусных начислений будет записано значение "0". |
aspectSchemeName | строковый | Наименование схемы разрезов |
aspectValueSetName | строковый | Наименование разреза |
allowDiscount | логический | Применение дисконта:
|
allowOnlyExternalDiscount | логический | Применение только внешнего дисконта (внешние системы лояльности):
|
allowBonusEarn | логический | Начисление бонусов на позицию:
|
allowBonusSpend | логический | Списание бонусов:
|
exciseMark | строковый | Акцизная марка / код маркировки |
additionalExciseMark | строковый | DataMatrix алкогольной продукции |
discName | строковый | Наименование дисконтной акции |
tags | строковый | Список тегов |
inn | строковый | ИНН |
kpp | строковый | КПП |
alcoholPercent | строковый | Процент алкоголя |
alcTypeCode | строковый | Код вида алкогольной продукции |
paymentItemId | строковый | Идентификатор записи оплаты в БД |
consultantName | строковый | Имя консультанта |
alcoCode | строковый | Алкокод акцизного товара |
bquantFromBcode | строковый | Количество полученное из штирих-кода |
packingPrice | строковый | Цена для расфасовки |
visualVerified | логический | Требуется визуальная проверка:
|
paymentMethod | строковый | Признак способа расчета (определяется на основе признака предмета расчета) |
tmcGroup | строковый | Название группы, к которой относится товар |
priceSource | строковый | Код способа получения цены:
|
tmcPriceSourceType | строковый | Тип источника цены товара |
objectName | строковый | Наименование объекта |
Объект moneyitem
– оплата
Свойство | Тип | Значение |
---|---|---|
checkNum | числовой | Номер чека |
scode | строковый | Код кассира |
ccode | строковый | Код кассы |
shift | числовой | Номер смены |
dateTime | дата и время | Дата и врем оплаты |
opcode | числовой | Код операции:
|
valcode | числовой | Код типа оплаты |
vsum | вещественный | Сумма |
sumb | вещественный | Сумма |
sumn | вещественный | Сумма |
sume | вещественный | Сумма |
docNum | строковый | Тип платежной карты |
frnum | числовой | Номер фискального регистратора |
cardnum | строковый | Номер карты |
operationId | числовой | Идентификатор транзакции |
itemId | числовой | Идентификатор оплаты |
paymentNumber | числовой | Номер оплаты по порядку |
Объект tmc
– товар
Свойство | Тип | Значение |
---|---|---|
code | строковый | Код |
barcode | строковый | Штрих-код |
additionalData | строковый | Дополнительные штрих-коды |
name | строковый | Название |
articul | строковый | Артикул |
extendetoptions | строковый | Расширенные опции |
vatCode1 | числовой | Код налога 1 |
vatCode2 | числовой | Код налога 2 |
vatCode3 | числовой | Код налога 3 |
vatCode4 | числовой | Код налога 4 |
vatCode5 | числовой | Код налога 5 |
deptCode | числовой | Код отдела |
cquant | вещественный | Количество учетных единиц |
documentquantlimit | вещественный | Максимально возможное наличие товара в чеке |
measure | числовой | Код единицы измерения |
priceType | числовой | Номер ценовой схемы |
price | вещественный | Цена |
minPrice | вещественный | Минимальная цена |
basePrice | вещественный | Базовая цена (tmc) |
actualPrice | вещественный | Актуальная цена (prices) |
actualPriceEffectiveDate | дата и время | Начало действия актуальной цены (prices) |
valCode | числовой | Код типа оплаты |
quantDefault | вещественный | Количество по умолчанию |
quantLimit | вещественный | Лимит количества |
quantMode | числовой | Флаги изменения количества:
|
bcodeMode | числовой | Флаги на добавление позиции:
|
opMode | числовой | Флаги работы с товаром:
|
deptMode | числовой | Флаги изменения отдела:
|
priceMode | числовой | Флаги изменения цены:
|
taraDefault | строковый | Код единицы измерения в режиме расфасовка |
taraCapacity | вещественный | Вместимость тары |
tmcGroups | объект | Гуппа товаров |
groupCode | строковый | Код группы товаров |
unitObject | объект | |
remain | числовой | Остаток |
remainDate | дата и время | Дата и время остатков |
Объект tmcindexprice
– индекс цены
Свойство | Тип | Значение |
---|---|---|
code | числовой | Код индекса цены |
barcode | строковый | Штрих-код, к которому привязан индекс цены |
name | строковый | Название |
price | вещестенный | Цена |
Объект tmcsalerestrict
– ограничение на продажу товаров
Свойство | Тип | Значение |
---|---|---|
code | числовой | Код |
tmcCode | строковый | Код товара |
dateBeg | дата | Начальная дата |
dateEnd | дата | Конечная дата |
daysBeg | числовой | Начальный день недели |
daysEnd | числовой | Конечный день недели |
timeBeg | время | Начальное время |
timeEnd | время | Конечное время |
Объект department
– отдел
Свойство | Тип | Значение |
---|---|---|
code | числовой | Код |
name | строковый | Название |
idclient | числовой | Идентификационный код клиента |
clientObject | объект | |
documentPrefix | строковый | Префикс документа |
documentNumber | строковый | Номер документа. |
Объект card
– карта
Свойство | Тип | Значение |
---|---|---|
number | строковый | Номер карты |
clientObject | объект | Клиент |
cardGroupObject | объект | Группа карт |
validityDateBeg | дата | Дата начала действия карты |
validityDateEnd | дата | Дата окончания действия карты |
blocked | логический | Признак блокировки карты |
cardSum | вещественный | Сумма на карте |
multiplicator | вещественный | Временный мультипликатор |
multiplicatorCurrent | вещественный | Постоянный мультипликатор |
multiplicatorBeg | дата и время | Начало действия временного мультипликатора |
multiplicatorEnd | дата и время | Окончание действия временного мультипликатора |
Объект client
– клиент
Свойство | Тип | Значение |
---|---|---|
idClient | числовой | Идентификационный номер клиента |
name | строковый | ФИО клиента |
sex | числовой | Пол клиента:
|
birthday | дата | День рождения |
specialDate1 | дата | Первая особая дата клиента |
specialDate2 | дата | Вторая особая дата клиента |
specialDate3 | дата | Третья особая дата клиента |
specialDate1Name | строковый | Название первой особой (специальной) даты |
specialDate2Name | строковый | Название второй особой (специальной) даты |
specialDate3Name | строковый | Название третьей особой (специальной) даты |
zipCode | строковый | Почтовый индекс клиента |
address | строковый | Адрес клиента |
строковый | ||
webPage | строковый | Web-страница |
phoneNumber | строковый | Телефонный номер клиента |
inn | строковый | ИНН |
document | строковый | Данные документа клиента (паспорта, водительского удостоверения и т.д.) |
okpo | строковый | ОКПО |
okpd | строковый | ОКПД |
occupation | строковый | Род занятий |
childrenCount | числовой | Количество детей клиента |
extendedOptions | строковый | Дополнительные параметры |
text | строковый | Дополнительная информация о клиенте |
segments | строковый | Группа сегментов клиента Используется для работы с онлайн-картами |
Объект cardGroup
– группа карт
Свойство | Тип | Значение |
---|---|---|
name | строковый | Имя группы карт |
text | строковый | Текст, относящийся к группе карт |
cardMode | числовой | Тип карт:
|
prefixBeg | строковый | Начало диапазона префикса номеров карт, входящих в данную группу |
prefixEnd | строковый | Конец диапазона префикса номеров карт, входящих в данную группу |
lenBeg | числовой | Начало диапазона длин номеров карт, входящих в данную группу |
lenEnd | числовой | Конец диапазона длин номеров карт, входящих в данную группу |
regexPattern | строковый | Маска номеров карт в виде регулярного выражения |
inputModeMask | числовой | Маска способа ввода карты |
regexRule | строковый | Правила получения выделения значащей последовательности из номеров карты (регулярное выражение) |
discountType | числовой | Тип скидки:
|
discountValue | вещественный | Размер скидки |
bonusUseCase | числовой | Вариант использования бонусов:
|
Объект unit
– единица измерения
Свойство | Тип | Значение |
---|---|---|
code | числовой | Код |
name | строоковый | Название |
fractional | числовой | Признак весового товара:
|
Объект valut
– валюта (тип оплаты)
Свойство | Тип | Значение |
---|---|---|
code | числовой | Код |
name | строковый | Название валюты |
shortName | строковый | Сокращенное название валюты |
type | числовой | Тип валюты |
mode | числовой | Флаги:
|
merchantId | числовой | Код продавца в платежном терминале |
stat | числовой | Статус:
|
precision | вещественный | Точность округления:
|
roundMode | числовой | Способ округления:
|
hidden | числовой | Признак:
|
operation | числовой | Тип операции дополнительной оплаты:
|
processingConfiguration | строковый | Настройки обращения к процессинговой системе |
Объект button
– кнопка
Свойство | Тип | Значение |
---|---|---|
buttonId | числовой | Идентификатор кнопки |
code | числовой | Код кнопки |
name | строковый | Название кнопки |
tag | строковый | Метка |
rateobject | числовой | Объект скидки:
|
ratetype | числовой | Тип скидки:
|
ratevalue | вещественный | Размер ставки скидки |
maxratevalue | вещественный | Максимальный размер ставки в процентах |
minratevalue | вещественный | Минимальный размер ставки в процентах |
inputvalue | вещественный | Размер ставки введенный вручную |
Объект cardRecord
– запись о карте в документе
Свойство | Тип | Значение |
---|---|---|
id | числовой | Идентификатор карты |
inputSource | числовой | Способ ввода:
|
cardObject | объект | Карта покупателя |
dateTime | дата и время | Время применения |
bonusBalance | вещественный | Баланс бонусов на карте |
bonusBalanceInactive | вещественный | Баланс неактивных бонусов на карте |
position | числовой | Номер позиции в документе |
Отчеты
Объект tmclist
– список кодов товаров
Свойство | Тип | Значение |
---|---|---|
tmc | строковый | Список выбранных кодов товаров, разделенный запятыми |
Объект frposition
– товарная позиция в ФР
Свойство | Тип | Значение |
---|---|---|
name | строковый | Наименование товара |
price | числовой | Стоимость позиции |
pricewithdisc | числовой | Стоимость позиции со скидкой |
count | числовой | Количество товара в позиции |
dept | числовой | Код отдела товара |
taxcode | числовой | Код налога товара |
taxsum | числовой | Сумма налога |
possum | числовой | Сумма позиций без скидок |
barcode | строковый | Штрих-код товара |
discsum | числовой | Сумма скидки на позицию |
storno | логический | Сторнированная позиция |
posnum | числовой | Номер позиции в чеке |
taramode | числовой | Тип позиции |
measureName | строковый | Наименование единицы измерения |
taxRate | числовой | Налоговая ставка |
itemBcode | строковый | Штрих-код из позиции |
paymentObject | числовой | Признак предмета расчета |
paymentMethod | числовой | Признак способа расчета |
bonusImpactSum | числовой | Сумма бонусных воздействий на позицию |
exciseMark | строковый | Акцизная марка |
exciseMarkType | числовой | Тип акцизной марки |
markingCode | строковый | Акцизная марка без удаления управляющих символов |
code | строковый | Код товара |
ntin | строковый | Код национального классификатора |
frUnit | числовой | Мера количества предмета расчета |
taxCodeStr | строковый | Код налога |
Объект zxreport
– основная часть ZX-отчета
Свойство | Тип | Значение |
---|---|---|
dateTime | дата и время | Дата и время отчета |
openShiftTime | дата и время | Дата и время открытия смены |
closeShiftTime | дата и время | Дата и время закрытия смены |
shiftNumber | числовой | Номер смены |
sections | список объектов | Итоги по операциям в каждом отделе |
operations | список объектов | Итоги по операциям суммарно по всем отделам |
discounts | список объектов | Итоги по скидкам |
discountsMap | маппинг по видам операций | Скидки по видам операций |
markups | список объектов | Итоги по наценкам |
markupsMap | маппинг по видам операций | Наценки по видам операций |
totalResult | список объектов | Окончательные итоги по операциям |
taxes | список объектов | Итоги по налогам |
startShiftNonNullableSums | список объектов | Необнуляемые суммы на начало смены |
ticketOperations | список объектов | Итоги по чекам по каждой операции |
ticketOperationsMap | маппинг по видам операций | Чеки по каждой операции |
moneyPlacements | список объектов | Итоги по операциям с наличными |
moneyPlacementsMap | маппинг по видам операций с наличными | Операции с наличными |
cashSum | числовой | Сумма наличных в кассе |
revenue | числовой | Выручка |
nonNullableSums | список объектов | Итоги по необнуляемым суммам на момент снятия отчета (для Z-отчета на конец смены) |
nonNullableSumsMap | маппинг по видам операций | Необнуляемые суммы на момент снятия отчета (для Z-отчета на конец смены) |
Объект section
– итоги по отделу
Свойство | Тип | Значение |
---|---|---|
sectionCode | строковый | Номер/название отдела |
operations | список объектов | Список операций |
operationsMap | маппинг по видам операций | Итоги по видам операций |
Объект operation
– итоги по виду операции (продажа, покупка, возвраты)
Свойство | Тип | Значение |
---|---|---|
operation | числовой | Тип операции |
count | числовой | Количество операций |
sum | числовой | Сумма |
Объект taxTotals
– итоги по налогу
Свойство | Тип | Значение |
---|---|---|
type | числовой | Тип налога |
percent | числовой | Значение налога в процентах (в тысячных долях, например 18000 = 18%) |
operations | список объектов | Итоги по операциям по данному налогу |
Объект ticketOperation
– итоги по операциям с чеками
Свойство | Тип | Значение |
---|---|---|
operation | числовой | Тип операции |
ticketsTotalCount | числовой | Общее количество чеков по данной операции |
ticketsCount | числовой | Количество чеков по данной операции за смену |
offlineCount | числовой | Количество чеков за смену в автономном режиме |
ticketsSum | числовой | Сумма по чекам по данной операции за смену |
discountSum | числовой | Сумма скидки по всем чекам за смену |
markupSum | числовой | Сумма наценки по всем чекам за смену |
changeSum | числовой | Сумма сдачи по всем чекам за смену |
payments | список объектов | Итоги по видам расчетов |
paymentsMap | маппинг по видам расчетов | Итоги по видам расчетов |
Объект ticketOperationPayment
– итоги по виду расчетов
Свойство | Тип | Значение |
---|---|---|
payment | числовой | Вид оплаты |
sum | числовой | Сумма по данному виду расчетов |
count | числовой | Количество платежей |
Объект payment
– оплата
Свойство | Тип | Значение |
---|---|---|
type | числовой | Вид оплаты |
sum | числовой | Уплаченная сумма |
Объект moneyPlacement
– итоги по виду операций с наличными
Свойство | Тип | Значение |
---|---|---|
operation | числовой | Вид операции |
operationsTotalCount | числовой | Общее количество операций данного вида |
operationsCount | числовой | Количество операций данного вида за смену |
operationsSum | числовой | Сумма денег по операции данного вида за смену |
offlineCount | числовой | Количество операций данного вида за смену в автономном режиме |
Объект nonNullableSum
– необнуляемая сумма
Свойство | Тип | Значение |
---|---|---|
operation | числовой | Тип операции |
sum | числовой | Сумма |
ads
– список строк: ответ от сервиса softwarefn
с текстом ОФД (тип TICKET_AD_OFD = 0)
с заменой макросов:
${ticket_number}
– Offline / Online номер чека,${client_timestamp}
– Время закрытия чека
Объект settings
– параметры устройства из менеджера оборудования
Свойство | Тип | Значение |
---|---|---|
device | строковый | Название устройства в системе |
deviceId | строковый | Идентификатор устройства |
enableCheckPrint | логический | Разрешение печати чеков |
lockNotificationDelay | числовой | Задержка перед отображением оповещения о блокировке |
offlineModeLabel | строковый | Надпись оповещения об автономном режиме |
offlineLabelFont | строковый | Шрифт надписи оповещения об автономном режиме |
port | числовой | Порт сервиса |
timeout | числовой | Таймаут ответа от сервера |
qrCodeUrl | строковый | Адрес для генерации QR-кода для просмотра чека |
qrCodeScale | числовой | Параметр масштабирования QR-кода |
Объект ticketRequest
– основная часть чека
Свойство | Тип | Значение |
---|---|---|
kkmInfoObject | объект | Метаданные сервиса |
operation | числовой | Код операции с чеком |
dateTime | дата и время | Дата и время операции |
operatorCashier | объект | Оператор-кассир |
domain | объект | Вид отрасли |
items | список объектов | Список товаров, работ, услуг |
payments | список объектов | Оплаты разных типов |
taxes | список объектов | Список налогов на сумму чека |
amounts | объект | Итоги по чеку |
extensionOptions | объект | Дополнительные сведения о покупателе |
offlineTicketNumber | числовой | Offline номер чека |
printedDocumentNumber | числовой | Номер печатного документа |
frShiftNumber | числовой | Номер текущей смены, считанный с ФР |
Объект kkmInfoObject
– метаданные сервиса
Свойство | Тип | Значение |
---|---|---|
serviceStatus | числовой | Статус сервиса |
lockDate | дата и время | Дата блокировки сервиса |
errorMessage | строковый | Сообщение об ошибке |
data | строковый | Данные, которые необходимо отправить в ответе (offlineTicketNumber) |
offlineModeReason | числовой | Причина перехода в автономный режим:
|
serviceStatusByDbState | числовой | Статус сервиса на основе состояния БД:
|
serviceStatus
– статус сервиса:
- 0 – онлайн,
- 1 – офлайн,
- 2 – заблокирован,
- 3 – серверно заблокирован.
Объект operatorCashier
– оператор-кассир
Свойство | Тип | Значение |
---|---|---|
code | числовой | Код оператора-кассира |
name | строковый | ФИО оператора-кассира |
Объект domain
– сфера деятельности (вид отрасли)
Свойство | Тип | Значение |
---|---|---|
type | числовой | Вид отрасли |
Объект item
– элемент списка товаров, работ, услуг
Свойство | Тип | Значение |
---|---|---|
type | числовой | Тип элемента |
commodity | объект | Предмет потребления |
modifier | объект | Модификатор стоимости (наценка/скидка) |
Объект commodity
– предмет потребления (товар, работа или услуга)
Свойство | Тип | Значение |
---|---|---|
name | строковый | Наименование товара, работы, услуги |
sectionCode | строковый | Код секции или отдела |
quantity | числовой | Количество товара, работы, услуги (в тысячных долях, например: 1000 = 1,0, 2500 = 2,5) |
price | числовой | Цена товара, работы, услуги |
sum | числовой | Итоговая сумма товара, работы, услуги |
taxes | список объектов | Список налогов |
exciseStamp | строковый | Код маркировки |
physicalLabel | строковый | Серия и номер акцизной марки |
barcode | строковый | Штрих-код (поле содержит штрих-код GTIN при его наличии) |
measureUnitCode | строковый | Код единицы измерения |
auxiliary | маппинг по строке ответа от сервиса | Дополнительная информация |
Объект tax
– налог элемента списка товаров, работ, услуг
Свойство | Тип | Значение |
---|---|---|
taxType | числовой | Тип налога |
taxationType | числовой | Вид налогообложения:
|
percent | числовой | Значение налога в тысячных долях процента |
sum | числовой | Значение налога в деньгах |
isInTotalSumFlag | логический | Заложен ли налог в сумму |
Объект modifier
– модификатор стоимости (скидка/надбавка/сторно)
Свойство | Тип | Значение |
---|---|---|
name | строковый | Наименование |
sum | числовой | Сумма |
taxes | список объектов | Список налогов |
auxiliary | маппинг по строке ответа от сервиса | Дополнительная информация |
Объект extensionOptions
– дополнительные сервисные поля
Свойство | Тип | Значение |
---|---|---|
customerEmail | строковый | Email покупателя |
customerPhone | строковый | Телефон покупателя |
customerIinOrBin | строковый | ИИН/БИН покупателя (индивидуальный идентификационный номер/бизнес-идентификационный номер) |
auxiliary | маппинг по строке ответа от сервиса | Дополнительная информация |
Объект serviceResponse
– ответ от сервиса softwarefn
Свойство | Тип | Значение |
---|---|---|
kkmInfoObject | объект | Метаданные сервиса |
ticketAds | список объектов | Рекламные тексты |
regInfo | объект | Регистрационная информация |
lastDocumentInfo | объект | Информация о последнем принятом документе |
bindedTaxation | объект | Привязанное налогообложение |
auxiliary | маппинг по строке ответа от сервиса | Дополнительная информация |
Объект ticketAd
– рекламный текстовый блок
Свойство | Тип | Значение |
---|---|---|
info | объект | Информация о текстовом блоке |
text | строковый | Текст |
Объект ticketAdInfo
– информация о рекламных текстах для чека
Свойство | Тип | Значение |
---|---|---|
type | числовой | Тип текста:
|
version | числовой | Версия текста |
Объект regInfo
– регистрационная информация
Свойство | Тип | Значение |
---|---|---|
kkm | объект | Информация о ККМ |
pos | объект | Информация о торговой точке |
org | объект | Информация об организации |
Объект kkmRegInfo
– регистрационные данные ККМ
Свойство | Тип | Значение |
---|---|---|
pointOfPaymentNumber | строковый | Регистрационный номер (код) точки приема платежей |
terminalNumber | строковый | Номер платежного терминала |
fnsKkmId | строковый | Регистрационный номер ККМ, выданный КГД |
serialNumber | строковый | Заводской номер ККМ |
kkmId | строковый | Идентификационный номер ККМ |
Объект posRegInfo
– регистрационные данные торговой точки
Свойство | Тип | Значение |
---|---|---|
title | строковый | Название торговой точки |
address | строковый | Адрес торговой точки |
Объект orgRegInfo
– регистрационные данные организации
Свойство | Тип | Значение |
---|---|---|
title | строковый | Название организации или ФИО ИП |
address | строковый | Юридический адрес организации |
inn | строковый | ИИН/БИН |
okved | строковый | Общий классификатор экономической деятельности |
Объект lastDocumentInfo
– информация о последнем принятом документе
Свойство | Тип | Значение |
---|---|---|
frShiftNumber | числовой | Номер смены |
printedDocumentNumber | числовой | Номер документа |
Объект bindedTaxation
– привязанное налогообложение
Свойство | Тип | Значение |
---|---|---|
type | числовой | Тип налогообложения:
|
taxes | список объектов | Ставки для каждого привязанного налога |
Объект bindedTax
– привязанный налог
Свойство | Тип | Значение |
---|---|---|
type | числовой | Тип налога (по умолчанию 100) |
percent | числовой | Значение налога в процентах (в тысячных долях процента) |
loymax_loyalty
— ответ от системы лояльности Loymax
, содержащий строки слипа для печати купона.
slip_lines
— список строк слипа для печати купона Loymax.
Объект line
— строка слипа для печати купона Loymax.
Свойство | Значение |
---|---|
barcode_type | Тип штрих-кода (QR-код) |
barcode | Значение штрих-кода |
width | |
height | |
text | Текст строки |
Объекты для сообщений POS-Интеллект (ITV)
Объект barcode
– штрих-код
Свойство | Тип | Значение |
---|---|---|
code | строковый | Штрих-код |
Объект error
– ошибка при скидке по кнопке
Свойство | Тип | Значение |
---|---|---|
text | строковый | Текст ошибки |
Объект permission
– права пользователя
Свойство | Тип | Значение |
---|---|---|
opcode | числовой | Код операции |
codename | строковый | Наименование команды |
username | строковый | Имя пользователя с правами |
userid | строковый | Id пользователя с правами |
result | числовой | Результат операции |
Объект opnumber
– номер операции
Свойство | Тип | Значение |
---|---|---|
num | строковый | Номер |
scale
– весСвойство | Тип | Значение |
---|---|---|
weight | вещественный | Вес |
Объект box
– денежный ящик
Свойство | Тип | Значение |
---|---|---|
sum | вещественный | Сумма в денежном ящике |
Объект codec
– кодировка выходных данных (Система видеонаблюдения)
Свойство | Тип | Значение |
---|---|---|
name | строковый | Название кодека |
Пользователи
user – пользователь
Свойство | Тип | Значение |
---|---|---|
code | строковый | Код пользователя |
name | строковый | Имя пользователя |
group | числовой | Группа (права), в которую входит пользователь |
locked | строковый | Признак блокировки пользователя |
barcode | строковый | Штрих-код пользователя |
keyposition | числовой | Текущее положение ключа |
rank | строковый | Должность пользователя |
inn | строковый | ИНН пользователя |
- No labels