expertsolution - Внесок користувача [uk]

API Протокол взаємодії Servio External Service з зовнішніми системами

2026-03-10T12:19:16Z

Bashenko.i: /* GetBillsGroupedSales */

=Опис Змін=
{| class="wikitable"
|+ Опис змін
|-
! ДАТА ВНЕСЕННЯ !! Мінімальна версія HMS !! НОМЕР НОВОЇ РЕДАКЦІЇ !! ЗМІНИ
|-
| 07.06.2021 || 05.12.171 || 1.03 || Форматування документа. Додано наступні функції в протокол: UpdateGuest, AddClient, UpdateClient. В відповідь команди GetClientsModified додано параметр GuestsID.
|-
| 11.06.2021 || 05.12.173 || 1.04 || Для методів GetGuestsModified, GetGroupsModified, GetClientsModified розширена інформація по прейскуранту. Додано новий метод: GetPriceListPrices.
|-
| 30.06.2021 || 05.12.176 || 1.05 || В методи GetGuestsModified, GetClientsModified, GetGroupsModified, GetActivitiesModified додано параметр для комплексного пошуку по полях.
|-
| 26.11.2021 || 06.00.023 || 1.06 || В відповіді методів GetGuestsModified, GetGroupsModified, GetActivitiesModified додано параметри.
|-
| 16.03.2022 || 06.00.038 || 1.07 || Додано метод SearchClients. Змінено методи GetClientsModified, AddClient.
|-
| 22.03.2022 || 06.00.039 || 1.08 || Додано поле Comment для структури Client.
|-
| 13.05.2022 || 06.00.045 || 1.09 || Додано методи GetBills, GetDepositAccounts, GetFiscalSession, AcceptSet, PayToHMS.
|-
| 03.10.2022 || 06.00.066 || 1.10 || Додано метод GetPaymentsDelivery.
|-
| 16.12.2022 || 06.00.076 || 1.11 || Додано метод GetRevenueInfo.
|-
| 14.03.2023 || 06.00.086 || 1.12 || Додано поля DateTimeCancelation, DateTimeDeparture, DateTimeReservation, DateTimeSettle, PersCancelation, PersDeparture, CancelReasonID, CancelReasonName, CancelReasonString для структури Guest.
|-
| 29.08.2023 || 06.00.109 || 1.13 || Для запиту методу GetRoomsModefied додано параметр isOnlyActual.
|-
| 17.10.2023 || 06.00.116 || 1.14 || Для запитів GetBills, GetDeposiAccounts, GetFiscalSessions додано параметр OpenTaxPeriodOnly.
|-
| 15.11.2023 || 06.00.120 || 1.15 || Додано метод GetBillsGroupedSales.
|-
| 23.11.2023 || 06.01.001 || 1.16 || Для GetRevenueInfo додано вхідні параметри ExtractClasses, ExtractSubClasses, а для блоку Revenue параметр Details.
|-
| 10.04.2024 || 06.01.027 || 1.17 || Для методу GetBillsGroupedSales розширено структуру Bill на поле RoomsCount.
|-
| 25.04.2024 || 06.01.032 || 1.18 || Змінено методи GetCustomerPayments, GetFiscalSessions.
|-
| 03.05.2024 || 06.01.034 || 1.19 || Для методу GetBillsGroupedSales змінена логіка групування Sales, RoomsCount з 1.17 перенесено в Sales.
|-
| 16.05.2024 || 06.01.036 || 1.20 || Для методів GetBillsGroupedSales, GetBills, GetFiscalSessions в сутність масивів "Companies": [ ] та "Consumers": [ ] додано поля "PayTypeID", "PayTypeName". В сутність масиву "Consumers": [ ] додано поля "HousingID", "HousingName".
|-
| 26.03.2025 || 06.01.094 || 1.21 || В відповідь методу GetFiscalSessions додано нове поле TotalReceipts, в якому згруповані оплати по типу чеку та оплати.
|-
| 20.06.2025 || 06.01.112 || 1.22 || В відповідь методу GetCustomerPayments додано два масиви PaymentReciepts та PaymentReturns.
|-
| 20.06.2025 || 06.01.123 || 1.23 || Додано два нових параметри AcceptanceDateFrom та AcceptanceDateTo до методу GetBills для фільтрації по датах акту.
|-
| 31.07.2025 || 06.01.128 || 1.24 || Додано RequestDate (дату й час запиту документів) у відповідь методів GetBills, GetFiscalSession, GetBillsGroupedSales, GetDepositAccounts та як вхідний параметр методу AcceptSet.
|}

=Опис взаємодії=
Формат переданих і прийнятих даних – протокол обміну JSON. Кодування запиту та відповіді UTF8. 
Запити повинні містити інформацію про авторизацію, відповіді повинні містити інформацію про версію протоколу, знімок часу в момент відповіді сервера, інформацію про помилку. Приклад запиту та відповіді наведено нижче. 

Права доступу розрізняються залежно від пари користувач/пароль, які вводяться в кожному JSON-запиті в розділі «Облікові дані»: 
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
}</pre>

=Опис функцій спілкування=

==GetRoomsModified==
Отримання інформації про зміни на обраний період по номерам.
Параметри: дані авторизації, готель (декілька?), час оновлення даних.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "Password"
},
// 0 – всі доступні готелі
"Hotels": [8],
// дата з часом, показувати номери, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom": "2025-06-19 00:00:00",
// id кімнат
"RoomsID": [],
// 0/1 - 0=не передає дані бронювань, 1=заповнює масив Clients інформацією про бронювання.
"isNeedClientInfo": 0,
// при isNeedClientInfo: 1 та isNeedDocumentsInfo: 1 заповнює массив Documents наявними документами.
"isNeedDocumentsInfo": 1,
//true - дата експлатації або її немає або більше поточної дати.
"v_isOnlyActual": false
}
</pre>

==GetGuestsModified==
Отримання інформації про гостей готелю. 
Параметри: дані авторизації, готель (декілька?), час оновлення даних (обрізано те, що було раніше, якщо не вказано, то тільки для всіх гостей, що проживають, 
або наступне бронювання, або останнє перебування в номері), масив з переборами відображених даних (проживання гостей (за замовчуванням, якщо не вказано), бронювання, виїзду, контактна інформація для гостей) 
'''Вхідні параметри:'''

<pre>
{
"Credentials" : {
"UserName" : "UserName",
"Password" : "User Password"
},
// 0 – всі доступні готелі
"Hotels" : [1, 2,...],
// дата з часом, показувати номери, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom" : "2019-11-12 12:33:45",
"ModifiedDateTo" : "2020-11-12 12:33:45",
// необов’язковий фільтр за ідентифікаторами гостей
"GuestsID" : ["1", .....] ,
// відповідно заброньовані, що проживають, останній виїхавший по номеру, анульований, незаїзд.
"GuestStatus" : [0,2,3,-1,-2],
// отримувати вартість гостя, за замовчуванням ні
"isNeedCostInfo" : "0",
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses":[""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses":[""],
// виводити дані по анкетах у гостей, за замовчуванням ні
"isNeedClientInfo" : "0",
// вивантажувати фото клієнта
"isNeedClientPhoto" : "0",

// виводити дані по документах в анкетах, за замовчуванням ні
"isNeedDocumentsInfo" : "0",
// ПІБ гостя
"GuestName" : "Петров Петро Петрович",
// Номер телефону
"PhoneNumber" : "0991232233",
// Пошта
"Mail" : "user@gmail.com",
// Ідентифікатор анкети гостя
"ClientID" : 654,
// Вподобання
"Preferences": [
{
"Code": "carnumber",
"Value": "333-44-55"
}
],
// Комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard"]
}
}
</pre>

'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "0.1",
// час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
"RequestTime" : "345356546",
// код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,
"Hotels" : [
"HotelInformation" : {
"HotelID" : 1,
"HotelName" : "Назва",
"HotelShortName" : "КороткаНазва"
},

"Guests" : [ {
"Room" : {
"RoomId" : 1,
"RoomNumber" : "1001",
"Floor" : "10",
"RoomType" : {
"RoomTypeName" : "",
"RoomTypeShortName" : "",
"RoomTypeId" : "",
"Beds" : "1",
"AddBeds" : "0"
}
},
"Guest" : #GuestInformation#
}
] // Гості
] // Готелі
}

</pre>

==GetClientsModified==
Отримання даних з анкет
*При HotelID = 0 повертаються всі анкети незалежно від наявності пов’язаного гостя.
*При HotelID ≠ 0 повертаються тільки ті анкети, для яких існує бронювання в зазначеному готелі.
*Якщо передано декілька значень HotelID (наприклад, [0,1]), то анкети з гостем у готелі 1 будуть дублюватися під обома HotelID: під 1 (за прямим фільтром) та під 0 (оскільки 0 означає «усі»).
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "{{login}}",
"Password": "{{password}}"
},
// 0 – всі доступні готелі
"Hotels": [
1
],
// Дата з часом у UTC, показувати анкети, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom": "2025-06-20 00:00:00",
"ModifiedDateTo": "2025-07-29 00:00:00",
// необов’язковий фільтр за ідентифікаторами клієнтів
"ClientsID": [],
// фільтри для анкет
"Phones": [
""
],
"Emails": [
""
],
"FirstName": "",
"LastName": "",
"MiddleName": "",
// серія та номер документа без роздільників
"DocumentSeriesAndNumber": "",
// ІПН документа
"DocumentIIN": "",
"Sex": true // true - чоловічий, false - жіночий
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1753779736833",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Clients": [
{
"Address": "",
"BirthDay": "2000-01-31",
"BlackList": false,
"ClientID": 13941,
"Comment": "",
"Documents": [],
"Email": "",
"FirstName": "test",
"GuestsID": [
29030,
29040
],
"LastName": "Testing",
"MiddleName": "",
"Phone": "+3809732446545",
"Photo": null,
"PhotoURL": "~/img/photo_place.gif",
"Preferences": [],
"Sex": true,
"VIP": true
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Family Hotel",
"HotelShortName": "FH"
}
}
]
}</pre>

==UpdateRooms==
Оновлення статуса кімнат
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Name",
"HotelShortName": "ShortName"
},
"Rooms": [
{
"Room": {
"RoomId": 1,
// код прибирання
"CleanStatus": "clean",
// код статусу продажу (sale, repair, repair not sale)
"SaleStatus": "repair"
}
}
]
}
]
}
</pre>

'''Значення, що повертається:'''
<pre>
{
"VersionInfo": "0.1",
// час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
"RequestTime": "123423234",
// код помилки, 0 – помилок немає
"ErrorCode": "0",
"ErrorText": ""
}
</pre>

==GetCustomerPayments==
Отримання інформації про нарахування клієнта. 
Необхідно вказати або масив "Клієнти", або періоди надання/зміни послуги. 
Якщо вказано і масив, і крапки, то інформація фільтрується тільки по масиву. 
Періоди дати повинні бути повними (вказуються як початок, так і кінець), але не довше 31 дня.

'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "Ім'я користувача",
"Password": "Пароль користувача"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// масив з типом і кодом кому надавалась послуга
"Customers": [ {
"CustomerId":1,
// тип контрагента (1 – гість, 2 – група, 3 – компанія, 4 – захід, 5 – цільовий рахунок)
"CustomerType":1
}],
// масив ідентифікаторів послуг (serviceid) для фільтра
"Services": [1,2, ...],
// масив буквених кодів класів послуг для фільтра
"ServiceClasses": [""],
// масив буквених кодів підкласів послуг для фільтра
"ServiceSubClasses": [""],
// включати чи анульовані нарахування (за замовчуванням ні)
"IncludeCanceled": "0",

// дати періоду надання послуг, якщо якась з дат не вказана, період відкритий
"ConsumptionDateStart": "2020-01-01 14:00:00",
"ConsumptionDateEnd": "2020-01-02 12:00:00",
// початкова дата, з якої нарахування були змінені
"ModifiedPaymentsFrom": "2020-01-01 14:00:00",
// кінцева дата, з якої нарахування були змінені
"ModifiedPaymentsTo": "2020-01-02 12:00:00",
// типи номенклатур послуг
"NomenclatureTypes": [0, 1]
}

</pre>

'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1753281347241",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "30114888",
"CompanyAccounts": [
{
"Account": "26003139727",
"BankName": "АТ \"Райффайзен Банк Аваль\"",
"Description": "",
"IBAN": null,
"IsDefault": false,
"MFO": "380805",
"ValuteISO": 1
},
{
"Account": "UA653808050000000026006639700",
"BankName": "АТ \"Райффайзен Банк Аваль\"",
"Description": "",
"IBAN": "UA653808050000000026006639700",
"IsDefault": true,
"MFO": "380805",
"ValuteISO": 1
}
],
"CompanyID": 2,
"FactualAddress": "04070, м.Київ, вул. Ярославська, 39Г",
"FullName": "ТОВ \"the Family Hotel\"",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "",
"LegalAddress": "04070, м.Київ, вул. Ярославська, 39Г",
"Name": "ТОВ Hotel",
"PayTypeID": 2,
"PayTypeName": "Безготівка",
"PhoneNumber": "+380(44)537-01-68",
"PostalAddress": "04070, м.Київ, вул. Ярославська, 39Г",
"TIN": "301143628888",
"VatCertificateNumber": "38253100",
"СorporateManager": null
}
],
"Customers": [
{
"ArrivalDate": "2025-07-24 15:00:00",
"BookingSource": "",
"CompanyOperatorID": null,
"Consumer": "F0000029043",
"CountryISO3": "",
"CountryName": "",
"CustomerId": 29043,
"CustomerName": "payments",
"CustomerType": 1,
"DepartureDate": "2025-07-27 12:00:00",
"HousingID": 1,
"HousingName": "Головний корпус",
"Payments": [
{
"Barcode": null,
"Code": "dwelling",
"CodeId": 2222,
"ConsumptionDate": "2025-07-25 23:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"IsReturned": false,
"LastReceiptBillID": 29755,
"LastReceiptDate": "2025-07-23 17:36:00",
"LastReceiptID": 24994,
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePayments": [
{
"CodeId": 100,
"ConsumptionDate": "2025-07-25 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-25 14:00:00",
"PeriodDateTo": "2025-07-26 12:00:00",
"Price": "20.00",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 1,
"ServiceName": "Проживання Accomondtion",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"UsedQuantity": "0.000"
},
{
"CodeId": 113,
"ConsumptionDate": "2025-07-25 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-25 18:00:00",
"PeriodDateTo": "2025-07-25 22:00:00",
"Price": "140.00",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 212,
"ServiceName": "Вечеря/Dinner",
"ServiceSubClassCode": "",
"ServiceSubClassName": "",
"UsedQuantity": "0.000"
},
{
"CodeId": 111,
"ConsumptionDate": "2025-07-26 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-26 07:00:00",
"PeriodDateTo": "2025-07-26 12:00:00",
"Price": "200.00",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 210,
"ServiceName": "Сніданок / Breakfast",
"ServiceSubClassCode": "breakfast",
"ServiceSubClassName": "Завтрак",
"UsedQuantity": "0.000"
},
{
"CodeId": 112,
"ConsumptionDate": "2025-07-25 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-25 14:00:00",
"PeriodDateTo": "2025-07-25 16:00:00",
"Price": "140.00",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 211,
"ServiceName": "Обід/Dinner",
"ServiceSubClassCode": "dinner",
"ServiceSubClassName": "Обед",
"UsedQuantity": "0.000"
}
],
"PayAmount": "499.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 132870,
"PaymentReciepts": [
{
"CreateUser": {
"LoginID": 2,
"UserName": "Admin"
},
"Date": "2025-07-23 17:36:00",
"DepositID": null,
"FiscalID": 7,
"FiscalSessionID": 7875,
"PaidType": "Cash",
"PayGroupType": 0,
"PayTypeID": 2088,
"PayTypeName": "Готівка",
"PaymentSum": 499.00,
"ReceiptID": 24994,
"ReceiptPayTypeCode": "ГОТ",
"ReceiptPayTypeName": "Готівка",
"ReceiptPaytypeID": 2088,
"RoundingDelta": null,
"SumWithoutTax": 415.83,
"Taxes": [
{
"TaxName": "ПДВ 20%",
"TaxSum": "83,17",
"TaxWage": "0,2000000000"
}
]
}
],
}

</pre>

==GetUsers==
Отримання списку активних користувачів готелю.

'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// масив ідентифікаторів користувачів для фільтру. Якщо не вказано, то всі активні користувачі готелю
"UsersID": [1, 2, ...]
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1585726829983",
"VersionInfo": "0.1",
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"Users": [
{
"Email": "petrovich@gmail.com",
"Phone": "56556756",
"UserID": 372,
"UserName": "Петров Петро Петрович"
}
]
}
]
}
</pre>

==GetCompanies==
Отримання списку відкритих компаній.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// масив ідентифікаторів компаній для фільтру. Якщо не вказано, то всі відкриті компанії
"CompaniesID": [1, 2, ...]
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1585727691299",
"VersionInfo": "0.1",
"Companies": [
{
"CompanyID": 2,
"CompanyName": "__Relax",
"Email": "sdasd@sdasd.ru",
"Phone": "123123"
}
]
}
</pre>

