Learn about HK PMS APIs to perform basic stay, folio, housekeeping and maintenance operations.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1388173","collectionId":"e2feb3b8-5e43-42df-8781-7ae70f08cade","publishedId":"2s93m1bR3E","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-21T17:30:59.000Z"},"item":[{"name":"Stays","item":[{"name":"Get Arrival Stays","id":"ad3b804e-b040-42af-a8c0-0d2b109a8188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This API enables the calling application to retrieve all stays that are in arrivals for the current business day.
\nRequest Body Details
\nNone
\nResponse Body Details
\n","urlObject":{"path":["This API enables the calling application to retrieve all stays that are in departures for the current business day.
\nRequest Body Details
\nNone
\nResponse Body Details
\n","urlObject":{"path":["This API enables the calling application to retrieve all stays that are in house for the current business day.
\nRequest Object Details
\nNone
\nResponse Object Details
\n","urlObject":{"path":["This API enables the calling application to retrieve the header-level details for the stay(s) associated with the given confirmation number.
\nRequest Object Details
\nNone
\nResponse Object Details
\n","urlObject":{"path":["This API retrieves the stay details for a given specific reservation id in the HK PMS system.
\nRequest Object Details
\nNone
\nResponse Object Details
\nSee example response.
\n","urlObject":{"path":["This API enables the calling application to assign a specific room unit to a stay.
\nRequest Object Details
\nResponse Object Details
\nNone
\n","urlObject":{"path":["This API enables the stay to be checked-in.
\nThis Request Object Details
\nNone
\nResponse Object Details
\nNone
\nMust Have Pre-Conditions
\nThis API enables the stay to be queried to be check-out eligible.
\nRequest Object Details
\nNone
\nResponse Object Details
\nMust Have Pre-Conditions
\nThis API enables the stay to be checked-out.
\nRequest Object Details
\nNone
\nResponse Object Details
\nNone
\nMust Have Pre-Conditions
\nThis section contains the APIs related to stay management. It is worth mentioning HK PMS is natively built with the concept of the single image inventory, which requires PMS to only handle the stays, folios and other property related operations. The CRS system of the record is responsible for the reservations, groups and all inventory-related functionalities. Every reservation in the CRS subsequently creates one or more stays in the HK PMS system. This design holds true whether it is HK CRS or an enterprise's chosen CRS system.
\n","_postman_id":"9e839183-ae5e-46fa-8bdd-24eff02ca8bb"},{"name":"Room Units","item":[{"name":"Get All Room Units","id":"b54a93a1-af49-46de-b6d5-e76bdcf7dd71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This API provides the room units inventory that exists for the given property.
\nRequest Object Details
\nNone
\nResponse Object Details
\nSee example response.
\n","urlObject":{"path":["This API provides all available room units that can be assigned to a given stay. It provides room units in an array format and also provides a set of filter groups that be used by the UI apps to organize the list of the rooms.
\nRequest Object Details
\nResponse Object Details
See example response.
A set of endpoints to retrieve available room units in general and for stay assignments.
\n","_postman_id":"3a64cf88-b08a-4a56-ac51-014d217ae3fb"},{"name":"Shift Management","item":[{"name":"Start Shift","item":[{"name":"Start Shift Consent","id":"6092aaec-938d-40b5-8a8e-636c1c95a68b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This API allows the user to get a consent to start a shift in the HK PMS system. All CASH or CHECK financial transactions that take place using a shift are recorded as part of the cash drawer.
\nRequest Object Details
\nNone
\nResponse Object Details
\n","urlObject":{"path":["This API allows the user to commit a shift start in the HK PMS system. All CASH or CHECK financial transactions that take place using a shift are recorded as part of the cash drawer.
\nRequest Object Details
\nResponse Object Details
\n","urlObject":{"path":["A set of endpoints to add a start a shift.
\n","_postman_id":"87fba208-60ba-41a7-b5f8-d3b8bcc054f6"},{"name":"End Shift","item":[{"name":"End Shift Consent","id":"fdfd21ea-5d14-4b18-ad91-15bf409ee9db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This API is called with shift id in the path param to get details of the currently open shift.
\nRequest Object Details
\nNone
\nResponse Object Details
\n","urlObject":{"path":["This API is called to end the currently open shift.
\nRequest Object Details
\nResponse Object Details
\nNone
\n","urlObject":{"path":["A set of endpoints to end a shift.
\n","_postman_id":"d3d9c12f-570c-490b-98a7-d865d8d4ca89"}],"id":"01b0baf5-d173-4d5a-9ba2-c745b62899ab","description":"A set of endpoints to manage shifts.
\n","_postman_id":"01b0baf5-d173-4d5a-9ba2-c745b62899ab"},{"name":"Stay Folios","item":[{"name":"Add Charge","item":[{"name":"List of Charge Types","id":"3ea2d576-5167-4b38-930c-3766fbbb04b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This API takes in a stay id and folio id and provides a list of charge types that can be posted to the specific folios with the specific amounts. It abstracts the charge type categories and all the discounting and other filtering from the client apps.
\nRequest Object Details
\nNone
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API provides a consent service to the client apps, who wish to add a specific charge type to a specific folio within a a specific stay for the given date range and quantity.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API provides an add charge service to the client apps, who wish to add a specific charge type to a specific folio within a a specific stay for the given date range and quantity.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nNone
\n","urlObject":{"path":["A set of endpoints to add a charge to the stay folios.
\n","_postman_id":"75d600d4-7b92-422e-a904-6839785e9b0c"},{"name":"Adjust Charge","item":[{"name":"Adjust Charge Consent","id":"09ef32ed-711d-47ab-ac54-11757e5167fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"charges\":[{\"id\":\"dcb68f5e-8536-47d5-bacf-d7b0254790e6\",\"value\":\"8\"}],\"adjustment_code_id\":\"4e7fd2d2-ada3-4a64-942c-cc9218a86428\",\"type\":\"DIRECT_ADJUSTMENT_INCL_TAX\",\"remark\":\"TEST\"}"},"url":"This API provides a consent service to the client apps, who wish to adjust a posted charge in the specific folio / stay.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API provides an adjust charge commit service to the client apps.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nNone
\n","urlObject":{"path":["A set of endpoints to adjust charges.
\n","_postman_id":"f4fd4da9-8b6c-4de9-821f-3788d14f1f89"},{"name":"Refund Payment","item":[{"name":"Refund Consent","id":"acac70cf-440b-4768-b5ad-df36d0cc0c32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"amount\":\"10\",\"refund_code_id\":\"980968ee-522e-4727-8cf1-bb1453f93db7\"}"},"url":"This API provides a consent service to the client apps, who wish to refund a posted payment in the specific folio / stay.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API provides the refund commit service to the client apps.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nNone
\n","urlObject":{"path":["A set of endpoints to process a refund of a payment.
\n","_postman_id":"e8715991-83e0-4a0e-8623-90aca1ff92a4"},{"name":"Retrieve a Folio","id":"11e4db7e-4486-4b7e-b50d-20ec03a28177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"This API provides the full folio object as a JSON.
\nRequest Object Details
\nNone
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API collects a payment based on the given request parameters for the given stay / folio.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nNone
\n","urlObject":{"path":["A set of endpoints to manage folios associated with stays.
\n","_postman_id":"3780c058-3981-4956-848b-e236aa2413dd"},{"name":"Maintenance","item":[{"name":"New Maintenance Issue","item":[{"name":"Get Available Maintenance Codes","id":"e2e9dd8d-9b50-4596-b3f0-d796d4af6e13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"This API brings back the maintenance codes as an array.
\nRequest Object Details
\nNone
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API brings back the available rooms to be marked OOO based on the given date range.
\nRequest Object Details
\nNone
\nResponse Object Details
\nSee example response
\n","urlObject":{"path":["This API creates a maintenance issue of the specific type, on the given room for the given dates.
\nRequest Object Details
\nSee example request
\nResponse Object Details
\nNone
\n","urlObject":{"path":["