Page tree
Skip to end of metadata
Go to start of metadata

Ниже приведен список объектов, которые могут быть использованы в макросах при редактировании шаблонов документов, текста на экране кассира и т.д.

Окружение

 registry - реестр

Объект registry - реестр


Свойство

Тип

Значение

checkNumber

числовой

Номер чека

shiftNumber

числовой

Номер смены

cashCode

строковый

Код кассы

shopCode

строковый

Код магазина

shiftBeg

дата и время

Дата и время начала смены 

 shift - смена

Объект shift - смена


Свойство

Тип

Значение

id

числовой

Идентификационный номер смены

num

числовой

Номер смены

cashcode

строковый

Код кассы

shopcode

строковый

Код магазина

usercode

строковый

Код пользователя (кассира)

timestart

дата и время

Время начала работы смены

timeend

дата и время

Время окончания работы смены

isopened

логический

Смена в кассе:

  • 0 - закрыта;
  • 1 - открыта.

isclosed

логический

Смена в кассе:

  • 0 - открыта;
  • 1 - закрыта.
firstCheckTimeдата и время

Дата и время закрытия первого чека в смене

 status - текущее состояние работы кассы

Объект status - текущее состояние работы кассы


Свойство

Тип

Значение

userid

строковый

Код пользователя

username

строковый

Имя пользователя

usergroup

числовой

Группа (права), в которую входит пользователь

department

числовой

Отдел

now

дата и время

Текущая дата и время

mode

строковый

Режим работы фискального регистратора

netmode

строковый

Режим работы (сетевой, локальный)

version

строковый

Версия

specialState

строковый

Индикатор выполнения специальных функций. Например, если включен режим автоматического взвешивания, то данный параметр имеет значение "ФАСОВКА"  

Документ

 document - документ

Объект document - документ


Свойство

Тип

Значение

id

числовой

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

num

строковый

Номер документа

type

числовой

Тип документа:

  • 1 - продажа,
  • 2 - возврат,
  • 3 - внесение,
  • 4 - выем,
  • 16 - документ инвентаризации.

dept

числовой

Номер отдела

cashCode

строковый

Код кассы

shift

числовой

Номер смены документа

cashierCode

строковый

Код кассира

dateTimeBeg

дата и время

Дата и время открытия чека

dateTimeEnd

дата и время

Дата и время закрытия чека

sum1

вещественный

Сумма без скидок

sum2

вещественный

Сумма без скидок

sumb

вещественный

Итоговая сумма со скидками

sumcashвещественныйСумма оплаты наличными
rtextстроковыйТекст для печати на текстовой ленте
shopOptionsстроковыйОпции магазина

status

числовой

Состояние документа

workShiftId

числовой

Идентификатор смены

positionsCount

числовой

Количество позиций

waresPositionsCount

числовой

Количество позиций товаров

waresQuantity

числовой

Количество товаров

urlEgaisстроковыйURL ЕГАИС
digitalSignatureEgaisстроковыйЦифровая подпись ЕГАИС

quantity

вещественный

Суммарное кол-во

netto

вещественный

Суммарное кол-во весовых товаров без тары

brutto

вещественный

Суммарное кол-во весовых товаров с тарой

verifiedAgeстроковый

Минимальный возраст покупателя в текущем документе (после подтверждения возраста)

activatedCampaignsстроковыйНе поддерживается
selectedCampaignsстроковыйНе поддерживается
hasCardстроковый

Карта в чеке:

  • 0 - отсутствует,
  • 1 - присутствует.
hasActiveCardстроковый

Бонусная карта в чеке:

  • 0 - отсутствует,
  • 1 - присутствует.
basePaymentNameстроковыйНаименование базовой валюты
identifierстроковыйИдентификатор чека на кассе
registeredPdfInEgaisстроковый

Товар зарегистрирован в ЕГАИС:

  • 0 - не зарегистрирован,
  • 1 - зарегистрирован.
hasCouponстроковый

Купон в чеке:

  • 0 - отсутствует,
  • 1 - присутствует.
