Обмен данными о чеках/заказах

Файл check содержит информацию о чеках/заказах и магазинах/брендах, где были проведены чеки.
Цель обмена: отображать информацию о чеках в LC, с возможностью просмотра статистики продаж в разрезе товаров, дат и покупателей, аналитика, формирование предложений, отображение покупок в личном кабинете покупателя в телеграм боте.
Частота обмена данными: максимально быстро по мере появления новых записей или изменения старых. Максимально допустимая задержка – 5 минут.
Направление: ERP —> LC

Структура

CheckJson

Имя	Описание	Схема
purchases обязательно	Описание чека	Purchases

Purchases

Имя	Описание	Схема
count обязательно	Количество чеков в документе	integer (int64)
purchase обязательно	Список чеков	< PurchaseType > array

PurchaseType

Имя	Описание	Схема
accrualBonuses необязательно	Начисляемые за чек бонусы. Используется в бонусном процессинге LC при запросе пречека	< AccrualBonusesType > array
amount обязательно	Сумма чека	number (double)
amountWithDiscount необязательно	Сумма чека после применения скидки. Используется при скидочном процессинге на стороне LC	number (double)
begintime обязательно	Дата пробития чека	string (date-time)
bonus-register обязательно	Список бонусных балансов, доступных для списания со счета клиента	< BonusRegister > array
booking необязательно	Бронирование, привязанное к чеку	BookingType
burnBonusRegister необязательно	Список бонусов которые сгорят при возврате предоплаты. Используется при бонусном процессинге на стороне LC	< BonusRegister > array
card необязательно	Список карт лояльности	< CardType > array
cash необязательно	Код Кассы. Если отсутствует, то это документ реализации	string
discountAmount необязательно	Сумма скидки	number (double)
documentType обязательно	Тип исходного чека	enum (SalesRefund, CheckRefund, Check, Sales, Prepayment, PrepaymentRefund)
enableBonusAccrue необязательно	Признак необходимости применения бонусных акций. Используется в пречеке при бонусном процессинге на стороне LC	boolean
enableBonusDebit необязательно	Признак необходимости списания бонусов. Используется в пречеке при бонусном процессинге на стороне LC	boolean
enableDiscounts необязательно	Признак необходимости применения скидочных акций. Используется в пречеке при скидочном процессинге на стороне LC	boolean
internalCode обязательно	Внутренний код чека	string
number обязательно	Номер чека	string
offline необязательно	Признак пробития чека в оффлайне. Используется при скидочном/бонусном процессинге на стороне LC	boolean
operationType обязательно	Тип операции. True - документ оплаты чека/реализации. False - документ возврата чека/реализации	boolean
payments необязательно	Платежи	< PaymentType > array
shift обязательно	Номер смены	integer (int64)
shop обязательно	Код торговой точки	string
shopName необязательно	Наименование торговой точки	string
sourceCheck необязательно	Ссылка на исходный чек. Указывается при проведении чека возврата	SourceCheckType
specialist необязательно	Специалист, оказывающий услугу	string
status обязательно	Статус чека	enum (canceled, productive)
stockChain необязательно	Список примененных к чеку акций. Используется при использовании скидочного/бонусного процессинга на стороне LC	< StockChain > array
tabNumber необязательно	Табельный номер кассира	string
userName необязательно	Имя специалиста	string

AccrualBonusesType

Имя	Описание	Схема
date обязательно	Дата начисления бонусов	string (date-time)
internalCode обязательно	Внутренний код типа бонуса	string
value обязательно	Количество бонусов	number (double)

BonusRegister

Имя	Описание	Схема
balance-available обязательно	Сумма предложенного списания бонусов	number (double)
internal-code обязательно	Код типа бонуса для списания	string

BookingType

