Информация о позициях чека, сторнированных позициях, оплатах и других данных представляет из себя вложенные массивы объектов в объекте чека.
Информация по данным о продажах начинается со строки ### sales data begin ### и заканчивается строкой ### sales data end ###. Разделителем объектов являются символы "---".
Сокращенный пример структуры документа
{
"cardPositions":[ ... ],
"sumn":24030.779999999999,
"deptPositions":[ ... ],
"moneyPositions":[ ... ],
"clientPositions":[ ... ],
"organizationPositions":[ ... ],
"buttonPositions":[ ... ],
"userCode":"7",
"disc_perc":0.0,
"paymentPositions":[ ... ],
"shift":3819,
"inventPositions":[{
    "discountPositions":[ ... ],
    "supplier":[ ... ],
    "taxes":[ ... ],
    "bonusPositions":[ ... ],
    "aspectPosition":[ ... ],
    "medicine":[ ... ],
    "agents":[ ... ],
	"inputrawdata": "MTA=",
     }],
"stornoPositions":[{
    "supplier":[ ... ],
    "taxes":[ ... ],
    "medicine":[ ... ],
	"inputrawdata": "MTA=",
    }]
"docSum":24030.779999999999,
"cashCode":"1"
}

Документы (Чеки)

Каждой продаже соответствует документ:

Свойство

Тип данных

Описание

Примечания
actorCodeстроковый

Код пользователя, который подтвердил операцию.

Записываются данные для документов:

  • внесение,
  • выем,
  • возврат,
  • возврат по чеку продажи,
  • сторно всех позиций,
  • аннулирование.

docNum

строковый

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


cardPositions

массив объектов

Список карт, которыми воспользовался клиент


modSum

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

Сумма после изменения цены


docType

числовой

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

  • 1 – продажа,
  • 2 – возврат,
  • 3 – внесение,
  • 4 – выем,
  • 7 – аннулирование продажи,
  • 8 – аннулирование возврата,
  • 13 – остаток денег на начало смены,
  • 16 – документ инвентаризации,
  • 18 – возврат поставщику,
  • 25 – возврат по чеку продажи,
  • 29 – постановка кега на кран,
  • 30 – отключение кега от крана.

baseSum

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

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


timeEnd

время

Время закрытия чека


userCode

строковый

Код кассира


inventPositions

массив объектов

Список позиций товара


shift

числовой

Номер смены


shiftType

числовой

Тип смены:

  • 0 – основная смена,
  • 1 – инвентаризация.

stornoPositions

массив объектов

Список сторнированых позиций товара

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

bonusPositions

массив объектов

Список бонусов


moneyPositions

массив объектов

Список оплат


timeBeg

время

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


docSum

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

Сумма итоговая


cashCode

строковый

Код кассы, на которой произведена продажа


deptPositionsмассив объектовСписок отделов
clientPositionsмассив объектовСписок клиентов
paymentPositionsмассив объектовСписок платежей
buttonPositionsмассив объектовСписок кнопок
dopdataчисловойИдентификатор документа
deptCodeчисловойКод отдела
vbrateвещественныйНе используется
verateвещественныйНе используется
sum2mвещественныйНе используется
summodeчисловойНе используется
sumtypeчисловойНе используется
disc_percвещественныйНе используется
disc_absвещественныйНе используется
sumnвещественныйНе используется
sumeвещественныйНе используется
vatsumвещественныйНе используется
c_linkчисловойНе используется
closedчисловой

Признак закрытия документа:

  • 0 – документ открыт,
  • 1 – документ закрыт,
  • 2 – документ аннулирован,
  • 3 – документ отложен.

При значениях 0 и 3 поля closed документ выгружен не будет.

opidстроковыйНе используется
dateincrementчисловойСмещение рабочей даты (производство)
buttonidчисловойИдентификационный номер кнопки
linkeddocumentidчисловойИдентификационный номер связанного документа
departmentidчисловойИдентификационный номер отдела
clientitemidчисловойИдентификационный номер клиента

identifier

числовойИдентификатор документа
moneyouttypeчисловой

Тип выема денежных средств

  • 0 – обычный выем,
  • 1 – выем без участия кассира,
  • NULL – остальные документы.

urlEgaisстроковыйURL ЕГАИС
digitalSignatureEgaisстроковыйЦифровая подпись ЕГАИС
noPdfUrlEgaisстроковыйURL алкогольного товара без акцизной марки
noPdfDigitalSignatureEgaisстроковыйЦифровая подпись алкогольного товара без акцизной марки
alcosetPositionsмассив объектовАлкогольный набор
сustomeraddressстроковыйРеквизиты покупателя
closewithoutprintчисловой

Закрытие чека без печати:

  • 0 – чек напечатан,
  • 1 – чек закрыт без печати.

sourceidentifierстроковый

Идентификационный номер документа-основания для операций:

  • возврата по чеку продажи на другой кассе,
  • восстановления отложенного чека,
  • аннулирования чека,
  • восстановления онлайн-чека.

backreasonчисловойКод причины возврата
fiscalidentifierстроковыйФискальный идентификатор документаЗаписывается только для ФР с ФН, складывается из номера фискального документа и номера фискального накопителя
frdoccopyтекст
  • Для ФР TFP-115 записывается копия документа продажи/возврата из ФР.
  • Для ФР Штрих с СКНО (Беларусь) записывается значение УИД.

correctionreasonчисловойКод причины коррекции
correctionsourcedocnumстроковыйНомер документа основания для коррекции (внутренний приказ, предписание налоговой и т.п.)
correctionsourcedocdateдата и времяДата документа основания для коррекции
correctiontypeчисловойТип коррекции (самостоятельная или по предписанию)
waybillprintedчисловойПризнак печати универсального передаточного документа
waybillnumberстроковыйНомер универсального передаточного документа
giftPositions

