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

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

2026-04-16T06:10:34Z

Andriy.Kolch: /* 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.
|-
| 27.03.2026 || 06.01.217 || 1.25 || Додано до функції UpdateClient окреме текстове поле PreferenceNotes з текстом рекомендацій.
|}

=Опис взаємодії=
Формат переданих і прийнятих даних – протокол обміну 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",
// Фільтрувати за датою будь-якої зміни дотичної до гостя
"UseLastChangeEventDate": true або false
// необов’язковий фільтр за ідентифікаторами гостей
"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" : {
"Adults": 1,
"ArrivalDateTime": "2026-04-15 06:00:00",
"CancelReasonID": null,
"CancelReasonName": null,
"CancelReasonString": null,
"ChannelReservationCode": null,
"Childs": 0,
"ChildsPay": 0,
"Clients": [],
"Company": {
"CompanyID": 1204,
"CompanyName": "Online Reservation",
"CompanyPrintCode": "X0001204",
"CompanyPrintName": "Online Reservation",
"CompanyPrintSertificate": "",
"Email": "ota@servio.support",
"ITN": "",
"IndustryID": null,
"IndustryName": "",
"Phone": "+380(98)765-43-21",
"SegmentID": null,
"SegmentName": ""
},
"CompanyID": 1204,
"ContactName": "Ткачук Олексій",
"Cost": "12950.00",
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "",
"DateTimeReservation": "2026-04-14 12:23:57",
"DateTimeSettle": "",
"DepartureDateTime": "2026-04-16 12:00:00",
"Email": "",
"GroupID": null,
"GuestID": 35508,
"GuestName": "Test Test",
"GuestStatus": 0,
"IdentityCards": [],
"ManagerActivities": [],
"ManagerID": null,
"NightsCount": 1,
"Notes": [],
"OperatorCompany": {
"CompanyID": 1204,
"CompanyName": "Online Reservation",
"CompanyPrintCode": "X0001204",
"CompanyPrintName": "Online Reservation",
"CompanyPrintSertificate": "",
"Email": "ota@servio.support",
"ITN": "",
"IndustryID": null,
"IndustryName": "",
"Phone": "+380(98)765-43-21",
"SegmentID": null,
"SegmentName": ""
},
"PaidTypeID": 4,
"PaidTypeName": "Кредитна карта",
"PayStatus": 0,
"Payments": [
{
"AcceptanceDate": null,
"Barcode": null,
"ConsumptionDate": "2026-04-15 13:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"LastReceiptDate": "",
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 177388,
"PaymentStatus": 0,
"PaymentType": 1,
"Price": "500.00",
"PriceValuteISO": "UAH",
"Quantity": "0.500",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 216,
"ServiceName": "Ранній заїзд/Early check-in",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ 7%",
"TaxRate": "0.07",
"TaxSum": "16.36",
"UsedQuantity": ""
}
] // Гості
] // Готелі
}

</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,
"PreferenceNotes": "текст рекомендацій",
"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": "Test Test"
},
"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": "UKR",
"CountryName": "Україна",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Test Test",
"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-04-16T06:09:08Z

Andriy.Kolch: /* GetGuestsModified */

=Опис Змін=
{| 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.
|-
| 27.03.2026 || 06.01.217 || 1.25 || Додано до функції UpdateClient окреме текстове поле PreferenceNotes з текстом рекомендацій.
|}

=Опис взаємодії=
Формат переданих і прийнятих даних – протокол обміну 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",
// Фільтрувати за датою будь-якої зміни дотичної до гостя
"UseLastChangeEventDate": true або false
// необов’язковий фільтр за ідентифікаторами гостей
"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" : {
"Adults": 1,
"ArrivalDateTime": "2026-04-15 06:00:00",
"CancelReasonID": null,
"CancelReasonName": null,
"CancelReasonString": null,
"ChannelReservationCode": null,
"Childs": 0,
"ChildsPay": 0,
"Clients": [],
"Company": {
"CompanyID": 1204,
"CompanyName": "Online Reservation",
"CompanyPrintCode": "X0001204",
"CompanyPrintName": "Online Reservation",
"CompanyPrintSertificate": "",
"Email": "ota@servio.support",
"ITN": "",
"IndustryID": null,
"IndustryName": "",
"Phone": "+380(98)765-43-21",
"SegmentID": null,
"SegmentName": ""
},
"CompanyID": 1204,
"ContactName": "Ткачук Олексій",
"Cost": "12950.00",
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "",
"DateTimeReservation": "2026-04-14 12:23:57",
"DateTimeSettle": "",
"DepartureDateTime": "2026-04-16 12:00:00",
"Email": "",
"GroupID": null,
"GuestID": 35508,
"GuestName": "Test Test",
"GuestStatus": 0,
"IdentityCards": [],
"ManagerActivities": [],
"ManagerID": null,
"NightsCount": 1,
"Notes": [],
"OperatorCompany": {
"CompanyID": 1204,
"CompanyName": "Online Reservation",
"CompanyPrintCode": "X0001204",
"CompanyPrintName": "Online Reservation",
"CompanyPrintSertificate": "",
"Email": "ota@servio.support",
"ITN": "",
"IndustryID": null,
"IndustryName": "",
"Phone": "+380(98)765-43-21",
"SegmentID": null,
"SegmentName": ""
},
"PaidTypeID": 4,
"PaidTypeName": "Кредитна карта",
"PayStatus": 0,
"Payments": [
{
"AcceptanceDate": null,
"Barcode": null,
"ConsumptionDate": "2026-04-15 13:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"LastReceiptDate": "",
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Послуга",
"PackagePayments": [],
"PayAmount": "0.00",
"PayAmountValuteISO": "",
"PaymentId": 177388,
"PaymentStatus": 0,
"PaymentType": 1,
"Price": "500.00",
"PriceValuteISO": "UAH",
"Quantity": "0.500",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 216,
"ServiceName": "Ранній заїзд/Early check-in",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ 7%",
"TaxRate": "0.07",
"TaxSum": "16.36",
"UsedQuantity": ""
}
] // Гості
] // Готелі
}

</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,
"PreferenceNotes": "текст рекомендацій",
"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-04-10T10:26:14Z

Andriy.Kolch:

=Опис Змін=
{| 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.
|-
| 27.03.2026 || 06.01.217 || 1.25 || Додано до функції UpdateClient окреме текстове поле PreferenceNotes з текстом рекомендацій.
|}

=Опис взаємодії=
Формат переданих і прийнятих даних – протокол обміну 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",
// Фільтрувати за датою будь-якої зміни дотичної до гостя
"UseLastChangeEventDate": true або false
// необов’язковий фільтр за ідентифікаторами гостей
"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,
"PreferenceNotes": "текст рекомендацій",
"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 Reservation10

2026-04-02T09:18:40Z

Andriy.Kolch: /* SetBillPayment */

Опис протоколу для інтеграції зовнішнього модуля бронювання з Servio HMS

=Формат запитів JSON=
Форматом переданих і прийнятих даних є протокол обміну JSON. Кодування запитів і відповідей UTF8. Приклад запиту і відповіді наведено нижче.
{
"firstName": "Ім'я",
"lastName": "Прізвище",
"адреса": {
"streetAddress": "Швидке ш., 101, кв.101",
"city": "Місто",
"postalCode": 101101
},
"phoneNumbers": [
"+380(98)-765-43-21",
"+380(98)-123-45-67"
]
}

=Заголовки/Headers=

У заголовках, для доступу до функцій необхідно вказувати AccessToken. Key - "AccessToken", Value - "Наданий токен".

=Формат даних=
* Формат дати/часу: "yyyy-MM-dd HH:mm:ss";
* Формат дати: "yyyy-MM-dd"
* Формат часу: "HH:mm"
* Роздільник типів із плаваючою крапкою(double): "."
=Опис функцій спілкування=
==GetCompanyInfo==
Функція GetCompanyInfo повертає інформацію про компанію, або помилку.

'''Вхідні параметри:'''
1. CompanyCode - string, довжина рядка до 20 символів. Ідентифікаційний код компанії.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки. Якщо компанія за кодом не знайдена код помилки - CompanyNotFound
4. CompanyID - int, ідентифікатор компанії.
5. CompanyCodeID - int, ідентифікатор коду компанії.
6. CompanyName - string, назва компанії
7. CompanyEmail - string, ел. пошта компанії
8. CompanyFax - рядок, факс компанії
9. ComanyPhoneNumber - string, номер контактного телефону компанії
10. IsPrepayment - bool, працює за передоплатою

==Get Rooms==
Функція GetRooms отримує за вхідними параметрами список категорій номерів із зазначенням кількості вільних номерів кожної категорії.

'''Вхідні параметри:'''

