{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"71f4c0e1-13cc-4c2a-9ee1-6be35302c241","name":"Kiosk API 1.1.24","description":"Kiosk API is implemented as standard REST service. Every call to the API is stateless.\n\nAPI works with current state of system, no caching is introduced. All mapping IDs are unique for one license assigned. Using the same mapping ID for different license is forbidden. List of mapping values for data bellow can be retrieved by calling d\n\nMappingSheet\n\nmethod.\n\n- Hotel services\n \n- Room types\n \n- Rooms\n \n- Revenue account (IDRastr)\n \n- Extra services (like room upgrade fees)\n \n- Payment types\n \n- Segments\n \n\nMapping for occasionally changed values are provided upon API setup. Any changes must be processed manually. This affects primarily this type of data:\n\n- Age categories\n \n\nIf not specified otherwise all Date and DateTime values are represented in hotel time zone.\n\nPlease see **List of specific terms** in\n\nNotes\n\nsection before continuing reading this documentaion.\n\n# API use / use-cases\n\nKiosk API has been developed with certain set of operations in mind.\n\nUsage or actions not described in this document are considered not to be supported, **until reviewed** by tech team.\n\n## Valid use\n\n### On-line checkin\n\nAn application responsible primarily for completing guest profiles, allowing guest profile updates is considered to be \"On-line checkin\" application. These application can be cloud based on run on physical device (windows / android) - any platform able to consume REST service.\n\nTwo basic approaches exists:\n\n1. Providing booking owner with kind of on-line link to give him way to complete guest profiles prior to checkin, then use \"quick on-line checkin\" desk for rapid in place checkin - usualy checking clients ID's and providing them with room keys.\n \n2. Implementing an app able to iterate through pending bookings and then continue as described in point 1. This is done usually by on-site hand held devices, self-checkin kiosks, etc.\n \n\n> In both cases it is up to API callee to handle data security, please see **Data access security in B2C and B2B environment** in \n \n\n#### Booking lookup\n\nTo obtail list of booking - room pairs that are about to be checked-in (exists in Provisional (Opce) / Confirmed state) call\n\nPendingCheckinList\n\nmethod.\n\nThere are cases when querying all pending bookings is not necessary, due to possession of some booking _identifier_. This identifier could be:\n\n- **GUID** - this GUID identifier is generated by HotelTime and is unique among all HotelTime instances / API licences, to query booking ID by GUID identifier use\n \n GetIDByUID\n \n- **CHMID** - Channel Manager ID, is identifier generated by processing Channel Manager, to query booking ID by CHMID identifier use\n \n GetIDByCHMID\n \n- **OriginID** - Booking Origin ID, usualy an identifier generated by origin OTA or the issuer of booking, to query booking ID by OriginID identifier use\n \n GetIDByOriginID\n \n\nIn all cases above, when booking is found, its internal HotelTime ID is returned. By subsequent call of\n\nDetail\n\nmethod, booking details are returned to the callee. It is up to the callee to decide and process booked rooms state accordingly, due to complete booking (including all booked rooms) is returned. Therefore retrieved rooms must be filtered for pending check-in state manually (look for rooms in Provisional (Opce) or Confirmed state).\n\n#### Guest profile fill-up\n\nAssuming the callee already have HotelTime internal booking ID, two options for adding a guest exists:\n\n1. Add **booking owner** as a guest to particular room by calling\n \n AddOwner\n \n method. This method can be used only when the owner is citizen and hasn't been designated as guest yet\n \n2. Add **new guest** profile by calling\n \n AddNewGuest\n \n method\n \n\nSome considerations for adding room guests (consult with Hotel operations):\n\n- Number of guests should be greater or equal to the Pax in each booked room\n \n- Not all fields in guest profile are mandatory\n \n- Rules for Guest account creation must be cunsulted with hotel operations (see **CreateAccount** attribute in API methods)\n \n- When the very same guest occupies two different rooms in one booking (like second room arrives after the first room departure) - this cannot be handled by API properly, let the front-office assign the guest for the following-up room in the PMS\n \n- Legal requirements must be consulted with hotel operations, like _GDPR_, _Guest ID / Passport_ scanning, etc. Mandatory fields in guest profile could vary by guest country of origin.\n \n\n#### Guest profile update\n\nProfile can be updated by calling\n\nUpdate\n\nmethod. Please check **Guest profile fill-up** in this section for additional details like required fields handling, sensitive data, etc.\n\nSome considerations for updating guest profile (consult with Hotel operations):\n\n- When updating guest profile not created by API call beware that you are editing one record in hotel address book. Unwanted guest details replacement could be done even for historical data and reports (like foreign police, etc.)\n \n- Profiles can be updated any time, any updates after guest check-in or check-out should be consulted with hotel operations first\n \n- Pay special attention to GDPR consent updates. Some of the data could be distributed over partner network when consent has been granted initially\n \n- Updating guest profile means displaying this profile to the user, API callee must implement security measures to protect these data from unwanted readers\n \n- When updating guest profile which has been used as owner profile for the booking, owner profile is changed too. To check for the profile uniquity, see Owner.ID and Guests.ID attributes\n \n\n#### Guest profile security\n\nIn the case the booking owner has access to booking details over some kind of \"link\" transmitted over unsecure transport layer (like email, sms) the callee is responsible of securing data provided by this API.\n\nEspecially when guest data are filled in the booking details, protecting them from other readers with access to the \"link\" is a must. Callee could implement some booking - security token storage on his own or use two methods available in this API for storing and validating custom end-user secrets (like password, pin) paired with particular booking.\n\nFor saving / changing the secrets call\n\nResPasswordUpdate\n\nmethod. \nFor validating secret entered by user in callee application with the stored one call\n\nResPasswordValidate\n\nmethod.\n\nFor more details please see **Data access security in B2C and B2B environment** in\n\nCalling the API\n\nsection.\n\n#### Completing check-in procedure\n\nCheck-in process in the API is **room based**, multi room bookings can be checked-in room by room, this is the major difference from API check-out where whole booking is checked-out at once.\n\nPrior to check-in some requirements must be fullfiled (depending on Hotel operations):\n\n- Room guest number matches the room reservation Pax\n \n- Hotel room must be in ready state (_Cleaned_ or _Inspected_)\n \n- Previous booking must be checked-out\n \n- Booking pre-payment has been completed (according to terms and conditions)\n \n- Room reservation must by assigned to hotel room (**roomless bookings cannot be checked-in by API**)\n \n- Check-in can be made only on arrival date (**no-shows cannot be checked-in by API**, only by PMS)\n \n\nRoom checking method call order:\n\n1. For requirements validation call\n \n CheckInValidate\n \n method.\n \n2. Room checking is done by calling\n \n CheckIn\n \n\nThings to consider after room check-in is completed:\n\n- There is no API functionality to revert this action back\n \n- Any changes in guest profiles in check-in rooms must be consulted with hotel operations (as guest names could be distributed over hotel systems like PBX, IPTV, etc.)\n \n- Check-in usually consist of some in-place actions like (issuing key-card, validation guest IDs / Passports, etc.) - some additional HW or partner system are usually required\n \n\n### Guest centric systems\n\nFor the purpose of this API _guest centric_ system or application is every app providing direct guest / hotel communication funcionality as well as any way to offer guest:\n\n- any kind of hotel extra services (special packages, hotel shuttle, airport pickups, etc.)\n \n- hotel partner services (guided tours, ticket for nearby events, etc.)\n \n- booking requests (bed configurations, room facilities requirements, early check-in / late check-out requests)\n \n- room type upgrades\n \n- guest experience enhacements (on-line check-in, guest bill view, etc.)\n \n\n#### Guest profile fill-up / update\n\n> Please see **On-line checkin** _Guest profile_ actions in this section \n \n\n#### Booking account view\n\nEach booking has one main account and optional number of guest accounts (one guest in booking can have only one account). Guest accounts are usually used for extra service charges as main account is used primarily for accomodation related services. In the case of room type upgrade or any additional fees related to guest stay (late check-out fee, etc.) guest account should be used - if exists.\n\nAccount details can be retrieved by calling\n\nDetail\n\nmethod.\n\nThings to consider for displaying account details:\n\n- One booking (even single room one) could have multiple accounts opened (main + 0..n guest account)\n \n- Main account could contain sensitive data (like real accomodation pricing which in some cases is not known to the guest - consult this with hotel opertaions)\n \n- When an invoice or closed bill is issued from hotel account, invoiced items dissappear from API data view, leaving account item less but marked as **IsEmpty = false**\n \n\n#### Generic extra service charge\n\nHotel account (main or guest) can be charged anytime (when account is opened) for individual items. When charging more than one item to the single account, one API call should be issued to keep items in one batch. This simplifies later operations and doesn't hurt API performance for extensive data validation required during account postings.\n\nItem to be charged can be specified in two basic ways:\n\n- Bound to specific hotel service - then IDService is used and Text + IDRastr (revenue account) cannot be specified as they are transfered from the hotel service definition\n \n- Service less - specific hotel service is not know, therefore IDService is not specified and Text + IDRastr must be specified by API callee\n \n\nAdditionally HotelTime allows two methods for charging extras:\n\n- **Before reservation check-in**: use [PostponedExtrasCharge](https://docs-ht.hoteltime.com/#720cf476-57d1-4b38-ac41-c9423394a7d6)\n \n- **After reservation check-in** (or during the check-in process): use [ExtrasCharge](https://docs-ht.hoteltime.com/#affd4757-f0c9-4b28-9235-63ba49446197)\n \n\nUsing the appropriate method ensures that all charges are processed correctly from an accounting perspective.\n\n**ExtrasCharge** triggers an immediate folio posting, which means the charge is instantly included in the revenue for the hotel day corresponding to the time of the call. The posting always applies to the current hotel day.\n\nIn contrast, **PostponedExtrasCharge** stores the charge information without posting it to the folio right away. The charge will only be applied to the folio—and thus included in the revenue—on the specified date and only once it is confirmed either by a user action in the application or through a subsequent API call. Please bear in mind, that Postponed Extras can be created through various channels such as hotel’s Channel Manager (online reservations).\n\n**ExtrasCharge posting method call order:**\n\n1. Get list of booking accounts by calling [Detail ](https://docs-ht.hoteltime.com/#56a13cef-7334-46f5-9dab-5c9ae0aef6b1) (Reservation detail)\n \n2. Select IDResRoom or IDAccount\n \n3. Call [ExtrasCharge](https://docs-ht.hoteltime.com/#affd4757-f0c9-4b28-9235-63ba49446197)\n \n4. If account charge is related to completed payment (like pre-paid guided tour) call [ResPrePayment](https://docs-ht.hoteltime.com/#6f717085-7a5e-40df-955b-354b00e9f990) and check **Pre-Payments** in this section for more details\n \n\n**PostponedExtrasCharge posting method call order:**\n\n1. Get list of booking accounts by calling [Detail](https://docs-ht.hoteltime.com/#56a13cef-7334-46f5-9dab-5c9ae0aef6b1)\n \n2. Call [PostponedExtrasCharge](https://docs-ht.hoteltime.com/#720cf476-57d1-4b38-ac41-c9423394a7d6) specifying items to be charged\n \n3. If account charge is related to completed payment (like pre-paid guided tour) call [ResPrePayment](https://docs-ht.hoteltime.com/#6f717085-7a5e-40df-955b-354b00e9f990) and check Pre-Payments in this section for more details\n \n\nTo check whether any **extras have been stored in a reservation** (e.g. via API, Channel Manager, or manually), follow this method call order:\n\n1. Get list of booking accounts by calling [Detail](https://docs-ht.hoteltime.com/#56a13cef-7334-46f5-9dab-5c9ae0aef6b1)\n \n2. Check for\n \n 1. **CHMExtraServiceInclusive: true** to gain information that inclusive extras are in the reservation\n \n 2. **CHMExtraServiceExclusive: true** to gain information that exclusive extras are in the reservation\n \n3. Call [CHMExtraServices](https://docs-ht.hoteltime.com/#3c8fb63a-f07a-4a40-bc79-852b3dd36bb4) to gain detailed information of the extras in the reservation\n \n\nIf there are any exclusive extras stored in the reservation and the check-in is performed through a third-party system, it is the **callee's responsibility to ensure these pending extras are properly posted** to the folio by calling [ExtrasCharge](https://docs-ht.hoteltime.com/#affd4757-f0c9-4b28-9235-63ba49446197).\n\n**Things to consider when charging hotel account:**\n\n- Price conversion between currencies is **not automated**. If the account uses a different currency than the reservation’s main account, it is the **callee’s responsibility** to recalculate the item price accordingly.\n \n- If an account is marked as **NoPost**, the callee should **verify its intended use** with the hotel’s operations team. Note that **not all extras** are excluded from posting in such cases.\n \n- If multiple accounts exist (e.g. a main account and one or more guest accounts), the callee should **follow hotel-specific rules** for how different service types should be posted.\n \n- To **cancel** a previously posted item, issue a **negative posting request**.\n \n\n#### Reservation requests\n\nFor detailed explenation of reservation specials and room features please see **Reservation request and Room features** in\n\nNotes\n\nsection\n\nRoom request method call order:\n\n1. Call\n \n RoomFeatureAdd\n \n method\n \n2. When additional details are required update room or booking note by calling\n \n ResRoomNoteUpdate\n \n or\n \n ResNoteUpdate\n \n3. When payment for such request has been processed call [ResPrePayment](#6f717085-7a5e-40df-955b-354b00e9f990) and check **Pre-Payments** in this section for more details\n \n\nReservation specials call order:\n\n1. Call\n \n ResSpecialsAdd\n \n method\n \n2. When additional details are required booking note by calling\n \n ResNoteUpdate\n \n3. When booked room ETA should be updated (early check-in request) call\n \n ResRoomETAUpdate\n \n method\n \n4. When payment for such request has been processed call [ResPrePayment](#6f717085-7a5e-40df-955b-354b00e9f990) and check **Pre-Payments** in this section for more details\n \n\nThings to consider:\n\n- List of reservation request and room features is hotel specific enumeration as well as codes used\n \n- Once a feature or specials is added to the booking, the API doesn't have functionality to roll it back\n \n\n#### Hotel partner services\n\nWhen additional partner services have been ordered / booked (like guided tours, events nearby, ...), API callee should:\n\n- Charge booking account for corresponding service or charge serviceless item with appropriate item description, see **Generic extra service charge** in this section for more details\n \n- Update booking notes by calling\n \n ResRoomNoteUpdate\n \n or\n \n ResNoteUpdate\n \n- Register pre-payment when service has been pre-paid by guest, see **Pre-Payments** in this section for more details\n \n\nThings to consider:\n\n- API doesn't have funcionality to connect to the partner booking services directly, it is up to the API callee to negotiate booking in partner systems first\n \n- In the case of booking services handled by HotelTime platform - wellness, gastro or venues, specific API can be used for issuing additional bookings - please contact tech team for more details\n \n\n#### Room type upgrades\n\nBooked room type can be changed / upgraded any time before room has been checked-in.\n\nIt is up to the API callee to decide whenever the upgrade is free of charge or is subject of any extra charge to the guest account. Also room type upgradability matrix must be handled by the API callee. When an attempt to change room booking room type to unsupported one by booked RateCode, an error is generated.\n\nRoom type upgrade call order:\n\n1. Check the desired room type availabilty by calling\n \n RoomTypeAvailability\n \n2. ... callee app business logic happends here ...\n \n3. Check again room type availability - due to some time window required for guest decision, payment processing, etc.\n \n4. Change booked room type by calling\n \n RoomTypeUpgrade\n \n\nRoomTypeUpgrade method process the room type change as well as hotel account extra service charge, if no charges applies just leave **AccountItems** element empty or null.\n\nThings to consider:\n\n- Downgrades (rollbacks) are handled the same way as upgrades - negative operation\n \n- For more details about upgrade extra charge computations see **Room type upgrade pricing** in\n \n Notes\n \n section for more details\n \n- Upgrading booked room with physical room assigned is subject of further API development - due to hotel operations constraints on assigned rooms\n \n\n#### Pre-Payments\n\nPre-payments are registered in PMS systems in following situations:\n\n- Regular pre-payment or complete booking payment is done in external system\n \n- Extra service / services are posted to the booking account and these services are pre-paid\n \n\nAll pre-payments are booking specific, is up to the front-office or PMS user to decide which pre-payment use with which account (if multiple accounts exists in one booking).\n\nPayments can be done in different than account currency as long as currency is supported by hotel - consult available currencies with hotel operations first. Then automatic conversion is done by API according to hotel exchange rates setup.\n\nWhenever is possible API callee should provide additional details for payment pairing (like CC transaction ID, PayPal transaction ID, etc.) in **PaymentVS** field (_Payment Variable Symbol_)\n\nPre-payment call order:\n\n1. Register pre-payment by calling [ResPrePayment](#6f717085-7a5e-40df-955b-354b00e9f990) method\n \n2. Download PDF version of deposit invoice by calling\n \n ResTaxDocumentPrintData\n \n\nThings to consider:\n\n- Negative pre-payments are not allowed\n \n- List of available payment types is hotel specific, not all payment types can be used for the API, consult with hotel operations usable ones\n \n\n### Kiosk\n\nFor the purpose of this API **kiosk** is physical extension of **on-line check-in** functionality.\n\nBenefits of kiosk running on physical device at site:\n\n- printer (for printing bills and confirmation of deposit payment)\n \n- key-lock encoder for issuing guest room cards\n \n- scanner device for obtaining copy of guest ID / Passport, computer readable data comparison to guest profile details\n \n- biometrics devices to validate ID / Passport holder\n \n\nAdditional features extending on-line check-in functionality are described in **Guest centric systems** (_room upgrades_, _booking of additional services_, _extra charges_, etc.)\n\n#### Guest centric systems shared functionality\n\nFor following functionality please see **Guest centric systems** in this section:\n\n- Booking lookup\n \n- Guest profile operations\n \n- Booking account view\n \n- Reservation request and room features\n \n- Hotel Partner services\n \n- Extra services\n \n- Room type upgrades\n \n- Pre-payments\n \n\n#### Check-in procedure\n\n> Please see **On-line checkin** - _Completing check-in procedure_ in this section \n \n\nWhen kiosk is represented by physical device inside hotel, key-card encoder can be fitted in, therefore completing the check-in procedure could lead to issuing even key-card for guests.\n\nKey-card encoders - or e-locks are vendor specific interfaces, for more details please contact tech team.\n\n#### Check-out procedure\n\nCheck-out process in the API is both: **booking based** or **room based.** If room ID is not provided, multi room bookings are checked-out at once and if a room with diferent departure date exists, API check-out will generate an error and check-out must me completed in the PMS.\n\nPrior to check-out some requirements must be fullfiled (depending on Hotel operations):\n\n- All bookings account must be settled or transfered to paymaster accounts\n \n- Check-out can be made only on departure date (**early or late checkouts cannot be processed by API**, only by PMS)\n \n\nBooking check-out method call order:\n\n1. Check booking for pending accounts (to be settled) by calling\n \n ResPendingAccounts\n \n2. Settle each account by calling\n \n AccountClose\n \n \\- for account detail call\n \n AccountDetail\n \n3. Store TaxDocumentID received after account has been settled - you can receive PDF with an invoice by calling\n \n ResTaxDocumentPrintData\n \n4. For requirements validation call\n \n CheckOutValidate\n \n method.\n \n5. Booking checkout is done by calling\n \n CheckOut\n \n\nThings to consider after room check-out is completed:\n\n- There is no API functionality to revert this action back (subsequent call to Room checkin will fail as booking is not in required state)\n \n- Key-cards will remain active (unless key-lock system provides on-line functionality to void the card)\n \n- Account owners should get their closed bills (printing - API supports PDF in 80mm formats for thermal printers, or send via email, etc.)\n \n\n#### Ad-hoc bookings\n\nAd-hoc bookings cannot be created by this API. Please contact tech team for more details regarding **OBE** API (_On-line Booking Engine API_)\n\n## Invalid use\n\nFollowing cases are considered as invalid API use:\n\n- using API for periodical polling for room availability - use **OBE** API instead\n \n- querying bookings for details only - use **Booking overview** API instead\n \n- querying for active bill for particular booking only - use **Gastro** or **IPTV** or **HotelStatus** API instead\n \n- querying booking details for PBX / IPTV purposes - use **IPTV** or **PBX** API instead\n \n- querying guest data in CRM manner (pre-stay, post-stay, post-checking, ...) - use **CRM** API instead\n \n- connecting to accountancy system for automated pre-payments registrations - use **Accountancy** API instead\n \n- account posting from Gastro, IPTV, PBX, Minibar systems - use **Gastro** or **HotelStatus** API instead\n \n- posting multiple account items to single bill in separate calls insted of one batch\n \n- multiple calls in one license at a time\n \n- automated IDs / GUID scanning\n \n- polling for data update (checkin, inhouse, checkout bookings, or simillar) - data should be gathered when requested - required by client operating target system\n \n\nIf invalid API usage is detected, access for license used in such case could be blocked.\n\n# Calling the API\n\n## Channel security\n\nAPI supports HTTPS protocol only with **TLS 1.2**. Older version of TLS or SSL protocols are not supported due to security concerns and GDPR regulation.\n\n## Authentication\n\nA license is required (**LicenseToken** - GUID in HTTP header).\n\n## Request / response formats\n\nServer accepts JSON (default) and XML requests. Desired serialization format must be specified in Content-Encoding HTTP Header element.\n\nRequest serialization format corresponds to response serialization format, therefore there is no option for requesting data in XML and expecting JSON response, and vice versa.\n\n## Rate limit\n\nThe number of requests is not limited, however there can only be one call per license at a time.\n\n## Atomicity and data transactions\n\nEach API method call is atomic.\n\nWhen multiple methods are separately called, no transaction across these calls exists. The callee is therefore responsible for handling rollbacks or arranging request from the checks to data manipulation operations for easier rollback. Some actions can be rolled back only by issuing new \"oposite\" action - f.e. charging negative amount to the booking account.\n\n## Data access security in B2C and B2B environment\n\nCallee is reponsible for handling data received with adequate precausions, data regulations and their inteded purpose of use.\n\nIf GDPR affects data sent or received from server, callee is responsible for protecting these data from unauthorized readers. API doesn't provide any kind of data checks or one-time tokenization for data access.\n\nOne exception has been introduced for saving custom password/secret to the particular booking and then checking this secret by API method call.\n\nAPI only provides functionality for saving and validating this secret. Callee is responsible for proper implementation and application logic in API consuming application.\n\n# Retrieving response from API\n\nAll API calls are synchronous.\n\nMapping of internal error codes to standard HTTP status codes has been implemented for easier understanding of API responses.\n\nData comming from API are wrapped in envelope, see\n\nData schemes - protocol\n\n, this applies even for the case no data are expected - then the envelope contains only response status.\n\n## HTTP error codes handling\n\nIn the case no **response data envelope** (see\n\nData schemes - Protocol\n\n) is returned, you must check for HTTP status code. 200 OK is not expected as server hasn't processed the request successfully.\n\nWithout data envelope, process HTTP status codes as usual.\n\n## Successful response\n\nSuccessfully processed request is identified by **IsSuccess** attribute in **response data envelope** (see\n\nData schemes - Protocol\n\n) only. HTTP status code 200 OK or similar without having IsSuccess equals to **true** doesn't designate response as sucessfull - there are no exceptions. Even empty response is wrapped in response data envelope.\n\nIn the case of successul response, also check of **warnings** field in response envelope should be done, for additional processing details.\n\n## Unsuccessful response\n\nUnsuccessfully processed request is identified by **IsSuccess** attribute in **response data envelope** (see\n\nData schemes - Protocol\n\n) only. HTTP status code is set by error causing the request to fail.\n\nDue to very limitted HTTP status code granularity, list of **APIError** objects is returned in errorneous response (see\n\nData schemes - Protocol\n\n).\n\nExpected API callee reaction to each type of APIError is described under **Response error codes** in\n\nError codes\n\nsection.\n\n# Data schemes - Protocol\n\nThese objects are used in every API call.\n\n## Response data envelope\n\nResponse data envelope is returned even for call with no particular result, thus only success / errors / warning elements should be considered.\n\n
TypeDescription
IsSuccess
Boolean
True if the request was successful, false if the request was unsuccessful
Data
Object / Value
Contains the result of the request in the form according to the method used
Errors
APIError[]
Contains information about errors if the request was unsuccessful, see APIError object in this section for more details
Warnings
String[]
Contains possible warnings
\n\n**Sample**\n\n```\n{\n \"IsSuccess\": true,\n \"Data\": { ... },\n \"Errors\": null,\n \"Warnings\": [ \"Partial update has been done, ETA mask set already\" ]\n}\n\n ```\n\n## APIError object\n\nAPIError object can be found in **response envelope**. For most cases you should check **MetaData** attribute for more details where most of them are presented in human-readable form, except for Missing or Invalid parameters where usually parameter name is specified if situation doesn't require furthe explanation of an error.\n\n
TypeDescription
ID
Integer
Integer representation of Error code
Code
String
SeeError codes- Response error codes list
MetaData
String
Additional details regarding an errorneous state, mostly human readable
\n\n**Sample**\n\n```\n{\n \"ID\": 2002,\n \"Code\": \"ParameterMissing\",\n \"MetaData\": \"IDReservation\"\n}\n\n ```\n\n# Data schemes - Request\n\nRequest specific data containers can be found here.\n\n## AccountChargeItemBag\n\nRepresents individual items to be posted on single booking account (main or guest). Item could have **service** specified or not.\n\nIn the case the service is specified, then system automatically fill **IDRastr** and **Text** filed from the service definition. When API callee tries to fill these values in request an error will be returned.\n\nWhen service is not specified request must contain **IDRastr** and **Text** fields, otherwise an error will be returned.\n\n
TypeDescription
IDRastr
Integer
Revenue account ID, value -1 means no value specified
IDService
Integer
ID of hotel's service used for this item (could be RoomType, Minibar item, etc.), value -1 means no value specified
Text
String
Item name / text
Amount
Integer
Number of units / amount
UnitPrice
Decimal
Item unit price
VatCharge
Float
Vat charge
IDHotelRoom
Integer
Physical hotel room ID, value -1 means no value specified. Please be aware this is not room booking ID, list of hotel rooms is provided during API setup
\n\n**Sample - Item with service**\n\n```\n{\n \"IDRastr\": -1,\n \"IDService\": 1100000014,\n \"Text\": null,\n \"Amount\": 2,\n \"UnitPrice\": 20,\n \"VatCharge\": 15.0,\n \"IDHotelRoom\": -1\n}\n\n ```\n\n**Sample - Item without service**\n\n```\n{\n \"IDRastr\": 1100000007,\n \"IDService\": -1,\n \"Text\": \"Guided tour 24.09.2019\",\n \"Amount\": 1,\n \"UnitPrice\": 200,\n \"VatCharge\": 21.0,\n \"IDHotelRoom\": 1100000025\n}\n\n ```\n\n## GDPRConsentBag\n\nRepresents set of **GDPR** consents assigned by particular guest.\n\n
TypeDescription
RepetitiveStay
Boolean
Storage of guest data are granted for future bookings only
Marketing
Boolean
Storage of guest data are granted for marketing purposes
\n\n**Sample**\n\n```\n{\n \"RepetitiveStay\": true,\n \"Marketing\": false\n}\n\n ```\n\n## PostAddressBag\n\nRepresents post address.\n\n
TypeDescription
Street
String
City
String
Zip
String
CountryISO2
String
Two-digit country code (ISO 3166-1 alpha-2)
\n\n**Sample**\n\n```\n{\n \"Street\": \"Fenchurch street 54\",\n \"City\": \"London\",\n \"Zip\": \"EC3M 3JY\",\n \"CountryISO2\": \"GB\",\n}\n\n ```\n\n## ResSubjectBag\n\nRepresents a subject which can be either an existing Subject or a new Citizen or Company. Exactly one of these types has to be filled. Inactive types are represented as \"null\". This data container is shared among request / response data containers.\n\n
TypeDescription
ID
Integer
ID of already existing Subject in hotel's addressbook
Citizen
ResCitizenBag
See Data schemes - Request for ResCitizenBag details
Company
ResCompanyBag
See Data schemes - Request for ResCompanyBag details
\n\n**Sample**\n\n```\n{\n \"ID\": null,\n \"Citizen\": { ... },\n \"Company\": null,\n}\n\n ```\n\n## ResCitizenBag\n\nRepresent guest addressbook details. This data container is shared among request / response data containers.\n\n
TypeDescription
FirstName
String
Surname
String
Address
PostAddressBag
See PostAddressBag object in this section for more details
IsMale
Boolean
True guest is male
BirthDate
Date
(null for not specified birth date)
IDCard
String
Guest ID card od Passport
IDDocumentType
Integer
Type of guest idenitification document. (0 or null - unspecified, 1 - Personal ID, 2 - Passport, 3 - Driver's License)
IDDocumentExpiration
Date
(null for unspecified document expiration)
Visa
String
Guest visa details
NationalityISO2
String
Two-digit nationality code (ISO 3166-1 alpha-2)
Email
String
GSM
String
Phone
String
LanguageISO
String
Guest ISO language code, see Language ISO codes object in Notes section for more details
GDPR
GDPRConsentBag
See GDPRConsentBag object in this section for more details. This field is mandatory
IDSignature
String
ID Signature for guest (maximum 40 characters)
CarLicensePlate
String
Maximum 20 characters
Loyalty
LoyaltyBag
Guest loyalty info
AR
String
AR number
\n\n**Sample**\n\n```\n{\n \"FirstName\": \"John\",\n \"Surname\": \"Wick\",\n \"Address\": { ... },\n \"IsMale\": \"true\",\n \"BirthDate\": null,\n \"IDCard\": \"144526887\",\n \"IDDocumentType\": 1,\n \"IDDocumentExpiration\": \"2029-04-26\", \n \"Visa\": null,\n \"NationalityISO2\": \"GB\",\n \"Email\": \"johnk.wick.3@gmail.com\",\n \"GSM\": \"+447754488755\",\n \"Phone\": \"+447123456789\",\n \"LaguageISO\": \"en-gb\",\n \"GDPR\": { ... },\n \"IDSignature\": \"28b008d4-293c-4393-b293-cf10f6dd717b\",\n \"CarLicensePlate\" : \"1A2566\",\n \"AR\": \"123AA\"\n}\n\n ```\n\n## ResCompanyBag\n\nRepresent guest addressbook details. This data container is shared among request / response data containers.\n\n
TypeDescription
Name
String(100)
BusinessID
String(20)
IČO for Czech/Slovak countries
VatID
String(20)
DIČ for Czech/Slovak countries
VatID2
String(20)
IČ DPH for Slovak country
VatPayer
Boolean
If true, the company is subjected to VAT
Address
PostAddressBag
See PostAddressBag object in this section for more details
Email
String
GSM
String
Phone
String
Loyalty
LoyaltyBag
Company loyalty info
AR
String
AR number
\n\n**Sample**\n\n```\n{\n \"Name\": \"Microsoft\",\n \"BusinessID\": \"Vermont123\",\n \"VatID\": \"US123123\",\n \"VatPayer\": true,\n \"Address\": { ... },\n \"Email\": \"johnk.wick.3@gmail.com\",\n \"GSM\": \"+447754488755\",\n \"Phone\": \"+447123456789\",\n \"AR\": \"123AA\"\n}\n\n ```\n\n## LoyaltyBag\n\nRepresents data about loyalty program of a subject.\n\n| | **Type** | **Description** |\n| --- | --- | --- |\n| ID | Integer | ID of the loyalty item.
Query **Enum/MappingSheet** for the loyalty IDs avaiable to hotel chain |\n| Number | String | Loyalty membership ID, member card ID or any other ID external system would like us to save to the subject profile |\n| LoyaltyConsent | Boolean | True if subject agreed to join loyalty program, otherwise false |\n\n**Sample**\n\n```\n{\n \"ID\": 1200234134,\n \"Number\": null,\n \"LoyaltyConsent\": true\n}\n\n ```\n\n## InvoiceSendBag\n\nIf specified in payment requests (AccountClose or ResPrePayment) created invoice will be sent to the payee automatically byt HOTELTIME.\n\n
TypeDescription
InvoiceLng
String
Language ISO code, allowed values are:
cs_cz, en_gb, de_ge, ru_ru, sk_sk, et_et, th_th, id_id, lv_lv
EmailLng
String
Language ISO code, allowed values are:
cs_cz, en_gb, de_ge, ru_ru, sk_sk, da_dk, es_es, fr_fr, it_it, nl_nl, pl_pl, et_et, th_th, id_id
\n\n**ISO codes are using _ (underscore) instead of - (hypen) for culture specification**\n\nAlso consult with hotel which e-mail languages are available (e-mail templates are defined by hotel according to it's language preferences).\n\nHotel must have **Concierge** service activated to process PDF invoice automated sending. If the service is not activated requesting invoice sendout will not fail, but nothing will be sent until Concierge is activated.\n\n**Sample**\n\n```\n{\n \"InvoiceLng\": \"en_gb\",\n \"EmailLng\": \"it_it\"\n}\n\n ```\n\n## AccountPosponedChargeItemBag\n\nEach bag represents one exclusive/inclusive charge to be charged after check-in.\n\n
TypeDescription
IDResRoom
Integer
HotelTime reservation room ID
IDService
Integer
HotelTime service ID
Text
String
Name of service charge
Amount
Integer
Amount of pieces per day of extra service
UnitPrice
Decimal
Price for one piece of one day of extra service (including VAT)
DateFrom
Datetime
Charges start on this day (time part of datetime will be ignored)
DateTo
Datetime
Charges end on this day (charge is only single-day if this is same as DateFrom)
(time part of datetime will be ignored)
Inclusive
Boolean
If this is true, extra service cannot be charged on reservation account and unit price will be ignored
\n\n``` json\n{\n \"IDResRoom\": 1200232840,\n \"IDService\": 1200205091,\n \"Text\": \"KioskPostponedExlusiveChargeTest\",\n \"Amount\": 3,\n \"UnitPrice\": 23.9,\n \"DateFrom\": \"2025-06-24T00:00:00\",\n \"DateTo\": \"2025-06-26T00:00:00\",\n \"Inclusive\": \"false\"\n}\n\n ```\n\n## AddressBookCitizenBag\n\nRepresent Citizen addressbook details. This data container is shared among request / response data containers.\n\n
TypeDescription
BeforeTitle
String(40)
FirstName
String(40)
Surname
String(40)
AfterTitle
String(40)
IsMale
Boolean
True guest is male
False guest is female
null guest sex is unspecified
BirthDate
Date
(null for not specified birth date)
BirthNumber
String(20)
BirthSurname
String(40)
BirthPlace
String(255)
BirthCountryISO2
String
Two-digit nationality code (ISO 3166-1 alpha-2)
IDCard
String(20)
Guest ID card od Passport
IDDocumentType
Integer
Type of guest idenitification document. (0 or null - unspecified, 1 - Personal ID, 2 - Passport, 3 - Driver's License)
IDDocumentIssueDate
Date
(null for unspecified document issue date)
IDDocumentExpiration
Date
(null for unspecified document expiration)
TravelDocumentNumber
String(20)
Guest visa details
TravelDocumentType
Integer
Type of guest travel document. Query Enum/MappingSheet for the types avaiable to hotel
TravelDocumentIssueDate
Date
(null for unspecified document issue date)
TravelDocumentExpiration
Date
(null for unspecified document expiration)
NationalityISO2
String
Two-digit nationality code (ISO 3166-1 alpha-2)
LanguageISO
String
Guest ISO language code, see Language ISO codes object in Notes section for more details
GDPR
GDPRConsentBag
See GDPRConsentBag object in this section for more details. This field is mandatory
IDSignature
String
ID Signature for guest (maximum 40 characters)
CarLicensePlate
String(20)
Maximum 20 characters
UID
Guid
read-only UID tied to this guest
IDCategory
Integer
Subject category of this guest. Query Enum/MappingSheet for the categories avaiable to hotel
Address
PostAddressBag (extended)
See PostAddressBag object in this section for more details.
Also includes
- Name (String)
Email
String(255)
GSM
String(100)
Phone
String(100)
Fax
String(100)
WWW
String(255)
VIPCode
String(40)
Note
String
AccountingCode
String(40)
Discount
Float
Loyalty
LoyaltyBag (extended)
Guest loyalty info.
See LoyaltyBag object in this section for more details.
Also includes read-only
- ExternalCode (String)
AR
String(20)
AR number
ModifyOn
DateTime
read-only DateTime of last modification made to this guest
\n\n**Sample**\n\n```\n{\n \"BeforeTitle\": \"Bc\",\n \"FirstName\": \"Jan\",\n \"Surname\": \"Novák\",\n \"AfterTitle\": null,\n \"IsMale\": 1,\n \"BirthDate\": \"2000-05-12T00:00:00\",\n \"BirthNumber\": \"123456\",\n \"BirthSurname\": \"Novák\",\n \"BirthPlace\": \"Tirana\",\n \"BirthCountryISO2\": \"AL\",\n \"IDDocumentType\": 2,\n \"IDCard\": \"12345654\",\n \"IDDocumentIssueDate\": null,\n \"IDDocumentExpiration\": null,\n \"TravelDocumentNumber\": \"6664242\",\n \"TravelDocumentType\": 3,\n \"TravelDocumentIssueDate\": \"2026-03-17T00:00:00\",\n \"TravelDocumentExpiration\": \"2027-03-17T00:00:00\",\n \"NationalityISO2\": \"AL\",\n \"LanguageISO\": \"en-gb\",\n \"GDPR\": { ... },\n \"IDSignature\": null,\n \"CarLicensePlate\": \"SPZ123\",\n \"UID\": \"fd8145d0-4c20-45c5-a6ea-fee33b8f5154\",\n \"IDCategory\": 1100021382,\n \"Address\": { ... },\n \"Email\": \"jan@novak.cz\",\n \"GSM\": \"+447754488755\",\n \"Phone\": \"+447754488755\",\n \"Fax\": null,\n \"WWW\": null,\n \"VIPCode\": null,\n \"Note\": null,\n \"AccountingCode\": null,\n \"AR\": null,\n \"Discount\": 0,\n \"Loyalty\": { ... },\n \"ModifyOn\": \"2026-04-23T11:27:46.78\"\n}\n\n ```\n\n## AddressBookDepartmentBag\n\nRepresent Citizen addressbook details. This data container is shared among request / response data containers.\n\n
TypeDescription
Name
String(100)
BusinessID
String(20)
IČO for Czech/Slovak countries
VatID
String(20)
DIČ for Czech/Slovak countries
VatID2
String(20)
IČ DPH for Slovak country
VatPayer
Boolean
If true, the company is subjected to VAT
Registration
String(255)
IDDefaultSegment
Integer
Default segment. Query Enum/MappingSheet for the segments avaiable to hotel
IDDefaultClientType
Integer
Default client types. Query Enum/MappingSheet for the client types avaiable to hotel
IDDefaultReservationSource
Integer
Default reservation source. Query Enum/MappingSheet for the types avaiable to hotel
InvDueDaysProforma
Integer
InvDueDaysInvoice
Integer
UID
Guid
read-only UID tied to this guest
IDCategory
Integer
Subject category of this Company. Query Enum/MappingSheet for the categories avaiable to hotel
Address
PostAddressBag (extended)
See PostAddressBag object in this section for more details.
Also includes Name field (String)
Email
String(255)
GSM
String(100)
Phone
String(100)
Fax
String(100)
WWW
String(255)
VIPCode
String(40)
Note
String
AccountingCode
String(40)
Discount
Float
Loyalty
LoyaltyBag (extended)
Company loyalty info.
See LoyaltyBag object in this section for more details.
Also includes read-only ExternalCode field (String)
AR
String
AR number
ModifyOn
DateTime
read-only DateTime of last modification made to this Company
\n\n**Sample**\n\n```\n{\n \"Name\": \"Srbsko s.r.o\",\n \"BusinessID\": \"123123132\",\n \"VatID\": \"321564\",\n \"VatID2\": null,\n \"VatPayer\": true,\n \"Registration\": null,\n \"IDDefaultSegment\": -1,\n \"IDDefaultClientType\": -1,\n \"IDDefaultReservationSource\": -1,\n \"InvDueDaysProforma\": -1,\n \"InvDueDaysInvoice\": -1,\n \"UID\": \"9c6ccc7c-98de-4a5b-a052-50370982c090\",\n \"IDCategory\": 1100021376,\n \"Address\": { ... },\n \"Email\": \"petra@test.cz\",\n \"GSM\": \"+420123456789\",\n \"Phone\": null,\n \"Fax\": null,\n \"WWW\": null,\n \"VIPCode\": null,\n \"Note\": null,\n \"AccountingCode\": null,\n \"AR\": \"AA132,\n \"Discount\": 0.0,\n \"Loyalty\": { ... },\n \"ModifyOn\": \"2026-05-21T12:03:57.57\"\n}\n\n ```\n\n# Data schemes - Response\n\nThese objects can be found in **response envelope Data** field.\n\n## AccountHeaderBag\n\nRepresents header of one particular account. Could be booking primary account or guest account.\n\n
TypeDescription
OwnerID
Integer
Account owner ID
OwnerName
String
Account owner name
OwnerAR
String
Account owner AR number
IsOwnerCompany
Boolean
True if the account owner is company. False if it is citizen.
CurrencyISO
String
See Currency ISO codes object inNotessection for more details
TotalPrice
Decimal
Account total price (including charged and pending items)
Advances
Decimal
The amount of advances paid by the OTA or directly in hotel (like CC pre-payments)
DueBalance
Decimal
Balance due that remains to be paid
IsEmpty
Boolean
True if the account has no posted, pending or invoiced items at all. Please beware that zero TotalPrice element doesn't mean the account is empty. Only empty accounts can be closed without a requirement to issue an invoice.
IsNoPost
Boolean
True if posting from external systems is disabled
IsOpened
Boolean
True if the account is open, false if the account is closed or waiting to be opened - like not checked-in booking
IsGuestAccount
Boolean
True if account is of a guest, false if this account is the main account of a reservation.
\n\n**Sample**\n\n```\n{\n \"OwnerName\": \"Adidas Ltd.\",\n \"CurrencyISO\": \"EUR\",\n \"TotalPrice\": 5000,\n \"Advances\": 1000,\n \"DueBalance\": 4000,\n \"IsEmpty\": false,\n \"IsNoPost\": false,\n \"IsOpened\": true,\n \"IsGuestAccount\": false\n}\n\n ```\n\n## ResCitizenIDBag\n\nExtension of **ResCitizenBag** for it's ID attribute and IDGuestAccount, see\n\nData schemes - Request\n\nsection for more details (ResCitizenBag is shared among request / response data).\n\n
TypeDescription
ID
Integer
Guest ID
IDGuestAccount
Integer
ID of an Account tied to the guest and some reservation. -1 if the guest doesn't have a GuestAccount
FirstName
String
Surname
String
AR
String
AR number
Address
PostAddressBag
See PostAddressBag object in this section for more details
IsMale
Integer
1 if guest is male, 0 if guest is female and -1 if guest's sex is undefined
BirthDate
Date
(null for not specified birth date)
IDCard
String
Guest ID card od Passport
Visa
String
Guest visa details
NationalityISO2
String
Two-digit nationality code (ISO 3166-1 alpha-2)
Email
String
GSM
String
Phone
String
LanguageISO
String
Guest ISO language code, see Language ISO codes object in Notes section for more details
GDPR
GDPRConsentBag
See GDPRConsentBag object in this section for more details
IDSignature
String
ID Signature for guest (maximum 40 characters)
CarLicensePlate
String
Maximum 20 characters
Loyalty
LoyaltyBag
Guest loyalty info
\n\nNote that guest can have multiple Accounts even in context of one reservation (Main reservation account and Guest account). To get more detail about a specific Account consult the [AccountDetail ](#7227140-2b531cee-5bc2-4919-b49c-3f378ed1e28c) method.\n\n**Sample**\n\n```\n{\n \"ID\": 1100000254,\n \"FirstName\": \"John\",\n \"Surname\": \"Wick\",\n \"Address\": { ... },\n \"IsMale\": 1,\n \"BirthDate\": null,\n \"IDCard\": \"144526887\",\n \"Visa\": null,\n \"NationalityISO2\": \"GB\",\n \"Email\": \"johnk.wick.3@gmail.com\",\n \"GSM\": \"+447754488755\",\n \"Phone\": \"+447123456789\",\n \"LaguageISO\": \"en-gb\",\n \"GDPR\": { ... },\n \"IDSignature\": \"28b008d4-293c-4393-b293-cf10f6dd717b\",\n \"CarLicensePlate\" : \"1A2566\",\n \"AR\": \"123AA\"\n}\n\n ```\n\n## AccountHeaderIDBag\n\nExtension of **AccountHeaderBag** for it's ID attribute. Mostly used in the case where multiple accounts are returned by single API call, f.e. see\n\nResPendingAccounts\n\nmethod.\n\n
TypeDescription
ID
Integer
Account ID
Header
AccountHeaderBag
Account detail, see AccountHeaderBag object in this section for more details
\n\n**Sample**\n\n```\n{\n \"ID\": 1100000254,\n \"Header\": { ... }\n}\n\n ```\n\n## AccountDetailBag\n\nRepresents detail (header + items) of one particular account. Could be booking primary account or guest account.\n\n
TypeDescription
Header
AccountHeaderBag
Account detail, see AccountHeaderBag object in this section for more details
Items
AccountItemBag[]
List of account items, see AccountItemBag object in this section for more details
\n\n**Sample**\n\n```\n{\n \"Header\": { ... },\n \"Items\": [ { ... }, { ... } ]\n}\n\n ```\n\n## AccountDetailIDBag\n\nExtension of **AccountDetailBag** for it's ID attribute.\n\n
TypeDescription
ID
Integer
Account ID
Header
AccountHeaderBag
Account detail, see AccountHeaderBag object in this section for more details
Items
AccountItemBag[]
List of account items, see AccountItemBag object in this section for more details
\n\n**Sample**\n\n```\n{\n \"ID\": 110000254,\n \"Header\": { ... },\n \"Items\": [ { ... }, { ... } ]\n}\n\n ```\n\n## AccountItemBag\n\nRepresents one account item.\n\n
TypeDescription
IDService
Integer
ID of hotel's service used for this item (could be RoomType, Minibar item, etc.), otherwise -1 or 0
Text
String
Item text / name
TimeFrom
DateTime
Item date from, f.e. \"2019-06-21T00:00:00\"
TimeTo
DateTime
Item date to, f.e. \"2019-06-21T00:00:00\". Single day account items have TimeTo equals to TimeFrom. This doesn't applies for account items related to Accomodation, where items are considered to by \"overnight\" type when single day accout item has TimeTo = TimeFrom + 1day
Amount
Integer
Number of units / amount
UnitPrice
Decimal
Price per unit
TotalPrice
Decimal
Total price including Vat
IsPackage
Boolean
True if the item represents a package - mostly accomodation related account items
IDExternalAccount
Integer
ID of external account related to this posting. -1 if not specified
\n\n**Sample**\n\n```\n{\n \"IDService\": 1100000114,\n \"Text\": \"Prague sea view package - DBL room\",\n \"TimeFrom\": \"2019-06-21T00:00:00\",\n \"TimeTo\": \"2019-06-25T00:00:00\",\n \"Amount\": 1,\n \"UnitPrice\": 5000,\n \"TotalPrice\": 5000,\n \"IsPackage\": true\n}\n\n ```\n\n## ResOwnerBag\n\nReservation owner datail data bag.\n\n
TypeDescription
ID
Int
Owner's ID
Name
String
Owner's full name
AR
String
AR number
Email
String
Owner email
GSM
String
Owner mobile phone number, if not specified Phone number is used instead
Phone
String
LanguageISO
String
Owner language culture, see Language ISO codes object inNotessection for more details
IDSignature
String
ID Signature for guest (maximum 40 characters)
Loyalty
LoyaltyBag
Owner loyalty info
\n\n**Sample**\n\n```\n{\n \"ID\": 1100000254,\n \"Name\": \"John Wick\",\n \"AR\": \"123AA\",\n \"Email\": \"johnk.wick.3@gmail.com\",\n \"GSM\": \"+447754488755\",\n \"Phone\": \"+447123456789\",\n \"LaguageISO\": \"en-gb\",\n \"IDSignature\": \"28b008d4-293c-4393-b293-cf10f6dd717b\",\n \"Loyalty\": {\n \"ID\": 1200234134,\n \"Number\": \"ahoj\",\n \"LoyaltyConsent\": true\n }\n}\n\n ```\n\n## ResRoomBag\n\nRepresents one booked room in hotel reservation. Please pay attantion to IDStay attribute meaning, see\n\nNotes\n\n**IDStay** for detailed explenation.\n\nBe aware that PAX and Guests list are two seperate types of data and it is up to the hotel policy whenever these values must contains the same number of items. When booking is created there are Guests mostly missing and they're entered to the system later on. When PAX and Ages elements are presented in the data since booking has been created.\n\n
TypeDescription
ID
Integer
Room booking ID
IDStay
Integer
See Notes IDStay for more details
Arrival
DateTime
Arrival date
Departure
DateTime
Departure date
ETA
TimeSpan
Estimated time of arrival
State
Integer

Room booking state

  • 10 - Provisional (Opce)

  • 20 - Confirmed

  • 30 - CheckedIn

  • 40 - CheckedOut

RoomTypeCode
String
Booked room type code
RoomCode
String
Room code assigned to this room booking, if null or empty no physical room has been assigned yet
RoomRequestMask
Integer (UInt64)
The bit mask representing list of room requests made by client, for available options please see RoomFeaturesList method
Pax
Integer
Total number of reserved guests
Ages
RoomAgeCount[]
List of Age - Amount pairs, see RoomAgeCount object in this section for more details
Guests
ResCitizenIDBag[]
List of guest assigned to this booking, see ResCitizenIDBag object in this section for more details.
Note
String
Room note
AuthCode
String
Authorisation code for Restaurant API calls or using VentoQR
\n\n**Sample**\n\n```\n{\n \"ID\": 1100001587,\n \"IDStay\": 1100001577,\n \"Arrival\": \"2019-06-05T00:00:00\",\n \"Departure\": \"2019-06-10T00:00:00\",\n \"ETA\": \"16:00:00\",\n \"State\": \"Confirmed\",\n \"RoomTypeCode\": \"DBL\",\n \"RoomCode\": null,\n \"RoomRequestMask\": 26479,\n \"Pax\": 2,\n \"Ages\": [ { ... } ],\n \"Guests\": null,\n \"Note\": \"Guest want to stay in shadows\",\n \"AuthCode\": \"YNL06\"\n}\n\n ```\n\n## RoomAgeCount\n\nRepresents Age - Amount pair in room booking. Hotel can define up to five custom age categories.\n\n
TypeDescription
IDAge
Integer
0 ... is considered to be Adult (system default)
1 .. 5 is defined by hotel and is specified upon API setup
Amount
Integer
Represents number of people in designated age group
\n\n**Sample**\n\n```\n{\n \"IDAge\": 0,\n \"Amount\": 2\n}\n\n ```\n\n## ResDetailBag\n\nRepresents one booking in the system.\n\nBookings can be single or group bookings. Group booking is considered when one booking element contains multiple rooms with at least two distinct **IDStays**, see\n\nNotes\n\n**IDStay** for more details.\n\n
TypeDescription
ID
Integer
Booking ID
OriginID
String
Origin ID
Owner
ResOwnerBag
Booking owner, see ResOwnerBag object in this section for more details
CurrencyISO
String
See Currency ISO codes object in Notes section for more details
IDMainAccount
Integer
ID of the reservation's main Account
TotalPrice
decimal
Total price of all reservation accounts (excluding already paid items)
Advances
decimal
Sum of all reservation accounts pre-payments
DueBalance
decimal
Total price of all reservation accounting reduced by all pre-payments
Created
DateTime
Booking creation date and time. This is in HotelTime TimeZone and represents date and time when booking has been created in HotelTime system. Original booking creation date time could be different in the case of OTA booking
Arrival
DateTime
Arrival date of booking. In the case of multi room booking, this value represents min(TimeFrom) from all room bookings
Departure
DateTime
Departure date of booking. In the case of multi room booking, this value represents max(TimeTo) from all room bookings
PasswordProtected
Boolean
If true, booking is protected by password, validation should be performed by calee. For more detail please seeResPasswordValidatemethod
Segment
String
Name of segment assigned to the booking, enumeration is defined by hotel. Common values are (direct bookings, OTA, walk-in, business contracted, etc.)
ClientType
String
Name of clientele type, assigned to the booking, enumaration is defined by hotel. Common values are (ILT - individual leissure, IBT - individual business, GBL - group business, etc.)
Source
String
Name of booking source, enumeration is defined by hotel. Common values are (e-mail, phone, OTA, web, etc.)
VirtualCardExists
Boolean
If true, a virtual card is assigned to the booking
CHMExtraServiceInclusive
Boolean
True if CHM extra service included in price exists
CHMExtraServiceExclusive
Boolean
True if CHM extra service not included in price exists
SpecialsMask
Integer (UInt64)
The bit mask representing list of booking requests (specials) made by client, for available options please see ReservationSpecialsList method
Rooms
ResRoomBag[]
List of room bookings, see ResRoomBag object in this section for more details
Note
String
Booking note
HasAgreement
Boolean
True if terms and conditions were agreed upon while completing OnlineCheckin (ResOp controller, OnlineCheckinComplete method)
ExpectedPaymentMethod
Integer
ID of preferred (expected) reservation payment type
\n\n**Sample**\n\n```\n{\n \"ID\": 1200175510,\n \"Owner\": { ... },\n \"CurrencyISO\": \"EUR\",\n \"IDMainAccount\": 1200175517,\n \"Created\": \"2019-05-19T07:14:56.81\",\n \"Arrival\": \"2019-05-19T00:00:00\",\n \"Departure\": \"2019-05-24T00:00:00\",\n \"Segment\": \"\",\n \"ClientType\": \"\",\n \"Source\": \"\",\n \"VirtualCardExists\": false,\n \"OTA_PrePaymentData\": null,\n \"SpecialsMask\": 5,\n \"Rooms\": [ { ... }, { ... } ],\n \"Note\": \"Booker is a genius\",\n \"PasswordProtected\": false,\n \"HasAgreement\": false\n }\n\n ```\n\n## PendingReservationBag\n\nRepresents one booking - room booking pair returned by method providing pending bookings, see\n\nPendingCheckInList\n\nor\n\nPendingCheckOutList\n\nmethods.\n\n
TypeDescription
ID
Integer
Booking ID
IDResRoom
Integer
Room booking ID
IDStay
Integer
SeeNotesIDStay for more details
Owner
ResOwnerBag
Bookign owner, see ResOwnerBag object in this section for more details
Created
DateTime
Booking creation date and time. This is in HotelTime TimeZone and represents date and time when booking has been created in HotelTime system. Original booking creation date time could be different in the case of OTA booking
Arrival
DateTime
Arrival date of booking. In the case of multi room booking, this value represents min(TimeFrom) from all room bookings
Departure
DateTime
Departure date of booking. In the case of multi room booking, this value represents max(TimeTo) from all room bookings
State
Integer

Room booking state

  • 10 - Provisional (Opce)

  • 20 - Confirmed

  • 30 - CheckedIn

  • 40 - CheckedOut

RoomTypeCode
String
Booked room type code
RoomCode
String
Room code assigned to this room booking, if null or empty no physical room has been assigned yet
RateCode
String
RateCode (price plan) assigned to this room booking
\n\n**Sample**\n\n```\n{\n \"ID\": 1100001387,\n \"IDResRoom\": 1100001397,\n \"IDStay\": 1100001395,\n \"Owner\": { ... },\n \"Created\": \"2019-02-01T14:31:29\",\n \"Arrival\": \"2019-06-05T00:00:00\",\n \"Departure\": \"2019-06-10T00:00:00\",\n \"State\": \"Confirmed\",\n \"RoomTypeCode\": \"DBL\",\n \"RoomCode\": \"503\"\n}\n\n ```\n\n## ResValidationErrorBag\n\nRepresenting one failed room booking validation.\n\n
TypeDescription
IDResRoom
Integer
Room booking ID
Errors
ValidatonErrorBag[]
List of validation errors, see ValidatonErrorBag object in this section for more details
\n\n**Sample**\n\n```\n{\n \"IDResRoom\": 1100001397,\n \"Errors\": [ { ... }, { ... } ]\n}\n\n ```\n\n## ValidatonErrorBag\n\nRepresenting one failed validation criteria and description - if available.\n\n
TypeDescription
Code
Integer
Vioalted validation code, see Validation error codes inError codessection for more details
MetaData
String
Additional details regarding an errorneous state, mostly human readable
\n\n**Sample**\n\n```\n{\n \"Code\": 30003,\n \"MetaData\": \"Pending maintenance task found\"\n}\n\n ```\n\n## BitNameBag\n\nRepresenting one value used in list of items represented by bit mask. For more details about bit masks, see **Bit masks** in\n\nNotes\n\nsection.\n\n
TypeDescription
Bit
Byte
Byte index (0 .. 63) for 64bit masks and (0 .. 31) for 32bit masks
Code
String
User assigned code for this bit index
Name
String
User assigned name for this bit index (could be null or empty)
MaskValue
Integer (UInt64)
Bit index numerical representation for easier API callee operations
\n\n**Sample**\n\n```\n{\n \"Bit\": 19,\n \"Code\": \"LTCI\"\n \"Name\": \"Late Check-out\"\n \"MaskValue\": 524288\n}\n\n ```\n\n## MappingSheetResponse\n\n
TypeDescription
HotelClusterID
String
Hotel ID in HotelTime cluster enviroment
HotelName
String
Current hotel name
HomeCurrency
String(3)
ISO code of home currency
ComplimentaryCurrency
String(3)
ISO code of complimentary currency
RoomTypes
Array
List of available room types. Room type values:
- ID (Integer)
- Name (String) - code of the room
- Capacity (Integer) - maximum capacity of the room including extrabeds
Rooms
Array
List of available physical rooms. Room values:
- ID (Integer)
- Code (String) - code of the room
- Name (String) - hotel's name of the room
- IDRoomType (Integer) - id of room's room type - see above
Services
Array
List of available hotel services. Hotel service values:
- ID (Integer)
- Name (String) - code of the room
- VatCharge (Double) - VAT/TAX charge for the service
- Price_Home (decimal) - price in hotel's primary currency
- Price_Complimentary (decimal) - price is hotel's secondary currency
RastrHeaders
Array
List of available revenue accounts. RastrHeader values:
- ID (Integer)
- Name (String) - name of the account
PaymentTypes
Array
List of available payment types. Payment type values:
- ID (Integer)
- Name (String) - name of the payment type
ReservationPaymentTypes
Array
List of available reservation payment types.
- ID (Integer)
- Name (String) - code of the payment type
StayReasons
Array
List of available stay reasons. Stay Reason values:
- ID (Integer)
-Name (String) - name of the stay reason.
Segments
Array
List of available segments. Segments values:
- IDParent (Integer) - parent segment ID
- Type (String) - one of possible segment types (Standard, Complimentar, HouseUse)
- ID (Integer) - segment ID
- Name (String) - name of the segment
InventoryItems
Array
List of available inventory items. Inventory item values:
- Code (String) - code of inventory item.
- Quantity (Integer) - quantity of given item.
- ID (Integer) - inventory item ID
- Name (String) - Full name of inventory item
ReservationSources
Array
List of available reservation sources. Reservation source values:
- ID (Integer)
- Name (String) - name of the reservation source
SubjectCategories
Array
List of available subject categories. Subject category values:
- ID (Integer)
- Name (String) - name of the subject category
ClientTypes
Array
List of available client types. Client type values:
- ID (Integer) - client type ID
- Name (String) - name of the client type
- Code (String) - code of client type
- IsGroup (Bool) - whether the client type is a group
TravelDocumentTypes
Array
List of available travel document types. Travel document type values:
- ID (Integer)
- Name (String) - name of the travel document
LoyaltyItems
Array
List of available loyalty levels. Loyalty item values:
- ID (Integer) - loyalty item ID
- Name (String) - Full name of loyalty item
- Code (String) - short code of loyalty item
- NightCount (Integer) - roomnight count to achieve this loyalty level
- TurnOver (Decimal) - turnover amount to achieve this loyalty level
\n\n**Payment types - important note**\n\nMapping is returning a complete list of payment types defined by the hotel. Use of payment type is dependant on hotel settings and can vary between years. Consult with the hotel which payment type is set for proper KioskAPI operations before using it.\n\n**Sample**\n\n```\n{\n \"HotelClusterID\": \"10.1100000001\",\n \"HotelName\": \"HotelTime Hotel\",\n \"HomeCurrency\": \"CZK\",\n \"ComplimentaryCurrency\": \"EUR\",\n \"RoomTypes\": [ \n { \"ID\": 1233321, \"Name\": \"Twin\", \"Capacity\": 2 },\n { \"ID\": 1233322, \"Name\": \"SGL\", \"Capacity\": 1 }\n ],\n \"Rooms\": [ \n { \"ID\": 1554, \"Code\": \"201\", \"Name\": \"Standard\", \"IDRoomType\": 1233321 },\n { \"ID\": 1410, \"Code\": \"211\", \"Name\": \"Standard balcony\", \"IDRoomtype\": 1233322 }\n ],\n \"Services\": [ \n { \"ID\": 1008560, \"Name\": \"Room upgrade\", \"VatCharge\": 15.0, \"Price_Home\": 1000.0, \"Price_Complimentary\": 40.0 },\n { \"ID\": 1008561, \"Name\": \"CocaCola\", \"VatCharge\": 21.0, \"Price_Home\": 0.0, \"Price_Complimentary\": 0.0 }\n ],\n \"RastrHeaders\": [ \n { \"ID\": 1139560, \"Name\": \"Accomodation\" },\n { \"ID\": 1184528, \"Name\": \"Minibar services\" }\n ],\n \"PaymentTypes\": [ \n { \"ID\": 1172252, \"Name\": \"Cash\" },\n { \"ID\": 1172253, \"Name\": \"Payment card\" } \n ],\n \"StayReasons\": [\n { \"ID\": 1200112136, \"Name\": \"Bussiness\" },\n { \"ID\": 1200112138, \"Name\": \"Touristic\" }\n ],\n \"Segments\": [ \n { \"IDParent\": -1, \"Type\": \"Standard\", \"ID\": 1254765007, \"Name\": \"Internet\" },\n { \"IDParent\": 1254765007, \"Type\": \"Standard\", \"ID\": 1254755006 , \"Name\": \"OTA\" }\n ],\n \"InventoryItems\": [\n { \"Code\": HDR, \"Quantity\": 30, \"ID\": 9, \"Name\": \"Hairdryer\" },\n { \"Code\": null, \"Quantity\": 4, \"ID\": 16, \"Name\": \"E-Bike\" }\n ],\n \"LoyaltyItems\": [\n {\n \"Code\": \"Cu\", \"Turnover\": 50000.0000, \"NightCount\": 10, \"ID\": 1200234130, \"Name\": \"Copper\"\n },\n { \"Code\": \"Ag\", \"Turnover\": 500000.0000, \"NightCount\": 100, \"ID\": 1200234134, \"Name\": \"Silver\" \n}\n ]\n}\n\n ```\n\n## GuestAddResponse\n\n
TypeDescription
IDGuest
Integer
ID of the new g uest in hotel's address book
IDAccount
Integer
If guest has been added with account create request, the ID of guest's account is provided. Otherwise -1
\n\n## AccountPayResponse\n\n
TypeDescription
IDSubject
Integer
Hotel's address book profile ID of the owner of paid invoice
DocumentType
Integer
Type of paid invoice
14872537 = Tax invoice
14872538 = Advance invoice
50794272 = Closed hotel invoice
TaxDocumentID
Integer
ID of paid / created invoice
TaxDocumentExtCode
String(40)
Paid invoice number
\n\n# Error codes\n\n## Response error codes\n\nIf the query fails, the following error codes can be expected:\n\n
IDCodeDescriptionExpected callee action
1
SystemUnderMaitenance
System is temporarly off-line
Try in next 10min window
2
SecureConnectionRequired
API call without HTTPS connection
Use HTTPS instead of HTTP
3
InterfaceNotActive
License is valid but temporarly disabled
Contact support for more details
4
InterfaceNotConfigured
Particular license hasn't been set up yet for production environment
Contact support for more details
404
EntityNotFound
Requested entity not found
See MetaData for more details
500
InternalServerError
Internal server occured
Try calling the API again in few minutes, if problems persists contact support
1001
InvalidLicense
License provided is invalid or hasn't been designated for production environment
Contact support
1002
LincenseIsMissing
API request without license data
Check for HTTP header presence
1003
LicenseMethodNotAllowed
Controller method is not allowed for the license
Contact support
1004
LicenseParallelRequest
Only one call per license is allowed
Do not issue parallel requests
2001
ParameterInvalid
Parameter provided is invalid
See MetaData for more details
2002
ParameterMissing
Mandatory parameter is missing
See MetaData for more details
2003
ParameterOutOfRange
Parameter is out of allowed range
See MetaData for more details
3001
NotSupportedOperation
The operation requested is not supported
See MetaData for more details
3002
ExternalError
An error occured in external system comminication
Retry in few minutes, otherwise contact support
4000
UnknowError
Something went really bad ...
Contact support
4002
4004
EntityLocked
The entity has been locked for this operation
See MetaData for more details
4005
EntityInInvalidState
Entity is not in valid state for this operation
See MetaData for more details
4006
EntityNotEmpty
En empty entity is requested for this operation
See MetaData for more details
4007
EntityValidationRequired
Entity validation should be performed
Call validation method first - check for details in method raising this error
4008
EntityDuplicity
Operation will lead to entity duplicity which is not allowed
See MetaData for more details
\n\n## Validation error codes\n\n
IDCodeDescription
30001
MissingGuest
One or more guest profiles is missing, number of guest must be greater or equal to PAX
30002
MissingRoom
Physical room hasn't been assigned to booking yet, contact front-office
30003
RoomIsNotReady
Room hasn't been cleaned up, inspected yet
30004
RoomIsOccupied
Previous booking hasn't been checked-out yet
30005
GuestProfileIncomplete
Some of the data are missing in the guest profile, contact front-office for more details
30006
PreCheckinPaymentRequired
Check-in procedure cannot be completed until pre-payment of booking is registered in system. See ResPrePayment method
30007
ArrivalDateMismatch
Check-in can be made on the arrival date only
30008
AllTokenAreActivated
Check-in procedure cannot be completed, all external tokens are activated for specified stay
30009
MissingGuestRequiredFiled
30010
MissingOrderCode
Check-in procedure cannot be completed until order code is filled in
40001
UnpaidGuestAccountFound
One or more unpaid guest accounts found. See ResPendingAccounts method
40002
UnpaidMainAccountFound
Unpaid main account found. See ResPendingAccounts method
40003
EarlyCheckout
Check-out can be made on the departure date only
40004
CheckedOutAlready
Booking has been checked out already
40005
RoomInInvalidStateFound
Room is in invalid state for particular operation - like an attempt to check-out not checked-in room
\n\n# Version Information\n\n
VersionDateChanges
1.1.24
14/05/2026
Added new controller AddressBook.

Enum/MappingSheet extended for ReservationSources, ClientTypes, SubjectCategories and TravelDocumentTypes fields.

The lists of LanguageISOs codes acctepted/returned by various data bags (eg. ResCitizenBag, InvoiceSendBag) have been updated.
1.1.23
07/05/2026
Added AR field to ResOwnerBag, ResCitizenBag, ResCitizenIDBag, ResCompanyBag, AccountHeaderBag
1.1.22
22/09/2025
Added Loyalty fields to ResCitizenBag, ResCitizenIDBag, ResCompanyBag, ResOwnerBag, MappingSheetResponse.
Created LoyaltyBag
1.1.21
29/07/2025
Added PostponedExtrasCharge method to Account controller, which puts inclusive/exclusive services to queue of reservation services that are to be charged after check-in.

Expanded Reservation/CHMExtraServices output by output fields DateFrom, DateTo, IDStay.

Enum/MappingSheet now sends ReservationPaymentTypes IDNameBags.

Reservation/Detail now sends ExpectedPaymentMethod ID of given reservation. (Meaning of IDs can be found in Enum/MappingSheet)
1.1.20
17/06/2025
ResOp controller was expanded by method PromocodeUpdate, which updates reservation promocode.
1.1.19
16/05/2025
The KioskAPI now processes only one request per license at a time. A parallel call will yield a LicenseParallelRequest error (code 1004).
1.1.18
07/04/2025
Guest controller's methods AddNewGuest, Update and AddNewGuestStay now support filling in the type of personal document and its expiration.

Reservation controller's method Detail now also return OriginID.

Added new method CountryList to Enum controller.
1.1.17
12/03/2025
Added an option to specify IDAccount in ResPrePayment
1.1.16
28/01/2025
New method ResOwnerUpdate added to Reservation controller
1.1.15
25/01/2025
ResDetailBag extended for CHMExtraServiceInlcusive/Exclusive properties

New method CHMExtraServices added to Reservation controller
1.1.14
24/01/2025
AccountItemBag extended for IDExternalAccount property
1.1.13
23/01/2025
AddNewGuest and AddNewGuestStay now support adding an already existing Citizen by its ID.
1.1.12
25/11/2024
RoomTypeUpgrade now supports upgrading ResRoom with assigned physical room.
1.1.11
11/09/2024
New error code LicenseMethodNotAllowed has been added.
1.1.10
10/14/2024
AccountHeaderBag extended of response parameters OwnerID and IsOwnerCompany.
1.1.9
09/24/2024
Enum controller's method MappingSheet extended of response parameter InventoryItems.
1.1.8
09/04/2024
Account controller's method TaxAdvanceCreate is extended for CreateVoucher and VoucherExtCode fields.

MappingSheet response on Enum controller has been extended for Price_Home and Price_Complimentary fields under hotel's services enumeration.

HotelStatus response on Enum controller has been extended for Languages field.
1.1.7
08/03/2024
AccountPayResponse extended for IDSubject property
Account controller extended for TaxAdvanceCreate and TaxAdvancePrintData methods
1.1.6
08/02/2024
Guest controller Update extended of parameter IDStayReason.
1.1.5
07/11/2024
ResOp controller CheckOutValidate and CheckOut methods extended of parameter IDResRoom. Guest controller all methods were extended to be used in room state 30 - CheckedIn with related application settings.
1.1.4
06/20/2024
Enum controller extended of new method HotelStatus. Method MappingSheet extended of hotel currencies and exchange rate, cluster ID and name of application (hotel), segments. Guest controller methods AddNewGuest and AddNewGuestStay extended of new response parameter GuestAddResponse.
1.1.3
04/28/2022
AuthToken added to room detail under Detail method in Reservation controller
1.1.2
04/14/2021
ETD estimated time of departure feature extending Reservation controller.
ResStayETDUpdate and ResRoomETDUpdate methods has been added
1.1.1
03/17/2021
Availability controller extended for RoomsAvailableForResRoom method
ResOp controller extended for RoomAssign method
1.1.0
11/12/2020
Enum controller extended for MappingSheet method
1.0.9
08/14/2020
ResDetailBag extended for PasswordProtected, Segment, ClientType, Source, VirtualCardExists properties
1.0.8
07/27/2020
Added the ResStayPendingAccounts method to the Account controller, the AddNewGuestStay method to the Guest controller, StayFeatureAdd, CheckInStayValidate and CheckInStay methods to the ResOp controller and StayDetail, ResStayNoteUpdate and ResStayETAUpdate methods to the Reservation controller
1.0.7
07/08/2020
Added the Phone field to the ResCitizenBag, ResCitizenIDBag and ResOwnerBag
Removed the DueBalance field from the ResDetailBag
1.0.6
03/31/2020
Added the IDSignature field to the ResCitizenBag, ResCitizenIDBag and ResOwnerBag

Added the GuestIDSignatureUpdate method to the Guest controller to add possibility to update guest's IDSignature (maximum 40 characters)
1.0.5
02/13/2020
Added the RateCode field to the Check-in / In-house / Check-out reservation lists
1.0.4
12/19/2019
Added the InhouseReservationList method to the Reservation controller to add possibility to get list of inhouse reservations
1.0.3
10/25/2019
Added the GetURLParameterForReservationByID method to the Reservation controller to add possibility to get the URL parameter for the Online Checkin application by reservation ID
1.0.2
8/2/2019
Added the ID property to the ResOwnerBag object to determine whether the owner of the reservation is also a guest
1.0.1
7/31/2019
Added the PasswordProtected property to the ResDetailBag object to determine whether the reservation is password-protected
1.0.0
7/1/2019
Initial version
\n\n# Notes\n\n## IDStay\n\nIDStay is per-booking unique identifier of one reserved room. This ID is generated upon booking creation and remains constant whenever operation is applied to the booking.\n\nYou can use this ID to identify rooms that are considered to be \"one\" stay. When booked room is splitted (f.e. due to room change in the middle of booking stay) new room booking is created and added to the booking. But the ID stay is copied from originaly splitted room booking. Therefore identifying one booked room stay.\n\n**Sample - Initial data**\n\n```\n{\n ...,\n \"ID\": 1100001578,\n \"IDStay\": 1100001577,\n \"Arrival\": \"2019-06-05T00:00:00\",\n \"Departure\": \"2019-06-10T00:00:00\",\n ...\n}\n\n ```\n\n**Sample - Room change in the middle of stay**\n\n```\n{\n ...,\n \"ID\": 1100001578,\n \"IDStay\": 1100001577,\n \"Arrival\": \"2019-06-05T00:00:00\",\n \"Departure\": \"2019-06-08T00:00:00\",\n ...\n},\n{\n ...,\n \"ID\": 1100001821,\n \"IDStay\": 1100001577,\n \"Arrival\": \"2019-06-08T00:00:00\",\n \"Departure\": \"2019-06-10T00:00:00\",\n ...\n}\n\n ```\n\nRoom bookings in the same IDStay group can have different **State** attributes according to hotel operations.\n\nPlease be aware that this room split can be done even for future bookins not only currently in-house.\n\nPossible room split causes (mid stay):\n\n- Room change\n \n- RoomType change\n \n- PAX change\n \n- Age composition change\n \n- RateCode change\n \n\nWhen change above is reverted to its original value, room booking isn't joined back to one item and remains splitted into two room bookings.\n\n## Reservation specials and Room features\n\nReservation specials and Room features are both list of 1..64 items defined by hotel. Please consult with hotel operations for more details and each attribute details.\n\nRoom features are additional attributes assigned to physical hotel rooms, each room booking can define set of these attributes to be fullfilled for particular reservation - room assignment.\n\nReservation specials are additional attributes assignable to the booking header, marking booking requirements for some special requirements or additional operations categorization / flagging.\n\nEach of this list is represented by bit-mask, allowing multiple list items to be specified in single value item. See **Bit masks** in this section for more details.\n\nList of currently defined room features can be retrieved by calling\n\nRoomFeaturesList\n\n, list of reservation specials by calling\n\nReservationSpecialsList\n\n**Sample - Room features**\n\n```\n...\n04 Twin\n05 Double\n06 Queen size\n07 Shower\n08 Disabled access\n09 Elevator\n10 Balcony\n...\n\n ```\n\n**Sample - Reservation specials**\n\n```\n...\n17 Shuttle\n18 Baby cot\n19 Dog\n20 Genius\n21 Wellness Complimentary\n22 Early check-in\n23 Late check-out\n...\n\n ```\n\n## Room type upgrade pricing\n\nRoom type upgrade pricing decision is up to the callee application logic. API doesn't expose any functionality to define room type upgradability matrix as well as upgrade pricing rules. The API will only validate that requested room type is compatible with booked RateCode for particular booking the callee is requesting upgrade for.\n\nUpgrade pricing could follow three basic models:\n\n1. **Free of charge** upgrade - then no price computation is required\n \n2. **One time fee** - then the upgrade fee is charged to booking account on the arrival datewith \"one time fee\" price specified\n \n3. **Room-night fee** - or person per night fee, in this case upgrade fee is charged to the booking account on the arrival date, but the callee must select one of three options available - hotel operations consultancy here is advised\n \n\nRoom-nigh fee account representation (f.e. booking 20 - 25.6.2019, fee 100 EUR per night):\n\n1. Five account items, one per night => 5x (UnitPrice = **100**, Amount = **1**)\n \n2. One account item, keeping unit price => 1x (UnitPrice = **100**, Amount = **5**)\n \n3. One account item, merging unitprice into one => 1x (UnitPrice = **500**, Amount = **1**)\n \n\nCallee must also select appropriate booking account for upgrade charge. If there is only main account - situation is pretty straightforward. In the case one or more guest account exists on upgraded room booking hotel operation rules applies here and callee should consult account **decission strategy** with hotel operations.\n\nLast but very important decission to make is to charge upgrade to hotel account with specific hotel service or as service less posting. For the difference please see **Generic extra service charge** in\n\nAPI use / use-cases\n\nsection.\n\n## Language name ISO codes\n\nSystem currently supports following language name ISO codes:\n\n
cs-cz
en-gb
de-ge
fr-fr
ru-ru
sk-sk
es-es
nl-nl
pl-pl
it-it
da-dk
ar-ae
\n\n> For new language ISO name code please contact support \n \n\n## Currency ISO codes\n\nSystem currently supports following currency ISO 4217 codes:\n\n
CZK
EUR
USD
PLN
CHF
GBP
DKK
ISK
NOK
SEK
HRK
JPY
SKK
CAD
AUD
HUF
TZS
LKR
KES
THB
AED
FJD
CDF
PHP
VND
IDR
NPR
SGD
CNY
HKD		MYR
NZD
ZAR
SAR
LAK
\n\n> For new currency ISO code please contact support \n \n\n## Bit masks\n\nStatic lists / enumerations are represented as bit-masks. Usualy stored in insigned 64bit integers, unsinged 32bit integers or rarely in byte fields. If not speficied otherwise unsigned 64bit integer is the default type.\n\nMore resources can be found here:\n\n- Wikipedia - Bitmask\n \n- Bitmasks for beginners\n \n- Bitmasks and enum flags\n \n\n## List of specific terms\n\n
TermDescription
RateCode
Pricing plan in HotelTime, besides pricing it will defined rules and restrictions applied to the hotel room booking
Rastr
Revenue account - statistical categorization of hotel revenue posted from accounts to the statistics by hotel day closure
PMS
Property Management System - system responsible of running hotel operations
OTA
Online Travel Agent - f.e. Booking.com, Expedia, ...
OBE
On-line Booking Engine
CHM
Channel Manager - booking delivery platform to PMS and availability, price and restriction distribution channel to the OTA's
Account / Bill / Invoice
Account stands for opened hotel account which by the time of departure (or early) is closed - then creating Bill or Invoice. Bill and Invoice both are tax documents, the only difference is that Bill is usually paid by Cash / Card, then Invoice is considered to be issued to account owner and paid afterwards or depending to accountancy requirements invoices are issued in the case where pre-payments should be settled or hotel specific operations requires issuing of invoices for Card payments
Extras
Any item posted to the account without direct binding to the hotel booking - by direct binding please understand no rule is defined in PMS to create such an item during booking create / update events. F.e. minibars, parking fee, restaurant bills, wellness bills, room service, etc.
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7227140","team":336225,"collectionId":"71f4c0e1-13cc-4c2a-9ee1-6be35302c241","publishedId":"S1a32SZB","public":true,"publicUrl":"https://docs-ht.hoteltime.com","privateUrl":"https://go.postman.co/documentation/7227140-71f4c0e1-13cc-4c2a-9ee1-6be35302c241","customColor":{"top-bar":"ffffff","right-sidebar":"383E46","highlight":"3566B1"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/dc0575ce-0e28-43f4-9f64-d3a707f3c1d9/SFRfbG9nb19zb2x1dGlvbnNfd2hpdGUucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/afcd3bcb-2e0e-45a0-875f-4a4282d3f8b3/SFRfbG9nb19zb2x1dGlvbnMucG5n","colors":{"top-bar":"ffffff","right-sidebar":"383E46","highlight":"3566B1"}}]}},"version":"8.11.6","publishDate":"2025-05-13T14:42:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/afcd3bcb-2e0e-45a0-875f-4a4282d3f8b3/SFRfbG9nb19zb2x1dGlvbnMucG5n","logoDark":"https://content.pstmn.io/dc0575ce-0e28-43f4-9f64-d3a707f3c1d9/SFRfbG9nb19zb2x1dGlvbnNfd2hpdGUucG5n"}},"statusCode":200},"environments":[{"name":"Kiosk API - Documentation","id":"bc786659-99d1-46b7-9bf2-646df78f89b4","owner":"7227140","values":[{"key":"url","value":"https://[server]","enabled":true},{"key":"licensetoken","value":"[guid token]","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0bf0928846992ad8e0dba2916371438db20331b5b1cdbdd38b57ba2536cbc192","favicon":"https://res.cloudinary.com/postman/image/upload/v1554990711/team/xbkmtlivbdnod0vkhrxr.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Kiosk API - Documentation","value":"7227140-bc786659-99d1-46b7-9bf2-646df78f89b4"}],"canonicalUrl":"https://docs-ht.hoteltime.com/view/metadata/S1a32SZB"}