массив объектов

Список подарков


cashtype

строковый

Тип кассы, на которой был закрыт чек:

  • POS,
  • SSCO,
  • VPOS.

Карты – cardPositions

Свойство
Тип данных
Описание
specialDate1датаПервая особая дата клиента
specialDate2датаВторая особая дата клиента
specialDate3датаТретья особая дата клиента
nameClientстроковыйФИО клиента
webpageстроковыйWeb-страница
numberстроковыйНомер карты
nameCardGroupстроковыйНазвание группы, к которой относится карта
extendedOptionsстроковыйТэги
occupationстроковыйРод занятий
okpdстроковыйОКПД
okpoстроковыйОКПО
valutCodeчисловойКод валюты
regexPatternстроковыйМаска номеров карт в виде регулярного выражения
specialDate3NameстроковыйНазвание третьей особой (специальной) даты
textClientстроковыйЗаметки
innстроковыйИНН
lenBegчисловойНачало диапазона длин номеров карт, входящих в группу данной карты
cardSumвещественныйСумма накоплений
sexчисловойПол клиента
inputSourceчисловой

Источник данных (способ ввода карт):

  • 0 – не определено,
  • 1 – вручную,
  • 2 – сканер штрих-кода,
  • 4 – ридер карт,
  • 8 – банковский терминал.
regexRuleстроковыйПравила получения значащей последовательности из номеров карты (регулярное выражение)
specialDate2NameстроковыйНазвание второй особой (специальной) даты
inputMaskчисловойМаска способа ввода карты
specialDate1NameстроковыйНазвание первой особой (специальной) даты
zipcodeстроковыйПочтовый индекс клиента
validityDateEndдатаОкончание периода валидности(действия карты)
phoneNumberстроковыйТелефонный номер клиента
discountValueвещественныйРазмер скидки
lenEndчисловойКонец диапазона длин номеров карт, входящих в группу данной карты
documentстроковыйДанные документа клиента (паспорта, водительского удостоверения и т.д.)
emailстроковыйE-mail
birthdayдатаДень рождения
addressстроковыйАдрес клиента
idClientстроковыйИдентификационный номер клиента
posTimeвремяВремя
idCardGroupчисловойИдентификационный номер группы карт, к которой относится данная карта
prefixEndстроковыйКонец диапазона префикса номеров карт, входящих в группу данной карты
validityDateBegдатаНачало периода валидности(действия карт)
textCardGroupстроковыйТекст относящийся к группе карт, входящих в группу данной карты
idCardстроковыйИдентификационный номер карты
cardModeчисловой

Тип карты:

  • 0 – Дисконтная,
  • 1 – Артикс Бонус,
  • 2 – Артикс:Дисконт,
  • 5 – Карта Террасофт,
  • 6 – Социальная карта,
  • 7 – RS.Loyalty,
  • 8 – CardLab,
  • 9 – Золотая корона,
  • 10 – EPS,
  • 11 – Loymax,
  • 12 – ABMLoyalty,
  • 17 – UDS,
  • 18 – Plazius,
  • 19 – Manzana2019,
  • 20 – KilBil,
  • 21 – Единая Карта Петербуржца,
  • 23 – Manzana Loyalty Online,
  • 24 – Mindbox.
prefixBegстроковыйНачало диапазона префикса номеров карт, входящих в группу данной карты
bonusBalanceвещественныйБаланс бонусов
discountTypeчисловойТип скидки
childrenCountчисловойКоличество детей клиента
carditemidчисловойИдентификационный номер карты
documentidчисловойИдентификационный номер документа
itemorderчисловойПорядок добавления карты
positionnumberчисловойНомер позиции в чеке в момент применения карты
clientitemidчисловойИдентификационный номер клиента

cashcode

числовойКод кассы
cardstatusчисловой

Статус карты:

  • 0 – только начисление (анонимная),

  • 1 – начисление и оплата (активная),

  • 2 – заблокирована,

  • 3 – только начисление.
rawdataстроковыйНомер карты без преобразований
verificationtypeчисловой

Тип верификации карты:

  • NULL – без верификации,
  • другие значения – по полю idverification в таблице verification БД Dictionaries.
bonusbalanceinactive вещественныйБаланс неактивных бонусов
purchases вещественныйКоличество покупок
operationinfoтекстИнформация о совершенных операциях
hashстроковыйХэш номера карты
optionsцелочисленный

Опции карты (битовая маска):

  • 1 – запрещен возврат бонусных баллов.

Клиенты – clientPositions

Свойство
Тип данных
Описание
Примечания
clientitemidчисловойИдентификационный номер клиента
idclientстроковый

Идентификатор клиента, полученный извне


nameстроковыйФИО клиента
textстроковыйЗаметки клиента
sexчисловойПол клиента
birthdayдатаДата дня рождения клиента
specialdate1датаПервая особенная дата для клиента
specialdate2датаВторая особенная дата для клиента
specialdate3датаТретья особенная дата для клиента
specialdate1nameстроковыйПоясняющая информация по первой особенной дате для клиента
specialdate2nameстроковыйПоясняющая информация по второй особенной дате для клиента
specialdate3nameстроковыйПоясняющая информация по третьей особенной дате для клиента
zipcodeстроковыйПочтовый индекс клиента
addressстроковыйАдрес клиента
emailстроковыйE-mail адрес клиента
webpageстроковыйАдрес web-страницы клиента
phonenumberстроковыйНомер телефона клиента
innстроковыйИНН клиента
documentстроковыйДанные документа клиента (паспорта, водительского удостоверения и проч.)
okpoстроковыйНомер ОКПО клиента
okpdстроковыйНомер ОКПД клиента
occupationстроковыйРод занятий клиента
childrencountчисловойКоличество детей у клиента
extendedoptionsстроковыйДополнительные опции у клиента

