Finance
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. |
Finance
Retrieve Incidental Invoices
This API provides incidental invoices (point of sale) information 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 |
| fromdate | DATE | From date [Format: yyyy-mm-dd] | 2020-03-01 |
| todate | DATE | To date [Format: yyyy-mm-dd] | 2020-03-31 |
| requestfor* | VARCHAR(100) | Request Type | XERO_INCIDENTAL_INVOICE |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"fromdate" : "2020-03-01",
"todate" : "2020-03-30",
"requestfor": "XERO_INCIDENTAL_INVOICE"
}
Response
| Name | Data Type | Description | Example |
| status | String | Response status | Success |
| data->type | String | Response type | Incidental Invoice |
| tranId | String | Transaction Id | P837-211 |
| tran_datetime | Date | Transaction Date | 2020-03-22 |
| reference1 | String | Guest Name/City Ledger Name | Jhems |
| reference2 | String | Guest Name/City Ledger Name | Jhems |
| reference3 | String | Bill Number | 2 |
| reference4 | String | ||
| reference5 | String | ||
| reference6 | String | ||
| reference7 | String | ||
| reference8 | String | ||
| reference9 | String | ||
| reference10 | String | ||
| reference11 | String | ||
| reference12 | String | ||
| reference13 | String | ||
| reference14 | String | Folio Type (CASH/CREDIT) | CASH / CREDIT |
| 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 |
| detail->tran_type | String | Transaction Type (Credit/Debit) | Cr/Dr |
| detail->remark | String | Comment | |
| detail->voucherno | String | Transaction Voucher No | 777 |
| detail->parentid | integer | Parent Id | 1234500000000000002 |
| detail->taxper | String | Tax Percentage | 15% |
| detail->detailId | integer | Transaction Details Id | 1234500000000000991 |
| detail->reference_id | integer | Statically Defined Reference Id | 2 |
| detail->reference_value | String | If reference_id is 1, thenValue of reference_value: Room Revenue It means :Value of reference_id:1: Room Revenue2: Extra Charges3: Discount4: Adjustment5: Tax6: Payment Type10: City Ledger | Payment Type, Extra Charges,Guest Ledger, Discount |
| detail->sub_reference1_id | integer | Statically Defined Sub Reference Id – 1 | 1 |
| detail->sub_reference1_value | String | City Ledger/ Discount, Etc Value | 1 |
| detail->sub_reference2_id | integer | Statically Defined Sub Reference Id – 2 | 2 |
| detail->sub_reference2_value | String | If Above reference value is of Extra Charges, then Extra Charge ID. If Above reference value is of Discount, then Discount ID. | 1234500000000000002 |
| detail->sub_reference3_id | integer | If Above reference value is Room Revenue, then sub_reference3_id is 1 otherwise 0. | 1,0 |
| detail->sub_reference3_value | String | If Above reference value is Room Revenue, then sub_reference3_value is 1 otherwise 0. | 1,0 |
| detail->sub_reference4_id | integer | If Above reference value is Room Revenue, then sub_reference4_value is 1 otherwise 0. | 1,0 |
| detail->sub_reference4_value | String | If Above reference value is Room Revenue, then sub_reference4_value is 1 otherwise 0 | 1,0 |
| detail->sub_reference5_id | integer | If Above reference value is Room Revenue, then sub_reference5_id is 5 otherwise 0. | 5, 0 |
| detail->sub_reference5_value | String | If sub_reference5_id is 5, thenValue of sub_reference5_id: 1/2/3/4/5 It means:1: Room Charges2: Cancellation Revenue3: Day Use Charges4: Late Checkout Charges5: No Show Revenue If sub_reference5_id is 5, then Value of sub_reference5_id: | 0 |
| detail->sub_reference6_id | integer | 0 | |
| detail->sub_reference6_value | String | 0 | |
| detail->sub_reference7_id | integer | 0 | |
| detail->sub_reference7_value | String | 0 | |
| detail->sub_reference8_id | integer | 0 | |
| detail->sub_reference8_value | String | 0 | |
| detail->amount | Decimal | Transaction Amount | 50 |
| detail->slabtaxunkid | String | Slab Tax id | 1234500000000000013_1 |
| detail->slabtax | String | Slab tax name | CGST |
| detail->slab | String | Slab range | 1000-2499-12 |
| gross_amount | Decimal | Gross Amount | 50 |
| amount_paid | Decimal | Amount Paid | 50 |
| balance | Decimal | Account Balance | 0 |
| remark | String | Comment of transaction |
Success
{
"status": "Success",
"data": [
{
"type": "Incidental Invoice",
"data": [
{
"tranId": "P837-211",
"tran_datetime": "2020-03-21",
"reference1": "Jhems",
"reference2": "Jhems",
"reference3": "2",
"reference4": "",
"reference5": "",
"reference6": "",
"reference7": "",
"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",
"detail": [
{
"tran_type": "Dr",
"remark": "",
"voucherno": "43",
"parentid": "",
"taxper": "",
"detailId": "1234500000000000837",
"reference_id": 6,
"reference_value": "Payment Type",
"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": 70,
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
},
{
"tran_type": "Cr",
"remark": "",
"voucherno": "123",
"parentid": "",
"taxper": "",
"detailId": "1234500000000000836",
"reference_id": 2,
"reference_value": "Extra Charges",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000001",
"sub_reference3_id": 1,
"sub_reference3_value": 1,
"sub_reference4_id": 1,
"sub_reference4_value": 1,
"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": "70.0000",
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
}
],
"gross_amount": 70,
"amount_paid": 70,
"balance": 0,
"remark": ""
},
{
"tranId": "P991-221",
"tran_datetime": "2020-03-22",
"reference1": "Jiya",
"reference2": "Mark Travels",
"reference3": "12",
"reference4": "",
"reference5": "",
"reference6": "",
"reference7": "",
"reference8": "",
"reference9": "",
"reference10": "",
"reference11": "",
"reference12": "",
"reference13": "",
"reference14": "CREDIT",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station,surat-396380,gujarat,india",
"reference21": "0261242059",
"detail": [
{
"tran_type": "Cr",
"remark": "",
"voucherno": "777",
"parentid": "",
"taxper": "",
"detailId": "1234500000000000991",
"reference_id": 2,
"reference_value": "Extra Charges",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000002",
"sub_reference3_id": 1,
"sub_reference3_value": 1,
"sub_reference4_id": 1,
"sub_reference4_value": 1,
"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": "1000.0000",
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
},
{
"tran_type": "Cr",
"remark": "water",
"voucherno": "123-1",
"parentid": "",
"taxper": "",
"detailId": "1234500000000000994",
"reference_id": 2,
"reference_value": "Extra Charges",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000003",
"sub_reference3_id": 1,
"sub_reference3_value": 1,
"sub_reference4_id": 1,
"sub_reference4_value": 1,
"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": "500.0000",
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
},
{
"tran_type": "Dr",
"remark": "xyz",
"voucherno": "",
"parentid": "",
"taxper": "",
"detailId": "1234500000000000992",
"reference_id": 10,
"reference_value": "City Ledger",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000020",
"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": 1000,
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
},
{
"tran_type": "Dr",
"remark": "",
"voucherno": "",
"parentid": "",
"taxper": "",
"detailId": "1234500000000000996",
"reference_id": 10,
"reference_value": "City Ledger",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000020",
"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": 450,
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
},
{
"tran_type": "Dr",
"remark": "",
"voucherno": "",
"parentid": "1234500000000000994",
"taxper": "",
"detailId": "1234500000000000995",
"reference_id": 3,
"reference_value": "Discount",
"sub_reference1_id": 1,
"sub_reference1_value": 1,
"sub_reference2_id": 2,
"sub_reference2_value": "1234500000000000018",
"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": 50,
"slabtaxunkid": "",
"slabtax": "",
"slab": ""
}
],
"gross_amount": 1500,
"amount_paid": 1500,
"balance": 0,
"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 Journals
This API provides journal 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 |
| fromdate | DATE | From date [Format: yyyy-mm-dd] | 2020-03-01 |
| todate | DATE | To date [Format: yyyy-mm-dd] | 2020-03-31 |
| requestfor* | VARCHAR(100) | Request Type | XERO_GENERAL_JOURNAL_INFO |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"fromdate" : "2020-03-01",
"todate" : "2020-03-30",
"requestfor": "XERO_GENERAL_JOURNAL_INFO"
}
Response
| Name | Data Type | Description | Example |
| status | String | Response status | Success |
| data->type | String | Response type | Advance Deposit Transfer, Folio Transfer, Cityledger Transfer, Cityledger Commision |
| tranId | String | Transaction Id | G1057-221 |
| tran_datetime | Date | Transaction Date [Format: yyyy-mm-dd] | 2020-03-22 |
| reference1 | Date | Receipt No | 52 |
| reference2 | Date | Guest Name | Holder |
| reference3 | String | Reservation No | 35 |
| reference4 | String | Reservation No | 35 |
| reference5 | String | Folio No | 36 |
| reference6 | String | Bill No / Invoice No | 39 |
| reference7 | String | Bill To | Holder |
| reference8 | String | Arrival Date [Format: yyyy-mm-dd] | 2020-03-24 |
| reference9 | String | Departure Date [Format: yyyy-mm-dd] | 2020-03-28 |
| reference10 | String | Business Source | |
| reference11 | String | Travel Agent Voucher No | |
| reference12 | String | Market Code | |
| reference13 | String | City Ledger Name (For only Cityledger Commision data) | |
| reference14 | String | Room Name | 107 |
| reference15 | String | Not Applicable | |
| reference16 | String | Not Applicable | |
| reference17 | String | Identity type of billing contact. If Billing contact is guest , Company Tax ID 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 |
| detail->tran_type | String | Transaction Type (Credit/Debit) | Cr/Dr |
| detail->detailId | Integer | Detail Id | 1234500000000000971 |
| detail->reference_id | integer | 13 | |
| detail->reference_value | String | Transaction Mode | Advance,Payment, Paid Out,Guest Ledger |
| detail->sub_ref1_id | integer | 1 | |
| detail->sub_ref1_value | String | 1 | |
| detail->sub_ref2_id | integer | 2 | |
| detail->sub_ref2_value | String | Guest Name, City Ledger Id (For only Cityledger Transfer,Cityledger Commision data) Expense Type Id (For only Cityledger Commision data) | Holder |
| detail->sub_ref3_id | integer | 3 | |
| detail->sub_ref3_value | String | Business Source Id | 0 |
| detail->sub_ref4_id | integer | 4 | |
| detail->sub_ref4_value | String | Room Id | 1234500000000000007 |
| detail->sub_ref5_id | integer | 5 | |
| detail->sub_ref5_value | String | Room Type Id | 1234500000000000002 |
| detail->sub_ref6_id | integer | 6 | |
| detail->sub_ref6_value | String | Folio No | 36 |
| detail->sub_ref7_id | integer | 7 | |
| detail->sub_ref7_value | String | Bill To | |
| detail->sub_ref8_id | integer | 0 | |
| detail->sub_ref8_value | String | 0 | |
| detail->amount | Decimal | Transaction Amount | 18930 |
| gross_amount | Decimal | Gross Amount | 18930 |
| remark | String | Comment of transaction |
Success
{
"status": "Success",
"data": [
{
"type": "Advance Deposit Transfer",
"data": [
{
"tranId": "G1057-221",
"tran_datetime": "2020-03-25",
"reference1": "59",
"reference2": "Holder",
"reference3": "35",
"reference4": "35",
"reference5": "36",
"reference6": "39",
"reference7": "",
"reference8": "2020-03-25",
"reference9": "2020-03-27",
"reference10": "",
"reference11": "",
"reference12": "",
"reference13": "",
"reference14": "107",
"reference15": "",
"reference16": "",
"reference17": "",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station ,surat-396380,gujarat,india",
"reference21": "0261242059",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000000971",
"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": 18930
},
{
"tran_type": "Cr",
"detailId": "1234500000000000971",
"reference_id": 8,
"reference_value": "Guest Ledger",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "Holder",
"sub_ref3_id": 3,
"sub_ref3_value": "",
"sub_ref4_id": 4,
"sub_ref4_value": "1234500000000000007",
"sub_ref5_id": 5,
"sub_ref5_value": "1234500000000000002",
"sub_ref6_id": 6,
"sub_ref6_value": "36",
"sub_ref7_id": 7,
"sub_ref7_value": "",
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": 18930
}
],
"gross_amount": 18930,
"remark": ""
}
]
},
{
"type": "Folio Transfer",
"data": [{
"tranId": "123456",
"tran_datetime": "2020-06-06 12:10:00",
"reference1": "Folio_Transfer-001",
"reference2": "Guest/Person Name",
"reference3": "booking no",
"reference4": "reservation no",
"reference5": "folio no",
"reference6": "bill no",
"reference7": "Bill to Name",
"reference8": "Arrival Date ",
"reference9": "Departure Date",
"reference10": "Business Source Name",
"reference11": "Travel Agent Voucher number - OTA Booking Voucher number",
"reference12": "Market Name",
"reference13": "",
"reference14": "Room Name",
"reference15": "",
"reference16": "",
"reference17": "Guest/Person Identity type or Company Tax Id",
"reference18": "Guest/Person Identity number"or Tax Id",
"reference19": "Guest/Person or Business Sources Email",
"reference20": "Guest/Person or Business Sources Address",
"reference21": "Guest/Peron or Business Sources Telephone number",
"detail": [
{
"tran_type": "Dr",
"detailId": "123456-1",
"reference_id": "7",
"reference_value": "Folio Transfer",
"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": "81.000"
},
{
"tran_type": "Cr",
"detailId": "123456-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": "roomunkid",
"sub_reference5_id": "5",
"sub_reference5_value": "roomtypeunkid",
"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": "81.000"
}
],
"gross_amount": "81.0000",
"remark": ""
}
]
},
{
"type": "Cityledger Transfer",
"data": [
{
"tranId": "G1056-251",
"tran_datetime": "2020-03-25",
"reference1": "0",
"reference2": "Krey",
"reference3": "",
"reference4": "",
"reference5": "31",
"reference6": "33",
"reference7": "",
"reference8": "",
"reference9": "",
"reference10": "",
"reference11": "",
"reference12": "",
"reference13": "Booking.com Travel",
"reference14": "112",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station ,surat-396380,gujarat,india",
"reference21": "0261242059",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000001056",
"reference_id": 10,
"reference_value": "City Ledger",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000097",
"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": 4130
},
{
"tran_type": "Cr",
"detailId": "1234500000000001056",
"reference_id": 8,
"reference_value": "Guest Ledger",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "Krey",
"sub_ref3_id": 3,
"sub_ref3_value": "",
"sub_ref4_id": 4,
"sub_ref4_value": "1234500000000000012",
"sub_ref5_id": 5,
"sub_ref5_value": "1234500000000000002",
"sub_ref6_id": 6,
"sub_ref6_value": "31",
"sub_ref7_id": 7,
"sub_ref7_value": "",
"sub_ref8_id": 0,
"sub_ref8_value": 0,
"amount": 4130
}
],
"gross_amount": 4130,
"remark": ""
}
]
},
{
"type": "Cityledger Commision",
"data": [
{
"tranId": "G1081-281",
"tran_datetime": "2020-03-28",
"reference1": "",
"reference2": "Prince",
"reference3": "49",
"reference4": "49",
"reference5": "53",
"reference6": "44",
"reference7": "",
"reference8": "2020-03-24",
"reference9": "2020-03-28",
"reference10": "Max Travel",
"reference11": "",
"reference12": "",
"reference13": "Max Travel",
"reference14": "128",
"reference15": "",
"reference16": "",
"reference17": "Company Tax ID",
"reference18": "",
"reference19": "test@gmail.com",
"reference20": "Near railway station, surat-396380,gujarat,india",
"reference21": "0261242059",
"detail": [
{
"tran_type": "Dr",
"detailId": "1234500000000001081",
"reference_id": 16,
"reference_value": "Paid Out",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000001",
"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": "800.0000"
},
{
"tran_type": "Cr",
"detailId": "1234500000000001081",
"reference_id": 10,
"reference_value": "City Ledger",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000018",
"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": "800.0000"
}
],
"gross_amount": "800.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. |
Finance
Retrieve Inwards 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 |
| fromdate | DATE | From date [Format: yyyy-mm-dd] | 2020-03-01 |
| todate | DATE | To date [Format: yyyy-mm-dd] | 2020-03-31 |
| requestfor* | VARCHAR(100) | Request Type | XERO_GET_RECEIPT_DATA |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"fromdate" : "2020-03-01",
"todate" : "2020-03-30",
"requestfor": "XERO_GET_RECEIPT_DATA"
}
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 |
| 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",
"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",
"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 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 |
| fromdate | DATE | From date [Format: yyyy-mm-dd] | 2020-03-01 |
| todate | DATE | To date [Format: yyyy-mm-dd] | 2020-03-31 |
| requestfor* | VARCHAR(100) | Request Type | XERO_GET_PAYMENT_DATA |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"fromdate" : "2020-03-01",
"todate" : "2020-03-30",
"requestfor": "XERO_GET_PAYMENT_DATA"
}
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 |
| 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",
"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",
"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",
"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": "",
"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. |
Finance
Retrieve Revenues
This API provides revenue information for a property 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 |
| fromdate | DATE | From date. [Format: yyyy-mm-dd] | 2020-03-01 |
| todate | DATE | To date. [Format: yyyy-mm-dd] | 2020-03-31 |
| ischeckout | VARCHAR(300) | It is a flag for check out. | True/False |
| requestfor* | VARCHAR(100) | Request Type | XERO_GET_TRANSACTION_DATA |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"fromdate" : "2020-03-01",
"todate" : "2020-03-30",
"ischeckout" : "true",
"requestfor": "XERO_GET_TRANSACTION_DATA"
}
Response
| Name | Data Type | Description | Example |
| record_id | String | Record/Unique Id | S7-18 |
| record_date | Date | Record Date | 2020-03-18 |
| reference1 | Date | Check In Date [Format: yyyy-mm-dd] | 2020-03-17 |
| reference2 | Date | Check Out Date [Format: yyyy-mm-dd] | 2020-03-18 |
| reference3 | String | Reservation No | 7 |
| reference4 | String | Folio No | 6 |
| reference5 | String | Guest Name | Alex Joy |
| reference6 | String | 0 | |
| reference7 | String | Source | |
| reference8 | String | Bill No / Invoice No | 0 |
| reference9 | String | Bill To | |
| reference10 | String | Voucher No | |
| reference11 | String | 0 | |
| reference12 | String | 0 | |
| reference13 | String | Room No | 103 |
| reference14 | String | Room Type | Twin |
| reference15 | String | Rate Type | Frequent Traveller |
| reference16 | String | Market Code | Airline Crew |
| 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 |
| detail->detail_record_id | integer | Rental ID | 1234500000000000038 |
| detail->detail_record_date | Date | Rental Date | 2020-03-17 |
| detail->reference_id | integer | List of Account Reference ID | 1 |
| detail->reference_name | String | List of Account Reference Name | |
| detail->sub_ref1_id | integer | List of Account Sub Reference ID ‘Single Ledger’ | 1 |
| detail->sub_ref1_value | String | List of Account Sub Reference value ‘Always “1” when reference_id = 1 | 1 |
| detail->sub_ref2_id | integer | List of Account Sub Reference ID ‘Room Name wise | 2 |
| detail->sub_ref2_value | String | List of Account Sub Reference value ‘Room Unique ID | 1234500000000000003 |
| detail->sub_ref3_id | integer | List of Account Sub Reference ID ‘Room Type wise | 3 |
| detail->sub_ref3_value | String | List of Account Sub Reference value ‘Room Type Unique ID | 1234500000000000005 |
| detail->sub_ref4_id | integer | List of Account Sub Reference ID ‘Rate Type wise | 4 |
| detail->sub_ref4_value | String | List of Account Sub Reference value ‘Rate Type Unique ID | 1234500000000000003 |
| detail->sub_ref5_id | integer | List of Account Sub Reference ID ‘Room Charge wise [Room Rent = 1, Cancellation Charge = 2, Day use = 3, Late checkout = 4 and No show charge = 5] | 5 |
| detail->sub_ref5_value | String | List of Account Sub Reference value ‘Room Unique ID’ | 1 |
| detail->sub_ref6_id | integer | List of Account Sub Reference ID ‘Slab Tax’ wise | 6 |
| detail->sub_ref6_value | String | List of Account Sub Reference value ‘Tax Unique ID’ | |
| detail->sub_ref7_id | integer | List of Account Sub Reference ID ‘Source wise’ | 7 |
| detail->sub_ref7_value | String | List of Account Sub Reference value ‘Source Unique ID’ | |
| detail->sub_ref8_id | integer | List of Account Sub Reference ID ‘Market code wise’ | 8 |
| detail->sub_ref8_value | String | List of Account Sub Reference value ‘market Place Unique ID’ | |
| detail->amount | String | Amount | 1900.0000 |
| detail->taxper | String | Percentage of applied tax definition | |
| detail->slabtaxunkid | String | Slab Tax id | 1234500000000000013_1 |
| detail->slabtax | String | Slab tax name | CGST |
| detail->slab | String | Slab range | 1000-2499-12 |
| detail->charge_name | String | Charge name | Laundry |
| detail->masterunkid | integer | Unique id | 1234500000000000015 |
| detail->parentmasterunkid | integer | Unique id | 1234500000000000014 |
| detail->description | String | description | |
| detail->Taxtype | String | Tax type | |
| detail->posdata | String | POS Data | |
| detail->POSTaxName | String | POS Tax name | |
| detail->POSTaxPercent | String | POS Tax Percentage | |
| gross_amount | Decimal | (rent – rental dis. + rental tax + ex. charges – ex. discount + ex. tax) | 0 |
| flat_discount | Decimal | Folio level Discount | 0 |
| adjustment_amount | Decimal | Adjustment | 0 |
| add_less_amount | Decimal | 0 | |
| total_amount | Decimal | (gross_amount – flat_discount + adjustment_amount) | 2242.0000 |
| amount_paid | Decimal | Paid Amount | 2242 |
| balance | Decimal | (total amount – paid amount) | 0 |
Success
[
{
"record_id": "S7-18",
"record_date": "2020-03-18",
"reference1": "2020-03-17",
"reference2": "2020-03-18",
"reference3": "7",
"reference4": "6",
"reference5": "Alex Joy",
"reference6": "0",
"reference7": "",
"reference8": "9",
"reference9": "",
"reference10": "",
"reference11": "0",
"reference12": "0",
"reference13": "103",
"reference14": "Twin",
"reference15": "Frequent Traveller",
"reference16": "",
"reference17": "Passport",
"reference18": "T9305602",
"reference19": "test@gmail.com",
"reference20": "Near railway station surat 396380 gujarat india",
"reference21": "0261242059",
"detail": [
{
"detail_record_id": "1234500000000000038",
"detail_record_date": "2020-03-17",
"reference_id": 1,
"reference_name": "Room Revenue",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000003",
"sub_ref3_id": 3,
"sub_ref3_value": "1234500000000000005",
"sub_ref4_id": 4,
"sub_ref4_value": "1234500000000000003",
"sub_ref5_id": 5,
"sub_ref5_value": 1,
"sub_ref6_id": 6,
"sub_ref6_value": "1234500000000000171_2",
"sub_ref7_id": 7,
"sub_ref7_value": "",
"sub_ref8_id": 8,
"sub_ref8_value": "",
"amount": "1900.0000",
"taxper": "",
"slabtaxunkid": "1234500000000000171_2",
"slabtax": "CGST",
"slab": "1001-7500.99-12",
"charge_name": "Room Charges",
"masterunkid": "1234500000000000004",
"parentmasterunkid": "",
"description": "",
"Taxtype": "",
"posdata": "",
"POSTaxName": "",
"POSTaxPercent": ""
},
{
"detail_record_id": "1234500000000000038",
"detail_record_date": "2020-03-17",
"reference_id": 5,
"reference_name": "Taxes",
"sub_ref1_id": 1,
"sub_ref1_value": 1,
"sub_ref2_id": 2,
"sub_ref2_value": "1234500000000000003",
"sub_ref3_id": 3,
"sub_ref3_value": “1234500000000000171_2”,
"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": "342.0000",
"taxper": "18.0000",
"slabtaxunkid": "1234500000000000171_2",
"slabtax": "CGST",
"slab": "1001-7500.99-6",
"charge_name": "CGST",
"masterunkid": "1234500000000000004",
"parentmasterunkid": "",
"description": "",
"Taxtype": "",
"posdata": "",
"POSTaxName": "",
"POSTaxPercent": ""
}
],
"gross_amount": 0,
"flat_discount": 0,
"adjustment_amount": 0,
"add_less_amount": 0,
"total_amount": "2242.0000",
"amount_paid": 2242,
"balance": 0
},
]
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 Financial Accounts
This API provides a financial accounts list for a property. 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 |
| requestfor* | VARCHAR(100) | Request Type | XERO_GET_CONFIG_DATA |
Request
{
"auth_code": "XXXXXXXXXXXXXXXXXXX",
"hotel_code": "XXXX",
"requestfor": "XERO_GET_CONFIG_DATA"
}
Response
| Name | Data Type | Description | Example |
| descriptionunkid | String | The Id is getting based on below data.If descriptiontype is RATE TYPE, then you will get RATE TYPE ID | 1234500000000000004 |
| description | String | The description is getting based on the below data.If descriptiontype is RATE TYPE, then you will get RATE TYPE NAME | Daily |
| descriptiontypeunkid | String | It is pre-defined unique Id | 1 |
| descriptiontype | String | Description type id and description type name is below listed according to Header Id and name Header-1: Room Revenue 1: SINGLE LEDGER 2: ROOM NAME 3: ROOM TYPE 4: RATE TYPE 5: ROOM CHARGE 6: TAX 7: SOURCE 8: MARKET CODE Header-2: Extra Charges 1: SINGLE LEDGER 2: EXTRA CHARGE Header-3: Discount 1: SINGLE LEDGER 2: DISCOUNT Header-4: Adjustment 1: SINGLE LEDGER Header-5: Taxes 1: SINGLE LEDGER 2: TAX Header-6: Payment Type 1: SINGLE LEDGER 2: Payment Type Header-7: Folio Transfer 1: SINGLE LEDGER Header-8: Guest Ledger 1: SINGLE LEDGER 3: BUSINESS SOURCE 4: ROOM NAME 5: ROOM TYPE Header-9: Guest Ledger – Customer 1: SINGLE LEDGER Header-10: City Ledger 1: SINGLE LEDGER 2: City Ledger Header-11: City Ledger – Customer 1: SINGLE LEDGER 2: City Ledger Header-12: City Ledger Contra 1: SINGLE LEDGER Header-13: Advance From Guest 1: SINGLE LEDGER Header-14: Cost Center 1: SINGLE LEDGER 2: ROOM NAME Header-15: Room Posting 1: SINGLE LEDGER 3: Tax Percentage Header-16: Paid Out 1: SINGLE LEDGER 2: Paid Out | SINGLE LEDGER, ROOM NAME, RATE TYPE |
| headerid | String | It is pre-defined unique Id | 1 |
| header | String | Header-1: Room Revenue Header-2: Extra Charges Header-3: Discount Header-4: Adjustment Header-5: Taxes Header-6: Payment Type Header-7: Folio Transfer Header-8: Guest Ledger Header-9: Guest Ledger – Customer Header-10: City Ledger Header-11: City Ledger – Customer Header-12: City Ledger Contra Header-13: Advance From Guest Header-14: Cost Center Header-15: Room Posting Header-16: Paid Out | Room Revenue |
Success
[
{
"descriptionunkid": "1",
"description": "Revenue",
"descriptiontypeunkid": "1",
"descriptiontype": "SINGLE LEDGER",
"headerid": "1",
"header": "Room Revenue"
},
{
"descriptionunkid": "123400000000000006",
"description": "30 Flat",
"descriptiontypeunkid": "2",
"descriptiontype": "TAX",
"headerid": "5",
"header": "Taxes"
},
{
"descriptionunkid": "123400000000000001",
"description": "Daily",
"descriptiontypeunkid": "4",
"descriptiontype": "RATE TYPE",
"headerid": "1",
"header": "Room Revenue"
},
{
"descriptionunkid": "123400000000000001",
"description": "Managers Open Discount",
"descriptiontypeunkid": "2",
"descriptiontype": "DISCOUNT",
"headerid": "3",
"header": "Discount"
}
]
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 Bills
A Bill is a container of charges, deposits and payments. This API provides you the detail information of all items posted on the booking invoices. The API can return data in CSV formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
|---|---|---|---|
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| FromDate * | Date | Date From | 2020-07-01 |
| ToDate * | Date | Date To | 2020-07-10 |
Request
{
"authcode": "xxxxxxxxxxxx",
"hotel_code":"xxxx",
"fromdate": "2020-02-01",
"todate": "2020-03-01"
}
Response
| Name | Data Type | Description | Example |
| Unique id | String | Unique id | UNK_123450000000000003_2020-03-28_4 |
| Hotel Name | String | Name of Hotel | Hotel Name |
| Hotel Code | Integer | Hotel unique code | xxxx |
| Folio No | Integer | Folio number | 1 |
| Date | Date | Folio date | 2020-02-03 |
| Voucher No/Receipt No | Integer | Voucher/Receipt number | 3 |
| Invoice Number | String | Invoice Number | A5 |
| Guest Name | String | Guest Full Name | Mr. John |
| Bill To Name | String | Guest/Business Name | ABC Company |
| Guest GST Number | String | Guest GST Number | xxxxxxxxxxxx |
| State | String | State Name | Maharastra |
| Phone Number | String | Guest Phone Number | 123456789 |
| Mobile Number | String | Guest Mobile Number | 123456789 |
| Type | String | Folio type | Extra Charges |
| Particular | String | Particular folio | Welcome Drink |
| Qty | Integer | Particular quantity | 1 |
| Currency | String | Folio Currency | $ |
| Amount | Decimal | folio amount | 100 |
| GST Rate | Float | Total GST Rate | 20,22.5 etc |
| CGST Tax Amount | Float | CGST Tax Amount | 10,100.10 etc |
| SGST Tax Amount | Float | SGST Tax Amount | 10,100.10 etc |
| IGST Tax Amount | Float | IGST Tax Amount | 10,100.10 etc |
| Service Tax | Decimal | Service Tax Amount | 10 |
| Luxury Tax | Decimal | Luxury Tax Amount | 10 |
| Discount | Decimal | Discount Amount | 0 |
| Adjustment | Decimal | Adjustment Amount | 0 |
| Total | Decimal | Total Amount | 120 |
| Is Advance Deposit | String | Is advance deposit | Yes |
| Is Inclusion | String | Is Tax inclusion in amount | Yes |
| Posted By | String | Posted By | admin |
Success
"Unique id","Hotel Name","Hotel Code","Folio No","Date","VoucherNo/ReceiptNo","Invoice Number","Guest Name","Bill To Name","Guest GST Number","State","Phone Number","Mobile Number","Type","Particular","Qty","Currency","Amount","GST Rate","CGST Tax Amount","SGST Tax Amount","IGST Tax Amount","Service Tax","Luxury Tax","Discount","Adjustment","Total","Is Advance Deposit","Is Inclusion","Posted By", "UNK_123450000000104586","Hotel","xxxx","1484","2020-12-01","504-1","5220","Mr. John","Mr. John","","","123456789","123456789","Bank","Cheque","","Rs","-2200","0","0","0","0","0","0","0","0","-2200","Yes","No","admin", "UNK_123450000000104547","Hotel","xxxx","1484","2021-02-28","","5220","Mr. John","ABC Company","","","123456789","123456789","Room Charges","Room Charges","","Rs","1964.28","12","117.86","117.86","0","0","0","0","0","2200","","No","admin",
Error Codes
Property Deactivated: This property has been deactivated OpenAPI Record invalid: Unauthorized Request. Please check hotel code and authentication code OpenAPI Deactivated: Auth Code is inactive. OpenAPI Request: Property is not authorized to access this api.
Finance
Retrieve Hotel Expenses
This API provides you with detailed information on all expenses for a property. The API can return data in CSV formats. The web service responds to HTTP POST requests.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
|---|---|---|---|
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| FromDate * | Date | Date From | 2020-07-01 |
| ToDate * | Date | Date To | 2020-07-10 |
Request
{
"authcode": "xxxxxxxxxxxx",
"hotel_code":"xxxx",
"fromdate": "2020-02-01",
"todate": "2020-03-01"
}
Response
| Name | Data Type | Description | Example |
| Hotel Name | String | Name of Hotel | Hotel Name |
| Hotel Code | Integer | Unique Hotel code | xxxx |
| Voucher Date | Date | Date of Voucher | 2020-05-02 |
| Voucher No | Integer | Voucher number | 1 |
| Contact Info | String | Contact information | Michele B. Wiese |
| Expense Made To | String | Expense made to | GUEST |
| Paid Out | String | Paid out for | Laundry Bill |
| Paid Out Charges | Decimal | Paid Out Charges amount | 100 |
| Paid Out Currency | String | Currency of Paid out | $ |
| Payment Mode | String | Mode of payment | Cash |
| Payment Charges | Decimal | Payment Charges | 10 |
| Payment Currency | String | Currency of Payment | $ |
Success
"HotelName","HotelCode","VoucherDate","VoucherNo","ContactInfo","ExpenseMadeTo","PaidOut","PaidOutCharges","PaidOutCurrency","PaymentMode","PaymentCharges","PaymentCurrency", "Hotel","xxxx","2020-03-18","3","Mr. Michele B. Wiese","GUEST","Laundry Bill","680","$","Cash,Cash,Cash","-680","$",
Error Codes
Property Deactivated: This property has been deactivated OpenAPI Record invalid: Unauthorized Request. Please check hotel code and authentication code OpenAPI Deactivated: Auth Code is inactive. OpenAPI Request: Property is not authorized to access this api.
Finance
Retrieve Extras
This API provides information of extra services available at your property which can be used in mapping or display purposes in the external applications. The API can return data in JSON formats.
URI Request
Request parameters are supplied by appending a question mark (?) to the base URI, followed by a sequence of parameter names and values separated by an ampersand (&).
End Point URL
[BaseUrl]booking/reservation_api/listing.php?[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&language=[LANGUAGE];
Header
Parameter
| Name | Data Type | Description | Example |
| [BaseUrl] * | – | Live server URL | https://live.ipms247.com/ |
| [Request_Type] * | – | Use Keyword “ExtraCharges” | |
| [Hotel_Code] * | INT(11) | Unique Hotel code | XXXX |
| [API_KEY] * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
| [LANGUAGE] | VARCHAR(20) | [Optional] Default is en. Pass language code. Language codes are available here. | en |
Request
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=ExtraCharges&HotelCode=XXX&APIKey=XXX&language=en
Response
| Name | Data Type | Description | Example |
| ExtraChargeId | Integer(20) | Unique id of ExtraCharge | XXXXXXXXXXXXXXXXXX |
| ShortCode | String | ShortCode of ExtraCharge | Transport |
| charge | String | ExtraCharge name | Welcome Drink |
| Description | String | ExtraCharge Description | |
| Rate | Decimal | ExtraCharge Rate | 100 |
| CharegeRule | String | Rule of ExtraCharge | PERQUANTITY |
| PostingRule | String | Rule of posting ExtraCharge | ONLYCHECKOUT |
| ValidFrom | Date | From date of ExtraCharge is valid | 2020-02-03 |
| ValidTo | Date | To Date of Extracharge is valid | 2020-03-03 |
| ischargealways | integer(1) | Is always charge or not, 0: not always charge, 1: always charge | 0 or 1 |
| applyon_rateplan | Integer(20) | Rateplanid where ExtraCharge applied or ALL | XXXXXXXXXXXXXXXXXX |
| applyon_special | Integer(20) | Specialid where ExtraCharge applied or ALL | ALL |
Success
[
{
"ExtraChargeId": "XXXXXXXXXXXXXXXXXX",
"ShortCode": "Bottle of Wine on Arrival", "charge": "Bottle of Wine on Arrival", "description": null,
"Rate": "500.0000", "ChargeRule": "PERQUANTITY",
"PostingRule": "ONLYCHECKOUT", "ValidFrom": null,
"ValidTo": null, "ischargealways": "0",
"applyon_rateplan": "XXXXXXXXXXXXXXXXXX", "applyon_special": ""
},
{
"ExtraChargeId": "XXXXXXXXXXXXXXXXXX",
"ShortCode": "Transport", "charge": "Transport Services", "description": null,
"Rate": "500.0000",
"ChargeRule": "PERBOOKING", "PostingRule": "ONLYCHECKIN", "ValidFrom": null,
"ValidTo": null, "ischargealways": "0", "applyon_rateplan": "ALL", "applyon_special": "ALL"
}
]
Error Codes
| Error Code | Error Name |
| HotelCodeEmpty | Hotel code is empty. |
| NORESACC | This request is valid for Reservation Account only. You may not have opted for Reservation Account Or Hotel Code and Authentication are invalid. |
| UNAUTHREQ | Unauthorized request. This request is not valid for this hotel code. |
| 2 | Cannot Parse Request |
| 5 | Recoverable Error. Equivalent to http 503. |
| CheckDate | Check out date should be greater than Check in date |
| DBConnectError | Database not connected. |
| getExtraChargeListError | Extra Charge List error |
| -1 | No Data found. |
| APIACCESSDENIED | Your property doesn’t have access to API integration or Key is incorrect. Please contact support for this. |
| ParametersMissing | Missing parameters. |
| UnknownError | Unknown Error |
| 4 | Timeout requested. Stops requests for the specified time. |
| InvalidHotelCode | Invalid Hotel code.Please check your property code. |
| BadRequest | Bad request type. |