Bookings

Retrieve Post to Room Information for specific room

This API provides in-house room/folio for your property for a specific room on which you wish to post the charges in context to charge post API. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

Header

Content-Type: application/xml

Parameter

NameData TypeDescription Example
auth *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
oprn *VARCHAR(150)Use Keyword “roomquery”
room *INT(11)Need to provide Room Id 106

Request 

<?xml version="1.0" standalone="yes"?>
<request>
<auth>xxxxxxxxxxxxxxxxxxxxxxx</auth>
<oprn>roomquery</oprn>
<room>106</room>
</request>

Response

NameData TypeDescription Example
statusStringStatus value will be provided Values: ok, errorok
softwaredateDateDate will be provided2020-03-19
msgStringMessage result will be provided Values:inhouseinhouse
guestnameStringGuest Name will be providedMr. Joy
arrivalDateIt is giving arrival date2020-03-17
departureDateIt is giving departure date2020-03-20
masterfolioIntegerMasterfolio no will be provided10
roomStringIt is giving room name/number106
roomtypeStringIt is giving room typeStudio
ratetypeStringIt is giving rate typeAll Inclusive
resnoIntegerIt is giving reservation no.11

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg>inhouse</msg>
    <softwaredate>2020-03-19</softwaredate>
    <guestname>Mr.U K Shah</guestname>
    <arrival>2020-03-17</arrival>
    <departure>2020-03-20</departure>
    <room>106</room>
    <masterfolio>10</masterfolio>
    <roomrows>
        <row>
            <guestname>Mr. Joy</guestname>
            <arrival>2020-03-17</arrival>
            <departure>2020-03-20</departure>
            <masterfolio>10</masterfolio>
            <room>106</room>
            <roomtype>Studio</roomtype>
            <ratetype>All Inclusive</ratetype>
            <resno>11</resno>
        </row>
    </roomrows>
</response>

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

ErrorsDescription
Hotel Code In-ActiveThe Property has been deactivated
API Authkey is deactivatedThe Authcode/Key has been deactivated
Invalid AuthenticationInvalid data
Bad RequestInvalid Request Parameter
Invalid API Request. Don’t have this API accessInvalid Request Method
Room not found

Bookings

Retrieve Post to Room Information

This API provides in-house rooms/folios for your property on which you wish to post the charges in context to charge post API. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

Header

Content-Type: application/xml

Parameter

NameData TypeDescription Example
auth *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
oprn *VARCHAR(150)Use Keyword “roomlist”

Request 

<?xml version="1.0" standalone="yes"?>
<request>
<auth>xxxxxxxxxxxxxxxxxxxxxxx</auth>
<oprn>roomlist</oprn>
</request>

Response

NameData TypeDescription Example
statusStringStatus value will be provided Values: ok, errorok
softwaredateDateDate will be provided2020-03-19
msgStringMessage result will be provided Values:inhouseinhouse
guestnameStringGuest Name will be providedMr. Joy
arrivalDateIt is giving arrival date2020-03-17
departureDateIt is giving departure date2020-03-20
masterfolioIntegerMasterfolio no will be provided10
roomStringIt is giving room name/number106
roomtypeStringIt is giving room typeStudio
ratetypeStringIt is giving rate typeAll Inclusive
remarksStringIt is giving remarks
resnoIntegerIt is giving reservation no.11

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg>inhouse</msg>
    <softwaredate>2020-03-19</softwaredate>
    <roomrows>
        <row>
            <guestname>Mr. Joy</guestname>
            <arrival>2020-03-17</arrival>
            <departure>2020-03-20</departure>
            <masterfolio>10</masterfolio>
            <room>106</room>
            <roomtype>Studio</roomtype>
            <ratetype>All Inclusive</ratetype>
            <remarks></remarks>
            <resno>11</resno>
        </row>
        <row>
            <guestname>Mrs Sophia</guestname>
            <arrival>2020-03-18</arrival>
            <departure>2020-03-21</departure>
            <masterfolio>22</masterfolio>
            <room>109</room>
            <roomtype>Single Bedroom Suite</roomtype>
            <ratetype>Daily</ratetype>
            <remarks></remarks>
            <resno>21</resno>
        </row>
        <row>
            <guestname>Mr.Denial Mark</guestname>
            <arrival>2020-03-19</arrival>
            <departure>2020-03-21</departure>
            <masterfolio>8</masterfolio>
            <room>101</room>
            <roomtype>Delux</roomtype>
            <ratetype>Frequent Traveller</ratetype>
            <remarks></remarks>
            <resno>9</resno>
        </row>
    </roomrows>