cashcode

строковыйКод кассы

organizationcode

строковый

Уникальный код организации


organizationid

строковый

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


optionsчисловой

Опции, установленные для клиента (битовая маска):

  • none – нет установленных опций,

  • sendCheckToEmail – отправлять чек на e-mail,

  • emailConfirmed – e-mail подтвержден.

Реализовано только для лояльности Артикс Бонус.

Для отправки чека на e-mail необходимо установить sendchecktoemail = 1 и emailconfirmed = 1.

Подробнее о функционале отправки чеков на электронную почту можно прочитать в разделе  "Отправка чека на адрес покупателя"

Организации – organizationPositions

СвойствоТип данныхОписание
idстроковыйИдентификатор записи в БД
codeстроковыйИдентификатор организации
innстроковыйИНН организации
nameстроковыйНазвание организации

Товарные позиции – inventPositions

Свойство
Тип данных
Описание
baseSumвещественныйСумма до изменения цены вручную и до применения скидок
opCodeчисловой

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

  • 50 – продажа,

  • 51 – сторно продажи,

  • 52 – продажа суммой в отдел,

  • 53 – сторно продажи суммой в отдел,

  • 56 – возврат суммой в чеке продажи,

  • 57 – сторно возврата суммой в чеке продажи,

  • 58 – возврат,

  • 59 – сторно возврата,

  • 60 – возврат суммой в отдел,

  • 61 – сторно возврата суммой в отдел,

  • 62 – возврат тары,

  • 63 – продажа сертификата,

  • 64 – возврат сертификата,

  • 70 – аннулирование продажи,

  • 71 – аннулирование возврата,

  • 200 – инвентаризация,

  • 201 – инвентаризация суммой в отдел,

  • 250 – возврат поставщику,

  • 260 – заказ,

  • 300 – выдача наличных покупателю,
  • 350 –  постановка кега на кран,
  • 351 – отключение кега от крана,
  • 1000 – "внешний" платеж в чеке продажи,

  • 1002 – "внешний" платеж в чеке возврата,

  • 1004 – комиссия к "внешнему" платежу в чеке продажи,

  • 1006 – комиссия к "внешнему" платежу в чеке возврата,

  • 1010 – режим обучения контрольным весам,

  • 1011 – превышение номинальной стоимости подарочного сертификата (карты) над продажной ценой товара.

discountPositionsмассив объектовСписок скидок
quantModeстроковыйСпособ ввода количества:
  • default – количество товара по умолчанию,
  • manual – количество товара введено вручную,
  • fromBarCode – количество получено из штрих-кода,
  • fromScales – количество получено с весов,
  • external – количество задано внешней процедурой,
  • softCheck – количество получено из софт-чека.
posNumчисловойНомер позиции в чеке
bcodeModeстроковыйСпособ ввода штрих-кода:
  • manual – ручной ввод,
  • scanner – сканером,
  • hotkey – горячей клавишей,
  • selected – выбран из справочника,
  • quickCode – введен с помощью быстрого кода,
  • complect – введен как составная часть комплекта,
  • external – введен внешней процедурой,
  • mcr – с ридера магнитных карт,
  • softCheck – введен из софт-чека,
  • goodsdetector – через распознавание.
quantчисловойКоличество
priceIndexчисловойИндекс цены (код колонки цены)
priceвещественныйЦена
modSumвещественныйСумма после изменения цены вручную (без скидки)
deptCodeчисловойКод отдела
minPriceвещественныйМинимальная цена
minretailpriceвещественный

Минимальная розничная цена

posTimeвремяВремя продажи
nameстроковыйНаименование товара
userCodeстроковыйКод кассира
barCodeстроковыйШтрих-код товара
accountingQuantчисловойКоличество товара в учетных единицах
finalPriceвещественныйИтоговая цена, после изменения цены вручную
supplierмассив объектовСписок поставщиков
taxesмассив объектовСписок налогов
posSumвещественныйИтоговая сумма, после изменения цены вручную и после применения скидок
inventCodeстроковыйКод товара
bonusPositionsмассив объектовСписок бонусов
articulстроковыйАртикул
measureCodeчисловойКод единицы измерения
priceTypeчисловой

Код схемы скидок

dopdataчисловойИдентификатор товарной позиции
docNumстроковыйНомер документа
statusчисловойСтатус документа
bcode_mainстроковыйШтрих-код комплекта товаров
ost_modifчисловойНе используется
pricevcodeчисловойКод типа оплаты
priceModeчисловойСпособ ввода цены
disc_percвещественныйНе используется
disc_absвещественныйСумма скидки
sumeвещественныйНачальная сумма до применения скидки
vatcode1числовойКод налога 1
vatrate1вещественныйСтавка налога 1
vatsum1вещественныйСумма налога 1
vatcode2числовойКод налога 2
vatrate2вещественныйСтавка налога 2
vatsum2вещественныйСумма налога 2
vatcode3числовойКод налога 3
vatrate3вещественныйСтавка налога 3
vatsum3вещественныйСумма налога 3
vatcode4числовойКод налога 4
vatrate4вещественныйСтавка налога 4
vatsum4вещественныйСумма налога 4
vatcode5числовойКод налога 5
vatrate5вещественныйСтавка налога 5
vatsum5вещественныйСумма налога 5
c_linkчисловойНе используется
frnumчисловойНомер ККМ
extendetoptionsстроковыйДополнительные опции
opidстроковыйНе используется
buttonidчисловойИдентификационный номер кнопки
paymentitemidчисловойИдентификационный номер платежа
extdocidстроковыйИдентификатор софт-чека
departmentidчисловойИдентификационный номер отдела
taramodeчисловой

