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

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
Немає опису редагування
Немає опису редагування
 
(Не показано 3 проміжні версії 2 користувачів)
Рядок 56: Рядок 56:
! scope="col"| Опис
! scope="col"| Опис
|-
|-
|
|<span style="color:#ff0000"><center>*</center></span>
| PlaceCode
| PlaceCode
| string
| String
| Kод місця
| Kод місця
|-
|-
|
|<span style="color:#ff0000"><center>*</center></span>
| PlaceSchemaID   
| PlaceSchemaID   
| Int  
| Int  
|  ID схеми
|  ID схеми (допустиме значення NULL)
|-
|-
|
|<span style="color:#ff0000"><center>*</center></span>
| PlaceID
| PlaceID
| Int
| Int
| ID місця
| ID місця (допустиме значення NULL)
|-
|-
|
|<span style="color:#ff0000"><center>*</center></span>
| Bracelet   
| Bracelet   
| String   
| String   
| Kод браслета
| Kод браслета (допустиме значення NULL)
|-
|-
|
|<span style="color:#ff0000"><center>*</center></span>
|    ClosedBills
|    ClosedBills
|    Int
|    Int
|    0-відкриті рахунки 1-тільки закриті рахунки
|    0 - відкриті рахунки<br> 1 - тільки закриті рахунки
|-
|-
|
|
|    DeliveryBills
|    DeliveryBills
|    Int
|    Int
|    1-тільки звичайні рахунки(без рахунків доставки), 2-звичайні й рахунки доставки, 3-тільки рахунки доставки
|    1 - тільки звичайні рахунки(без рахунків доставки),<br> 2 - звичайні й рахунки доставки,<br> 3 - тільки рахунки доставки
|-
|-
| <!-- <center>*</center> -->                                              <!-- ЗАКОМЕНТОВАНИЙ ПРИЗНАК ОБОВЯЗКОВОГО ПОЛЯ -->
| <!-- <center>*</center> -->                                              <!-- ЗАКОМЕНТОВАНИЙ ПРИЗНАК ОБОВЯЗКОВОГО ПОЛЯ -->
| ReservedBills  
| ReservedBills  
| Int  
| Int  
| 1-тільки звичайні рахунки(без рахунків бронювання), 2-звичайні й рахунки бронювання, 3-тільки рахунки бронювання
| 1 - тільки звичайні рахунки(без рахунків бронювання),<br> 2 - звичайні й рахунки бронювання,<br> 3 - тільки рахунки бронювання
|-
|-
|
|
| CodeGUID
| CodeGUID
| String
| String
| GUID-код рахунку
| GUID - код рахунку
|-
|-
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру
Рядок 168: Рядок 168:
|-
|-
|  
|  
| Bills
|<span style="color:#ff0000"> Bills</span>
| Bills[]
|<span style="color:#ff0000"> Bills []</span>
| Масив рахунків з такими параметрами:
| Масив рахунків з такими параметрами:
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | ID
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ID
| Int
| Int
| ID рахунку
| ID рахунку
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | Number
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Number
| Int
| Int
| Hомер рахунку
| Hомер рахунку
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Opened
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Opened
| Datetime
| Datetime
| Час створення
| Час створення
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Closed
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Closed
| Datetime
| Datetime
| Час закриття
| Час закриття
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Printed
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Printed
| Datetime
| Datetime
| Час друку рахунку
| Час друку рахунку
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | DiscountUsed
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DiscountUsed
| Int
| Int
| Чи застосована знижка до рахунку (0 — ні, 1 — так)
| Чи застосована знижка до рахунку<br>0 - ні,<br> 1 - так
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Total
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Total
| Datetime
| Datetime
| Сума по рахунку
| Сума по рахунку
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | OpenUser
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OpenUser
| String
| String
| Ім`я користувача що створив рахунок
| Ім`я користувача що створив рахунок
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | PlaceCode
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PlaceCode
| String
| String
| Код місця
| Код місця
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Viewed
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Viewed
| Int
| Int
| 0 – рахунок не продивилися, 1 – рахунок продивилися
| 0 - рахунок не продивилися,<br>1 - рахунок продивилися
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Completed
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Completed
| Int
| Int
| Чи всі позиції рахунку приготовані (тільки для закритих рахунків)
| Чи всі позиції рахунку приготовані (тільки для закритих рахунків)
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Shipped
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Shipped
| Int
| Int
| Чи всі позиції рахунку відвантажені (тільки для закритих рахунків)
| Чи всі позиції рахунку відвантажені (тільки для закритих рахунків)
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Description
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Description
| String
| String
| Примітка (тільки для закритих рахунків)
| Примітка (тільки для закритих рахунків)
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | ShortComment
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShortComment
| String
| String
| Скорочений коментар (тільки для закритих рахунків)
| Скорочений коментар (тільки для закритих рахунків)
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | smsdate
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> smsdate
| Datetime
| Datetime
| Дата та час відправлення сповіщення по рахунку
| Дата та час відправлення сповіщення по рахунку
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | ChangeDate
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ChangeDate
| Datetime
| Datetime
| Дата зміни
| Дата зміни
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | ChangeDateUTC
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ChangeDateUTC
| String
| String
| Дата зміни в UTC-форматі
| Дата зміни в UTC - форматі
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | PaymentName
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PaymentName
| String
| String
| Назва типу оплати яким був оплачений рахунок
| Назва типу оплати яким був оплачений рахунок
|-
|-
|  
|  
|&nbsp;|&nbsp;&nbsp;&nbsp; | CodeGUID
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> CodeGUID
| String
| String
| GUID-код рахунку
| GUID - код рахунку
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | AdvancePay
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> AdvancePay
| Decimal
| Decimal
| Cума передоплати
| Cума передоплати
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | LockUserId
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> LockUserId
| Int
| Int
| ID корстувача що заблокував рахунок
| ID корстувача що заблокував рахунок
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | PersonName
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PersonName
| String
| String
| Iм'я клієнта
| Iм'я клієнта
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | PersonPhotoID
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PersonPhotoID
| Int
| Int
| ID фото клієнта
| ID фото клієнта
|-
|-
|
|
|&nbsp;|&nbsp;&nbsp;&nbsp; | Comment
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Comment
| String
| String
| Kоментар до рахунку
| Kоментар до рахунку