==GetActivitiesModified==
Отримання списку заходів.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// дата з часом, показувати заходи, зміни у яких сталися після вказаного часу
"ModifiedDateFrom": "2019-11-12 12:33:45",\
"ModifiedDateTo": "2020-11-12 12:33:45",
// необов’язковий фільтр за ідентифікаторами заходів
"ActivitiesID": [1, ...],
// статуси заходів (-2, -1, 0, 3)
"ActivityStatus": [0, ...],
// необов’язковий фільтр за ідентифікаторами груп
"GroupsID": [1, ...],
// отримувати вартість, за замовчуванням ні
"isNeedCostInfo": 0,
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses": [""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses": [""],
// комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["Name", "Phone", "Email", "AccountNumber"]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1595322549800",
"VersionInfo": "0.1",
"Hotels": [
{
"Activities": [
{
"ActivityID": 405,
"ActivityName": "Мангал",
"ActivityTypeID": 1,
"ActivityTypeName": "Мангал 1",
"Adults": 1,
"Childs": 0,
"Comment": "",
"Company": null,
"ContactName": "",
"Cost": "388.66",
"Country": null,
"DecisionDate": "",
"Email": "",
"EndDate": "2012-06-08 02:00:00",
"GroupID": null,
"InfoSourceID": 1,
"InfoSourceName": "Реклама",
"Manager": {
"Email": "",
"Phone": "4242",
"UserID": 1,
"UserName": "Адмін"
},
"OperatorCompany": {
"CompanyID": 314,
"CompanyName": "",
"CompanyPrintCode": "",
"CompanyPrintName": "",
"CompanyPrintSertificate": "",
"Email": "",
"ITN": "",
"Phone": "",
"SegmentID": null,
"SegmentName": "",
"IndustryID": null,
"IndustryName": ""
},
"Payments": [
{
"ConsumptionDate": "2012-06-08 02:00:00",
"IsCanceled": false,
"IsPackagePayment": false,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 556721,
"PaymentStatus": 0,
"PaymentType": 4,
"Price": "388.66",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживання",
"ServiceId": 89579,
"ServiceName": "Проживання",
"Tax2Name": "Акцизний збір",
"Tax2Rate": "0.18",
"Tax2Sum": "59.29",
"TaxName": "ПДВ 18%",
"TaxRate": "0.20",
"TaxSum": "54.90",
"UsedQuantity": ""
}
],
"Phone": "",
"PaidTypeID": 1,
"PaidTypeName": "Готівка",
"PayStatus": 1,
"CreationLoginID": 2,
"PrepareTypeID": null,
"PrepareTypeName": null,
"PriceList": {
"PriceListID": 24,
"PriceListName": "Peggy",
"Description": "",
"IsChargeBonuses": false,
"IsForInternet": false,
"IsNonReturnRate": false,
"IsRackRate": false,
"IsSpecRate": false
},
"ReservationTypeID": 1,
"StartDate": "2012-06-05 08:00:00",
"StatusID": 0,
"StatusName": "Активне"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}
Прайс-лист та сутності країн виглядають наступним чином:

Country: {"CountryID":int, "CountryName":string, "CountryISO2":string, "CountryISO3":string}PriceList: {"PriceListID":int, "PriceListName":string}

</pre>

==GetGroupsModified==
Отримання списку груп.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// дата з часом, показувати групи, зміни у яких сталися після вказаного часу
"ModifiedDateFrom": "2019-11-12 12:33:45",
"ModifiedDateTo": "2020-11-12 12:33:45",
// статуси груп (-3, -2, -1, 0, 1)
"GroupStatus": [0, ...],
// необов’язковий фільтр за ідентифікаторами груп
"GroupsID": [1, ...],
// отримувати вартість, за замовчуванням ні
"isNeedCostInfo": 0,
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses": [""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses": [""],
// комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["Name", "Phone", "Email", "AccountNumber"]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1595328964995",
"VersionInfo": "0.1",
"Hotels": [
{
"Groups": [
{
"Activities": [
571,
572,
573
],
"Adults": 5,
"CanceledReason": null,
"Childs": 0,
"ChildsPay": 0,
"Comment": "",
"Company": null,
"ContactName": "",
"Cost": "650.00",
"Country": null,
"DecisionDate": "",
"Email": "",
"EndDate": "2012-06-30 12:00:00",
"GroupID": 717,
"GroupName": "sdvsdvsd",
"Guests": [
28571,
28572,
28573
],
"InfoSourceID": null,
"InfoSourceName": "",
"Manager": null,
"ManagerID": 403,
"PaidTypeID": 1,
"PaidTypeName": "Готівка",
"PersReservation": 2,
"OperatorCompany": {
"CompanyID": 285,
"CompanyName": "Google",
"CompanyPrintCode": "6756777777",
"CompanyPrintName": "Google",
"CompanyPrintSertificate": "",
"Email": "",
"ITN": "125154452115",
"Phone": "",
"SegmentID": null,
"SegmentName": "",
"IndustryID": null,
"IndustryName": ""
},
"PriceList": {
"Description": "",
"IsChargeBonuses": false,
"IsForInternet": false,
"IsNonReturnRate": false,
"IsRackRate": false,
"IsSpecRate": false,
"PriceListID": 24,
"PriceListName": "Peggy"
},
"Payments": [
{
"ConsumptionDate": "2012-06-30 12:00:00",
"IsCanceled": false,
"IsPackagePayment": true,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 303327,
"PaymentStatus": 0,
"PaymentType": 2,
"Price": "650.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживання",
"ServiceId": 1,
"ServiceName": "Проживання Pack",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживання",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxRate": "",
"TaxSum": "",
"UsedQuantity": ""
}
],
"Phone": null,
"PriceList": {
"PriceListID": 31,
"PriceListName": "Raquel8"
},
"ReservationTypeID": 2,
"StartDate": "2012-06-21 14:00:00",
"StatusID": 0,
"StatusName": "Активна"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}
</pre>

==UpdateGuest==
Оновлення інформації про гостя.
'''Вхідні параметри:'''
<pre>
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"GuestID":29177,
"Comment":"",
"UpdateFields":{
"ClientsToAdd":[49060],
"ClientsToDelete":[1,2]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,

}
</pre>

==AddClient==
Додавання нової анкети.
'''Вхідні параметри:'''
<pre>
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"LastName":"External", //обязательное поле
"Iso3Country":"UKR", //обязательное поле
"Sex":true,
"FirstName":"Service",
"MiddleName":"Test",
"BirthDay":"1991-02-02",
"AdultOrChild":false,
"Address":"Kiev, Yangelya 39a",
"ClubCardNumber":1,
"Email":"user@test.com",
"Phone":"0991112233",
"BlackList":true,
"VIP":true,
"Preferences":[{
"Code":"carnumber",
"Value":""
}],
"Documents": [
{
"DocumentDateEnd": "2050-02-02",
"DocumentDateIssue": "1991-02-02",
"DocumentNumber": "000000",
"DocumentSeries": "uu",
"DocumentType": "Passport",//обязательное поле
"IIN": "3333333333"
}
]
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,

}
</pre>
*перелік можливих значень поля DocumentType
<pre>
•Passport
•InternationalPassport
•ServicePassport
•DiplomaticPassport
•CertificationSoldier
•SeamanPassport
•MilitaryID
•DrivingLicence
•TemporaryIdentityCard
•ForeignCitizenPassport
•BirthCertificate
•IdentityCard
•InternationalPassportNew
•InternationalBirthCertificate
•ExternalInternationalPassport
•UssrPassport
•ExternalBirthCertificate
•ForeignBirthCertificate
•TemporaryAsylumCertificate
•CisCitizenIdentityCard
•ForeignCitizenServicePassport
•NationalForeignCitizenPassport
•TemporaryAsylumReview
</pre>

==UpdateClient==
Оновлення інформації по анкеті.
'''Вхідні параметри:'''
<pre>
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"ClientID":49060,
"UpdateFields":{
"LastName":"External",
"Iso3Country":"UKR",
"Sex":true,
"FirstName":"Service",
"MiddleName":"Test",
"BirthDay":"1991-02-02",
"AdultOrChild":false,
"Address":"Kiev, Yangelya 39a",
"ClubCardNumber":1,
"Email":"user@test.com",
"Phone":"0991112233",
"BlackList":true,
"VIP":true,
"Preferences":[{
"Code":"carnumber",
"Value":""
}]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,

}
</pre>

==GetPriceListPrices==
Отримання інформації про ціни послуг прайс-листів.

'''Вхідні параметри:'''
<pre>
int[] PriceListIDs – масив ідентифікаторів прейскурантів. Обов’язковий параметр.
string[] ServiceClassCodes – масив кодів класів послуг, за якими потрібні ціни. Обов’язковий параметр.
date ConsumptionDate – дата споживання. Обов’язковий параметр.
int CustomerType – тип споживача в готельній системі, для якого розраховуються ціни послуг. Обов’язковий параметр.
string[] ServiceSubClassExcludeCodes – масив кодів підкласів послуг, за якими не повертати ціни. Необов’язковий параметр.
int[] ServiceIDs – ідентифікатори послуг, для яких повертати ціни. Необов’язковий параметр.
string[3] Valute – код валюти, у якій повертати ціни. Якщо не вказано, ціни будуть розраховані у валюті послуги.
Conditionals – умови для підбору тарифу послуг, необов’язковий параметр. Структура зі наступними полями:
int TermActivity – тип заходу
int TermAdultCount – кількість дорослих
int TermChildPaidCount – кількість дітей з оплатою
int TermMealType – тип харчування
int TermPlacesAdditionalCount – кількість додаткових місць
int TermPlacesCount – кількість місць
int TermRoomType – категорія номера
bool TermWayOfSettlement – тип поселення: true – по місцях, false – номер цілком

{
"Credentials":{"UserName":"artemis","Password":"123"},
"PriceListIDs":[1,2296],
"ServiceClassCodes":["dwelling","conference","eat"],
"ConsumtionDate":"2021-06-11",
"CustomerType":1,
"ServiceSubClassExcludeCodes":["breakfast"],
"ServiceIDs":[1],
"Valute":"USD",
"Conditionals":{
"TermActivity":1,
"TermAdultCount":1,
"TermChildPaidCount":1,
"TermMealType":1,
"TermPlacesAdditionalCount":1,
"TermPlacesCount":1,
"TermRoomType":1,
"TermWayOfSettlement":false
}
}
</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час, коли почали формувати відповідь на сервері в UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
Hotels[] – масив результатів по готелях. Структура з такими параметрами:
HotelInformation – інформація по готелю. Структура з такими полями:
int HotelID – ідентифікатор готелю
string HotelName – назва готелю
string HotelShortName – коротка назва готелю
PriceLists[] – список прейскурантів. Структура з такими полями:
int PriceListID – ідентифікатор прейскуранта
string PriceListName – назва прейскуранта
Services[] – список послуг прейскуранта. Структура з такими полями:
int ServiceId – ID послуги
string ServiceName – назва послуги
string ServiceClassCode – код класу послуги
string ServiceSubClassCode – код підкласу послуги
decimal Price – ціна послуги
string Currency – валюта
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1623419232509",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"PriceLists": [
{
"PriceListID": 1,
"PriceListName": "Bennie933",
"Services": [
{
"Currency": "USD",
"Price": "5.79",
"ServiceClassCode": "dwelling",
"ServiceId": 1,
"ServiceName": "Проживання Pack",
"ServiceSubClassCode": "dwelling"
}
]
}
]
}
]
}
</pre>

==SearchClients==
Отримання списку анкет.

'''Вхідні параметри:'''
<pre>
date ModifiedDateFrom – дата останньої зміни анкети
int[] ClientsID – масив ідентифікаторів анкет
string[] Phones – масив телефонних номерів
string[] Emails – масив електронних поштових скриньок
string[] LoyaltyCards – масив кодів карт лояльності
string FirstName – ім’я
string LastName – прізвище
string MiddleName – по батькові
string DocumentSeriesAndNumber – серія і номер документа без роздільників
string DocumentIIN – ІПН документа
bool Sex – стать
int MaxRecordsCount – максимальна кількість записів у відповіді
date BirthDay – дата народження
Preferences[] – масив вподобань. Структура з такими полями:
string Code – код вподобання
string Value – значення вподобання
ComplexSearch – комплексний пошук. Структура з такими полями:
string SearchString – значення для пошуку
string[] SearchObjects – масив полів, по яких виконується пошук
{
"Credentials":{"UserName":"artemis","Password":"123"},
"ClientsID" : [1,2296],
"Phones" :["123-33-55","0991112233"],
"Emails":["test@gmail.com"],
"LoyaltyCards":["123-33-55","0991112233"],
"FirstName":"Ivan",
"LastName":"Ivanov",
"MiddleName":"Ivanovich",
"DocumentSeriesAndNumber":"FF123123",
"DocumentIIN":"123534645",
"Sex": true,
"MaxRecordsCount": 5
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
Clients[] – список анкет, масив структур Client

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1647424120627",
"VersionInfo": "1.0.0.3",
"Clients": [
{
"Address": "",
"BirthDay": "",
"BlackList": true,
"ClientID": 648,
"Comment": "Like cars",
"Documents": [
{
"DocumentDateEnd": "",
"DocumentDateIssue": "",
"DocumentNumber": "",
"DocumentSeries": "",
"DocumentType": "DrivingLicence",
"INN": "",
}
],
"Email": "",
"FirstName": "Asdffff",
"GuestsID": [],
"LastName": "Dsf",
"MiddleName": "Asdf",
"Phone": "",
"Photo": null,
"PhotoURL": "~/img/photo_place.gif",
"Preferences": [
{
"Code": null,
"Name": "Хар1",
"PreferenceID": 47,
"Value": "wer"
},
{
"Code": null,
"Name": "уке",
"PreferenceID": 49,
"Value": "789"
},
{
"Code": null,
"Name": "кен",
"PreferenceID": 50,
"Value": "890"
},
{
"Code": null,
"Name": "123",
"PreferenceID": 51,
"Value": "123"
}
],
"Sex": true,
"VIP": true
}
]

</pre>

==GetBills==
Отримання інформації про рахунки.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
bool ForceSetAccepted – примусова відмітка про обробку, за замовчуванням true.
bool NotAcceptedOnly – тільки необроблені рахунки, за замовчуванням true.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
int[] Bills – масив ідентифікаторів рахунків, необов’язковий параметр.
int[] BillTypes – масив типів рахунків, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
BillPayers – платники, структура з такими полями:
short PayerType – тип платника, необов’язковий параметр
int[] PayerID – ідентифікатори платників, необов’язковий параметр
DateTime DateBillFrom – початкова дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateBillTo – кінцева дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModifiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModifiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime AcceptanceDateFrom – початкова дата діапазону дат актів, необов'язковий параметр (якщо не вказано – без обмежень)
DateTime AcceptanceDateTo – кінцева дата діапазону дат актів, необов'язковий параметр (якщо не вказано – без обмежень)
byte[] NomenclatureTypes – масив типів номенклатур, необов’язковий параметр

{
"Credentials":{"UserName":"loginName","Password":"password"},
"Hotels":[1,2],
"ForceSetAccepted":true,
"NotAcceptedOnly":true,
"OpenTaxPeriodOnly":false,
"Bills":[2451,2137],
"BillTypes":["Payment","Comission"],
"ServiceProviderID":[1,2,3],
"ServiceProviderFullName":["name1","name2"],
"BillPayers":{"PayerType":1, "PayerID":[1,2]},
"DateBillFrom":"2000-01-01",
"DateBillTo":"2000-01-01",
"DateModefiedBillFrom":"2000-01-01 00:00:00",
"DateModefiedBillTo":"2000-01-01 00:00:00",
"AcceptanceDateFrom": "2000-01-01",
"AcceptanceDateTo": "2000-01-01",
"NomenclatureTypes": [0, 1],
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel
SumWithoutTax - сумарна сума послуг, які не оподатковуються
SumWithTax - сумарна сума послуг, які оподатковуються
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654847287800",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Bills": [
{
"Account": "F0000029177",
"BillComment": "",
"BillCustomerID": 29177,
"BillCustomerTypeID": 1,
"BillDate": "2022-05-13 20:36:26",
"BillID": 132740,
"BillPayerID": 29177,
"BillPayerTypeID": 1,
"BillType": "Оплата|Комісія",
"CompanyPayerID": null,
"CreateUser": {
"LoginID": 372,
"UserName": "Роман Веснин"
},
"Currency": "UAH",
"CurrencyCourse": 1.0000000000000,
"PaymentsSum": "180,0000",
"ReceiptReturns": [],
"Receipts": [
{
"CreateUser": {
"LoginID": 372,
"UserName": "Роман Веснин"
},
"Date": "2022-05-13 20:39:00",
"DepositID": 2143,
"FiscalID": 1,
"FiscalSessionID": 147,
"PaidType": "None|Cash|Credit|Noncash|Bonus|Deposit",
"PayGroupType": 4,
"PayTypeID": 49,
"PayTypeName": "Депозит ГРН",
"ReceiptID": 136084,
"ReceiptPayTypeCode": "ДГР",
"ReceiptPayTypeID": 49,
"ReceiptPayTypeName": "Депозит ГРН",
"RoundingDelta": null,
"Sales": [
{ "#SaleObject": {} }
],
"Sum": 180.00,
"SumBeforeRounding": 180.00,
"SumWithTax": 0,
"SumWithoutTax": 180.00,
"Taxes": [
{
"TaxName": "ПДВ 18%",
"TaxSum": "21,1900000000000",
"TaxWage": "0,2000000000"
},
{
"TaxName": "Акцизний збір",
"TaxSum": "22,8800",
"TaxWage": "0,1800000000"
}
]
}
],
"ReceiptsSum": "180,0000",
"Sales": [
{
"Canceled": false,
"CanceledDate": "",
"Comment": null,
"Consumer": "F0000029177",
"ConsumerID": 29177,
"ConsumerTypeID": 1,
"ConsumptionDate": "2022-05-13 20:36:26",
"FiscalID": 1,
"LastReceiptID": 136084,
"PaidType": "Deposit",
"PayGroupTypeID": 4,
"PaymentID": 627246,
"PeriodDateFrom": "",
"PeriodDateTo": "",
"Price": "180,00",
"Quantity": "1,000",
"ReceiptPayTypeCode": "ДГР",
"ReceiptPayTypeID": 49,
"ReceiptPayTypeName": "Депозит ГРН",
"RestaurantBill": "",
"RestaurantReceipt": null,
"SecondTaxName": null,
"SecondTaxSum": "",
"SecondTaxType": null,
"SecondTaxWage": "",
"ServiceClassCode": "",
"ServiceClassID": null,
"ServiceClassName": "",
"ServiceCode": "453",
"ServiceID": 203,
"ServiceName": "Надбавка",
"ServiceSubClassCode": "",
"ServiceSubClassID": null,
"ServiceSubClassName": "",
"ServiceTypeID": 1,
"ServiceTypeName": "Основні послуги",
"TaxGroupCode": "TouristTax",
"TaxGroupID": 8,
"TaxGroupName": "Туристичний збір",
"TaxName": "",
"TaxSum": "",
"TaxWage": "",
"Taxed": false,
"Total": "180,00",
"AcceptanceDate": "2017-01-26 00:00:00"
}
],
"ServiceProviderID": 317
}
],
"Companies": [
{
"BranchOfficeCode": null,
"Code": "",
"CompanyID": 317,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"HousingID": 1,
"HousingName": "Головний корпус",
"FactualAddress": "",
"FullName": "Начисленька",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "12312312",
"LegalAddress": "",
"Name": "Начисленька",
"PhoneNumber": null,
"PostalAddress": "",
"TIN": "",
"VatCertificateNumber": "",
"CorporateManager": null
}
],
"Consumers": [
{
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000029177",
"ConsumerID": 29177,
"ConsumerTypeID": 1,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"CountryISO3": "BLR",
"CountryName": "Білорусь",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт"
}
],
"DeletedBills": [
100713,
123719,
129732
],
"FiscalDevices": [
{
"CashCode": "О11",
"FiscalID": 1,
"FiscalName": "О1-тест"
}
],
"FiscalSessions": [
{
"CloseBalance": "7970,0000",
"CloseDate": "2013-08-20 14:23:50",
"CloseUser": {
"LoginID": 411,
"UserName": "Цаплинов Євген"
},
"FiscalID": 147,
"FiscalSessionID": 221,
"OpenBalance": "7820,0000",
"OpenDate": "2013-08-20 09:01:07",
"OpenUser": {
"LoginID": 411,
"UserName": "Цаплинов Євген"
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"Payers": [
{
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"CountryISO3": "BLR",
"CountryName": "Білорусь",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"Payer": "F0000029177",
"PayerID": 29177,
"PayerTypeID": 1,
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт"
}
]
}
]
}

</pre>

==GetDepositAccounts==
Отримання інформації про депозитні рахунки.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
bool ForceSetAccepted – примусова відмітка про обробку, за замовчуванням true.
bool NotAcceptedOnly – тільки необроблені депозитні рахунки, за замовчуванням true.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
Owners – власники, структура з такими полями:
short OwnerTypeID – тип власника, необов’язковий параметр
int[] OwnerIDs – ідентифікатори власників, необов’язковий параметр
DateTime DateCreationFrom – початкова дата створення депозитного рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateCreationTo – кінцева дата створення депозитного рахунку, необов’язковий параметр (якщо не вказано – необмежено)
bool ModefiedReceiptsOnly – відображати тільки ті чеки, які створені в зазначений період змін (якщо false – показувати рахунки, які були змінені у вказаний період з усіма чеками, якщо true – відкидати чеки, що не входять у період), за замовчуванням true
DateTime DateModefiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModefiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
{
"Credentials":{"UserName":"loginName","Password":"password"},
"Hotels":[1,2],
"ForceSetAccepted":true,
"NotAcceptedOnly":true,
"OpenTaxPeriodOnly":false,
"ServiceProviderID":[1,2,3],
"ServiceProviderFullName":["name1","name2"],
"Owners":{"OwnerTypeID":1, "OwnerIDs":[1,2]},
"DateCreationFrom":"2000-01-01",
"DateCreationTo":"2000-01-01",
"ModefiedReceiptsOnly":false,
"DateModefiedBillFrom":"2000-01-01 00:00:00",
"DateModefiedBillTo":"2000-01-01 00:00:00"
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері в UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654849559948",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "",
"CompanyID": 1,
"FactualAddress": "71 Old Boulevard",
"FullName": "Janice2",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "ZYR",
"LegalAddress": "751 Green Milton Road",
"Name": "NCT",
"PhoneNumber": null,
"PostalAddress": "284 Green Second Blvd.",
"TIN": "543452",
"VatCertificateNumber": "ANZI9JXDF",
"СorporateManager": null
},
],
"Consumers": [
{
"ArrivalDate": "2012-04-12 15:04:48",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000028048",
"ConsumerID": 28048,
"ConsumerTypeID": 1,
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Анка",
"PriceListName": "__AFT",
"RoomNumber": "18104",
"RoomTypeName": "Стандарт"
}
],
"DepositAccounts": [
{
"AccountCode": null,
"Balance": "600,0000",
"CompanyAgentID": null,
"Currency": "UAH",
"DateCreated": "2013-06-21 15:28:52",
"DepositAccount": 2,
"OwnerName": "Dsf Asdffff Asdf",
"OwnerTypeID": 0,
"Receipts": [
{#ReceiptObject#}
],
"ReceiptsReturns": [
{#ReceiptObject#}
],
"Requisites": "2",
"ServiceProviderID": 1
}
],
"FiscalDevices": [
{
"CashCode": "О31 ",
"FiscalID": 6,
"FiscalName": "О3-test tk"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Отель 1",
"HotelShortName": "О1"
}
}
]
}

</pre>

==GetFiscalSessions==
Отримання інформації про фіскальні сесії.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
int[] Fiscals – масив ідентифікаторів касових апаратів, необов’язковий параметр.
string[] CashBox – масив кодів кас у довідниках кас Servio HMS, необов’язковий параметр.
bool ForceSetAccepted – примусова відмітка про обробку, за замовчуванням true.
bool NotAcceptedOnly – тільки необроблені рахунки, за замовчуванням true.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
string DateSessionType – вказує варіант контролю дат: за відкриттям або закриттям зміни.
bool CloseSessionOnly – тільки закриті зміни, необов’язковий параметр.
DateTime DateSessionFrom – початкова дата фіскальної сесії, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateSessionTo – кінцева дата фіскальної сесії, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModefiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModefiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateReceiptFrom – початкова дата оплати чека (необов’язковий параметр)
DateTime DateReceiptTo – кінцева дата оплати чека (необов’язковий параметр)
byte[] NomenclatureTypes – масив типів номенклатур, необов’язковий параметр
{
"Credentials":{"UserName":"loginName","Password":"password"},
"Hotels": [1,2],
"Fiscals":[1,2],
"CashBox":["100"],
"ForceSetAccepted":true,
"NotAcceptedOnly":true,
"OpenTaxPeriodOnly":false,
"ServiceProviderID":[1,2,3],
"ServiceProviderFullName":["name1","name2"],
"DateSessionType":"OpenDate|CloseDate",
"CloseSessionOnly":true,
"DateSessionFrom":"2000-01-01 00:00:00",
"DateSessionTo":"2000-01-01 00:00:00",
"DateModefiedBillFrom":"2000-01-01 00:00:00",
"DateModefiedBillTo":"2000-01-01 00:00:00",
"NomenclatureTypes": [0, 1],
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "6756777777",
"CompanyID": 285,
"FactualAddress": "",
"FullName": "Google",
"IsOperator": true,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": false,
"KPP": "1251254552",
"LegalAddress": "",
"Name": "Google",
"PhoneNumber": "",
"PostalAddress": "",
"TIN": "125154452115",
"VatCertificateNumber": "",
"CorporateManager": 419
}
],
"Consumers": [
{
"ArrivalDate": "2013-01-10 14:23:43",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000027742",
"ConsumerID": 27742,
"ConsumerTypeID": 1,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2013-01-12 12:00:00",
"Name": "Бугогагов Сергій",
"PriceListName": "__AFT",
"RoomNumber": "201",
"RoomTypeName": "Стандарт"
}
],
"FiscalDevices": [
{
"CashCode": "К03",
"FiscalID": 28,
"FiscalName": "О1-Каса 03"
}
],
"FiscalSessions": [
{
"CloseBalance": "200.0000",
"CloseDate": "2013-05-31 16:30:00",
"CloseUser": {
"LoginID": 2,
"UserName": "Ім’я"
},
"FiscalDeviceID": 28,
"FiscalSessionID": 198,
"OpenBalance": "0.0000",
"OpenDate": "2012-04-05 10:30:00",
"OpenUser": {
"LoginID": 2,
"UserName": "Ім’я"
},
"Receipts": [
{ "#ReceiptObject": {} }
],
"ReceiptsReturns": [
{ "#ReceiptObject": {} }
],
"TotalReceipts": {
"ReceiptReturns": [
{
"FiscalReceiptTypeID": 2,
"FiscalReceiptTypeName": "Чек повернення оплати",
"ReceiptPaidTypeID": 4,
"ReceiptPaidTypeName": "Безготівковий",
"Sum": 110.00
}
],
"Receipts": [
{
"FiscalReceiptTypeID": 1,
"FiscalReceiptTypeName": "Чек на оплату",
"ReceiptPaidTypeID": 4,
"ReceiptPaidTypeName": "Безготівковий",
"Sum": 200.00
}
],
"TotalSum": 200.00
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}

</pre>

==AcceptSet==
Встановлення позначки про обробку.

'''Вхідні параметри:'''
<pre>
int[] Bills – ідентифікатори оброблених рахунків, необов’язковий параметр.
int[] DepositAccounts – ідентифікатори оброблених депозитних рахунків, необов’язковий параметр.
int[] FiscalSessions – ідентифікатори оброблених фіскальних сесій, необов’язковий параметр.
DateTime Date – дата і час обробки у UTC, якщо не вказано — поточний час.
DateTime RequestDate - дата й час запиту документів в UTC, необов’язковий параметр.

{
"Credentials":{"UserName":"loginName","Password":"password"},
"Bills":[1,2],
"DepositAcounts":[17,18],
"FiscalSessions":[5],
"Date":"2021-06-10 10:25:43",
"RequestDate": "2021-06-10 09:56:46"
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1652080021398",
"VersionInfo": "1.0.0.3"
}

</pre>

== PayToHMS ==
Імпорт оплати з бухгалтерії.

'''Вхідні параметри:'''
<pre>
PayBindings[] – список платіжних доручень, масив структур PayBinding, необов’язковий параметр.
ReturnPayBindings[] – список повернень платіжних доручень, масив структур ReturnPayBinding, необов’язковий параметр.
DeletedPayDoxes[] – список видалених платіжних доручень, масив структур DeletedPayDox, необов’язковий параметр.
{
"Credentials": {
"UserName": "loginName",
"Password": "password"
},
"PayBindings": [
{
"PayConfirmedDate": "2022-05-11 15:20:00",
"Store": "Готель 1",
"Agent": "Гість2",
"BillID": "00000023572",
"Account": "F0000004061",
"PaySum": "40,00",
"BillSum": "126,00",
"Org": "",
"VAT": "20%",
"VATSum": "8,00",
"Doc": "",
"SDDS": "Оплата ресторану",
"Currency": 980,
"TIN": "",
"Code": "",
"NonResident": "false",
"PaymentDescription": "Опис",
"DocRowNumber": 2,
"DocComment": "коментар",
"DocAuthor": "Автор",
"DocNumber": "00000050065",
"BankNumber": "1400790",
"BankDate": "2022-05-10 14:00:00",
"AgentBankAccount": "26000070010005",
"DepositAccount": "",
"AccountCode1C": ""
}
],
"ReturnPayBindings": [
{
"PayConfirmedDate": "2022-05-11 20:00:00",
"Agent": "Компанія47",
"BillID": "00000003873",
"Account": "C0000000275",
"ReturnPaySum": "5800,00",
"Org": "Ілона",
"VAT": "20%",
"VATSum": "1160,00",
"Doc": "",
"SDDS": "Обслуговування",
"Currency": 980,
"TIN": "231444444412",
"Code": "372345234523",
"NonResident": "true",
"PaymentDescription": "",
"DocRowNumber": 1,
"DocComment": "",
"DocAuthor": "Автор",
"DocNumber": "00000050041",
"BankNumber": "360915",
"BankDate": "2022-05-11 14:00:00",
"AgentBankAccount": "140045926505",
"DepositAccount": "",
"AccountCode1C": ""
}
],
"DeletedPayDoxes": [
{
"DocNumber": "00000050050",
"DocDate": "2022-05-10 12:00:00"
}
]
}
</pre>

'''Структура PayBinding''':
<pre>
PayConfirmedDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
Store (Рядок 50) – склад зі рахунку на оплату (готель).
Agent (Рядок 100) – контрагент. Не використовується.
BillID (Рядок 11) – номер рахунку на оплату (містить провідні нулі). Необов’язковий, якщо використовується DepositAccount.
Account (Рядок 11) – номер договору. Не використовується.
PaySum (Число 15,2) – сума платежу.
BillSum (Число 15,2) – сума рахунку на оплату (сума взаєморозрахунків).
Org (Рядок 50) – організація. Не використовується.
VAT (Перерахування: 0%, БезПДВ, 20%, НеПДВ) – ставка ПДВ. Не використовується.
VATSum (Число 15,2) – сума ПДВ. Не використовується.
Doc (Рядок 255) – текстове подання ПД. Не використовується.
SDDS (Рядок 100) – стаття руху грошових коштів. Не використовується.
Currency (Число 3) – ISO номер валюти.
TIN (Рядок 12) – ІПН контрагента.
Code (Рядок 12) – код за ЄДРПОУ контрагента.
NonResident (Логічне True/False) – ознака нерезидента.
PaymentDescription (Рядок 255) – призначення платежу. Не використовується.
DocRowNumber (Число) – номер рядка в ПД. Не використовується.
DocComment (Рядок 255) – коментар ПД. Не використовується.
DocAuthor (Рядок 100) – автор ПД. Не використовується.
DocNumber (Рядок 11) – номер ПД.
BankNumber (Рядок 30) – номер платежу в банківській виписці (за нумерацією контрагента).
BankDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платежу в банківській виписці.
AgentBankAccount (Рядок 50) – банківський рахунок контрагента. Не використовується.
DepositAccount (Число 12) – номер депозитного рахунку в системі HMS Servio, з якого проводилася оплата послуг. Необов’язковий, якщо використовується BillID.
AccountCode1C (Рядок 9) – код елемента у довіднику договорів 1С для ідентифікації депозитних рахунків.
</pre>
'''Структура ReturnPayBinding:'''
<pre>
PayConfirmedDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
Agent (Рядок 100) – контрагент. Не використовується.
BillID (Рядок 11) – номер рахунку на оплату (містить провідні нулі). Необов’язковий, якщо використовується DepositAccount.
Account (Рядок 11) – номер договору. Не використовується.
ReturnPaySum (Число 15,2) – сума повернення платежу.
Org (Рядок 50) – організація. Не використовується.
VAT (Перерахування: 0%, БезПДВ, 20%, НеПДВ) – ставка ПДВ. Не використовується.
VATSum (Число 15,2) – сума ПДВ. Не використовується.
Doc (Рядок 255) – текстове подання ПД. Не використовується.
SDDS (Рядок 100) – стаття руху грошових коштів. Не використовується.
Currency (Число 3) – ISO номер валюти.
TIN (Рядок 12) – ІПН контрагента.
Code (Рядок 12) – код за ЄДРПОУ контрагента.
NonResident (Логічне True/False) – ознака нерезидента.
PaymentDescription (Рядок 255) – призначення платежу. Не використовується.
DocRowNumber (Число) – номер рядка в ПД. Не використовується.
DocComment (Рядок 255) – коментар ПД. Не використовується.
DocAuthor (Рядок 100) – автор ПД. Не використовується.
DocNumber (Рядок 11) – номер ПД.
BankNumber (Рядок 30) – номер платежу в банківській виписці (за нумерацією контрагента).
BankDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платежу в банківській виписці.
AgentBankAccount (Рядок 50) – банківський рахунок контрагента. Не використовується.
DepositAccount (Число 12) – номер депозитного рахунку в системі HMS Servio, з якого проводилася оплата послуг. Необов’язковий, якщо використовується BillID.
AccountCode1C (Рядок 9) – код елемента у довіднику договорів 1С для ідентифікації депозитних рахунків.
</pre>
'''Структура DeletedPayDox:'''
<pre>
DocNumber (Рядок 11) – номер ПД.
DocDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
</pre>

'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки

{
"ErrorCode":0,
"ErrorText":"",
"RequestTime":"1652080021476",
"VersionInfo":"1.0.0.3"
}

</pre>

==GetPaymentsDelivery==
Отримання інформації про нарахування на доставку. 

Параметри: авторизаційні дані, готелі, ідентифікатори нарахувань, коди класів послуг, коди груп послуг, початкова дата створення нарахування (не раніше). 
Додаткові фільтри послуг (передаються послуги, які відповідають принаймні одному фільтру; порожній фільтр не обробляється; якщо всі фільтри порожні — передаються всі послуги). 

'''Вхідні параметри:'''
<pre>
{
"Credentials":{"UserName":"admin","Password":"expert"},
"Hotels":[1],
"ServiceIDs":[1,2],
"ServiceClassCodes":["eat"],
"ServiceGroupCodes":["delivery"],
"DatePaymentFrom":"2022-09-30 13:00:00"
}

</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1664796014427",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Guests": [
{
"Guest": {
"Adults": 0,
"ArrivalDateTime": "0001-01-01 00:00:00",
"CancelReasonID": null,
"CancelReasonName": null,
"CancelReasonString": null,
"Childs": 0,
"ChildsPay": 0,
"Clients": [],
"Company": null,
"CompanyID": null,
"Cost": null,
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "",
"DateTimeReservation": "0001-01-01 00:00:00",
"DateTimeSettle": "",
"DepartureDateTime": "0001-01-01 00:00:00",
"Email": null,
"GroupID": null,
"GuestID": 162177,
"GuestName": "Максим Воронцов",
"GuestStatus": 0,
"IdentityCards": [],
"ManagerActivities": [],
"ManagerID": null,
"NightsCount": 0,
"Notes": [],
"OperatorCompany": null,
"PaidTypeID": null,
"PaidTypeName": null,
"PayStatus": null,
"Payments": [
{
"ConsumptionDate": "2022-09-30 13:05:00",
"IsCanceled": false,
"IsPackagePayment": false,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 631433,
"PaymentStatus": 0,
"PaymentType": 1,
"Price": "45.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 436,
"ServiceName": "Стейк в номер",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ7",
"TaxRate": "0.07",
"TaxSum": "2.94",
"UsedQuantity": ""
},
{
"ConsumptionDate": "2022-09-30 13:05:00",
"IsCanceled": false,
"IsPackagePayment": false,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 631435,
"PaymentStatus": 0,
"PaymentType": 1,
"Price": "80.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 437,
"ServiceName": "Аперитив Віола",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ7",
"TaxRate": "0.07",
"TaxSum": "5.23",
"UsedQuantity": ""
}
],
"PersCancelation": null,
"PersDeparture": null,
"PersReservation": null,
"PersSettle": null,
"Phone": "",
"Preferences": [],
"PriceList": null,
"PriceListID": 0,
"PriceListName": null,
"ReservationTypeID": null,
"ReservationTypeName": null,
"SourceCode": null,
"TourOperatorID": null,
"UTMParameters": null,
"Vip": null
},
"Room": {
"Building": null,
"Checkup": null,
"CleanStatus": null,
"Floor": null,
"RoomId": 0,
"RoomNumber": "1852 Стандарт",
"RoomStatus": null,
"RoomType": null,
"SaleStatus": null
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}

</pre>

==GetRevenueInfo==
Отримання статистичних даних. 

Параметри: авторизаційні дані, готелі, ідентифікатори нарахувань, дати початку та кінця періоду. 

'''Вхідні параметри:'''
<pre>
{
"Credentials": {"UserName": "UserName","Password": "Password"},
"Hotels": [3],
"DateFrom": "2023-01-08",
"DateTo": "2023-01-20",
"ExtractClasses": ["eat", "wash", "minibar"],
"ExtractSubClasses": ["restaurant", "breakfast"]
}

</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1700750126101",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"HotelID": 3,
"HotelName": "Готель 3",
"RoomTypesRevenue": [
{
"GuestArrivals": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestDeparts": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestOccupancy": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0,
"ClientNights": 0
},
"Revenue": {
"Details": [
{
"Code": "eat",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "wash",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "minibar",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "restaurant",
"IsSubClass": true,
"SubTotal": 0.00
},
{
"Code": "breakfast",
"IsSubClass": true,
"SubTotal": 0.00
}
],
"Dwelling": 0.00,
"Other": 0.00,
"Total": 0.00
},
"RoomTypeOccupancy": {
"AllRooms": 90,
"OcupRooms": 0.00,
"Ordering": 2,
"RoomTypeID": 37,
"RoomTypeName": "Люкс",
"RoomTypeNameShort": "Л",
"RoomsInSale": 90,
"RoomsOnRepairNotSale": 0
}
},
{
"GuestArrivals": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestDeparts": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestOccupancy": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0,
"ClientNights": 0
},
"Revenue": {
"Details": [
{
"Code": "eat",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "wash",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "minibar",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "restaurant",
"IsSubClass": true,
"SubTotal": 0.00
},
{
"Code": "breakfast",
"IsSubClass": true,
"SubTotal": 0.00
}
],
"Dwelling": 0.00,
"Other": 0.00,
"Total": 0.00
},
"RoomTypeOccupancy": {
"AllRooms": 270,
"OcupRooms": 0.00,
"Ordering": 0,
"RoomTypeID": 4061,
"RoomTypeName": "Стандарт 3М",
"RoomTypeNameShort": "Ст3",
"RoomsInSale": 270,
"RoomsOnRepairNotSale": 0
}
}
]
}
]
}

