GetOpenBills

Матеріал з expertsolution
Перейти до навігації Перейти до пошуку

Функція повертає список відкритих рахунків

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


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



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
    "Skip": 0,
    "Take": 20,
 // "OnlyCurrentTerm": true,
    "Filters": {
      //  "PlaceID": 105,
      //  "IsAdvancePay": false,
      //  "IsDelivery": true,
      //  "CardCode": "8833-2211",
      //  "CardOwnerName": "John Doe",
      //  "PlaceName": "Main Hall",
      //  "DeliveryAddress": "123 Example Street",
      //  "UserID": 42,
      //  "BraceletCode": "BR-999",
      //  "SearchQuery": "Table 5",
      //  "MinSum": 10.50,
      //  "MaxSum": 500.00,
      //  "BillWithNoClosedChecks": false,
      //  "IsDateTimeVisible": true,
          "BillStatus": 1,
      //  "BillType": 0,
      //  "PaymentTypeID": 3
    },
    "Sorting": {
        "ByStatus": 2
    }
}



Типи даних Body
* Параметр Тип Опис
* Skip Int Скільки записів пропустити
* Take Int Скільки записів отримати
Filters Filters [ ] Масив списку фільтрів. Елементи масиву з наступними полями:
     | PlaceID Int ID місця надання послуг з методу GetPlaces
     | IsAdvancePay Bool Передоплата
True - Є передоплата;
Folse - Передоплата відсутня;
     | IsDelivery Bool Рахунок доставки
True -Так;
Folse - Ні;
     | CardCode String Код картки користувача з методу GetDiscountCardInfo
     | CardOwnerName String Ім'я власника карти з методу GetDiscountCardInfo
     | PlaceName String Назва місця надання послуг з методу GetPlaces
     | DeliveryAddress String Адреса доставки (для рахунків доставки)
     | UserID Int ID користувача що відкрив рахунок
     | BraceletCode String Код браслета
     | SearchQuery String Вільний текст пошуку
     | MinSum String Мінімальна сума рахунку.
     | MaxSum String Максимальна сума рахунку.
     | BillWithNoClosedChecks Bool Рахунки з незакритими чеками.
True -Так;
Folse - Ні;
     | IsDateTimeVisible Bool Використовувати дату і час для пошуку рахунку.
True -Так;
Folse - Ні;
*      | BillStatus Int Статус рахунку.
0 - без пошуку.
2 - роздрукований.
3 - Заблокований.
     | BillType Int Тип рахунку
     | PaymentTypeID Int ID типу оплати з методу GetPayments
* Sorting Sorting {} Обьєкт. Елементи з наступними полями:
     | ByStatus Int Сортування.
