T
Перейти до навігації
Перейти до пошуку
Формат запитів JSON
Формат переданих і прийнятих даних – протокол обміну JSON. Кодування запиту та відповіді UTF8.
Запити повинні містити інформацію про авторизацію, відповіді повинні містити інформацію про версію протоколу, знімок часу в момент відповіді сервера, інформацію про помилку. Приклад запиту та відповіді наведено нижче.
Права доступу розрізняються залежно від пари користувач/пароль, які вводяться в кожному JSON-запиті в розділі «Облікові дані»:
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
}
Формат даних
- Формат дати/часу: "yyyy-MM-dd HH:mm:ss";
- Формат дати: "yyyy-MM-dd"
- Формат часу: "HH:mm"
- Роздільник типів із плаваючою крапкою(double): "."
Опис функцій спілкування
GetGuestsModified
Отримання інформації про гостей готелю.
Параметри: дані авторизації, готель (декілька?), час оновлення даних (обрізано те, що було раніше, якщо не вказано, то тільки для всіх гостей, що проживають,
або наступне бронювання, або останнє перебування в номері), масив з переборами відображених даних (проживання гостей (за замовчуванням, якщо не вказано), бронювання, виїзду, контактна інформація для гостей)
Вхідні параметри:
{
"Credentials" : {
"UserName" : "UserName",
"Password" : "User Password"
},
// 0 – всі доступні готелі
"Hotels" : [1, 2,...],
// дата з часом, показувати номери, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom" : "2019-11-12 12:33:45",
// необов’язковий фільтр за ідентифікаторами гостей
"GuestsID" : ["1", .....] ,
// відповідно заброньовані, що проживають, останній виїхавший по номеру, анульований, незаїзд.
"GuestStatus" : [0,2,3,-1,-2],
// отримувати вартість гостя, за замовчуванням ні
"isNeedCostInfo" : "0",
// літерні коди класів послуг, нарахування по яких потрапляють у вартість
"ServiceClasses":[""],
// літерні коди підкласів послуг, нарахування по яких не потраплятимуть у вартість
"ExcludeServiceSubclasses":[""],
// виводити дані по анкетах у гостей, за замовчуванням ні
"isNeedClientInfo" : "0",
// вивантажувати фото клієнта
"isNeedClientPhoto" : "0",
// виводити дані по документах в анкетах, за замовчуванням ні
"isNeedDocumentsInfo" : "0",
// ПІБ гостя
"GuestName" : "Петров Петро Петрович",
// Номер телефону
"PhoneNumber" : "0991232233",
// Пошта
"Mail" : "user@gmail.com",
// Ідентифікатор анкети гостя
"ClientID" : 654,
// Вподобання
"Preferences": [
{
"Code": "carnumber",
"Value": "333-44-55"
}
],
// Комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard"]
}
}
Значення, що повертається:
{
"VersionInfo" : "0.1",
// час, коли почали формувати відповідь на сервері у UTC (мілісекунди)
"RequestTime" : "345356546",
// код помилки, 0 – помилок немає
"ErrorCode" : "0",
"ErrorText" : "" ,
"Hotels" : [
"HotelInformation" : {
"HotelID" : 1,
"HotelName" : "Назва",
"HotelShortName" : "КороткаНазва"
},
"Guests" : [ {
"Room" : {
"RoomId" : 1,
"RoomNumber" : "1001",
"Floor" : "10",
"RoomType" : {
"RoomTypeName" : "",
"RoomTypeShortName" : "",
"RoomTypeId" : "",
"Beds" : "1",
"AddBeds" : "0"
}
},
"Guest" : #GuestInformation#
}
] // Гості
] // Готелі
}
GetClientsModified
Вхідні параметри:
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// Дата з часом у UTC, показувати анкети, зміни у яких сталися після вказаного часу.
"ModifiedDateFrom": "",
// необов’язковий фільтр за ідентифікаторами клієнтів
"ClientsID": [1, ...],
// фільтри для анкет
"Phones": [""],
"Emails": [""],
"FirstName": "",
"LastName": "",
"MiddleName": "",
// серія та номер документа без роздільників
"DocumentSeriesAndNumber": "",
// ІПН документа
"DocumentIIN": "",
"Sex": true, // true - чоловічий, false - жіночий
"BirthDay": "1982-08-01",
// Вподобання
"Preferences": [
{
"Code": "carnumber",
"Value": "333-44-55"
}
],
// Комплексний пошук по конкретних полях
"ComplexSearch": {
"SearchString": "+380991112233",
"SearchObjects": ["LastName", "FirstName", "MiddleName", "Phone", "Email", "AccountNumber"]
}
}
Значення, що повертається:
{
"VersionInfo": "0.1",
//время когда начали формировать ответ на сервере в UTC
"RequestTime": "",
//Код ошибки, 0 – нет ошибок
"ErrorCode": "0",
"ErrorText": "",
"Clients": [
"Client": {
"ClientID": "1",
"FirsName": "",
"MiddleName": "",
"LastName": "",
"BirthDay": "",
"Email":"guest@gmail.com",
"Phone":"+79997776655",
"Comment":"Like smoking",
"GuestsID":[1,2],
"Documents": [
"PersonDocument": {
"DocumentType": ,
"DocumentNumber": ,
"DocumentSeries": ,
"DocumentDateIssue": "",
"DocumentDateEnd": "",
"IIN": "",
}
]
}
]// Clients
}
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
Вхідні параметри:
{
"Credentials": {
"UserName": "UserName",
"Password": "User 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]
}
Значення, що повертається:
{
"Hotels": [
{
"HotelInformation": {
"HotelID": 1,
"HotelName": "Name",
"HotelShortName": "ShortName"
},
// список контрагентів, хто користується послугою
"Customers": [
{
"CustomerID": 1,
// тип контрагента (1 – гість, 2 – група, 3 – компанія, 4 – захід, 5 – цільовий рахунок)
"CustomerType": 1,
"CustomerName": "Василь Сухопаров",
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000029177",
"ConsumerID": 29177,
"ConsumerTypeID": 1,
"CountryISO3": "UKR",
"CountryName": "Україна",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт",
"RoomTypeID": 1,
"HousingName": "Корпус 1",
"HousingID": 1,
"Payments": [
{
"PaymentID": 1,
"PaymentType": 1,
"ServiceID": 1,
"ServiceClassName": "",
"ServiceClassCode": "",
"ServiceSubClassName": "",
"ServiceSubClassCode": "",
"ConsumptionDate": "2017-11-09 08:11:33",
// статус оплати (0 – не оплачено, 1 – оплачено, 2 – частково оплачено)
"NomenclatureTypes": 0,
"NomenclatureTypeName": "Продукт",
"PaymentStatus": 0,
"PayAmount": "100.00",
"PayAmountValuteISO": "RUB",
"Quantity": "1.000",
"Price": "10.00",
"UsedQuantity": "1.000",
"PriceValuteISO": "RUB",
"IsPackagePayment": true,
"TaxName": "",
"TaxSum": "",
"TaxRate": "",
"TaxName2": "",
"TaxSum2": "",
"TaxRate2": "",
"RestaurantReceipt": 1,
"RestaurantBill": "",
"ReceiptPayTypeID": 1,
"ReceiptPayTypeName": "Карта",
"IsReturned": false,
"LastReceiptDate": "2013-06-07 08:54:00",
"LastReceiptID": 1,
"LastReceiptBillID": 1,
"IsCanceled": false,
"PackagePayments": [
{
"PackagePaymentID": 1,
"ServiceID": 1,
"ServiceName": "",
"ServiceClassName": "",
"ServiceClassCode": "",
"ServiceSubClassName": "",
"ServiceSubClassCode": "",
"Quantity": "1.000",
"UsedQuantity": "1.000",
"Price": "10.00",
"PeriodDateFrom": "2017-11-08 08:00:00",
"PeriodDateTo": "2017-11-10 10:00:00"
}
]
}
]
}
]
}
]
}
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": "1585727691299",
"VersionInfo": "0.1",
"Companies": [
{
"CompanyID": 2,
"CompanyName": "__Relax",
"Email": "sdasd@sdasd.ru",
"Phone": "123123"
}
]
}
GetActivitiesModified
Вхідні параметри:
{
"Credentials": {
"UserName": "UserName",
"Password": "User Password"
},
// 0 – всі доступні готелі
"Hotels": [1, 2, ...],
// дата з часом, показувати заходи, зміни у яких сталися після вказаного часу
"ModifiedDateFrom": "2019-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",
// статуси груп (-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,
"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 – кінцева дата і час останньої зміни рахунку, необов’язковий параметр (якщо не вказано – необмежено)
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",
"NomenclatureTypes": [0, 1],
}
Значення, що повертається:
string VersionInfo – версія сервісу
long RequestTime – час початку формування відповіді на сервері у UTC (мілісекунди)
int ErrorCode – код помилки. 0 – помилки немає
string ErrorText – текст помилки
Hotels[] – список готелів, масив структур Hotel
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654847287800",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Bills": [
{
"Account": "F0000029177",
"BillComment": "",
"BillCustomerID": 29177,
"BillCustomerTypeID": 1,
"BillDate": "2022-05-13 20:36:26",
"BillID": 132740,
"BillPayerID": 29177,
"BillPayerTypeID": 1,
"BillType": "Оплата|Комісія",
"CompanyPayerID": null,
"CreateUser": {
"LoginID": 372,
"UserName": "Роман Веснин"
},
"Currency": "UAH",
"CurrencyCourse": 1.0000000000000,
"PaymentsSum": "180,0000",
"ReceiptReturns": [],
"Receipts": [
{
"CreateUser": {
"LoginID": 372,
"UserName": "Роман Веснин"
},
"Date": "2022-05-13 20:39:00",
"DepositID": 2143,
"FiscalID": 1,
"FiscalSessionID": 147,
"PaidType": "None|Cash|Credit|Noncash|Bonus|Deposit",
"PayGroupType": 4,
"PayTypeID": 49,
"PayTypeName": "Депозит ГРН",
"ReceiptID": 136084,
"ReceiptPayTypeCode": "ДГР",
"ReceiptPayTypeID": 49,
"ReceiptPayTypeName": "Депозит ГРН",
"RoundingDelta": null,
"Sales": [
{ "#SaleObject": {} }
],
"Sum": 180.00,
"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"
}
],
"ServiceProviderID": 317
}
],
"Companies": [
{
"BranchOfficeCode": null,
"Code": "",
"CompanyID": 317,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"HousingID": 1,
"HousingName": "Головний корпус",
"FactualAddress": "",
"FullName": "Начисленька",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "12312312",
"LegalAddress": "",
"Name": "Начисленька",
"PhoneNumber": null,
"PostalAddress": "",
"TIN": "",
"VatCertificateNumber": "",
"CorporateManager": null
}
],
"Consumers": [
{
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000029177",
"ConsumerID": 29177,
"ConsumerTypeID": 1,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"CountryISO3": "BLR",
"CountryName": "Білорусь",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт"
}
],
"DeletedBills": [
100713,
123719,
129732
],
"FiscalDevices": [
{
"CashCode": "О11",
"FiscalID": 1,
"FiscalName": "О1-тест"
}
],
"FiscalSessions": [
{
"CloseBalance": "7970,0000",
"CloseDate": "2013-08-20 14:23:50",
"CloseUser": {
"LoginID": 411,
"UserName": "Цаплинов Євген"
},
"FiscalID": 147,
"FiscalSessionID": 221,
"OpenBalance": "7820,0000",
"OpenDate": "2013-08-20 09:01:07",
"OpenUser": {
"LoginID": 411,
"UserName": "Цаплинов Євген"
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
},
"Payers": [
{
"ArrivalDate": "2013-06-07 08:54:00",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"CountryISO3": "BLR",
"CountryName": "Білорусь",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Чуж Іннокентій Сидорович",
"Payer": "F0000029177",
"PayerID": 29177,
"PayerTypeID": 1,
"PriceListName": "Peggy",
"RoomNumber": "23",
"RoomTypeName": "Стандарт"
}
]
}
]
}
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 – текст помилки
Hotels[] – список готелів, масив структур Hotel
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654849559948",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "",
"CompanyID": 1,
"FactualAddress": "71 Old Boulevard",
"FullName": "Janice2",
"IsOperator": false,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": true,
"KPP": "ZYR",
"LegalAddress": "751 Green Milton Road",
"Name": "NCT",
"PhoneNumber": null,
"PostalAddress": "284 Green Second Blvd.",
"TIN": "543452",
"VatCertificateNumber": "ANZI9JXDF",
"СorporateManager": null
},
],
"Consumers": [
{
"ArrivalDate": "2012-04-12 15:04:48",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000028048",
"ConsumerID": 28048,
"ConsumerTypeID": 1,
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2017-01-26 12:00:00",
"Name": "Анка",
"PriceListName": "__AFT",
"RoomNumber": "18104",
"RoomTypeName": "Стандарт"
}
],
"DepositAccounts": [
{
"AccountCode": null,
"Balance": "600,0000",
"CompanyAgentID": null,
"Currency": "UAH",
"DateCreated": "2013-06-21 15:28:52",
"DepositAccount": 2,
"OwnerName": "Dsf Asdffff Asdf",
"OwnerTypeID": 0,
"Receipts": [
{#ReceiptObject#}
],
"ReceiptsReturns": [
{#ReceiptObject#}
],
"Requisites": "2",
"ServiceProviderID": 1
}
],
"FiscalDevices": [
{
"CashCode": "О31 ",
"FiscalID": 6,
"FiscalName": "О3-test tk"
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Отель 1",
"HotelShortName": "О1"
}
}
]
}
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 – текст помилки
Hotels[] – список готелів, масив структур Hotel
{
"ErrorCode": 0,
"ErrorText": "",
"RequestTime": "1654850037905",
"VersionInfo": "1.0.0.3",
"Hotels": [
{
"Companies": [
{
"BranchOfficeCode": null,
"Code": "6756777777",
"CompanyID": 285,
"FactualAddress": "",
"FullName": "Google",
"IsOperator": true,
"IsPayer": false,
"IsResident": true,
"IsServiceProvider": false,
"KPP": "1251254552",
"LegalAddress": "",
"Name": "Google",
"PhoneNumber": "",
"PostalAddress": "",
"TIN": "125154452115",
"VatCertificateNumber": "",
"CorporateManager": 419
}
],
"Consumers": [
{
"ArrivalDate": "2013-01-10 14:23:43",
"BookingSource": "Реклама",
"CompanyOperatorID": null,
"Consumer": "F0000027742",
"ConsumerID": 27742,
"ConsumerTypeID": 1,
"PayTypeID": 1,
"PayTypeName": "Готівка",
"CountryISO3": "",
"CountryName": "",
"DepartureDate": "2013-01-12 12:00:00",
"Name": "Бугогагов Сергій",
"PriceListName": "__AFT",
"RoomNumber": "201",
"RoomTypeName": "Стандарт"
}
],
"FiscalDevices": [
{
"CashCode": "К03",
"FiscalID": 28,
"FiscalName": "О1-Каса 03"
}
],
"FiscalSessions": [
{
"CloseBalance": "200.0000",
"CloseDate": "2013-05-31 16:30:00",
"CloseUser": {
"LoginID": 2,
"UserName": "Ім’я"
},
"FiscalDeviceID": 28,
"FiscalSessionID": 198,
"OpenBalance": "0.0000",
"OpenDate": "2012-04-05 10:30:00",
"OpenUser": {
"LoginID": 2,
"UserName": "Ім’я"
},
"Receipts": [
{ "#ReceiptObject": {} }
],
"ReceiptsReturns": [
{ "#ReceiptObject": {} }
],
"TotalReceipts": {
"ReceiptReturns": [
{
"FiscalReceiptTypeID": 2,
"FiscalReceiptTypeName": "Чек повернення оплати",
"ReceiptPaidTypeID": 4,
"ReceiptPaidTypeName": "Безготівковий",
"Sum": 110.00
}
],
"Receipts": [
{
"FiscalReceiptTypeID": 1,
"FiscalReceiptTypeName": "Чек на оплату",
"ReceiptPaidTypeID": 4,
"ReceiptPaidTypeName": "Безготівковий",
"Sum": 200.00
}
],
"TotalSum": 200.00
}
}
],
"HotelInformation": {
"HotelID": 1,
"HotelName": "Готель 1",
"HotelShortName": "Г1"
}
}
]
}