Режим использования тары:

taracapacityвещественныйВместимость тары (используется, если taramode = 1)
cashcodeчисловойКод кассы

aspectPosition

массив значенийНабор разрезов для позиции
excisemarkстроковыйШтрих-код акцизной марки
alcoholPercentчисловойПроцент алкоголя товара
kppстроковыйКПП производителя
innстроковыйИНН производителя
consultantidстроковыйКод консультанта
additionalexcisemarkстроковыйСерия и номер акцизной марки (дополнительный штрих-код DataMatrix акцизной марки)
alcocodeстроковыйАлкокод акцизных товаров
additionalbarcode строковыйДополнительный штрих-код
additionaldata строковыйДополнительные данные
alctypecode числовой

Код вида алкогольной продукции. По умолчанию NULL.

При значении NULL или 0 считается незаполненным.

aspectschemecode числовойКод схемы разреза
tags строковый

Метки товара. Товар может иметь несколько меток, разделенных символом ";":

  • social – товар является социальным,
  • rfid – товар является меховым изделием,
  • excise – товар является подакцизным алкоголем,
  • nonexcise – товар является безакцизным алкоголем,
  • tobacco – товар является табачным,
  • shoes – товар является обувным,
  • lottery – товар является лотерейным билетом,
  • forbidBack – возврат товара запрещен,
  • medicine – товар является лекарственным препаратом,
  • protectiveMeans – товар является средством индивидуальной защиты,
  • markedgoods – товар является маркированным,
  • prescription – товар отпущен по электронному рецепту,
  • gift – товар является подарком,
  • markdown – товар является уцененным,
  • draftBeer – разливное пиво.
paymentobjectчисловойПризнак предмета расчета
paymentmethodчисловойПризнак способа расчета
manufacturercountrycodeчисловойКод страны происхождения товара
customsdeclarationnumber

строковый

Номер таможенной декларации
pricedoctypeчисловойТип документа для переоценки
prepackagedчисловой

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

  • 0 – товар нерасфасован,
  • 1 – товар расфасован.
excisetypeстроковыйТип акцизной марки:
  • ALCOHOL,
  • TOBACCO,
  • SHOES,
  • MEDIC,
  • PROT,
  • DRAFTBEER,
  • MARKEDGOODS.
giftобъект

Товар является подарком.

Данный объект заполняется если isfiscal = 1 (подарок был продан как товар).

ntinстроковыйКод национального классификатора товаров
checkmarkresultчисловойРезультат проверки кода маркировки (тег 2106)
markingcodeстроковыйКод маркировки до любых преобразований в формате base64
inputrawdataстроковыйИсходные данные до любых преобразований в формате base64, полученные при добавлении товара
ownertypeчисловойТип владельца продукта/услуги:
  • 0 – перепродажа,
  • 1 – товар собственного производства,
  • 2 – услуга.
expirationdateдата и времяПредельная дата реализации
groupcodevarchar(255)Код группы товаров
groupnamevarchar(255)Название группы товаров

Налоги – taxes

Свойство
Тип данных
Описание
taxRateвещественныйНалоговая ставка
taxCodeчисловойКод налоговой ставки
taxSumвещественныйСумма налога

Отделы – deptPositions

Свойство
Тип данных
Описание
departmentidчисловойИдентификатор отдела
departmentcodeчисловойКод отдела
departmentnameстроковыйНазвание отдела
clientitemidчисловойИдентификационный номер клиента
documentprefixстроковыйПрефикс документа
documentnumberстроковыйНомер документа
cashcodeстроковыйКод кассы

Скидки – discountPositions

Свойство
Тип данных
Описание
isPositionDiscountлогическийПризнак скидки на позицию: 
  • true – скидка на позицию,
  • false – на чек.
userCodeстроковыйКод кассира
discTypeстроковыйТип скидки: 
  • percent – процентная,
  • summ – абсолютная,
  • index – цена установлена из колонки цен,
  • price – фиксированная цена,
  • bonus – бонус.
checkSumвещественныйСумма, от которой рассчитана скидка:
  • для скидки на чек – сумма чека,
  • для скидки на позицию – сумма позиции.
discNameстроковыйНазвание (описание) скидки
cardNameстроковыйНазвание карты (для скидок по карте)
discSchemeчисловойКод группы (схемы) скидок
discModeстроковый

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

  • automatic – автоматическая,
  • byCard – по карте,
  • fixed – фиксированная,
  • byPayment – скидка на оплату,
  • byPaymentCard – по карте оплаты,
  • byDiscKit – на набор,
  • byChange – "на мелочь" (округление),
  • certificate – оплата сертификатом,
  • byCoupon – по купону,
  • fiscalRound – фискальное округление,
  • correction – корректирующая.
discSumвещественныйСумма скидки
cardTypeчисловойТип карты, по которой начислена скидка
cardNumberстроковыйНомер карты, по которой начислена скидка
discCodeчисловойКод скидки в группе
additionalpriceобъектДополнительная цена
accumulateSumчисловойНе используется
discNumberчисловойНомер скидки (в порядке применения)
discSizeвещественныйРазмер скидки:
  • % для скидки с типом 1,
  • сумма для скидки с типом 2,
  • номер колонки для скидки с типом 3.
posTimeдата и времяВремя применения скидки
discitemidчисловойИдентификационный номер скидки
goodsitemidчисловойИдентификационный номер позиции документа
positionnumчисловойНомер товарной позиции
carditemidчисловойИдентификационный номер карты
cashcodeчисловойКод кассы
discsystemстроковый

