Get Bill
Перейти до навігації
Перейти до пошуку
Функція повертає рахунок і його вміст
Розділ містить методи, необхідні для отримання рахунку за номером або GUID-кодом з бази даних
| Опис | Отримання рахунку. |
|---|---|
| Метод | POST |
| URL | /POSExternal/Get_Bill |
| Request Headers | |
|---|---|
| KEY | VALUE |
| Content-Type | application/json |
| AccessToken | |
| Body raw (json) |
|---|
{
"BillID": "{{billid}}",
//"CodeGUID":"805CC7A4-48F5-445C-9290-BE71964F0E6B",
"Locked_": false
}
| Типи даних Body | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| SystemCode | String[32] | код системи | |
| BillID | Int | ID рахунку | |
| TempID | Int | тимчасовий id рахунку. Шукає рахунок за цим кодом. Якщо не знаходить – повертає BillID = -1 (необов'язковий параметр) | |
| Locked | Bool | заблокувати рахунок (необов'язковий параметр) | |
| CodeGUID | String | GUID-код рахунку | |
| * Позначення обов’язкового параметру | |||
| Додатковий опис вихідних параметрів |
|---|
| Response (json) |
|---|
{
"Error": "",
"Success": true,
"BillID": 19738,
"BillNumber": 15978,
"Number": 15978,
"BillType": 2,
"BlockedStationCode": null,
"BlockedUserName": null,
"Closed": "2022-07-18 12:24:03",
"Comment": null,
"CompanyCode": null,
"CompanyName": null,
"Description": null,
"EventName": null,
"FirstDate": null,
"IsPaid": true,
"IsPrepared": true,
"LastDate": null,
"Locked": null,
"PlaceCode": "TABLE300818110717487",
"Printed": "2022-07-18 12:23:44",
"ShortComment": null,
"SubTotal": 595,
"Total": 535.5,
"UserName": "Expert Solution",
"Items": [
{
"BillItemID": 25647,
"CategoryID": 147,
"CategoryName": "МОЯ КАТЕГОРИЯ",
"Comment": null,
"ComplexID": null,
"Description": null,
"EnterpriseID": 205,
"EnterpriseTaxCode": null,
"ExciseStamp": false,
"ExciseStamps": null,
"ItemType": " ",
"Name": "Коктейль Оголена Crazy Даша",
"Ordered": "2022-07-18 12:23:44",
"ParentID": null,
"PhotoUrl": null,
"PickUp": 0,
"Pos": 0,
"Price": 300,
"Quantity": 1,
"Seat": 0,
"SectionID": 3101,
"ShortName": "Коктейль Оголена Crazy Даша",
"Status": 1,
"SubItemID": null,
"TarifItemID": 14445,
"Total": 270,
"TypeID": null
},
{
"BillItemID": 25648,
"CategoryID": 147,
"CategoryName": "МОЯ КАТЕГОРИЯ",
"Comment": null,
"ComplexID": null,
"Description": null,
"EnterpriseID": 205,
"EnterpriseTaxCode": null,
"ExciseStamp": false,
"ExciseStamps": null,
"ItemType": " ",
"Name": "Коктейль Госпожа",
"Ordered": "2022-07-18 12:23:44",
"ParentID": null,
"PhotoUrl": null,
"PickUp": 0,
"Pos": 0,
"Price": 295,
"Quantity": 1,
"Seat": 0,
"SectionID": 3101,
"ShortName": "Коктейль Госпожа",
"Status": 1,
"SubItemID": null,
"TarifItemID": 14453,
"Total": 265.5,
"TypeID": null
}
],
"Discounts": [
{
"Applied": "2022-07-15 11:50:41",
"BillID": 19738,
"CardID": null,
"Discount": 10.0000,
"DiscountID": 7516,
"DiscountType": 3,
"OwnerCode": null,
"OwnerID": null,
"OwnerName": null
}
],
"IdTemps": [
{
"idTemp": 431492278
},
{
"idTemp": 619128041
},
{
"idTemp": 1113879060
},
{
"idTemp": 856863549
}
],
"ChangeDate": "2022-07-18 12:24:03",
"ChangeDateUTC": "2022-07-18T09:24:03.71Z",
"WaitedFor": null,
"WaitedFrom": null,
"EstimatedPaymentID": null,
"EstimatedPaymentName": null,
"CodeGUID": "6049AF6A-54D9-48E2-AA7C-B0A4D15E1081",
"AdvancePay": 0,
"IsUseCard": false,
"GuestCount": 3,
"DeliveryAddressComment": null,
"DeliveryComment": null,
"OpenUserID": 0,
"idTemp": null,
"NumType": 1,
"NumName": "Рахунок гостя"
}
| Типи даних Response | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| Error | String [] | Опис помилки, що виникла | |
| Success | Bool | Успіх виконання запиту | |
| BillType | Int | тип рахунку:
1 – звичайний рахунок; 2 – рахунок закрито і не можна редагувати; 3 – рахунок відкритий і сплачений 4 – рахунок бронювання (для готельної системи за замовчуванням; 8 – рахунок доставки | |
| 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–не замовлено, 1–замовлено, 2–прийнято в роботу, 4–готово, 7–готово до відвантаження | |
| IsManualPrice | Int | можливість застосування ручної ціни (для режиму авторизації) | |
| Seat | Int | номер клієнта | |
| Pos | Int | порядок виносу | |
| BillItemTempID | Int | тимчасовий код | |
| TimeOut | Int | через скільки хвилин винос | |
| EnterpriseTaxCode | String | код зведення (відповідає поєднанню підприємства і податку) | |
| TypeID | Int | тип номенклатури (для режиму авторизації)
0 - Надбавка 1 - Продукція (можлива не ціла кількість) 2 - Продукція (поштучно – тільки ціла кількість) 3 - Продукція (за вагою) 4 - Товар (можлива не ціла кількість) 5 - Товар (поштучно – тільки ціла кількість) 6 - Товар (за вагою) 7 - Послуга | |
| ExciseStamps | String [] | масив акцизних марок | |
| Discounts | DiscountList[] | масив знижок по рахунку з наступними полями (тільки після авторизації) | |
| DiscountID | Int | ID дисконту | |
| BillID | Int | ID рахунку | |
| DiscountType | Int | тип знижки:
1 картка, 2 по групі карток, 3 у відсотковому вираженні, 4 в грошовому, 5 акційний купон | |
| 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 | код станції з якої заблокували рахунок | |
| * Позначення обов’язкового параметру | |||
| Додатковий опис вхідних параметрів |
|---|