</pre>

==GetBillsGroupedSales==
Отримання інформації про рахунки зі згрупованими нарахуваннями.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
bool ForceSetAccepted – примусова відмітка про обробку.
bool NotAcceptedOnly – тільки необроблені рахунки.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] Bills – масив ідентифікаторів рахунків, необов’язковий параметр.
int[] BillTypes – масив типів рахунків, необов’язковий параметр.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
DateTime DateBillFrom – початкова дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено).
DateTime DateBillTo – кінцева дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено).
DateTime DateModefiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено).
DateTime DateModefiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено).

{
"Credentials": { "UserName": "paRiin", "Password": "Qcds3#fds" },
"Hotels": [1,3],
"NotAcceptedOnly": false,
"ForceSetAccepted": true,
"OpenTaxPeriodOnly": false,
"Bills": [164370, 164375],
"BillTypes": ["Payment", "Comission"],
"ServiceProviderID": [341,100],
"ServiceProviderFullName": ["Хотел Груп Лтд", "Молнар"],
"DateBillFrom": "2023-05-29 14:17:53",
"DateBillTo": "2023-10-17 21:46:18",
"DateModefiedBillFrom": "2023-09-26 16:23:10",
"DateModefiedBillTo": "2023-09-29 05:51:32"
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel.
HotelInformation – інформація по готелю. Структура з полями:
int HotelID – ідентифікатор готелю
string HotelName – назва готелю
string HotelShortName – коротка назва готелю
FiscalSessions[] – список фіскальних сесій FiscalSession. Структура з полями:
int FiscalSessionID – ідентифікатор сесії
int FiscalID – ідентифікатор каси
DateTime? OpenDate – дата відкриття зміни
DateTime? CloseDate – дата закриття зміни
UserInfo OpenUser – користувач, який відкрив зміну. Структура UserInfo:
int LoginID – ідентифікатор користувача
string UserName – ім’я користувача
UserInfo CloseUser – користувач, який закрив зміну
decimal? OpenBalance – баланс каси на момент відкриття зміни
decimal? CloseBalance – баланс каси на момент закриття зміни
FiscalDevices[] – список кас FiscalDevice. Структура з полями:
int FiscalID – ідентифікатор каси
string CashCode – код каси
string FiscalName – назва каси
Consumers[] – список споживачів Consumer. Структура з полями:
DateTime? ArrivalDate – дата заїзду
string BookingSource – джерело бронювання
int? CompanyOperatorID – ідентифікатор компанії-оператора
string Consumer – особовий рахунок
int ConsumerID – ідентифікатор споживача
int ConsumerTypeID – тип споживача
string CountryISO3 – код країни
string CountryName – назва країни
DateTime? DepartureDate – дата виїзду
string Name – назва споживача
string PriceListName – назва прейскуранта
string RoomNumber – номер кімнати
string RoomTypeName – назва категорії
Payers[] – список платників Payer. Структура з полями:
DateTime? ArrivalDate – дата заїзду
string BookingSource – джерело бронювання
int? CompanyOperatorID – ідентифікатор компанії-оператора
string CountryISO3 – код країни
string CountryName – назва країни
DateTime? DepartureDate – дата виїзду
string Name – назва платника
string Payer – особовий рахунок
int PayerID – ідентифікатор платника
int PayerTypeID – тип платника
string PriceListName – назва прейскуранта
string RoomNumber – номер кімнати
string RoomTypeName – назва категорії
Companies[] – список компаній Company. Структура з полями:
string BranchOfficeCode – код філії
string Code – код компанії
int CompanyID – ідентифікатор компанії
string FactualAddress – фактична адреса
string FullName – повна назва
bool IsOperator – ознака компанії-оператора
bool IsPayer – ознака платника
bool IsResident – ознака резидента
bool IsServiceProvider – ознака постачальника послуг
string KPP – КПП
string LegalAddress – юридична адреса
string Name – назва
string PhoneNumber – номер телефону
string PostalAddress – поштова адреса
string TIN – ІПН
string VatCertificateNumber – номер свідоцтва ПДВ
string CorporateManager – корпоративний менеджер
int[] DeletedBills – список видалених рахунків
Bills[] – список рахунків Bill. Структура з полями:
int BillID – ідентифікатор рахунку
DateTime BillDate – дата рахунку
string BillType – тип рахунку
int? CompanyPayerID – ідентифікатор компанії-платника
int ServiceProviderID – ідентифікатор постачальника послуг
string Account – особовий рахунок споживача
string Currency – назва валюти рахунку
decimal CurrencyCourse – курс валюти
string BillComment – коментар до рахунку
int BillCustomerID – ідентифікатор споживача
int BillCustomerTypeID – тип споживача
int BillPayerID – ідентифікатор платника
int BillPayerTypeID – тип платника
decimal PaymentsSum – сума нарахувань
decimal ReceiptsSum – сума оплат
UserInfo CreateUser – користувач, який створив рахунок
Sale[] Sales – список нарахувань Sale. Структура з полями:
decimal Price – ціна нарахування
decimal Quantity – кількість
decimal Total – вартість
int Consumers – кількість споживачів
DateTime PeriodDateFrom – дата початку періоду споживання
DateTime PeriodDateTo – дата кінця періоду споживання
bool Canceled – відмітка скасування
int ServiceID – ідентифікатор послуги
string ServiceName – назва послуги
int? ServiceCode – код послуги
int? ServiceTypeID – ідентифікатор групи послуги
string ServiceTypeName – назва групи
int? ServiceClassID – ідентифікатор класу послуги
string ServiceClassName – назва класу
string ServiceClassCode – код класу
int? ServiceSubClassID – ідентифікатор підкласу
string ServiceSubClassName – назва підкласу
string ServiceSubClassCode – код підкласу
bool Taxed – ознака оподаткування
int? TaxGroupID – ідентифікатор податкової групи
string TaxGroupName – назва податкової групи
string TaxGroupCode – код податкової групи
int? TaxType – ідентифікатор основного податку
string TaxName – назва основного податку
decimal? TaxWage – ставка основного податку
decimal? TaxSum – сума основного податку
int? SecondTaxType – ідентифікатор додаткового податку
string SecondTaxName – назва додаткового податку
decimal? SecondTaxWage – ставка додаткового податку
decimal? SecondTaxSum – сума додаткового податку
DateTime? AcceptanceDate - дата акту
Receipt[] Receipts – список чеків оплати Receipt. Структура з полями:
UserInfo CreateUser – касир
DateTime Date – дата чека
int ReceiptID – ідентифікатор чека
int? DepositID – ідентифікатор депозиту
int? BillID – ідентифікатор рахунку
int PayTypeID – ідентифікатор типу оплати
string PaidType – тип оплати
string PayTypeName – назва типу оплати
int? PayGroupType – ідентифікатор групи оплати
int ReceiptPayTypeID – ідентифікатор типу оплати
string ReceiptPayTypeName – назва типу оплати
string ReceiptPayTypeCode – код типу оплати
int? FiscalID – ідентифікатор каси
int? FiscalSessionID – ідентифікатор касової зміни
decimal Sum – сума чека
decimal SumWithTax – сума позицій, що не підлягають оподаткуванню
decimal SumWithoutTax – сума позицій, що не підлягають оподаткуванню
decimal? RoundingDelta – сума заокруглення
Taxes[] – список податків у чеку Tax. Структура з полями:
string TaxName – назва податку
decimal TaxWage – ставка податку
decimal TaxSum – сума податку
Sales[] – список послуг у чеку Sale.
Receipt[] ReceiptReturns – список чеків повернення Receipt
int RoomsCount – кількість споживачів у рахунку

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1700052641226",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Bills": [
{
"Account": "G0000036126",
"BillComment": "",
"BillCustomerID": 36126,
"BillCustomerTypeID": 2,
"BillDate": "2023-11-15 10:42:09",
"BillID": 164370,
"BillPayerID": 36126,
"BillPayerTypeID": 2,
"BillType": "Payment",
"CompanyPayerID": null,
"CreateUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
},
"Currency": "UAH",
"CurrencyCourse": 1,
"PaymentsSum": 49157.20,
"ReceiptReturns": [
{
"CreateUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
},
"Date": "2023-11-15 14:48:00",
"DepositID": null,
"FiscalID": 1,
"FiscalSessionID": 17343,
"PaidType": "Credit",
"PayGroupType": 1,
"PayTypeID": 11,
"PayTypeName": "Карта",
"ReceiptID": 174323,
"ReceiptPayTypeCode": "крт",
"ReceiptPayTypeID": 11,
"ReceiptPayTypeName": "Карта",
"RoundingDelta": null,
"Sales": [
{
"Canceled": false,
"Consumers": 1,
"PeriodDateFrom": "2023-11-18 14:00:00",
"PeriodDateTo": "2023-11-19 12:00:00",
"Price": 1200,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 100,
"ServiceID": 89579,
"ServiceName": "Проживання",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassID": 2,
"ServiceSubClassName": "Проживание",
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "FullVAT",
"TaxGroupID": 1,
"TaxGroupName": "ПДВ 20%",
"TaxName": "ПДВ 20",
"TaxSum": 200,
"TaxType": 14,
"TaxWage": 0.2,
"Taxed": true,
"Total": 1200
},
{
"Canceled": false,
"Consumers": 1,
"PeriodDateFrom": "2023-11-18 14:00:00",
"PeriodDateTo": "2023-11-19 12:00:00",
"Price": 34.8,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 987,
"ServiceID": 210,
"ServiceName": "Туристичний збір",
"ServiceSubClassCode": null,
"ServiceSubClassID": null,
"ServiceSubClassName": null,
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "Untax",
"TaxGroupID": 8,
"TaxGroupName": "Не оподатковується",
"TaxName": "Не оподатковується",
"TaxSum": 0,
"TaxType": 1040,
"TaxWage": 0,
"Taxed": false,
"Total": 34.8
}
],
"Sum": 2469.6,
"SumWithTax": 2400,
"SumWithoutTax": 69.6,
"Taxes": [
{
"TaxName": "ПДВ 20",
"TaxSum": 400,
"TaxWage": 0.2
}
]
}
],
"Receipts": [
{
"CreateUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
},
"Date": "2023-11-15 11:12:00",
"DepositID": null,
"FiscalID": 1,
"FiscalSessionID": 17343,
"PaidType": "Credit",
"PayGroupType": 1,
"PayTypeID": 11,
"PayTypeName": "Карта",
"ReceiptID": 174322,
"ReceiptPayTypeCode": "крт",
"ReceiptPayTypeID": 11,
"ReceiptPayTypeName": "Карта",
"RoundingDelta": null,
"Sales": [
{
"Canceled": false,
"Consumers": 4,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-27 12:00:00",
"Price": 1200,
"Quantity": 39,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 100,
"ServiceID": 89579,
"ServiceName": "Проживання",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassID": 2,
"ServiceSubClassName": "Проживание",
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "FullVAT",
"TaxGroupID": 1,
"TaxGroupName": "ПДВ 20%",
"TaxName": "ПДВ 20",
"TaxSum": 7800,
"TaxType": 14,
"TaxWage": 0.2,
"Taxed": true,
"Total": 46800
},
{
"Canceled": false,
"Consumers": 4,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-27 12:00:00",
"Price": 34.8,
"Quantity": 39,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 987,
"ServiceID": 210,
"ServiceName": "Туристичний збір",
"ServiceSubClassCode": null,
"ServiceSubClassID": null,
"ServiceSubClassName": null,
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "Untax",
"TaxGroupID": 8,
"TaxGroupName": "Не оподатковується",
"TaxName": "Не оподатковується",
"TaxSum": 0,
"TaxType": 1040,
"TaxWage": 0,
"Taxed": false,
"Total": 1357.2
},
{
"Canceled": true,
"Consumers": 1,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-18 12:00:00",
"Price": 1200,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 100,
"ServiceID": 89579,
"ServiceName": "Проживання",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassID": 2,
"ServiceSubClassName": "Проживание",
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "FullVAT",
"TaxGroupID": 1,
"TaxGroupName": "ПДВ 20%",
"TaxName": "ПДВ 20",
"TaxSum": 200,
"TaxType": 14,
"TaxWage": 0.2,
"Taxed": true,
"Total": 1200
},
{
"Canceled": true,
"Consumers": 1,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-18 12:00:00",
"Price": 34.8,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 987,
"ServiceID": 210,
"ServiceName": "Туристичний збір",
"ServiceSubClassCode": null,
"ServiceSubClassID": null,
"ServiceSubClassName": null,
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "Untax",
"TaxGroupID": 8,
"TaxGroupName": "Не оподатковується",
"TaxName": "Не оподатковується",
"TaxSum": 0,
"TaxType": 1040,
"TaxWage": 0,
"Taxed": false,
"Total": 34.8
}
],
"Sum": 49392,
"SumWithTax": 48000,
"SumWithoutTax": 1392,
"Taxes": [
{
"TaxName": "ПДВ 20",
"TaxSum": 8000,
"TaxWage": 0.2
}
]
}
],
"ServiceProviderID": 341
}
],
"Companies": [
{
"BranchOfficeCode": null,
"Code": "38964368",
"CompanyID": 341,
"PayTypeID": 1,
"PayTypeName": "Наличные",
"HousingID": 1,
"HousingName": "Головний корпус",
"FactualAddress": "",
"FullName": "Hotel Group Ltd.",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "",
"LegalAddress": "",
"Name": "Хотел Груп Лтд",
"PhoneNumber": "",
"PostalAddress": "",
"TIN": "286547135401",
"VatCertificateNumber": "",
"СorporateManager": null
}
],
"Consumers": [
{
"ArrivalDate": "",
"BookingSource": "",
"CompanyOperatorID": null,
"Consumer": "G0000036126",
"ConsumerID": 36126,
"ConsumerTypeID": 2,
"PayTypeID": 1,
"PayTypeName": "Наличные",
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "",
"Name": "Grouped Sales",
"PriceListName": "ПР Базовий",
"RoomNumber": "",
"RoomTypeName": ""
}
],
"DeletedBills": [164366, 164367, 164368, 164369],
"FiscalDevices": [
{
"CashCode": " ",
"FiscalID": 1,
"FiscalName": "Каса"
}
],
"FiscalSessions": [
{
"CloseBalance": null,
"CloseDate": "",
"CloseUser": {
"LoginID": null,
"UserName": ""
},
"FiscalID": 1,
"FiscalSessionID": 17343,
"OpenBalance": 46571582.29,
"OpenDate": "2023-10-17 13:41:45",
"OpenUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "гот 1"
},
"Payers": [
{
"ArrivalDate": "",
"BookingSource": "",
"CompanyOperatorID": null,
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "",
"Name": "Grouped Sales",
"Payer": "G0000036126",
"PayerID": 36126,
"PayerTypeID": 2,
"PriceListName": "ПР Базовий",
"RoomNumber": "",
"RoomTypeName": ""
}
]
}
]
}

