Generate Bill

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The generateBill operation will return detailed bill information for a specified set of rooms, occupancy levels and dates.

Request

Element		Type	Description
siteID		Integer	(Mandatory) The internal siteID of the property in the IBE.
rateID		Integer	(Mandatory) The internal rateID of the rate in the IBE.
checkinDate		String	(Mandatory) An ISO 8601 format date indicating the check-in date of the guest.
checkoutDate		String	(Mandatory) An ISO 8601 format date indicating the check-out date of the guest.
rooms		Array	(Mandatory) A list of rooms that are being booked on the specified rate.
	roomID	Integer	(Mandatory) The internal roomID of the room in the IBE.
	adults	Integer	(Mandatory) The number of adults in the room.
	child1	Integer	The number of children in the child1 age category in the room. If not specified, a value of 0 is assumed.
	child2	Integer	The number of children in the child2 age category in the room. If not specified, a value of 0 is assumed.
	child3	Integer	The number of children in the child3 age category in the room. If not specified, a value of 0 is assumed.
	child4	Integer	The number of children in the child4 age category in the room. If not specified, a value of 0 is assumed.
	infant	Integer	The number of infants in the infant age category in the room. If not specified, a value of 0 is assumed.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "generateBill",
    "siteID": 1853,
    "rateID": 4241363,
    "checkinDate": "2024-12-12",
    "checkoutDate": "2024-12-13",
    "rooms": [
        {
            "roomID": 4194373,
            "adults": 1
        },
        {
            "roomID": 4194374,
            "adults": 1,
            "child1": 1
        }
    ]
}

Response

Element				Type	Description
bill				Array	The bill array will contain an entry for each roomID specified in the request.
	roomIndex			Integer	The index of the room in the request.
	roomID			Integer	The internal roomID for the room in the IBE.
	billItems			Array	The billItems array will contain an entry for each bill item relevant to this booking.
		date		String	The date the bill item applies to.
		type		String	The type of the bill item.
		title		String	The title of the bill item.
		currency		String	The currency of the bill item.
		quantity		Integer	The quantity of this bill item.
		itemPrice		Integer\|Float	The item price of this bill item.
		subTotal		Integer\|Float	The subtotal of this bill item.
		subTotalIncTax		Integer\|Float	The subtotal of this bill item including taxes.
		taxItems		Array	The taxItems array will contain an entry for each tax item relating to this bill item.
			name	String	The name of the tax item.
			amount	Integer\|Float	The amount of the tax item.
			currency	String	The currency of the tax item.
	total			Integer\|Float	The overall total of all the bill items for this roomID.
	totalIncTax			Integer\|Float	The overall total of all bill items for this roomID including taxes.
billCheckSum				String	An encrypted string representing the values listed in the rest of the response. This is used in the createReservation operation and will be verified to ensure bill details have not been tampered with.
checkoutURL				String	A deep link URL to the checkout page for this reservation.

Sample

{
  "bill": [
    {
      "roomIndex": 1,
      "roomID": 4194373,
      "billItems": [
        {
          "date": "2024-12-12",
          "type": "accomodation",
          "title": "Best Available Rate Room Only / 1 adult",
          "currency": "EUR",
          "quantity": 1,
          "itemPrice": 150,
          "subTotal": 150,
          "subTotalIncTax": 150,
          "taxItems": []
        }
      ],
      "total": 150,
      "totalIncTax": 150
    },
    {
      "roomIndex": 2,
      "roomID": 4194374,
      "billItems": [
        {
          "date": "2024-12-12",
          "type": "accomodation",
          "title": "Best Available Rate Room Only\n1 adult / 1 child (2-5)",
          "currency": "EUR",
          "quantity": 1,
          "itemPrice": 205,
          "subTotal": 205,
          "subTotalIncTax": 205,
          "taxItems": []
        }
      ],
      "total": 205,
      "totalIncTax": 205
    }
  ],
  "billChecksum": "reNJ-9wEBC8FSNznk3gu6nDyjHZ-GKSnfok_Zh6tlfZd_Umc-beSoIydPlf8GaexyWlco3eMyXSCvQw1K0Nhr7axqxv0x7q4z-p5y9bB9Qb_AX5jgj41Dk0LO1fn7aga5kCfaZNHws2DYwgP_hdqEJlP1KpjbcPGWY1xWPIYzT6Jy8wq7q3OnsTXfgKY7FKgX3LyiSnN6H95ZnExWPlngZjb6rPds24cNdKd3bFjz4TRZq4XIEM33SQP33DjaVKBeo1K2dYhy_1SzINXp7d-pKOTyb2vcQ3yIWWgu85EtbchQI-0EO5e_oo7JFzT76XxmBsegiZPOlflXrDEf-YT68ArBRKpgOWHenTznCBrHWJit1d_vj4cqOpbgn2kL3s-Dnv-Fvi4aBsDeb8_z11IdMo_HTGFzb5_P8V03wahpDW47P2N7unzNqqAfZEWWNIDKesg_eTnsmT9jAFdn3TEl2SRFcUR2jsXz-rySW-5ZRy5PvNy4zwKiVOPc89mZ7Opd3D-dnJW-ZtrW19H507QjbhRF95FVYENWs6XobiYfrHz0go88Gaerl1pexhrTUIMzt0yHUMqYvvzDOM5lXm8IL07OHNB5kFeF7TuOqPuhtiBrwEHc3He59MMib7GR1-VY-3Czc0o46vay-889-4kUd5lohcTKH5Keh4NbgTMyWgBCTNE7AUr7lAjPs3RBqKwT1V8iZE65MTiTVf81uiGSSPFg647mMpPHEGGAyYNAl3bIz-HQR8G_4WW2Wk_nZdb7uwuHwH2GNRCZc_sZXUKa3vFkjhUsZxqqJcHotC4nXeCtcghugPfVOjIhftzyMbu",
  "checkoutURL": "http://dev.avvio.com/convert/site/TestHotel%20Mahony/guests.html?rateID=4208974&roomIDs=4194373,4194374&checkin=2024-12-12&nights=1&party=1,0,0,0,0,0;1,1,0,0,0,0&availability=DtSpxyfXoB1yFiAFfRq5SIdMHcjMtrKw5hDjp8jBMSked5hqsXB5O_Azml4rYMHKa4uf5MsQnex9X1qCIKgxaz8g_6qbguYZ56Y9IBYsa11MvbnrT0lbYrwxlPN7eS_KZ9EGrAY4u0A-xoiC8TUFSg"
}