Номер дисконтной системы, к которой принадлежит скидка:

  • 1 – воздействие из первого дерева дисконта,
  • 2 – воздействие из второго дерева дисконта.
sessionidvarchar(255)Идентификатор транзакции 

Дополнительные цены – additionalPrice

СвойствоТип данныхОписание
additionalpriceidчисловойИдентификационный номер дополнительной цены
discitemidчисловойИдентификационный номер скидки
documentidчисловойИдентификатор документа
effectivedateдата и времяДата переоценки
nameстроковыйНазвание цены

Бонусы – bonusPositions

СвойствоТип данныхОписание
bonusitemidчисловойИдентификационный номер бонуса
documentidчисловойИдентификационный номер документа
goodsitemidчисловойИдентификационный номер позиции документа
posnumчисловойПорядковый номер операции
opCodeчисловойКод операции. 
  • 1200 – начисление,
  • 1202 – списание,
  • 1204 – возврат списанных бонусов.
cardNumberстроковыйНомер карты, с которой списаны бонусы
amountвещественныйСумма начисления/списания
posTimeдата и времяДата и время добавления бонусных воздействий
valCodeчисловой

Код валюты (из справочника валют)

initialSumвещественныйСумма бонусов до списания и начисления на карту бонусов
scodeстроковыйКод кассира
cashcodeчисловойКод кассы
campaignidчисловойИдентификатор акции
ispositionbonusчисловойПризнак начисления на позицию
bonusnumberчисловойПорядковый номер начисления
assettimebeg дата и времяДата и время активации бонуса
assettimeend дата и времяДата и время аннулирования бонуса
campaignnameстроковыйНазвание акции
weight числовойВес акции. Необходим для определения порядка расходования
transactionidстроковыйИдентификатор операции
discountcodeцелочисленныйКод правила начисления акции

Оплаты – moneyPositions

СвойствоТип данныхОписаниеПримечания
dopdataчисловойИдентификационный номер оплатыПри выгрузке продаж через SOAP вместо этого поля используется поле moneyitemid
docNumчисловойИдентификационный номер документа
acodeстроковыйНе используется
userCodeстроковыйКод кассира
posTimeдата и времяДата и время оплаты
opCodeчисловойКод операции:
  • 44 – остаток денег на начало смены (увеличение суммы в денежном ящике),
  • 70 – прием денег от покупателя при продаже (увеличение суммы в денежном ящике),
  • 72 – сдача по продаже (уменьшение суммы в денежном ящике),
  • 74 – выдача денег покупателю по возврату (уменьшение суммы в денежном ящике),
  • 76 – сдача по возврату (увеличение суммы в денежном ящике),
  • 80 – внесение (увеличение суммы в денежном ящике),
  • 82 – выем (уменьшение суммы в денежном ящике),
  • 100 – выдача денег при аннулировании продажи (уменьшении суммы в денежном ящике),
  • 101 – сдача при аннулировании продажи (увеличение суммы в денежном ящике),
  • 102 – прием денег при аннулировании возврата (увеличение суммы в денежном ящике),
  • 103 – сдача при аннулировании возврата (уменьшение суммы в денежном ящике),
  • 104 – коррекция прихода (сумма в денежном ящике не изменяется),
  • 105 – коррекция расхода (сумма в денежном ящике не изменяется),
  • 300 – выдача наличных покупателю.

valCodeчисловой

Код типа оплаты (из справочника валют)


nrateвещественныйНе используется
bondвещественныйНе используется
bond_quantчисловойНе используется
vsumвещественныйНе используется
sumBвещественныйИтоговая сумма оплаты
sumnвещественныйНе используется
sumeвещественныйНе используется
c_linkчисловойНе используется
frnumчисловойНомер ККМ
cardnumстроковыйНомер карты
cashcodeстроковыйКод кассы
valutOperationчисловой

Тип операции в валюте:

  • 0 – оплата наличными,
  • 3 – оплата сертификатом,
  • 10 – оплата банковской картой,
  • 11 – онлайн-оплата.

valNameстроковыйНазвание валюты
balanceвещественныйБаланс сертификата
operationIdстроковыйИдентификационный номер операции
discnumberчисловойНомер скидки
slip текстПечатный образ мини-выписки (заполняется при использовании внешнего процессинга)
authcodeстроковыйКод авторизации, который возвращает банковская система во время проведения транзакции
merchantidстроковыйКод продавца в платежном терминале
sourceoperationidстроковыйИдентификатор (RRN) транзакции, по которому выполняется отмена
paymentmethodчисловой

Способ оплаты:

  • 0 – не определено,
  • 1 – по карте,
  • 2 – по QR-коду,
  • 3 – по биометрии.

При оплате по QR-коду данные заполняются для следующих процессингов:

При оплате по биометрии данные заполняются для процессинга Сбербанк.

endcardnumчисловойПоследние 4 цифры номера карты для быстрого поиска
additionaldataтекстДополнительные данные

При оплате через Белэксимгарант записывается информация о страховом полисе:

  • начало действия полиса,
  • конец действия полиса,
  • дата последнего изменения баланса,
  • код подразделения,
  • ФИО клиента,
  • баланс,
  • номер полиса,
  • серия полиса.

При оплате через процессинг Сбербанка записывается json-объект с полями:

  • флаги операции,
  • способ чтения номера карты.

Оплаты с отказом – failedMoneyPositions

Свойство

Тип данных

Описание


failedmoneyitemid

числовой

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


documentid

числовой

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


scode

строковый

Код кассира


mtime

дата и время

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


opcode

числовой

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

  • 70 – прием денег от покупателя при продаже (увеличение суммы в денежном ящике),
  • 74 – выдача денег покупателю по возврату (уменьшение суммы в денежном ящике).

valcode

числовой