hasCouponGivenстроковый

 Выдача купона в текущем чеке:

  • 0 - отсутствует,
  • 1 - присутствует.
shownAlcoholCautionстроковый

Ограничение продажи алкогольной продукции.

Если настройка alcoholCaution в /linuxcash/cash/conf/ncash.ini включена, то будет записано значение "1", иначе - "0".

basePaymentModeстроковыйРежим базовой валюты
basePaymentSumстроковый

Сумма оплаты базовой валютой

consultantNameстроковыйИмя консультанта
consultantстроковыйНе поддерживается
currentPositionстроковый

Индекс выделенной пользователем позиции

frDocNumстроковый

Номер документа из ФР

frDocCopyстроковый

Копия документа в ФР

userNameстроковыйИмя пользователя
customerAddressстроковый

Адрес (телефон или email) покупателя

closeWithoutPrintстроковый

Отказ от печати чека:

  • 0 - печать чека осуществляется,
  • 1 - покупатель отказался от печати.

Реализовано только на ФР Атол.

egaisCounterстроковый

Счетчик успешных регистраций в ЕГАИС

backReasonCodeстроковый

Код причины возврата

certificatesстроковыйНе поддерживается
actorCodeчисловой

Код пользователя, подтверждающего некоторое действие

sourceIdentifierстроковый

Идентификатор исходного документа при возврате

addingAllowedлогический

Флаг возможности добавления позиций в документ:

  • true - можно добавлять позиции,
  • false - нельзя добавлять позиции.
moneyItemsстроковыйНе поддерживается
goodsItemsстроковыйНе поддерживается
discountsстроковыйНе поддерживается
stornoItemsстроковыйНе поддерживается
cardRecordsстроковыйНе поддерживается
couponsстроковыйНе поддерживается
buttonстроковыйНе поддерживается
databaseStatusстроковый

Статус документа в БД:

  • 1 - закрыт,
  • 2 - отменён,
  • 0 - остальное.
basePaymentTypeстроковыйНе поддерживается
bonusRecordsстроковыйНе поддерживается
linkedDocumentIdчисловой

Идентификатор связанного документа

shopLabelsстроковый

Получение меток магазина

shopCode

строковый

Код магазина

contextстроковыйНе поддерживается
changeSumвещественный

Сумма сдачи (сумма оплаты - сумма документа)

paymentSumвещественный

Сумма оплат в документе

discWithoutBonusвещественный

Сумма дисконта без учёта бонусов

maxSum

вещественный

Максимальная сумма документа

considerRemainлогический

Флаг учёта остатков:

  • true - учитывать остатки при продаже,
  • false - не учитывать остатки при продаже.
unitePositionстроковый

Настройка объединения позиций ("disable", "all", "piece")

positionsLimit

числовой

Лимит количества позиций в документе

uniqueIdPatternстроковый

Паттерн образования уникального идентификатора документа

deptModeстроковый

Настройка разбиения сумм по отделам в возврате по чеку продажи ("deny", "logicalDept", "frDept")

newCheck

логический

Флаг того, что документ является новым:

  • true - новый документ,
  • false - документ не является новым.
backModeлогический

Возврата в чеке продажи.

Передается 0 независимо от настройки backMode и контекста кассы.

wasDeferredлогический

Флаг того, что документ был отложен:

  • true - документ отложен,
  • false - документ не отложен.
deferredSentлогический

Флаг того, что отложенный чек был отправлен на сервер:

  • true - отправлен на сервер,
  • false - не отправлен на сервер.
cashItemsстроковыйНе поддерживается
currentPayableSumвещественный

Сумма наличной оплаты которая выполняется в данный момент

currentPaymentSumвещественный

Сумма оплат в документе + сумма наличной оплаты которая выполняется в данный момент

pluginDataстроковыйНе поддерживается
countersстроковыйНе поддерживается
countersChangedстроковый

Статус счётчиков дисконта:

  • 0 - счетчики отключены,
  • 1 - ошибка при получении счетчиков,
  • 2 - счетчики получены.
countersSourceCardNumberстроковый

Номер карты по которой сработали счётчики дисконта

