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

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
Немає опису редагування
Немає опису редагування
Рядок 40: Рядок 40:
     "OperType": 1,  //создание счета
     "OperType": 1,  //создание счета
     "BillType": 1,  //тип резерв
     "BillType": 1,  //тип резерв
     "UserName": "Чистяков 'Антон'",
     "UserName": "Сергей Сергей",
     "PlaceCode": "TABLE300818110717487",  //код стола
     "PlaceCode": "TABLE300818110717487",  //код стола
     "EventName":"День Рождения",  //
     "EventName":"День Рождения",  //
     "FirstDate": "2021-11-29 10:00:0",
     "FirstDate": "2021-11-29 10:00:0",
     "LastDate": "2021-11-29 22:00:00",
     "LastDate": "2021-11-29 22:00:00",
     "CardCode": "380675016786"
     "CardCode": "380121231231"
}
}
</syntaxhighlight>
</syntaxhighlight>
Рядок 77: Рядок 77:
| BillType   
| BillType   
| Int  
| Int  
| тип рахунку(1-звичайний рахунок, 4-рахунок бронювання (для готельної системи за замовчанням), 8-рахунок доставки)
| Тип рахунку(1-звичайний рахунок, 4-рахунок бронювання (для готельної системи за замовчанням), 8-рахунок доставки)
|-
|-
|
|
|    FirstDate
|    FirstDate
|    Datetime
|    Datetime
|    дата початку надання послуг, допустиме значення NULL
|    Дата початку надання послуг, допустиме значення NULL
|-
|-
|
|
|    LastDate
|    LastDate
|    Datetime
|    Datetime
|    дата закінчення надання послуг, допустиме значення NULL
|    Дата закінчення надання послуг, допустиме значення NULL
|-
|-
|
|
|    UserName
|    UserName
|    String[64]
|    String [64]
|    користувач що створив рахунок, допустиме значення NULL
|    Kористувач що створив рахунок, допустиме значення NULL
|-
|-
|
|
|    PlaceCode
|    PlaceCode
|    String[32]
|    String [32]
|    код місця надання послуги (для рахунків бронювання обов”язковий параметр, допустиме значення NULL для інших)
|    Kод місця надання послуги (для рахунків бронювання обов”язковий параметр, допустиме значення NULL для інших)
|-
|-
|
|
|    EventID
|    EventID
|    String[32]
|    String [32]
|    ID заходу(для рахунків бронювання, допустиме значення NULL для інших)
|    ID заходу(для рахунків бронювання, допустиме значення NULL для інших)
|-
|-
|
|
|    EventName
|    EventName
|    String[32]
|    String [32]
|    назва заходу (для рахунків бронювання, допустимо значення NULL для інших)
|    Hазва заходу (для рахунків бронювання, допустимо значення NULL для інших)
|-
|-
|
|
|    CompanyCode
|    CompanyCode
|    String[32]
|    String [32]
|    код компанії, допустиме значення NULL
|    Kод компанії, допустиме значення NULL
|-
|-
|
|
|    CompanyName
|    CompanyName
|    String[32]
|    String [32]
|    компанія, допустиме значення NULL
|    Kомпанія, допустиме значення NULL
|-
|-
|
|
|    Description
|    Description
|    String[500]
|    String [500]
|    опис рахунку, допустиме значення NULL
|    Oпис рахунку, допустиме значення NULL
|-
|-
|
|
|    CardCode
|    CardCode
|    String
|    String
|    код карти
|    Kод карти
|-
|-
|
|
|    Delivery
|    Delivery
|    Delivery[]
|    Delivery []
|    об”єкт доставки з такими полями (для рахунків доставки), допустиме значення NULL для інших:
|    Oб'єкт доставки з такими полями (для рахунків доставки), допустиме значення NULL для інших:
|-
|-
|
|
Рядок 142: Рядок 142:
|    WaitedFor
|    WaitedFor
|    Datetime
|    Datetime
|    дата і час доставки(з)
|    Дата і час доставки(з)
|-
|-
|
|
|    WaitedFrom
|    WaitedFrom
|    Datetime
|    Datetime
|    дата і час доставки(по)
|    Дата і час доставки(по)
|-
|-
|
|
|    Comment
|    Comment
|    String
|    String
|    коментар
|    Коментар
|-
|-
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру

Версія за 14:00, 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": "380121231231"
}



Типи даних 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] Kористувач що створив рахунок, допустиме значення NULL
PlaceCode String [32] Kод місця надання послуги (для рахунків бронювання обов”язковий параметр, допустиме значення NULL для інших)
EventID String [32] ID заходу(для рахунків бронювання, допустиме значення NULL для інших)
EventName String [32] Hазва заходу (для рахунків бронювання, допустимо значення NULL для інших)
CompanyCode String [32] Kод компанії, допустиме значення NULL
CompanyName String [32] Kомпанія, допустиме значення NULL
Description String [500] Oпис рахунку, допустиме значення NULL
CardCode String Kод карти
Delivery Delivery [] Oб'єкт доставки з такими полями (для рахунків доставки), допустиме значення 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 Номер рахунку
* Позначення обов’язкового параметру
Додатковий опис вхідних параметрів