Имя	Описание	Схема
analyticPlace необязательно	Дополнительная аналитическая информация из 1С	string
cancelReason необязательно	Причина отмены	CancelReasonType
card обязательно	Дисконтная карта клиента	CardType
checkCode необязательно	Внутренний код чека	string
client необязательно	Клиент	ClientType
confirmationState необязательно	Статус подтверждения бронирования	enum (Confirmed, NotConfirmed)
documentDate обязательно	Дата совершения бронирования	string (date-time)
documentNumber обязательно	Номер	string
duration необязательно	Длительность приёма в минутах	string
internalCode обязательно	Внутренний код бронирования	string
place обязательно	Точка обслуживания	ShopType
planningDate обязательно	Плановая дата записи	string (date-time)
specialist необязательно	Специалист	Specialist
specialization необязательно	Специализация	Specialization
status необязательно	Статус бронирования	enum (Booked, Completed, Canceled)
updateDatetime необязательно	Дата изменения записи	string (date-time)

CancelReasonType

Имя	Описание	Схема
internalCode необязательно	Внутренний код причины отмены	string
name необязательно	Наименование причины отмены	string

CardType

Имя	Описание	Схема
number обязательно	Номер карты	string
type обязательно	Тип карты. По умолчанию передавать INTERNAL	enum (INTERNAL, EXTERNAL, PRESENT, BONUS, COUPON_CARD, COUPON_RECEIPT, COUPON_PROCESSING, COUPON_UNIQUE, UNKNOWN)

ClientType

Имя	Описание	Схема
additionalEmails необязательно	Дополнительные email адреса	< string > array
birth-date необязательно	Дата рождения	string (date-time)
city необязательно	Город	string
email необязательно	Адрес электронной почты	string
emailVerifiedDate необязательно	Дата подтверждения email адреса	string (date-time)
first-name необязательно	Имя	string
guid обязательно	Внутренний код клиента (guid)	string
hasTelegramBot необязательно	Признак наличия ТГ бота	boolean
last-name необязательно	Фамилия	string
lcguid необязательно	Внутренний код клиента в системе LC	string
middle-name необязательно	Отчество	string
phone обязательно	Номер телефона	string
phoneVerifiedDate необязательно	Дата подтверждения номера телефона	string (date-time)
referral-code необязательно	Реферальный код	string
sex необязательно	Пол	enum (MALE, FEMALE, FORMER_MALE, FORMER_FEMALE, UNSPECIFIED)
status обязательно	Статус клиента	enum (Active, Closed, Blocked)
telegramBotInstallationDate необязательно	Дата установки ТГ бота	string (date-time)
telegramBotShutdownDate необязательно	Дата удаления ТГ бота	string (date-time)

ShopType

Имя	Описание	Схема
address необязательно	Адрес точки обслуживания	string
internalCode необязательно	Внутренний код точки обслуживания	string
name необязательно	Наименование точки обслуживания	string

Specialist

Имя	Описание	Схема
birth-date обязательно	Дата рождения	string (date-time)
email необязательно	Email адрес	string
gender необязательно	Пол	enum (MALE, FEMALE, FORMER_MALE, FORMER_FEMALE, UNSPECIFIED)
guid обязательно	guid	string
inn необязательно	ИНН телефона	string
name обязательно	ФИО	string
phone необязательно	Номер телефона	string
post необязательно	Адрес электронной почты	string
specializations необязательно	Специализации	< Specialization > array

Specialization

Имя	Описание	Схема
externalCode обязательно	Внутренний код	string
name обязательно	Наименование специализации	string

PaymentType

Имя	Описание	Схема
amount обязательно	Сумма оплаты	number (double)
date обязательно	Дата проведения платежа	string (date-time)
description необязательно	Описание платежа	string
internal-code обязательно	Внутренний код платежа	string
name обязательно	Наименование типа оплаты	string
status обязательно	Статус платежа	enum (paidInPart, paidInFull, pendingInFull, pendingInPart)
transaction-code необязательно	Код привязанной бонусной транзакции. Используется в бонусном процессинге на стороне LC	string
type обязательно	Тип платежа. Произвольное значение, например Cash или Card	string

SourceCheckType

Имя	Описание	Схема
documentType необязательно	Тип исходного чека	enum (SalesRefund, CheckRefund, Check, Sales, Prepayment, PrepaymentRefund)
number необязательно	Номер исходного чека	string

StockChain

Имя	Описание	Схема
code обязательно	Внутренний код акции	string
name обязательно	Наименование акции	string