Поточна версія на 09:10, 20 липня 2022

Отримання всіх відкритих або всіх закритих рахунків поточної зміни

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


Опис Отримання масиву рахунків.
Метод POST
URL /POSExternal/GetBills



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json) 
 {
    "Bracelet": null,
    "ClosedBills": 1,
    "PlaceID": null,
    "PlaceCode": null,
    "PlaceSchemaID": 0
 }



Типи даних Body
* Параметр Тип Опис
*
 		PlaceCode String Kод місця
*
 		PlaceSchemaID Int ID схеми (допустиме значення NULL)
*
 		PlaceID Int ID місця (допустиме значення NULL)
*
 		Bracelet String Kод браслета (допустиме значення NULL)
*
 		ClosedBills Int 0 - відкриті рахунки
1 - тільки закриті рахунки
DeliveryBills Int 1 - тільки звичайні рахунки(без рахунків доставки),
2 - звичайні й рахунки доставки,
3 - тільки рахунки доставки
ReservedBills Int 1 - тільки звичайні рахунки(без рахунків бронювання),
2 - звичайні й рахунки бронювання,
3 - тільки рахунки бронювання
CodeGUID String GUID - код рахунку
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json) 
{
 "Error": "",
    "Bills": [
        {
            "ID": 19738,
            "Number": 15978,
            "Opened": "2022-07-15 11:49:15",
            "Total": 535.50,
            "OpenUser": "Expert Solution",
            "PlaceCode": "TABLE300818110717487",
            "Viewed": 1,
            "Completed": 0,
            "Shipped": 0,
            "Description": null,
            "ShortComment": null,
            "ChangeDate": "2022-07-18 12:24:03",
            "smsdate": null,
            "ChangeDateUTC": "2022-07-18T09:24:03.71Z",
            "CodeGUID": "6049AF6A-54D9-48E2-AA7C-B0A4D15E1081",
            "AdvancePay": 0,
            "Printed": "2022-07-18 12:23:44",
            "LockUserID": null,
            "Closed": "2022-07-18 12:24:03",
            "DiscountUsed": 0,
            "PersonName": null,
            "PaymentName": null,
            "PersonPhotoID": null,
            "Comment": null
        },
}



Типи даних Response
* Параметр Тип Опис
Error String [] Опис помилки, що виникла
Success Bool Успіх виконання запиту
Bills Bills [] Масив рахунків з такими параметрами:
     | ID Int ID рахунку
     | Number Int Hомер рахунку
     | Opened Datetime Час створення
     | Closed Datetime Час закриття
     | Printed Datetime Час друку рахунку
     | DiscountUsed Int Чи застосована знижка до рахунку
0 - ні,
1 - так
     | Total Datetime Сума по рахунку
     | OpenUser String Ім`я користувача що створив рахунок
     | PlaceCode String Код місця
     | Viewed Int 0 - рахунок не продивилися,
1 - рахунок продивилися
     | Completed Int Чи всі позиції рахунку приготовані (тільки для закритих рахунків)
     | Shipped Int Чи всі позиції рахунку відвантажені (тільки для закритих рахунків)
     | Description String Примітка (тільки для закритих рахунків)
     | ShortComment String Скорочений коментар (тільки для закритих рахунків)
     | smsdate Datetime Дата та час відправлення сповіщення по рахунку
     | ChangeDate Datetime Дата зміни
     | ChangeDateUTC String Дата зміни в UTC - форматі
     | PaymentName String Назва типу оплати яким був оплачений рахунок
     | CodeGUID String GUID - код рахунку
     | AdvancePay Decimal Cума передоплати
     | LockUserId Int ID корстувача що заблокував рахунок
     | PersonName String Iм'я клієнта
     | PersonPhotoID Int ID фото клієнта
     | Comment String Kоментар до рахунку
* Позначення обов’язкового параметру
Додатковий опис вхідних параметрів
Отримано з http://wiki.servio.support/index.php?title=GetBills&oldid=1779