Код типа оплаты с отказом


sumb

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

Сумма оплаты с отказом


docnum

строковый

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


frnum

числовой

Номер ККМ


cardnum

строковый

Номер карты


cashcodeстроковыйКод кассы
slipтекстПечатный образ мини-выписки
valutoperationчисловой

Тип операции в валюте:

  • 3 – оплата сертификатом,
  • 10 – оплата банковской картой.

valnameстроковыйНазвание валюты
merchantidстроковыйКод продавца в платежном терминале
endcardnumстроковыйПоследние 4 цифры номера карты для быстрого поиска
terminalidстроковыйИдентификационный номер терминала
additionaldataтекстДополнительные данные

При оплате через Белэксимгарант записывается информация о страховом полисе:

  • начало действия полиса,
  • конец действия полиса,
  • дата последнего изменения баланса,
  • код подразделения,
  • ФИО клиента,
  • баланс,
  • номер полиса,
  • серия полиса.

Платежи – paymentPositions

Свойство
Тип данных
Описание
cashcode

строковый

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

paymentidстроковыйСистемный идентификатор платежа
cardnumberстроковыйНомер карты клиента
paymentitemidчисловойИдентификационный номер платежа
terminalcodeстроковыйКод терминала оплаты
terminaladdressстроковыйФизический адрес терминала оплаты
creationtimeдата и времяВремя создания платежа
accountnumberстроковыйНомер счета
amountвещественныйСумма платежа
commissionagentвещественныйСумма комиссии агента
commissionsubagentвещественныйСумма комиссии субагента
providercodeстроковыйКод провайдера, предоставляющего услугу
providernameстроковыйНазвание провайдера, предоставляющего услугу
providerinnстроковыйИНН провайдера
providerphoneстроковыйНомер телефона провайдера
provideraddressстроковыйФизический адрес провайдера
categorycodeстроковыйКод категории
categorynameстроковыйНазвание категории
agentcodeстроковыйКод агента, предоставляющего услугу
agentnameстроковыйНазвание агента
agentinnстроковыйИНН агента
agentphoneстроковыйНомер телефона агента
agentaddressстроковыйФизический адрес агента
subagentcodeстроковыйКод субагента
subagentnameстроковыйИмя субагента
subagentinnстроковыйИНН субагента
subagentphoneстроковыйНомер телефона субагента
subagentaddressстроковыйФизический адрес субагента

Сторнированные позиции – stornoPositions

Свойство
Тип данных
Описание
Примечания
baseSumвещественныйСумма до изменения цены вручную и до применения скидок
opCodeчисловой

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

  • 50 – продажа,

  • 51 – сторно продажи,

  • 52 – продажа суммой в отдел,

  • 53 – сторно продажи суммой в отдел,

  • 54 – возврат в чеке продажи,

  • 55 – сторно возврата в чеке продажи,

  • 56 – возврат суммой в чеке продажи,

  • 57 – сторно возврата суммой в чеке продажи,

  • 58 – возврат,

  • 59 – сторно возврата,

  • 60 – возврат суммой в отдел,

  • 61 – сторно возврата суммой в отдел,

  • 62 – возврат тары,

  • 63 – продажа сертификата,

  • 64 – возврат сертификата,

  • 70 – аннулирование продажи,

  • 71 – аннулирование возврата,

  • 200 – инвентаризация,

  • 201 – инвентаризация суммой,

  • 250 – возврат поставщику,

  • 260 – заказ,

  • 300 – выдача наличных покупателю,
  • 350 –  постановка кега на кран,
  • 351 – отключение кега от крана,
  • 1000 – "внешний" платеж в чеке продажи,

  • 1002 – "внешний" платеж в чеке возврата,

  • 1004 – комиссия к "внешнему" платежу в чеке продажи,

  • 1006 – комиссия к "внешнему" платежу в чеке возврата,

  • 1010 – режим обучения контрольным весам,

  • 1011 – превышение номинальной стоимости подарочного сертификата (карты) над продажной ценой товара.


quantModeстроковый

Способ ввода количества:

  • default – количество по умолчанию,
  • manual – количество введено вручную,
  • fromBarCode – количество из отсканированного штрих-кода,
  • fromScales – количество получено с весов,
  • external – количество задано внешней процедурой,
  • softCheck – количество получено из софт-чека.

posNumчисловойНомер позиции в чеке
bcodeModeстроковый

Способ ввода штрих-кода:

  • manual – ручной ввод,
  • scanner – сканером,
  • hotkey – горячей клавишей,
  • selected – выбран из справочника,
  • quickCode – введен с помощью быстрого кода,
  • complect – введен как составная часть комплекта,
  • external – введен внешней процедурой,
  • mcr – введен с ридера магнитных карт,
  • softCheck – введен из софт-чека,
  • goodsdetector – через распознавание.

quantчисловойКоличество
priceIndexчисловойИндекс цены (код колонки цены)
priceвещественныйЦена
modSum вещественный Сумма после изменения цены вручную (без скидки)
deptCode числовойКод отдела
posTimeвремяВремя продажи
nameстроковыйНаименование товара
userCodeстроковыйКод кассира
barCodeстроковыйШтрих-код товара
accountingQuantчисловойКоличество товара в учетных единицах
finalPriceвещественныйИтоговая цена, после изменения цены вручную
supplierмассив объектовСписок поставщиков
taxesмассив объектовСписок налогов
posSumвещественныйИтоговая сумма, после изменения цены вручную и после применения скидок
inventCodeстроковый

Код товара


minPriceвещественныйМинимальная цена
minretailpriceвещественныйМинимальная розничная цена
articulстроковыйАртикул
measureCodeчисловойКод единицы измерения
priceTypeчисловойКод схемы скидок
extendetoptionsстроковыйДополнительные опции товара
cashcodeстроковыйКод кассы
taramodeчисловой