</response>

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

ErrorsDescription
Hotel Code In-ActiveThe Property has been deactivated
API Authkey is deactivatedThe Authcode/Key has been deactivated
Invalid AuthenticationInvalid data
Bad RequestInvalid Request Parameter
Invalid API Request. Don’t have this API accessInvalid Request Method
In-House guest room list is empty

Bookings

Update POS Receipt No

This API allows you to update receipt no on a folio in context to charge post API. In case of any issues with receipt no, you can make use of this API to update the correct receipt no. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

Header

Content-Type: application/xml

Parameter

NameData TypeDescription Example
auth *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
oprn *VARCHAR(150)Use Keyword “updatevoucherno”
voucherno *INT(11)Voucher No will be providedPOS245
requestid *INT(11)Request Id will be provided2804

Request 

<?xml version="1.0" standalone="yes"?> 
<request> 
<auth>xxxxxxxxxxxxxxxxxxxxxxx</auth>
<oprn>updatevoucherno</oprn> 
<voucherno>POS245</voucherno>
<requestid>2804</requestid>
</request>

Response

NameData TypeDescription Example
statusStringStatus value will be provided Values: ok, errorok
msgStringMessage result will be provided Values: already voided, voucher no. already present, voucher no. addedvoucher no. added

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg> voucher no. added </msg>
</response>

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

ErrorsDescription
Hotel Code In-ActiveThe Property has been deactivated
API Authkey is deactivatedThe Authcode/Key has been deactivated
Invalid AuthenticationInvalid data
Bad RequestInvalid Request Parameter
Invalid API Request. Don’t have this API accessInvalid Request Method
Invalid request idProvided Request Id is invalid

Bookings

Void Charge on Room

This API allows you to void/delete the posted charges on a folio in context to charge post API. When you have asked the restaurant manager to post charge to room, but then you decide to pay straight away, so for deleting those charges from folio, you can make use of this API. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

Header

Content-Type: application/xml

Parameter

NameData TypeDescription Example
auth *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
oprn *VARCHAR(150)Use Keyword “voidcharge”
requestid *INT(11)Need to send request id172

Request 

<?xml version="1.0" standalone="yes"?>
<request>
<auth>xxxxxxxxxxxxxxxxxxxxxxxx</auth>
<oprn>voidcharge</oprn>
<requestid>2804</requestid>
</request>

Response

NameData TypeDescription Example
statusStringStatus value will be provided Values: ok, errorok
msgStringMessage result will be provided Values: voided,already voidedvoided

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg>voided</msg>
</response>

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

ErrorsDescription
Hotel Code In-ActiveThe Property has been deactivated
API Authkey is deactivatedThe Authcode/Key has been deactivated
Invalid AuthenticationInvalid data
Bad RequestInvalid Request Parameter
Invalid API Request. Don’t have this API accessInvalid Request Method
Invalid request idProvided Request Id is invalid
Invalid Operation

Bookings

Post Charge To Room

This API allows you to post charges on a folio. This is basically you take food in the restaurant and ask to do Room Post as you are staying in the same hotel, so you wish to pay finally on checkout. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

Header

Content-Type: application/xml

Parameter

