GET hotels/{hotelId}/reservations/reservationratedetail/checkedout?key={key}&fromDate={fromDate}&toDate={toDate}

Gets all Reservations with rate detail for the hotel specified that have been checked-out on a specific date range (max. 60 days) and their related Guest Profiles.

Request Information

URI Parameters

Name	Description	Type	Additional information
hotelId	Hotel-Id => checked against the calling applications permissions	string	Required
key	API - Key identifying the caller	string	Required
fromDate	Start of Date Range, Format YYYY-MM-DD	date	Required
toDate	End of Date Range, Format YYYY-MM-DD	date	Required

Body Parameters

None.

Response Information

Resource Description

List of reservationsGuestProfile

Collection of ReservationRateDetail

Name	Description	Type	Additional information
ArrivalDate	The date guest arrive to the hotel	string	None.
BookingNumber	reservation number	string	None.
CancellationNumber	The Cancellation Number that is assigned to a Cancelled Reservation	integer	None.
CentralReservationNumber	Central reservation Number	string	None.
CompRate	Comp Rate ('Y' if $0 rate, or 'N')	string	None.
DepartureDate	The date guest does checking out	string	None.
GuestType	Client Type (System Configuration -> Client Type -> Name)	string	None.
IsGuestTaxExempt	Is guest tax excempt	boolean	None.
LastUpdateDate	Last update date i.e.: date when the reservation was created in RoomKey database, checked-out, cancelled - whichever is the most recent one	string	None.
MarketingCode	Associated with Client Type Grouping found in RoomKey under System Configuration -> Client Types	string	None.
NumberOfActualNights	Number of actual nights guest stay at the hotel	decimal number	None.
NumberOfAdults	Number of adults	integer	None.
NumberOfChildren	Number of childeren	integer	None.
NumberOfNights	Number of booked nights	integer	None.
OtherRevenue	Other revenue except room revenue	decimal number	None.
PackageCode	Code associated with Package booked - found under System Configuration -> Packages and Inclusions -> Short Name	string	None.
PromoCode	Code associated with Online Booking Promotion booked - found under System Configuration -> Online Booking Promotions -> Promo Name	string	None.
PropertyCode	Hotel code	string	None.
RateCode	Rate Code name	string	None.
RecordType	Record Type S = Guest Stay Data, R = reservation Data *Required if reservation Data is sent	string	None.
ReservationDate	Date the reservation is made	string	None.
ReservationRatesWithDetails	Reservation Daily Rates	Collection of ReservationRateWithDetail	None.
ReservationServices	Reservation Guest Service Detail	Collection of ReservationService	None.
ResortFee	Resort Fee	decimal number	None.
RoomNumber	Room number	string	None.
RoomRate	Daily rate of the room	decimal number	None.
RoomRevenue	Room revenue	decimal number	None.
RoomTypeCode	Code of room type	string	None.
SourceOfBusiness	Source of business (SOB), e.g. "Application", "CallCentre", "Email", "Facebook", "Fax", "Instagram", ...	string	None.
Status	Reservation status, i.e. "In House", "Reserved", "Canceled", "Checked out" Endpoints that return only a specific reservation status usually return this field blank.	string	None.
Taxes	Total taxes	decimal number	None.
TotalRevenue	Total revenue: room revenue + other revenue + taxes	decimal number	None.
TotalRevenueWithoutTaxes	Total revenue without taxes: room revenue + other revenue	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ArrivalDate": "sample string 1",
    "BookingNumber": "sample string 2",
    "CancellationNumber": 1,
    "CentralReservationNumber": "sample string 3",
    "CompRate": "sample string 4",
    "DepartureDate": "sample string 5",
    "GuestType": "sample string 6",
    "IsGuestTaxExempt": true,
    "LastUpdateDate": "sample string 8",
    "MarketingCode": "sample string 9",
    "NumberOfActualNights": 10.1,
    "NumberOfAdults": 11,
    "NumberOfChildren": 12,
    "NumberOfNights": 13,
    "OtherRevenue": 14.0,
    "PackageCode": "sample string 15",
    "PromoCode": "sample string 16",
    "PropertyCode": "sample string 17",
    "RateCode": "sample string 18",
    "RecordType": "sample string 19",
    "ReservationDate": "sample string 20",
    "ReservationRatesWithDetails": [],
    "ReservationServices": [],
    "ResortFee": 21.0,
    "RoomNumber": "sample string 22",
    "RoomRate": 23.0,
    "RoomRevenue": 24.0,
    "RoomTypeCode": "sample string 25",
    "SourceOfBusiness": "sample string 26",
    "Status": "sample string 27",
    "Taxes": 28.0,
    "TotalRevenue": 29.0,
    "TotalRevenueWithoutTaxes": 30.0
  },
  {
    "ArrivalDate": "sample string 1",
    "BookingNumber": "sample string 2",
    "CancellationNumber": 1,
    "CentralReservationNumber": "sample string 3",
    "CompRate": "sample string 4",
    "DepartureDate": "sample string 5",
    "GuestType": "sample string 6",
    "IsGuestTaxExempt": true,
    "LastUpdateDate": "sample string 8",
    "MarketingCode": "sample string 9",
    "NumberOfActualNights": 10.1,
    "NumberOfAdults": 11,
    "NumberOfChildren": 12,
    "NumberOfNights": 13,
    "OtherRevenue": 14.0,
    "PackageCode": "sample string 15",
    "PromoCode": "sample string 16",
    "PropertyCode": "sample string 17",
    "RateCode": "sample string 18",
    "RecordType": "sample string 19",
    "ReservationDate": "sample string 20",
    "ReservationRatesWithDetails": [],
    "ReservationServices": [],
    "ResortFee": 21.0,
    "RoomNumber": "sample string 22",
    "RoomRate": 23.0,
    "RoomRevenue": 24.0,
    "RoomTypeCode": "sample string 25",
    "SourceOfBusiness": "sample string 26",
    "Status": "sample string 27",
    "Taxes": 28.0,
    "TotalRevenue": 29.0,
    "TotalRevenueWithoutTaxes": 30.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfReservationRateDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <ReservationRateDetail>
    <ArrivalDate>sample string 1</ArrivalDate>
    <BookingNumber>sample string 2</BookingNumber>
    <CancellationNumber>1</CancellationNumber>
    <CentralReservationNumber>sample string 3</CentralReservationNumber>
    <CompRate>sample string 4</CompRate>
    <DepartureDate>sample string 5</DepartureDate>
    <GuestType>sample string 6</GuestType>
    <IsGuestTaxExempt>true</IsGuestTaxExempt>
    <LastUpdateDate>sample string 8</LastUpdateDate>
    <MarketingCode>sample string 9</MarketingCode>
    <NumberOfActualNights>10.1</NumberOfActualNights>
    <NumberOfAdults>11</NumberOfAdults>
    <NumberOfChildren>12</NumberOfChildren>
    <NumberOfNights>13</NumberOfNights>
    <OtherRevenue>14</OtherRevenue>
    <PackageCode>sample string 15</PackageCode>
    <PromoCode>sample string 16</PromoCode>
    <PropertyCode>sample string 17</PropertyCode>
    <RateCode>sample string 18</RateCode>
    <RecordType>sample string 19</RecordType>
    <ReservationDate>sample string 20</ReservationDate>
    <ReservationRatesWithDetails />
    <ReservationServices />
    <ResortFee>21</ResortFee>
    <RoomNumber>sample string 22</RoomNumber>
    <RoomRate>23</RoomRate>
    <RoomRevenue>24</RoomRevenue>
    <RoomTypeCode>sample string 25</RoomTypeCode>
    <SourceOfBusiness>sample string 26</SourceOfBusiness>
    <Status>sample string 27</Status>
    <Taxes>28</Taxes>
    <TotalRevenue>29</TotalRevenue>
    <TotalRevenueWithoutTaxes>30</TotalRevenueWithoutTaxes>
  </ReservationRateDetail>
  <ReservationRateDetail>
    <ArrivalDate>sample string 1</ArrivalDate>
    <BookingNumber>sample string 2</BookingNumber>
    <CancellationNumber>1</CancellationNumber>
    <CentralReservationNumber>sample string 3</CentralReservationNumber>
    <CompRate>sample string 4</CompRate>
    <DepartureDate>sample string 5</DepartureDate>
    <GuestType>sample string 6</GuestType>
    <IsGuestTaxExempt>true</IsGuestTaxExempt>
    <LastUpdateDate>sample string 8</LastUpdateDate>
    <MarketingCode>sample string 9</MarketingCode>
    <NumberOfActualNights>10.1</NumberOfActualNights>
    <NumberOfAdults>11</NumberOfAdults>
    <NumberOfChildren>12</NumberOfChildren>
    <NumberOfNights>13</NumberOfNights>
    <OtherRevenue>14</OtherRevenue>
    <PackageCode>sample string 15</PackageCode>
    <PromoCode>sample string 16</PromoCode>
    <PropertyCode>sample string 17</PropertyCode>
    <RateCode>sample string 18</RateCode>
    <RecordType>sample string 19</RecordType>
    <ReservationDate>sample string 20</ReservationDate>
    <ReservationRatesWithDetails />
    <ReservationServices />
    <ResortFee>21</ResortFee>
    <RoomNumber>sample string 22</RoomNumber>
    <RoomRate>23</RoomRate>
    <RoomRevenue>24</RoomRevenue>
    <RoomTypeCode>sample string 25</RoomTypeCode>
    <SourceOfBusiness>sample string 26</SourceOfBusiness>
    <Status>sample string 27</Status>
    <Taxes>28</Taxes>
    <TotalRevenue>29</TotalRevenue>
    <TotalRevenueWithoutTaxes>30</TotalRevenueWithoutTaxes>
  </ReservationRateDetail>
</ArrayOfReservationRateDetail>