</pre>

API Протокол взаємодії Servio External Service з зовнішніми системами

2026-03-10T11:55:06Z

Bashenko.i: Додані AcceptanceDate та SumBeforeRounding в GetBills

=Опис Змін=
{| class="wikitable"
|+ Опис змін
|-
! ДАТА ВНЕСЕННЯ !! Мінімальна версія HMS !! НОМЕР НОВОЇ РЕДАКЦІЇ !! ЗМІНИ
|-
| 07.06.2021 || 05.12.171 || 1.03 || Форматування документа. Додано наступні функції в протокол: UpdateGuest, AddClient, UpdateClient. В відповідь команди GetClientsModified додано параметр GuestsID.
|-
| 11.06.2021 || 05.12.173 || 1.04 || Для методів GetGuestsModified, GetGroupsModified, GetClientsModified розширена інформація по прейскуранту. Додано новий метод: GetPriceListPrices.
|-
| 30.06.2021 || 05.12.176 || 1.05 || В методи GetGuestsModified, GetClientsModified, GetGroupsModified, GetActivitiesModified додано параметр для комплексного пошуку по полях.
|-
| 26.11.2021 || 06.00.023 || 1.06 || В відповіді методів GetGuestsModified, GetGroupsModified, GetActivitiesModified додано параметри.
|-
| 16.03.2022 || 06.00.038 || 1.07 || Додано метод SearchClients. Змінено методи GetClientsModified, AddClient.
|-
| 22.03.2022 || 06.00.039 || 1.08 || Додано поле Comment для структури Client.
|-
| 13.05.2022 || 06.00.045 || 1.09 || Додано методи GetBills, GetDepositAccounts, GetFiscalSession, AcceptSet, PayToHMS.
|-
| 03.10.2022 || 06.00.066 || 1.10 || Додано метод GetPaymentsDelivery.
|-
| 16.12.2022 || 06.00.076 || 1.11 || Додано метод GetRevenueInfo.
|-
| 14.03.2023 || 06.00.086 || 1.12 || Додано поля DateTimeCancelation, DateTimeDeparture, DateTimeReservation, DateTimeSettle, PersCancelation, PersDeparture, CancelReasonID, CancelReasonName, CancelReasonString для структури Guest.
|-
| 29.08.2023 || 06.00.109 || 1.13 || Для запиту методу GetRoomsModefied додано параметр isOnlyActual.
|-
| 17.10.2023 || 06.00.116 || 1.14 || Для запитів GetBills, GetDeposiAccounts, GetFiscalSessions додано параметр OpenTaxPeriodOnly.
|-
| 15.11.2023 || 06.00.120 || 1.15 || Додано метод GetBillsGroupedSales.
|-
| 23.11.2023 || 06.01.001 || 1.16 || Для GetRevenueInfo додано вхідні параметри ExtractClasses, ExtractSubClasses, а для блоку Revenue параметр Details.
|-
| 10.04.2024 || 06.01.027 || 1.17 || Для методу GetBillsGroupedSales розширено структуру Bill на поле RoomsCount.
|-
| 25.04.2024 || 06.01.032 || 1.18 || Змінено методи GetCustomerPayments, GetFiscalSessions.
|-
| 03.05.2024 || 06.01.034 || 1.19 || Для методу GetBillsGroupedSales змінена логіка групування Sales, RoomsCount з 1.17 перенесено в Sales.
|-
| 16.05.2024 || 06.01.036 || 1.20 || Для методів GetBillsGroupedSales, GetBills, GetFiscalSessions в сутність масивів "Companies": [ ] та "Consumers": [ ] додано поля "PayTypeID", "PayTypeName". В сутність масиву "Consumers": [ ] додано поля "HousingID", "HousingName".
|-
| 26.03.2025 || 06.01.094 || 1.21 || В відповідь методу GetFiscalSessions додано нове поле TotalReceipts, в якому згруповані оплати по типу чеку та оплати.
|-
| 20.06.2025 || 06.01.112 || 1.22 || В відповідь методу GetCustomerPayments додано два масиви PaymentReciepts та PaymentReturns.
|-
| 20.06.2025 || 06.01.123 || 1.23 || Додано два нових параметри AcceptanceDateFrom та AcceptanceDateTo до методу GetBills для фільтрації по датах акту.
|-
| 31.07.2025 || 06.01.128 || 1.24 || Додано RequestDate (дату й час запиту документів) у відповідь методів GetBills, GetFiscalSession, GetBillsGroupedSales, GetDepositAccounts та як вхідний параметр методу AcceptSet.
|}

