Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Информация о позициях чека, сторнированных позициях, оплатах и других данных представляет из себя вложенные массивы объектов в объекте чека.
Информация по данным о продажах начинается со строки ### sales data begin ### и заканчивается строкой ### sales data end ###. Разделителем объектов являются символы "---".


Code Block
titleСокращенный пример структуры документа
{
"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 – документ отложен.


Info

При значениях 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

...


Свойство
Тип данных
Описание
Примечания
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 подтвержден.


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

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

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

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

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

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

...