0 - Disabled.
1 - Asc.
2 - Desc
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": null,
    "Bills": [
        {
            "BillItems": [
                {
                    "BillItemId": 0,
                    "Code2": null,
                    "Completed": "",
                    "EnterpriseID": 0,
                    "ID": 45342,
                    "IsXCHRG": false,
                    "ItemAmount": 1.000,
                    "ItemName": "Плавання",
                    "ItemPriceTotal": 500.00,
                    "ItemType": "        ",
                    "PreparationTimeSec": 0,
                    "Shipped": ""
                }
            ],
            "ID": 15258,
            "Number": 27007,
            "Opened": "2025-09-10 11:54:44",
            "Total": 500.00,
            "CloseUser": null,
            "OpenUser": "ES",
            "PlaceCode": null,
            "PlaceName": null,
            "Viewed": 0,
            "Completed": 0,
            "Shipped": 0,
            "Description": "",
            "ShortComment": null,
            "ChangeDate": "",
            "smsdate": "",
            "ChangeDateUTC": null,
            "CodeGUID": null,
            "AdvancePay": 0,
            "Printed": "2025-09-10 11:55:40",
            "LockUserID": null,
            "Closed": "",
            "DiscountUsed": 0,
            "LockTermID": -1,
            "PersonName": null,
            "PaymentName": "Переказ",
            "PersonPhotoID": 0,
            "Bracelets": null,
            "Comment": "",
            "CloseUserID": null,
            "OpenUserID": 1000,
            "GuestCount": 1,
            "ChildCount": 0,
            "OwnerName": null,
            "DiscountGroupName": null,
            "DeliveryAddress": "",
            "SubTotal": 500.00,
            "Ext": "BILLRST ",
            "IsArchived": false,
            "PaymentID": 0,
            "SessionID": null,
            "NameExt": null,
            "OpenTermID": 1959,
            "PhoneExt": null,
            "DescriptionExt": null,
            "TempID": null,
            "HasNotClosedChecks": false,
            "BillType": null,
            "StartedReservation": null,
            "FinishedReservation": null,
            "Caption": null,
            "DayTicket": null,
            "CardCode": "",
            "HasCompletedBillItem": false,
            "HallName": null,
            "ParentID": null,
            "IsPickup": false,
            "IsDeliveryBill": false,
            "BillExternalId": null,
            "CentralBillId": null,
            "NumType": null,
            "DeliveryStatus": null
        },
    ],
    "Users": [
        {
            "ID": 1000,
            "Name": "ES"
        },
        {
            "ID": 1001,
            "Name": "ADMIN"
        },
        {
            "ID": 9631,
            "Name": "Ольга"
        },
        {
            "ID": 11188,
            "Name": "DEMO"
        },
        {
            "ID": 11400,
            "Name": "Пиндик Іван"
        }
    ],
    "BillCount": 165
}



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
Success Bool Успіх виконання запиту
BillItems BillItems [ ] Масив списку позицій рахунку. Елементи масиву з наступними полями:
     | BillItemId Int ID Виконавця
     | Code2 String Імя виконавця
     | Completed Int ID групи до якої належить виконавець
     | EnterpriseID String Фамілія виконавця
     | ID String По батькові виконавця
     | IsXCHRG Int ID персони виконавця
     | ItemPriceTotal String Посада виконавця
     | ItemType Int ID Посади виконавця
     | PreparationTimeSec Int ID фотограї, отримати фото можна методом GetImage
     | Shipped Int ID фотограї, отримати фото можна методом GetImage
ID Int ID рахунку.
Number Int Номер рахункe
Opened String Дата та час відкриття рахунку
CloseUser String Імя юзера що закрив рахунок
OpenUser String Імя юзера що відкрив рахунок
PlaceCode String Код місця надання послуг на якому відкритий рахунок.
PlaceName String Назва місця надання послуг на якому відкритий рахунок.
Viewed int Рахунок переглянуто.
Completed Bool Рахунок приготовано.
True - так.
Folse - ні
Shipped int Доставлено.
Description String Опис до рахунку
ChangeDate String Дата зміни рахунку
CodeGUID String GUID Код рахунку
AdvancePay Double
Printed String Дата та час друку рахунку
LockUserID Int ID користувача що заблокував рахунок
Closed String Дата та час закриття рахунку
DiscountUsed Int
LockTermID Int ID станції на якій був заблокований рахунок
PersonName String
PaymentName String Імя типу оплати
PersonPhotoID Int ID фото персони
Bracelets String [] код браслету
Comment String Коментар до рахунку
CloseUserID Int ID користувача що закрив рахунок
OpenUserID Int ID користувача що відкрив рахунок
GuestCount Int кількість гостей в рахунку
ChildCount Int кількість дітей в рахунку
OwnerName String Імя власника рахунку
DiscountGroupName String Назва дисконтної групи
DeliveryAddress String адреса доставки
SubTotal Decimal Сума по рахунку
Ext Int ID
PaymentID Int ID типу оплати
SessionID Int ID сесії в якій закрито рахунок
OpenTermID Int ID терміналу на якому було відкрито рахунок
BillType Int тип рахунку
CardCode String Код карти
ParentID Int ID батьківського елементу
IsPickup Bool Рахунок самовивозу
Додатковий опис вхідних параметрів