NameData TypeDescriptionExample
auth *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
oprn *VARCHAR(150)Use Keyword “chargepost”
room *VARCHAR(50)Room Name1401 A
folio *VARCHAR(50)Folio NoGF1120
table *VARCHAR(50)Table Nochargepost
outlet *VARCHAR(50)It is should be an Outlet name.OT
charge *VARCHAR(150)“Restaurant Charge” should be come.Breakfast
postingdate *DATEIt is a charge posting date.2020-07-02
trandate *DATEA date of charge posting to PMS.2020-07-02
amount *DECIMAL(10,2)The charging amount of Posting. It must be tax exclusive amount.7.57
tax *DECIMAL(10,2)It should be Tax amount, if tax applicable. Can take multiple2.00
gross_amount *DECIMAL(10,2)The charging amount of Posting. It must be tax inclusive amount.5.57
voucherno *VARCHAR(50)It should be receipt no.POS234
remarkVARCHAR(200)It should be remarks from POS.Outlet : OT,POS User : Admin
posuser *VARCHAR(50)POS user who does Posting to PMS.Admin

Request 

<request>
<auth>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</auth>
<oprn>chargepost</oprn>
<room>101</room>
<folio>8</folio>
<table>chargepost</table>
<outlet>OT</outlet>
<charge>Breakfast</charge>
<postingdate>2020-05-15</postingdate>
<trandate>2020-05-15</trandate>  
<amount>100</amount>
<tax>2.00</tax>
<gross_amount>5.57</gross_amount>
<voucherno>POS895</voucherno>
<remark>Outlet : OT,POS User : Admin</remark>
<posuser>Admin</posuser>
</request>

Response

NameData TypeDescription Example
statusStringStatus value will be providedValues: ok, errorok
msgStringMessage result will be providedValues: success or error messagesuccess
hotelnameStringName of HotelHotel
hotelcodeIntegerID of Roomxxxx

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg>added in queue</msg>
    <requestid>2805</requestid>
</response>

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

ErrorsDescription
Hotel Code In-ActiveThe Property has been deactivated
API Authkey is deactivatedThe Authcode/Key has been deactivated
Invalid AuthenticationInvalid data
Bad RequestInvalid Request Parameter
Invalid API Request. Don’t have this API accessInvalid Request Method
You are not allowed to post charges to room. Reason: POS2PMS account is not setup at PMS end.
You are not allowed to post charges to room. Reason: Folio not found in PMS.
You are not allowed to post charges to the room. Reason: Credit Card details is not available on the booking.
You are not allowed to post charges to room. Reason: Credit limit set on folio says credit balance is less than posting amount.
You are not allowed to post charges to room. Reason: Credit limit set on folio says your credit limit for posting charges is over.
You are not allowed to post charges to room. Reason : Credit limit set on folio says your daily credit limit for posting charges is over.
Tax Mapping with PMS and POS are not in Sync

Configuration

Check Hotel Authentication

This API checks authentication and returns hotel information if authentication is valid. The API can return data in XML formats. The web service responds to HTTP POST requests.

End Point URL

Header

Content-Type: application/xml

Parameter

NameData TypeDescription Example
auth *VARCHAR(300)Unique Authentication codeXXXXXXXXXXXXXXXXX
oprn *VARCHAR(150)Use Keyword “gethotelinfo”

Request 

<?xml version="1.0" standalone="yes"?>
<request>
     <auth>xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</auth>
     <oprn>gethotelinfo</oprn>
</request>

Response

NameData TypeDescription Example
statusStringStatus value will be providedValues: ok, errorok
msgStringMessage result will be providedValues: success or error messagesuccess
hotelnameStringName of HotelHotel
hotelcodeIntegerID of Roomxxxx

Success

<?xml version='1.0' standalone='yes'?>
<response>
    <status>ok</status>
    <msg>success</msg>
    <hotelname>Mega Hills Hotel</hotelname>
    <hotelcode>xxxx</hotelcode>
</response> 

Error

<?xml version='1.0' standalone='yes'?>
<response>
    <status>error</status>
    <msg>Invalid Authentication</msg>
</response>

Error Codes

ErrorsDescription
Hotel Code In-ActiveThe Property has been deactivated
API Authkey is deactivatedThe Authcode/Key has been deactivated
Invalid AuthenticationInvalid data
Bad RequestInvalid Request Parameter
Invalid API Request. Don’t have this API accessInvalid Request Method

Click here to Register