=Опис взаємодії=
Формат переданих і прийнятих даних – протокол обміну JSON. Кодування запиту та відповіді UTF8. 
Запити повинні містити інформацію про авторизацію, відповіді повинні містити інформацію про версію протоколу, знімок часу в момент відповіді сервера, інформацію про помилку. Приклад запиту та відповіді наведено нижче. 

Права доступу розрізняються залежно від пари користувач/пароль, які вводяться в кожному JSON-запиті в розділі «Облікові дані»: 
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
}</pre>

=Опис функцій спілкування=

==GetRoomsModified==
Отримання інформації про зміни на обраний період по номерам.
Параметри: дані авторизації, готель (декілька?), час оновлення даних.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "Password"
},
// 0 – всі доступні готелі
"Hotels": [8],
// дата з часом, показувати номери, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom": "2025-06-19 00:00:00",
// id кімнат
"RoomsID": [],
// 0/1 - 0=не передає дані бронювань, 1=заповнює масив Clients інформацією про бронювання.
"isNeedClientInfo": 0,
// при isNeedClientInfo: 1 та isNeedDocumentsInfo: 1 заповнює массив Documents наявними документами.
"isNeedDocumentsInfo": 1,
//true - дата експлатації або її немає або більше поточної дати.
"v_isOnlyActual": false
}
</pre>

==GetGuestsModified==
Отримання інформації про гостей готелю. 
Параметри: дані авторизації, готель (декілька?), час оновлення даних (обрізано те, що було раніше, якщо не вказано, то тільки для всіх гостей, що проживають, 
або наступне бронювання, або останнє перебування в номері), масив з переборами відображених даних (проживання гостей (за замовчуванням, якщо не вказано), бронювання, виїзду, контактна інформація для гостей) 
'''Вхідні параметри:'''

<pre>
{
"Credentials" : {
"UserName" : "UserName",
"Password" : "User Password"
},
// 0 – всі доступні готелі
"Hotels" : [1, 2,...],
// дата з часом, показувати номери, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom" : "2019-11-12 12:33:45",
"ModifiedDateTo" : "2020-11-12 12:33:45",
// необов’язковий фільтр за ідентифікаторами гостей
"GuestsID" : ["1", .....] ,
// відповідно заброньовані, що проживають, останній виїхавший по номеру, анульований, незаїзд.
"GuestStatus" : [0,2,3,-1,-2],
// отримувати вартість гостя, за замовчуванням ні
"isNeedCostInfo" : "0",
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses":[""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses":[""],
// виводити дані по анкетах у гостей, за замовчуванням ні
"isNeedClientInfo" : "0",
// вивантажувати фото клієнта
"isNeedClientPhoto" : "0",

// виводити дані по документах в анкетах, за замовчуванням ні
"isNeedDocumentsInfo" : "0",
// ПІБ гостя
"GuestName" : "Петров Петро Петрович",
// Номер телефону
"PhoneNumber" : "0991232233",
// Пошта
"Mail" : "user@gmail.com",
// Ідентифікатор анкети гостя
"ClientID" : 654,
// Вподобання
"Preferences": [
{
"Code": "carnumber",
"Value": "333-44-55"
}
],
// Комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard"]
}
}
</pre>

'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "0.1",
// час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
"RequestTime" : "345356546",
// код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,
"Hotels" : [
"HotelInformation" : {
"HotelID" : 1,
"HotelName" : "Назва",
"HotelShortName" : "КороткаНазва"
},

"Guests" : [ {
"Room" : {
"RoomId" : 1,
"RoomNumber" : "1001",
"Floor" : "10",
"RoomType" : {
"RoomTypeName" : "",
"RoomTypeShortName" : "",
"RoomTypeId" : "",
"Beds" : "1",
"AddBeds" : "0"
}
},
"Guest" : #GuestInformation#
}
] // Гості
] // Готелі
}

</pre>

==GetClientsModified==
Отримання даних з анкет
*При HotelID = 0 повертаються всі анкети незалежно від наявності пов’язаного гостя.
*При HotelID ≠ 0 повертаються тільки ті анкети, для яких існує бронювання в зазначеному готелі.
*Якщо передано декілька значень HotelID (наприклад, [0,1]), то анкети з гостем у готелі 1 будуть дублюватися під обома HotelID: під 1 (за прямим фільтром) та під 0 (оскільки 0 означає «усі»).
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "{{login}}",
"Password": "{{password}}"
},
// 0 – всі доступні готелі
"Hotels": [
1
],
// Дата з часом у UTC, показувати анкети, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom": "2025-06-20 00:00:00",
"ModifiedDateTo": "2025-07-29 00:00:00",
// необов’язковий фільтр за ідентифікаторами клієнтів
"ClientsID": [],
// фільтри для анкет
"Phones": [
""
],
"Emails": [
""
],
"FirstName": "",
"LastName": "",
"MiddleName": "",
// серія та номер документа без роздільників
"DocumentSeriesAndNumber": "",
// ІПН документа
"DocumentIIN": "",
"Sex": true // true - чоловічий, false - жіночий
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1753779736833",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Clients": [
{
"Address": "",
"BirthDay": "2000-01-31",
"BlackList": false,
"ClientID": 13941,
"Comment": "",
"Documents": [],
"Email": "",
"FirstName": "test",
"GuestsID": [
29030,
29040
],
"LastName": "Testing",
"MiddleName": "",
"Phone": "+3809732446545",
"Photo": null,
"PhotoURL": "~/img/photo_place.gif",
"Preferences": [],
"Sex": true,
"VIP": true
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Family Hotel",
"HotelShortName": "FH"
}
}
]
}</pre>

==UpdateRooms==
Оновлення статуса кімнат
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Name",
"HotelShortName": "ShortName"
},
"Rooms": [
{
"Room": {
"RoomId": 1,
// код прибирання
"CleanStatus": "clean",
// код статусу продажу (sale, repair, repair not sale)
"SaleStatus": "repair"
}
}
]
}
]
}
</pre>

'''Значення, що повертається:'''
<pre>
{
"VersionInfo": "0.1",
// час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
"RequestTime": "123423234",
// код помилки, 0 – помилок немає
"ErrorCode": "0",
"ErrorText": ""
}
</pre>

==GetCustomerPayments==
Отримання інформації про нарахування клієнта. 
Необхідно вказати або масив "Клієнти", або періоди надання/зміни послуги. 
Якщо вказано і масив, і крапки, то інформація фільтрується тільки по масиву. 
Періоди дати повинні бути повними (вказуються як початок, так і кінець), але не довше 31 дня.

'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "Ім'я користувача",
"Password": "Пароль користувача"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// масив з типом і кодом кому надавалась послуга
"Customers": [ {
"CustomerId":1,
// тип контрагента (1 – гість, 2 – група, 3 – компанія, 4 – захід, 5 – цільовий рахунок)
"CustomerType":1
}],
// масив ідентифікаторів послуг (serviceid) для фільтра
"Services": [1,2, ...],
// масив буквених кодів класів послуг для фільтра
"ServiceClasses": [""],
// масив буквених кодів підкласів послуг для фільтра
"ServiceSubClasses": [""],
// включати чи анульовані нарахування (за замовчуванням ні)
"IncludeCanceled": "0",

// дати періоду надання послуг, якщо якась з дат не вказана, період відкритий
"ConsumptionDateStart": "2020-01-01 14:00:00",
"ConsumptionDateEnd": "2020-01-02 12:00:00",
// початкова дата, з якої нарахування були змінені
"ModifiedPaymentsFrom": "2020-01-01 14:00:00",
// кінцева дата, з якої нарахування були змінені
"ModifiedPaymentsTo": "2020-01-02 12:00:00",
// типи номенклатур послуг
"NomenclatureTypes": [0, 1]
}

</pre>

'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1753281347241",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "30114888",
"CompanyAccounts": [
{
"Account": "26003139727",
"BankName": "АТ \"Райффайзен Банк Аваль\"",
"Description": "",
"IBAN": null,
"IsDefault": false,
"MFO": "380805",
"ValuteISO": 1
},
{
"Account": "UA653808050000000026006639700",
"BankName": "АТ \"Райффайзен Банк Аваль\"",
"Description": "",
"IBAN": "UA653808050000000026006639700",
"IsDefault": true,
"MFO": "380805",
"ValuteISO": 1
}
],
"CompanyID": 2,
"FactualAddress": "04070, м.Київ, вул. Ярославська, 39Г",
"FullName": "ТОВ \"the Family Hotel\"",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "",
"LegalAddress": "04070, м.Київ, вул. Ярославська, 39Г",
"Name": "ТОВ Hotel",
"PayTypeID": 2,
"PayTypeName": "Безготівка",
"PhoneNumber": "+380(44)537-01-68",
"PostalAddress": "04070, м.Київ, вул. Ярославська, 39Г",
"TIN": "301143628888",
"VatCertificateNumber": "38253100",
"СorporateManager": null
}
],
"Customers": [
{
"ArrivalDate": "2025-07-24 15:00:00",
"BookingSource": "",
"CompanyOperatorID": null,
"Consumer": "F0000029043",
"CountryISO3": "",
"CountryName": "",
"CustomerId": 29043,
"CustomerName": "payments",
"CustomerType": 1,
"DepartureDate": "2025-07-27 12:00:00",
"HousingID": 1,
"HousingName": "Головний корпус",
"Payments": [
{
"Barcode": null,
"Code": "dwelling",
"CodeId": 2222,
"ConsumptionDate": "2025-07-25 23:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"IsReturned": false,
"LastReceiptBillID": 29755,
"LastReceiptDate": "2025-07-23 17:36:00",
"LastReceiptID": 24994,
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePayments": [
{
"CodeId": 100,
"ConsumptionDate": "2025-07-25 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-25 14:00:00",
"PeriodDateTo": "2025-07-26 12:00:00",
"Price": "20.00",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 1,
"ServiceName": "Проживання Accomondtion",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"UsedQuantity": "0.000"
},
{
"CodeId": 113,
"ConsumptionDate": "2025-07-25 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-25 18:00:00",
"PeriodDateTo": "2025-07-25 22:00:00",
"Price": "140.00",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 212,
"ServiceName": "Вечеря/Dinner",
"ServiceSubClassCode": "",
"ServiceSubClassName": "",
"UsedQuantity": "0.000"
},
{
"CodeId": 111,
"ConsumptionDate": "2025-07-26 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-26 07:00:00",
"PeriodDateTo": "2025-07-26 12:00:00",
"Price": "200.00",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 210,
"ServiceName": "Сніданок / Breakfast",
"ServiceSubClassCode": "breakfast",
"ServiceSubClassName": "Завтрак",
"UsedQuantity": "0.000"
},
{
"CodeId": 112,
"ConsumptionDate": "2025-07-25 23:59:00",
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePaymentID": 132870,
"PeriodDateFrom": "2025-07-25 14:00:00",
"PeriodDateTo": "2025-07-25 16:00:00",
"Price": "140.00",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 211,
"ServiceName": "Обід/Dinner",
"ServiceSubClassCode": "dinner",
"ServiceSubClassName": "Обед",
"UsedQuantity": "0.000"
}
],
"PayAmount": "499.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 132870,
"PaymentReciepts": [
{
"CreateUser": {
"LoginID": 2,
"UserName": "Admin"
},
"Date": "2025-07-23 17:36:00",
"DepositID": null,
"FiscalID": 7,
"FiscalSessionID": 7875,
"PaidType": "Cash",
"PayGroupType": 0,
"PayTypeID": 2088,
"PayTypeName": "Готівка",
"PaymentSum": 499.00,
"ReceiptID": 24994,
"ReceiptPayTypeCode": "ГОТ",
"ReceiptPayTypeName": "Готівка",
"ReceiptPaytypeID": 2088,
"RoundingDelta": null,
"SumWithoutTax": 415.83,
"Taxes": [
{
"TaxName": "ПДВ 20%",
"TaxSum": "83,17",
"TaxWage": "0,2000000000"
}
]
}
],
}

</pre>

==GetUsers==
Отримання списку активних користувачів готелю.

'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// масив ідентифікаторів користувачів для фільтру. Якщо не вказано, то всі активні користувачі готелю
"UsersID": [1, 2, ...]
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1585726829983",
"VersionInfo": "0.1",
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"Users": [
{
"Email": "petrovich@gmail.com",
"Phone": "56556756",
"UserID": 372,
"UserName": "Петров Петро Петрович"
}
]
}
]
}
</pre>

==GetCompanies==
Отримання списку відкритих компаній.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// масив ідентифікаторів компаній для фільтру. Якщо не вказано, то всі відкриті компанії
"CompaniesID": [1, 2, ...]
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1585727691299",
"VersionInfo": "0.1",
"Companies": [
{
"CompanyID": 2,
"CompanyName": "__Relax",
"Email": "sdasd@sdasd.ru",
"Phone": "123123"
}
]
}
</pre>

