| Name | Description | Type | Additional information |
|---|---|---|---|
| AcceptGeneralEmail |
Accept General Email - "Y" will be sent for yes, "N" will be sent for no (related to your "reservation email") |
string |
None. |
| AddressLine1 |
Guest's first address line |
string |
None. |
| AddressLine2 |
Guest's secound address line |
string |
None. |
| ArrivalDate |
The date guest arrive to the hotel |
string |
None. |
| AvailableCredit |
Guests available credit, Credit Limit minus already accured charges |
decimal number |
None. |
| BookingNumber |
reservation number |
string |
None. |
| CancellationNumber |
The Cancellation Number that is assigned to a Cancelled Reservation |
integer |
None. |
| Cell1 |
Guests main Cell phone |
string |
None. |
| Cell2 |
Guests secondary Cell-Phone (e.g. work) |
string |
None. |
| CentralReservationNumber |
Central reservation Number |
string |
None. |
| City |
Guest's city |
string |
None. |
| CompanyEmailAddress |
Travel agency email address |
string |
None. |
| CompanyFaxNumber |
Travel agency Fax number |
string |
None. |
| CompanyName |
Tarvel agency name |
string |
None. |
| CompRate |
Comp Rate ('Y' if $0 rate, or 'N') |
string |
None. |
| Contact |
Travel agent contact |
string |
None. |
| ContactEmailAddress |
Travel agent contact email address |
string |
None. |
| ContactFaxNumber |
Travel agent contact fax number |
string |
None. |
| CountryCode |
Guest's country code |
string |
None. |
| DepartureDate |
The date guest does checking out |
string |
None. |
| DepositPaid |
Deposit amount that guests pay |
decimal number |
None. |
| EmailAddress |
Guest's email address |
string |
None. |
| FirstName |
Guest's first name |
string |
None. |
| FolioNumber |
Displays lowest Folio number being used on Guest Folio |
integer |
None. |
| GuestId |
Guest Identifier |
string |
None. |
| GuestType |
Client Type (System Configuration -> Client Type -> Name) |
string |
None. |
| IsGuestTaxExempt |
Is guest tax excempt |
boolean |
None. |
| JoinLoyalty |
Guest would like to join loyalty return one, if not zero. |
integer |
None. |
| LastName |
Guest's last name |
string |
None. |
| LastUpdateDate |
Last update date i.e.: date when the reservation was created in RoomKey database, checked-in, checked-out, cancelled - whichever is the most recent one |
string |
None. |
| LoyaltyNumber |
Guests loyalty number |
string |
None. |
| MailToFlag |
Guest wants to receive email |
boolean |
None. |
| MarketingCode |
Associated with Client Type Grouping found in RoomKey under System Configuration -> Client Types |
string |
None. |
| MarketSegment |
Rate Plan Market Segment |
string |
None. |
| MarketingOptIn |
Marketing Opt In - "Y" will be sent for yes, "N" will be sent for no (related to your "marketing campaigns") |
string |
None. |
| MiddleInitial |
[deprecated] Field not available in system |
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. |
| PaymentType |
Type of payment |
string |
None. |
| Phone1 |
Guests main Phone |
string |
None. |
| Phone2 |
Guests secondary phone (e.g. work) |
string |
None. |
| PreferredContactMethod |
[deprecated] Field not available in system |
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. |
| ReservationRates |
Reservation Daily Rates |
Collection of ReservationRate |
None. |
| ReservationServices |
Reservation Guest Service Detail |
Collection of ReservationService |
None. |
| ReservationUniqueIDs |
Reservation Guest Service Detail |
Collection of ReservationUniqueID |
None. |
| ResortFee |
[deprecated] Field not available in system |
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. |
| StateCode |
Guest's state or province |
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. |
| TelephoneNumber |
[deprecated] Please use the Phone1 field |
string |
None. |
| TimeofCheckOut |
The time guest does checking out |
string |
None. |
| Title |
Guest's title |
string |
None. |
| TotalRevenue |
Total revenue: room revenue + other revenue + taxes |
decimal number |
None. |
| TotalRevenueWithoutTaxes |
Total revenue without taxes: room revenue + other revenue |
decimal number |
None. |
| TravelAgent |
Travel Agent name |
string |
None. |
| TravelAgentEmailAddress |
Travel agent email address |
string |
None. |
| TravelAgentFaxNumber |
Travel agent fax number |
string |
None. |
| TravelAgentIATA |
Travel Agent IATA Number |
string |
None. |
| VIP |
VIP indicator |
boolean |
None. |
| VIPCode |
VIP guest's code |
string |
None. |
| ZipCode |
Guest's ZIP code |
string |
None. |
| VehicleLicensePlate |
Guest Vehicle Licence plate # |
string |
None. |
| VehicleMake |
Guest Vehicle Make |
string |
None. |
| VehicleModel |
Guest Vehicle Model |
string |
None. |
| VehicleColor |
Guest Vehicle Color |
string |
None. |
| GroupId | string |
None. |
|
| GroupName | string |
None. |
|
| CorporateId | string |
None. |
|
| CorporateName | string |
None. |
|
| WholeSalerId | string |
None. |
|
| WholeSalerName | string |
None. |