1. HotelID - int, від 1 до +∞, ID готелю
2. DateArrival - date, дата заїзду - ведеться ігнорування часу.
3. DateDeparture - date. Дата виїзду - ведеться ігнорування часу.
4. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі.
5. Adults - int, від 1 до 1000. Кількість дорослих людей
6. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок.
7. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка.
8. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів.
9. CompanyCodeID - int, ідентифікатор коду компанії, 0 - немає, >0 - визначає ID компанії під якою відбувається бронювання
10. TimeDeparture - string, 5 символів - час виїзду (н/р: "12:00"), якщо час виїзду не вказано, передавати порожній рядок, у такому разі час виїзду буде проставлятися в автоматичному режимі.
11. IsoLanguage - string, 2 символи, двобуквена iso назва мови для виведення запиту.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, , 1 - Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. RoomTypes - RoomType[], одновимірний масив JSON структур RoomType, у якому зберігається інформація за категоріями кімнат:
a. ID - int, ID категорії номера в базі PMS.
b. FreeRoom - int, кількість вільних номерів цієї категорії.
c. MainPlacesCount - int, кількість основних місць у номері.
d. NearestDateToReservation - Nullable<datetime>, дата найближчої можливої броні
5. СontractConditions - СontractCondition[], одновимірний масив JSON структур СontractCondition, у якому зберігається інформація щодо умов договорів компанії. Це поле заповнюється тільки якщо CompanyID > 0, кількість елементів у масиві відповідає кількості умов договорів, що діють на дату заїзду:
a. СontractConditionID - int, ідентифікатор умови договору компанії.
b. СontractConditionName - string, назва умови договору компанії.
c. PaidTypes - int[], масив кодів типів оплат доступних за цією умовою. Значення елементів масиву: 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
d. ExpiredDate - datetime, дата закінчення поточного договору компанії.

==GetPrices==

Функція GetPrices отримує за вхідними параметрами список заявок на бронювання із зазначенням списку послуг і цін на кожен день проживання за кожною заявкою. Далі на сайті цю інформацію обробляють і групують у зручному для користувача вигляді.

