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
Parameter
| Name | Data Type | Description | Example |
| auth * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| oprn * | VARCHAR(150) | Use Keyword “chargepost” | |
| room * | VARCHAR(50) | Room Name | 1401 A |
| folio * | VARCHAR(50) | Folio No | GF1120 |
| table * | VARCHAR(50) | Table No | chargepost |
| outlet * | VARCHAR(50) | It is should be an Outlet name. | OT |
| charge * | VARCHAR(150) | “Restaurant Charge” should be come. | Breakfast |
| postingdate * | DATE | It is a charge posting date. | 2020-07-02 |
| trandate * | DATE | A 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 multiple | 2.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 |
| remark | VARCHAR(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
| Name | Data Type | Description | Example |
| status | String | Status value will be providedValues: ok, error | ok |
| msg | String | Message result will be providedValues: success or error message | success |
| hotelname | String | Name of Hotel | Hotel |
| hotelcode | Integer | ID of Room | xxxx |
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
| Errors | Description |
| Hotel Code In-Active | The Property has been deactivated |
| API Authkey is deactivated | The Authcode/Key has been deactivated |
| Invalid Authentication | Invalid data |
| Bad Request | Invalid Request Parameter |
| Invalid API Request. Don’t have this API access | Invalid 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 | – |