Режим использования тары:


taracapacityвещественныйВместимость тары (актуально для значения taramode = 1)
departmentidчисловойИдентификационный код отдела
paymentitemidчисловойИдентификационный код платежа
buttonidчисловойИдентификационный код кнопки
opidстроковыйИдентификационный номер пользователя, подтвердившего операцию
frnumчисловойНомер ККМ
c_linkчисловойНе используется
docnumСтроковыйНомер документа
dopdataчисловойИдентификатор сторнированной позицииПри выгрузке продаж через SOAP используется поле stornogoodsitemid
statusчисловойСтатус
bcode_mainвещественныйШтрих-код комплекта товаров
ost_modifчисловойНе используется
pricevcodeчисловойКод типа оплаты
priceModeчисловойСпособ ввода цены
disc_percвещественныйНе используется
disc_absвещественныйСумма скидки
sumeвещественныйНачальная сумма до применения скидок
timeStornoвремяВремя сторнирования
docNumчисловойНомер документа
vatcode1числовойКод налога 1
vatrate1вещественныйСтавка налога 1
vatsum1вещественныйСумма налога 1
vatcode2числовойКод налога 2
vatrate2вещественныйСтавка налога 2
vatsum2вещественныйСумма налога 2
vatcode3числовойКод налога 3
vatrate3вещественныйСтавка налога 3
vatsum3вещественныйСумма налога 3
vatcode4числовойКод налога 4
vatrate4вещественныйСтавка налога 4
vatsum4вещественныйСумма налога 4
vatcode5числовойКод налога 5
vatrate5вещественныйСтавка налога 5
vatsum5вещественныйСумма налога 5
excisemarkстроковыйШтрих-код акцизной марки
alcoholPercentчисловойПроцент алкоголя товара
kppстроковыйКПП производителя
innстроковыйИНН производителя
consultantidстроковыйКод консультанта
additionalexcisemarkстроковыйСерия и номер акцизной марки (дополнительный штрих-код DataMatrix акцизной марки)
additionalbarcode строковыйДополнительный штрих-код
alctypecode числовой

Код вида алкогольной продукции. По умолчанию NULL.

При значении NULL или 0 считается незаполненным


aspectschemecode числовойКод схемы разреза
paymentobjectчисловойПризнак предмета расчета
paymentmethodчисловойПризнак способа расчета
manufacturercountrycodeчисловойКод страны происхождения товара
tagsстроковый

Метки товара:

  • social – товар является социальным,
  • rfid – товар является меховым изделием,
  • excise – товар является подакцизным алкоголем,
  • nonexcise – товар является безакцизным алкоголем,
  • tobacco – товар является табачным,
  • shoes – товар является обувным,
  • lottery – товар является лотерейным билетом,
  • forbidBack – возврат товара запрещен,
  • medicine – товар является лекарственным препаратом,
  • protectiveMeans – товар является средством индивидуальной защиты,
  • markedgoods – товар является маркированным,
  • gift – товар является подарком,
  • markdown – товар является уцененным,
  • draftBeer – разливное пиво.

Товар может иметь несколько меток, разделенных символом ";"

customsdeclarationnumber

строковый

Номер таможенной декларации
pricedoctypeчисловой

Тип документа для переоценки (основание для формирования цены):

  • 1 – переоценка,
  • 2 – распродажа,
  • 3 – цена увеличена до минимальной,
  • 4 – из набора значений разрезов,
  • 5 – маркетинговая акция,
  • 6 – получение цены от удаленного сервиса.

prepackagedчисловой

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

  • 0 – товар нерасфасован,
  • 1 – товар расфасован.


excisetypevarcharТип акцизной марки:
  • ALCOHOL,
  • TOBACCO,
  • SHOES,
  • MEDIC,
  • PROT,
  • DRAFTBEER,
  • MARKEDGOODS.

ntinстроковыйКод национального классификатора товаров
checkmarkresultчисловойРезультат проверки кода маркировки (тег 2106)
markingcodeстроковыйКод маркировки до любых преобразований в формате base64
inputrawdataстроковыйИсходные данные до любых преобразований в формате base64, полученные при добавлении товара
ownertypeчисловойТип владельца продукта/услуги:
  • 0 – перепродажа,
  • 1 – товар собственного производства,
  • 2 – услуга.

expirationdateдата и времяПредельная дата реализации
groupcodeстроковыйКод группы товаров


groupnameстроковыйНазвание группы товаров


Разрезы – aspectPosition

Свойство
Тип данных
Описание

aspectitemid

строковыйИдентификатор разреза
goodsitemidстроковыйИдентификатор товара
aspectcodeстроковыйКод разреза
aspectvaluecodeстроковыйКод значения разреза
cashcodeстроковыйКод кассы
productsectioncodeстроковыйКод разреза характеристики

Кнопки – buttonPositions

Свойство
Тип данных
Описание

buttonid

числовойИдентификатор кнопки
cashcodeстроковыйКод кассы
inputvalueвещественныйРазмер ставки, введенный вручную
minratevalueвещественныйМинимальное размер ставки в процентах
maxratevalueвещественныйМаксимальное размер ставки в процентах
ratevalueвещественныйРазмер ставки скидки
ratetypeлогический

Тип скидки:

  • процентная,
  • суммовая.
rateobjectлогический

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

  • чек,
  • позиция.
tagстроковыйМетка
nameстроковыйНазвание кнопки
codeчисловойКод кнопки

Сертификаты – certificatePositions

СвойствоТип данныхОписание

balance

вещественныйТекущий баланс (при полном списании равен 0)

certificateid

числовойУникальный ID сертификата

