Bill PaymentExt
Перейти до навігації
Перейти до пошуку
Функція оплачує рахунок і закриває його
Розділ містить методи, необхідні для оплати рахунку за номером
| Опис | Оплата рахунку. |
|---|---|
| Метод | POST |
| URL | /POSExternal/Bill_PaymentExt |
| Request Headers | |
|---|---|
| KEY | VALUE |
| Content-Type | application/json |
| AccessToken | |
| Body raw (json) |
|---|
{
"AccountID": 0,
"BillID": 17572,
"Deposit": 0.0,
"DepositID": 0,
"Description": "",
"DontClose": false,
"id": 828411040,
"PaySubType": 0,
"PaymentID": 2441,
"ReturnResult": false,
"Summ": 22000.0,
"SystemCode": "4503"
}
| Типи даних Body | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| SystemCode | String [32] | Код системи | |
| BillID | Int | ID рахунку | |
| PaymentID | Int | ID оплати | |
| CardCode | String | Код карти для типу оплаты картою (в інших ігнорується) | |
| Summ | Int | Cума оплати в копійках | |
| Description | String [500] | Подробиці оплати (бажано додавати зміну за якої була проведена оплата, RRN, код карти, номер розрахункового рахунку, і т.д.) | |
| BonusSum | Decimal | Cума бонусів | |
| ReturnResult | Bool | Повернення файлів для друку на Bluetooth принтер | |
| Параметри що використовуються для закриття на номер. Для отримання параметрів використовувати функцію GetHMSGuests. | |||
| AccountID | Int | ID аккаунту (вик. тільки для закриття на номер) | |
| DepositID | Int | ID депозиту (вик. тільки для закриття на номер) | |
| Deposit | Decimal | Депозит (вик. тільки для закриття на номер) | |
| PaySubType | Int | Tип закриття (вик. тільки для закриття на номер) | |
| DontClose | Bool | Hе закривати рахунок після оплати (за замовчуванням рахунок буде закрито) (необов'язковий параметр) | |
| * Позначення обов’язкового параметру | |||
| Додатковий опис вихідних параметрів |
|---|
| Response (json) |
|---|
{
"Error": "",
"Success": true,
"Files": []
}
| Типи даних Response | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| Error | String [] | Опис помилки, що виникла | |
| Success | Bool | Успіх виконання запиту | |
| BillType | Int | Тип рахунку: 1 – звичайний рахунок; | |
| FirstDate | Datetime | Дата початку надання послуг. Для рахунків бронювання обов”язковий параметр, для інших ігнорується | |
| BillID | Int | ID рахунку | |
| LastDate | Datetime | Дата закінчення надання послуг. Для рахунків бронювання обов”язковий параметр, для інших ігнорується | |
| UserName | String [64] | Користувач що створив рахунок | |
| PlaceCode | String [32] | Код місця надання послуги для рахунків бронювання, допустиме значення NULL для інших | |
| EventName | String [32] | Назва заходу для рахунків бронювання, допустиме значення NULL для інших | |
| CompanyCode | String [32] | Код компанії, допустиме значення NULL | |
| CompanyName | String [32] | Назва компанії, допустиме значення NULL | |
| Description | String [500] | Опис рахунку, допустиме значення NULL | |
| ShortComment | String [255] | Короткий коментар до рахунку | |
| Total | Decimal | Сума по рахунку | |
| SubTotal | Decimal | Сума по рахунку без знижки | |
| IsPrepared | Boolean | Ознака підготовки рахунку до закриття (встановлюється перед сплатою рахунку і його закриттям) | |
| Printed | Datetime | Дата друку рахунку | |
| Closed | Datetime | Дата закриття рахунку | |
| Locked | Datetime | Дата блокування | |
| IsPaid | Boolean | Рахунок сплачений | |
| IsUseCard | Boolean | Чи додана до рахунку картка | |
| NumType | Int | Вид рахунку (Null якщо немає) | |
| GuestCount | Int | Кількість гостей | |
| NumName | String | Назва виду рахунку (Null якщо немає) | |
| DeliveryComment | String | Коментар до рахунку доставки | |
| DeliveryAddressComment | String | Коментар до адреси доставки | |
| DeliveryPersonComment | String | Коментар до персони | |
| idTemp | Int | Тимчасовий код рахунку | |
| ChangeDate | Datetime | Дата зміни | |
| WaitedFrom | Datetime | Дата доставки замовлення (з) | |
| WaitedFor | Datetime | Дата доставки замовлення (до) | |
| Items | BillList [] | Массив опису номенклатури. Елементи масиву з наступними полями: | |
| | BillItemID | Int | ID позиції рахунку | |
| | ParentID | Int | ID-вказівник батьківської/базової позиції рахунку | |
| | TarifItemID | Int | ID номенклатури | |
| | ModifierID | Int | ID модифікатора стану (для режиму авторизації) | |
| | Name | String [128] | Назва номенклатури | |
| | ShortName | String [32] | Коротка назва номенклатури | |
| | Description | String [500] | Опис номенклатури | |
| | Comment | String [1024] | Kоментар до позиції | |
| | Quantity | Decimal | Кількість номенклатури | |
| | Price | Decimal | Ціна за одиницю номенклатури | |
| | SectionID | Int | ID відділу | |
| | Total | Decimal | Ціна позиції (після знижки или вручну тільки за авторизацією) | |
| | ItemType | String [32] | Тип суб-позиції | |
| | PhotoUrl | String [128] | Url вказівник на картинку в інтернеті | |
| | ComplexID | Int | ID комплексу | |
| | SubItemName | String | Назва номенклатури інгридієнту комплексу за замовчуванням | |
| | Ordered | Datetime | Дата замовлення позиції рахунку | |
| | Status | Int | Статус блюда: 0 – не замовлено, | |
| | IsManualPrice | Int | Можливість застосування ручної ціни (для режиму авторизації) | |
| | Seat | Int | Номер клієнта | |
| | Pos | Int | Порядок виносу | |
| | BillItemTempID | Int | Тимчасовий код | |
| | TimeOut | Int | Через скільки хвилин винос | |
| | EnterpriseTaxCode | String | Код зведення (відповідає поєднанню підприємства і податку) | |
| | TypeID | Int | Тип номенклатури (для режиму авторизації) 0 - Надбавка | |
| | ExciseStamps | String [] | Масив акцизних марок | |
| Discounts | DiscountList [] | Масив знижок по рахунку з наступними полями (тільки після авторизації) | |
| | DiscountID | Int | ID дисконту | |
| | BillID | Int | ID рахунку | |
| | DiscountType | Int | Тип знижки: 1 - картка, | |
| | Applied | String [128] | Час застосування | |
| | OwnerID | Int | ID персони | |
| | OwnerName | String [500] | Iм'я персони | |
| | OwnerCode | String [1024] | Kод персони | |
| | Discount | Decimal | Дисконт (% або сума, залежить від DiscountType) | |
| | CardID | Int | ID дисконтної картки | |
| IdTemps | IdTemp [] | Масив id Temp | |
| | idTemp | Int | Тимчасовий ID позиції при створенні в рахунку | |
| CodeGUID | String | GUID-код | |
| AdvancePay | Decimal | Сума передплати | |
| BlockedUserName | String | Iм'я користувача що заблокував рахунок | |
| BlockedStationCode | String | Код станції з якої заблокували рахунок | |
| * Позначення обов’язкового параметру | |||
| Додатковий опис вхідних параметрів |
|---|