ProBonus API: Отчёты
Методы, формирующие отчёты веб-интерфейса, и получение содержимого чека.
Общие правила (адрес, авторизация, форматы, коды ошибок) — на странице ProBonus API. Справочник методов.
Список методов
| Метод | Адрес | Назначение |
|---|---|---|
GET | /api/v0/reports/accounts_count_by_dates | Прирост гостевой базы |
GET | /api/v0/reports/anti_fraud_events | Отчет по "Антифроду" |
GET | /api/v0/reports/birthdays | Отчет "Дни рождения" |
GET | /api/v0/reports/coupons_turnover | Отчет "Оборот товарных купонов" |
GET | /api/v0/reports/dashboard/dashboard_accounts_counts_by_account_group | Дашборд количество счетов по группам счетов |
GET | /api/v0/reports/dashboard/dashboard_accounts_counts_by_ages | Дашборд количество счетов по возрасту |
GET | /api/v0/reports/dashboard/dashboard_accounts_counts_by_sex | Дашборд количество счетов по полу |
GET | /api/v0/reports/dashboard/sums_by_account_groups | Дашборд суммы по группам счетов |
GET | /api/v0/reports/dashboard/sums_by_days | Дашборд суммы по дням |
GET | /api/v0/reports/dashboard/sums_by_restaurants | Дашборд суммы по ресторанам |
GET | /api/v0/reports/download_accounts | Выгрузка всех элементов справочника "Счета" в xls файл |
GET | /api/v0/reports/first_transaction_date_time | Дата и время первой транзакции в базе |
GET | /api/v0/reports/identifiers | Отчет по типам идентификаторов |
GET | /api/v0/reports/inactive_accounts | Отчет "Бездействующие счета" |
GET | /api/v0/reports/lost_accounts | Отчет "Потерянные гости" |
GET | /api/v0/reports/loyalty_participants | Отчет по участникам программы лояльности |
GET | /api/v0/reports/mailings_history | История рассылок |
GET | /api/v0/reports/meals_with_subsidies | Отчет "Питание с дотациями" |
GET | /api/v0/reports/messages_by_mailing_id | Сообщения рассылки |
GET | /api/v0/reports/promocodes | Отчет "Промокоды" |
GET | /api/v0/reports/promotion_actuation_history | История запусков акций |
GET | /api/v0/reports/promotion_actuation_logs | Журнал применения акций |
GET | /api/v0/reports/promotion_actuation_logs_by_actuation_id | Журнал применения акции по запуску |
GET | /api/v0/reports/promotions_effectiveness | Отчет "Эффективность акций" |
GET | /api/v0/reports/referrals | Отчёт «Реферальная программа» |
GET | /api/v0/reports/referrals_graph | График по реферальной программе |
GET | /api/v0/reports/rfm | Отчёт «RFM-анализ» |
GET | /api/v0/reports/spent_by_days | Отчет "Потраты по дням" |
GET | /api/v0/reports/stamps | Отчет по штампикам |
GET | /api/v0/reports/stamps_graph | График штампиков |
GET | /api/v0/reports/sums | Отчет "Суммовой" |
GET | /api/v0/reports/top_guests | Топ гостей |
GET | /api/v0/reports/transactions | Отчет "Транзакции" |
GET | /api/v0/checks/get_by_id | Получение гостевого содержимого чека r_keeper по id |
Отчёты
Прирост гостевой базы
GET /api/v0/reports/accounts_count_by_dates
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) |
Ответ 200 — массив объектов ReportAccountsCountByDates:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | date | да | Дата |
count | integer | да | Количество |
byUtm | объект {ключ: integer} | да | |
countOnDate | integer | да | |
byUtmOnDate | объект {ключ: integer} | да |
Отчет по "Антифроду"
GET /api/v0/reports/anti_fraud_events
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) | |
event_types | строка запроса | массив integer | Фильтр по типам событий |
Ответ 200 — массив объектов ReportAntiFraudEventsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
datetime | datetime | да | Дата и время |
fullName | string | да | ФИО гостя |
identifier | string | Идентификатор | |
accountGroupName | string | да | Наименование группы счетов |
restaurantName | string | Наименование ресторана | |
text | string | да | Текст |
accountId | integer | да | Идентификатор счёта |
eventType | integer | да |
Отчет "Дни рождения"
GET /api/v0/reports/birthdays
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
tags_ids | строка запроса | массив integer | Фильтр по тегам счетов | |
no_tags | строка запроса | boolean | Учитывать счета без тегов; по умолчанию false |
|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) |
Ответ 200 — массив объектов ReportBirthdaysItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
fullName | string | да | ФИО гостя |
birthday | date | да | Дата рождения |
age | integer | да | Возраст |
accountGroupName | string | да | Наименование группы счетов |
phone | string | Номер телефона | |
email | string | Адрес e-mail | |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя | |
tags | string | Теги |
Отчет "Оборот товарных купонов"
GET /api/v0/reports/coupons_turnover
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
coupons_dish_ids | строка запроса | массив integer | Фильтр по товарным купонам | |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
do_not_show_coupons_without_turnover_in_the_period | строка запроса | boolean | Не показывать купоны без оборота за период; по умолчанию false |
Ответ 200 — массив объектов ReportAccountsCouponsTurnoverDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
couponDishId | integer | да | Идентификатор товарного купона |
couponDishName | string | да | |
balanceBegin | integer | да | Остаток на начало периода |
issue | integer | да | |
applied | integer | да | |
expired | integer | да | |
balanceEnd | integer | да | Остаток на конец периода |
Дашборд количество счетов по группам счетов
GET /api/v0/reports/dashboard/dashboard_accounts_counts_by_account_group
Авторизация: требуется
Ответ 200 — массив объектов DashboardDashboardAccountsCountByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
accountGroupName | string | да | Наименование группы счетов |
count | integer | да | Количество |
Дашборд количество счетов по возрасту
GET /api/v0/reports/dashboard/dashboard_accounts_counts_by_ages
Авторизация: требуется
Ответ 200 — массив объектов DashboardDashboardAccountsCountByAgesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
ageYears | integer | да | Возраст, лет |
accountsCount | integer | да | Количество счетов |
Дашборд количество счетов по полу
GET /api/v0/reports/dashboard/dashboard_accounts_counts_by_sex
Авторизация: требуется
Ответ 200 — массив объектов DashboardDashboardAccountsCountBySexDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
sex | string | да | Пол |
count | integer | да | Количество |
Дашборд суммы по группам счетов
GET /api/v0/reports/dashboard/sums_by_account_groups
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — массив объектов DashboardSumsByGroupItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
name | string | да | Наименование |
checksCount | integer | Количество чеков; по умолчанию 0 |
|
bonusSpentSum | number | Потрачено бонусов, руб.; по умолчанию 0 |
|
discountSum | number | Сумма скидок, руб.; по умолчанию 0 |
|
bonusRefillSum | number | Сумма пополнений бонусами, руб.; по умолчанию 0 |
|
moneySum | number | Сумма оплаты деньгами, руб.; по умолчанию 0 |
|
averageCheck | number | Средний чек, руб.; по умолчанию 0 |
Дашборд суммы по дням
GET /api/v0/reports/dashboard/sums_by_days
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — объект DashboardSumsByDaysDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
prevSums | DashboardPeriodSumsDto | да | |
sums | DashboardPeriodSumsDto | да | |
sumsByDays | массив DashboardSumsByDaysItemDto | да |
Дашборд суммы по ресторанам
GET /api/v0/reports/dashboard/sums_by_restaurants
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — массив объектов DashboardSumsByGroupItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
name | string | да | Наименование |
checksCount | integer | Количество чеков; по умолчанию 0 |
|
bonusSpentSum | number | Потрачено бонусов, руб.; по умолчанию 0 |
|
discountSum | number | Сумма скидок, руб.; по умолчанию 0 |
|
bonusRefillSum | number | Сумма пополнений бонусами, руб.; по умолчанию 0 |
|
moneySum | number | Сумма оплаты деньгами, руб.; по умолчанию 0 |
|
averageCheck | number | Средний чек, руб.; по умолчанию 0 |
Выгрузка всех элементов справочника "Счета" в xls файл
GET /api/v0/reports/download_accounts
Авторизация: требуется
Ответ 200: без содержимого.
Дата и время первой транзакции в базе
GET /api/v0/reports/first_transaction_date_time
Авторизация: требуется
Ответ 200 — объект ReportFirstTransactionDateTime:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dateTime | datetime | Дата и время |
Отчет по типам идентификаторов
GET /api/v0/reports/identifiers
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
date_begin | строка запроса | date | Начало периода | |
date_end | строка запроса | date | Конец периода | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — объект ReportIdentifiersDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsTotal | integer | да | Всего счетов |
types | массив ReportIdentifiersDistributionItemDto | да | Типы |
checks | ReportIdentifiersChecksDto | Чеки | |
checksByDates | ReportIdentifiersChecksByDatesDto | ||
walletDevices | ReportWalletDevicesDto |
Отчет "Бездействующие счета"
GET /api/v0/reports/inactive_accounts
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
tags_ids | строка запроса | массив integer | Фильтр по тегам счетов | |
no_tags | строка запроса | boolean | Учитывать счета без тегов; по умолчанию false |
|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) |
Ответ 200 — массив объектов ReportInactiveAccountsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
fullName | string | да | ФИО гостя |
accountGroupName | string | да | Наименование группы счетов |
phone | string | Номер телефона | |
email | string | Адрес e-mail | |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя | |
tags | string | Теги |
Отчет "Потерянные гости"
GET /api/v0/reports/lost_accounts
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_active_begin | строка запроса | date | да | Начало периода активности |
date_inactive_begin | строка запроса | date | да | Начало периода бездействия |
date_end | строка запроса | date | да | Конец периода |
tags_ids | строка запроса | массив integer | Фильтр по тегам счетов | |
no_tags | строка запроса | boolean | Учитывать счета без тегов; по умолчанию false |
|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — массив объектов ReportLostAccountsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
fullName | string | да | ФИО гостя |
phone | string | Номер телефона | |
email | string | Адрес e-mail | |
overallChecks | integer | да | |
averageChecksInMonth | number | да | |
averageChecksInDay | number | да | |
overallSpent | number | да | |
averageCheck | number | да | Средний чек, руб. |
lastCheckDate | datetime | да | |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя | |
tags | string | Теги |
Отчет по участникам программы лояльности
GET /api/v0/reports/loyalty_participants
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) | |
restaurant_other | строка запроса | boolean | Учитывать операции без ресторана (ручные, внешние); по умолчанию false |
|
identifier_ids | строка запроса | массив integer | Фильтр по типам идентификаторов |
Ответ 200 — массив объектов ReportLoyaltyParticipantsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
phone | string | Номер телефона | |
cards | string | Карты | |
fullName | string | да | ФИО гостя |
bonusLevel | string | ||
sumMoney | number | Сумма оплаты деньгами, руб.; по умолчанию 0 |
|
averageCheck | number | Средний чек, руб.; по умолчанию 0 |
|
sumReward | number | Начислено бонусов, руб.; по умолчанию 0 |
|
sumSpent | number | Сумма потрат, руб.; по умолчанию 0 |
История рассылок
GET /api/v0/reports/mailings_history
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
promotion_actuation_types | строка запроса | массив SegmentPromotionActuationType | Фильтр по типам применения акций; по умолчанию [1, 2, 3] |
Ответ 200 — массив объектов ReportMailingsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
creatingDatetime | datetime | да | Дата и время создания |
promotionActionId | integer | Идентификатор действия акции | |
promotionId | integer | Идентификатор акции | |
promotionName | string | Наименование акции | |
allMessagesCount | integer | да | |
notSentMessagesCount | integer | да | |
sentMessagesCount | integer | да | |
errorMessagesCount | integer | да | |
canceledMessagesCount | integer | да | |
promotionActuationType | SegmentPromotionActuationType | да | |
speed | integer | ||
finish | datetime | ||
finishForecast | datetime |
Отчет "Питание с дотациями"
GET /api/v0/reports/meals_with_subsidies
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
restaurant_id | строка запроса | integer | да | Идентификатор ресторана |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) |
Ответ 200 — объект ReportMealsWithSubsidiesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dates | массив date | Даты | |
rows | массив ReportMealsWithSubsidiesDtoItemDto | Строки отчёта |
Сообщения рассылки
GET /api/v0/reports/messages_by_mailing_id
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
mailing_id | строка запроса | integer | да | Идентификатор рассылки |
Ответ 200 — массив объектов ReportMessagesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
accountId | integer | да | Идентификатор счёта |
fullName | string | да | ФИО гостя |
creatingDatetime | datetime | да | Дата и время создания |
sendingStatus | MessageSendingStatus | да | Статус отправки |
sendingDatetime | datetime | Дата и время отправки | |
channelType | MailingChannelType | да | Канал отправки |
channelDestination | string | Адресат в канале | |
messageText | string |
Отчет "Промокоды"
GET /api/v0/reports/promocodes
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
promocode_id | строка запроса | integer | Идентификатор промокода | |
date_begin | строка запроса | date | Начало периода | |
date_end | строка запроса | date | Конец периода | |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) |
Ответ 200 — объект ReportPromocodesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
promocodeName | string | да | |
periodStart | date | да | Начало периода |
periodEnd | date | Конец периода | |
activationsCount | integer | да | Количество активаций |
activationsByDates | массив ReportPromocodesActivationByDateDto | да |
История запусков акций
GET /api/v0/reports/promotion_actuation_history
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
Ответ 200 — массив объектов ReportPromotionActuationHistoryItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
spentTime | number | да | Длительность выполнения |
datetime | datetime | да | Дата и время |
promotionName | string | да | Наименование акции |
accountsCount | integer | да | Количество счетов |
promotionActionId | integer | да | Идентификатор действия акции |
actionType | integer | Тип действия | |
promotionId | integer | Идентификатор акции |
Журнал применения акций
GET /api/v0/reports/promotion_actuation_logs
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
Ответ 200 — массив объектов ReportPromotionActuationLogsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
accountId | integer | да | Идентификатор счёта |
datetime | datetime | да | Дата и время |
fullName | string | да | ФИО гостя |
promotionName | string | да | Наименование акции |
text | string | да | Текст |
actionType | integer | Тип действия | |
promotionId | integer | Идентификатор акции |
Журнал применения акции по запуску
GET /api/v0/reports/promotion_actuation_logs_by_actuation_id
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
actuation_id | строка запроса | integer | да | Идентификатор запуска акции |
Ответ 200 — массив объектов ReportPromotionActuationLogsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
accountId | integer | да | Идентификатор счёта |
datetime | datetime | да | Дата и время |
fullName | string | да | ФИО гостя |
promotionName | string | да | Наименование акции |
text | string | да | Текст |
actionType | integer | Тип действия | |
promotionId | integer | Идентификатор акции |
Отчет "Эффективность акций"
GET /api/v0/reports/promotions_effectiveness
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
promotion_id | строка запроса | integer | да | Идентификатор акции |
days_to_attract | строка запроса | integer | Количество дней для расчёта привлечения гостей; по умолчанию 7 |
Ответ 200 — массив объектов ReportPromotionsEffectivenessItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
actuationDatetime | datetime | да | |
guestsCovered | integer | да | |
guestsAttracted | integer | да | |
effectiveness | number | да |
Отчёт «Реферальная программа»
GET /api/v0/reports/referrals
Авторизация: требуется
Ответ 200 — объект ReportReferralsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
invitingAccountCount | integer | да | |
invitedAccountCount | integer | да | |
invitedAccountWithTransactionsCount | integer | да | |
efficiency | number | да |
График по реферальной программе
GET /api/v0/reports/referrals_graph
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
Ответ 200 — массив объектов ReportReferralsGraphDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | date | да | Дата |
count | integer | да | Количество |
Отчёт «RFM-анализ»
GET /api/v0/reports/rfm
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) | |
r0 | строка запроса | integer | RFM: нижняя граница давности (R); по умолчанию 0 |
|
r1 | строка запроса | integer | RFM: верхняя граница давности (R); по умолчанию 0 |
|
f0 | строка запроса | integer | RFM: нижняя граница частоты (F); по умолчанию 0 |
|
f1 | строка запроса | integer | RFM: верхняя граница частоты (F); по умолчанию 0 |
|
m0 | строка запроса | integer | RFM: нижняя граница суммы (M); по умолчанию 0 |
|
m1 | строка запроса | integer | RFM: верхняя граница суммы (M); по умолчанию 0 |
Ответ 200 — объект ReportRfmDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
createRfmInfo | ReportRfmCreateRptInfoDto | да | |
rfmData | RfmDto |
Отчет "Потраты по дням"
GET /api/v0/reports/spent_by_days
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
tags_ids | строка запроса | массив integer | Фильтр по тегам счетов | |
no_tags | строка запроса | boolean | Учитывать счета без тегов; по умолчанию false |
|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) | |
restaurant_other | строка запроса | boolean | Учитывать операции без ресторана (ручные, внешние); по умолчанию false |
Ответ 200 — объект ReportSpentSumsByIdentifierCodesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dates | массив date | Даты | |
rows | массив ReportSpentSumsByIdentifierCodesItemDto | Строки отчёта |
Отчет по штампикам
GET /api/v0/reports/stamps
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
promotion_id | строка запроса | integer | Идентификатор акции | |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — объект ReportStampsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
stampId | integer | да | Идентификатор акции «Штампики» |
stampName | string | да | Наименование акции «Штампики» |
stampCreatedAt | date | да | |
stampExpiresAt | date | ||
isActive | boolean | да | Активен |
stampsIssuedCount | integer | да | Выдано подарков |
accountsIssuedCount | integer | да | Гостей, получивших подарки |
stampsUsedCount | integer | да | Погашено подарков |
accountsUsedCount | integer | да | Гостей, погасивших подарки |
stampsLeftoverCount | integer | да | Остаток подарков |
accountsLeftoverCount | integer | да | Гостей с непогашенными подарками |
promoDishesRevenue | number | Выручка по акционным блюдам, руб.; по умолчанию 0.0 |
|
checksWithPromoDishesRevenue | number | Выручка по чекам с акционными блюдами, руб.; по умолчанию 0.0 |
|
checksWithGiftDishesRevenue | number | Выручка по чекам с подарочными блюдами, руб.; по умолчанию 0.0 |
|
giftsCost | number | Затраты на подарки, руб.; по умолчанию 0.0 |
|
restaurantStats | массив RestaurantStampsStatsDto | да | Статистика по ресторанам |
График штампиков
GET /api/v0/reports/stamps_graph
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
promotion_id | строка запроса | integer | да | Идентификатор акции |
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — объект StampsGraphDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dates | массив date | да | Даты |
issued | массив integer | да | Выдано |
used | массив integer | да | Использовано |
promoDishesRevenue | массив number | да | Выручка по акционным блюдам, руб. |
checksWithPromoDishesRevenue | массив number | да | Выручка по чекам с акционными блюдами, руб. |
checksWithGiftDishesRevenue | массив number | да | Выручка по чекам с подарочными блюдами, руб. |
giftsCost | массив number | да | Затраты на подарки, руб. |
Отчет "Суммовой"
GET /api/v0/reports/sums
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
tags_ids | строка запроса | массив integer | Фильтр по тегам счетов | |
no_tags | строка запроса | boolean | Учитывать счета без тегов; по умолчанию false |
|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) | |
restaurant_other | строка запроса | boolean | Учитывать операции без ресторана (ручные, внешние); по умолчанию false |
Ответ 200 — массив объектов ReportSumsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
accountOwner | string | да | Владелец счёта |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя | |
accountGroupId | integer | да | Идентификатор группы счетов |
accountGroupName | string | Наименование группы счетов | |
sumMoney | number | Сумма оплаты деньгами, руб. | |
sumDiscount | number | Сумма скидок, руб. | |
sumReward | number | Начислено бонусов, руб. | |
sumSpent | number | Сумма потрат, руб. | |
sumBurned | number | Сгорело, руб. | |
sumBalanceBegin | number | Остаток на начало периода, руб. | |
sumBalanceEnd | number | Остаток на конец периода, руб. | |
tags | string | Теги |
Топ гостей
GET /api/v0/reports/top_guests
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
tags_ids | строка запроса | массив integer | Фильтр по тегам счетов | |
no_tags | строка запроса | boolean | Учитывать счета без тегов; по умолчанию false |
|
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) |
Ответ 200 — массив объектов ReportTopGuestsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
accountGroupId | integer | да | Идентификатор группы счетов |
accountGroupName | string | да | Наименование группы счетов |
phones | string | Телефоны | |
emails | string | Адреса e-mail | |
fullName | string | да | ФИО гостя |
countChecks | integer | да | Количество чеков |
countVisits | integer | да | Количество посещений |
sumSpent | number | да | Сумма потрат, руб. |
sumDiscount | number | да | Сумма скидок, руб. |
averageSpentSumByCheck | number | да | |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя | |
tags | string | Теги |
Отчет "Транзакции"
GET /api/v0/reports/transactions
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
date_begin | строка запроса | date | да | Начало периода |
date_end | строка запроса | date | да | Конец периода |
account_group_ids | строка запроса | массив integer | Фильтр по группам счетов (несколько значений) | |
restaurant_ids | строка запроса | массив integer | Фильтр по ресторанам (несколько значений) | |
restaurant_other | строка запроса | boolean | Учитывать операции без ресторана (ручные, внешние); по умолчанию false |
Ответ 200 — массив объектов ReportTransactionsItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dateTime | datetime | да | Дата и время |
identifierName | string | Наименование идентификатора | |
identifierCode | string | Код идентификатора | |
rkUnit | integer | Номер станции (кассы) r_keeper | |
rkCheck | integer | Номер чека r_keeper | |
transactionKind | string | Вид транзакции | |
transactionName | string | Наименование операции | |
transactionSum | number | Сумма операции, руб. | |
transactionDelayedSum | number | Отложенная сумма операции, руб. | |
restaurantId | integer | Идентификатор ресторана | |
checkId | integer | Идентификатор чека | |
bonusDateStart | datetime | Дата, с которой бонусы доступны | |
isExternal | boolean | Операция внешней системы | |
accountId | integer | да | Идентификатор счёта |
accountOwner | string | да | Владелец счёта |
accountGroupId | integer | да | Идентификатор группы счетов |
accountGroupName | string | Наименование группы счетов | |
restaurantName | string | Наименование ресторана | |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя |
Чеки
Получение гостевого содержимого чека r_keeper по id
GET /api/v0/checks/get_by_id
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
id | строка запроса | integer | да | Идентификатор объекта |
Ответ 200 — объект BaseCheckDataDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dataType | CheckDataTypeEnum | да | Тип данных |
data | RKCheckDataDto или ExternalCheckDataDto | да | Данные |
Модели данных
Вложенные объекты и перечисления, на которые ссылаются методы этого раздела.
CheckDataTypeEnum
Перечисление (string). Значения: RKEEPER, EXTERNAL.
RKEEPER — чек r_keeper, EXTERNAL — чек внешней системы
ComboLineDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
quantity | number | да | Количество |
code | string | да | Код |
type | string | Тип | |
prListSum | number | да | Сумма по прайс-листу, руб. |
dishes | массив DishLineDto | да | |
modifiers | массив ModifyLineDto | да |
DashboardPeriodSumsDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dateBegin | date | да | |
dateEnd | date | да | |
checksCount | integer | Количество чеков; по умолчанию 0 |
|
bonusSpentSum | number | Потрачено бонусов, руб.; по умолчанию 0 |
|
discountSum | number | Сумма скидок, руб.; по умолчанию 0 |
|
bonusRefillSum | number | Сумма пополнений бонусами, руб.; по умолчанию 0 |
|
moneySum | number | Сумма оплаты деньгами, руб.; по умолчанию 0 |
|
bonusManualRefillSum | number | Сумма ручных пополнений, руб.; по умолчанию 0 |
|
bonusBurnSum | number | Сгорело бонусов, руб.; по умолчанию 0 |
|
averageCheck | number | Средний чек, руб.; по умолчанию 0 |
|
baseVolume | integer | по умолчанию 0 |
|
baseIncrease | integer | по умолчанию 0 |
|
activeClients | integer | по умолчанию 0 |
|
loyaltySystemPenetration | number | по умолчанию 0 |
DashboardSumsByDaysItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | date | да | Дата |
checksCount | integer | Количество чеков; по умолчанию 0 |
|
bonusSpentSum | number | Потрачено бонусов, руб.; по умолчанию 0 |
|
discountSum | number | Сумма скидок, руб.; по умолчанию 0 |
|
bonusRefillSum | number | Сумма пополнений бонусами, руб.; по умолчанию 0 |
|
moneySum | number | Сумма оплаты деньгами, руб.; по умолчанию 0 |
|
bonusManualRefillSum | number | Сумма ручных пополнений, руб.; по умолчанию 0 |
|
averageCheck | number | Средний чек, руб.; по умолчанию 0 |
|
bonusBurnSum | number | Сгорело бонусов, руб.; по умолчанию 0 |
DiscountDto (check)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
sum | number | да | Сумма, руб. |
DishLineDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
quantity | number | да | Количество |
code | string | да | Код |
type | string | Тип | |
prListSum | number | Сумма по прайс-листу, руб. | |
modifiers | массив ModifyLineDto | да |
ExternalCheckDataDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
restaurantName | string | да | Наименование ресторана |
restaurantCode | string | да | Код ресторана r_keeper |
date | datetime | да | Дата |
externalCheck | integer | да | Данные внешнего чека |
checkGuid | uuid | да | GUID чека r_keeper |
bonusSpentSum | number | да | Потрачено бонусов, руб. |
discountSum | number | да | Сумма скидок, руб. |
bonusAccruedSum | number | да | Начислено бонусов, руб. |
moneySpentSum | number | да | Потрачено денег, руб. |
checkData | string | да | Данные чека |
MailingChannelType
Перечисление (integer). Значения: 0, 1, 2, 3, 4.
MessageSendingStatus
Перечисление (integer). Значения: 0, 1, 2, 3.
ModifyLineDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
quantity | number | да | Количество |
code | string | да | Код |
type | string | Тип | |
prListSum | number | Сумма по прайс-листу, руб. |
PaymentDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
sum | number | да | Сумма, руб. |
cardCode | string | Код карты | |
ownerInfo | string |
ReportIdentifiersChecksByDatesDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
points | массив ReportIdentifiersChecksByDatesPointDto | да |
ReportIdentifiersChecksByDatesPointDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | date | да | Дата |
identifierTypeId | integer | Идентификатор типа идентификатора | |
identifierTypeCode | string | Код типа идентификатора | |
identifierTypeName | string | да | Наименование типа идентификатора |
checksCount | integer | да | Количество чеков |
ReportIdentifiersChecksDistributionItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
identifierTypeId | integer | Идентификатор типа идентификатора | |
identifierTypeCode | string | Код типа идентификатора | |
identifierTypeName | string | да | Наименование типа идентификатора |
checksTotal | integer | да | Всего чеков |
ReportIdentifiersChecksDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
checksTotal | integer | да | Всего чеков |
types | массив ReportIdentifiersChecksDistributionItemDto | да | Типы |
ReportIdentifiersDistributionItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
identifierTypeId | integer | Идентификатор типа идентификатора | |
identifierTypeCode | string | Код типа идентификатора | |
identifierTypeName | string | да | Наименование типа идентификатора |
accountsTotal | integer | да | Всего счетов |
ReportMealsWithSubsidiesDtoItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
accountGroupId | integer | да | Идентификатор группы счетов |
accountGroupName | string | да | Наименование группы счетов |
accountOwner | string | да | Владелец счёта |
accountTags | массив string | Теги счёта | |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
identifierCode | string | да | Код идентификатора |
identifierTypeName | string | Наименование типа идентификатора | |
count | integer | Количество; по умолчанию 0 |
|
sumsByDates | массив ReportSpentSumsByIdentifierCodesSumDateItemDto | ||
sum | number | Сумма, руб.; по умолчанию 0 |
|
orgSubSum | number | по умолчанию 0 |
|
emplSubSum | number | по умолчанию 0 |
ReportPromocodesActivationByDateDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | date | да | Дата |
count | integer | да | Количество |
ReportRfmCreateRptInfoDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
status | string | да | Статус |
info | string | Информация |
ReportSpentSumsByIdentifierCodesItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
accountGroupId | integer | да | Идентификатор группы счетов |
accountGroupName | string | да | Наименование группы счетов |
accountOwner | string | да | Владелец счёта |
accountText | string | Доп. информация о госте | |
accountMessageToScreen | string | Сообщение для экрана | |
accountMessageOnCheck | string | Сообщение для печати | |
accountSex | integer | Пол гостя | |
identifierCode | string | да | Код идентификатора |
identifierTypeName | string | Наименование типа идентификатора | |
count | integer | Количество; по умолчанию 0 |
|
sumsByDates | массив ReportSpentSumsByIdentifierCodesSumDateItemDto | ||
sum | number | Сумма, руб.; по умолчанию 0 |
|
tags | string | Теги |
ReportSpentSumsByIdentifierCodesSumDateItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | date | да | Дата |
sum | number | да | Сумма, руб. |
ReportWalletDevicesDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
devicesTotal | integer | да | Всего устройств |
types | массив ReportWalletDevicesItemDto | да | Типы |
ReportWalletDevicesItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
deviceTypeCode | string | да | |
deviceTypeName | string | да | |
devicesTotal | integer | да | Всего устройств |
RestaurantStampsStatsDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
restaurantId | integer | да | Идентификатор ресторана |
restaurantName | string | да | Наименование ресторана |
promoDishCount | integer | да | «Порций купить» — N, количество акционных блюд для получения подарка |
accountsPromoDishCount | integer | да |
RfmDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
r | RfmReportGroupsDto | да | |
f | RfmReportGroupsDto | да | |
m | RfmReportGroupsDto | да | |
accounts | объект {ключ: RfmReportAccountDto} | да | Список счетов |
segments | объект {ключ: массив integer} | да | Сегменты |
RfmReportAccountDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
grp | string | да | |
phone | string | да | Номер телефона |
r | integer | да | |
f | integer | да | |
m | number | да |
RfmReportGroupDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
caption | string | да | Подпись |
accounts | массив integer | да | Список счетов |
RfmReportGroupsDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
grp1 | RfmReportGroupDto | да | |
grp2 | RfmReportGroupDto | да | |
grp3 | RfmReportGroupDto | да |
RKCheckDataDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
checkNum | integer | да | Номер чека |
tableCode | integer | да | Стол |
guests | integer | да | Количество гостей |
startService | datetime | да | Начало обслуживания |
closeDatetime | datetime | да | Время закрытия чека |
cashierName | string | да | Кассир |
waiterName | string | да | Официант |
lines | массив ComboLineDto или DishLineDto | да | Строки чека |
overallSum | number | да | Сумма чека, руб. |
discounts | массив DiscountDto (check) | да | Скидки |
toPay | number | да | Сумма к оплате, руб. |
payments | массив PaymentDto | да | Оплаты |
SegmentPromotionActuationType
Перечисление (integer). Значения: 1, 2, 3.