personalPricesстроковыйНе поддерживается
personalPricesCardNumberстроковый

Номер карты по которой сработали персональные скидки

fiscalIdentifierстроковый

Фискальный идентификатор документа

correctionReasonCodeчисловой

Код основания документа коррекции

correctionSourceDocumentNumberстроковый

Идентификатор исходного документа для коррекции

correctionSourceDocumentDateдата

Не поддежано логикой форматирования параметров кассы

correctionTypeчисловой

Тип коррекции:

  • 0 - самостоятельная операция,
  • 1 - операция по предписанию.
waybillPrintRequireStatusчисловой

Статус печати счёт-фактуры:

  • 0 - не определено,
  • 1 - печать счета-фактуры не требуется,
  • 2 - печать счета-фактуры требуется.
versionстроковый

Версия кассы

virtualCheckстроковыйНе поддерживается
multiplePaymentsWithProcessingстроковыйНе поддерживается
waybillNumberстроковый

Номер счёт-фактуры

discountApplyLimitSumстроковый

Максимально возможная сумма скидки

discountOnChangeSumстроковый

Сумма скидки на мелочь.

Если скидка на мелочь не была применена, то будет записано значение "0".

internalDiscountFullModeчисловойРежим работы внутреннего дисконта
failedMoneyItemsстроковыйНе поддерживается
objectNameстроковыйНаименование объекта
 checkdiscountitem - скидка

Объект checkdiscountitem - скидка


Свойство

Тип

Значение

itemId

числовой

Идентификатор скидки

positionNum

числовой

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

dateTime

дата и время

Дата и время применения скидки

isPositionDiscount

числовой

Флаг на что применялась скидка:

  • 0 - на чек;
  • 1 - на позицию.

discMode

числовой

Режим скидки:

  • 1 - автоматическое;
  • 2 - по карте;
  • 3 - фиксированная;
  • 4 - скидка на оплату;
  • 5 - скидка на комплект;
  • 6 - скидка "на мелочь" (округление).

discType

числовой

Тип скидки:

  • 1 - процентная;
  • 2 - суммовая;
  • 3 - индекс цены.

discSize

вещественный

Ставка скидки (проценты в случае процентной скидки, сумма в случае суммовой скидки,
индекс цены в случае скидки по индексу цены, отрицательная ставка - надбавка)

discSum

вещественный

Сумма скидки

discName

строковый

Название скидки

discCode

числовой

Код скидки

discScheme

числовой

Дисконтная схема

cardNumber

строковый

Номер дисконтной карты в случае скидки по карте

cardName

строковый

Название дисконтной карты в случае скидки по карте

discNumber

числовой

Номер скидки в порядке применения

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

Объект position - позиция в документе


Свойство

Тип

Значение

posnum

числовой

Номер последней добавленной позиции в чек

dept

числовой

Номер отдела последней добавленной позиции в чек

item_datetime

дата и время

Дата и время добавления последней добавленной позиции в чек

opcode

числовой

Код операции:

  • 50 - продажа;
  • 52 - продажа суммой в отдел;
  • 54 - возврат товара в чеке продажи;
  • 56 - возврат суммой в чеке продажи;
  • 58 - возврат;
  • 60 - возврат суммой в отдел;
  • 200 - инвентаризация;
  • 201 - инвентаризация суммой в отдел;
  • 1000 - платеж;
  • 1004 - комиссия к "внешнему" платежу в чеке продажи.

bcode

строковый

Код / Штрих-код товара (зависит от способа добавления)

additionalBarcodeстроковыйШтрих-код позиции по свободной цене
additionaldataстроковый

Дополнительные данные

name

строковый

Имя последней добавленной позиции

articul

строковый

Артикул последней добавленной позиции

scode

числовой

Код кассира, который добавил последнюю позицию

extendetoptions

строковый

Дополнительная информация по последней добавленной позиции

measure

числовой

Код единицы измерения последней добавленной позиции

bcode_mode

числовой

Код способа добавления последней добавленной позиции:

  • 1 - вручную;
  • 2 - сканером;
  • 3 - горячая клавиша;
  • 4 - выбор из списка.