==GetActivitiesModified==
Отримання списку заходів.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// дата з часом, показувати заходи, зміни у яких сталися після вказаного часу
"ModifiedDateFrom": "2019-11-12 12:33:45",\
"ModifiedDateTo": "2020-11-12 12:33:45",
// необов’язковий фільтр за ідентифікаторами заходів
"ActivitiesID": [1, ...],
// статуси заходів (-2, -1, 0, 3)
"ActivityStatus": [0, ...],
// необов’язковий фільтр за ідентифікаторами груп
"GroupsID": [1, ...],
// отримувати вартість, за замовчуванням ні
"isNeedCostInfo": 0,
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses": [""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses": [""],
// комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["Name", "Phone", "Email", "AccountNumber"]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1595322549800",
"VersionInfo": "0.1",
"Hotels": [
{
"Activities": [
{
"ActivityID": 405,
"ActivityName": "Мангал",
"ActivityTypeID": 1,
"ActivityTypeName": "Мангал 1",
"Adults": 1,
"Childs": 0,
"Comment": "",
"Company": null,
"ContactName": "",
"Cost": "388.66",
"Country": null,
"DecisionDate": "",
"Email": "",
"EndDate": "2012-06-08 02:00:00",
"GroupID": null,
"InfoSourceID": 1,
"InfoSourceName": "Реклама",
"Manager": {
"Email": "",
"Phone": "4242",
"UserID": 1,
"UserName": "Адмін"
},
"OperatorCompany": {
"CompanyID": 314,
"CompanyName": "",
"CompanyPrintCode": "",
"CompanyPrintName": "",
"CompanyPrintSertificate": "",
"Email": "",
"ITN": "",
"Phone": "",
"SegmentID": null,
"SegmentName": "",
"IndustryID": null,
"IndustryName": ""
},
"Payments": [
{
"ConsumptionDate": "2012-06-08 02:00:00",
"IsCanceled": false,
"IsPackagePayment": false,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 556721,
"PaymentStatus": 0,
"PaymentType": 4,
"Price": "388.66",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживання",
"ServiceId": 89579,
"ServiceName": "Проживання",
"Tax2Name": "Акцизний збір",
"Tax2Rate": "0.18",
"Tax2Sum": "59.29",
"TaxName": "ПДВ 18%",
"TaxRate": "0.20",
"TaxSum": "54.90",
"UsedQuantity": ""
}
],
"Phone": "",
"PaidTypeID": 1,
"PaidTypeName": "Готівка",
"PayStatus": 1,
"CreationLoginID": 2,
"PrepareTypeID": null,
"PrepareTypeName": null,
"PriceList": {
"PriceListID": 24,
"PriceListName": "Peggy",
"Description": "",
"IsChargeBonuses": false,
"IsForInternet": false,
"IsNonReturnRate": false,
"IsRackRate": false,
"IsSpecRate": false
},
"ReservationTypeID": 1,
"StartDate": "2012-06-05 08:00:00",
"StatusID": 0,
"StatusName": "Активне"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}
Прайс-лист та сутності країн виглядають наступним чином:

Country: {"CountryID":int, "CountryName":string, "CountryISO2":string, "CountryISO3":string}PriceList: {"PriceListID":int, "PriceListName":string}

</pre>

==GetGroupsModified==
Отримання списку груп.
'''Вхідні параметри:'''
<pre>
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// дата з часом, показувати групи, зміни у яких сталися після вказаного часу
"ModifiedDateFrom": "2019-11-12 12:33:45",
"ModifiedDateTo": "2020-11-12 12:33:45",
// статуси груп (-3, -2, -1, 0, 1)
"GroupStatus": [0, ...],
// необов’язковий фільтр за ідентифікаторами груп
"GroupsID": [1, ...],
// отримувати вартість, за замовчуванням ні
"isNeedCostInfo": 0,
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses": [""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses": [""],
// комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["Name", "Phone", "Email", "AccountNumber"]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1595328964995",
"VersionInfo": "0.1",
"Hotels": [
{
"Groups": [
{
"Activities": [
571,
572,
573
],
"Adults": 5,
"CanceledReason": null,
"Childs": 0,
"ChildsPay": 0,
"Comment": "",
"Company": null,
"ContactName": "",
"Cost": "650.00",
"Country": null,
"DecisionDate": "",
"Email": "",
"EndDate": "2012-06-30 12:00:00",
"GroupID": 717,
"GroupName": "sdvsdvsd",
"Guests": [
28571,
28572,
28573
],
"InfoSourceID": null,
"InfoSourceName": "",
"Manager": null,
"ManagerID": 403,
"PaidTypeID": 1,
"PaidTypeName": "Готівка",
"PersReservation": 2,
"OperatorCompany": {
"CompanyID": 285,
"CompanyName": "Google",
"CompanyPrintCode": "6756777777",
"CompanyPrintName": "Google",
"CompanyPrintSertificate": "",
"Email": "",
"ITN": "125154452115",
"Phone": "",
"SegmentID": null,
"SegmentName": "",
"IndustryID": null,
"IndustryName": ""
},
"PriceList": {
"Description": "",
"IsChargeBonuses": false,
"IsForInternet": false,
"IsNonReturnRate": false,
"IsRackRate": false,
"IsSpecRate": false,
"PriceListID": 24,
"PriceListName": "Peggy"
},
"Payments": [
{
"ConsumptionDate": "2012-06-30 12:00:00",
"IsCanceled": false,
"IsPackagePayment": true,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 303327,
"PaymentStatus": 0,
"PaymentType": 2,
"Price": "650.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживання",
"ServiceId": 1,
"ServiceName": "Проживання Pack",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживання",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxRate": "",
"TaxSum": "",
"UsedQuantity": ""
}
],
"Phone": null,
"PriceList": {
"PriceListID": 31,
"PriceListName": "Raquel8"
},
"ReservationTypeID": 2,
"StartDate": "2012-06-21 14:00:00",
"StatusID": 0,
"StatusName": "Активна"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}
</pre>

==UpdateGuest==
Оновлення інформації про гостя.
'''Вхідні параметри:'''
<pre>
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"GuestID":29177,
"Comment":"",
"UpdateFields":{
"ClientsToAdd":[49060],
"ClientsToDelete":[1,2]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,

}
</pre>

==AddClient==
Додавання нової анкети.
'''Вхідні параметри:'''
<pre>
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"LastName":"External", //обязательное поле
"Iso3Country":"UKR", //обязательное поле
"Sex":true,
"FirstName":"Service",
"MiddleName":"Test",
"BirthDay":"1991-02-02",
"AdultOrChild":false,
"Address":"Kiev, Yangelya 39a",
"ClubCardNumber":1,
"Email":"user@test.com",
"Phone":"0991112233",
"BlackList":true,
"VIP":true,
"Preferences":[{
"Code":"carnumber",
"Value":""
}],
"Documents": [
{
"DocumentDateEnd": "2050-02-02",
"DocumentDateIssue": "1991-02-02",
"DocumentNumber": "000000",
"DocumentSeries": "uu",
"DocumentType": "Passport",//обязательное поле
"IIN": "3333333333"
}
]
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,

}
</pre>
*перелік можливих значень поля DocumentType
<pre>
•Passport
•InternationalPassport
•ServicePassport
•DiplomaticPassport
•CertificationSoldier
•SeamanPassport
•MilitaryID
•DrivingLicence
•TemporaryIdentityCard
•ForeignCitizenPassport
•BirthCertificate
•IdentityCard
•InternationalPassportNew
•InternationalBirthCertificate
•ExternalInternationalPassport
•UssrPassport
•ExternalBirthCertificate
•ForeignBirthCertificate
•TemporaryAsylumCertificate
•CisCitizenIdentityCard
•ForeignCitizenServicePassport
•NationalForeignCitizenPassport
•TemporaryAsylumReview
</pre>

==UpdateClient==
Оновлення інформації по анкеті.
'''Вхідні параметри:'''
<pre>
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"ClientID":49060,
"UpdateFields":{
"LastName":"External",
"Iso3Country":"UKR",
"Sex":true,
"FirstName":"Service",
"MiddleName":"Test",
"BirthDay":"1991-02-02",
"AdultOrChild":false,
"Address":"Kiev, Yangelya 39a",
"ClubCardNumber":1,
"Email":"user@test.com",
"Phone":"0991112233",
"BlackList":true,
"VIP":true,
"Preferences":[{
"Code":"carnumber",
"Value":""
}]
}
}
</pre>
'''Значення, що повертається:'''
<pre>
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,

}
</pre>

==GetPriceListPrices==
Отримання інформації про ціни послуг прайс-листів.

'''Вхідні параметри:'''
<pre>
int[] PriceListIDs – масив ідентифікаторів прейскурантів. Обов’язковий параметр.
string[] ServiceClassCodes – масив кодів класів послуг, за якими потрібні ціни. Обов’язковий параметр.
date ConsumptionDate – дата споживання. Обов’язковий параметр.
int CustomerType – тип споживача в готельній системі, для якого розраховуються ціни послуг. Обов’язковий параметр.
string[] ServiceSubClassExcludeCodes – масив кодів підкласів послуг, за якими не повертати ціни. Необов’язковий параметр.
int[] ServiceIDs – ідентифікатори послуг, для яких повертати ціни. Необов’язковий параметр.
string[3] Valute – код валюти, у якій повертати ціни. Якщо не вказано, ціни будуть розраховані у валюті послуги.
Conditionals – умови для підбору тарифу послуг, необов’язковий параметр. Структура зі наступними полями:
int TermActivity – тип заходу
int TermAdultCount – кількість дорослих
int TermChildPaidCount – кількість дітей з оплатою
int TermMealType – тип харчування
int TermPlacesAdditionalCount – кількість додаткових місць
int TermPlacesCount – кількість місць
int TermRoomType – категорія номера
bool TermWayOfSettlement – тип поселення: true – по місцях, false – номер цілком

{
"Credentials":{"UserName":"artemis","Password":"123"},
"PriceListIDs":[1,2296],
"ServiceClassCodes":["dwelling","conference","eat"],
"ConsumtionDate":"2021-06-11",
"CustomerType":1,
"ServiceSubClassExcludeCodes":["breakfast"],
"ServiceIDs":[1],
"Valute":"USD",
"Conditionals":{
"TermActivity":1,
"TermAdultCount":1,
"TermChildPaidCount":1,
"TermMealType":1,
"TermPlacesAdditionalCount":1,
"TermPlacesCount":1,
"TermRoomType":1,
"TermWayOfSettlement":false
}
}
</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час, коли почали формувати відповідь на сервері в UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
Hotels[] – масив результатів по готелях. Структура з такими параметрами:
HotelInformation – інформація по готелю. Структура з такими полями:
int HotelID – ідентифікатор готелю
string HotelName – назва готелю
string HotelShortName – коротка назва готелю
PriceLists[] – список прейскурантів. Структура з такими полями:
int PriceListID – ідентифікатор прейскуранта
string PriceListName – назва прейскуранта
Services[] – список послуг прейскуранта. Структура з такими полями:
int ServiceId – ID послуги
string ServiceName – назва послуги
string ServiceClassCode – код класу послуги
string ServiceSubClassCode – код підкласу послуги
decimal Price – ціна послуги
string Currency – валюта
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1623419232509",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"PriceLists": [
{
"PriceListID": 1,
"PriceListName": "Bennie933",
"Services": [
{
"Currency": "USD",
"Price": "5.79",
"ServiceClassCode": "dwelling",
"ServiceId": 1,
"ServiceName": "Проживання Pack",
"ServiceSubClassCode": "dwelling"
}
]
}
]
}
]
}
</pre>

==SearchClients==
Отримання списку анкет.

