ProBonus API: Счета гостей
Поиск, создание и изменение счетов гостей, баланс, пополнение и изъятие, транзакции, теги, купоны, штампики, групповые операции, контакты в мессенджерах.
Общие правила (адрес, авторизация, форматы, коды ошибок) — на странице ProBonus API. Справочник методов.
Список методов
| Метод | Адрес | Назначение |
|---|---|---|
GET | /api/v0/accounts/activity_by_periods | Краткий отчёт "Активность по периодам" (день/7дней/неделя/30дней/месяц/всё время) |
POST | /api/v0/accounts/block | Блокировка элемента справочника "Счета" по заданному id |
POST | /api/v0/accounts/coupon_dish_delete | Удалить начисленный купон |
POST | /api/v0/accounts/coupon_dish_issue | Начислить купон на счёт |
POST | /api/v0/accounts/delete | Удаление элемента справочника "Счета" по заданному id |
GET | /api/v0/accounts/find_by_identifier | Чтение элемента справочника "Счета" по заданному идентификатору |
GET | /api/v0/accounts/find_by_phone | Чтение элемента справочника "Счета" по заданному номеру телефона |
GET | /api/v0/accounts/find_by_phone_part | Поиск счетов по части номера телефона |
GET | /api/v0/accounts/get | Чтение элемента справочника "Счета" по заданному id |
GET | /api/v0/accounts/get_available_bonuses | Баланс и сумма, доступная к оплате, по счетам |
GET | /api/v0/accounts/get_balance_extended | Получение информации о балансе счета по заданному id |
GET | /api/v0/accounts/get_last_raw_transactions | Последние транзакции счёта (без обработки) |
GET | /api/v0/accounts/get_temporary_identifier | Генерация временного идентификатора для счета по его id |
POST | /api/v0/accounts/group_operations/account_group_by_account_group | Групповая операция: перенос всех счетов группы в другую группу |
POST | /api/v0/accounts/group_operations/account_group_by_accounts | Групповая операция: смена группы для выбранных счетов |
POST | /api/v0/accounts/group_operations/add_draft_cards | Групповая операция: создание заготовок карт |
POST | /api/v0/accounts/group_operations/block_accounts_by_account_group | Групповая операция: блокировка всех счетов группы |
POST | /api/v0/accounts/group_operations/block_accounts_by_accounts | Групповая операция: блокировка выбранных счетов |
POST | /api/v0/accounts/group_operations/change_accounts_properties | Групповая операция: изменение свойств счетов |
POST | /api/v0/accounts/group_operations/change_tags_by_account_group | Групповая операция: изменение тегов всех счетов группы |
POST | /api/v0/accounts/group_operations/change_tags_by_accounts | Групповая операция: изменение тегов выбранных счетов |
POST | /api/v0/accounts/group_operations/change_valid_to_by_account_group | Групповая операция: срок действия всех счетов группы |
POST | /api/v0/accounts/group_operations/change_valid_to_by_accounts | Групповая операция: срок действия выбранных счетов |
POST | /api/v0/accounts/group_operations/delete_accounts_by_account_group | Групповая операция: удаление всех счетов группы |
POST | /api/v0/accounts/group_operations/delete_accounts_by_accounts | Групповая операция: удаление выбранных счетов |
POST | /api/v0/accounts/group_operations/discount_by_account_group | Групповая операция: скидка/бонус всех счетов группы |
POST | /api/v0/accounts/group_operations/discount_by_accounts | Групповая операция: скидка/бонус выбранных счетов |
POST | /api/v0/accounts/group_operations/limits_discount_by_account_group | Групповая операция: лимиты скидки/бонуса всех счетов группы |
POST | /api/v0/accounts/group_operations/limits_discount_by_accounts | Групповая операция: лимиты скидки/бонуса выбранных счетов |
POST | /api/v0/accounts/group_operations/limits_pay_by_account_group | Групповая операция: лимиты оплат всех счетов группы |
POST | /api/v0/accounts/group_operations/limits_pay_by_accounts | Групповая операция: лимиты оплат выбранных счетов |
POST | /api/v0/accounts/group_operations/messages_by_account_group | Групповая операция: сообщения для экрана/печати всех счетов группы |
POST | /api/v0/accounts/group_operations/messages_by_accounts | Групповая операция: сообщения для экрана/печати выбранных счетов |
POST | /api/v0/accounts/group_operations/phone_identifier_by_account_group | Групповая операция: телефон как идентификатор для всех счетов группы |
POST | /api/v0/accounts/group_operations/phone_identifier_by_accounts | Групповая операция: телефон как идентификатор для выбранных счетов |
POST | /api/v0/accounts/group_operations/refill_by_account_group | Групповая операция: пополнение баланса всех счетов группы |
POST | /api/v0/accounts/group_operations/refill_by_accounts | Групповая операция: пополнение баланса выбранных счетов |
POST | /api/v0/accounts/group_operations/withdrawal_by_account_group | Групповая операция: изъятие с баланса всех счетов группы |
POST | /api/v0/accounts/group_operations/withdrawal_by_accounts | Групповая операция: изъятие с баланса выбранных счетов |
POST | /api/v0/accounts/group_operations/zero_by_account_group | Групповая операция: обнуление баланса всех счетов группы |
POST | /api/v0/accounts/group_operations/zero_by_accounts | Групповая операция: обнуление баланса выбранных счетов |
POST | /api/v0/accounts/identifiers/generate_wallet_identifier | Сгенерировать wallet-идентификатор для счёта |
POST | /api/v0/accounts/insert | Добавление нового элемента справочника "Счета" |
POST | /api/v0/accounts/insert_by_template | Добавление нового элемента справочника "Счета" с автоматическим заполнением свойств счёта по шаблону группы счетов |
GET | /api/v0/accounts/list | Чтение списка элементов справочника "Счета" (все счета или счета из указанной группы) |
GET | /api/v0/accounts/promo_stamps | Штампики счёта и их транзакции |
POST | /api/v0/accounts/refill | Пополнение баланса счета с заданным id |
GET | /api/v0/accounts/tags/active | Получить список активных тегов счёта |
POST | /api/v0/accounts/tags/detach | Снять тег(и) со счетов |
POST | /api/v0/accounts/tags/set | Назначить тег(и) счетам |
GET | /api/v0/accounts/transactions | Отчёт по транзакциям по счету с заданным ID |
POST | /api/v0/accounts/unblock | Разблокировка элемента справочника "Счета" по заданному id |
POST | /api/v0/accounts/update | Обновление элемента справочника "Счета" по заданному id |
POST | /api/v0/accounts/withdrawal | Изъятие средств с баланса счета с заданным id |
POST | /api/v0/additional_contacts/add_additional_contact | Добавление контакта мессенджера к счёту |
GET | /api/v0/additional_contacts/find_account_by_additional_contact | Поиск счёта по контакту мессенджера |
GET | /api/v0/additional_contacts/get_by_type_and_value | Чтение контакта мессенджера по типу и значению |
POST | /api/v0/additional_contacts/insert_account_by_template_with_additional_contacts | Создание счёта по шаблону группы вместе с контактами мессенджеров |
Счета
Краткий отчёт "Активность по периодам" (день/7дней/неделя/30дней/месяц/всё время)
GET /api/v0/accounts/activity_by_periods
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
Ответ 200 — объект AccountActivityByPeriodsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountOwnerFullName | string | ФИО владельца счёта | |
isDraft | boolean | Заготовка карты; по умолчанию false |
|
spentSumDay | number | да | |
spentSumWeek | number | да | |
spentSumWeekCalendar | number | да | |
spentSumMonth | number | да | |
spentSumMonthCalendar | number | да | |
spentSumAll | number | да | |
spentSumDiscountPeriod | number | да | |
discountSumDay | number | да | |
discountSumWeek | number | да | |
discountSumWeekCalendar | number | да | |
discountSumMonth | number | да | |
discountSumMonthCalendar | number | да | |
discountSumAll | number | да | |
bonusSumDay | number | да | |
bonusSumWeek | number | да | |
bonusSumWeekCalendar | number | да | |
bonusSumMonth | number | да | |
bonusSumMonthCalendar | number | да | |
bonusSumAll | number | да | |
paySumDay | number | да | |
paySumWeek | number | да | |
paySumWeekCalendar | number | да | |
paySumMonth | number | да | |
paySumMonthCalendar | number | да | |
paySumAll | number | да | |
useCountDay | integer | да | |
useCountWeek | integer | да | |
useCountWeekCalendar | integer | да | |
useCountMonth | integer | да | |
useCountMonthCalendar | integer | да | |
useCountAll | integer | да | |
payCountDay | integer | да | |
payCountWeek | integer | да | |
payCountWeekCalendar | integer | да | |
payCountMonth | integer | да | |
payCountMonthCalendar | integer | да | |
payCountAll | integer | да |
Блокировка элемента справочника "Счета" по заданному id
POST /api/v0/accounts/block
Авторизация: требуется
Тело запроса — объект AccountBlockParamDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
reason | string | да | Причина (комментарий) операции |
Ответ 200: JSON (структура в схеме не описана).
Удалить начисленный купон
POST /api/v0/accounts/coupon_dish_delete
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
id | строка запроса | integer | да | Идентификатор объекта |
Ответ 200 — массив объектов AccountCouponDishDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор записи |
couponDishId | integer | да | Купон |
name | string | да | Наименование |
dateOfIssue | datetime | да | Дата выдачи |
dateStop | datetime | Действует до (NULL — бессрочно) |
|
dateApply | datetime | Дата погашения | |
checkId | integer | Идентификатор чека | |
text | string | Комментарий / основание выдачи | |
state | AccountCouponDishState | да | Состояние |
Начислить купон на счёт
POST /api/v0/accounts/coupon_dish_issue
Авторизация: требуется
Тело запроса — объект AccountIssueCouponDishRequest:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
couponDishId | integer | да | Идентификатор товарного купона |
lifetimeDays | integer | Срок действия, дней; мин. 1 |
Ответ 200 — массив объектов AccountCouponDishDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор записи |
couponDishId | integer | да | Купон |
name | string | да | Наименование |
dateOfIssue | datetime | да | Дата выдачи |
dateStop | datetime | Действует до (NULL — бессрочно) |
|
dateApply | datetime | Дата погашения | |
checkId | integer | Идентификатор чека | |
text | string | Комментарий / основание выдачи | |
state | AccountCouponDishState | да | Состояние |
Удаление элемента справочника "Счета" по заданному id
POST /api/v0/accounts/delete
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
id | строка запроса | integer | да | Идентификатор объекта |
Ответ 200: JSON (структура в схеме не описана).
Чтение элемента справочника "Счета" по заданному идентификатору
GET /api/v0/accounts/find_by_identifier
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
code | строка запроса | string | да | Код идентификатора (номер карты, QR-код и т. п.) |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Чтение элемента справочника "Счета" по заданному номеру телефона
GET /api/v0/accounts/find_by_phone
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
phone | строка запроса | string | да | Номер телефона |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Поиск счетов по части номера телефона
GET /api/v0/accounts/find_by_phone_part
Авторизация: требуется
Возвращает общее количество и ограниченный список счетов.
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
phone_part | строка запроса | string | да | Часть номера телефона |
max_result_count | строка запроса | integer | Максимальное количество счетов в ответе; мин. 1; по умолчанию 10 |
Ответ 200 — объект AccountsFindByPhonePartResultDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
count | integer | да | Количество |
accounts | массив AccountsFindByPhonePartItemDto | да | Список счетов |
Чтение элемента справочника "Счета" по заданному id
GET /api/v0/accounts/get
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
id | строка запроса | integer | да | Идентификатор объекта |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Баланс и сумма, доступная к оплате, по счетам
GET /api/v0/accounts/get_available_bonuses
Авторизация: требуется
Возвращает для каждого счёта сумму баланса и сумму, доступную к оплате с учётом установленных ограничений.
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
Ответ 200 — объект AvailableBonusesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
balance | number | да | Баланс, руб. |
maxPaySum | number | да | Максимальная сумма оплаты бонусами, руб. |
Получение информации о балансе счета по заданному id
GET /api/v0/accounts/get_balance_extended
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
id | строка запроса | integer | да | Идентификатор объекта |
Ответ 200 — массив объектов AccountBalanceExtendedDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
sum | number | да | Сумма, руб. |
dateStop | datetime | Дата окончания | |
dateStart | datetime | Дата начала | |
sumLateIssue | number |
Последние транзакции счёта (без обработки)
GET /api/v0/accounts/get_last_raw_transactions
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
limit | строка запроса | integer | Максимальное количество записей в ответе; по умолчанию 5 |
Ответ 200 — массив объектов AccountRawTransactionItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | TransactionRawKind | да | Тип |
date | datetime | да | Дата |
rkCheck | integer | Номер чека r_keeper | |
restaurantName | string | Наименование ресторана | |
chmode | integer | Режим чека r_keeper: 1 — оплата, 3 — возврат |
|
sumSpent | number | Сумма потрат, руб. | |
sumDiscount | number | Сумма скидок, руб. | |
sumReward | number | Начислено бонусов, руб. | |
sumMoney | number | Сумма оплаты деньгами, руб. | |
sumRefill | number | Сумма ручного пополнения, руб. | |
refillReason | string | Причина (комментарий) ручной операции | |
balances | массив AccountRawTransactionBalanceItemDto | Балансы |
Генерация временного идентификатора для счета по его id
GET /api/v0/accounts/get_temporary_identifier
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
identifier_type | строка запроса | string | Тип идентификатора; по умолчанию «temporary» |
Ответ 200 — объект TempIdentifierGetDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
code | string(50) | да | Код |
expired | datetime | да | Срок действия (для временных кодов) |
Групповая операция: перенос всех счетов группы в другую группу
POST /api/v0/accounts/group_operations/account_group_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpAccountGroupByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
newAccountGroupId | integer | да | Новая группа счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: смена группы для выбранных счетов
POST /api/v0/accounts/group_operations/account_group_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpAccountGroupByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsIds | массив integer | да | Список идентификаторов счетов |
newAccountGroupId | integer | да | Новая группа счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: создание заготовок карт
POST /api/v0/accounts/group_operations/add_draft_cards
Авторизация: требуется
Тело запроса — объект AccountAddDraftCardsParamDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
accountGroup | IdDto | да | Группа счетов |
messageToScreen | string | Сообщение для экрана | |
messageOnCheck | string | Сообщение для печати | |
discount | IdDto | Скидка | |
rkCode | integer | Код скидки (бонуса) r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса r_keeper | |
bonusLifetime | integer | мин. 1 | |
bonusDelayedDays | integer | мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | по умолчанию false |
|
startingBalance | AccountStartingBalance | да | Стартовый (приветственный) баланс нового счёта |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
draftCards | string | да | Номера карт. Можно указать: ; один номер ; номера через запятую ; диапазон через тире ; комбинировать номера и диапазон Примеры: ; 856 ; 856,901,1005 ; 856-1200 ; 856,901,1005,1010-1060 ; 1,2,10-80,856,901,1005,1010-1060 |
Ответ 200 — массив объектов AccountAddDraftCardItemResult:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
card | integer | да | Карта |
success | boolean | Признак успешного выполнения; по умолчанию false |
|
error | string | Ошибка |
Групповая операция: блокировка всех счетов группы
POST /api/v0/accounts/group_operations/block_accounts_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpBlockAccountsByGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
blockReason | string(100) | да | Причина блокировки |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: блокировка выбранных счетов
POST /api/v0/accounts/group_operations/block_accounts_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpBlockAccountsByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
blockReason | string(100) | да | Причина блокировки |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: изменение свойств счетов
POST /api/v0/accounts/group_operations/change_accounts_properties
Авторизация: требуется
Тело запроса — объект ChangeAccountPropertiesDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupIds | массив integer | Список идентификаторов групп счетов | |
accountIds | массив integer | Список идентификаторов счетов | |
actions | массив ChangeBonusAwardActionDto или ChangeMessagesActionDto или ChangeTagsActionDto или ChangeValidToActionDto или ChangePayLimitsActionDto | да | Действия акции |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: изменение тегов всех счетов группы
POST /api/v0/accounts/group_operations/change_tags_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpTagsByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
mode | string | да | assign / detach / clear_all |
tagIds | массив integer | обязательно для assign/detach; игнорируется для clear_all |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: изменение тегов выбранных счетов
POST /api/v0/accounts/group_operations/change_tags_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpTagsByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsIds | массив integer | да | Список идентификаторов счетов |
mode | string | да | assign / detach / clear_all |
tagIds | массив integer | обязательно для assign/detach; игнорируется для clear_all |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: срок действия всех счетов группы
POST /api/v0/accounts/group_operations/change_valid_to_by_account_group
Авторизация: требуется
Тело запроса — объект GroupOpSetValidToByGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
validTo | date | Дата до которой действует счёт, null если бессрочно | |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: срок действия выбранных счетов
POST /api/v0/accounts/group_operations/change_valid_to_by_accounts
Авторизация: требуется
Тело запроса — объект GroupOpSetValidToByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
validTo | date | Дата до которой действует счёт, null если бессрочно | |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: удаление всех счетов группы
POST /api/v0/accounts/group_operations/delete_accounts_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpDeleteAccountsByGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
permanentDelete | boolean | да | Удалить без возможности восстановления |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: удаление выбранных счетов
POST /api/v0/accounts/group_operations/delete_accounts_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpDeleteAccountsByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
permanentDelete | boolean | да | Удалить без возможности восстановления |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: скидка/бонус всех счетов группы
POST /api/v0/accounts/group_operations/discount_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpDiscountByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
discount | IdDto | Скидка | |
rkCode | integer | Код скидки (бонуса) r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса r_keeper | |
bonusLifetime | integer | мин. 1 | |
bonusDelayedDays | integer | мин. 1 | |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: скидка/бонус выбранных счетов
POST /api/v0/accounts/group_operations/discount_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpDiscountByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
discount | IdDto | Скидка | |
rkCode | integer | Код скидки (бонуса) r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса r_keeper | |
bonusLifetime | integer | мин. 1 | |
bonusDelayedDays | integer | мин. 1 | |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: лимиты скидки/бонуса всех счетов группы
POST /api/v0/accounts/group_operations/limits_discount_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpLimitsDiscountByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: лимиты скидки/бонуса выбранных счетов
POST /api/v0/accounts/group_operations/limits_discount_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpLimitsDiscountByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: лимиты оплат всех счетов группы
POST /api/v0/accounts/group_operations/limits_pay_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpLimitsPayByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: лимиты оплат выбранных счетов
POST /api/v0/accounts/group_operations/limits_pay_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpLimitsPayByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: сообщения для экрана/печати всех счетов группы
POST /api/v0/accounts/group_operations/messages_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpMessagesByGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
changeMessageToScreen | boolean | Изменять сообщение для экрана; по умолчанию false |
|
changeMessageOnCheck | boolean | Изменять сообщение для печати; по умолчанию false |
|
messageToScreen | string | Сообщение для экрана | |
messageOnCheck | string | Сообщение для печати | |
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: сообщения для экрана/печати выбранных счетов
POST /api/v0/accounts/group_operations/messages_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpMessagesByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
changeMessageToScreen | boolean | Изменять сообщение для экрана; по умолчанию false |
|
changeMessageOnCheck | boolean | Изменять сообщение для печати; по умолчанию false |
|
messageToScreen | string | Сообщение для экрана | |
messageOnCheck | string | Сообщение для печати | |
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: телефон как идентификатор для всех счетов группы
POST /api/v0/accounts/group_operations/phone_identifier_by_account_group
Авторизация: требуется
Позволяет авторизовать гостя на кассе по номеру телефона.
Тело запроса — объект GrpOpCreatePhoneIdentifierByGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
Ответ 200 — массив объектов GrpOpCreatePhoneIdentifierResultItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
phone | string(15) | да | Номер телефона |
msgCode | integer | да | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество |
Групповая операция: телефон как идентификатор для выбранных счетов
POST /api/v0/accounts/group_operations/phone_identifier_by_accounts
Авторизация: требуется
Позволяет авторизовать гостя на кассе по номеру телефона.
Тело запроса — объект GrpOpCreatePhoneIdentifierByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsIds | массив integer | да | Список идентификаторов счетов |
Ответ 200 — массив объектов GrpOpCreatePhoneIdentifierResultItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
phone | string(15) | да | Номер телефона |
msgCode | integer | да | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество |
Групповая операция: пополнение баланса всех счетов группы
POST /api/v0/accounts/group_operations/refill_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpRefillByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
reason | string | да | Причина (комментарий) операции |
amount | number | Сумма, руб.; мин. 0; макс. 999999999.99 | |
lifetime | integer | Срок жизни начисленных бонусов, дней; мин. 1 |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: пополнение баланса выбранных счетов
POST /api/v0/accounts/group_operations/refill_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpRefillByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsIds | массив integer | да | Список идентификаторов счетов |
reason | string | да | Причина (комментарий) операции |
amount | number | Сумма, руб.; мин. 0; макс. 999999999.99 | |
lifetime | integer | Срок жизни начисленных бонусов, дней; мин. 1 |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: изъятие с баланса всех счетов группы
POST /api/v0/accounts/group_operations/withdrawal_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpWithdrawalByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
reason | string | да | Причина (комментарий) операции |
amount | number | Сумма, руб.; мин. 0; макс. 999999999.99 |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: изъятие с баланса выбранных счетов
POST /api/v0/accounts/group_operations/withdrawal_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpWithdrawalByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsIds | массив integer | да | Список идентификаторов счетов |
reason | string | да | Причина (комментарий) операции |
amount | number | Сумма, руб.; мин. 0; макс. 999999999.99 |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: обнуление баланса всех счетов группы
POST /api/v0/accounts/group_operations/zero_by_account_group
Авторизация: требуется
Тело запроса — объект GrpOpBaseBalanceOperationByAccountGroupDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountGroupId | integer | да | Идентификатор группы счетов |
reason | string | да | Причина (комментарий) операции |
Ответ 200: JSON (структура в схеме не описана).
Групповая операция: обнуление баланса выбранных счетов
POST /api/v0/accounts/group_operations/zero_by_accounts
Авторизация: требуется
Тело запроса — объект GrpOpBaseBalanceOperationByAccountsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountsIds | массив integer | да | Список идентификаторов счетов |
reason | string | да | Причина (комментарий) операции |
Ответ 200: JSON (структура в схеме не описана).
Сгенерировать wallet-идентификатор для счёта
POST /api/v0/accounts/identifiers/generate_wallet_identifier
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
Ответ 200 — массив объектов IdentifierGetDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
identifierType | IdentifierTypeDto | Тип идентификатора | |
isUsingWithManagerCard | boolean | да | Применяется вместе с картой менеджера |
isBlocked | boolean | да | Идентификатор заблокирован |
blockReason | string(100) | Причина блокировки | |
id | integer | да | Идентификатор записи |
code | string(50) | Код идентификатора (номер карты, телефон, код QR) | |
isDeleted | boolean | да | Признак удаления |
deleteReason | string(100) | Причина удаления | |
isSysCode | boolean | Системный код; по умолчанию false |
Добавление нового элемента справочника "Счета"
POST /api/v0/accounts/insert
Авторизация: требуется
Тело запроса — объект AccountInsertDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
discountTemporary | DiscountTemporaryUpdInsDto | Временные скидки счёта | |
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | IdDto | да | Группа счетов |
discount | IdDto | Скидка | |
identifiers | массив IdentifierInsertDto | да | Идентификаторы |
phones | массив PhoneInsertDto | да | Телефоны |
startingBalance | AccountStartingBalance | да | Стартовый (приветственный) баланс нового счёта |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
invitingAccountId | integer | Пригласивший гость |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Добавление нового элемента справочника "Счета" с автоматическим заполнением свойств счёта по шаблону группы счетов
POST /api/v0/accounts/insert_by_template
Авторизация: требуется
Тело запроса — объект AccountInsertByTemplateDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
discountTemporary | DiscountTemporaryUpdInsDto | Временные скидки счёта | |
phones | массив PhoneUpdateDto или PhoneInsertDto | да | Достаточно передать список изменённых и новых телефонов. Сначала производится изменение всех записей, потом вставка всех записей. У телефона изменить номер нельзя, только удалить и сделать новый |
identifiers | массив IdentifierUpdateDto или IdentifierInsertDto | да | Достаточно передать список изменённых и новых идентификаторов. Сначала производится изменение всех записей, потом вставка всех записей. У идентификатора изменить код нелья, только удалить и сделать новый |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения | |
sex | integer | Пол | |
text | string | Текст | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Заблокирован | |
accountGroupId | integer | да | Идентификатор группы счетов |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
invitingAccountId | integer | Пригласивший гость |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Чтение списка элементов справочника "Счета" (все счета или счета из указанной группы)
GET /api/v0/accounts/list
Авторизация: требуется
Базовая информация.
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_group_id | строка запроса | integer | Идентификатор группы счетов |
Ответ 200 — массив объектов AccountsListItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
cards | string | Действующие карты | |
cardsBl | string | Заблокированые карты | |
phones | string | Действующие телефоны | |
phonesBl | string | Заблокированые телефоны | |
identifiers | string | Действующие идентификаторы (не телефоны, и не карты) | |
identifiersBl | string | Заблокированые идентификаторы (не телефоны, и не карты) | |
accountGroupId | integer | да | Группа счетов |
balance | number | Баланс, руб. | |
discountName | string | Наименование составной скидки бонуса, если есть | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
blockReason | string(100) | Причина блокировки | |
discountLevelName | string | Название текущего уровня составной скидки | |
sex | integer | Пол | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
text | string | Доп. информация о госте | |
messageToScreen | string | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string | «Сообщение для печати» — печатается в чеке/пречеке | |
accountGroupName | string | да | Наименование группы счетов |
emails | string | да | Адреса e-mail |
systemIdentifier | string | да | |
systemTgIdentifier | string | по умолчанию «» |
|
systemMaxIdentifier | string | по умолчанию «» |
|
allPhones | string | да | |
createDatetime | datetime | да | Дата и время создания счёта |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
accountTags | массив integer | Теги счёта |
Штампики счёта и их транзакции
GET /api/v0/accounts/promo_stamps
Авторизация: требуется
Возвращает по каждой акции «Штампики» количество выданных, использованных и оставшихся подарков и все связанные транзакции.
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
Ответ 200 — массив объектов AccountPromoStampDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
name | string | да | Наименование |
issued | integer | да | Выдано |
used | integer | да | Использовано |
remaining | integer | да | Осталось |
transactions | массив PromoStampTransactionDto | да | Транзакции |
Пополнение баланса счета с заданным id
POST /api/v0/accounts/refill
Авторизация: требуется
Тело запроса — объект AccountRefillParamDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта |
reason | string | да | Причина пополнения (отображается в отчётах) |
amount | number | да | Сумма пополнения, руб.; мин. 0; макс. 999999999.99 |
lifetime | integer | Срок жизни начисленных бонусов, дней; мин. 1 | |
lateIssueDays | integer | Отложенное начисление: через сколько дней бонусы станут доступны; мин. 1 |
Ответ 200: JSON (структура в схеме не описана).
Получить список активных тегов счёта
GET /api/v0/accounts/tags/active
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
Ответ 200 — массив объектов TagListItemDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string(100) | да | Наименование тега |
isDeleted | boolean | Признак удаления; по умолчанию false |
|
groupId | integer | да | ID группы тега |
id | integer | да | Идентификатор тега |
usageCount | integer | Количество использований; по умолчанию 0 |
Снять тег(и) со счетов
POST /api/v0/accounts/tags/detach
Авторизация: требуется
Тело запроса — объект AccountTagDetachDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountIds | массив integer | да | Список идентификаторов счетов |
tagId | integer | да | Идентификатор тега |
Ответ 200: JSON (структура в схеме не описана).
Назначить тег(и) счетам
POST /api/v0/accounts/tags/set
Авторизация: требуется
Тело запроса — объект AccountTagSetDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountIds | массив integer | да | Список идентификаторов счетов |
tagId | integer | да | Идентификатор тега |
endDate | date | если null — бессрочно; если > NOW — будет отвязан в эту дату | |
assignmentType | integer | да | тип назначения (manual/promotion/etc) |
userId | integer | Идентификатор пользователя | |
promotionActionId | integer | Идентификатор действия акции | |
promotionActionType | integer | ||
comment | string | Комментарий |
Ответ 200: JSON (структура в схеме не описана).
Отчёт по транзакциям по счету с заданным ID
GET /api/v0/accounts/transactions
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
account_id | строка запроса | integer | да | Идентификатор счёта |
date_begin | строка запроса | date | Начало периода | |
date_end | строка запроса | date | Конец периода |
Ответ 200 — объект AccountTransactionsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
dateBegin | date | ||
dateEnd | date | ||
accountOwnerFullName | string | ФИО владельца счёта | |
isDraft | boolean | Заготовка карты; по умолчанию false |
|
totalMoney | number | по умолчанию 0 |
|
totalDiscount | number | по умолчанию 0 |
|
totalReward | number | по умолчанию 0 |
|
totalSpent | number | по умолчанию 0 |
|
totalManualRefill | number | по умолчанию 0 |
|
totalManualWithdrawal | number | по умолчанию 0 |
|
totalManualPromotionRefill | number | по умолчанию 0 |
|
totalManualPromotionWithdrawal | number | по умолчанию 0 |
|
totalDelayedReward | number | по умолчанию 0 |
|
totalDelayedManualRefill | number | по умолчанию 0 |
|
totalDelayedManualWithdrawal | number | по умолчанию 0 |
|
totalDelayedManualPromotionRefill | number | по умолчанию 0 |
|
totalDelayedManualPromotionWithdrawal | number | по умолчанию 0 |
|
items | массив ReportTransactionsItemDto | Элементы |
Разблокировка элемента справочника "Счета" по заданному id
POST /api/v0/accounts/unblock
Авторизация: требуется
Тело запроса — объект IdDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
Ответ 200: JSON (структура в схеме не описана).
Обновление элемента справочника "Счета" по заданному id
POST /api/v0/accounts/update
Авторизация: требуется
Тело запроса — объект AccountUpdateDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
phones | массив PhoneUpdateDto или PhoneInsertDto | да | Достаточно передать список изменённых и новых телефонов. Сначала производится изменение всех записей, потом вставка всех записей. У телефона изменить номер нельзя, только удалить и сделать новый |
identifiers | массив IdentifierUpdateDto или IdentifierInsertDto | да | Достаточно передать список изменённых и новых идентификаторов. Сначала производится изменение всех записей, потом вставка всех записей. У идентификатора изменить код нелья, только удалить и сделать новый |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
discountTemporary | DiscountTemporaryUpdInsDto | Временные скидки счёта | |
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | IdDto | да | Группа счетов |
discount | IdDto | Скидка |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Изъятие средств с баланса счета с заданным id
POST /api/v0/accounts/withdrawal
Авторизация: требуется
Тело запроса — объект AccountWithdrawalParamDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
reason | string | да | Причина (комментарий) операции |
amount | number | да | Сумма, руб.; мин. 0; макс. 999999999.99 |
Ответ 200 — объект AccountRefillWithdrawalResultDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
bonusBalance | number | да | Баланс бонусов, руб. |
bonusAwaitingIssue | number | да | Бонусы, ожидающие начисления (отложенные), руб. |
bonusBurnSoon | number | да | Бонусы, которые скоро сгорят, руб. |
Контакты в мессенджерах
Добавление контакта мессенджера к счёту
POST /api/v0/additional_contacts/add_additional_contact
Авторизация: требуется
Тело запроса — объект AdditionalContactInsertDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | AdditionalContactType | да | Тип контакта (канал мессенджера) |
value | string | да | Значение (идентификатор чата/пользователя в мессенджере) |
accountId | integer | да | Счёт гостя |
Ответ 200 — объект AdditionalContactGetDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор контакта |
type | AdditionalContactType | да | Тип контакта (канал мессенджера) |
value | string | да | Значение (идентификатор чата/пользователя в мессенджере) |
accountId | integer | да | Счёт гостя |
Поиск счёта по контакту мессенджера
GET /api/v0/additional_contacts/find_account_by_additional_contact
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
type | строка запроса | AdditionalContactType | да | Тип контакта мессенджера |
value | строка запроса | string | да | Значение контакта (идентификатор в мессенджере) |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Чтение контакта мессенджера по типу и значению
GET /api/v0/additional_contacts/get_by_type_and_value
Авторизация: требуется
Параметры запроса:
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
type | строка запроса | AdditionalContactType | да | Тип контакта мессенджера |
value | строка запроса | string | да | Значение контакта (идентификатор в мессенджере) |
Ответ 200 — объект AdditionalContactGetDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор контакта |
type | AdditionalContactType | да | Тип контакта (канал мессенджера) |
value | string | да | Значение (идентификатор чата/пользователя в мессенджере) |
accountId | integer | да | Счёт гостя |
Создание счёта по шаблону группы вместе с контактами мессенджеров
POST /api/v0/additional_contacts/insert_account_by_template_with_additional_contacts
Авторизация: требуется
Тело запроса — объект AccountInsertByTemplateWithAdditionalContactsDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
additionalContacts | массив AdditionalContactBaseDto | Контакты мессенджеров | |
discountTemporary | DiscountTemporaryUpdInsDto | Временные скидки счёта | |
phones | массив PhoneUpdateDto или PhoneInsertDto | да | Достаточно передать список изменённых и новых телефонов. Сначала производится изменение всех записей, потом вставка всех записей. У телефона изменить номер нельзя, только удалить и сделать новый |
identifiers | массив IdentifierUpdateDto или IdentifierInsertDto | да | Достаточно передать список изменённых и новых идентификаторов. Сначала производится изменение всех записей, потом вставка всех записей. У идентификатора изменить код нелья, только удалить и сделать новый |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения | |
sex | integer | Пол | |
text | string | Текст | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Заблокирован | |
accountGroupId | integer | да | Идентификатор группы счетов |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
invitingAccountId | integer | Пригласивший гость |
Ответ 200 — объект AccountDto:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор счёта (ID гостя) |
emails | массив EmailDto | Адреса e-mail | |
birthday | date | Дата рождения (используется в сегментах «День рождения») | |
sex | integer | Пол | |
text | string | Доп. информация о госте | |
blockReason | string(100) | Причина блокировки | |
validTo | date | Срок действия счёта | |
isExpired | boolean | Срок действия истёк; по умолчанию false |
|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период | |
discountLimitPeriod | integer | Ограничение скидок/бонусов: период лимита суммы | |
discountLimitAmount | number | Ограничение скидок/бонусов: максимальная сумма за период; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Ограничение скидок/бонусов: период лимита количества применений | |
discountUseLimitCount | integer | Ограничение скидок/бонусов: максимальное количество применений за период | |
fName | string(100) | Имя | |
lName | string(100) | Фамилия | |
mName | string(100) | Отчество | |
draft | boolean | да | Заготовка карты (счёт создан без данных гостя) |
isBlocked | boolean | Счёт заблокирован | |
messageToScreen | string(255) | «Сообщение для экрана» — выводится кассиру при применении карты | |
messageOnCheck | string(255) | «Сообщение для печати» — печатается в чеке/пречеке | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
discountLevelName | string | Название текущего уровня составной скидки | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами. См. Либо начисление, либо оплата бонусами; по умолчанию false |
|
accountGroup | AccountGroupDto | да | Группа счетов |
discount | DiscountDto (discount) | Скидка | |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
|
identifiers | массив IdentifierGetDto | да | Идентификаторы |
phones | массив PhoneGetDto | Телефоны | |
discountTemporary | DiscountTemporaryGetDto | да | Временные скидки счёта |
bonusBalance | number | Баланс бонусов, руб.; по умолчанию 0 |
|
bonusAwaitingIssue | number | Бонусы, ожидающие начисления (отложенные), руб.; по умолчанию 0 |
|
bonusBurnSoon | number | Бонусы, которые скоро сгорят, руб.; по умолчанию 0 |
|
promotions | AccountPromotionsInfo | да | Акции |
createDatetime | datetime | Дата и время создания счёта | |
utm | string | UTM-метки, с которыми гость пришёл в систему (бот, ссылка регистрации) | |
couponsDishes | массив AccountCouponDishDto | Товарные купоны | |
referralInfo | CurrentAccountReferralInfoDto | да | Сведения о том, кто пригласил гостя |
invitedReferralsInfo | массив InvitedAccountReferralInfoDto | да | Гости, приглашённые этим гостем |
Модели данных
Вложенные объекты и перечисления, на которые ссылаются методы этого раздела.
AccountCouponDishDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор записи |
couponDishId | integer | да | Купон |
name | string | да | Наименование |
dateOfIssue | datetime | да | Дата выдачи |
dateStop | datetime | Действует до (NULL — бессрочно) |
|
dateApply | datetime | Дата погашения | |
checkId | integer | Идентификатор чека | |
text | string | Комментарий / основание выдачи | |
state | AccountCouponDishState | да | Состояние |
AccountCouponDishState
Перечисление (string). Значения: UNAPPLIED, APPLIED, DELETED, EXPIRED.
UNAPPLIED — доступен, APPLIED — погашен, DELETED — удалён, EXPIRED — просрочен
AccountGroupDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор группы |
name | string(100) | да | Наименование группы |
template | AccountTemplateDto | Шаблон |
AccountPromotionsInfo
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
stamps | массив AccountPromotionStampsInfo | Штампики |
AccountPromotionStampsInfo
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string | да | Наименование |
currentTurnCount | integer | да | Куплено в текущем цикле |
promoCount | integer | да | Порций для получения подарка |
giftsCount | integer | да | Подарков за цикл |
hideProgressWithoutActivity | boolean | Не показывать прогресс гостям без покупок по акции; по умолчанию false |
|
totalPromoPurchases | integer | Всего куплено акционных блюд; по умолчанию 0 |
AccountRawTransactionBalanceItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
accountId | integer | да | Идентификатор счёта |
transactionId | integer | да | Идентификатор транзакции |
date | datetime | да | Дата |
dateStart | datetime | да | Дата начала |
dateStop | datetime | да | Дата окончания |
tag | integer | да | Номер порции (из последовательности transaction_balance_tag); связывает начисление и его списания |
sum | number | да | Сумма, руб. |
AccountsFindByPhonePartItemDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
fio | string | да | ФИО |
phone | string | да | Номер телефона |
systemId | string | да |
AccountStartingBalance
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
sum | number | Сумма, руб.; мин. 0; макс. 999999999.99 | |
lifetime | integer | Срок жизни начисленных бонусов, дней; мин. 1 |
AccountTemplateDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
payLimitPeriod | integer | Период лимита суммы оплат со счёта | |
payLimitAmount | number | Лимит суммы оплат со счёта; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Период лимита количества оплат | |
payUseLimitCount | integer | Лимит количества оплат | |
discountLimitPeriod | integer | Период лимита суммы скидок/бонусов | |
discountLimitAmount | number | Лимит суммы скидок/бонусов; мин. 0; макс. 999999999.99 | |
discountUseLimitPeriod | integer | Период лимита количества применений | |
discountUseLimitCount | integer | Лимит количества применений | |
accountGroup | IdDto | Группа счетов | |
messageToScreen | string | Сообщение для экрана по умолчанию | |
messageOnCheck | string | Сообщение для печати по умолчанию | |
discount | IdDto | Скидка | |
rkCode | integer | Код скидки (бонуса) в r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса в r_keeper | |
bonusLifetime | integer | Срок жизни начисляемых бонусов, дней; мин. 1 | |
bonusDelayedDays | integer | Отложенное начисление бонусов, дней; мин. 1 | |
notAwardBonusesIfPaidWithBonuses | boolean | Не начислять бонусы, если чек оплачен бонусами; по умолчанию false |
|
startingBalance | AccountStartingBalance | да | Стартовый (приветственный) баланс нового счёта |
isRkCodeBonus | boolean | Код r_keeper является бонусом (а не скидкой) | |
isCompositeDiscountBonus | boolean | Составная скидка начисляет бонусы; по умолчанию false |
|
isBonusLifetime | boolean | У бонусов есть срок жизни; по умолчанию false |
|
isBonusDelayed | boolean | Отложенное начисление бонусов; по умолчанию false |
AdditionalContactBaseDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | AdditionalContactType | да | Тип контакта (канал мессенджера) |
value | string | да | Значение (идентификатор чата/пользователя в мессенджере) |
AdditionalContactType
Перечисление (integer). Значения: 1, 2.
ChangeBonusAwardActionDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | string | да | Тип; значения: changeBonusAward |
parameters | ChangeBonusAwardParametersDto | да | Параметры (JSON) |
ChangeBonusAwardParametersDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
notAwardBonusesIfPaidWithBonuses | boolean | да |
ChangeMessagesActionDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | string | да | Тип; значения: changeMessages |
parameters | ChangeMessagesParametersDto | да | Параметры (JSON) |
ChangeMessagesParametersDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
changeMessageToScreen | boolean | Изменять сообщение для экрана; по умолчанию false |
|
changeMessageOnCheck | boolean | Изменять сообщение для печати; по умолчанию false |
|
messageToScreen | string(255) | Сообщение для экрана | |
messageOnCheck | string(255) | Сообщение для печати |
ChangePayLimitsActionDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | string | да | Тип; значения: changePayLimits |
parameters | ChangePayLimitsParametersDto | да | Параметры (JSON) |
ChangePayLimitsParametersDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
payLimitPeriod | integer | Ограничение оплат со счёта: период лимита суммы | |
payLimitAmount | number | Ограничение оплат со счёта: максимальная сумма за период, руб.; мин. 0; макс. 999999999.99 | |
payUseLimitPeriod | integer | Ограничение оплат со счёта: период лимита количества | |
payUseLimitCount | integer | Ограничение оплат со счёта: максимальное количество оплат за период |
ChangeTagsActionDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | string | да | Тип; значения: changeTags |
parameters | ChangeTagsParametersDto | да | Параметры (JSON) |
ChangeTagsParametersDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
mode | string | да | Режим; значения: assign, detach, clear_all |
tagIds | массив integer | Список идентификаторов тегов |
ChangeValidToActionDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | string | да | Тип; значения: changeValidTo |
parameters | ChangeValidToParametersDto | да | Параметры (JSON) |
ChangeValidToParametersDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
mode | string | да | Режим; значения: date, unlimited |
validTo | date |
CurrentAccountReferralInfoDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
fullName | string | да | ФИО гостя |
createDatetime | datetime | да | Дата и время создания счёта |
rewardReceived | datetime | Вознаграждение получено | |
invitingAccountId | integer | Пригласивший гость | |
invitingAccountFullName | string |
DiscountDto (discount)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string(50) | да | Наименование |
limitPeriodInDays | integer | Период накопления суммы потрат, дней (NULL — за всё время) |
|
discountLevels | массив DiscountLevelDto | да | Уровни составной скидки |
id | integer | да | Идентификатор |
DiscountLevelDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
rkCode | integer | да | Код скидки (бонуса) r_keeper для уровня |
levelAmount | number | да | Порог суммы потрат для перехода на уровень; мин. 0; макс. 999999999.99 |
rkBonusTypeCode | integer | Код типа бонуса r_keeper | |
levelName | string | Название уровня | |
isBonus | boolean | Бонус (а не скидка); по умолчанию false |
DiscountTemporaryGetDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
rkCode | integer | Код скидки (бонуса) r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса r_keeper | |
reason | string | Причина назначения | |
validUntil | date | Действует до (включительно) | |
isRkCodeBonus | boolean | да | Код r_keeper является бонусом (а не скидкой) |
isValid | boolean | Данные корректны |
DiscountTemporaryUpdInsDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
rkCode | integer | Код скидки (бонуса) r_keeper | |
rkBonusTypeCode | integer | Код типа бонуса r_keeper | |
reason | string | Причина (комментарий) операции | |
validUntil | date | Действует до (включительно) |
EmailDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
address | string (e-mail) | да | Адрес e-mail |
isPrimary | boolean | да | Основной адрес |
IdDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
IdentifierGetDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
identifierType | IdentifierTypeDto | Тип идентификатора | |
isUsingWithManagerCard | boolean | да | Применяется вместе с картой менеджера |
isBlocked | boolean | да | Идентификатор заблокирован |
blockReason | string(100) | Причина блокировки | |
id | integer | да | Идентификатор записи |
code | string(50) | Код идентификатора (номер карты, телефон, код QR) | |
isDeleted | boolean | да | Признак удаления |
deleteReason | string(100) | Причина удаления | |
isSysCode | boolean | Системный код; по умолчанию false |
IdentifierInsertDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
identifierType | IdentifierTypeInsertIdDto | да | Тип идентификатора |
isUsingWithManagerCard | boolean | да | Применяется вместе с картой менеджера |
isBlocked | boolean | да | Идентификатор заблокирован |
blockReason | string(100) | Причина блокировки | |
code | string(50) | Код идентификатора (номер карты, телефон, код QR) |
IdentifierTypeDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name | string(100) | да | Наименование типа |
id | integer | да | Идентификатор типа |
system | boolean | Системный тип (нельзя удалить); по умолчанию false |
|
systemType | string | Код системного типа (см. описание таблицы) | |
temporary | boolean | Временный идентификатор (имеет срок действия); по умолчанию false |
|
frontVisible | boolean | Отображать в веб-интерфейсе; по умолчанию true |
|
frontEditable | boolean | Разрешено редактировать в веб-интерфейсе; по умолчанию true |
IdentifierTypeInsertIdDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | integer | да | Идентификатор |
IdentifierUpdateDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
identifierType | IdentifierTypeInsertIdDto | да | Тип идентификатора |
isUsingWithManagerCard | boolean | да | Применяется вместе с картой менеджера |
isBlocked | boolean | да | Идентификатор заблокирован |
blockReason | string(100) | Причина блокировки | |
id | integer | да | Идентификатор записи |
isDeleted | boolean | да | Признак удаления |
deleteReason | string(100) | Причина удаления |
InvitedAccountReferralInfoDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
fullName | string | да | ФИО гостя |
createDatetime | datetime | да | Дата и время создания счёта |
rewardReceived | datetime | Вознаграждение получено | |
accountId | integer | да | Идентификатор счёта |
PhoneGetDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
isPrimary | boolean | да | Основной номер |
text | string | Комментарий | |
isIdentifier | boolean | да | Признак того, что телефон является идентификатором. Если значение True, то создаётся идентификатор. Можно задать значение True (тоесть создать идентификатор) и при создании телефона и при изменении. Если телефон уже является идентификатором, этот флаг игнорируется. Также, этот флаг игнорируется, если телефон не идентификатор, и его надо удалить (выставлен флаг is_deleted). Если нужно, чтобы телефон перестал быть идентификатором, необходимо удалить его из идентификаторов |
id | integer | да | Идентификатор записи |
number | string(15) | да | phone number in E.164 format |
PhoneInsertDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
isPrimary | boolean | да | Основной номер |
text | string | Комментарий | |
isIdentifier | boolean | да | Признак того, что телефон является идентификатором. Если значение True, то создаётся идентификатор. Можно задать значение True (тоесть создать идентификатор) и при создании телефона и при изменении. Если телефон уже является идентификатором, этот флаг игнорируется. Также, этот флаг игнорируется, если телефон не идентификатор, и его надо удалить (выставлен флаг is_deleted). Если нужно, чтобы телефон перестал быть идентификатором, необходимо удалить его из идентификаторов |
number | string(15) | да | phone number in E.164 format |
PhoneUpdateDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
isPrimary | boolean | да | Основной номер |
text | string | Комментарий | |
isIdentifier | boolean | да | Признак того, что телефон является идентификатором. Если значение True, то создаётся идентификатор. Можно задать значение True (тоесть создать идентификатор) и при создании телефона и при изменении. Если телефон уже является идентификатором, этот флаг игнорируется. Также, этот флаг игнорируется, если телефон не идентификатор, и его надо удалить (выставлен флаг is_deleted). Если нужно, чтобы телефон перестал быть идентификатором, необходимо удалить его из идентификаторов |
id | integer | да | Идентификатор записи |
isDeleted | boolean | Признак удаления; по умолчанию false |
PromoStampTransactionDto
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
datetime | datetime | да | Дата и время |
operation | string | да | Операция |
dishName | string | Наименование блюда | |
quantity | integer | Количество | |
restaurant | string | да | Код ресторана (устаревшее поле, см. restaurant_id) |
checkNumber | string | Номер чека | |
checkId | integer | Идентификатор чека | |
checkDishSum | integer | Сумма по блюду, копейки | |
checkSum | integer | Сумма чека, копейки |
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 | Пол гостя |
TransactionRawKind
Перечисление (integer). Значения: 1, 2, 3, 4.