bquant

вещественный

Количество последней добавленной позиции

bquant_mode

числовой

Способ получения количества последней добавленной позиции:

  • 1 - взято по умолчанию;
  • 2 - введено вручную;
  • 3 - получено из штрих-кода;
  • 4 - получено с весов.

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строковый

Применен модификатор "расфасовка":

  • true - товар был расфасован;
  • false - товар не был расфасован.
index_priceстроковый

Индексная цена.

Если для товара была применена индексная цена, то будет записано значение "0".

disc_percстроковыйПроцент скидки в чеке
disc_absстроковыйПроцент скидки в чеке
tara_defaultстроковыйПри добавлении товара, который является тарой или может быть отпущен только в тару, значение записано не будет/null.
groupIdстроковый

Идентификатор группы (заполняется после применения модификатора группы)

recalcableстроковыйВ открытом чеке будет записано значение "1", иначе - записано не будет/null.
buttonстроковыйКнопка (скидка по кнопке)
discountOnChangeSumстроковый

Сумма скидки на мелочь.

Если скидка на мелочь не была применена, то будет записано значение "0".

departmentстроковыйНе поддерживается

departmentObject

объект

Ссылка на объект отдел

departmentCodeстроковыйКод отдела
departmentNameстроковыйНаименование отдела
departmentClientItemIdстроковый

Идентификатор записи клиента отдела из БД

departmentDocumentPrefixстроковый

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

tmcPrice

строковыйЦена товара без скидок
tmcTaraModeстроковый
  • 0 - товар не является тарой,
  • 1 - товар является тарой.
tmcTaraCapacityстроковый

Вместимость тары с округлением до целого

unitCodeстроковыйКод единицы измерения
unitNameстроковыйНаименование единицы измерения
unitFlagстроковый

Флаг весовой единицы измерения:

  • 0 - штучный товар;
  • 1 - весовой товар (кг).
softCheckIdстроковыйИдентификатор софт-чека
hasDiscountстроковый

Цена поучена из дисконта.

Если для позиции была применена скидка, то будет записано значение "1", иначе - "0".

bonusImpactEarnстроковыйПри наличии бонусных начислений будет записано значение "0".
aspectSchemeNameстроковый

Наименование схемы разрезов

aspectValueSetNameстроковый

Наименование разреза

allowDiscountлогический

Применение дисконта:

  • true - разрешено;
  • false - запрещено.
allowOnlyExternalDiscountлогический

Применение только внешнего дисконта (внешние системы лояльности):

  • true - разрешено;
  • false - запрещено.
allowBonusEarnлогический

Начисление бонусов на позицию:

  • true - разрешено;
  • false - запрещено.
allowBonusSpendлогический

Списание бонусов:

  • true - разрешено;
  • false - запрещено.
exciseMarkстроковыйАкцизная марка / код маркировки
additionalExciseMarkстроковыйDataMatrix алкогольной продукции
discNameстроковый

Наименование дисконтной акции

tagsстроковыйСписок тегов
innстроковыйИНН
kppстроковыйКПП
alcoholPercentстроковыйПроцент алкоголя
alcTypeCodeстроковый

Код вида алкогольной продукции

paymentItemIdстроковый

Идентификатор записи оплаты в БД

consultantNameстроковыйИмя консультанта
consultantстроковыйНе поддерживается
alcoCodeстроковыйАлкокод акцизного товара
campaignLabelsстроковыйНе поддерживается
bquantFromBcodeстроковыйКоличество полученное из штирих-кода
packingPriceстроковыйЦена для расфасовки
alcoSetItemsстроковыйНе поддерживается
visualVerifiedлогический

Требуется визуальная проверка:

  • 0 - требуется;
  • 1 - не требуется.
securityWeightстроковыйНе поддерживается
paymentMethodстроковый