'''Вхідні параметри:'''
<pre>
date ModifiedDateFrom – дата останньої зміни анкети
int[] ClientsID – масив ідентифікаторів анкет
string[] Phones – масив телефонних номерів
string[] Emails – масив електронних поштових скриньок
string[] LoyaltyCards – масив кодів карт лояльності
string FirstName – ім’я
string LastName – прізвище
string MiddleName – по батькові
string DocumentSeriesAndNumber – серія і номер документа без роздільників
string DocumentIIN – ІПН документа
bool Sex – стать
int MaxRecordsCount – максимальна кількість записів у відповіді
date BirthDay – дата народження
Preferences[] – масив вподобань. Структура з такими полями:
string Code – код вподобання
string Value – значення вподобання
ComplexSearch – комплексний пошук. Структура з такими полями:
string SearchString – значення для пошуку
string[] SearchObjects – масив полів, по яких виконується пошук
{
"Credentials":{"UserName":"artemis","Password":"123"},
"ClientsID" : [1,2296],
"Phones" :["123-33-55","0991112233"],
"Emails":["test@gmail.com"],
"LoyaltyCards":["123-33-55","0991112233"],
"FirstName":"Ivan",
"LastName":"Ivanov",
"MiddleName":"Ivanovich",
"DocumentSeriesAndNumber":"FF123123",
"DocumentIIN":"123534645",
"Sex": true,
"MaxRecordsCount": 5
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
Clients[] – список анкет, масив структур Client

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1647424120627",
"VersionInfo": "1.0.0.3",
"Clients": [
{
"Address": "",
"BirthDay": "",
"BlackList": true,
"ClientID": 648,
"Comment": "Like cars",
"Documents": [
{
"DocumentDateEnd": "",
"DocumentDateIssue": "",
"DocumentNumber": "",
"DocumentSeries": "",
"DocumentType": "DrivingLicence",
"INN": "",
}
],
"Email": "",
"FirstName": "Asdffff",
"GuestsID": [],
"LastName": "Dsf",
"MiddleName": "Asdf",
"Phone": "",
"Photo": null,
"PhotoURL": "~/img/photo_place.gif",
"Preferences": [
{
"Code": null,
"Name": "Хар1",
"PreferenceID": 47,
"Value": "wer"
},
{
"Code": null,
"Name": "уке",
"PreferenceID": 49,
"Value": "789"
},
{
"Code": null,
"Name": "кен",
"PreferenceID": 50,
"Value": "890"
},
{
"Code": null,
"Name": "123",
"PreferenceID": 51,
"Value": "123"
}
],
"Sex": true,
"VIP": true
}
]

</pre>

==GetBills==
Отримання інформації про рахунки.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
bool ForceSetAccepted – примусова відмітка про обробку, за замовчуванням true.
bool NotAcceptedOnly – тільки необроблені рахунки, за замовчуванням true.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
int[] Bills – масив ідентифікаторів рахунків, необов’язковий параметр.
int[] BillTypes – масив типів рахунків, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
BillPayers – платники, структура з такими полями:
short PayerType – тип платника, необов’язковий параметр
int[] PayerID – ідентифікатори платників, необов’язковий параметр
DateTime DateBillFrom – початкова дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateBillTo – кінцева дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModifiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModifiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime AcceptanceDateFrom – початкова дата діапазону дат актів, необов'язковий параметр (якщо не вказано – без обмежень)
DateTime AcceptanceDateTo – кінцева дата діапазону дат актів, необов'язковий параметр (якщо не вказано – без обмежень)
byte[] NomenclatureTypes – масив типів номенклатур, необов’язковий параметр

{
"Credentials":{"UserName":"loginName","Password":"password"},
"Hotels":[1,2],
"ForceSetAccepted":true,
"NotAcceptedOnly":true,
"OpenTaxPeriodOnly":false,
"Bills":[2451,2137],
"BillTypes":["Payment","Comission"],
"ServiceProviderID":[1,2,3],
"ServiceProviderFullName":["name1","name2"],
"BillPayers":{"PayerType":1, "PayerID":[1,2]},
"DateBillFrom":"2000-01-01",
"DateBillTo":"2000-01-01",
"DateModefiedBillFrom":"2000-01-01 00:00:00",
"DateModefiedBillTo":"2000-01-01 00:00:00",
"AcceptanceDateFrom": "2000-01-01",
"AcceptanceDateTo": "2000-01-01",
"NomenclatureTypes": [0, 1],
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel
SumWithoutTax - сумарна сума послуг, які не оподатковуються
SumWithTax - сумарна сума послуг, які оподатковуються
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654847287800",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Bills": [
{
"Account": "F0000029177",
"BillComment": "",
"BillCustomerID": 29177,
"BillCustomerTypeID": 1,
"BillDate": "2022-05-13 20:36:26",
"BillID": 132740,
"BillPayerID": 29177,
"BillPayerTypeID": 1,
"BillType": "Оплата|Комісія",
"CompanyPayerID": null,
"CreateUser": {
"LoginID": 372,
"UserName": "Роман Веснин"
},
"Currency": "UAH",
"CurrencyCourse": 1.0000000000000,
"PaymentsSum": "180,0000",
"ReceiptReturns": [],
"Receipts": [
{
"CreateUser": {
"LoginID": 372,
"UserName": "Роман Веснин"
},
"Date": "2022-05-13 20:39:00",
"DepositID": 2143,
"FiscalID": 1,
"FiscalSessionID": 147,
"PaidType": "None|Cash|Credit|Noncash|Bonus|Deposit",
"PayGroupType": 4,
"PayTypeID": 49,
"PayTypeName": "Депозит ГРН",
"ReceiptID": 136084,
"ReceiptPayTypeCode": "ДГР",
"ReceiptPayTypeID": 49,
"ReceiptPayTypeName": "Депозит ГРН",
"RoundingDelta": null,
"Sales": [
{ "#SaleObject": {} }
],
"Sum": 180.00,
"SumBeforeRounding": 180.00,
"SumWithTax": 0,
"SumWithoutTax": 180.00,
"Taxes": [
{
"TaxName": "ПДВ 18%",
"TaxSum": "21,1900000000000",
"TaxWage": "0,2000000000"
},
{
"TaxName": "Акцизний збір",
"TaxSum": "22,8800",
"TaxWage": "0,1800000000"
}
]
}
],
"ReceiptsSum": "180,0000",
"Sales": [
{
"Canceled": false,
"CanceledDate": "",
"Comment": null,
"Consumer": "F0000029177",
"ConsumerID": 29177,
"ConsumerTypeID": 1,
"ConsumptionDate": "2022-05-13 20:36:26",
"FiscalID": 1,
"LastReceiptID": 136084,
"PaidType": "Deposit",
"PayGroupTypeID": 4,
"PaymentID": 627246,
"PeriodDateFrom": "",
"PeriodDateTo": "",
"Price": "180,00",
"Quantity": "1,000",
"ReceiptPayTypeCode": "ДГР",
"ReceiptPayTypeID": 49,
"ReceiptPayTypeName": "Депозит ГРН",
"RestaurantBill": "",
"RestaurantReceipt": null,
"SecondTaxName": null,
"SecondTaxSum": "",
"SecondTaxType": null,
"SecondTaxWage": "",
"ServiceClassCode": "",
"ServiceClassID": null,
"ServiceClassName": "",
"ServiceCode": "453",
"ServiceID": 203,
"ServiceName": "Надбавка",
"ServiceSubClassCode": "",
"ServiceSubClassID": null,
"ServiceSubClassName": "",
"ServiceTypeID": 1,
"ServiceTypeName": "Основні послуги",
"TaxGroupCode": "TouristTax",
"TaxGroupID": 8,
"TaxGroupName": "Туристичний збір",
"TaxName": "",
"TaxSum": "",
"TaxWage": "",
"Taxed": false,
"Total": "180,00",
"AcceptanceDate": "2017-01-26 00:00:00"
}
],
"ServiceProviderID": 317
}
],
"Companies": [
{
"BranchOfficeCode": null,
"Code": "",
"CompanyID": 317,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"HousingID": 1,
"HousingName": "Головний корпус",
"FactualAddress": "",
"FullName": "Начисленька",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "12312312",
"LegalAddress": "",
"Name": "Начисленька",
"PhoneNumber": null,
"PostalAddress": "",
"TIN": "",
"VatCertificateNumber": "",
"CorporateManager": null
}
],
"Consumers": [
{
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000029177",
"ConsumerID": 29177,
"ConsumerTypeID": 1,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"CountryISO3": "BLR",
"CountryName": "Білорусь",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт"
}
],
"DeletedBills": [
100713,
123719,
129732
],
"FiscalDevices": [
{
"CashCode": "О11",
"FiscalID": 1,
"FiscalName": "О1-тест"
}
],
"FiscalSessions": [
{
"CloseBalance": "7970,0000",
"CloseDate": "2013-08-20 14:23:50",
"CloseUser": {
"LoginID": 411,
"UserName": "Цаплинов Євген"
},
"FiscalID": 147,
"FiscalSessionID": 221,
"OpenBalance": "7820,0000",
"OpenDate": "2013-08-20 09:01:07",
"OpenUser": {
"LoginID": 411,
"UserName": "Цаплинов Євген"
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"Payers": [
{
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"CountryISO3": "BLR",
"CountryName": "Білорусь",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"Payer": "F0000029177",
"PayerID": 29177,
"PayerTypeID": 1,
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт"
}
]
}
]
}

</pre>

==GetDepositAccounts==
Отримання інформації про депозитні рахунки.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
bool ForceSetAccepted – примусова відмітка про обробку, за замовчуванням true.
bool NotAcceptedOnly – тільки необроблені депозитні рахунки, за замовчуванням true.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
Owners – власники, структура з такими полями:
short OwnerTypeID – тип власника, необов’язковий параметр
int[] OwnerIDs – ідентифікатори власників, необов’язковий параметр
DateTime DateCreationFrom – початкова дата створення депозитного рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateCreationTo – кінцева дата створення депозитного рахунку, необов’язковий параметр (якщо не вказано – необмежено)
bool ModefiedReceiptsOnly – відображати тільки ті чеки, які створені в зазначений період змін (якщо false – показувати рахунки, які були змінені у вказаний період з усіма чеками, якщо true – відкидати чеки, що не входять у період), за замовчуванням true
DateTime DateModefiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModefiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
{
"Credentials":{"UserName":"loginName","Password":"password"},
"Hotels":[1,2],
"ForceSetAccepted":true,
"NotAcceptedOnly":true,
"OpenTaxPeriodOnly":false,
"ServiceProviderID":[1,2,3],
"ServiceProviderFullName":["name1","name2"],
"Owners":{"OwnerTypeID":1, "OwnerIDs":[1,2]},
"DateCreationFrom":"2000-01-01",
"DateCreationTo":"2000-01-01",
"ModefiedReceiptsOnly":false,
"DateModefiedBillFrom":"2000-01-01 00:00:00",
"DateModefiedBillTo":"2000-01-01 00:00:00"
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері в UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654849559948",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "",
"CompanyID": 1,
"FactualAddress": "71 Old Boulevard",
"FullName": "Janice2",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "ZYR",
"LegalAddress": "751 Green Milton Road",
"Name": "NCT",
"PhoneNumber": null,
"PostalAddress": "284 Green Second Blvd.",
"TIN": "543452",
"VatCertificateNumber": "ANZI9JXDF",
"СorporateManager": null
},
],
"Consumers": [
{
"ArrivalDate": "2012-04-12 15:04:48",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000028048",
"ConsumerID": 28048,
"ConsumerTypeID": 1,
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Анка",
"PriceListName": "__AFT",
"RoomNumber": "18104",
"RoomTypeName": "Стандарт"
}
],
"DepositAccounts": [
{
"AccountCode": null,
"Balance": "600,0000",
"CompanyAgentID": null,
"Currency": "UAH",
"DateCreated": "2013-06-21 15:28:52",
"DepositAccount": 2,
"OwnerName": "Dsf Asdffff Asdf",
"OwnerTypeID": 0,
"Receipts": [
{#ReceiptObject#}
],
"ReceiptsReturns": [
{#ReceiptObject#}
],
"Requisites": "2",
"ServiceProviderID": 1
}
],
"FiscalDevices": [
{
"CashCode": "О31 ",
"FiscalID": 6,
"FiscalName": "О3-test tk"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Отель 1",
"HotelShortName": "О1"
}
}
]
}

</pre>

==GetFiscalSessions==
Отримання інформації про фіскальні сесії.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
int[] Fiscals – масив ідентифікаторів касових апаратів, необов’язковий параметр.
string[] CashBox – масив кодів кас у довідниках кас Servio HMS, необов’язковий параметр.
bool ForceSetAccepted – примусова відмітка про обробку, за замовчуванням true.
bool NotAcceptedOnly – тільки необроблені рахунки, за замовчуванням true.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
string DateSessionType – вказує варіант контролю дат: за відкриттям або закриттям зміни.
bool CloseSessionOnly – тільки закриті зміни, необов’язковий параметр.
DateTime DateSessionFrom – початкова дата фіскальної сесії, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateSessionTo – кінцева дата фіскальної сесії, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModefiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateModefiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
DateTime DateReceiptFrom – початкова дата оплати чека (необов’язковий параметр)
DateTime DateReceiptTo – кінцева дата оплати чека (необов’язковий параметр)
byte[] NomenclatureTypes – масив типів номенклатур, необов’язковий параметр
{
"Credentials":{"UserName":"loginName","Password":"password"},
"Hotels": [1,2],
"Fiscals":[1,2],
"CashBox":["100"],
"ForceSetAccepted":true,
"NotAcceptedOnly":true,
"OpenTaxPeriodOnly":false,
"ServiceProviderID":[1,2,3],
"ServiceProviderFullName":["name1","name2"],
"DateSessionType":"OpenDate|CloseDate",
"CloseSessionOnly":true,
"DateSessionFrom":"2000-01-01 00:00:00",
"DateSessionTo":"2000-01-01 00:00:00",
"DateModefiedBillFrom":"2000-01-01 00:00:00",
"DateModefiedBillTo":"2000-01-01 00:00:00",
"NomenclatureTypes": [0, 1],
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "6756777777",
"CompanyID": 285,
"FactualAddress": "",
"FullName": "Google",
"IsOperator": true,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": false,
"KPP": "1251254552",
"LegalAddress": "",
"Name": "Google",
"PhoneNumber": "",
"PostalAddress": "",
"TIN": "125154452115",
"VatCertificateNumber": "",
"CorporateManager": 419
}
],
"Consumers": [
{
"ArrivalDate": "2013-01-10 14:23:43",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000027742",
"ConsumerID": 27742,
"ConsumerTypeID": 1,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2013-01-12 12:00:00",
"Name": "Бугогагов Сергій",
"PriceListName": "__AFT",
"RoomNumber": "201",
"RoomTypeName": "Стандарт"
}
],
"FiscalDevices": [
{
"CashCode": "К03",
"FiscalID": 28,
"FiscalName": "О1-Каса 03"
}
],
"FiscalSessions": [
{
"CloseBalance": "200.0000",
"CloseDate": "2013-05-31 16:30:00",
"CloseUser": {
"LoginID": 2,
"UserName": "Ім’я"
},
"FiscalDeviceID": 28,
"FiscalSessionID": 198,
"OpenBalance": "0.0000",
"OpenDate": "2012-04-05 10:30:00",
"OpenUser": {
"LoginID": 2,
"UserName": "Ім’я"
},
"Receipts": [
{ "#ReceiptObject": {} }
],
"ReceiptsReturns": [
{ "#ReceiptObject": {} }
],
"TotalReceipts": {
"ReceiptReturns": [
{
"FiscalReceiptTypeID": 2,
"FiscalReceiptTypeName": "Чек повернення оплати",
"ReceiptPaidTypeID": 4,
"ReceiptPaidTypeName": "Безготівковий",
"Sum": 110.00
}
],
"Receipts": [
{
"FiscalReceiptTypeID": 1,
"FiscalReceiptTypeName": "Чек на оплату",
"ReceiptPaidTypeID": 4,
"ReceiptPaidTypeName": "Безготівковий",
"Sum": 200.00
}
],
"TotalSum": 200.00
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}

</pre>

==AcceptSet==
Встановлення позначки про обробку.

'''Вхідні параметри:'''
<pre>
int[] Bills – ідентифікатори оброблених рахунків, необов’язковий параметр.
int[] DepositAccounts – ідентифікатори оброблених депозитних рахунків, необов’язковий параметр.
int[] FiscalSessions – ідентифікатори оброблених фіскальних сесій, необов’язковий параметр.
DateTime Date – дата і час обробки у UTC, якщо не вказано — поточний час.
DateTime RequestDate - дата й час запиту документів в UTC, необов’язковий параметр.

{
"Credentials":{"UserName":"loginName","Password":"password"},
"Bills":[1,2],
"DepositAcounts":[17,18],
"FiscalSessions":[5],
"Date":"2021-06-10 10:25:43",
"RequestDate": "2021-06-10 09:56:46"
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1652080021398",
"VersionInfo": "1.0.0.3"
}

</pre>

== PayToHMS ==
Імпорт оплати з бухгалтерії.

'''Вхідні параметри:'''
<pre>
PayBindings[] – список платіжних доручень, масив структур PayBinding, необов’язковий параметр.
ReturnPayBindings[] – список повернень платіжних доручень, масив структур ReturnPayBinding, необов’язковий параметр.
DeletedPayDoxes[] – список видалених платіжних доручень, масив структур DeletedPayDox, необов’язковий параметр.
{
"Credentials": {
"UserName": "loginName",
"Password": "password"
},
"PayBindings": [
{
"PayConfirmedDate": "2022-05-11 15:20:00",
"Store": "Готель 1",
"Agent": "Гість2",
"BillID": "00000023572",
"Account": "F0000004061",
"PaySum": "40,00",
"BillSum": "126,00",
"Org": "",
"VAT": "20%",
"VATSum": "8,00",
"Doc": "",
"SDDS": "Оплата ресторану",
"Currency": 980,
"TIN": "",
"Code": "",
"NonResident": "false",
"PaymentDescription": "Опис",
"DocRowNumber": 2,
"DocComment": "коментар",
"DocAuthor": "Автор",
"DocNumber": "00000050065",
"BankNumber": "1400790",
"BankDate": "2022-05-10 14:00:00",
"AgentBankAccount": "26000070010005",
"DepositAccount": "",
"AccountCode1C": ""
}
],
"ReturnPayBindings": [
{
"PayConfirmedDate": "2022-05-11 20:00:00",
"Agent": "Компанія47",
"BillID": "00000003873",
"Account": "C0000000275",
"ReturnPaySum": "5800,00",
"Org": "Ілона",
"VAT": "20%",
"VATSum": "1160,00",
"Doc": "",
"SDDS": "Обслуговування",
"Currency": 980,
"TIN": "231444444412",
"Code": "372345234523",
"NonResident": "true",
"PaymentDescription": "",
"DocRowNumber": 1,
"DocComment": "",
"DocAuthor": "Автор",
"DocNumber": "00000050041",
"BankNumber": "360915",
"BankDate": "2022-05-11 14:00:00",
"AgentBankAccount": "140045926505",
"DepositAccount": "",
"AccountCode1C": ""
}
],
"DeletedPayDoxes": [
{
"DocNumber": "00000050050",
"DocDate": "2022-05-10 12:00:00"
}
]
}
</pre>

'''Структура PayBinding''':
<pre>
PayConfirmedDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
Store (Рядок 50) – склад зі рахунку на оплату (готель).
Agent (Рядок 100) – контрагент. Не використовується.
BillID (Рядок 11) – номер рахунку на оплату (містить провідні нулі). Необов’язковий, якщо використовується DepositAccount.
Account (Рядок 11) – номер договору. Не використовується.
PaySum (Число 15,2) – сума платежу.
BillSum (Число 15,2) – сума рахунку на оплату (сума взаєморозрахунків).
Org (Рядок 50) – організація. Не використовується.
VAT (Перерахування: 0%, БезПДВ, 20%, НеПДВ) – ставка ПДВ. Не використовується.
VATSum (Число 15,2) – сума ПДВ. Не використовується.
Doc (Рядок 255) – текстове подання ПД. Не використовується.
SDDS (Рядок 100) – стаття руху грошових коштів. Не використовується.
Currency (Число 3) – ISO номер валюти.
TIN (Рядок 12) – ІПН контрагента.
Code (Рядок 12) – код за ЄДРПОУ контрагента.
NonResident (Логічне True/False) – ознака нерезидента.
PaymentDescription (Рядок 255) – призначення платежу. Не використовується.
DocRowNumber (Число) – номер рядка в ПД. Не використовується.
DocComment (Рядок 255) – коментар ПД. Не використовується.
DocAuthor (Рядок 100) – автор ПД. Не використовується.
DocNumber (Рядок 11) – номер ПД.
BankNumber (Рядок 30) – номер платежу в банківській виписці (за нумерацією контрагента).
BankDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платежу в банківській виписці.
AgentBankAccount (Рядок 50) – банківський рахунок контрагента. Не використовується.
DepositAccount (Число 12) – номер депозитного рахунку в системі HMS Servio, з якого проводилася оплата послуг. Необов’язковий, якщо використовується BillID.
AccountCode1C (Рядок 9) – код елемента у довіднику договорів 1С для ідентифікації депозитних рахунків.
</pre>
'''Структура ReturnPayBinding:'''
<pre>
PayConfirmedDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
Agent (Рядок 100) – контрагент. Не використовується.
BillID (Рядок 11) – номер рахунку на оплату (містить провідні нулі). Необов’язковий, якщо використовується DepositAccount.
Account (Рядок 11) – номер договору. Не використовується.
ReturnPaySum (Число 15,2) – сума повернення платежу.
Org (Рядок 50) – організація. Не використовується.
VAT (Перерахування: 0%, БезПДВ, 20%, НеПДВ) – ставка ПДВ. Не використовується.
VATSum (Число 15,2) – сума ПДВ. Не використовується.
Doc (Рядок 255) – текстове подання ПД. Не використовується.
SDDS (Рядок 100) – стаття руху грошових коштів. Не використовується.
Currency (Число 3) – ISO номер валюти.
TIN (Рядок 12) – ІПН контрагента.
Code (Рядок 12) – код за ЄДРПОУ контрагента.
NonResident (Логічне True/False) – ознака нерезидента.
PaymentDescription (Рядок 255) – призначення платежу. Не використовується.
DocRowNumber (Число) – номер рядка в ПД. Не використовується.
DocComment (Рядок 255) – коментар ПД. Не використовується.
DocAuthor (Рядок 100) – автор ПД. Не використовується.
DocNumber (Рядок 11) – номер ПД.
BankNumber (Рядок 30) – номер платежу в банківській виписці (за нумерацією контрагента).
BankDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платежу в банківській виписці.
AgentBankAccount (Рядок 50) – банківський рахунок контрагента. Не використовується.
DepositAccount (Число 12) – номер депозитного рахунку в системі HMS Servio, з якого проводилася оплата послуг. Необов’язковий, якщо використовується BillID.
AccountCode1C (Рядок 9) – код елемента у довіднику договорів 1С для ідентифікації депозитних рахунків.
</pre>
'''Структура DeletedPayDox:'''
<pre>
DocNumber (Рядок 11) – номер ПД.
DocDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
</pre>

'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки

{
"ErrorCode":0,
"ErrorText":"",
"RequestTime":"1652080021476",
"VersionInfo":"1.0.0.3"
}

</pre>

==GetPaymentsDelivery==
Отримання інформації про нарахування на доставку. 

Параметри: авторизаційні дані, готелі, ідентифікатори нарахувань, коди класів послуг, коди груп послуг, початкова дата створення нарахування (не раніше). 
Додаткові фільтри послуг (передаються послуги, які відповідають принаймні одному фільтру; порожній фільтр не обробляється; якщо всі фільтри порожні — передаються всі послуги). 

'''Вхідні параметри:'''
<pre>
{
"Credentials":{"UserName":"admin","Password":"expert"},
"Hotels":[1],
"ServiceIDs":[1,2],
"ServiceClassCodes":["eat"],
"ServiceGroupCodes":["delivery"],
"DatePaymentFrom":"2022-09-30 13:00:00"
}

</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1664796014427",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Guests": [
{
"Guest": {
"Adults": 0,
"ArrivalDateTime": "0001-01-01 00:00:00",
"CancelReasonID": null,
"CancelReasonName": null,
"CancelReasonString": null,
"Childs": 0,
"ChildsPay": 0,
"Clients": [],
"Company": null,
"CompanyID": null,
"Cost": null,
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "",
"DateTimeReservation": "0001-01-01 00:00:00",
"DateTimeSettle": "",
"DepartureDateTime": "0001-01-01 00:00:00",
"Email": null,
"GroupID": null,
"GuestID": 162177,
"GuestName": "Максим Воронцов",
"GuestStatus": 0,
"IdentityCards": [],
"ManagerActivities": [],
"ManagerID": null,
"NightsCount": 0,
"Notes": [],
"OperatorCompany": null,
"PaidTypeID": null,
"PaidTypeName": null,
"PayStatus": null,
"Payments": [
{
"ConsumptionDate": "2022-09-30 13:05:00",
"IsCanceled": false,
"IsPackagePayment": false,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 631433,
"PaymentStatus": 0,
"PaymentType": 1,
"Price": "45.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 436,
"ServiceName": "Стейк в номер",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ7",
"TaxRate": "0.07",
"TaxSum": "2.94",
"UsedQuantity": ""
},
{
"ConsumptionDate": "2022-09-30 13:05:00",
"IsCanceled": false,
"IsPackagePayment": false,
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 631435,
"PaymentStatus": 0,
"PaymentType": 1,
"Price": "80.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "eat",
"ServiceClassName": "Харчування",
"ServiceId": 437,
"ServiceName": "Аперитив Віола",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ7",
"TaxRate": "0.07",
"TaxSum": "5.23",
"UsedQuantity": ""
}
],
"PersCancelation": null,
"PersDeparture": null,
"PersReservation": null,
"PersSettle": null,
"Phone": "",
"Preferences": [],
"PriceList": null,
"PriceListID": 0,
"PriceListName": null,
"ReservationTypeID": null,
"ReservationTypeName": null,
"SourceCode": null,
"TourOperatorID": null,
"UTMParameters": null,
"Vip": null
},
"Room": {
"Building": null,
"Checkup": null,
"CleanStatus": null,
"Floor": null,
"RoomId": 0,
"RoomNumber": "1852 Стандарт",
"RoomStatus": null,
"RoomType": null,
"SaleStatus": null
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}

</pre>

==GetRevenueInfo==
Отримання статистичних даних. 

Параметри: авторизаційні дані, готелі, ідентифікатори нарахувань, дати початку та кінця періоду. 

'''Вхідні параметри:'''
<pre>
{
"Credentials": {"UserName": "UserName","Password": "Password"},
"Hotels": [3],
"DateFrom": "2023-01-08",
"DateTo": "2023-01-20",
"ExtractClasses": ["eat", "wash", "minibar"],
"ExtractSubClasses": ["restaurant", "breakfast"]
}

</pre>
'''Значення, що повертається:'''
<pre>
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1700750126101",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"HotelID": 3,
"HotelName": "Готель 3",
"RoomTypesRevenue": [
{
"GuestArrivals": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestDeparts": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestOccupancy": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0,
"ClientNights": 0
},
"Revenue": {
"Details": [
{
"Code": "eat",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "wash",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "minibar",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "restaurant",
"IsSubClass": true,
"SubTotal": 0.00
},
{
"Code": "breakfast",
"IsSubClass": true,
"SubTotal": 0.00
}
],
"Dwelling": 0.00,
"Other": 0.00,
"Total": 0.00
},
"RoomTypeOccupancy": {
"AllRooms": 90,
"OcupRooms": 0.00,
"Ordering": 2,
"RoomTypeID": 37,
"RoomTypeName": "Люкс",
"RoomTypeNameShort": "Л",
"RoomsInSale": 90,
"RoomsOnRepairNotSale": 0
}
},
{
"GuestArrivals": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestDeparts": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0
},
"GuestOccupancy": {
"ChildCount": 0,
"ChildPaidCount": 0,
"ClientCount": 0,
"Guests": 0,
"ClientNights": 0
},
"Revenue": {
"Details": [
{
"Code": "eat",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "wash",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "minibar",
"IsSubClass": false,
"SubTotal": 0.00
},
{
"Code": "restaurant",
"IsSubClass": true,
"SubTotal": 0.00
},
{
"Code": "breakfast",
"IsSubClass": true,
"SubTotal": 0.00
}
],
"Dwelling": 0.00,
"Other": 0.00,
"Total": 0.00
},
"RoomTypeOccupancy": {
"AllRooms": 270,
"OcupRooms": 0.00,
"Ordering": 0,
"RoomTypeID": 4061,
"RoomTypeName": "Стандарт 3М",
"RoomTypeNameShort": "Ст3",
"RoomsInSale": 270,
"RoomsOnRepairNotSale": 0
}
}
]
}
]
}

