Set Bill: відмінності між версіями

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
Немає опису редагування
Немає опису редагування
Рядок 1: Рядок 1:
=='''Функція формує рахунок і його опис'''==
=='''Функція формує рахунок і його опис'''==


  Розділ містить методи, необхідні для формування рахунку для подальшого внесуння його у базу даних
  Розділ містить методи, необхідні для формування рахунку для подальшого внесення його у базу даних
<br>
<br>


Рядок 193: Рядок 193:
|
|
| Error
| Error
| String []  
| String[]  
| Опис помилки, що виникла
| Опис помилки, що виникла
|-
|-

Версія за 11:51, 19 липня 2022

Функція формує рахунок і його опис

Розділ містить методи, необхідні для формування рахунку для подальшого внесення його у базу даних


Опис Створення рахунку і його опис
Метод POST
URL /POSExternal/SetBill



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
    "OperType": 1,  //создание счета
    "BillType": 1,  //тип резерв
    "UserName": "Чистяков 'Антон'",
    "PlaceCode": "TABLE300818110717487",  //код стола
    "EventName":"День Рождения",  //
    "FirstDate": "2021-11-29 10:00:0",
    "LastDate": "2021-11-29 22:00:00",
    "CardCode": "380675016786"
}



Типи даних Body
* Параметр Тип Опис
SystemCode String[32] Kод системи
OperType Int Tип операції(1-створення рахунку, 2-зміна рахунку)
BillID Int ID рахунку. Якщо OperType=1, значення ігноруватиметься
BillType Int тип рахунку(1-звичайний рахунок, 4-рахунок бронювання (для готельної системи за замовчанням), 8-рахунок доставки)
FirstDate Datetime дата початку надання послуг, допустиме значення NULL
LastDate Datetime дата закінчення надання послуг, допустиме значення NULL
UserName String[64] користувач що створив рахунок, допустиме значення NULL
PlaceCode String[32] код місця надання послуги (для рахунків бронювання обов”язковий параметр, допустиме значення NULL для інших)
EventID String[32] ID заходу(для рахунків бронювання, допустиме значення NULL для інших)
EventName String[32] назва заходу (для рахунків бронювання, допустимо значення NULL для інших)
CompanyCode String[32] код компанії, допустиме значення NULL
CompanyName String[32] компанія, допустиме значення NULL
Description String[500] опис рахунку, допустиме значення NULL
CardCode String код карти
Delivery Delivery[] об”єкт доставки з такими полями (для рахунків доставки), допустиме значення NULL для інших:
ClientAdressID Int ID адреси клієнта
WaitedFor Datetime дата і час доставки(з)
WaitedFrom Datetime дата і час доставки(по)
Comment String коментар
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": "",
    "Success": true,
    "BillID": 19843,
    "BillNumber": 16067
}



Типи даних Response
* Параметр Тип Опис
Error String[] Опис помилки, що виникла
Success Bool Успіх виконання запиту
BillID Int ID рахунку
BillNumber Int Номер рахунку
* Позначення обов’язкового параметру
Додатковий опис вхідних параметрів