Признак способа расчета (определяется на основе признака предмета расчета

tmcGroupстроковыйЗарезервировано для будущего использования
priceSourceстроковый

Код способа получения цены:

  • 0 - был применен модификатор (по умолчанию).
tmcPriceSourceTypeстроковыйТип источника цены товара
objectNameстроковыйНаименование объекта
vatRatesстроковыйНе поддерживается
vatSumsстроковыйНе поддерживается
vatCodesстроковыйНе поддерживается
 moneyitem - оплата

Объект moneyitem - оплата


Свойство

Тип

Значение

checkNum

числовой

Номер чека

acode

строковый

Зарезервировано для будущего использования

scode

строковый

Код кассира

ccode

строковый

Код кассы

shift

числовой

Номер смены

dateTime

дата и время

Дата и врем оплаты

opcode

числовой

Код операции:

  • 44 - остаток денег на начало смены (увеличение суммы в денежном ящике);
  • 70 - прием денег от покупатели при продаже(увеличение суммы в денежном ящике);
  • 72 - сдача по продаже (уменьшение суммы в денежном ящике);
  • 74 - выдача денег покупателю по возврату (уменьшение суммы в денежном ящике);
  • 76 - сдача по возврату (увеличение суммы в денежном ящике);
  • 80 - внесение (увеличение суммы в денежном ящике);
  • 82 - выем (уменьшение суммы в денежном ящике).

valcode

числовой

Код типа оплаты

nrate

вещественный

Зарезервировано для будущего использования

bond

вещественный

Зарезервировано для будущего использования

bquant

числовой

Зарезервировано для будущего использования

vsum

вещественный

Сумма

sumb

вещественный

Сумма

sumn

вещественный

Сумма

sume

вещественный

Сумма

docNum

строковый

Тип платежной карты

c_link

числовой

Зарезервировано для будущего использования

frnum

числовой

Номер фискального регистратора

cardnum

строковый

Номер карты

operationId

числовой

Идентификатор транзакции

itemId

числовой

Идентификатор оплаты

paymentNumber

числовой

Номер оплаты по порядку

 tmc - товар

Объект 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

вещественный

Лимит количества

ostat

числовой

Зарезервировано для будущего использования

links

числовой

Зарезервировано для будущего использования

quantMode

числовой

Флаги изменения количества:

  • 1 - использовать количество по умолчанию из товара;
  • 2 - разрешить ручной ввод количества;
  • 4 - разрешить установку количества из ШК;
  • 8 - разрешить ввод количества с весов;
  • 16 - включить ограничение количества;
  • 32 - требуется обязательный ввод количества;
  • 64 - требовать ввод количества с весов;
  • 128 - требовать ввод количества из ШК.

(см. Правила использования битовых масок)

bcodeMode

числовой

Флаги на добавление позиции:

  • 1 - разрешить ручной ввод штрих-кода;
  • 2 - разрешить ввод штрих-кода сканером.

(см. Правила использования битовых масок)

opMode

числовой

Флаги работы с товаром:

  • 1 - запретить продажу товара;
  • 2 - запретить возврат товара;
  • 4 - не показывать товар в списках;
  • 8 - запретить возврат товара в чеке продажи. 

(см. Правила использования битовых масок)

deptMode

числовой

Флаги изменения отдела:

  • 1 - разрешить ввод отдела вручную;
  • 2 - требовать указание отдела вручную.

(см. Правила использования битовых масок)

priceMode

числовой

Флаги изменения цены:

  • 1 - разрешить ручной ввод цены;
  • 2 - обязательный ввод цены вручную;
  • 4 - обязательный выбор цены из массива цен. 

(см. Правила использования битовых масок)

taraFlag

числовой

Зарезервировано для будущего использования

taraMode

числовой

Зарезервировано для будущего использования

taraDefault

строковый

Код единицы измерения в режиме расфасовка

taraCapacityвещественныйВместимость тары

tmcGroups

объект

Гуппа товаров

groupCode

строковый

Код группы товаров

unitObject

объект

Единица измерения

remain

числовой

Остаток

remainDate

дата и время

Дата и время остатков

 tmcindexprice - индекс цены

Объект tmcindexprice - индекс цены


Свойство

Тип

Значение

code

числовой

Код индекса цены

barcode

строковый

Штрих-код, к которому привязан индекс цены

name

строковый

Название

price

вещестенный

Цена

 tmcsalerestrict - ограничение на продажу товаров

Объект tmcsalerestrict - ограничение на продажу товаров


Свойство

Тип

Значение

code

числовой

Код

tmcCode

строковый

Код товара

dateBeg

дата

Начальная дата

dateEnd

дата

Конечная дата

daysBeg

числовой

Начальный день недели

daysEnd

числовой

Конечный день недели

timeBeg

время

Начальное время

timeEnd

время

Конечное время

 department - отдел

Объект department - отдел


Свойство

Тип

Значение

code

числовой

Код

name

строковый

Название

idclient

числовой

Идентификационный код клиента

clientObject

объект

Клиент

documentPrefix

строковый

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

documentNumber

строковый

Номер документа.
Заполняется при сохранении документа по правилу <префикс документа><код кассы>-<6 цифр номера чека>,
например: ПВ2-002069.

 card - карта

Объект card - карта


Свойство

Тип

Значение

number

строковый

Номер карты

clientObjectобъектКлиент

cardGroupObject

объектГруппа карт

validityDateBeg

дата

Дата начала действия карты

validityDateEnd

дата

Дата окончания действия карты

blockedлогическийПризнак блокировки карты

cardSum

вещественный

Сумма на карте

multiplicatorвещественныйВременный мультипликатор
multiplicatorCurrentвещественныйПостоянный мультипликатор
multiplicatorBegдата и времяНачало действия временного мультипликатора
multiplicatorEndдата и времяОкончание действия временного мультипликатора

 client - клиент

Объект client - клиент


Свойство

Тип

Значение

idClient

числовой

Идентификационный номер клиента

name

строковый

ФИО клиента

sex

числовой

Пол клиента:

  • 0 - мужской;
  • 1 - женский.

birthday

дата

День рождения

specialDate1

дата

Первая особая дата клиента

specialDate2

дата

Вторая особая дата клиента

specialDate3

дата

Третья особая дата клиента

specialDate1Name

строковый

Название первой особой (специальной) даты

specialDate2Name

строковый

Название второй особой (специальной) даты

specialDate3Name

строковый

Название третьей особой (специальной) даты

zipCode

строковый

Почтовый индекс клиента

address

строковый

Адрес клиента

email

строковый

E-mail

webPage

строковый

Web-страница

phoneNumber

строковый

Телефонный номер клиента

inn

строковый

ИНН

document

строковый

Данные документа клиента (паспорта, водительского удостоверения и т.д.)

okpo

строковый

ОКПО

okpd

строковый

ОКПД

occupation

строковый

Род занятий

childrenCount

числовой

Количество детей клиента

extendedOptions

строковый

Дополнительные параметры

textстроковыйДополнительная информация о клиенте
 cardGroup - группа карт

Объект cardGroup - группа карт


Свойство

Тип

Значение

name

строковый

Имя группы карт

text

строковый

Текст, относящийся к группе карт

cardMode

числовой

Тип карт:

  • 0 - диконтная;
  • 1 - бонусная;
  • 2 - артикс дисконт.

prefixBeg

строковый

Начало диапазона префикса номеров карт, входящих в данную группу

prefixEnd

строковый

Конец диапазона префикса номеров карт, входящих в данную группу

lenBeg

числовой

Начало диапазона длин номеров карт, входящих в данную группу

lenEnd

числовой

Конец диапазона длин номеров карт, входящих в данную группу

regexPattern

строковый

Маска номеров карт в виде регулярного выражения

inputModeMask

числовой

Маска способа ввода карты

regexRule

строковый

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

discountType

числовой

Тип скидки:

  • 1 - процентная;
  • 2 - суммовая;
  • 3 - индекс цены.

discountValue

вещественный

Размер скидки

bonusUseCase

числовой

Вариант использования бонусов:

  • 0 - скидка;
  • 1 - оплата.

 unit - единица измерения

Объект unit - единица измерения


Свойство

Тип

Значение

code

числовой

Код

name

строоковый

Название

fractional

числовой

Признак весового товара:

  • 1 - весовой;
  • 0 - штучный.
 valut - валюта(тип оплаты)

Объект valut - валюта (тип оплаты)


Свойство

Тип

Значение

code

числовой

Код

name

строковый

Название валюты

shortName

строковый

Сокращенное название валюты

type

числовой

Тип валюты

mode

числовой

Флаги:

  • 1 - оплата только полностью;
  • 2 - оплата без сдачи;
  • 4 - не давать сдачу;
  • 256 - запрет оплаты в чеке продажи;
  • 512 - запрет оплаты в чеке возврата.

(см. Правила использования битовых масок)

merchantIdчисловойКод продавца в платежном терминале

stat

числовой

Статус:

  • 1 - национальная;
  • 2 - базовая;
  • 4 - дополнительная.

rate

вещественный

Зарезервировано для будущего использования

rateCB

вещественный

Зарезервировано для будущего использования

precision

вещественный

Точность округления:

  • 0,01 - до сотых;
  • 0,1 - до десятых;
  • 1 - до целых;
  • 10 - до десятков;
  • 100 - до сотен.

roundMode

числовой

Способ округления:

  • 0 - до ближайшего большего;
  • 1 - математический без потери;
  • 2 - математический с потерей точности;
  • 3 - до ближайшего меньшего;
  • 4 - до ближайшего меньшего с потерей.

drawer

числовой

Зарезервировано для будущего использования

hidden

числовой

Признак:

  • 0 - отображается в списке выбора типов оплаты;
  • 1 - не отображается в списке выбора типов оплаты.

operation

чисолвой

Тип операции дополнительной оплаты:

  • 0 - нет операций;
  • 1 - оплата бонусами;
  • 2 - оплата платежными картами;
  • 3 - оплата сертификатами.

processingConfiguration

строковый

Настройки обращения к процессинговой системе  

 button - кнопка

Объект button - кнопка


Свойство

Тип

Значение

buttonId

числовой

Идентификатор кнопки

code

числовой

Код кнопки

name

строковый

Название кнопки

tag

строковый

Метка

rateobject

числовой

Объект скидки:

  • 0 - скидка на документ;
  • 1 - скидка на позицию.

ratetype

числовой

Тип скидки:

  • 0 - процентная;
  • 1 - суммовая.

ratevalue

вещественный

Размер ставки скидки

maxratevalue

вещественный

Максимальный размер ставки в процентах

minratevalue

вещественный

Минимальный размер ставки в процентах

inputvalue

вещественный

Размер ставки введенный вручную

 cardRecord - запись о карте в документе

Объект cardRecord - запись о карте в документе


Свойство

Тип

Значение

id

числовой

Идентификатор карты

inputSource

числовой

Способ ввода:

  • 1 - вручную;
  • 2 - с помощью сканера;
  • 3 - с помощью ридера.

cardObject

объект

Карта покупателя

dateTime

дата и время

Время применения

bonusBalance

вещественный

Баланс бонусов на карте

bonusBalanceInactiveвещественныйБаланс неактивных бонусов на карте

position

числовой

Номер позиции в документе

Отчеты

 tmclist - список кодов товаров

Объект tmclist - список кодов товаров

СвойствоТипЗначение
tmcстроковыйСписок выбранных кодов товаров, разделенный запятыми

Объекты для сообщений POS-Интеллект (ITV)

 barcode - штрих-код

Объект barcode - штрих-код


Свойство

Тип

Значение

code

строковый

Штрих-код

 error - ошибка при скидке по кнопке

Объект error - ошибка при скидке по кнопке


Свойство

Тип

Значение

text

строковый

Текст ошибки 

 permission - права пользователя

Объект permission - права пользователя


Свойство

Тип

Значение

opcode

Числовой

Код операции

codename

строковый

Наименование команды

username

строковый

Имя пользователя с правами

userid

строковый

Id пользователя с правами

result

Числовой

Результат операции  

 opnumber - номер операции

Объект opnumber - номер операции


Свойство

Тип

Значение

num

строковый

Номер  

 scale - вес
Объект scale - вес


Свойство

Тип

Значение

weight

вещественный

Вес

 box - денежный ящик

Объект box - денежный ящик


Свойство

Тип

Значение

sum

вещественный

Сумма в денежном ящике 

 codec - кодировка выходных данных (Система видеонаблюдения)

Объект codec - кодировка выходных данных (Система видеонаблюдения)


Свойство

Тип

Значение

name

строковый

Название кодека

Структура платежа

 payment - платеж

payment - платеж


Свойство

Тип

Значение

paymentId

строковый

Идентификатор платежа

accountObject

объект

Аккаунт

providerObject

объект

Поставщик

terminalObject

объект

Терминал

subagentObject

объект

Субагент

amount

вещественный

Сумма платежа

dateTime

дата и время

Дата и время платежа

providerSum

вещественный

Сумма комиссии

changeMode

логический

Платеж в режиме сдачи

shiftNumber

числовой

Номер смены

checkNumber

числовой

Номер чека

userCode

строковый

Код кассира

subagentSum

вещественный

Сумма комиссии субагента

paymentItemCode

строковый

Код платежа

paymentItemBcode

строковый

Штрих-код платежа

comissionItemCode

строковый

Код комиссии

comissionItemBcode

строковый

Штрих-код комиссии

databaseId

строковый

Идентификатор базы данных

paymentDepartment

числовой

Номер отдела оплаты

comissionDepartment

числовой

Номер отдела комиссии

 account - аккаунт

account - аккаунт


Свойство

Тип

Значение

accountNumber

строковый

Номер аккаунта

nameстроковыйНаименование аккаунта

providerObject

объект

Поставщик

clientCardRecordObject

объект

Запись о карте клиента 

 clientCardRecord - запись о карте клиента

clientCardRecord - запись о карте клиента


Свойство

Тип

Значение

number

строковый

Номер записи

clientCardObject

объект

Карта клиента  

 clientCard - карта клиента

clientCard - карта клиента


Свойство

Тип

Значение

agentCode

строковый

Код агента

mask

строковый

Маска

transform

строковый

Правило преобразования маски

clientCardMaskId

числовой

Идентификатор маски карты клиента 

 provider - поставщик

provider - поставщик


Свойство

Тип

Значение

providerId

числовой

Идентификатор поставщика

providerCode

строковый

Код поставщика

terminalId

числовой

Идентификатор терминала

categoryId

числовой

Идентификатор категории

name

строковый

Название

inn

строковый

ИНН

phone

строковый

Телефон

address

строковый

Адрес

accountMask

строковый

Маска аккаунта

minSum

вещественный

Минимальная сумма

maxSum

вещественный

Максимальная сумма

bcodeMask

строковый

Маска штрих-кода

bcodeTransform

строковый

Правило преобразования штрих-кода

inputMask

строковый

Маска ввода

inputTransform

строковый

Правило преобразования входных данных

terminalObject

объект

Терминал

categoryObject

объект

Категория

 category - категория

category - категория


Свойство

Тип

Значение

categoryId

числовой

Идентификатор категории

agentCode

строковый

Код агента

categoryCode

строковый

Код категории

name

строковый

Название категории

 terminal - терминал

terminal - терминал


Свойство

Тип

Значение

terminalId

числовой

Идентификатор терминала

terminalCode

строковый

Код терминала

agentCode

строковый

Код агента

address

строковый

Адрес

agentObject

объект

Агент

 agent (subagent) - агент (субагент)

agent (subagent) - агент (субагент)


Свойство

Тип

Значение

code

строковый

Код агента

name

строковый

Название

inn

строковый

ИНН

phone

строковый

Телефон

address

строковый

Адрес

Пользователи


 user - пользователь

user - пользователь


Свойство

Тип

Значение

code

строковый

Код пользователя

nameстроковыйИмя пользователя
groupчисловойГруппа (права), в которую входит пользователь
lockedстроковыйПризнак блокировки пользователя
barcodeстроковыйШтрих-код пользователя
keypositionчисловойТекущее положение ключа
rankстроковыйДолжность пользователя
innстроковыйИНН пользователя
  • No labels