code

строковыйКод группы сертификатов

fullyspend

числовой

Использование полного списания:

  • 1 – полное списание,
  • 0 – частичное списание.

name

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

number

строковыйНомер сертификата

paymentsum

вещественныйСумма оплаты сертификатом

sum

вещественныйНоминал сертификата

Купоны – couponPosition

СвойствоТип данныхОписаниеПримечания

couponid

числовой

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


carditemid

числовой

Внешний ключ карты

Не используется, выгружается со значением null

number

строковый

Номер купона, получаемый из системы лояльности LM


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

Величина вознаграждения

Не используется, выгружается со значением null
offernameстроковыйНаименование акцииНе используется, выгружается со значением null
couponconditionтекстУсловия акцииНе используется, выгружается со значением null
dateusedдата и времяДата использования купона
dateexpirationдата и времяДата окончания срока действия купона
typeчисловой

Тип купона:

  • 1 – Artix,
  • 2 – online.

statusчисловой

Статус купона:

  • 1 – купон выдан,
  • 2 – купон использован (погашен),
  • 3 – купон не использован.

datebeginдата и времяДата начала срока действия купона
documentidчисловойДокумент, в котором был выдан/погашен купон
campaignidчисловойИдентификатор акции
campaingnameстроковыйНазвание акции
generatednumberстроковыйНомер купона, генерируемый кассовой программой

Поставщики – supplier

СвойствоТип данныхОписание
agentpaymentobjectцелочисленныйПризнак агента по предмету расчета:
  • 1 – БАНК. ПЛ. АГЕНТ,
  • 2 – БАНК. ПЛ. СУБАГЕНТ,
  • 4 – ПЛ. АГЕНТ,
  • 8 – ПЛ. СУБАГЕНТ,
  • 64 – АГЕНТ.
codeстроковыйКод поставщика
innстроковыйИНН поставщика
nameстроковыйНаименование поставщика
phoneстроковыйТелефон поставщика

Консультант – consultant

Свойство

Тип данных

Описание

consultantid

целочисленный

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

goodsitemid

целочисленный

Идентификационный номер позиции документа

stornogoodsitemid

целочисленный

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

code

строковый

Код консультанта

name

строковый

ФИО консультанта

Фискальная информация о документе – fiscaldocument

Реализовано хранение фискальной информации о документе для ФР Атол, Штрих и Пирит.

Свойство

Тип данных

Описание

Примечания

fiscaldocumentid

целочисленный

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

documentid

целочисленный

Идентификационный номер документа
fnnumberстроковыйНомер ФН
serialnumстроковыйСерийный номер ККТ
fdnumberцелочисленныйНомер ФД
taxsystemстроковый

Система налогообложения:

  • OSN – общая система налогообложения,
  • USN1 – упрощенная система налогообложения,
  • USN2 – упрощенная система налогообложения (доход – расход),
  • ENVD – единый налог на вменённый доход,
  • ESHN – единый сельскохозяйственный налог,
  • PATENT – патентная система налогообложения.


shiftnumberстроковыйСмена в ФР
sumвещественныйСумма документа
hasofdticketцелочисленный

Наличие квитанции от ОФД:

  • 0 – квитанция отсутствует,
  • 1 – квитанция получена.


fndateдата и времяДата и время регистрации документа в ФН
ofddateдата и времяДата и время регистрации документа в ОФД
fiscalsignстроковыйФискальный признак
ofdfiscalsignстроковыйФискальный признак от ОФД
updatetimeдата и времяВремя обновления фискальной информации о документе
tlvтекст

Содержит json-объект с tlv-данными документа из ФН

Необходимо включить плагин fdcontroller. После обновления фискальных данных поле будет заполнено

Список подарков – giftPositions

Данный массив заполняется если isfiscal = 0 (подарок был выдан как не товар).

Свойство

Тип данных

Описание

Примечания

bcode

строковый

Штрих-код подарка


documentid

целочисленный

Идентификатор документа, в котором был выдан подарок
giftid

целочисленный

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


goodsitemidцелочисленныйИдентификатор подарка

Если подарок был продан как товар, то будет указано значение поля goodsitemid из таблицы documents.goodsitem.

Если подарок был продан не как товар, то будет указано значение NULL

isfiscalцелочисленный

Флаг, был ли подарок выдан как товар:

  • 0 – подарок не будет зарегистрирован в ФР,
  • 1 – подарок будет зарегистрирован в ФР.

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

Иначе все данные будут записаны в inventPositions в gift

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

Лекарственные препараты – medicine

Свойство

Тип данных

Описание

Примечания
codeцелочисленныйКод лекарственного препарата
countryстроковый

Страна производителя товара


innтекст

МНН ( международное непатентованное название)

Может указываться через запятую
optionsцелочисленный

Опции товара (битовая маска):

  • 1 – требуется рецепт,
  • 2 – лекарство входит в "Перечень лекарственных средств обязательных для наличия в аптеках",
  • 4 – лекарство входит в "Основной перечень лекарственных средств",
  • 8 – запрещена продажа последней единицы.

partyстроковыйПартия
producerстроковыйПроизводитель
seriesстроковыйСерия
shelflifeдатаСрок годности

Платежные агенты – agents

Свойство

Тип данных

Описание

Примечания
payingagentphonesстроковый

Список телефонов платежного агента

Может указываться через запятую
receivepaymentsoperatorphonesстроковый

Список телефонов оператора по приему платежей

Может указываться через запятую
transferoperatoraddressстроковый

Адрес оператора перевода


transferoperatorinnстроковый

ИНН оператора перевода


transferoperatornameстроковый

Наименование оператора перевода


transferoperatorphoneстроковый

Телефон оператора перевода


  • No labels