GetDiscountCardInfo: відмінності між версіями
Перейти до навігації
Перейти до пошуку
Немає опису редагування |
Немає опису редагування |
||
| Рядок 62: | Рядок 62: | ||
| Int | | Int | ||
| Pахунок до якого застосувати дисконтну картку | | Pахунок до якого застосувати дисконтну картку | ||
|- | |||
| | |||
| TakeFirst | |||
| Int | |||
| Фільтр. Виводить зазначену кількість останніх рахунків. (без цього параметру виводяться всі рахунки) | |||
|- | |- | ||
Версія за 08:15, 25 вересня 2023
Функція повертає інформацію по дисконтній картці і застосовує її до рахунку якщо параметр BillID>0
Розділ містить методи, необхідні для отримання інформації про дисконтну картку за її номером
| Опис | Отримання інформації про дисконтну картку. |
|---|---|
| Метод | POST |
| URL | /POSExternal/GetDiscountCardInfo |
| Request Headers | |
|---|---|
| KEY | VALUE |
| Content-Type | application/json |
| AccessToken | |
| Body raw (json) |
|---|
{
"CardCode": "1111"
//"BillID": 4901
}
| Типи даних Body | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| CardCode | String [50] | Код картки | |
| BillID | Int | Pахунок до якого застосувати дисконтну картку | |
| TakeFirst | Int | Фільтр. Виводить зазначену кількість останніх рахунків. (без цього параметру виводяться всі рахунки) | |
| * Позначення обов’язкового параметру | |||
| Додатковий опис вихідних параметрів |
|---|
| Response (json) |
|---|
{
{
"Error": "",
"Success": true,
"eWallets": [
{
"AccumulatedBonuses": 0.00,
"Accumulation": 9322.50,
"BonusBalance": 1050.00,
"BonusStatusName": null,
"BonusSum": 1050.00,
"Comment": null,
"CompanyAccount": null,
"Credit": 0.00,
"DayLimit": 9999999999.00,
"Description": null,
"Discount": 50.0000,
"DiscountPriceListCode": null,
"DiscountStatusName": null,
"DiscountTransactionsSum": null,
"Email": "",
"ExtraMoneySum": 0.00,
"IsBonusProgram": false,
"IsDiscountProgram": true,
"IsPayCard": false,
"IsSmartCard": false,
"Issue": false,
"LoyaltyProgramName": "Знижка 50%",
"MobilePhone": "80631238767",
"MonthLimit": 9999999999.00,
"PaySum": 0.00,
"PersonCode": "1CA15182-C731-4C60-BAB7-C684E22A109B",
"PersonDiscountCode": "1111 ",
"PersonDiscountGroupID": 2420,
"PersonDiscountID": 14996,
"PersonDiscountShortCode": "1111",
"PersonID": 14995,
"ServioSynkCode": "PSDCNTS050314140952030 ",
"ShortCode": "1111",
"UseCatLimits": false,
"UsePayLimits": false,
"UserName": "Наталия Наталия Сергеевна",
"Validity": null,
"ValidityStart": null,
"WeekLimit": 9999999999.00,
"YearLimit": 9999999999.00,
"Avatar": "",
"Birthday": null,
"FirstName": "Наталия",
"GetNews": false,
"LastName": "Наталия",
"MiddleName": "Сергеевна",
"Properties": [],
"Sex": "1",
"BrandSums": [],
"Childrens": []
}
],
"Bills": [
{
"BillId": 19917,
"BillNumber": 16103,
"BillSubTotal": 450.00,
"BillTotal": 225.00,
"Opened": "2022-07-25 13:02:34",
"DeliveryStatus": null,
"DeliveryStatusName": null,
"PaymentID": null,
"AddressID": null,
"KitchenID": null,
"BrandID": null,
"BrandName": null,
"NumType": 1,
"Items": [
{
"TarifItemID": 13697,
"Name": "Аперитив Aperol",
"Amount": 1.000,
"SubTotal": 150.00,
"DiscountSum": 75.00,
"Total": 75.00
}
]
}
],
"Promocodes": [],
"Tradeactions": [],
"Votes": [],
"Addresses": [
{
"ID": 1033,
"StreetName": "проспект Валерия Лобановского, Киев, Украина",
"Number": "999",
"Building": "",
"Entrance": "",
"Storey": "",
"Apartment": null,
"IsDefault": false
}
]
}
}
| Типи даних Response | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| Error | String [] | Опис помилки, що виникла | |
| Success | Bool | Успіх виконання запиту | |
| eWallets | eWallet [] | Масив описів електронних гаманців eWallet. Елементи масива структури з наступними полями: | |
| | PersonID | Int | ID персони | |
| | PersonCode | String | Код персони | |
| | PersonDiscountID | Int | ID дисконтної картки | |
| | PersonDiscountCode | String [30] | Довгий номер магнітної картки | |
| | PersonDiscountGroupID | Int | ID групи картки | |
| | Discount | Decimal | Розмір знижки по картці | |
| | LoyaltyProgramName | String [100] | Назва програми лояльності | |
| | UserName | String | ПІБ користувача з анкети електронного гаманця | |
| | MobilePhone | String | Мобільний телефон | |
| | IsBonusProgram | Bool | Флаг що визначає належність електронного гаманця до бонусної програми | |
| | IsDiscountProgram | Bool | Флаг що визначає належність електронного гаманця до дисконтної програми | |
| | BonusStatusName | String [50] | Назва поточного бонусного статусу, якщо гаманець належить до бонусної програми | |
| | BonusBalance | Decimal | Поточний бонусний баланс електронного гаманця | |
| | AccumulatedBonuses | Decimal | Поточна кількість накопичених бонусів електронного гаманця | |
| | DiscountStatusName | String [50] | Назва поточного дисконтного статусу, якщо гаманець належить до дисконтної програми | |
| | DiscountPriceListCode | String [20] | Код прейскуранту поточного дисконтного статусу, потрібен для синхронизації знижки по прейскуранту, якщо гаманець належить до дисконтної программи і для нього заведений код прейскуранту | |
| | DiscountTransactionsSum | Decimal | Сума всіх неанульованих транзакцій з урахуванням знижки, проведених для даного гаманця | |
| | ServioSynkCode | String [20] | Код синхронизації програми лояльності | |
| | CompanyAccount | Int | Ідентифікатор компанії | |
| | PersonDiscountShortCode | String [30] | Короткий номер магнитної картки | |
| | BonusSum | Decimal | Сума бонусів | |
| | PaySum | Decimal | Сума на розрахунковій картці | |
| | Credit | Decimal | Сума кредитy | |
| | Accumulation | Decimal | Сума обороту по карті | |
| | IsPayCard | Bool | Чи є платіжною карткою | |
| | ExtraMoneySum | Decimal | Сума екстра-грошей | |
| | IsSmartCard | Bool | Чи є смарт карткою | |
| | ShortCode | String | Короткий номер магнiтної картки | |
| | DayLimit | Decimal | Ліміт списання за день | |
| | WeekLimit | Decimal | Ліміт списання за тиждень | |
| | MonthLimit | Decimal | Ліміт списання за місяць | |
| | YearLimit | Decimal | Ліміт списання за рік | |
| | UsePayLimits | Bool | Чи використовуються ліміти списання | |
| | UseCatLimits | Bool | Чи використовуються ліміти категорій | |
| | ValidityStart | Datetime | Дата початку дії картки/сертифікату | |
| | Validity | Datetime | Дата закінчення дії картки/сертифікату | |
| | Blocked | Bool | Чи є картка заблокованою | |
| | Issue | Bool | Чи Issued | |
| | Comment | String | Коментар | |
| | Description | String | Примітка | |
| String | Електронна пошта | ||
| | Birthday | Datetime | Дата народження | |
| | Sex | String | Стать | |
| | GetNews | Bool | Отримувати сповіщення | |
| | LastName | String | Прізвище | |
| | FirstName | String | Ім'я | |
| | MiddleName | String | По-батькові | |
| | Avatar | String | Іконки аватару | |
| | Properties | Int [] | Список «Улюблені Розваги» | |
| Bills | Bills [] | Масив рахунків. Елементи масиву структури з такими полями: | |
| | BillId | Int | ID рахунку | |
| | BillNumber | Int | Номер рахунку | |
| | NumType | Int | Тип рахунку | |
| | BillTotal | Decimal | Сума по рахунку зі знижкою, грн | |
| | BillSubTotal | Decimal | Сума по рахунку без знижки, грн | |
| | DeliveryStatus | Int | Статус замовлення | |
| | DeliveryStatusName | String | Найменування статусу замовлення | |
| | PaymentID | Int | ID оплати | |
| | AddressID | Int | ID адреси | |
| | KitchenID | Int | ID кухні | |
| | BrandID | Int | ID бренду | |
| | BrandName | String | Ім'я бренду | |
| | Items | Items [] | Масив замовлень. Елементи масива структури з такими полями: | |
| | | TarifItemID | Int | ID тарифної позиції | |
| | | Name | String | Найменування замовлення | |
| | | Amount | Decimal | Кількість | |
| | | SubTotal | Decimal | Сума без знижки, грн | |
| | | DiscountSum | Decimal | Знижка, грн | |
| | | Total | Decimal | Сума зі знижкою, грн | |
| Promocodes | Promocodes [] | Масив з промокодами. Елементи масиву структури з такими полями: | |
| | ID | Int | ID промокоду | |
| | Code | String | Код промокоду | |
| | Validity | Datetime | Період дії промокоду | |
| | Info | String | Опис | |
| Tradeactions | Tradeactions [] | Масив з акціями. Елементи масиву структури з такими полями: | |
| | ID | Int | ID акції | |
| | Name | String | Найменування акції | |
| | Validity | Datetime | Період дії акції | |
| | Info | String | Опис | |
| Votes | Votes [] | Масив з відгуками. Елементи масиву структури з такими полями: | |
| | ID | Int | ID відгуку | |
| | VoteDate | String | Дата відгуку | |
| | BillNumber | Int | Номер рахунку | |
| | Info | String | Зміст відгуку | |
| Addresses | Addresses [] | Масив з адресами. Елементи массиву структури з такими полями: | |
| | ID | Int | ID адреси | |
| | StreetName | String | Назва вулиці | |
| | Number | String | Номер будинку | |
| | Building | String | Буква будинку | |
| | Entrance | String | Вхід | |
| | Storey | String | Поверх | |
| | Apartment | String | Квартира | |
| | IsDefault | Bool | За замовчуванням | |
| * Позначення обов’язкового параметру | |||
| Додатковий опис вхідних параметрів |
|---|