</pre>

==GetBillsGroupedSales==
Отримання інформації про рахунки зі згрупованими нарахуваннями.

'''Вхідні параметри:'''
<pre>
int[] Hotels – масив номерів готелів.
bool ForceSetAccepted – примусова відмітка про обробку.
bool NotAcceptedOnly – тільки необроблені рахунки.
bool OpenTaxPeriodOnly – обмежувати за датою закриття податкового періоду.
int[] Bills – масив ідентифікаторів рахунків, необов’язковий параметр.
int[] BillTypes – масив типів рахунків, необов’язковий параметр.
int[] ServiceProviderID – масив ідентифікаторів постачальників послуг, необов’язковий параметр.
string[] ServiceProviderFullName – масив назв постачальників послуг, необов’язковий параметр.
DateTime DateBillFrom – початкова дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено).
DateTime DateBillTo – кінцева дата створення рахунку, необов’язковий параметр (якщо не вказано – необмежено).
DateTime DateModefiedBillFrom – початкова дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено).
DateTime DateModefiedBillTo – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено).

{
"Credentials": { "UserName": "paRiin", "Password": "Qcds3#fds" },
"Hotels": [1,3],
"NotAcceptedOnly": false,
"ForceSetAccepted": true,
"OpenTaxPeriodOnly": false,
"Bills": [164370, 164375],
"BillTypes": ["Payment", "Comission"],
"ServiceProviderID": [341,100],
"ServiceProviderFullName": ["Хотел Груп Лтд", "Молнар"],
"DateBillFrom": "2023-05-29 14:17:53",
"DateBillTo": "2023-10-17 21:46:18",
"DateModefiedBillFrom": "2023-09-26 16:23:10",
"DateModefiedBillTo": "2023-09-29 05:51:32"
}

</pre>
'''Значення, що повертається:'''
<pre>
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
DateTime RequestDate - дата й час запиту документів в UTC
Hotels[] – список готелів, масив структур Hotel.
HotelInformation – інформація по готелю. Структура з полями:
int HotelID – ідентифікатор готелю
string HotelName – назва готелю
string HotelShortName – коротка назва готелю
FiscalSessions[] – список фіскальних сесій FiscalSession. Структура з полями:
int FiscalSessionID – ідентифікатор сесії
int FiscalID – ідентифікатор каси
DateTime? OpenDate – дата відкриття зміни
DateTime? CloseDate – дата закриття зміни
UserInfo OpenUser – користувач, який відкрив зміну. Структура UserInfo:
int LoginID – ідентифікатор користувача
string UserName – ім’я користувача
UserInfo CloseUser – користувач, який закрив зміну
decimal? OpenBalance – баланс каси на момент відкриття зміни
decimal? CloseBalance – баланс каси на момент закриття зміни
FiscalDevices[] – список кас FiscalDevice. Структура з полями:
int FiscalID – ідентифікатор каси
string CashCode – код каси
string FiscalName – назва каси
Consumers[] – список споживачів Consumer. Структура з полями:
DateTime? ArrivalDate – дата заїзду
string BookingSource – джерело бронювання
int? CompanyOperatorID – ідентифікатор компанії-оператора
string Consumer – особовий рахунок
int ConsumerID – ідентифікатор споживача
int ConsumerTypeID – тип споживача
string CountryISO3 – код країни
string CountryName – назва країни
DateTime? DepartureDate – дата виїзду
string Name – назва споживача
string PriceListName – назва прейскуранта
string RoomNumber – номер кімнати
string RoomTypeName – назва категорії
Payers[] – список платників Payer. Структура з полями:
DateTime? ArrivalDate – дата заїзду
string BookingSource – джерело бронювання
int? CompanyOperatorID – ідентифікатор компанії-оператора
string CountryISO3 – код країни
string CountryName – назва країни
DateTime? DepartureDate – дата виїзду
string Name – назва платника
string Payer – особовий рахунок
int PayerID – ідентифікатор платника
int PayerTypeID – тип платника
string PriceListName – назва прейскуранта
string RoomNumber – номер кімнати
string RoomTypeName – назва категорії
Companies[] – список компаній Company. Структура з полями:
string BranchOfficeCode – код філії
string Code – код компанії
int CompanyID – ідентифікатор компанії
string FactualAddress – фактична адреса
string FullName – повна назва
bool IsOperator – ознака компанії-оператора
bool IsPayer – ознака платника
bool IsResident – ознака резидента
bool IsServiceProvider – ознака постачальника послуг
string KPP – КПП
string LegalAddress – юридична адреса
string Name – назва
string PhoneNumber – номер телефону
string PostalAddress – поштова адреса
string TIN – ІПН
string VatCertificateNumber – номер свідоцтва ПДВ
string CorporateManager – корпоративний менеджер
int[] DeletedBills – список видалених рахунків
Bills[] – список рахунків Bill. Структура з полями:
int BillID – ідентифікатор рахунку
DateTime BillDate – дата рахунку
string BillType – тип рахунку
int? CompanyPayerID – ідентифікатор компанії-платника
int ServiceProviderID – ідентифікатор постачальника послуг
string Account – особовий рахунок споживача
string Currency – назва валюти рахунку
decimal CurrencyCourse – курс валюти
string BillComment – коментар до рахунку
int BillCustomerID – ідентифікатор споживача
int BillCustomerTypeID – тип споживача
int BillPayerID – ідентифікатор платника
int BillPayerTypeID – тип платника
decimal PaymentsSum – сума нарахувань
decimal ReceiptsSum – сума оплат
UserInfo CreateUser – користувач, який створив рахунок
Sale[] Sales – список нарахувань Sale. Структура з полями:
decimal Price – ціна нарахування
decimal Quantity – кількість
decimal Total – вартість
int Consumers – кількість споживачів
DateTime PeriodDateFrom – дата початку періоду споживання
DateTime PeriodDateTo – дата кінця періоду споживання
bool Canceled – відмітка скасування
int ServiceID – ідентифікатор послуги
string ServiceName – назва послуги
int? ServiceCode – код послуги
int? ServiceTypeID – ідентифікатор групи послуги
string ServiceTypeName – назва групи
int? ServiceClassID – ідентифікатор класу послуги
string ServiceClassName – назва класу
string ServiceClassCode – код класу
int? ServiceSubClassID – ідентифікатор підкласу
string ServiceSubClassName – назва підкласу
string ServiceSubClassCode – код підкласу
bool Taxed – ознака оподаткування
int? TaxGroupID – ідентифікатор податкової групи
string TaxGroupName – назва податкової групи
string TaxGroupCode – код податкової групи
int? TaxType – ідентифікатор основного податку
string TaxName – назва основного податку
decimal? TaxWage – ставка основного податку
decimal? TaxSum – сума основного податку
int? SecondTaxType – ідентифікатор додаткового податку
string SecondTaxName – назва додаткового податку
decimal? SecondTaxWage – ставка додаткового податку
decimal? SecondTaxSum – сума додаткового податку
Receipt[] Receipts – список чеків оплати Receipt. Структура з полями:
UserInfo CreateUser – касир
DateTime Date – дата чека
int ReceiptID – ідентифікатор чека
int? DepositID – ідентифікатор депозиту
int? BillID – ідентифікатор рахунку
int PayTypeID – ідентифікатор типу оплати
string PaidType – тип оплати
string PayTypeName – назва типу оплати
int? PayGroupType – ідентифікатор групи оплати
int ReceiptPayTypeID – ідентифікатор типу оплати
string ReceiptPayTypeName – назва типу оплати
string ReceiptPayTypeCode – код типу оплати
int? FiscalID – ідентифікатор каси
int? FiscalSessionID – ідентифікатор касової зміни
decimal Sum – сума чека
decimal SumWithTax – сума позицій, що не підлягають оподаткуванню
decimal SumWithoutTax – сума позицій, що не підлягають оподаткуванню
decimal? RoundingDelta – сума заокруглення
Taxes[] – список податків у чеку Tax. Структура з полями:
string TaxName – назва податку
decimal TaxWage – ставка податку
decimal TaxSum – сума податку
Sales[] – список послуг у чеку Sale.
Receipt[] ReceiptReturns – список чеків повернення Receipt
int RoomsCount – кількість споживачів у рахунку

{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1700052641226",
"VersionInfo": "1.0.0.3",
"RequestDate": "2025-08-28 08:56:46",
"Hotels": [
{
"Bills": [
{
"Account": "G0000036126",
"BillComment": "",
"BillCustomerID": 36126,
"BillCustomerTypeID": 2,
"BillDate": "2023-11-15 10:42:09",
"BillID": 164370,
"BillPayerID": 36126,
"BillPayerTypeID": 2,
"BillType": "Payment",
"CompanyPayerID": null,
"CreateUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
},
"Currency": "UAH",
"CurrencyCourse": 1,
"PaymentsSum": 49157.20,
"ReceiptReturns": [
{
"CreateUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
},
"Date": "2023-11-15 14:48:00",
"DepositID": null,
"FiscalID": 1,
"FiscalSessionID": 17343,
"PaidType": "Credit",
"PayGroupType": 1,
"PayTypeID": 11,
"PayTypeName": "Карта",
"ReceiptID": 174323,
"ReceiptPayTypeCode": "крт",
"ReceiptPayTypeID": 11,
"ReceiptPayTypeName": "Карта",
"RoundingDelta": null,
"Sales": [
{
"Canceled": false,
"Consumers": 1,
"PeriodDateFrom": "2023-11-18 14:00:00",
"PeriodDateTo": "2023-11-19 12:00:00",
"Price": 1200,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 100,
"ServiceID": 89579,
"ServiceName": "Проживання",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassID": 2,
"ServiceSubClassName": "Проживание",
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "FullVAT",
"TaxGroupID": 1,
"TaxGroupName": "ПДВ 20%",
"TaxName": "ПДВ 20",
"TaxSum": 200,
"TaxType": 14,
"TaxWage": 0.2,
"Taxed": true,
"Total": 1200
},
{
"Canceled": false,
"Consumers": 1,
"PeriodDateFrom": "2023-11-18 14:00:00",
"PeriodDateTo": "2023-11-19 12:00:00",
"Price": 34.8,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 987,
"ServiceID": 210,
"ServiceName": "Туристичний збір",
"ServiceSubClassCode": null,
"ServiceSubClassID": null,
"ServiceSubClassName": null,
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "Untax",
"TaxGroupID": 8,
"TaxGroupName": "Не оподатковується",
"TaxName": "Не оподатковується",
"TaxSum": 0,
"TaxType": 1040,
"TaxWage": 0,
"Taxed": false,
"Total": 34.8
}
],
"Sum": 2469.6,
"SumWithTax": 2400,
"SumWithoutTax": 69.6,
"Taxes": [
{
"TaxName": "ПДВ 20",
"TaxSum": 400,
"TaxWage": 0.2
}
]
}
],
"Receipts": [
{
"CreateUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
},
"Date": "2023-11-15 11:12:00",
"DepositID": null,
"FiscalID": 1,
"FiscalSessionID": 17343,
"PaidType": "Credit",
"PayGroupType": 1,
"PayTypeID": 11,
"PayTypeName": "Карта",
"ReceiptID": 174322,
"ReceiptPayTypeCode": "крт",
"ReceiptPayTypeID": 11,
"ReceiptPayTypeName": "Карта",
"RoundingDelta": null,
"Sales": [
{
"Canceled": false,
"Consumers": 4,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-27 12:00:00",
"Price": 1200,
"Quantity": 39,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 100,
"ServiceID": 89579,
"ServiceName": "Проживання",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassID": 2,
"ServiceSubClassName": "Проживание",
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "FullVAT",
"TaxGroupID": 1,
"TaxGroupName": "ПДВ 20%",
"TaxName": "ПДВ 20",
"TaxSum": 7800,
"TaxType": 14,
"TaxWage": 0.2,
"Taxed": true,
"Total": 46800
},
{
"Canceled": false,
"Consumers": 4,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-27 12:00:00",
"Price": 34.8,
"Quantity": 39,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 987,
"ServiceID": 210,
"ServiceName": "Туристичний збір",
"ServiceSubClassCode": null,
"ServiceSubClassID": null,
"ServiceSubClassName": null,
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "Untax",
"TaxGroupID": 8,
"TaxGroupName": "Не оподатковується",
"TaxName": "Не оподатковується",
"TaxSum": 0,
"TaxType": 1040,
"TaxWage": 0,
"Taxed": false,
"Total": 1357.2
},
{
"Canceled": true,
"Consumers": 1,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-18 12:00:00",
"Price": 1200,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 100,
"ServiceID": 89579,
"ServiceName": "Проживання",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassID": 2,
"ServiceSubClassName": "Проживание",
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "FullVAT",
"TaxGroupID": 1,
"TaxGroupName": "ПДВ 20%",
"TaxName": "ПДВ 20",
"TaxSum": 200,
"TaxType": 14,
"TaxWage": 0.2,
"Taxed": true,
"Total": 1200
},
{
"Canceled": true,
"Consumers": 1,
"PeriodDateFrom": "2023-11-17 14:00:00",
"PeriodDateTo": "2023-11-18 12:00:00",
"Price": 34.8,
"Quantity": 1,
"SecondTaxName": null,
"SecondTaxSum": null,
"SecondTaxType": null,
"SecondTaxWage": null,
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Услуги проживания",
"ServiceCode": 987,
"ServiceID": 210,
"ServiceName": "Туристичний збір",
"ServiceSubClassCode": null,
"ServiceSubClassID": null,
"ServiceSubClassName": null,
"ServiceTypeID": 13,
"ServiceTypeName": "Услуги проживания",
"TaxGroupCode": "Untax",
"TaxGroupID": 8,
"TaxGroupName": "Не оподатковується",
"TaxName": "Не оподатковується",
"TaxSum": 0,
"TaxType": 1040,
"TaxWage": 0,
"Taxed": false,
"Total": 34.8
}
],
"Sum": 49392,
"SumWithTax": 48000,
"SumWithoutTax": 1392,
"Taxes": [
{
"TaxName": "ПДВ 20",
"TaxSum": 8000,
"TaxWage": 0.2
}
]
}
],
"ServiceProviderID": 341
}
],
"Companies": [
{
"BranchOfficeCode": null,
"Code": "38964368",
"CompanyID": 341,
"PayTypeID": 1,
"PayTypeName": "Наличные",
"HousingID": 1,
"HousingName": "Головний корпус",
"FactualAddress": "",
"FullName": "Hotel Group Ltd.",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "",
"LegalAddress": "",
"Name": "Хотел Груп Лтд",
"PhoneNumber": "",
"PostalAddress": "",
"TIN": "286547135401",
"VatCertificateNumber": "",
"СorporateManager": null
}
],
"Consumers": [
{
"ArrivalDate": "",
"BookingSource": "",
"CompanyOperatorID": null,
"Consumer": "G0000036126",
"ConsumerID": 36126,
"ConsumerTypeID": 2,
"PayTypeID": 1,
"PayTypeName": "Наличные",
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "",
"Name": "Grouped Sales",
"PriceListName": "ПР Базовий",
"RoomNumber": "",
"RoomTypeName": ""
}
],
"DeletedBills": [164366, 164367, 164368, 164369],
"FiscalDevices": [
{
"CashCode": " ",
"FiscalID": 1,
"FiscalName": "Каса"
}
],
"FiscalSessions": [
{
"CloseBalance": null,
"CloseDate": "",
"CloseUser": {
"LoginID": null,
"UserName": ""
},
"FiscalID": 1,
"FiscalSessionID": 17343,
"OpenBalance": 46571582.29,
"OpenDate": "2023-10-17 13:41:45",
"OpenUser": {
"LoginID": 3484,
"UserName": "Чередниченко Дмитро"
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "гот 1"
},
"Payers": [
{
"ArrivalDate": "",
"BookingSource": "",
"CompanyOperatorID": null,
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "",
"Name": "Grouped Sales",
"Payer": "G0000036126",
"PayerID": 36126,
"PayerTypeID": 2,
"PriceListName": "ПР Базовий",
"RoomNumber": "",
"RoomTypeName": ""
}
]
}
]
}

</pre>