API Протокол взаємодії Servio External Service з зовнішніми системами
(Перенаправлено з Протокол взаємодії Servio External Service з зовнішніми системами.)
Перейти до навігації
Перейти до пошуку
Опис Змін
| ДАТА ВНЕСЕННЯ | Мінімальна версія 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 з текстом рекомендацій. | ||||
| 29.07.2026 | 06.01.250 | 1.26 | Додано функції з ресторанної служби в загальне API: GetHotelRooms, GetTransactionObjects, DoTransaction, GetGuestNotConfirmSales, SetConfirmSale. В метод DoTransaction додано необов'язковий параметр ClientID для перевірки проживання клієнта в номері. | ||||
| 29.07.2026 | 06.01.250 | 1.27 | Додано новий метод GetReservationsModified для отримання нових/змінених бронювань з фільтрацією за компанією-оператором для корпоративних користувачів. | 07.08.2026 | 06.01.250 | 1.28 | Додано новий метод SendMessageFromHotel для відправки повідомлення (SMS/Viber за схемою вайбер-смс або email) на довільний контакт від імені готелю. |
Опис взаємодії
Формат переданих і прийнятих даних – протокол обміну JSON. Кодування запиту та відповіді UTF8.
Запити повинні містити інформацію про авторизацію, відповіді повинні містити інформацію про версію протоколу, знімок часу в момент відповіді сервера, інформацію про помилку. Приклад запиту та відповіді наведено нижче.
Права доступу розрізняються залежно від пари користувач/пароль, які вводяться в кожному JSON-запиті в розділі «Облікові дані»:
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
}
Опис функцій спілкування
GetRoomsModified
Отримання інформації про зміни на обраний період по номерам. Параметри: дані авторизації, готель (декілька?), час оновлення даних. Вхідні параметри:
{
"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
}
Значення що повертається:
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1780492860870",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Family Hotel",
"HotelShortName": "FH"
},
"Rooms": [
{
"Building": "Корпус 2",
"Checkup": false,
"CleanStatus": "light",
"Floor": "2",
"RoomId": 208,
"RoomNumber": "люкс",
"RoomStatus": null,
"RoomType": {
"AddBeds": 3,
"Beds": 5,
"RoomTypeId": 1045,
"RoomTypeName": "котедж",
"RoomTypeShortName": "кт"
},
"SaleStatus": "sale"
},
{
"Building": "Головний корпус",
"Checkup": false,
"CleanStatus": "light",
"Floor": "1",
"RoomId": 319,
"RoomNumber": "20",
"RoomStatus": {
"GuestStatus": "VAC",
"GuestsDeparture": {
"Adults": 1,
"ArrivalDateTime": "2025-12-19 15:45:04",
"CancelReasonID": null,
"CancelReasonName": null,
"CancelReasonString": null,
"ChannelReservationCode": null,
"Childs": 0,
"ChildsPay": 0,
"Clients": [],
"Company": null,
"CompanyID": null,
"ContactName": "",
"Cost": "",
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "2025-12-19 15:45:42",
"DateTimeReservation": "2025-12-19 15:42:03",
"DateTimeSettle": "2025-12-19 15:45:04",
"DepartureDateTime": "2025-12-19 15:45:42",
"Email": "",
"GroupID": null,
"GuestID": 33699,
"GuestName": "Пупупу",
"GuestStatus": 3,
"IdentityCards": [],
"LastChangeDate": "2025-12-19 15:45:42",
"ManagerActivities": [],
"ManagerID": 518,
"NightsCount": 0,
"Notes": [],
"OperatorCompany": null,
"PaidTypeID": 1,
"PaidTypeName": "Готівка",
"PayStatus": null,
"Payments": [],
"PersCancelation": null,
"PersDeparture": 518,
"PersReservation": 518,
"PersSettle": 518,
"Phone": "+380(66)209-58-17",
"Preferences": [],
"PriceList": {
"Description": " 1400.00",
"IsChargeBonuses": true,
"IsForInternet": false,
"IsNonReturnRate": false,
"IsRackRate": false,
"IsSpecRate": false,
"PriceListID": 109,
"PriceListName": "Стартовий"
},
"PriceListID": 109,
"PriceListName": "Стартовий",
"ReservationTypeID": 1,
"ReservationTypeName": "Гарантована",
"SourceCode": "",
"TourOperatorID": null,
"UTMParameters": null,
"Vip": "0"
},
"GuestsOccupied": [],
"GuestsReservation": {
"Adults": 1,
"ArrivalDateTime": "2026-05-30 14: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": "1 1",
"Cost": "",
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "",
"DateTimeReservation": "2026-05-29 17:57:32",
"DateTimeSettle": "",
"DepartureDateTime": "2026-05-31 12:00:00",
"Email": "",
"GroupID": null,
"GuestID": 36047,
"GuestName": "1 1 ",
"GuestStatus": 0,
"IdentityCards": [],
"LastChangeDate": "2026-05-29 17:57:32",
"ManagerActivities": [],
"ManagerID": null,
"NightsCount": 0,
"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": null,
"Payments": [],
"PersCancelation": null,
"PersDeparture": null,
"PersReservation": 393,
"PersSettle": null,
"Phone": "+380500000000",
"Preferences": [],
"PriceList": {
"Description": " 1400.00",
"IsChargeBonuses": true,
"IsForInternet": false,
"IsNonReturnRate": false,
"IsRackRate": false,
"IsSpecRate": false,
"PriceListID": 109,
"PriceListName": "Стартовий"
},
"PriceListID": 109,
"PriceListName": "Стартовий",
"ReservationTypeID": 0,
"ReservationTypeName": "Не гарантована",
"SourceCode": "ModulV4",
"TourOperatorID": 1204,
"UTMParameters": null,
"Vip": "0"
}
},
"RoomType": {
"AddBeds": 21,
"Beds": 3,
"RoomTypeId": 8,
"RoomTypeName": "Smart Double",
"RoomTypeShortName": "SMD"
},
"SaleStatus": "sale"
}
]
}
]
}
GetGuestsModified
Отримання інформації про гостей готелю.
Параметри: дані авторизації, готель (декілька?), час оновлення даних (обрізано те, що було раніше, якщо не вказано, то тільки для всіх гостей, що проживають,
або наступне бронювання, або останнє перебування в номері), масив з переборами відображених даних (проживання гостей (за замовчуванням, якщо не вказано), бронювання, виїзду, контактна інформація для гостей)
Вхідні параметри:
{
"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"]
}
}
Значення, що повертається:
{
"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": ""
}
{
"Guest": {
"Adults": 1,
"ArrivalDateTime": "2026-06-25 13: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": "s_h_admin Test",
"Cost": "3000.00",
"Country": null,
"DateTimeCancelation": "",
"DateTimeDeparture": "",
"DateTimeReservation": "2026-06-25 11:55:50",
"DateTimeSettle": "",
"DepartureDateTime": "2026-06-28 12:00:00",
"Email": "admin@company.com",
"GroupID": null,
"GuestID": 52249,
"GuestName": "s_h_admin Test ",
"GuestStatus": 0,
"IdentityCards": [],
"LastChangeDate": "2026-06-25 11:55:50",
"ManagerActivities": [],
"ManagerID": null,
"NightsCount": 3,
"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": 1,
"Payments": [
{
"AcceptanceDate": null,
"Barcode": null,
"ConsumptionDate": "2026-06-25 23:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"LastReceiptDate": "",
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Услуга",
"PackagePayments": [],
"PayAmount": "1000.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 197301,
"PaymentStatus": 1,
"PaymentType": 1,
"Price": "1000.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 1366,
"ServiceName": "проживання 2.0",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ 20%",
"TaxRate": "0.20",
"TaxSum": "166.67",
"UsedQuantity": ""
},
{
"AcceptanceDate": null,
"Barcode": null,
"ConsumptionDate": "2026-06-27 23:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"LastReceiptDate": "",
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Услуга",
"PackagePayments": [],
"PayAmount": "1000.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 197303,
"PaymentStatus": 1,
"PaymentType": 1,
"Price": "1000.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 1366,
"ServiceName": "проживання 2.0",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ 20%",
"TaxRate": "0.20",
"TaxSum": "166.66",
"UsedQuantity": ""
},
{
"AcceptanceDate": null,
"Barcode": null,
"ConsumptionDate": "2026-06-26 23:59:00",
"ExiseStamps": null,
"IsCanceled": false,
"IsPackagePayment": true,
"LastReceiptDate": "",
"MeasurementUnit": null,
"NomenclatureType": 1,
"NomenclatureTypeName": "Услуга",
"PackagePayments": [],
"PayAmount": "1000.00",
"PayAmountValuteISO": "UAH",
"PaymentId": 197304,
"PaymentStatus": 1,
"PaymentType": 1,
"Price": "1000.00",
"PriceValuteISO": "UAH",
"Quantity": "1.000",
"ServiceClassCode": "dwelling",
"ServiceClassName": "Послуги проживания",
"ServiceId": 1366,
"ServiceName": "проживання 2.0",
"ServiceSubClassCode": "dwelling",
"ServiceSubClassName": "Проживание",
"Tax2Rate": "",
"Tax2Sum": "",
"TaxName": "ПДВ 20%",
"TaxRate": "0.20",
"TaxSum": "166.67",
"UsedQuantity": ""
}
],
"PersCancelation": null,
"PersDeparture": null,
"PersReservation": 393,
"PersSettle": null,
"Phone": "",
"Preferences": [],
"PriceList": {
"Description": " 1400.00",
"IsChargeBonuses": true,
"IsForInternet": false,
"IsNonReturnRate": true,
"IsRackRate": false,
"IsSpecRate": false,
"PriceListID": 109,
"PriceListName": "Стартовий"
},
"PriceListID": 109,
"PriceListName": "Стартовий",
"ReservationTypeID": 1,
"ReservationTypeName": "Гарантована",
"SourceCode": "ModulV4",
"TourOperatorID": 1204,
"UTMParameters": null,
"Vip": "0"
},
"Room": {
"Building": "Головний корпус",
"Checkup": false,
"CleanStatus": null,
"Floor": "1",
"RoomId": 319,
"RoomNumber": "20",
"RoomStatus": null,
"RoomType": {
"AddBeds": 21,
"Beds": 3,
"RoomTypeId": 8,
"RoomTypeName": "Smart Double",
"RoomTypeShortName": "SMD"
},
"SaleStatus": "sale"
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Family Hotel",
"HotelShortName": "FH"
}
}
]
}
GetClientsModified
Отримання даних з анкет
- При HotelID = 0 повертаються всі анкети незалежно від наявності пов’язаного гостя.
- При HotelID ≠ 0 повертаються тільки ті анкети, для яких існує бронювання в зазначеному готелі.
- Якщо передано декілька значень HotelID (наприклад, [0,1]), то анкети з гостем у готелі 1 будуть дублюватися під обома HotelID: під 1 (за прямим фільтром) та під 0 (оскільки 0 означає «усі»).
Вхідні параметри:
{
"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 - жіночий
}
Значення, що повертається:
{
"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"
}
}
]
}
UpdateRooms
Оновлення статуса кімнат Вхідні параметри:
{
"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"
}
}
]
}
]
}
Значення, що повертається:
{
"VersionInfo": "0.1",
// час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
"RequestTime": "123423234",
// код помилки, 0 – помилок немає
"ErrorCode": "0",
"ErrorText": ""
}
GetCustomerPayments
Отримання інформації про нарахування клієнта.
Необхідно вказати або масив "Клієнти", або періоди надання/зміни послуги.
Якщо вказано і масив, і крапки, то інформація фільтрується тільки по масиву.
Періоди дати повинні бути повними (вказуються як початок, так і кінець), але не довше 31 дня.
Вхідні параметри:
{
"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]
}
Значення, що повертається:
{
"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"
}
]
}
],
}
GetUsers
Отримання списку активних користувачів готелю.
Вхідні параметри:
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// масив ідентифікаторів користувачів для фільтру. Якщо не вказано, то всі активні користувачі готелю
"UsersID": [1, 2, ...]
}
Значення, що повертається:
{
"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": "Петров Петро Петрович"
}
]
}
]
}
GetCompanies
Отримання списку відкритих компаній. Вхідні параметри:
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// масив ідентифікаторів компаній для фільтру. Якщо не вказано, то всі відкриті компанії
"CompaniesID": [1, 2, ...]
}
Значення, що повертається:
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1780493304967",
"VersionInfo": "1.0.0.3",
"Companies": [
{
"CompanyID": 2,
"CompanyName": "ТОВ Hotel",
"CompanyPrintCode": "30114888",
"CompanyPrintName": "ТОВ \"the Family Hotel\"",
"CompanyPrintSertificate": "38253100",
"Email": "info@servio.com.ua",
"ITN": "301143628888",
"IndustryID": null,
"IndustryName": "",
"Phone": "+380(44)537-01-68",
"SegmentID": null,
"SegmentName": ""
},
{
"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": ""
}
]
}
GetActivitiesModified
Отримання списку заходів. Вхідні параметри:
{
"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"]
}
}
Значення, що повертається:
{
"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}
GetGroupsModified
Отримання списку груп. Вхідні параметри:
{
"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"]
}
}
Значення, що повертається:
{
"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"
}
}
]
}
UpdateGuest
Оновлення інформації про гостя. Вхідні параметри:
{
"Credentials":{
"UserName":"username",
"Password":"password"
},
"GuestID":29177,
"Comment":"",
"UpdateFields":{
"ClientsToAdd":[49060],
"ClientsToDelete":[1,2]
}
}
Значення, що повертається:
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,
}
AddClient
Додавання нової анкети. Вхідні параметри:
{
"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"
}
]
}
Значення, що повертається:
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,
}
- перелік можливих значень поля DocumentType
•Passport •InternationalPassport •ServicePassport •DiplomaticPassport •CertificationSoldier •SeamanPassport •MilitaryID •DrivingLicence •TemporaryIdentityCard •ForeignCitizenPassport •BirthCertificate •IdentityCard •InternationalPassportNew •InternationalBirthCertificate •ExternalInternationalPassport •UssrPassport •ExternalBirthCertificate •ForeignBirthCertificate •TemporaryAsylumCertificate •CisCitizenIdentityCard •ForeignCitizenServicePassport •NationalForeignCitizenPassport •TemporaryAsylumReview
UpdateClient
Оновлення інформації по анкеті. Вхідні параметри:
{
"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":""
}]
}
}
Значення, що повертається:
{
"VersionInfo" : "",
Час, коли відповідь почала генеруватися на сервері в UTC (мілісекунди)
"RequestTime" : "345356546",
код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,
}
GetPriceListPrices
Отримання інформації про ціни послуг прайс-листів.
Вхідні параметри:
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
}
}
Значення, що повертається:
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"
}
]
}
]
}
]
}
SearchClients
Отримання списку анкет.
Вхідні параметри:
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
}
Значення, що повертається:
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
}
]
GetBills
Отримання інформації про рахунки.
Вхідні параметри:
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],
}
Значення, що повертається:
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": "Стандарт"
}
]
}
]
}
GetDepositAccounts
Отримання інформації про депозитні рахунки.
Вхідні параметри:
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"
}
Значення, що повертається:
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": [
{
"BillID": null,
"CreateUser": {
"LoginID": 447474,
"UserName": "Test"
},
"Date": "2022-05-31 17:16:00",
"DepositID": 13,
"FiscalID": 9,
"FiscalReceiptTypeCode": null,
"FiscalReceiptTypeID": 0,
"FiscalReceiptTypeName": null,
"FiscalSessionID": 5209,
"PaidType": "Cash",
"PayGroupType": 0,
"PayTypeID": 2,
"PayTypeName": "ГОТІВКА",
"ReceiptID": 12250,
"ReceiptPayTypeCode": "ГОТ",
"ReceiptPayTypeID": 2,
"ReceiptPayTypeName": "ГОТІВКА",
"RoundingDelta": 0,
"Sales": [
{
"AcceptanceDate": null,
"AdditionalServiceCode": null,
"Barcode": null,
"Canceled": false,
"CanceledDate": "",
"Comment": null,
"Consumer": "",
"ConsumerID": 6542,
"ConsumerTypeID": 0,
"ConsumptionDate": "",
"FiscalID": 9,
"LastReceiptID": 12250,
"MeasurementUnit": null,
"NomenclatureType": 0,
"NomenclatureTypeName": null,
"PaidType": "Cash",
"PayGroupTypeID": 0,
"PaymentID": 0,
"PeriodDateFrom": "",
"PeriodDateTo": "",
"Price": "300,0000",
"Quantity": "1",
"ReceiptPayTypeCode": "ГОТ",
"ReceiptPayTypeID": 2,
"ReceiptPayTypeName": "ГОТІВКА",
"RestaurantBill": null,
"RestaurantReceipt": null,
"RoundingDelta": null,
"SecondTaxName": "",
"SecondTaxSum": "",
"SecondTaxType": null,
"SecondTaxWage": "",
"ServiceClassCode": "Commission",
"ServiceClassID": 19,
"ServiceClassName": "Комісія",
"ServiceCode": "889",
"ServiceID": 207,
"ServiceName": "Предоплата за послуги готелю",
"ServiceSubClassCode": "",
"ServiceSubClassID": null,
"ServiceSubClassName": "",
"ServiceTypeID": 4,
"ServiceTypeName": "Грошові послуги",
"TaxGroupCode": "18",
"TaxGroupID": 18,
"TaxGroupName": "без податку2023",
"TaxName": "Не оподатковується",
"TaxSum": "0",
"TaxWage": "0,0000000000",
"Taxed": true,
"Total": "300,0000"
}
],
"Sum": 300.0000,
"SumBeforeRounding": null,
"SumWithTax": 300.0000,
"SumWithoutTax": 0,
"Taxes": [
{
"TaxName": "Не оподатковується",
"TaxSum": "0",
"TaxWage": "0,0000000000"
}
]
],
"ReceiptsReturns": [
{
"BillID": null,
"CreateUser": {
"LoginID": 844887,
"UserName": "Test"
},
"Date": "2023-10-24 15:14:00",
"DepositID": 15,
"FiscalID": 9,
"FiscalReceiptTypeCode": null,
"FiscalReceiptTypeID": 0,
"FiscalReceiptTypeName": null,
"FiscalSessionID": 7485,
"PaidType": "Cash",
"PayGroupType": 0,
"PayTypeID": 2,
"PayTypeName": "ГОТІВКА",
"ReceiptID": 21402,
"ReceiptPayTypeCode": "ГОТ",
"ReceiptPayTypeID": 2,
"ReceiptPayTypeName": "ГОТІВКА",
"RoundingDelta": 0,
"Sales": [
{
"AcceptanceDate": null,
"AdditionalServiceCode": null,
"Barcode": null,
"Canceled": false,
"CanceledDate": "",
"Comment": null,
"Consumer": "",
"ConsumerID": 1234,
"ConsumerTypeID": 0,
"ConsumptionDate": "",
"FiscalID": 9,
"LastReceiptID": 21402,
"MeasurementUnit": null,
"NomenclatureType": 0,
"NomenclatureTypeName": null,
"PaidType": "Cash",
"PayGroupTypeID": 0,
"PaymentID": 0,
"PeriodDateFrom": "",
"PeriodDateTo": "",
"Price": "600,0000",
"Quantity": "1",
"ReceiptPayTypeCode": "ГОТ",
"ReceiptPayTypeID": 2,
"ReceiptPayTypeName": "ГОТІВКА",
"RestaurantBill": null,
"RestaurantReceipt": null,
"RoundingDelta": null,
"SecondTaxName": "",
"SecondTaxSum": "",
"SecondTaxType": null,
"SecondTaxWage": "",
"ServiceClassCode": "Commission",
"ServiceClassID": 19,
"ServiceClassName": "Комісія",
"ServiceCode": "889",
"ServiceID": 207,
"ServiceName": "Предоплата за послуги готелю",
"ServiceSubClassCode": "",
"ServiceSubClassID": null,
"ServiceSubClassName": "",
"ServiceTypeID": 4,
"ServiceTypeName": "Грошові послуги",
"TaxGroupCode": "18",
"TaxGroupID": 18,
"TaxGroupName": "без податку2023",
"TaxName": "Не оподатковується",
"TaxSum": "0",
"TaxWage": "0,0000000000",
"Taxed": true,
"Total": "600,0000"
}
],
"Sum": 600.0000,
"SumBeforeRounding": null,
"SumWithTax": 600.0000,
"SumWithoutTax": 0,
"Taxes": [
{
"TaxName": "Не оподатковується",
"TaxSum": "0",
"TaxWage": "0,0000000000"
}
]
}
],
"Requisites": "2",
"ServiceProviderID": 1
"StartBalance": 0
}
],
"FiscalDevices": [
{
"CashCode": "О31 ",
"FiscalID": 6,
"FiscalName": "О3-test tk"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Отель 1",
"HotelShortName": "О1"
}
}
]
}
GetFiscalSessions
Отримання інформації про фіскальні сесії.
Вхідні параметри:
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],
}
Значення, що повертається:
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": "2026-02-06 14:00:00",
"BookingSource": "",
"CompanyOperatorID": null,
"Consumer": "F0000033985",
"ConsumerID": 33985,
"ConsumerTypeID": 1,
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2026-02-07 11:00:00",
"HousingID": 1006,
"HousingName": "Корпус 3",
"Name": "64684",
"PayTypeID": 1,
"PayTypeName": "Готівка",
"PriceListName": "Стартовий",
"Profiles": [],
"RoomNumber": "701",
"RoomTypeName": "Classic Double"
}
],
""FiscalDevices": [
{
"CashCode": "101",
"FiscalID": 7,
"FiscalName": "КАСА ФОП"
}
],
"FiscalSessions": [
{
"CashierShiftTotals": [
{
"CashierName": "QAtest",
"GrandTotalAmount": 1440.00,
"LoginID": 518,
"TotalBonusAmount": 0,
"TotalCardAmount": 1440.00,
"TotalCashAmount": 0.00,
"TotalCertificateAmount": 0,
"TotalDepositAmount": 0,
"TotalLoyaltyCardMoneyAmount": 0,
"TotalNonCashAmount": 0,
"TotalNonMoneyAmount": 0,
"TotalPaymentsMoney": 1452.50
},
{
"CashierName": "Servio reservation",
"GrandTotalAmount": 12900.00,
"LoginID": 393,
"TotalBonusAmount": 0,
"TotalCardAmount": 12900.00,
"TotalCashAmount": 0,
"TotalCertificateAmount": 0,
"TotalDepositAmount": 0,
"TotalLoyaltyCardMoneyAmount": 0,
"TotalNonCashAmount": 0,
"TotalNonMoneyAmount": 0,
"TotalPaymentsMoney": 12900.00
}
],
"CloseBalance": "44116,7400",
"CloseDate": "2026-03-09 17:43:17",
"CloseUser": {
"LoginID": 4784,
"UserName": "test"
},
"FiscalDeviceID": 7,
"FiscalSessionID": 8043,
"OpenBalance": "44116,7400",
"OpenDate": "2026-02-06 17:06:47",
"OpenUser": {
"LoginID": 4784,
"UserName": "test"
},
"Receipts": [
{
"BillID": 30589,
"CreateUser": {
"LoginID": 529,
"UserName": "Валентина "
},
"Date": "2026-05-22 11:37:00",
"DepositID": null,
"FiscalID": 1022,
"FiscalReceiptTypeCode": "ЧПЛ",
"FiscalReceiptTypeID": 1,
"FiscalReceiptTypeName": "Чек на оплату",
"FiscalSessionID": 7871,
"PaidType": "Credit",
"PayGroupType": 1,
"PayTypeID": 1021,
"PayTypeName": "Кредитна картка",
"ReceiptID": 24818,
"ReceiptPayTypeCode": "К4",
"ReceiptPayTypeID": 1021,
"ReceiptPayTypeName": "Кредитна картка",
"RoundingDelta": 0,
"Sales": [
{
"AcceptanceDate": "2026-05-23",
"AdditionalServiceCode": null,
"Barcode": null,
"Canceled": false,
"CanceledDate": "",
"Comment": null,
"Consumer": "F0000032800",
"ConsumerID": 32800,
"ConsumerTypeID": 1,
"ConsumptionDate": "2026-05-23 14:00:00",
"FiscalID": 1022,
"LastReceiptID": 24818,
"MeasurementUnit": null,
"NomenclatureType": 0,
"NomenclatureTypeName": "Товар",
"PaidType": "Credit",
"PayGroupTypeID": 1,
"PaymentID": 161455,
"PeriodDateFrom": "2026-05-23 14:00:00",
"PeriodDateTo": "2026-05-23 14:00:00",
"Price": "400,00",
"Quantity": "1,000",
"ReceiptPayTypeCode": "К4",
"ReceiptPayTypeID": 1021,
"ReceiptPayTypeName": "Кредитна картка",
"RestaurantBill": "",
"RestaurantReceipt": null,
"RoundingDelta": "",
"SecondTaxName": null,
"SecondTaxSum": "",
"SecondTaxType": null,
"SecondTaxWage": "",
"ServiceClassCode": "dwelling",
"ServiceClassID": 1,
"ServiceClassName": "Послуги проживания",
"ServiceCode": "98765",
"ServiceID": 1571,
"ServiceName": "тестова послуга",
"ServiceSubClassCode": "",
"ServiceSubClassID": null,
"ServiceSubClassName": "",
"ServiceTypeID": 1,
"ServiceTypeName": "Основні послуги",
"TaxGroupCode": "Product",
"TaxGroupID": 6,
"TaxGroupName": "Продукт",
"TaxName": "ПДВ 20%",
"TaxSum": "66,6700000000000",
"TaxWage": "0,2000000000",
"Taxed": false,
"Total": "400,00"
}
],
"ServiceProviderID": 1120,
"Sum": 400.00,
"SumBeforeRounding": 400.00,
"SumWithTax": 400.00,
"SumWithoutTax": 0,
"Taxes": [
{
"TaxName": "ПДВ 20%",
"TaxSum": "66,6700000000000",
"TaxWage": "0,2000000000"
}
]
},
"TotalReceipts": {
"ReceiptReturns": [
{
"FiscalReceiptTypeID": 2,
"FiscalReceiptTypeName": "Чек возврата оплаты",
"ReceiptPaidTypeID": 2088,
"ReceiptPaidTypeName": "Готівка",
"Sum": 12.50
}
],
"Receipts": [
{
"FiscalReceiptTypeID": 1,
"FiscalReceiptTypeName": "Чек на оплату",
"ReceiptPaidTypeID": 10,
"ReceiptPaidTypeName": "Кредитна картка",
"Sum": 14340.00
},
{
"FiscalReceiptTypeID": 1,
"FiscalReceiptTypeName": "Чек на оплату",
"ReceiptPaidTypeID": 2088,
"ReceiptPaidTypeName": "Готівка",
"Sum": 12.50
}
],
"TotalSum": 14352.50
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Family Hotel",
"HotelShortName": "FH"
}
}
]
}
AcceptSet
Встановлення позначки про обробку.
Вхідні параметри:
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"
}
Значення, що повертається:
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1652080021398",
"VersionInfo": "1.0.0.3"
}
PayToHMS
Імпорт оплати з бухгалтерії.
Вхідні параметри:
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"
}
]
}
Структура PayBinding:
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С для ідентифікації депозитних рахунків.
Структура ReturnPayBinding:
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С для ідентифікації депозитних рахунків.
Структура DeletedPayDox:
DocNumber (Рядок 11) – номер ПД. DocDate (Дата і час РРРР-ММ-ДД ЧЧ:мм:сс) – дата платіжного доручення (ПД) в 1С.
Значення, що повертається:
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
{
"ErrorCode":0,
"ErrorText":"",
"RequestTime":"1652080021476",
"VersionInfo":"1.0.0.3"
}
GetPaymentsDelivery
Отримання інформації про нарахування на доставку.
Параметри: авторизаційні дані, готелі, ідентифікатори нарахувань, коди класів послуг, коди груп послуг, початкова дата створення нарахування (не раніше).
Додаткові фільтри послуг (передаються послуги, які відповідають принаймні одному фільтру; порожній фільтр не обробляється; якщо всі фільтри порожні — передаються всі послуги).
Вхідні параметри:
{
"Credentials":{"UserName":"admin","Password":"expert"},
"Hotels":[1],
"ServiceIDs":[1,2],
"ServiceClassCodes":["eat"],
"ServiceGroupCodes":["delivery"],
"DatePaymentFrom":"2022-09-30 13:00:00"
}
Значення, що повертається:
{
"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"
}
}
]
}
GetRevenueInfo
Отримання статистичних даних.
Параметри: авторизаційні дані, готелі, ідентифікатори нарахувань, дати початку та кінця періоду.
Вхідні параметри:
{
"Credentials": {"UserName": "UserName","Password": "Password"},
"Hotels": [3],
"DateFrom": "2023-01-08",
"DateTo": "2023-01-20",
"ExtractClasses": ["eat", "wash", "minibar"],
"ExtractSubClasses": ["restaurant", "breakfast"]
}
Значення, що повертається:
{
"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
}
}
]
}
]
}
GetBillsGroupedSales
Отримання інформації про рахунки зі згрупованими нарахуваннями.
Вхідні параметри:
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"
}
Значення, що повертається:
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": ""
}
]
}
]
}
GetHotelRooms
Отримання списку номерів готелю.
Вхідні параметри:
int HotelID – ідентифікатор готелю.
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"HotelID": 1
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає.
string ErrorText – текст помилки.
Rooms[] – список номерів готелю. Структура з такими полями:
int RoomID – ідентифікатор номеру.
string RoomNumber – назва/номер кімнати.
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"Rooms": [
{
"RoomID": 101,
"RoomNumber": "101"
},
{
"RoomID": 102,
"RoomNumber": "202 Стандарт"
}
]
}
GetTransactionObjects
Отримання списку об'єктів для транзакції (нарахування з ресторану на номер, гостя або рахунок).
Вхідні параметри:
int HotelID – ідентифікатор готелю.
int AccountType – тип запрашуваного об'єкта (1 - гість, 4 - захід, 5 - перманентний рахунок, 6 - особистий рахунок).
int? GuestID – ідентифікатор гостя (необов'язковий параметр).
string RoomNumber – номер кімнати (необов'язковий параметр).
string DepositCardNumber – номер карти депозитного рахунку (необов'язковий параметр).
string LoyaltyCardNumber – номер карти лояльності (необов'язковий параметр).
string LockCardNumber – номер карти замкової системи (необов'язковий параметр).
string Name – ПІБ або назва (необов'язковий параметр).
string Account – номер рахунку (необов'язковий параметр).
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"HotelID": 1,
"AccountType": 1,
"GuestID": 35508,
"RoomNumber": "101",
"DepositCardNumber": "",
"LoyaltyCardNumber": "",
"LockCardNumber": "",
"Name": "",
"Account": ""
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає.
string ErrorText – текст помилки.
Objects[] – масив знайдених об'єктів для транзакції. Структура з такими полями:
int ObjectID – ідентифікатор об'єкту (наприклад, ID гостя).
string ObjectName – назва об'єкту (ПІБ гостя, назва заходу тощо).
int AccountType – тип знайденого об'єкта.
string AccountTypeStr – текстовий опис типу об'єкта.
string RoomNumber – номер кімнати (якщо є).
decimal Balance – поточний баланс.
decimal Limit – доступний ліміт.
int LimitType – тип ліміту.
string Info – додаткова інформація.
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"Objects": [
{
"ObjectID": 35508,
"ObjectName": "Петров Петро",
"AccountType": 1,
"AccountTypeStr": "Гість",
"RoomNumber": "101",
"Balance": 0.0,
"Limit": 5000.0,
"LimitType": 0,
"Info": ""
}
]
}
DoTransaction
Проведення транзакції (нарахування на номер/гостя/рахунок).
Вхідні параметри:
int HotelID – ідентифікатор готелю.
int AccountType – тип об'єкта (1 - гість, 4 - захід, 5 - перманентний рахунок, 6 - особистий рахунок).
int AccountID – ідентифікатор об'єкта (ID гостя, заходу тощо).
int? DepositID – ідентифікатор депозиту (необов'язковий параметр).
int? ServiceID – ідентифікатор послуги (необов'язковий параметр).
string Quantity – кількість послуг (у форматі рядка).
string Price – ціна або сума транзакції (у форматі рядка).
int TransactionType – тип транзакції.
int? TransactionID – ідентифікатор ресторанного рахунку або транзакції (необов'язковий параметр).
string Description – коментар або опис нарахування.
string RestaurantBill – деталізація чека (рекомендується у форматі XML або текстовому вигляді).
int? ClientID – ідентифікатор клієнта. Якщо вказано, система перевірить, чи проживає даний клієнт у зазначеному номері (необов'язковий параметр).
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"HotelID": 1,
"AccountType": 1,
"AccountID": 35508,
"DepositID": null,
"ServiceID": null,
"Quantity": "1.0",
"Price": "500.00",
"TransactionType": 1,
"TransactionID": 123456,
"Description": "Оплата за вечерю",
"RestaurantBill": "<xml>Деталізація чека у форматі XML або текст</xml>",
"ClientID": 49060
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає.
string ErrorText – текст помилки.
bool Result – результат виконання транзакції (true у разі успіху).
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"Result": true
}
GetGuestNotConfirmSales
Отримання списку непідтверджених нарахувань для гостя.
Вхідні параметри:
int HotelID – ідентифікатор готелю.
int GuestID – ідентифікатор гостя.
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"HotelID": 1,
"GuestID": 35508
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає.
string ErrorText – текст помилки.
Sales[] – масив непідтверджених нарахувань. Структура з такими полями:
int SaleID – ідентифікатор нарахування.
DateTime Date – дата нарахування.
decimal Amount – сума.
string Description – опис.
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"Sales": [
{
"SaleID": 98765,
"Date": "2026-07-29T12:00:00",
"Amount": 250.00,
"Description": "Міні-бар"
}
]
}
SetConfirmSale
Підтвердження нарахування.
Вхідні параметри:
int SaleID – ідентифікатор нарахування, яке потрібно підтвердити.
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
"SaleID": 98765
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає.
string ErrorText – текст помилки.
bool Result – результат підтвердження (true у разі успіху).
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"Result": true
}
GetReservationsModified
Отримання нових бронювань з певного часу. Метод перевіряє, чи є користувач API корпоративним (чи має прив'язані компанії). Якщо користувач корпоративний, повертаються лише бронювання, у яких компанія-оператор (TourOperatorID) входить до списку компаній користувача. Якщо користувач не корпоративний – повертається помилка (код 5, доступу немає).
Вхідні параметри:
DateTime ModifiedDateFrom – дата й час останнього отриманого бронювання, необов'язковий параметр. Повертаються бронювання з датою створення/редагування (LastChangeDate), більшою за вказану. Якщо не вказано – бронювання не фільтруються за датою. Формат: "yyyy-MM-dd HH:mm:ss".
{
"Credentials": { "UserName": "UserName", "Password": "User Password" },
"ModifiedDateFrom": "2023-01-27 00:00:00"
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає. 5 – доступу немає (користувач не корпоративний або немає прав на метод).
string ErrorText – текст помилки.
Hotels[] – список готелів, масив структур Hotel.
HotelInformation – інформація по готелю. Структура з полями:
int HotelID – ідентифікатор готелю.
string HotelName – назва готелю.
string HotelShortName – коротка назва готелю.
Guests[] – список бронювань. Структура з полями:
Guest – інформація про бронювання. Структура з полями:
int GuestID – ідентифікатор бронювання.
int GuestStatus – статус бронювання.
string GuestName – назва бронювання.
int Adults – кількість дорослих.
int Childs – кількість дітей.
int ChildsPay – кількість дітей, за яких стягується оплата.
DateTime ArrivalDateTime – дата й час заїзду.
DateTime DepartureDateTime – дата й час виїзду.
int NightsCount – кількість ночей.
string SourceCode – джерело бронювання.
string Email – електронна пошта.
string Phone – телефон.
string ContactName – контактна особа.
string Vip – ознака VIP.
string Cost – сума нарахувань.
int? TourOperatorID – ідентифікатор компанії-оператора.
Company OperatorCompany – компанія-оператор. Структура з полями:
int CompanyID – ідентифікатор компанії.
string CompanyName – назва компанії.
string CompanyPrintName – друкована назва.
string CompanyPrintCode – друкований код.
string CompanyPrintSertificate – номер свідоцтва.
string Email – електронна пошта.
string Phone – телефон.
string ITN – ІПН.
int? IndustryID – ідентифікатор галузі.
string IndustryName – назва галузі.
int? SegmentID – ідентифікатор сегмента.
string SegmentName – назва сегмента.
int? CompanyID – ідентифікатор компанії-платника.
Company Company – компанія-платник (структура аналогічна OperatorCompany).
Country Country – країна. Структура з полями:
int CompanyID – ідентифікатор країни.
string CountryName – назва країни.
string CountryISO2 – код країни ISO2.
string CountryISO3 – код країни ISO3.
int PriceListID – ідентифікатор прейскуранта.
string PriceListName – назва прейскуранта.
PriceList PriceList – прейскурант. Структура з полями:
int PriceListID – ідентифікатор прейскуранта.
string PriceListName – назва прейскуранта.
string Description – опис.
bool IsRackRate – ознака базового тарифу.
bool IsSpecRate – ознака спеціального тарифу.
bool IsNonReturnRate – ознака неповоротного тарифу.
bool IsForInternet – ознака тарифу для інтернету.
bool IsChargeBonuses – ознака нарахування бонусів.
int? ReservationTypeID – ідентифікатор типу гарантії.
string ReservationTypeName – назва типу гарантії.
int? PaidTypeID – ідентифікатор типу оплати.
string PaidTypeName – назва типу оплати.
int? PayStatus – статус оплати.
int? GroupID – ідентифікатор групи.
int? ManagerID – ідентифікатор менеджера.
int? PersReservation – ідентифікатор користувача, який створив бронювання.
int? PersSettle – ідентифікатор користувача, який заселив.
int? PersDeparture – ідентифікатор користувача, який виселив.
int? PersCancelation – ідентифікатор користувача, який скасував.
DateTime? DateTimeReservation – дата й час бронювання.
DateTime? DateTimeSettle – дата й час заселення.
DateTime? DateTimeDeparture – дата й час виселення.
DateTime? DateTimeCancelation – дата й час скасування.
DateTime? LastChangeDate – дата й час останньої зміни.
int? CancelReasonID – ідентифікатор причини скасування.
string CancelReasonName – назва причини скасування.
string CancelReasonString – текст причини скасування.
string ChannelReservationCode – код бронювання каналу.
Payment[] Payments – список нарахувань.
string[] IdentityCards – список номерів карт замкової системи.
Client[] Clients – список анкет.
int[] ManagerActivities – список ідентифікаторів заходів.
GuestNote[] Notes – список приміток.
Preference[] Preferences – список уподобань.
GuestUTMParameters UTMParameters – UTM-мітки.
Room – інформація про номер. Структура з полями:
int RoomId – ідентифікатор номеру.
string RoomNumber – назва/номер кімнати.
string Building – корпус.
string Floor – поверх.
string SaleStatus – статус продажу.
string CleanStatus – статус прибирання.
bool Checkup – ознака перевірки.
RoomType RoomType – категорія номеру. Структура з полями:
int RoomTypeId – ідентифікатор категорії.
string RoomTypeName – назва категорії.
string RoomTypeShortName – коротка назва категорії.
int Beds – кількість основних місць.
int AddBeds – кількість додаткових місць.
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1785330158652",
"VersionInfo": "1.0.0.4",
"Hotels": [
{
"Guests": [
{
"Guest": {
"GuestID": 29597,
"GuestStatus": -1,
"GuestName": "Доктор Зло",
"Adults": 1,
"Childs": 0,
"ArrivalDateTime": "2014-06-26 14:00:00",
"DepartureDateTime": "2014-06-27 12:00:00",
"NightsCount": 1,
"TourOperatorID": 2,
"OperatorCompany": {
"CompanyID": 2,
"CompanyName": "__Relax",
"Email": "sdasd@sdasd.ru",
"Phone": "123123"
},
"PriceListID": 207,
"PriceListName": "Cassie664",
"ReservationTypeID": 1,
"ReservationTypeName": "Гарантирована",
"PaidTypeID": 2,
"PaidTypeName": "Безналичный",
"LastChangeDate": "2023-01-28 20:54:20"
},
"Room": {
"RoomId": 2,
"RoomNumber": "106-107",
"Building": "Головний корпус",
"Floor": "42",
"SaleStatus": "sale",
"RoomType": {
"RoomTypeId": 33,
"RoomTypeName": "Сімейний",
"RoomTypeShortName": "См",
"Beds": 2,
"AddBeds": 8
}
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "гот 1"
}
}
]
}
SendMessageFromHotel
Відправка повідомлення на довільний контакт (номер телефону або email) від імені готелю. На телефон повідомлення надсилається за схемою вайбер-смс (спершу Viber, при недоставці — SMS fallback, тип розсилки SMSAndViber). Провайдера для телефону (Альфасмс / Турбосмс / не відправляти) визначає налаштування готелю PhoneMessageMode (не передається в запиті). Тема (Subject) є необов'язковою й застосовується тільки до email. Метод перевіряє валідність контакту й повідомлення, наявність налаштувань відправки (SMTP для пошти; для телефону — дозвіл на відправку та токен служби повідомлень) і доступ користувача API до вказаних готелів.
Налаштування готелю PhoneMessageMode («режим відправки на телефон», per-hotel, не передається в JSON) — обирає лише провайдера, схема відправки завжди SMSAndViber. Токени провайдерів беруться з наявних налаштувань готелю (TurboSMSAuthInstall / AlphaSMSAuthInstall). Значення: DoNotSend (0) – не відправляти на телефон; AlphaSMS (1) – провайдер AlphaSMS; TurboSMS (2) – провайдер TurboSMS.
Вхідні параметри:
int[] Hotels – масив готелів. 0 – усі доступні готелі / загальний готель (беруться його налаштування). Обов'язковий параметр, порожній масив – помилка.
string Message – текст повідомлення. Обов'язковий параметр, до 1000 символів.
string Subject – тема повідомлення. Необов'язковий параметр, до 100 символів, застосовується тільки для email.
string Contact – контакт (одне значення, не масив): номер телефону або email. Обов'язковий параметр.
string Contacttype – тип контакту: "phone" | "email". Обов'язковий параметр.
{
"Credentials": { "UserName": "UserName", "Password": "User Password" },
"Hotels": [0],
"Message": "TextMessage",
"Subject": "TextSubject",
"Contact": "Phone number or email",
"Contacttype": "phone"
}
Значення, що повертається:
string VersionInfo – версія сервісу.
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди).
int ErrorCode – код помилки. 0 – помилки немає. Можливі коди помилок:
22 (MessageFieldRequired) – не вказано текст повідомлення.
23 (ContactFieldRequired) – не вказано контакт.
24 (ContactTypeFieldRequired) – не вказано тип контакту.
25 (MessageTooLong) – текст повідомлення довший за 1000 символів.
26 (SubjectTooLong) – тема довша за 100 символів.
27 (HotelsFieldRequired) – не вказано готелі (порожній масив).
16 (UnknownParameterValue) – некоректне значення Contacttype (не "phone"/"email") або невалідний формат контакту.
28 (ProviderNotConfigured) – провайдер (SMS/SMTP) не налаштований для готелю.
29 (PhoneSendingDisabled) – відправку на телефон вимкнено (PhoneMessageMode = DoNotSend).
5 – доступу немає (користувач не має доступу до вказаних готелів або немає прав на метод).
string ErrorText – текст помилки.
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1780492860870",
"VersionInfo": "1.0.0.3"
}