Jitu
Bookings
Add Extra Charge
This API will post the extra charge to a particular single or multiple reservations. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
| Name | Data Type | Description | Example |
| HotelCode* | INT(11) | Unique Hotel code | xxxx |
| AuthCode* | VARCHAR(300) | Unique Authentication code | xxxxxxxxxx |
| Request_Type* | VARCHAR(100) | Request Type | AddExtraCharge |
| Reservation->BookingId* | VARCHAR(100) | Reservation No. | 11-1 or 12 |
| Reservation->FolioNo | INT(20) | Folio No. | 12 |
| Reservation->ChargeId* | INT(20) | Charge Unique Id (Click here to get ChargeId) https://api.ezeetechnosys.com/#592 | 123400000000000001 |
| Reservation->Amount* | DECIMAL(19,4) | Amount to pay | 100.00 |
| Reservation->Qty* | INT(20) | Quantity | 1 or 2 |
| Receipt->Comment | VARCHAR(100) | Comment is optional | Extra charge is added for room |
Note: To get the chargeunkid of specific extra charge, use this api
API : Retrieve Extras
Request
{
"RES_Request": {
"Request_Type": "AddExtraCharge",
"Authentication": {
"HotelCode": "1234",
"AuthCode": "xxxxxxxxxxxxxxxx"
},
"Reservation": [
{
"BookingId": "11-1",
"FolioNo": "", // Optional
"ChargeId": "123400000000000007",
"Amount": "70",
"Qty": "1",
"Comment": "extra charge is added"
},
{
"BookingId": "12",
"FolioNo": "302", // Optional
"ChargeId": "123400000000000007",
"Amount": "10",
"Qty": "5",
"Comment": "extra charge is added"
}
]
}
}
Response
Success
{
"Success": {
"SuccessMsg": "Extra charge is added successfully for booking 11-1"
},
"Errors": [
{
"ErrorCode": "0",
"ErrorMessage": "Success"
}
]
}
Success/Error:
{
"Success": {
"SuccessMsg": "Extra charge is added successfully for booking 11-1"
},
"Errors": [
{
"ErrorCode": "104",
"ErrorMessage": "Charge Id is missing for booking 12"
}
]
}
Error
{
"Errors": [
{
"ErrorCode": "104",
"ErrorMessage": "Charge Id is missing for booking 12"
}
]
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameters |
| 500 | Error occurred during processing. |
| 502 | Request Type is missing |
| 101 | Hotel Code is missing |
| 102 | Authentication Code is missing |
| 301 | Unauthorized Request. Please check hotel code and authentication code |
| 302 | Unauthorized Request. Integration is not allowed |
| 303 | Auth Code is inactive |
| 201 | Unauthorized request.(Request Type) request is not valid for this hotel code |
| 202 | Unauthorized request. Hotel code is not active |
| 103 | Booking ID is missing |
| 104 | Payment Id is missing for booking |
| 105 | Currency Id is missing for booking |
| 106 | Payment amount is missing or invalid payment amount for booking |
| 108 | Error in folio. |
| 109 | Maximum 10 bookings are allowed at a time. |
| 110 | Payment ID not valid |
| 114 | Currency is not valid for booking |
| 115 | Amount is exceeded than folio balance for booking |
| 116 | Invalid parameter for booking |
| 113 | We don’t find this reservation in our system. So payment not processed for booking |
| 117 | Reservation is void. So payment not processed for booking |
| 118 | Reservation is past checked out. So payment not processed for booking |
| 119 | Invalid folio no for booking |
Finance
Retrieve Inwards Folio wise Payments
This API provides inwards payments (receipts data) that can be used in your financial accounts. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| hotel_code* | INT(11) | Unique Hotel code | xxxx |
| auth_code* | VARCHAR(300) | Unique Authentication code | xxxxxxxxxx |
| foliounkid* | TEXT | Provide foliounkid with comma separated | 8000000000000026123,8000000000000026123 |
| requestfor* | VARCHAR(100) | Request Type | XERO_GET_RECEIPT_DATA_FOLIOUNKID |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"foliounkid" : "8000000000000026123,8000000000000026123",
"requestfor": "XERO_GET_RECEIPT_DATA_FOLIOUNKID"
}
Response
| Name | Data Type | Description | Example |
| status | String | Response status | Success |
| data->type | String | Response type | Advance Deposit, Received From Guest, Received From Cityledger |
| tranId | String | Transaction Id | R946-22 |
| tran_datetime | Date | Transaction Date [Format: yyyy-mm-dd] | 2020-03-22 |
| reference1 | Date | Receipt No (For only Advance Deposit data) | 52 |
| reference2 | Date | Guest Name / Cityledger Name | Eliza |
| reference3 | String | Reservation No (For only Advance Deposit, Received From Guest data) | 50 |
| reference4 | String | Reservation No (For only Advance Deposit, Received From Guest data) | 50 |
| reference5 | String | Folio No (For only Advance Deposit, Received From Guest data) | 54 |
| reference6 | String | Bill No / Inv. No | 45 |
| reference7 | String | Bill To (For only Advance Deposit, Received From Guest data | Eliza |
| reference8 | String | Arrival Date Time (For only Advance Deposit, Received From Guest data) | 2020-03-24 |
| reference9 | String | Departure Date Time (For only Advance Deposit, Received From Guest data) | 2020-03-28 |
| reference10 | String | Travel Agent/ Business Source (For only Advance Deposit, Received From Guest data) | Apex Travels |
| reference11 | String | Travel Agent Voucher No (For only Advance Deposit, Received From Guest data) | |
| reference13 | String | Room Name (For only Advance Deposit, Received From Guest data) | 108 |
| reference14 | String | Folio Type / Settlement Type (CASH/CREDIT) (For only Advance Deposit, Received From Guest data) | CASH |
| reference15 | String | ||
| reference16 | String | Not Applicable | |
| reference17 | String | Identity type of billing contact.If Billing contact is guest,Company tax ID of guest will be displayed and if Billing contact is company, it will be blank | Passport |
| reference18 | String | Identity number of billing contact.If Billing contact is a guest,the tax id of guest will be displayed and if Billing contact is company ,it will be blank | T9305602 |
| reference19 | String | Email of billing contact | test@gmail.com |
| reference20 | String | Address of billing contact | Near railway station, Surat – 396380, Gujarat, India |
| reference21 | String | Telephone of billing contact | 0261242059 |
| reference22 | String | Address of billing contact | Near railway station |
| reference23 | String | City name of billing contact | Surat |
| reference24 | String | State name of billing contact | Gujarat |
| reference25 | String | Zip code | 396380 |
| reference26 | String | Country of billing contact | India |
| reference27 | String | GSTIN Number | |
| reference28 | Integer | Contact Type Unique Id | VENDOR/TRAVELAGENT |
| reference29 | Integer | Folio Unique Id | 1234500000000000123 |
| detail->tran_type | String | Transaction Type (Credit/Debit) | Cr/Dr |
| detail->detailId | Integer | Detail Id | 1234500000000000946 |
| detail->reference_id | integer | 6 | |
| detail->reference_value | String | Transaction Mode | Advance,Payment, Paid Out |
| detail->sub_ref1_id | integer | 1 | |
| detail->sub_ref1_value | String | 1 | |
| detail->sub_ref2_id | integer | 2 | |
| detail->sub_ref2_value | String | City Ledger Contact Id, Payment Id Guest Name (For only Received From Guest in Credit transaction type data) | 1234500000000000155 |
| detail->sub_ref3_id | integer | 0 | |
| detail->sub_ref3_value | String | Business Source Id (For only Received From Guest in Credit transaction type data) | 0 |
| detail->sub_ref4_id | integer | 0 | |
| detail->sub_ref4_value | String | Room Id (For only Received From Guest in Credit transaction type data) | 0 |
| detail->sub_ref5_id | integer | 0 | |
| detail->sub_ref5_value | String | Room Type Id (For only Received From Guest in Credit transaction type data) | 0 |
| detail->sub_ref6_id | integer | 0 | |
| detail->sub_ref6_value | String | Folio No (For only Received From Guest in Credit transaction type data) | 0 |
| detail->sub_ref7_id | integer | 0 | |
| detail->sub_ref7_value | String | Bill To (For only Received From Guest in Credit transaction type data) | 0 |
| detail->sub_ref8_id | integer | 0 | |
| detail->sub_ref8_value | String | 0 | |
| detail->amount | Decimal | Transaction Amount | 200 |
| gross_amount | Decimal | Gross Amount | 200 |
| remark | String | Comment of transaction |
Success
{
"status": "Success",
"data": [
{
"type": "Advance Deposit",
"data": [
{
"tranId": "R946-22",
"tran_datetime": "2020-03-22",
"reference1": "52",
"reference2": "Eliza,
"reference3": "50",
"reference4": "50",
"reference5": "54",
"reference6": "45",
"reference7": "Eliza",
"reference8": "2020-03-24",
"reference9": "2020-03-28",
"reference10": "Apex Travels",
"reference11": "",
"reference13": "108",
"reference14": "Cash",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station,surat-396380,gujarat, india",
"reference21": "026142059",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000000946",
"reference_id": 6,
"reference_value": "Payment",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000155",
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": "25000.0000"
},
{
"tran_type": "Cr",
"detailId": "1234500000000000946",
"reference_id": 13,
"reference_value": "Advance",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 0,
"sub_ref2_value": 0,
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": "25000.0000"
}
],
"gross_amount": "25000.0000",
"remark": ""
}
]
},
{
"type": "Received From Guest",
"data": [
{
"tranId": "R355-21",
"tran_datetime": "2020-03-21",
"reference1": "39",
"reference2": "Loy",
"reference3": "42",
"reference4": "42",
"reference5": "45",
"reference6": "20",
"reference7": "Loy",
"reference8": "2020-03-19",
"reference9": "2020-03-21",
"reference10": "Apex Travels",
"reference11": "",
"reference13": "113",
"reference14": "Cash",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station, surat-396380,gujarat,india",
"reference21": "026142059",
"reference22": "Near railway station",
"reference23": "Surat",
"reference24": "Gujarat",
"reference25": "396380",
"reference26": "India",
"reference27": "",
"reference28": "VENDOR/TRAVELAGENT",
"reference29": "1234500000000000123",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000000355",
"reference_id": 6,
"reference_value": "Payment",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000155",
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": 8310
},
{
"tran_type": "Cr",
"detailId": "1234500000000000355",
"reference_id": 8,
"reference_value": "Guest Ledger",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "Loy",
"sub_ref3_id": 3,
"sub_ref3_value": "1234500000000000010",
"sub_ref4_id": 4,
"sub_ref4_value": "1234500000000000013",
"sub_ref5_id": 5,
"sub_ref5_value": "1234500000000000002",
"sub_ref6_id": 6,
"sub_ref6_value": "45",
"sub_ref7_id": 7,
"sub_ref7_value": "Loy",
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": 8310
}
],
"gross_amount": 8310,
"remark": ""
}
]
},
{
"type": "Received From Cityledger",
"data": [
{
"tranId": "R363-21",
"tran_datetime": "2020-03-21",
"reference1": "42",
"reference2": "Apex Travels",
"reference3": "",
"reference4": "",
"reference5": "",
"reference6": "",
"reference7": "",
"reference8": "",
"reference9": "",
"reference10": "",
"reference11": "",
"reference13": "",
"reference14": "",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station,surat-396380,gujarat,india",
"reference21": "0261242059",
"reference22": "Near railway station",
"reference23": "Surat",
"reference24": "Gujarat",
"reference25": "396380",
"reference26": "India",
"reference27": "",
"reference28": "VENDOR/TRAVELAGENT",
"reference29": "1234500000000000123",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000000363",
"reference_id": 6,
"reference_value": "Payment",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000155",
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": 200
},
{
"tran_type": "Cr",
"detailId": "1234500000000000363",
"reference_id": 10,
"reference_value": "Cityledger",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000020",
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": 200
}
],
"gross_amount": 200,
"remark": ""
}
]
}
]
}
Error Codes
| Code | Message |
| AllFields | All fields are mandatory. |
| AuthKey | Authentication Key Is Not Found. |
| ReqFor | Invalid Request Format. |
| HotelCode | Hotel Code Is Not Found |
| Error | Something went wrong! |
| Error | Bad Request |
| 304 | Database Error |
| 202 | Unauthorized request. Hotel code is not active |
| 301 | Unauthorized request. Request is not valid for this hotel code [Permission denied] |
| 303 | Auth Code is inactive. |
Finance
Retrieve Outwards Folio wise Payments
This API provides outwards payments that can be used in your financial accounts. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| hotel_code* | INT(11) | Unique Hotel code | xxxx |
| auth_code* | VARCHAR(300) | Unique Authentication code | xxxxxxxxxx |
| foliounkid* | TEXT | Provide foliounkid with comma separated | 8000000000000026198,8000000000000026199 |
| requestfor* | VARCHAR(100) | Request Type | XERO_GET_PAYMENT_DATA_FOLIOUNKID |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"foliounkid" : "8000000000000026198,8000000000000026199",
"requestfor": "XERO_GET_PAYMENT_DATA_FOLIOUNKID"
}
Response
| Name | Data Type | Description | Example |
| status | String | Response status | Success |
| data->type | String | Response type | General Expense, Advance Deposit Refund, Guest Refund, Cityledger Refund |
| tranId | String | Transaction Id | P950-221 |
| tran_datetime | Date | Transaction Date [Format: yyyy-mm-dd] | 2020-03-22 |
| reference1 | String | Bill No / Inv. No (For only General Expenses data) Receipt No (For only Advance Deposit Refund, Guest Refund, Cityledger Refund data) | 12 |
| reference2 | String | Guest Name (For only General Expense,Advance Deposit Refund, Guest Refund data) | Johnson |
| reference3 | String | Reservation No (For only Advance Deposit Refund, Guest Refund data) | |
| reference4 | String | Reservation No (For only Advance Deposit Refund, Guest Refund data) | |
| reference5 | String | Folio No (For only Advance Deposit Refund, Guest Refund data) | |
| reference6 | String | Bill No / Invoice No | 12 |
| reference7 | String | Bill To (For only General Expense,Advance Deposit Refund, Guest Refund data) | Johnson |
| reference8 | String | Arrival Date Time (For only Advance Deposit Refund, Guest Refund data) | |
| reference9 | String | Departure Date Time (For only Advance Deposit Refund, Guest Refund data) | |
| reference10 | String | Business Source Id (For only Advance Deposit Refund, Guest Refund data) | |
| reference11 | String | TravelAgent Voucher No (For only Advance Deposit Refund, Guest Refund data) | |
| reference12 | String | Market Code Id ( For only Advance Deposit Refund, Guest Refund data) | |
| reference13 | String | Room Name (For only Advance Deposit Refund, Guest Refund data) | |
| reference14 | String | Folio Type / Settlement Type | CASH |
| reference15 | String | ||
| reference16 | String | Not Applicable | |
| reference17 | String | Identity type of billing contact. If Billing contact is guest,Company Tax ID of guest will be displayed and if Billing contact is company,it will be blank | Passport |
| reference18 | String | Identity number of billing contact. If Billing contact is a guest, the tax id of guest will be displayed and if Billing contact is company , it will be blank | T9305602 |
| reference19 | String | Email of billing contact | test@gmail.com |
| reference20 | String | Address of billing contact | Near railway station surat 396380 gujarat india |
| reference21 | String | Telephone of billing contact | 0261242059 |
| reference22 | String | Address of billing contact | Near railway station |
| reference23 | String | City name of billing contact | surat |
| reference24 | String | State name of billing contact | gujarat |
| reference25 | String | Zip code of billing contact | 396380 |
| reference26 | String | Country name of billing contact | india |
| reference27 | String | GSTIN number of billing contact | |
| reference28 | String | Contact Type Unique Id | VENDOR/TRAVELAGENT |
| reference29 | String | Folio Unique Id | 8000000000000026198 |
| detail->tran_type | String | Transaction Type (Credit/Debit) | Cr/Dr |
| detail->detailId | Integer | Detail Id | 1234500000000000951 |
| detail->reference_id | integer | Reference Id | 6 |
| detail->reference_value | String | Transaction Mode | Advance,Payment, Paid Out |
| detail->sub_reference1_id | integer | Single Ledger Id | 1 |
| detail->sub_reference1_value | String | Single Ledger Value | 1 |
| detail->sub_reference2_id | integer | 2 | |
| detail->sub_reference2_value | String | Expense Type Id, Tax Id (For Only General Expensel ) City Ledger Id, Payment Id (All API) Guest Name (For Only Guest Refund in debit transaction type) | 1234500000000000155 |
| detail->sub_reference3_id | integer | 3 | |
| detail->sub_reference3_value | String | Business Source Id (For Only Guest Refund in debit transaction type) | 0 |
| detail->sub_reference4_id | integer | 4 | |
| detail->sub_reference4_value | String | Room Id (For Only Guest Refund in debit transaction type) | 0 |
| detail->sub_reference5_id | integer | 5 | |
| detail->sub_reference5_value | String | Rate Type Id (For Only Guest Refund in debit transaction type) | 0 |
| detail->sub_reference6_id | integer | 6 | |
| detail->sub_reference6_value | String | Folio No (For Only Guest Refund in debit transaction type) | 0 |
| detail->sub_reference7_id | integer | 7 | |
| detail->sub_reference7_value | String | Bill To (For Only Guest Refund in debit transaction type) | 0 |
| detail->sub_reference8_id | integer | 8 | |
| detail->sub_reference8_value | String | 0 | |
| detail->amount | Decimal | Transaction Amount | 1900.0000 |
| detail->slabtaxunkid | String | IF General Expense type found then add Slab Tax id | 1234500000000000013_1 |
| detail->slabtax | String | IF General Expense type found then add Slab tax name | CGST |
| detail->slab | String | IF General Expense type found then add Slab range | 1000-2499-12 |
| gross_amount | Decimal | Gross Amount | 0 |
| amount_paid | Decimal | Amount Paid (For Only General Expense) | 2242 |
| balance | Decimal | Account Balance (For Only General Expense) | 0 |
| remark | String | Comment of transaction |
Success
{
"status": "Success",
"data": [
{
"type": "General Expense",
"data": [
{
"tranId": "P950-221",
"tran_datetime": "2020-03-22",
"reference1": "12",
"reference2": "Johnson",
"reference3": "",
"reference4": "",
"reference5": "",
"reference6": "12",
"reference7": "Johnson",
"reference8": "",
"reference9": "",
"reference10": "",
"reference11": "",
"reference12": "",
"reference13": "",
"reference14": "CASH",
"reference15": "",
"reference16": "",
"reference17": "Passport",
"reference18": "T9305602",
"reference19": "test@gmail.com",
"reference20": "Near railway station surat 396380 gujarat india",
"reference21": "0261242059",
"reference22": "Near railway station surat",
"reference23": "",
"reference24": "",
"reference25": "",
"reference26": "",
"reference27": null,
"reference28": "",
"reference29": "8000000000000026198",
"detail": [
{
"tran_type": "Cr",
"detailId": "1234500000000000951",
"reference_id": 6,
"reference_value": "Payment",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000155",
"sub_reference3_id": 0,
"sub_reference3_value": 0,
"sub_reference4_id": 0,
"sub_reference4_value": 0,
"sub_reference5_id": 0,
"sub_reference5_value": 0,
"sub_reference6_id": 0,
"sub_reference6_value": 0,
"sub_reference7_id": 0,
"sub_reference7_value": 0,
"sub_reference8_id": 0,
"sub_reference8_value": 0,
"amount": 1500,
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
},
{
"tran_type": "Dr",
"detailId": "1234500000000000950",
"reference_id": 16,
"reference_value": "Paid Out",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000002",
"sub_reference3_id": 0,
"sub_reference3_value": 0,
"sub_reference4_id": 0,
"sub_reference4_value": 0,
"sub_reference5_id": 0,
"sub_reference5_value": 0,
"sub_reference6_id": 0,
"sub_reference6_value": 0,
"sub_reference7_id": 0,
"sub_reference7_value": 0,
"sub_reference8_id": 0,
"sub_reference8_value": 0,
"amount": "1500.0000",
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
}
],
"gross_amount": 1500,
"amount_paid": 1500,
"balance": 0,
"remark": ""
}
]
},
{
"type": "Advance Deposit Refund",
"data": [
{
"tranId": "P949-221",
"tran_datetime": "2020-03-22 00:00:00",
"reference1": "53",
"reference2": "Eliya",
"reference3": "50",
"reference4": "50",
"reference5": "54",
"reference6": "45",
"reference7": "Mrs. Eliya",
"reference8": "2020-03-24",
"reference9": "2020-03-28",
"reference10": "Mark Tour and Travels",
"reference11": "",
"reference12": "",
"reference13": "108",
"reference14": "",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station surat 396380 gujarat india",
"reference21": "0261242059",
"reference22": "Near railway station surat",
"reference23": "",
"reference24": "",
"reference25": "",
"reference26": "",
"reference27": null,
"reference28": "",
"reference29": "8000000000000026198",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000000948",
"reference_id": 13,
"reference_value": "Advance",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 0,
"sub_reference2_value": 0,
"sub_reference3_id": 0,
"sub_reference3_value": 0,
"sub_reference4_id": 0,
"sub_reference4_value": 0,
"sub_reference5_id": 0,
"sub_reference5_value": 0,
"sub_reference6_id": 0,
"sub_reference6_value": 0,
"sub_reference7_id": 0,
"sub_reference7_value": 0,
"sub_reference8_id": 0,
"sub_reference8_value": 0,
"amount": 2640
},
{
"tran_type": "Cr",
"detailId": "1234500000000000948",
"reference_id": 6,
"reference_value": "Payment",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000155",
"sub_reference3_id": 0,
"sub_reference3_value": 0,
"sub_reference4_id": 0,
"sub_reference4_value": 0,
"sub_reference5_id": 0,
"sub_reference5_value": 0,
"sub_reference6_id": 0,
"sub_reference6_value": 0,
"sub_reference7_id": 0,
"sub_reference7_value": 0,
"sub_reference8_id": 0,
"sub_reference8_value": 0,
"amount": 2640
}
],
"gross_amount": 2640,
"remark": ""
}
]
},
{
"type": "Guest Refund",
"data": [
{
"tranId": "3",
"tran_datetime": "2020-06-06 12:10:00",
"reference1": "VOC-003",
"reference2": "Guest/Person Name",
"reference3": "BKN-13",
"reference4": "RN-13",
"reference5": "FN-13",
"reference6": "BL-13",
"reference7": "Bill to Name",
"reference8": "2020-06-06",
"reference9": "2020-06-07",
"reference10": "Business Source Name",
"reference11": "OTA Booking Voucher number",
"reference12": "Market Name",
"reference13": "103",
"reference14": "Cash",
"reference15": "Credit Number",
"reference16": "",
"reference17": "Passport",
"reference18": "T9305602",
"reference19": "test@gmail.com",
"reference20": "Near railway station,surat-396380,gujarat,india",
"reference21": "0261242059",
"reference22": "Near railway station surat",
"reference23": "",
"reference24": "",
"reference25": "",
"reference26": "",
"reference27": null,
"reference28": "",
"reference29": "8000000000000026198",
"detail": [
{
"tran_type": "Dr",
"detailId": "3-1",
"reference_id": "8",
"reference_value": "Guest Ledger",
"sub_reference1_id": "1",
"sub_reference1_value": "1",
"sub_reference2_id": "2",
"sub_reference2_value": "Guest Name",
"sub_reference3_id": "3",
"sub_reference3_value": "buss01",
"sub_reference4_id": "4",
"sub_reference4_value": "1234500000000000150",
"sub_reference5_id": "5",
"sub_reference5_value": "1234500000000000006",
"sub_reference6_id": "6",
"sub_reference6_value": "fn-001",
"sub_reference7_id": "7",
"sub_reference7_value": "Bill to Name",
"sub_reference8_id": "0",
"sub_reference8_value": "0",
"amount": "1780.000"
},
{
"tran_type": "Cr",
"detailId": "3-1",
"reference_id": "6",
"reference_value": "Payment",
"sub_reference1_id": "1",
"sub_reference1_value": "1",
"sub_reference2_id": "2",
"sub_reference2_value": "1234500000000000156",
"sub_reference3_id": "0",
"sub_reference3_value": "0",
"sub_reference4_id": "0",
"sub_reference4_value": "0",
"sub_reference5_id": "0",
"sub_reference5_value": "0",
"sub_reference6_id": "0",
"sub_reference6_value": "0",
"sub_reference7_id": "0",
"sub_reference7_value": "0",
"sub_reference8_id": "0",
"sub_reference8_value": "0",
"amount": "1780.000"
}
],
"gross_amount": "1780.0000",
"remark": ""
}
]
},
{
"type": "Cityledger Refund",
"data": [
{
"tranId": "4",
"tran_datetime": "2020-06-06 12:10:00",
"reference1": "VOC-004",
"reference2": "",
"reference3": "",
"reference4": "",
"reference5": "",
"reference6": "",
"reference7": "",
"reference8": "",
"reference9": "",
"reference10": "",
"reference11": "",
"reference12": "",
"reference13": "",
"reference14": "",
"reference15": "",
"reference16": "",
"reference17": "",
"reference18": "",
"reference19": "",
"reference20": "",
"reference21": "",
"reference22": "Near railway station surat",
"reference23": "",
"reference24": "",
"reference25": "",
"reference26": "",
"reference27": null,
"reference28": "",
"reference29": "8000000000000026198",
"detail": [
{
"tran_type": "Dr",
"detailId": "4-1",
"reference_id": "10",
"reference_value": "City Ledger",
"sub_reference1_id": "1",
"sub_reference1_value": "1",
"sub_reference2_id": "2",
"sub_reference2_value": "1234500000000000156",
"sub_reference3_id": "0",
"sub_reference3_value": "0",
"sub_reference4_id": "0",
"sub_reference4_value": "0",
"sub_reference5_id": "0",
"sub_reference5_value": "0",
"sub_reference6_id": "0",
"sub_reference6_value": "0",
"sub_reference7_id": "0",
"sub_reference7_value": "0",
"sub_reference8_id": "0",
"sub_reference8_value": "0",
"amount": "2801.000"
},
{
"tran_type": "Cr",
"detailId": "4-1",
"reference_id": "6",
"reference_value": "Payment",
"sub_reference1_id": "1",
"sub_reference1_value": "1",
"sub_reference2_id": "2",
"sub_reference2_value": "1234500000000000158",
"sub_reference3_id": "0",
"sub_reference3_value": "0",
"sub_reference4_id": "0",
"sub_reference4_value": "0",
"sub_reference5_id": "0",
"sub_reference5_value": "0",
"sub_reference6_id": "0",
"sub_reference6_value": "0",
"sub_reference7_id": "0",
"sub_reference7_value": "0",
"sub_reference8_id": "0",
"sub_reference8_value": "0",
"amount": "2801.000"
}
],
"gross_amount": "2801.0000",
"remark": ""
}
]
}
]
}
Error Codes
| Code | Message |
| AllFields | All fields are mandatory. |
| AuthKey | Authentication Key Is Not Found. |
| ReqFor | Invalid Request Format. |
| HotelCode | Hotel Code Is Not Found |
| Error | Something went wrong! |
| Error | Bad Request |
| 304 | Database Error |
| 202 | Unauthorized request. Hotel code is not active |
| 301 | Unauthorized request. Request is not valid for this hotel code [Permission denied] |
| 303 | Auth Code is inactive. |
F & B
Purchases [F&B]
This API provides detailed information about all the financial heads mapped in the Food and Beverage (FnB) domain. It supports various combinations of financial data types, allowing for the relevant combination based on specific requirements.
End Point URL
https://api.ipos247.com/v1/fas/get_purchase_dataHeader
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}Parameter
| Name | Data Type | Description |
|---|---|---|
| hotel_code* | String | The unique code identifying the hotel for which financial data is requested. |
| fromdate* | Date | The starting date of the financial data retrieval period (in YYYY-MM-DD format). |
| todate* | Date | The ending date of the financial data retrieval period (in YYYY-MM-DD format). |
| outlet | Integer | The unique identifier for the outlet store |
Request
{
"hotel_code": "XXXX",
"fromdate": "2024-05-28",
"todate": "2024-06-27",
"outlet" : "1000000000000001"
}
Response
| Field Name | Data Type | Description |
|---|---|---|
| status | String | Indicates the success or failure of the API response. |
| statusCode | Integer | HTTP status code for the API response. |
| data | Array | Contains the main records of financial transactions. Each entry represents a transaction. |
Information about data array
| Field Name | Data Type | Description |
|---|---|---|
| record_id | String | Unique identifier for the financial record. |
| record_date | Date | The date of the financial transaction (in YYYY-MM-DD format). |
| reference1 | String | Primary reference ID for the transaction. |
| reference2 | String | Secondary reference ID for the transaction. Can be null. |
| reference3 | String | Name of the store or location. Can be blank. |
| reference4 to reference22 | String | Additional references. Data may be null or blank depending on the record. |
| gross_amount | Decimal | Total gross amount of the transaction. |
| flat_discount | Decimal | Any flat discount applied to the transaction. Can be blank. |
| total_tax | Decimal | Total tax applied to the transaction. Will be provided even if 0. |
| total_amount | Decimal | Total amount after adding taxes and discounts. |
| amount_paid | Decimal | Amount paid for the transaction. Can be blank. |
| amount_posted | Decimal | Amount posted for the transaction. Can be null or blank. |
| balance | Decimal | Remaining balance for the transaction. Will be provided even if 0. |
| narration | String | Additional narration or comments for the transaction. Can be blank. |
| details | Array | Detailed breakdown of the transaction, including items and taxes. Empty or null data fields will be provided for individual details if applicable. |
Information about details array
| Field Name | Data Type | Description |
|---|---|---|
| detail_record_id | String | Unique identifier for the detail record. |
| parent_record_id | String | Parent record ID, applicable for related records. Can be null. |
| reference_id | Integer | ID representing the reference type (e.g., POS Sales, Taxes). |
| reference_name | String | Name of the reference, such as transaction type. |
| tran_type | String | Transaction type (e.g., Credit, Debit). |
| charge_name | String | Name of the charge or item in the transaction. |
| amount | Decimal | Amount related to the detail record. |
| remark | String | Additional remarks for the detail record. Can be blank or null. |
| taxper | Decimal | Tax percentage for the item or charge. Can be null or blank. |
| sub_ref1_value to sub_ref8_value | Various | Sub-references for the detailed record. These values may vary and can be null. |
Success
{
"status": "success",
"statusCode": 200,
"data": [
{
"record_id": "1000000000014622",
"record_date": "2024-06-20",
"reference1": "GRN-25",
"reference2": "1021",
"reference3": "1000000000000001",
"reference4": "Store Name",
"reference5": "Account 1",
"reference6": "",
"reference7": "",
"reference8": "",
"reference9": "",
"reference10": "",
"reference11": "",
"reference12": "",
"reference13": "",
"reference14": "",
"reference15": "Goods Received Note",
"gross_amount": "3591.7150",
"flat_discount": "0.0000",
"total_tax": "1.2656",
"add_less_amount": "0.0000",
"total_amount": "3592.9806",
"remark": "",
"narration": "",
"details": [
{
"detail_reference_id": "1000000000116025",
"tran_type": "Dr",
"reference_id": 17,
"reference_name": "Purchase",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1000000000000001",
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 4,
"sub_ref4_value": "1000000000000030",
"sub_ref5_id": 5,
"sub_ref5_value": 0,
"amount": "5.7150",
"item_code": "",
"charge_name": "Item 1",
"hsn_code": "",
"rate_per_unit": "5.7150",
"qty": "1.0000",
"unit_unkid": "1000000000000015"
},
{
"detail_reference_id": "1000000000116026",
"tran_type": "Dr",
"reference_id": 17,
"reference_name": "Purchase",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1000000000000001",
"sub_ref3_id": 0,
"sub_ref3_value": 0,
"sub_ref4_id": 4,
"sub_ref4_value": "1000000000000018",
"sub_ref5_id": 5,
"sub_ref5_value": 0,
"amount": "1500.0000",
"item_code": "",
"charge_name": "Item 2",
"hsn_code": "",
"rate_per_unit": "1500.0000",
"qty": "1.0000",
"unit_unkid": "1000000000000013"
}
]
}
]
}Error
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}F & B
Sales [F&B]
This API provides detailed information about all the financial heads mapped in the Food and Beverage (FnB) domain. It supports various combinations of financial data types, allowing for the relevant combination based on specific requirements.
End Point URL
https://api.ipos247.com/v1/fas/get_sales_dataHeader
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}Parameter
| Name | Data Type | Description |
|---|---|---|
| hotel_code* | String | The unique code identifying the hotel for which financial data is requested. |
| fromdate* | Date | The starting date of the financial data retrieval period (in YYYY-MM-DD format). |
| todate* | Date | The ending date of the financial data retrieval period (in YYYY-MM-DD format). |
| exclude_roomposting | Integer | Flag to exclude room posting details from the data [0 = Include (default), 1 = Exclude]. |
| exclude_nocharge | Integer | Flag to exclude no-charge details from the data [0 = Include (default), 1 = Exclude]. |
Request
{
"hotel_code": "XXXX",
"fromdate": "2024-05-16",
"todate": "2024-05-16",
"exclude_roomposting": "0",
"exclude_nocharge": "0"
}Response
| Field Name | Data Type | Description |
|---|---|---|
| status | String | Indicates the success or failure of the API response. |
| statusCode | Integer | HTTP status code for the API response. |
| data | Array | Contains the main records of financial transactions. Each entry represents a transaction. |
Information about data array
| Field Name | Data Type | Description |
|---|---|---|
| record_id | String | Unique identifier for the financial record. |
| record_date | Date | The date of the financial transaction (in YYYY-MM-DD format). |
| reference1 | String | Primary reference ID for the transaction. |
| reference2 | String | Secondary reference ID for the transaction. Can be null. |
| reference3 | String | Name of the store or location. Can be blank. |
| reference4 to reference22 | String | Additional references. Data may be null or blank depending on the record. |
| gross_amount | Decimal | Total gross amount of the transaction. |
| flat_discount | Decimal | Any flat discount applied to the transaction. Can be blank. |
| total_tax | Decimal | Total tax applied to the transaction. Will be provided even if 0. |
| total_amount | Decimal | Total amount after adding taxes and discounts. |
| amount_paid | Decimal | Amount paid for the transaction. Can be blank. |
| amount_posted | Decimal | Amount posted for the transaction. Can be null or blank. |
| balance | Decimal | Remaining balance for the transaction. Will be provided even if 0. |
| narration | String | Additional narration or comments for the transaction. Can be blank. |
| details | Array | Detailed breakdown of the transaction, including items and taxes. Empty or null data fields will be provided for individual details if applicable. |
Information about details array
| Field Name | Data Type | Description |
|---|---|---|
| detail_record_id | String | Unique identifier for the detail record. |
| parent_record_id | String | Parent record ID, applicable for related records. Can be null. |
| reference_id | Integer | ID representing the reference type (e.g., POS Sales, Taxes). |
| reference_name | String | Name of the reference, such as transaction type. |
| tran_type | String | Transaction type (e.g., Credit, Debit). |
| charge_name | String | Name of the charge or item in the transaction. |
| amount | Decimal | Amount related to the detail record. |
| remark | String | Additional remarks for the detail record. Can be blank or null. |
| taxper | Decimal | Tax percentage for the item or charge. Can be null or blank. |
| sub_ref1_value to sub_ref8_value | Various | Sub-references for the detailed record. These values may vary and can be null. |
Success
{
"status": "success",
"statusCode": 200,
"data": [
{
"record_id": "1000000000013299",
"record_date": "2024-05-16",
"reference1": "REC-4041",
"reference2": "1000000000000014",
"reference3": "McDonald's- vesu",
"reference4": null,
"reference5": null,
"reference6": "1715852000",
"reference7": "",
"reference8": "",
"reference9": "0",
"reference10": "0",
"reference11": "",
"reference12": "",
"reference13": "",
"reference14": "",
"reference15": "",
"reference16": "",
"reference17": "",
"reference18": "john",
"reference19": "",
"reference20": "",
"reference21": "Take Away",
"reference22": "",
"gross_amount": "200.0000",
"flat_discount": "0.0000",
"total_tax": "10.0000",
"add_less_amount": "0.0000",
"total_amount": "210.0000",
"amount_paid": "0.0000",
"amount_posted": "0.0000",
"balance": "210.0000",
"narration": "",
"details": [
{
"detail_record_id": "1000000000109878",
"reference_id": 1,
"reference_name": "POS Sales",
"tran_type": "Cr",
"item_code": "",
"charge_name": "Test2",
"hsn_code": "",
"quantity": "1.000000000000",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": 0,
"sub_ref3_id": 3,
"sub_ref3_value": 0,
"sub_ref4_id": 4,
"sub_ref4_value": "1000000000000001",
"sub_ref5_id": 5,
"sub_ref5_value": 0,
"sub_ref6_id": 6,
"sub_ref6_value": "1000000000000001 + ",
"sub_ref7_id": 7,
"sub_ref7_value": "1000000000000605",
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": "100.0000",
"remark": ""
},
{
"detail_record_id": "1000000000109879",
"parent_record_id": "1000000000109878",
"reference_id": 3,
"reference_name": "Taxes",
"tran_type": "Cr",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1000000000000002",
"sub_ref3_id": 3,
"sub_ref3_value": "2.5000",
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": "2.5000",
"taxper": "2.5000",
"remark": ""
},
{
"detail_record_id": "1000000000109880",
"parent_record_id": "1000000000109878",
"reference_id": 3,
"reference_name": "Taxes",
"tran_type": "Cr",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1000000000000001",
"sub_ref3_id": 3,
"sub_ref3_value": "2.5000",
"sub_ref4_id": 0,
"sub_ref4_value": 0,
"sub_ref5_id": 0,
"sub_ref5_value": 0,
"sub_ref6_id": 0,
"sub_ref6_value": 0,
"sub_ref7_id": 0,
"sub_ref7_value": 0,
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": "2.5000",
"taxper": "2.5000",
"remark": ""
}
]
}
]
}Error
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}F & B
Financial Accounts [F&B]
This API provides detailed information about all the financial heads mapped in the Food and Beverage (FnB) domain. It supports various combinations of financial data types, allowing for the relevant combination based on specific requirements.
End Point URL
https://api.ipos247.com/v1/fas/get_config_dataHeader
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}Parameter
| Name | Data Type | Description |
|---|---|---|
| hotel_code* | INT | The unique identifier for the hotel. This is essential for retrieving relevant data. |
Request
{
"hotel_code": "your_hotel_code", // Required
}Response
| Name | Data Type | Description |
|---|---|---|
| status | String | Indicates the status of the response. |
| statusCode | Integer | HTTP status code for the response. |
| data | Array | List of details related to financial accounts. |
| headerid | String | Unique identifier for the header. |
| header | String | Name of the financial account header. |
| descriptiontypeunkid | String | Unique identifier for the description type. |
| descriptiontype | String | Type of the description for the financial account. |
| descriptionunkid | String | Unique identifier for the specific description. |
| description | String | Detailed description related to the financial account and type. |
Reference Data
| Header ID | Header | Description Type Unk ID | Description Type |
|---|---|---|---|
| 1 | POS REVENUE | 1 | Single Ledger |
| 1 | POS REVENUE | 2 | Menu Group |
| 1 | POS REVENUE | 3 | Menu Subgroup |
| 1 | POS REVENUE | 4 | Menu Item Category |
| 1 | POS REVENUE | 6 | Session and Category Wise |
| 2 | EXTRA CHARGE | 1 | Single Ledger |
| 2 | EXTRA CHARGE | 2 | Extra Charge |
| 3 | TAX | 1 | Single Ledger |
| 3 | TAX | 2 | Tax |
| 4 | TIPS | 1 | Single Ledger |
| 5 | ADJUSTMENT | 1 | Single Ledger |
| 6 | DISCOUNT | 1 | Single Ledger |
| 6 | DISCOUNT | 2 | Discount |
| 7 | ROOM POSTING | 1 | Single Ledger |
| 7 | ROOM POSTING | 2 | Room Posting |
| 8 | PAYMENT | 1 | Single Ledger |
| 8 | PAYMENT | 2 | Payment Type |
| 9 | CITY LEDGER | 1 | Single Ledger |
| 9 | CITY LEDGER | 2 | City Ledger |
| 17 | PURCHASE | 1 | Single Ledger |
| 17 | PURCHASE | 2 | Store Item Category |
| 17 | PURCHASE | 4 | Store Item |
| 18 | STORE TAX | 1 | Single Ledger |
| 18 | STORE TAX | 2 | Store Tax |
| 19 | VENDOR | 1 | Single Ledger |
| 19 | VENDOR | 2 | Vendor |
| 20 | VENDOR – ACCOUNT | 1 | Single Ledger |
| 20 | VENDOR – ACCOUNT | 2 | Vendor – Account |
| 21 | ADJUSTMENT | 1 | Single Ledger |
| 22 | ADD/LESS | 1 | Single Ledger |
| 23 | DISCOUNT | 1 | Single Ledger |
| 31 | VENDOR PAYMENT | 1 | Single Ledger |
| 31 | VENDOR PAYMENT | 2 | Vendor Payment Type |
| 32 | EXTRA CHARGE | 1 | Single Ledger |
| 32 | EXTRA CHARGE | 2 | Extra Charge |
Success
{
"status": "success",
"statusCode": 200,
"data": [
{
"headerid": "1",
"header": "POS REVENUE",
"descriptiontypeunkid": "1",
"descriptiontype": "Single Ledger",
"descriptionunkid": "1",
"description": "Revenue"
},
{
"headerid": "1",
"header": "POS REVENUE",
"descriptiontypeunkid": "2",
"descriptiontype": "Menu Group",
"descriptionunkid": "1081060000000001",
"description": "7Seven-Menu"
}
]
}Error
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}F & B
Outlet and Store Information [F&B]
This API retrieves the list of available outlet stores, along with their unique identifiers and names.
End Point URL
https://api.ipos247.com/v1/fas/get_store_nameHeader
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}Parameter
| Name | Data Type | Description |
|---|---|---|
| hotel_code* | String | The unique code identifying the hotel for which financial data is requested. |
Request
{
"hotel_code": "XXXX",
}Response
| Field Name | Data Type | Description |
|---|---|---|
| status | String | Indicates the success or failure of the API response. |
| statusCode | Integer | HTTP status code for the API response. |
| data | Array | Contains the main records of financial transactions. Each entry represents a transaction. |
| id | String | Unique identifier for the outlet store. |
| name | String | Name of the outlet store. |
Success
{
"status": "success",
"statusCode": 200,
"data": [
{
"id": "1000000000000001",
"name": "MainOutlet"
},
{
"id": "1000000000000002",
"name": "Store Factory"
}
]
}
Error
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}F & B
Orders
This API endpoint retrieves order information from a specific hotel or outlet in the Optimus system.
End Point URL
https://api.ipos247.com/v1/service/ordersHeader
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}Parameter
| Name | Data Type | Description |
|---|---|---|
| hotel_code* | INT | The unique identifier for the hotel. This is essential for retrieving relevant data. |
| form_date* | Date | Specifies the starting date for the query. The date format should be in YYYY-MM-DD |
| to_date | Date | Specifies the ending date for the query. If omitted, the system will consider the form_date as the only date for data retrieval. The date format should also be YYYY-MM-DD. |
| outlet_name | String | The name of the specific outlet within the hotel. If not provided, the query will retrieve data from all outlets. |
Request
{
"hotel_code": "your_hotel_code", // Required
"form_date": "2024-08-22", // Required (format: YYYY-MM-DD)
"to_date": "2024-08-22", // Optional (format: YYYY-MM-DD)
"outlet_name": "MainOutlet" // Optional
}Response
| Name | Data Type | Description |
|---|---|---|
| status | String | Status of the request, indicating whether it was successful. |
| statusCode | Integer | HTTP status code indicating the result of the request. |
| data | Array | An array of order objects, each containing detailed information about individual orders. |
| outletName | String | The name of the outlet where the order was placed. |
| orderNumber | String | A unique identifier for the order. |
| receiptNumber | String | The receipt number associated with the order. |
| orderType | String | Type of order (e.g., Dine In, Takeaway, Delivery). |
| orderDateTime | Date Time | Date and time when the order was placed. |
| businessSource | String | Source of the business (may be empty or provided depending on configuration). |
| guestName | String | Name of the guest, if available. |
| guestCount | Integer | Number of guests associated with the order. |
| employeeName | String | Name of the employee who handled the order. |
| sessionName | String | Name of the session in which the order was placed (can be empty). |
| totalItemsAmount | Float | Total amount for the items ordered, before discounts, taxes, and surcharges. |
| totalDiscountAmount | Float | Total discount applied to the order. |
| totalTaxAmount | Float | Total tax applied to the order. |
| totalTipsAmount | Float | Total amount of tips added to the order. |
| totalSurchargesAmount | Float | Total surcharges applied to the order. |
| totalRoundOffAmount | Float | Any rounding-off adjustments made to the total amount. |
| totalPaymentAmount | Float | Total amount paid for the order. |
| netSalesAmount | Float | The net sales amount after applying discounts but before taxes and other charges. |
| grossSalesAmount | Float | The gross sales amount before any discounts or adjustments. |
| remark | String | Any additional remarks related to the order. |
| orderPayments | Array | An array of payment objects detailing how the order was paid. |
| orderPayments.amount | Float | The amount paid using a specific payment method. |
| orderPayments.type | String | The payment type (e.g., Bank, Cash, Credit Card). |
| orderPayments.method | String | The specific payment method used (e.g., Visa, MasterCard, PayPal). |
Success
{
"status": "success",
"statusCode": 200,
"data": [
{
"outletName": "MainOutlet",
"orderNumber": "1",
"receiptNumber": "9696",
"orderType": "Dine In",
"orderDateTime": "2024-08-22 11:51:13",
"businessSource": "",
"guestName": "",
"guestCount": "1",
"employeeName": "Analyn",
"sessionName": "",
"totalItemsAmount": "75.9905",
"totalDiscountAmount": "15.8000",
"totalTaxAmount": "3.0095",
"totalTipsAmount": "16.8000",
"totalSurchargesAmount": "0.0000",
"totalRoundOffAmount": "0.0000",
"totalPaymentAmount": "80.0000",
"netSalesAmount": "60.1905",
"grossSalesAmount": "75.9905",
"remark": "",
"orderPayments": [
{
"amount": "80.0000",
"type": "Bank",
"method": "Visa"
}
]
},
{
"outletName": "MainOutlet",
"orderNumber": "2",
"receiptNumber": "9698",
"orderType": "Dine In",
"orderDateTime": "2024-08-22 12:06:55",
"businessSource": "",
"guestName": "",
"guestCount": "2",
"employeeName": "Manager",
"sessionName": "",
"totalItemsAmount": "167.3714",
"totalDiscountAmount": "34.8000",
"totalTaxAmount": "6.6286",
"totalTipsAmount": "0.0000",
"totalSurchargesAmount": "0.0000",
"totalRoundOffAmount": "0.0000",
"totalPaymentAmount": "139.2000",
"netSalesAmount": "132.5714",
"grossSalesAmount": "167.3714",
"remark": "",
"orderPayments": [
{
"amount": "139.2000",
"type": "Bank",
"method": "Visa"
}
]
}
]
}Error
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}F & B
Menu
This API retrieves the menu information for a specific hotel based on the provided hotel code, including outlets, categories, subcategories, and items
End Point URL
https://api.ipos247.com/v1/service/menu Header
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}Parameter
| Name | Data Type | Description |
|---|---|---|
| hotel_code * | INT | The unique identifier for the hotel. This is essential for retrieving relevant data. |
| outlet_name | String | The name of the specific outlet within the hotel. If not provided, the query will retrieve data from all outlets. |
Request
{
"hotel_code": "XXXX", // Required
"outlet_name": "MainOutlet" // Optional
}Response
| Name | Data Type | Description |
|---|---|---|
| status | String | Status of the request, indicating whether it was successful. |
| statusCode | Integer | HTTP status code indicating the result of the request. |
| data | Object | Contains all data related to outlets, categories, subcategories, and items. |
| outlets | Array | Contains the list of outlets available in the hotel. |
| outlets.ref_id | Integer | Reference ID of the outlet. |
| outlets.outlet_name | String | Name of the outlet. |
| categories | Array | Contains the list of categories with names and reference IDs. |
| categories.ref_id | Integer | Reference ID of the category. |
| categories.category_name | String | Name of the category. |
| subcategories | Array | Contains the list of subcategories with names and reference IDs. |
| subcategories.ref_id | Integer | Reference ID of the subcategory. |
| subcategories.subcategory_name | String | Name of the subcategory. |
| items | Array | Contains the list of items with details like name, code, and price. |
| items.item_name | String | Name of the item. |
| items.item_code | String | Code of the item. |
| items.food_type | String | VEG, NONVEG, EGG |
| items.unit_price | items. description | Price of the item. |
| items.category_ref_id | Array of Strings | List of reference IDs corresponding to the categories. |
| items.subcategory_ref_id | Array of Strings | List of reference IDs corresponding to the subcategories. |
| items.outlet_ref_id | Array of Strings | List of reference IDs corresponding to the outlets. |
| items.description | String | Description of the item (if any). |
Success
{
"status": "success",
"statusCode": 200,
"data": {
"outlets": [
{
"outlet_name": "MainOutlet",
"ref_id": "10000000001"
}
],
"categories": [
{
"category_name": "Hot Drinks",
"ref_id": "10000000001"
},
{
"category_name": "Cold Drinks",
"ref_id": "10000000002"
},
{
"category_name": "Fresh Juice",
"ref_id": "10000000003"
},
{
"category_name": "Soft Drinks",
"ref_id": "10000000004"
}
],
"subcategories": [
{
"subcategory_name": "Classic",
"ref_id": "10000000001"
},
{
"subcategory_name": "Coffee",
"ref_id": "10000000002"
},
{
"subcategory_name": "Tea",
"ref_id": "10000000003"
},
{
"subcategory_name": "Other Drinks",
"ref_id": "10000000004"
}
],
"items": [
{
"item_name": "Blueberry",
"Item Code": "376",
"Unit Price": "75.2381",
"category_ref_id": [
"10000000001"
],
"subcategory_ref_id": [
"10000000001"
],
"outlet_ref_id": [
"10000000001"
],
"description": ""
},
{
"item_name": "Double Apple",
"Item Code": "377",
"Unit Price": "75.2381",
"category_ref_id": [
"10000000001"
],
"subcategory_ref_id": [
"10000000001"
],
"outlet_ref_id": [
"10000000001"
],
"description": ""
}
]
}
}Error
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}Bookings
Retrieve Transaction Details
This API helps you to fetch booking details for specific transaction unique ID based on Room No, Guest, Identity No, Guest Email, Guest Mobile No, Guest Registration No. The API can return data in JSON formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| Request_Type* | VARCHAR(100) | Request Type | GetTransactionDetails |
| TranunkId* | VARCHAR(100) | Transaction Id single/multiple (comma separated) | xxxxx0000000000400 |
| RoomNo | VARCHAR(500) | Room No (It is Optional) | 101 |
| Guest | VARCHAR(100) | Guest Name (It is Optional) | test |
| IdentityNo | VARCHAR(255) | Identity No (It is Optional) | ASD43543 |
| GuestEmail | VARCHAR(255) | Guest Email (It is Optional) | abc@gmail.com |
| GuestMobileNo | VARCHAR(255) | Guest Mobile No (It is Optional) | XXXXXXXXXX |
| GuestRegistrationNo | VARCHAR(255) | Guest Registration No (It is Optional) | XXXXXX |
| HotelCode* | INT(11) | Unique Hotel code | xxxx |
| AuthCode* | VARCHAR(300) | Unique Authentication code | xxxxxxxxxx |
Request
{
"RES_Request": {
"Request_Type": "GetTransactionDetails,"
. "TranunkId": "xxxxx0000000000400",
"RoomNo": "101",
"Guest": "Joy T. Mnewy",
"IdentityNo": "ASD43543",
"GuestEmail": "XXXXXX@gmail.com",
"GuestMobileNo": "XXXXXXXXXX",
"GuestRegistrationNo": "XXXXXX",
"Authentication": {
"HotelCode": "XXXX",
"AuthCode": "XXXXXXXXXXXXXXXXXXX"
}
}
}
Response
| Name | Data Type | Description | Example |
| LocationId | INT(11) | Hotel code | xxxx |
| UniqueID | VARCHAR(255) | Unique Booking id/ Reservation No | 10125, 86436, B4525 etc |
| BookedBy | VARCHAR(255) | Information regarding Booked by | Booking.com etc |
| Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo. | VARCHAR(255) | Here * denotes guest information like Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo. | shown in JSON response below. |
| Source | VARCHAR(1000) | Booking generated source | Booking.com etc |
| PaymentMethod | VARCHAR(255) | Payment Mode selected by guest | Cash, Credit, CityLedger etc |
| IsChannelBooking | INT(1) | Is booking comes from channel [0 or 1]1 : Booking from the channel.0: Booking not from the channel. | 0 or 1 |
| BookingTran. SubBookingId | VARCHAR(255) | Sub booking Id | 138 |
| BookingTran. TransactionId | INT(20) | Booking Transaction ID | 112500000000000163 |
| BookingTran. Status | VARCHAR(100) | Booking Status | New or Modify or Cancel. |
| BookingTran.IsConfirmed | INT(1) | Booking Confirmation Flag. [1 or 0]1 : Confirmed0 : Not Confirmed | 1 or 0. |
| BookingTran.CurrentStatus | VARCHAR(100) | Booking Current Status | Arrived, Checked Out, Cancel, Void, etc |
| BookingTran.VoucherNo | VARCHAR(255) | Booking Voucher No | 10203049/8512 |
| BookingTran. PackageCode | INT(20) | Package Code | 112500000000000001 |
| BookingTran. PackageName | VARCHAR(1000) | Package Name | European Plan etc |
| BookingTran. RateplanCode | INT(20) | Unique RatePlan Code | 112500000000000006 |
| BookingTran. RateplanName | STRING(1000) | RatePlan Name | Grand Sea View Junior Suite |
| BookingTran. RoomTypeCode | INT(20) | Unique RoomType Code | 112500000000000006 |
| BookingTran. RoomTypeName | STRING(1000) | RoomType Name | Garden View Studio Room |
| BookingTran.RoomID | INT(20) | Unique RoomID | 112500000000000001 |
| BookingTran. RoomName | STRING(1000) | Room Name | 101 |
| BookingTran. Start | DATE | Check-in date[Format : yyyy-mm-dd] | 2017-12-25 |
| BookingTran. End | DATE | Check-out date [Format : yyyy-mm-dd] | 2017-12-27 |
| BookingTran.TotalRate | DECIMAL(19,4) | Rate on room in amount | 1500.43 |
| BookingTran.TotalDiscount | DECIMAL(19,4) | Discount on room in amount | 500 |
| BookingTran. TotalExtraCharge | DECIMAL(19,4) | Extra charges in amount(if any) | 300 |
| BookingTran.* | – | Here * denotes guest informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityType, IdentityNo, ExpiryDate. | |
| BookingTran. TransportationMode | VARCHAR(100) | Mode of transportation | Bus, car etc |
| BookingTran. Vehicle | VARCHAR(255) | Detail of vehicle | |
| BookingTran. PickupDate | DATE | Pickup date[Format : yyyy-mm-dd] | 2017-12-25 etc |
| BookingTran. PickupTime | TIME | Pickup time | |
| BookingTran. Source | VARCHAR(1000) | Booking generated source | Booking.com |
| BookingTran. Comment | VARCHAR(1000) | Additional Information or comment. | |
| BookingTran. AffiliateName | VARCHAR(1000) | Booking Affiliate Name | |
| BookingTran.AffiliateCode | VARCHAR(1000) | Booking Affiliate Code | |
| BookingTran.* | – | Here * denotes Credit Card Informations like CCLink, CCNo, CCType, CardHolderName, CCExpiryDate, | CCLink in encoded with base64_encode. |
| BookingTran.RentalInfo.RoomID | INT(20) | Unique RoomID | 112500000000000001 |
| BookingTran.RentalInfo. RoomName | STRING(1000) | Room Name | 101 |
| BookingTran.RentalInfo.EffectiveDate | DATETIME | Booking details for particular effective date | 2017-12-25 etc |
| BookingTran.RentalInfo.PackageCode | INT(20) | Package code | 112500000000000001 |
| BookingTran.RentalInfo.PackageName | VARCHAR(1000) | Package Name | European Plan |
| BookingTran.RentalInfo.RoomTypeCode | INT(20) | Unique RoomType Code | 112500000000000006 |
| BookingTran.RentalInfo.RoomTypeName | STRING(1000) | RoomType Name | Grand Sea View Junior Suite |
| BookingTran.RentalInfo.Adult | INT(11) | No. of Adults | 2,3,4 etc |
| BookingTran. RentalInfo.Child | INT(11) | No. of Child | 2,3,4 etc |
| BookingTran. RentalInfo.Rent | DECIMAL(19,4) | Room rental amount | 1500.43 |
| BookingTran. RentalInfo.Discount | DECIMAL(19,4) | Discount on rental room in amount | 500 |
| BookingTran.Sharer.* | – | Here * denotes Sharer informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Nationality,Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityTypeID, IdentityNo, ExpiryDate. | |
| Errors.ErrorCode | – | Response Error Code | 104, 404 etc |
| Errors.ErrorMessage | – | Generate Response Message | Unauthorized Request. etc |
Success
{
"Reservations": {
"Reservation": [
{
"BookingTran": [
{
"SubBookingId": "11241254",
"TransactionId": "112400000000001902",
"Createdatetime": "2019-09-04 11:40:30",
"Modifydatetime": "2019-09-04 11:40:30",
"Status": "New",
"IsConfirmed": "1",
"CurrentStatus": "Arrived",
"VoucherNo": "single1276/1",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RateplanCode": "112400000000000001",
"RateplanName": "Sea View Deluxe Room",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"RoomID": "112400000000000001",
"RoomName": "101",
"Start": "2019-09-26",
"End": "2019-09-28",
"ArrivalTime": "12:00:00",
"DepartureTime": "11:00:00",
"CurrencyCode": "USD",
"TotalAmountAfterTax": "976.00",
"TotalAmountBeforeTax": "800.00",
"TotalTax": "176.00",
"TotalDiscount": "0.00",
"TotalExtraCharge": "0.00",
"TotalPayment": "0.00",
"TACommision": "0.00",
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
“RegistrationNo” : "",
"IdentityType": "Pan card",
"IdentityNo": "12345667765",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "car",
"PickupDate": "",
"PickupTime": "",
"Source": "BookingEye",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "AA",
"TaxName": "VAT @ 12%",
"TaxAmount": "96.0000"
},
{
"TaxCode": "LT",
"TaxName": "Luxury @ 10%",
"TaxAmount": "80.0000"
}
],
"RentalInfo": [
{
"RoomID": "112400000000000001",
"RoomName": "101",
"EffectiveDate": "2019-09-26",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "550.00",
"Rent": "671.00",
"Discount": "0.00"
},
{
"RoomID": "112400000000000001",
"RoomName": "101",
"EffectiveDate": "2019-09-27",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "250.00",
"Rent": "305.00",
"Discount": "0.00"
}
],
"Sharer": [
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"RegistrationNo" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
},
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"Registration No" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
}
]
}
],
"LocationId": "1124",
"UniqueID": "11241254",
"BookedBy": "BookingEye",
"Salutation": "Ms.",
"FirstName": "Larry",
"LastName": "Forney",
"Gender": "Female",
"Address": "",
"City": "Brockway",
"State": "CA",
"Country": "USA",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"Source": "BookingEye",
"PaymentMethod": "Cash",
"IsChannelBooking": "1"
}
]
}
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameters. |
| 101 | Hotel Code is missing |
| 102 | Authentication Code is missing |
| 201 | Unauthorized request. (Request Type) the request is not valid for this hotel code OR OpenAPI platform is deactive |
| 202 | Unauthorized request. Hotel code is not active |
| 203 | Missing Parameter OR Invalid Parameter: TranunkId |
| 301 | Unauthorized Request. Please check hotel code and authentication code |
| 303 | Auth Code is inactive. |
| 500 | Error occurred during processing |
| 502 | Request Type is missing |
| 503 | No Reservation Found. |