'''Вхідні параметри:'''
1. HotelID - int, від 1 до +∞, ID готелю
2. CompanyID - int, ідентифікатор компанії, 0 - немає, >0 - визначає ID компанії під якою відбувається бронювання
3. DateArrival - date, дата заїзду - ведеться ігнорування часу.
4. DateDeparture - date, дата виїзду - ведеться ігнорування часу.
5. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі.
6. Adults - int, від 1 до 1000. Кількість дорослих людей
7. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок.
8. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка.
9. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів.
10. IsoLanguage - string, 2 символи, двобуквена iso назва мови для виведення запиту.
11. RoomTypeIDs - int[], масив ідентифікаторів категорій номерів, для яких потрібно брати ціну.
12. СontractConditionID - int, ідентифікатор умови договору, за якою необхідно отримати PriceLists. 0 - системна умова, >0 - ідентифікатор обраної умови.
13. СontractConditionAddIDs - int[], масив ідентифікаторів умов договорів, за якими необхідно отримати PriceLists.
14. PaidType - int, тип оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
15. NeedTransport - int, від 0 до 1, потрібно замовити транспорт 0 - не потрібно, 1 - потрібно
16. IsTouristTax - int, параметр чи оподатковується цей гість, 1- оподатковується, 0 - не оподатковується. За замовчуванням 1.
17. AgentCategory - int, категорія контрагента. 0 - не вказано (буде використано категорію, налаштовану для готелю за замовчуванням), 1 - Резидент, 2 - Нерезидент.
18. AgentCategories - int[], масив категорій контрагентів (можливі значення елементів масиву як у полі AgentCategory). Якщо масив містить хоча б один елемент, то ціни за послугами-надбавками повертаються окремо від цін на основні послуги.
19. TimeDeparture - string, 5 символів - час виїзду (н/р: "12:00"), якщо час виїзду не вказано, передавати порожній рядок, у такому разі час виїзду буде проставлятися в автоматичному режимі.
20. LoyaltyAuthCode - string, 20 символів. Код бронювання програми лояльності (обов'язкове поле).

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. ValuteShort - рядок, скорочення базової валюти в зазначеній мові.
5. PriceLists - PriceList[], одновимірний масив JSON структур PriceList, у якому зберігається інформація про прейскуранти, що повертаються, а також про ціни для цих прейскурантів на запитувані категорії кімнат:
a. PriceListID - int, ID прейскуранта в базі HMS;
b. PriceListName - string, найменування прейскуранта;
c. ConditionID - int, ID умови договору;
d. IsNonReturnRate - int, ознака неповоротного тарифу, 1 - неповоротний тариф, 0 - поворотний тариф.
e. IsSpecRate- int, ознака спеціальної пропозиції, 1 - спеціальна пропозиція, 0 - звичайний тариф.
f. RoomTypes - RoomType[], одновимірний масив JSON структур RoomType, у якому зберігається інформація щодо цін для категорій кімнат:
i. ID - int, ID категорії номера в базі HMS.
ii. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
1. ServiceID - int, ідентифікатор послуги
2. ServiceName - string, назва послуги
3. ServiceCode - int, податковий код групи
4. ServiceSystemCode - string, системний код
5. ServiceTypeName - string, назва типу улуги
6. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
a. Date - datetime, дата і час споживання послуги
b. Price - double, сума нарахування в поточний день
c. RackRatePrice - double, сума нарахування в поточний день за прейскурантом стійки
iii. AgentCategories - AgentCategory[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг-надбавок для різних категорій контрагентів. Заповнюється залежно від вхідного параметра. '''AgentCategories:''' якщо масив містить хоча б один елемент, то ціни на послуги-надбавки повертаються окремо від цін на основні послуги в даному полі; якщо масив не заповнено, то ціни на послуги-надбавки повертаються до '''RoomType.Services''' разом із рештою послуг.
1. AgentCategory - int, категорія контрагента.
2. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг-надбавок для категорії контрагента.
iv. SaleRestrictions - JSON-структура, в якій міститься інформація щодо обмежень продажів для категорії кімнати на вказаний часовий проміжок:
1. ClosedToSale - JSON-структура містить інформацію про обмеження "Заборона продажів":
a. HasRestrictions - bool, ознака наявності обмеження
b. Message - string, текст повідомлення
2. ClosedToArrive - JSON структура містить інформацію про обмеження "Заборона заїзду":
a. HasRestrictions - bool, ознака наявності обмеження
b. Message - string, текст повідомлення
3. EarlyReservation - JSON структура містить інформацію про обмеження "Раннє бронювання":
a. HasRestrictions - bool, ознака наявності обмеження
b. Message - string, текст повідомлення
4. MinStay - JSON структура містить інформацію про обмеження "Мінімальний період проживання":
a. HasRestrictions - bool, ознака наявності обмеження
b. Days - int, кількість днів. 0 - якщо відсутні чинні обмеження на мінімальний період проживання.
c. Message - string, текст повідомлення
5. MinPay - JSON структура містить інформацію про обмеження "Мінімальна передоплата":
a. Days - int, кількість днів.
b. Message - string, текст повідомлення
c. MinPayPaymentRules - MinPayPaymentRuleInfo[], одновимірний масив JSON структур MinPayPaymentRuleInfo, у якому зберігається інформація про обов'язковість оплат:
i. TimeFromArriveDate - long, Час до заїзду (сек.), діє в більший бік, тобто в разі різниці між датою заїзду та датою бронювання, більшої за це значення, оплата буде обов'язковою, якщо меншою - ні.
ii. TimeForPayment - long, час для оплати з дати бронювання (сек.)

==AddRoomReservation==
Функція AddRoomReservation створює нову бронь у базі за вхідними параметрами і повертає ID броні.
Примітка: У разі вибору типу оплати-300 (безготівкова оплата) в HMS створюється автоматично рахунок на компанію.

'''Вхідні параметри:'''
1. HotelID - int, від 1 до +∞, ID готелю
2. DateArrival - date, дата заїзду - ведеться ігнорування часу.
3. DateDeparture - date .Дата виїзду - ведеться ігнорування часу.
4. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі.
5. Adults - int, від 1 до 1000. Кількість дорослих людей
6. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок.
7. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка.
8. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів.
9. GuestLastName - string, прізвище гостя
10. GuestFirstName - string, ім'я гостя
11. RoomTypeID - int, 1 до +∞, ID категорії номера
12. CompanyID - int, ідентифікатор (ID) компанії під якою відбувається бронювання
13. Company - рядок, назва компанії
14. СontractConditionID - int, ідентифікатор умови договору компанії. 0 - системна умова, >0 - ідентифікатор обраної умови.
15. PaidType - int, тип оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
16. Iso3Country - string, рядок 3 символи, iso позначення країни.
17. Country - string, назва країни
18. Address - рядок, адреса проживання
19. Phone - рядок, телефон
20. Fax - рядок, факс
21. eMail - рядок, пошта
22. NeedTransport - int, від 0 до 1, потрібно замовити транспорт 0 - не потрібно, 1 - потрібно
23. Comment - string, рядок коментарів. Обріжеться під час вставки в базу.
24. ClientInfo - string, додаткова інформація про людину, яка зробила бронь: IP-адреса, тощо.
25. IsTouristTax - int, ознака включення тур.збору в автоматично створений рахунок, 1- включається, 0 - не включається
26. AgentCategory - int, категорія контрагента. 0 - не вказано (буде використано категорію, налаштовану для готелю за замовчуванням), 1 - Резидент, 2 - Нерезидент.
27. PriceListID - int, 1 до +∞, ID прейскуранта
28. LoyaltyCardTypeID - int, ідентифікатор типу карти лояльності.
29. LoyaltyCardNumber - string, 20 символів. Код бронювання програми лояльності.
30. ContactName - string, до 50 символів. Контактна особа під час бронювання.
31. TimeDeparture - string, 5 символів - час виїзду (н/р: "12:00"), якщо час виїзду не вказано, передавати порожній рядок, у такому разі час виїзду буде проставлятися в автоматичному режимі.
32. BirthDate - date, дата народження.
33. UTM_CAMPAIGN - string, 128 символів - UTM-мітка. Назва рекламної кампанії
34. UTM_CONTENT - string, 128 символів - UTM-мітка. Інформація, яка допомагає розрізняти оголошення, якщо збігаються інші параметри
35. UTM_MEDIUM - string, 128 символів - UTM-мітка. Тип трафіку
36. UTM_SOURCE - string, 128 символів - UTM-мітка. Рекламна система
37. UTM_TERM - string, 128 символів - UTM-мітка. Ключове слово, яке ініціювало показ оголошення

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Account - int, від 1 до +∞, ID броні

==SetReservationType==
Функція SetReservationType змінює тип зазначеної броні на гарантовану. Додатково ця функція дає змогу проводити оплат і гарантувати захід, у цьому разі в поле Л/Рахунки додається префікс A і групи префікс G.

'''Вхідні параметри:'''
1. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
2. Amount - double, сума за перший день проживання
3. RRN - string, RRN-код платіжної операції.
4. OrderID - int, необов'язкове поле. Ідентифікатор платіжної операції сайту Reikartz.
5. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
a. ServiceID - int, ідентифікатор послуги
b. ServiceName - string, назва послуги, допускається порожнє значення
c. ServiceCode - int, бухгалтерський код послуги, допускається порожнє значення
d. ServiceSystemCode - string, системний код, допускається порожнє значення
e. ServiceTypeName - string, назва типу послуги, допускається порожнє значення
f. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
i. Date - datetime, дата і час споживання послуги
ii. Price - double, сума нарахування в поточний день
iii. CustomerAccount - string, ідентифікатор бронювання споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
6. ServiceProviderID - int, необов'язковий параметр, ідентифікатор постачальника послуг, використовуваного для виставлення рахунків під час оплати кредитною карткою.
7. ServiceProviderName - string, найменування постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.

==SetReservationBill==
Функція SetReservationBill функція є проміжною ланкою перед оплатою нарахування, вона створює на картці відповідної сутності рахунок і поміщає в нього зазначений список нарахувань послуг, за якими стягуватиметься оплата. Після формування рахунку і перерахунку податків функція повертає уточнений список послуг з остаточними цінами (Використовується для коригування вартості надбавки в рахунках з різними постачальниками). Ця функція дає змогу готувати захід, у цьому разі в поле Л/Рахунки додається префікс A і групи префікс G.

'''Вхідні параметри:'''
1. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
2. Amount - double, сума за перший день проживання
3. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
a. ServiceID - int, ідентифікатор послуги
b. ServiceName - string, назва послуги, допускається порожнє значення
c. ServiceCode - int, бухгалтерський код послуги, допускається порожнє значення
d. ServiceSystemCode - string, системний код, допускається порожнє значення
e. ServiceTypeName - string, назва типу улуги, допускається порожнє значення
f. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
i. Date - datetime, дата і час споживання послуги
ii. Price - double, сума нарахування в поточний день
iii. CustomerAccount - string, ідентифікатор бронювання споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
4. ServiceProviderID - int, необов'язковий параметр, ідентифікатор постачальника послуг, використовуваного для виставлення рахунків під час оплати кредитною карткою.
5. ServiceProviderName - string, найменування постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1- Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A'
(activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
5. Amount - double, сума за перший день проживання
6. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
a. ServiceID - int, ідентифікатор послуги
b. ServiceName - string, назва послуги
c. ServiceCode - int, бухгалтерський код послуги
d. ServiceSystemCode - string, системний код
e. ServiceTypeName - string, назва типу улуги
f. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
i. Date - datetime, дата і час споживання послуги
ii. Price - double, сума нарахування в поточний день
iii. CustomerAccount - string, ідентифікатор бронювання споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.

==RevertTransaction==
Функція RevertTransaction для типу транзакції робить повернення за кредиткою
Функція RevertTransaction дає змогу проводити повернення оплати з сайту. Додатково ця функція дає змогу проводити повернення оплати для заходу, у цьому разі в поле Л/Рахунки додається префікс A і групи префікс G.

'''Вхідні параметри:'''
1. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
2. Amount - double, сума повернення за транзакцією
3. RRN - string, RRN-код платіжної операції.
4. OrderID - int, необов'язкове поле. Ідентифікатор платіжної операції сайту Reikartz.
5. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
a. ServiceID - int, ідентифікатор послуги
b. ServiceName - string, назва послуги, допускається порожнє значення
c. ServiceCode - int, бухгалтерський код послуги, допускається порожнє значення
d. ServiceSystemCode - string, системний код, допускається порожнє значення
e. ServiceTypeName - string, назва типу улуги, допускається порожнє значення
f. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
i. Date - datetime, дата і час споживання послуги
ii. Price - double, сума нарахування в поточний день
iii. CustomerAccount - string, ідентифікатор бронювання споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.

==GetAccountBill==
Функція GetAccountBill формує і повертає рахунок у вигляді стисненого zip документа або папки в потрібному форматі.

'''Вхідні параметри:'''
1. Account - int, від 1 до +∞, ID броні
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою.
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. DocumentID - int, посилання на документ, який буде зроблено

==GetAccountConfirm==
Функція GetAccountConfirm формує і повертає підтвердження бронювання у вигляді стисненого zip документа або папки в потрібному форматі.

'''Вхідні параметри:'''
1. Account - int, від 1 до +∞, ID броні
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою.
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. DocumentID - int, посилання на документ, який буде зроблено

==GetRoomTypesList==
Функція GetRoomTypesList повертає список категорій номерів за готелем.

'''Вхідні параметри:'''
1. HotelID - int, від 0 до +∞, ID готелю, якщо 0, то виводяться категорії номерів по всіх готелях

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Count - визначає розмірність повернених масивів.
5. IDs - int[], масив цілих чисел, ID категорій номерів у базі.
6. ClassNames - string[], масив рядків, назви категорій номерів.
7. HotelIDs - int[], масив цілих чисел, ID готелю категорії номерів.

==GetGroupRooms==
Функція GetGroupRooms отримує за вхідними параметрами список категорій номерів із зазначенням кількості вільних номерів кожної категорії.

Вхідні параметри:
1. HotelID - int, від 1 до +∞, ID готелю
2. BookingRequests - BookingRequest[], одновимірний масив JSON структур BookingRequest, у якому зберігається інформація щодо заявок на бронювання кімнат:
a. DateArrival - date, дата заїзду - ведеться ігнорування часу.
b. DateDeparture - date. Дата виїзду - ведеться ігнорування часу.
c. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі.
d. TimeDeparture - string, 5 символів - час виїзду (н/р: "20:00"), якщо час виїзду не вказано, передавати порожній рядок, у такому разі час виїзду буде проставлятися в автоматичному режимі.
e. Adults - int, від 1 до 1000. Кількість дорослих людей
f. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок.
g. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка.
h. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів.
3. IsoLanguage - string, 2 символи, двобуквена iso назва мови для виведення запиту.
4. CompanyСodeID - int, ідентифікатор компанії, 0 - немає, >0 - визначає ID компанії під якою відбувається бронювання

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2-Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. BookingRequestAnswers - BookingRequestAnswer[], одновимірний масив JSON структур BookingRequestAnswer, у якому зберігається інформація про знайдені категорії номерів за заявками на бронювання кімнат:
a. RoomTypes - RoomType[], одновимірний масив JSON структур RoomType, у якому зберігається інформація за категоріями кімнат:
i. ID - int, ID категорії номера в базі PMS.
ii. FreeRoom - int, кількість вільних номерів цієї категорії.
iii. MainPlacesCount - int, кількість основних місць у номері.
iv. NearestDateToReservation-Nullable<datetime>, дата найближчої можливої броні.
5. СontractConditions - СontractCondition[], одновимірний масив JSON структур СontractCondition, у якому зберігається інформація щодо умов договорів компанії. Це поле заповнюється тільки якщо CompanyID > 0, кількість елементів у масиві відповідає кількості умов договорів, що діють на дату заїзду:
a. СontractConditionID - int, ідентифікатор умови договору компанії.
b. СontractConditionName - string, назва умови договору компанії.
c. PaidTypes - int[], масив кодів типів оплат доступних за цією умовою. Значення елементів масиву: 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.

==AddGroupRoomReservation==
Функція AddGroupRoomReservation створює нову групову бронь у базі за вхідними параметрами, і повертає ID броні групи в системі.
Примітка: У разі вибору типу оплати-300 (безготівкова оплата) в HMS створюється автоматично рахунок на компанію.

'''Вхідні параметри:'''
1. HotelID - int, від 1 до +∞, ID готелю
2. GroupName - string, назва групи
3. CompanyID - int, ідентифікатор компанії, 0 - немає, >0 - визначає ID компанії під якою відбувається бронювання
4. Company - рядок, назва компанії
5. Iso3Country - string, рядок 3 символи, iso позначення країни.
6. Country - string, назва країни
7. PaidType - int, тип оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
8. ContactName - string, контактна особа групи
9. ContactEMail - string, електронна пошта контактної особи
10. ContactInfo - string, інша контактна інформація по групі. Максимум 500 сивволів.
11. Comment - string, рядок коментарів. Обріжеться під час вставки в базу
12. ClientInfo - string, додаткова інформація про людину, яка зробила бронь: IP-адреса, тощо.
13. СontractConditionID - int, ідентифікатор умови договору компанії. 0 - системна умова, >0 - ідентифікатор обраної умови.
14. RoomReservations - RoomReservation[], одновимірний масив JSON структур RoomReservation, у якому зберігається інформація про заявки бронювання номерів групи:
a. GuestName - string, необов'язкове поле - ім'я гостя. Якщо не вказано, в ім'я гостя підставляється назва групи.
b. DateArrival - date дата заїзду - ведеться ігнорування часу.
c. DateDeparture - date. Дата виїзду - ведеться ігнорування часу.
d. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі.
e. TimeDeparture - string, 5 символів - час виїзду (н/р: "20:00"), якщо час виїзду не вказано, передавати порожній рядок, у такому разі час виїзду буде проставлятися в автоматичному режимі.
f. Adults - int, від 1 до 1000. Кількість дорослих людей
g. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок.
h. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка.
i. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів.
j. RoomTypeID - int, 1 до +∞, ID категорії номера
k. NeedTransport - int, від 0 до 1, потрібно замовити транспорт 0 - не потрібно, 1 - потрібно
l. IsTouristTax - int, ознака включення тур.збору в автоматично створений рахунок, 1- включається, 0 - не включається
m. AgentCategory - int, категорія контрагента. 0 - не вказано (буде використано категорію, налаштовану для готелю за замовчуванням), 1 - Резидент, 2 - Нерезидент.
Примітка: За поточною реалізацією протоколу формат параметра-int,
в 11 версії формат буде виправлено на bool, згідно відповідності протоколу
n. PriceListID - int, 1 до +∞, ID прейскуранта
o. СontractConditionID - int, ідентифікатор умови договору компанії. 0 - умова з групи, >0 - ідентифікатор обраної умови.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Account - int, від 1 до +∞, ID групової броні
5. RoomReservations - RoomReservation[], одновимірний масив JSON структур RoomReservation, у якому зберігається інформація про заявки бронювання номерів групи:
i. DateArrival - date, дата заїзду - ведеться ігнорування часу.
ii. DateDeparture - date. Дата виїзду - ведеться ігнорування часу.
iii. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі.
iv. Adults - int, від 1 до 1000. Кількість дорослих людей
v. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок.
vi. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка.
vii. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів.
viii. RoomTypeID - int, 1 до +∞, ID категорії номера
ix. NeedTransport - int, від 0 до 1, потрібно замовити транспорт 0 - не потрібно, 1 - потрібно
x. IsTouristTax - int, параметр чи оподатковується цей гість, 1- оподатковується, 0 - не оподатковується. За замовчуванням 1.
xi. PriceListID - int, 1 до +∞, ID прейскуранта
xii. GuestAccount - int, від 1 до +∞, ID індивідуальної броні гостя

==GetGroupAccountBill==
Функція GetGroupAccountBill формує і повертає рахунок групи у вигляді стисненого zip документа або папки в потрібному форматі.

'''Вхідні параметри:'''
1. Account - int, від 1 до +∞, ID групової броні
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою.
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. DocumentID - int, посилання на документ, який буде зроблено

==GetGroupAccountConfirm==
Функція GetGroupAccountConfirm формує і повертає групове підтвердження бронювання у вигляді стисненого zip документа або папки в потрібному форматі.

'''Вхідні параметри:'''
1. Account - int, від 1 до +∞, ID групової броні
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою.
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. DocumentID - int, посилання на документ, який буде зроблено

==GetLoyaltyCardNumberInfo==
Функція GetLoyaltyCardNumberInfo повертає інформацію за карткою лояльності. Якщо картки немає, то повертається помилка.

'''Вхідні параметри:'''
1. CompanyID - int, ідентифікатор компанії, >0 - визначає ID компанії під якою відбувається бронювання
2. LoyaltyCardTypeID - int, ідентифікатор типу карти лояльності.
3. HotelID - int, від 1 до +∞, ID готелю
4. LoyaltyCardNumber - string, номер картки лояльності.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. СontractConditionID - int, 0 - немає значення, ідентифікатор умови договору компанії.
5. СontractConditionName - string, назва умови договору компанії.
6. PaidTypes - int[], масив кодів типів оплат доступних за цією умовою. Значення елементів масиву: 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
7. GuestLastName - string, прізвище гостя
8. GuestFirstName - string, ім'я гостя
9. PriceListID - int, 0 - немає значення, 1 до +∞ - ID прейскуранта

==GetLoyaltyCardTypes==
Функція GetLoyaltyCardTypes повертає інформацію щодо заведених програм карт лояльності.

'''Вхідні параметри:'''
Немає

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. LoyaltyCardTypes - LoyaltyCardType[], одновимірний масив JSON структур LoyaltyCardType, у якому зберігається інформація про типи програм лояльності:
a. LoyaltyCardTypeID - int, ідентифікатор типу картки лояльності.
b. LoyaltyCardTypeName - string, назва типу картки лояльності.

==GetDocument==
Функція GetDocument повертає інформацію щодо сформованого документа, поставленого для створення раніше.

'''Вхідні параметри:'''
1. DocumentID - int, ідентифікатор документа для пошуку.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. IsReady - bool, логічне значення, що визначає, чи готовий документ на поточний момент. При цьому запит може бути опрацьовано, але документ не сформовано через помилку.
5. DocumentCode - string, бінарний код документа або папки формату zip потрібного формату даних у вигляді рядка в Base64.

==GetReservationInfo==

Функція GetReservationInfo повертає інформацію щодо створеного бронювання, дані повертаються тільки для підтверджених бронювань. Додатково додано відображення даних за заброньованими заходами в разі якщо Л/Рахунок має префікс A і групи префікс G

'''Вхідні параметри:'''
1. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. HotelID - int, від 1 до +∞, ID готелю
5. AccountName - string, ПІБ гостя в бронюванні / назва заходу.
6. DateArrival - datetime, дата і час заїзду.
7. DateDeparture - datetime. Дата і час виїзду.
8. Adults - int, від 1 до 1000. Кількість дорослих людей
9. Childs - int, від 0 до 1000. Кількість дітей
10. RoomTypeID - int, 1 до +∞, ID категорії номера / ID типу заходу
11. RoomType -string, назва категорії номера/ назва типу заходу
12. StatusID - int, код статусу бронювання
13. StatusName - string, назва статусу бронювання гостя/заходу
14. Email - рядок, електронна пошта гостя/заходу
15. PaidType - int, тип оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
16. ServiceProviderID - int, ідентифікатор постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.
17. ServiceProviderName - string, найменування постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.
18. Services - Service[], одновимірний масив JSON структур Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
a. ServiceID - int, ідентифікатор послуги
b. ServiceName - string, назва послуги
c. ServiceCode - int, бухгалтерський код послуги
d. ServiceSystemCode - string, системний код
e. ServiceTypeName - string, назва типу улуги
f. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
i. Date - datetime, дата і час споживання послуги
ii. Price - double, сума нарахування в поточний день
iii. CustomerAccount - string, ідентифікатор бронювання споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
iv. IsPaid - bool, показує, чи було нарахування послуги оплачено. True - для повної та часткової оплати.
v. IsPaidFromSite - bool, показує чи було нарахування послуги оплачено через сайт. Заповнюється, якщо IsPaid = true.
vi. PayAccount - string, особовий рахунок, від якого пройшла оплата.
vii. OrderID - ідентифікатор платіжної операції сайту Reikartz.
viii. ServiceProviderID - int, ідентифікатор постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.
ix. ServiceProviderName - string, найменування постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.
19. MinPays - MinPayInfo[], одновимірний масив JSON структур MinPayInfo, в якому міститься інформація про обмеження "Мінімальна передоплата":
a. Account - string, ID групи або гостя
b. Days - int, кількість днів.
c. CancelationDate - string, необов'язкове поле, дата ануляції броні (н/р: "2021-04-12 18:13:50 +03:00")

==GetRoomType==
Функція GetRoomType повертає повний опис номера за ID і локалізаціями

'''Вхідні параметри:'''
1. RoomTypeID - int, від 1 до +∞, ID категорії кімнати.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. MainPlacesCount - int, кількість основних місць у номері.
5. MaxAdditionalPlacesCount - int, Максимальна кількість додаткових ліжок у категорії номері

==GetClientDocuments==
Функція GetClientDocuments повертає інформацію списку паспортних даних гостя.

'''Вхідні параметри:'''
1. GuestCode - string, HEX рядок, 4 блоки по 4 символи з роздільником дефісом, що містить масив зашифрованих TripleDes алгоритмом даних. Перші 4 байти int32 представлення ID броні даних броні гостя, 5й байт перші 2 цифри року, 6й байт останні 2 цифри року, 7й байт місяць, 8й байт число місяця дати заїзду гостя. Приклад і код виконання нижче.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. HotelID - int, від 1 до +∞, ID готелю
5. GuestID - int, від 1 до +∞, ID гостя
6. GuestName - string, ПІБ гостя в бронюванні.
7. DateArrival - datetime, дата і час заїзду.
8. DateDeparture - datetime. Дата і час виїзду.
9. Adults - int, від 1 до 1000. Кількість дорослих людей
10. Childs - int, від 0 до 1000. Кількість дітей
11. RoomTypeID - int, 1 до +∞, ID категорії номера
12. StatusID - int, код статусу бронювання
13. StatusName - string, назва статусу бронювання гостя.
14. ClientDocumentTypes - ClientDocumentType[], одновимірний масив JSON структур ClientDocumentType, в якому зберігається інформація про типи реєстраційних документів клієнта:
a. ClientDocumentTypeID - int, ідентифікатор типу реєстраційного документа.
b. ClientDocumentTypeName - string, назва типу реєстраційного документа.
c. ClientDocumentFields - string[], одновимірний масив кодів необов'язкових полів реєстраційного документа для цього типу документа
d. ClientDocumentRequiredFields - string[], одновимірний масив кодів обов'язкових полів реєстраційного документа для цього типу документа
15. Clients - Client[], одновимірний масив JSON структур Client, у якому зберігається інформація про заведені реєстраційні дані гостя:
a. ClientID - int, ідентифікатор реєстраційних даних.
b. LastName - string, до 50, прізвище
c. FirstName - string, до 50, ім'я
d. MiddleName - string, до 50, по батькові
e. BirthDate - datetime, дата народження
f. Iso3Nationality - string, 3 символи, iso код країни громадянства
g. Address - рядок, адреса
h. Email - рядок, пошта
i. PhoneNumber - string, номер телефону
j. CarNumber - string, номер машини
k. AdultOrChild - boolean, дорослий чи дитина
l. IsMan - boolean, стать, true - чоловік, false - жінка
m. Vip - boolean, чи є VIP
n. Comment - string, до 500, коментар
o. DocumentPhotoURL - string, адреса для фото анкети
p. ClientDocumentTypeID - int, ідентифікатор типу реєстраційного документа.
q. ClientDocumentValues - ClientDocumentValue[], одновимірний масив JSON структур ClientDocumentValue, в якому зберігається інформація про значення полів реєстраційного документа, що засвідчує особу та закріплений за проживанням:
i. ClientDocumentFieldCode - string, код поля реєстраційного документа.
ii. ClientDocumentFieldValue - string, значення поля реєстраційного документа.

==SetClientDocuments==
Функція SetClientDocuments проставляє інформацію за списком паспортних даних гостя. Якщо додаються нові паспортні дані, то система перевіряє, збіг введених даних з уже заведеними в системі за такими полями: ПІБ, тип документа, номер і серія документа, дата народження, у разі відповідності даних поле з уже наявними в базі система автоматично підтягує старі дані й оновлює їх відповідно до решти полів.

'''Вхідні параметри:'''
1. GuestID - int, від 1 до +∞, ID гостя
2. Clients - Client[], одновимірний масив JSON структур Client, в якому зберігається інформація про заведені реєстраційні дані гостя:
a. ClientID - int, ідентифікатор реєстраційних даних. Для нових реєстраційних даних значення обирається випадково з діапазону від -10000 до -1, у межах однієї транзакції ідентифікатори не повинні збігатися.
b. LastName - string, до 50, прізвище для анкети - обов'язковий параметр
c. FirstName - string, до 50, ім'я
d. MiddleName - string, до 50, по батькові
e. BirthDate - datetime, дата народження - обов'язковий параметр
f. Iso3Nationality - string, 3 символи, iso код країни громадянства - обов'язковий параметр
g. Address - рядок, адреса
h. Email - рядок, пошта
i. CarNumber - string, номер машини
j. PhoneNumber - string, номер телефону
k. AdultOrChild - boolean, дорослий чи дитина
l. IsMan - boolean, стать, true - чоловік, false - жінка
m. Vip - boolean, чи є VIP
n. Comment - string, до 500, коментар
o. DocumentPhotoURL - string, адреса для фото анкети
p. DocumentScan - string, файл скану документа. Формат: "Розширення файлу"; "Тіло файлу у форматі base64", без пробілів, розширення також включає символ "."
q. ClientDocumentTypeID - int, ідентифікатор типу реєстраційного документа.
r. ClientDocumentValues - ClientDocumentValue[], одновимірний масив JSON структур ClientDocumentValue, у якому зберігається інформація про значення полів реєстраційного документа клієнта:
i. ClientDocumentFieldCode - string, код поля реєстраційного документа.
ii. ClientDocumentFieldValue - string, значення поля реєстраційного документа.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.

==GetCompanyReferencedData==
Функція GetCompanyReferencedData повертає дані довідників пов'язаних із компаніями.

'''Вхідні параметри:'''
1. Немає

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. CompanyLegalForms - CompanyLegalForm[], одновимірний масив JSON структур CompanyLegalForm , у якому зберігається інформація довідника про види правових форм для компаній:
a. LegalFormID - int, ідентифікатор правової форми компанії
b. LegalFormName - string, назва правової форми компанії

==SearchCompanies==
Функція SearchCompanies здійснює пошук компаній за ЄДРПОУ або ІПН.

'''Вхідні параметри:'''
1. ITN - рядок, ІПН компанії.
2. EGRPOU- рядок, ЄДРПОУ компанії.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Companies - CompanyData [], одновимірний масив JSON структур CompanyData, в якому зберігається інформація про знайдені компанії:
a. CompanyID - int, ідентифікатор компанії
b. LegalFormID - int, ідентифікатор правової форми компанії
c. Name - string, назва компанії
d. ITN - рядок, ІПН компанії
e. EGRPOU - рядок, ЄДРПОУ компанії.
f. LegalAddress- рядок, юридична адреса компанії.

==AddCompany==
Функція AddCompany створює нову компанію.

'''Вхідні параметри:'''
1. LegalFormID - int, ідентифікатор правової форми компанії
2. Name - string, назва компанії
3. ITN - рядок, ІПН компанії
4. EGRPOU - рядок, ЄДРПОУ компанії.
5. ContactPerson - рядок, контактна особа.
6. FactualAddress - рядок, фактична адреса компанії.
7. LegalAddress- рядок, юридична адреса компанії.
8. PostalAddress - рядок, поштова адреса компанії.
9. PhoneNumber - string, контактний номер телефону.
10. Email - рядок, контактний email.
11. Comment - string, примітки.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. CompanyID - int, ідентифікатор створеної компанії

==CancelReservation==
Функція CancelReservation здійснює ануляцію (скасування бронювання) гостя, групи або заходу, якщо це можливо.

'''Вхідні параметри:'''
1. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя, групи або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.

==GetRoomTypesMinPrice==
Функція GetRoomTypesMinPrice отримує мінімально можливу ціну за категоріями кімнат на 30 днів вперед. Значення функції отримується запитом аналогічним функції GetPrice, де в якості вхідних параметрів використовуються параметри індивідуального бронювання на 30 днів від поточної дати, 1 дорослого, без дітей, 1 місцеве розміщення без додаткових місць, без компанії, за прейскурантом для інтернету за замовчуванням. Отримане значення вартості проживання групується за днями і типами послуг і вибирається мінімальне значення.

'''Вхідні параметри:'''
1. HotelID - int - готель для якого потрібно брати ціни
2. RoomTypeIDs - int[], масив ідентифікаторів категорій номерів, для яких потрібно брати ціну, якщо порожній - то беремо весь готель

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
4. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
5. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
6. ErrorCode - string, код помилки.
7. Prices[] - одновимірний масив json, кількість елементів у ньому дорівнює кількості типів номерів у цьому готелі
a. RoomTypeID - int
b. DwellingPrice - double, за проживання
c. ToursborPrice - double, турсбір

==GetMinPrices==
Функція GetMinPrices повертає мінімально можливі ціни за вказаними готелями з розбивкою за категоріями кімнат на вказаний період. Значення функції отримується запитом аналогічним функції GetPrice, де в якості вхідних параметрів використовуються параметри індивідуального бронювання на вказаний період, 1 дорослого, без дітей, 1 місцеве розміщення без додаткових місць, від зазначеної компанії, за прейскурантами, доступними компанії. Отримане значення вартості проживання групується за днями і типами послуг і вибирається мінімальне значення.

'''Вхідні параметри:'''
1. HotelIDs - int[] - масив ідентифікаторів готелів, для яких потрібно брати ціни.
2. StartDate - datetime, дата початку періоду.
3. EndDate - datetime, дата закінчення періоду.
4. CompanyCode - string, довжина рядка до 20 символів. Ідентифікаційний код компанії.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. ValuteShort - рядок, скорочення базової валюти в зазначеній мові.
5. HotelsPrices - HotelsPrices[], одновимірний масив JSON структур HotelsPrices, в якому зберігається інформація за мінімальними цінами готелів на вказаний період:
a. HotelID - int, ідентифікатор готелю
b. HotelPrices - HotelPrices[], одновимірний масив JSON структур HotelPrices, в якому зберігається інформація за мінімальними цінами готелю на вказаний період:
i. Date - datetime, дата на яку розраховані ціни.
ii. MinPrice - мінімальна ціна готелю на дату.
iii. Rooms[] - одновимірний масив цін із розбивкою за категоріями кімнат:
1. RoomTypeID - int, ідентифікатор категорії кімнати.
2. Price - мінімальна з цін бронювання в цій категорії на дату, серед прейскурантів доступних за кодом компанії.

==GetAccountCancellation==
Функція GetAccountCancellation формує і повертає документ ануляції бронювання у вигляді стисненого zip документа або папки в потрібному форматі.

'''Вхідні параметри:'''
1. Account - int, від 1 до +∞, ID броні
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою.
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. DocumentID - int, посилання на документ, який буде зроблено

==GetGroupAccountCancellation==
Функція GetGroupAccountCancellation формує і повертає документ ануляції бронювання групи у вигляді стисненого zip документа або папки в потрібному форматі.

'''Вхідні параметри:'''
1. Account - int, від 1 до +∞, ID групової броні
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою.
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. DocumentID - int, посилання на документ, який буде зроблено

==AddFileToReservation==
Функція AddFileToReservation додає до сутності файли документів.

'''Вхідні параметри:'''
1. Account - string, ідентифікатор бронювання. Строкове (10/11 символів) представлення Л/Рахунку гостя, групи або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
2. FileName - string, назва файлу з розширенням. До прив'язки приймаються файли тільки з такими розширеннями ".png", ".jpg", ".jpeg", ".bmp", ".tiff", ".tif", ".gif", ".pdf", ".doc", ".docx", ".xls", ".xlsx", ".odt", ".ods", ".txt", ".zip", ".rar", ".7z".
3. FileBase64 - string, Тіло файлу в base64 форматі. Розмір рядка має бути в межах від 100 до 4 000 000 символів.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Account - string, ідентифікатор бронювання.

==GetBillInfo==
Функція GetBillInfo отримує інформацію про рахунок за його ID. Дані повертаються тільки якщо рахунок є рахунком верхнього рівня.

'''Вхідні параметри:'''
1. BillID - string, ідентифікатор рахунку.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки;
4. PayerID - int, ID платника;
5. Status - int, статус рахунку: 0 - не збережений, 1 - відкритий, 2 - закритий, -1 - анульований;
6. PayerPrintName - string, найменування платника;
7. ValuteID - int, ID валюти;
8. ValuteShort - string, скорочення валюти;
9. ServiceProviderID - int, ID постачальника послуг;
10. ServiceProviderName - string, найменування постачальника послуг;
11. Services - Services[], одновимірний масив JSON структур Service, у якому зберігається така інформація:
a. ServiceID - int, ідентифікатор послуги;
b. ServiceName - string, назва послуги;
c. ServiceCode - int, бухгалтерський код послуги;
d. ServiceSystemCode - string, системний код;
b. ServiceTypeName - string, назва типу улуги;
e. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуг для зазначеного проміжку часу:
i. Date - datetime, дата і час споживання послуги;
ii. PaymentID - int, ID нарахування;
iii. CustomerAccount - string, ідентифікатор споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс""Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями;
iv. CustomerName - string, найменування споживача послуги;
v. Quantity - десяткова, кількість;
vi. Price - десяткова, ціна;
vii. IsPaid - bool, показує чи було нарахування послуги оплачено. True - оплачено;
viii. IsPaidFromSite - bool, чи було оплачено нарахування через сайт. True - якщо було оплачено через сайт;
ix. OrderID - ідентифікатор платіжної операції сайту.

==SetBillPayment==
Функція SetBillPayment приймає ID наявного рахунка і список послуг для оплати, формує чек на оплату і оплачує за касою.

'''Вхідні параметри:'''
1. BillID - int, ID рахунку для оплати;
2. RRN - string, RRN-код платіжної операції;
3. OrderID - int, необов'язкове поле. Ідентифікатор платіжної операції сайту Reikartz;
4. Services - Service[], одновимірний масив JSON структур Service, у якому зберігається така інформація:
a. ServiceID - int, ідентифікатор послуги;
b. ServiceName - string, назва послуги, допускається порожнє значення;
c. ServiceCode - int, бухгалтерський код послуги, допускається порожнє значення;
d. ServiceSystemCode - string, системний код, допускається порожнє значення;
e. ServiceTypeName - string, назва типу послуги, допускається порожнє значення;
f. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, у якому зберігається інформація за цінами послуги для зазначеного часового проміжку:
i. Date - datetime, дата і час споживання послуги;
ii. Price - double, сума нарахування в поточний день;
iii. CustomerAccount - string, ідентифікатор бронювання споживача послуги. Строкове (10/11 символів) представлення Л/Рахунку гостя або заходу. Формат: "Префікс", "Натуральне число", де префікс - буква з множини {'' (порожньо = гість), 'A' (activity = захід), 'G' (group = група)}, "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями.
iv. Quantity - int, кількість наданої послуги.
v. PaymentID – int, ID нарахування
vi. PaySum – decimal, сума оплати
'''Значення, що повертається:'''

Повертається JSON структура з такими полями:

1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Еrror, 2 - Incorrect string. 
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок. 
ErrorCode - string, код помилки.

==GetReceiptBill==
Функція GetReceiptBill формує і повертає рахунок у вигляді стисненого zip документа або папки в потрібному форматі.

Вхідні параметри:
1. BillID - int, ID рахунку;
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови для створення документа потрібною мовою;
3. Format - int, необов'язкове поле формату документа, що повертається: 0 - PDF, 1 - HTML, 2 - Excel, 3 - Doc. За замовчуванням : 0;

Значення, що повертається:

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки;
4. DocumentID - int, посилання на документ, який буде зроблено.

==GetVariantRooms==
Функція GetVariantRooms повертає за вхідними параметрами список категорій номерів із кількістю вільних місць на різні дати.

'''Вхідні параметри:'''
1. HotelID- int, ID готелю;
2. DateArrival - date, бажана дата заїзду - ведеться ігнорування часу;
3. DateDeparture - date, бажана дата виїзду - ведеться ігнорування часу;
4. TimeArrival - string, 5 символів - час заїзду (н/р: "14:00"), якщо час заїзду не вказано, передавати порожній рядок, у такому разі час заїзду буде проставлятися в автоматичному режимі;
5. TimeDeparture - string, 5 символів - час виїзду (н/р: "14:00"), якщо час виїзду не вказано, передавати порожній рядок, у такому разі час виїзду буде проставлятися в автоматичному режимі;
6. Adults - int, від 1 до 1000. Кількість дорослих людей;
7. Childs - int, від 0 до 1000. Якщо кількість дітей немає на формі (визначається параметром), приходить порожній рядок;
8. ChildAges - int[], масив цілих чисел, що означають вік кожної дитини. Якщо кількість дітей більша за розмірність наступного за ним масиву вікових груп, то повертається помилка;
9. RoomTypeIDs - int[], масив ідентифікаторів типів кімнат;
10. IsExtraBedUsed - bool, логічне значення. Можливість використання додаткових місць для видачі номерів;
11. CompanyCodeID - int, ідентифікатор коду компанії, 0 - немає, >0 - визначає ID компанії під якою відбувається бронювання.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки;
4. RoomTypes - RoomTypes[], одновимірний масив JSON структур RoomType, у якому зберігається інформація за категоріями кімнат:
a. ID - int, ID категорії номера в базі PMS.
b. PeriodOfResidence - PeriodOfResidence[], одновимірний масив JSON структур PeriodOfResidence, у якому зберігається інформація щодо можливих періодів бронювання:
i. FirstDate - DateTime, дата і час заїзду;
ii. LastDate - DateTime, дата і час виїзду; iii. FreeRoom - int, кількість.

==GetRentals==

Функція GetRentals повертає за вхідними параметрами список типів прокатів із зазначенням кількості вільних ресурсів прокатів кожного типу і зазначенням списку послуг і цін на кожен день.

'''Вхідні параметри:'''
1. HotelID - int, від 1 до +∞, ID готелю;
2. CompanyID - int, ідентифікатор компанії, 0 - немає, >0 - визначає ID компанії під якою відбувається бронювання;
3. StartDate - date, дата початку прокату - ведеться ігнорування часу;
4. EndDate - date, дата закінчення прокату прокату - ведеться ігнорування часу;
5. StartTime - string, 5 символів - час початку прокату (н/р: "14:00"), якщо час не вказано, передавати порожній рядок, у такому разі час виїзду проставлятимуть в автоматичному режимі;
6. EndTime - string, 5 символів - час закінчення прокату (н/р: "14:00"), якщо час не вказано, передавати порожній рядок, у такому разі час виїзду проставлятимуть в автоматичному режимі;
7. LoyaltyAuthCode - string, Номер картки лояльності;
8. ContractConditionID - int, ідентифікатор умови договору, за якою необхідно отримати PriceLists. 0 - системна умова, >0 - ідентифікатор обраної умови;
9. ContractConditionAddIDs- int[], масив ідентифікаторів умов договорів, за якими необхідно отримати PriceLists;
10. PaidType - int, тип оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
11. IsoLanguage - string, 2 символи, двобуквена iso назва мови для виведення запиту
4. EndDate - date, дата закінчення прокату прокату - ведеться ігнорування часу;
5. StartTime - string, 5 символів - час початку прокату (н/р: "14:00"), якщо час не вказано, передавати порожній рядок, у такому разі час виїзду проставлятимуть в автоматичному режимі;
6. EndTime - string, 5 символів - час закінчення прокату (н/р: "14:00"), якщо час не вказано, передавати порожній рядок, у такому разі час виїзду проставлятимуть в автоматичному режимі;
7. LoyaltyAuthCode - string, Номер картки лояльності;
8. ContractConditionID - int, ідентифікатор умови договору, за якою необхідно отримати PriceLists. 0 - системна умова, >0 - ідентифікатор обраної умови;
9. ContractConditionAddIDs- int[], масив ідентифікаторів умов договорів, за якими необхідно отримати PriceLists;
10. PaidType - int, тип оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата.
11. IsoLanguage - string, 2 символи, двобуквена iso назва мови для виведення запиту.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки;
4. ValuteShort - string, рядок, скорочення базової валюти в зазначеній мові
5. RentalTypes - RentalType[], одновимірний масив JSON структур RentalType, у якому зберігається інформація про типи прокатів:
a. ID - int, ID типу прокату в базі PMS.
b. RentalTypeName - string, найменування типу прокату
c. FreeRentalResource - int, кількість вільних ресурсів прокату цього типу для бронювання.
d. PriceLists - PriceList[], одновимірний масив JSON структур PriceList, у якому зберігається інформація про прейскуранти, що повертаються, а також про ціни для цих прейскурантів на запитувані категорії кімнат:
i. PriceListID - int, ID прейскуранта в базі HMS;
ii. PriceListName - string, найменування прейскуранта;
iii. ConditionID - int, ID умови договору; iv. IsNonReturnRate - int, ознака неповоротного тарифу, 1 - неповоротний тариф, 0 - поворотний тариф.
v. IsSpecRate- int, ознака спеціальної пропозиції, 1 - спеціальна пропозиція, 0 - звичайний тариф.
vi. Services - Service[], одновимірний масив JSON структур
Service, в якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних послуг:
1. ServiceID - int, ідентифікатор послуги
2. ServiceName - string, назва послуги
3. ServiceCode - int, податковий код групи
4. ServiceSystemCode - string, системний код
5. ServiceTypeName - string, назва типу улуги
6. PriceDates - PriceDate[], одновимірний масив JSON структур PriceDate, в якому зберігається інформація за цінами послуги для категорії кімнати для зазначеного часового проміжку. Кількість елементів у цьому масиві визначає кількість дат, що відображаються користувачеві на сайті:
a. Date - datetime, дата і час споживання послуги
b. Price - double, сума нарахування в поточний день
c. RackRatePrice - double, сума нарахування в поточний день за прейскурантом стійки

==AddRentalReservation==
Функція AddRentalReservation створює нові броні прокатів у базі за вхідними параметрами, і повертає ID прокатів.

'''Вхідні параметри:'''
1. HotelID - int, від 1 до +∞, ID готелю
2. Account - string, ідентифікатор бронювання споживача прокату. Строкове (1013 символів) представлення Л/Рахунку гостя або персонального акаунта.
Формат: "Префікс""Натуральне число""Суфікс", де префікс - буква з множини {'' (порожньо= гість), 'B' (персональний акаунт) "Натуральне число" - ідентифікатор відповідного об'єкта в системі Servio з провідними нулями,
"Суфікс"
- суфікс системи (необов'язковий параметр)
3. Rentals- Rental[], одновимірний масив JSON структур Service, у якому зберігається інформація за цінами послуг. Кількість елементів у цьому масиві визначає кількість різних прокатів, які потрібно забронювати:
a. RentalTypeID - int, ID типу прокату.
b. StartDate - datetime, дата початку прокату.
c. EndDate - datetime, дата закінчення прокату.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Еrror, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.
4. Rentals- int[], масив цілих чисел, що позначає ID заброньованих прокатів
CancelRentals
Функція CancelRentals здійснює ануляцію (скасування бронювання) прокатів.
Вхідні параметри:
1. RentalIDs - int[], масив цілих чисел, що позначає ID прокатів.
Значення, що повертається:
Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string.
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок.
3. ErrorCode - string, код помилки.

==UpdateHotelInfo==
Оновлення інформації щодо готелів.

'''Вхідні параметри:'''
1. HotelInfos - HotelInfo[], одновимірний масив JSON структур HotelInfo, у якому міститься така інформація:
1.1 HotelID - int, ID готелю для якого оновлюється інформація;
2.1 Base64Images - string[], масив рядків, що
містять закодовані в Base64 формат послідовність байт вмісту файлів зображень;
3.1 HotelContacts - HotelContact[], одновимірний
масив JSON структур HotelContact, у якому міститься опис інформації щодо готелю певною мовою і має такі поля:
a. LanguageISO1Code - string, двобуквений код мови, для якої оновлюється інформація;
b. HotelName- string, назва готелю відповідною мовою;
c. HotelAddress - string, адреса готелю відповідною мовою;
d. HotelDescription - string, опис готелю відповідною мовою.

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки.

==UpdateRoomTypeInfo==
Оновлення інформації за типами номерів готелю.

Вхідні параметри:
1. RoomInfos - RoomInfo[], одновимірний масив JSON структур RoomInfo, у якому міститься така інформація:
1.1 RoomTypeID - int, ID типу номера для якого оновлюється інформація;
2.1 Base64Images - string[], масив рядків, що
містять закодовані в Base64 формат послідовність байт вмісту файлів зображень;
3.1 RoomTypeDescriptions - RoomTypeDescription[], одновимірний масив JSON структур RoomTypeDescription, у якому міститься опис інформації за типом номера певною мовою і має такі поля:
a. LanguageISO1Code - string, двобуквений код мови, для якої оновлюється інформація;
b. RoomTypeDescription - string, опис номера певною мовою.

Значення, що повертається:

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки.

==GetServicePrices==
Отримання вартості певної послуги для певного прейскуранта.

'''Вхідні параметри:'''
1. PriceListID - int, ідентифікатор прайс-листа для якого треба отримати вартість послуги;
2. IsGroup - bool, true - розрахунок проводиться для групи, false - для гостя;
3. Services - Service[], одновимірний масив JSON структур Service, у якому міститься така інформація:
3.1. ServiceCode - int, код послуги;
3.2. Quantity - десяткова, кількість;
3.3. ConsumptionDate - datetime, дата і час споживання послуги.
4. ISOCodeValute - string, необов'язковий параметр, 3 символи, трибуквена iso
назва валюти.

==GetReservationInfoByEmail==
Отримання інформації про бронювання по email.

'''Вхідні параметри:'''
1. Email - string, email адреса, за якою шукатимуться броні;
2. Limit - int, кількість записів, які будуть виведені у відповіді;
3. Offset - int, кількість записів, які потрібно пропустити;

'''Значення, що повертається:'''

Повертається JSON структура з такими полями:
1. Result - int, ціле число, що відповідає за результат виконання функції, 0 - OK, 1 - Function Error, 2 - Incorrect string;
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок;
3. ErrorCode - string, код помилки;
4. Length - int, загальна кількість броней, які знайшлися за заданим email;
5. Reservations - Reservation[], одновимірний масив JSON структур Reservation, у якому міститься така інформація:
5.1. Account - рядок, ідентифікатор бронювання;
5.2. AccountName - string, ПІБ гостя в бронюванні / назва заходу.
5.3. HotelID - int, ID готелю, якому належить бронь;
5.4. DateArrival - DateTime, дата заїзду/дата початку заходу;
5.5. DateDeparture - DateTime, дата виїзду/дата закінчення заходу;
5.6. Adults - int, від 1 до 1000. Кількість дорослих людей;
5.7. Childs - int, від 0 до 1000. Кількість дітей;
5.8. RoomTypeID - int, 1 до +∞, ID категорії номера / ID типу заходу;
5.9. RoomType -string, назва категорії номера/ назва типу заходу;
5.10. StatusID - int, код статусу бронювання;
5.11. StatusName - string, назва статусу бронювання гостя/заходу

==OnlinePaymentInfo==
Отримання інформації про нарахування та рахунки для оплати онлайн системою.

'''Вхідні параметри:'''
1. Account - string, акаунт, про який необхідно отримати інформацію (формат:
<префікс><ідентифікатор доповнений зліва нулями до 10 символів>, префікси та їхні об'єкти: "" - гість, "G" - група, "A" - захід, "I" - рахунок)
2. ValuteISOCode - string, код валюти згідно з ISO 4217

'''Значення, що повертається:'''
1. Result - int, результат виконання, 0 - OK, 1 - Function Error, 2 - Incorrect string
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок
3. ErrorCode - string, код помилки
4. HotelID - int, ідентифікатор готелю
5. AccountName - string, найменування платника
6. FirstDate - date, дата заїзду/початку
7. LastDate - date, дата виїзду/кінця
8. Adults - int, кількість дорослих
9. Childs - int, кількість дітей
10. TypeID - int, ідентифікатор типу/категорії
11. TypeName - string, найменування типу/категорії
12. StatusID - int, код статусу
13. StatusName - string, назва статусу
14. Email - рядок, електронна пошта
15. Phone - рядок, контактний телефон
16. ValuteISOCode - string, код валюти згідно з ISO 4217
17. ValuteShort - string, скорочення валюти
18. PaidType - int, код типу оплати 100 - готівка, 200 - кредитна картка, 300 - безготівкова оплата
19. ServiceProviderID - int, ідентифікатор постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою
20. ServiceProviderName - string, найменування постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою
21. Services - ServiceInfo[], інформація за цінами послуг поза рахунком
21.1. ServiceID - int, ідентифікатор послуги
21.2. ServiceName - string, найменування послуги
21.3. ServiceCode - int, крд послуги
21.4. ServiceSystemCode - string, системний код послуги
21.5. ServiceTypeName - string, назва типу послуги
21.6. PriceDate - PriceDate[], інформація про ціни для проміжку часу
21.6.1. Date - date, дата споживання
21.6.2. Price - десяткова?, вартість
21.6.3. TaxRate - decimal?, податкова ставка
21.6.4. TaxAmount - decimal?, сума податку
21.6.5. IsPaid - bool, ознака оплати (як повної так і часткової)
21.6.6. CustomerAccount - особовий рахунок споживача
21.6.7. PayAccount - особовий рахунок платника (присутній тільки для оплачених)
21.6.8. ServiceProviderID - int, ідентифікатор постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою.
21.6.9. ServiceProviderName - string, найменування постачальника послуг, що використовується для виставлення рахунків під час оплати кредитною карткою
22. Bills - BillInfo[], інформація за рахунками
22.1. BillID - int, ідентифікатор рахунку
22.2. ServiceProviderID - int, ідентифікатор постачальника послуг у рахунку
22.3. ServiceProviderName - string, найменування постачальника послуг у рахунку
22.4. Services - ServiceInfo[], інформація щодо послуг у рахунку

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

'''Вхідні параметри:'''
1. HotelId - int, ID готелю, для якого потрібно отримати список кімнат.

'''Значення, що повертається:'''
1. Result - int, результат виконання, 0 - OK, 1 - Function Error, 2 - Incorrect string
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок
3. ErrorCode - string, код помилки
4. Rooms - Room[], інформація по кімнатах
4.1. RoomId - int, ідентифікатор кімнати
4.2. RoomNumber - string, номер кімнати

==SendGuestConfirmation==
Відправка підтвердження бронювання/ануляції гостя. Перша відправка має бути з параметром DocumentID = null. На цьому етапі буде повернено DocumentID, який відповідатиме ID шаблону, який формується.
Далі, використовуючи отриманий на першому етапі DocumentID, додаючи його до запиту, ми можемо перевірити готовність шаблону для відправки. Якщо шаблон готовий - документ буде одразу відправлено, якщо ж він ще не встиг згенеруватись - повідомлення не буде відправлено, а у відповідь на запит поле IsReady буде дорівнювати null.

'''Вхідні параметри:'''
1. Account - string, Особовий рахунок гостя.
2. IsoLanguage - string, 2 символи, двобуквена iso назва мови.
3. PhoneNumber - string, необов'язковий параметр, номер телефону гостя. Якщо вказано - додатково фільтрує клієнтів по номеру. Необхідний для відправки Alpha/Turbo.
4. DocumentID - int, необов'язковий параметр, ID згенерованного шаблону для перевірки готовності.

'''Значення, що повертається:'''
1. Result - int, результат виконання, 0 - OK, 1 - Function Error, 2 - Incorrect string
2. Error - string, текст помилки, що сталася, якщо функція виконана успішно, то передається порожній рядок
3. ErrorCode - string, код помилки
4. IsReady - bool, повідомляє, чи готовий документ для відправки, при цьому запит може бути оброблений, але документ не було сформовано через помилку. true - шаблон готовий, false - шаблон не готовий.
5. DocumentID - int, ID документу, для перевірки готовності.
6. IsMessageSent - bool, уведомляет, было ли отправлено сообщение.
6. MessageSentComment - string, коментар для успішно відправленого повідомлення (В який месенджер було відправлено та які були помилки).

Налаштування Pre-chekin

2026-03-31T08:18:36Z

Andriy.Kolch: /* Налаштування Pre-ChekIn у модулі бронювання */

__TOC__

==Налаштування конфігураційного файлу ExternalConection==

Для зберігання файлів під час попередньої реєстрації (далі — Pre-Checkin) служба External повинна знати шлях, куди зберігати файли. 

Відкрийте файл ExternalConnectionService.exe.config у папці служби External. 
Знайдіть параметр ContentPath та вкажіть у ньому шлях до папки Content, яка використовується для збереження файлів. 
Папка Content знаходиться у файлах сайту HMS. 
Приклад шляху: 
D:\Servio_HMS\HMS_DevTest_Andy\HMS\Content\ 
[[Файл:ContentPath.png|1200 px]] 

Після збереження змін у конфігураційному файлі перезапустіть службу ExternalConnection. 

==Налаштування Pre-ChekIn у модулі бронювання==

Для відображення сторінки Pre-Checkin у модулі бронювання необхідно увімкнути відповідні параметри в налаштуваннях готелю в адмін-панелі модуля. 

Як увімкнути: 
#Перейдіть до налаштувань готелю в акаунті компанії. 
#Відкрийте блок «Відображення модуля бронювання». 

У цьому блоці доступні такі параметри: 

*Показувати сторінку попередньої реєстрації 
(за замовчуванням вимкнений) 
— при увімкненні додає сторінку Pre-Checkin як окремий крок у процесі бронювання. 
*Попередня реєстрація обов’язкова 
(за замовчуванням вимкнений) 
— при увімкненні користувач не зможе перейти до наступного кроку бронювання, поки не заповнить дані Pre-Checkin. 

[[Файл:Відображення модуля.png|1200 px]] 

Важливо: 
*Якщо увімкнено лише перший параметр, сторінку Pre-Checkin можна пропустити. 
*Якщо увімкнено обидва параметри, попередня реєстрація стає обов’язковою. 
Завершення: 
#Увімкніть параметр «Показувати сторінку попередньої реєстрації» (та, за потреби, другий параметр). 
#Збережіть налаштування. 

Після цього в модулі бронювання з’явиться сторінка Pre-Checkin як окремий крок після етапу «Ваші дані». 
[[Файл:PRCH.png|1200px]] 

==Посилання на сторінку Pre-ChekIn==

Для посилання на сторінку Pre-ChekIn використовується наступне посилання:

https://serviobooking.com/ServioQR/hms/precheckin/{Guest.Account}?companykey={key}

Дане посилання можна використовувати в шаблонах HMS, вставляючи їх з HTML-тегами (Так, само як посилання на оплату).
<a href="https://serviobooking.com/ServioQR/hms/precheckin/{Guest.Account}?companykey=9213697E-CA9F-4AE6-B2E5-C05C3BE47CCF" target="_blank">CHEK-IN.</a>

2026-02-26T15:19:06Z

Andriy.Kolch:

Period

Файл:Тип завдання.png

2026-02-26T15:06:05Z

Andriy.Kolch:

Тип завдання

Файл:Блок Завдання синхронізації.png

2026-02-26T15:00:35Z

Andriy.Kolch:

Блок Завдання синхронізації