Newer Version Available

This content describes an older version of this product. View Latest

HotelStayEnrgyUse

Represents the energy consumption related to hotel stay. This object is available in API version 54.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
CarbonFootprintReportDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the carbon footprint data of the associated stationary asset is due to be sent to a reporting body.
CostCenter
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The cost center associated with this energy use record.
EmissionFctrKgCo2eRoomPerNight
Type
double
Properties
Filter, Nillable, Sort
Description
The emissions that are calculated based on the impact of staying in a hotel. This value is measured in kg of CO2 equivalents per night.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until when the values of this energy use record are valid.
HotelCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city in which the hotel is located
HotelCountry
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The country in which the hotel is located.
Possible values are:
  • AD—Andorra
  • AE—United Arab Emirates
  • AF—Afghanistan
  • AG—Antigua and Barbuda
  • AI—Anguilla
  • AL—Albania
  • AM—Armenia
  • AO—Angola
  • AQ—Antarctica
  • AR—Argentina
  • AT—Austria
  • AU—Australia
  • AW—Aruba
  • AX—Aland Islands
  • AZ—Azerbaijan
  • BA—Bosnia and Herzegovina
  • BB—Barbados
  • BD—Bangladesh
  • BE—Belgium
  • BF—Burkina Faso
  • BG—Bulgaria
  • BH—Bahrain
  • BI—Burundi
  • BJ—Benin
  • BL—Saint Barthélemy
  • BM—Bermuda
  • BN—Brunei Darussalam
  • BO—Bolivia, Plurinational State of
  • BQ—Bonaire, Sint Eustatius and Saba
  • BR—Brazil
  • BS—Bahamas
  • BT—Bhutan
  • BV—Bouvet Island
  • BW—Botswana
  • BY—Belarus
  • BZ—Belize
  • CA—Canada
  • CC—Cocos (Keeling) Islands
  • CD—Congo, the Democratic Republic of the
  • CF—Central African Republic
  • CG—Congo
  • CH—Switzerland
  • CI—Cote d'Ivoire
  • CK—Cook Islands
  • CL—Chile
  • CM—Cameroon
  • CN—China
  • CO—Colombia
  • CR—Costa Rica
  • CU—Cuba
  • CV—Cape Verde
  • CW—Curaçao
  • CX—Christmas Island
  • CY—Cyprus
  • CZ—Czech Republic
  • DE—Germany
  • DJ—Djibouti
  • DK—Denmark
  • DM—Dominica
  • DO—Dominican Republic
  • DZ—Algeria
  • EC—Ecuador
  • EE—Estonia
  • EG—Egypt
  • EH—Western Sahara
  • ER—Eritrea
  • ES—Spain
  • ET—Ethiopia
  • FI—Finland
  • FJ—Fiji
  • FK—Falkland Islands (Malvinas)
  • FO—Faroe Islands
  • FR—France
  • GA—Gabon
  • GB—United Kingdom
  • GD—Grenada
  • GE—Georgia
  • GF—French Guiana
  • GG—Guernsey
  • GH—Ghana
  • GI—Gibraltar
  • GL—Greenland
  • GM—Gambia
  • GN—Guinea
  • GP—Guadeloupe
  • GQ—Equatorial Guinea
  • GR—Greece
  • GS—South Georgia and the South Sandwich Islands
  • GT—Guatemala
  • GW—Guinea-Bissau
  • GY—Guyana
  • HM—Heard Island and McDonald Islands
  • HN—Honduras
  • HR—Croatia
  • HT—Haiti
  • HU—Hungary
  • ID—Indonesia
  • IE—Ireland
  • IL—Israel
  • IM—Isle of Man
  • IN—India
  • IO—British Indian Ocean Territory
  • IQ—Iraq
  • IR—Iran, Islamic Republic of
  • IS—Iceland
  • IT—Italy
  • JE—Jersey
  • JM—Jamaica
  • JO—Jordan
  • JP—Japan
  • KE—Kenya
  • KG—Kyrgyzstan
  • KH—Cambodia
  • KI—Kiribati
  • KM—Comoros
  • KN—Saint Kitts and Nevis
  • KP—Korea, Democratic People's Republic of
  • KR—Korea, Republic of
  • KW—Kuwait
  • KY—Cayman Islands
  • KZ—Kazakhstan
  • LA—Lao People's Democratic Republic
  • LB—Lebanon
  • LC—Saint Lucia
  • LI—Liechtenstein
  • LK—Sri Lanka
  • LR—Liberia
  • LS—Lesotho
  • LT—Lithuania
  • LU—Luxembourg
  • LV—Latvia
  • LY—Libya
  • MA—Morocco
  • MC—Monaco
  • MD—Moldova, Republic of
  • ME—Montenegro
  • MF—Saint Martin (French part)
  • MG—Madagascar
  • MK—Macedonia, the former Yugoslav Republic of
  • ML—Mali
  • MM—Myanmar
  • MN—Mongolia
  • MO—Macao
  • MQ—Martinique
  • MR—Mauritania
  • MS—Montserrat
  • MT���Malta
  • MU—Mauritius
  • MV—Maldives
  • MW—Malawi
  • MX—Mexico
  • MY—Malaysia
  • MZ—Mozambique
  • NA—Namibia
  • NC—New Caledonia
  • NE—Niger
  • NF—Norfolk Island
  • NG—Nigeria
  • NI—Nicaragua
  • NL—Netherlands
  • NO—Norway
  • NP—Nepal
  • NR—Nauru
  • NU—Niue
  • NZ—New Zealand
  • OM—Oman
  • PA—Panama
  • PE—Peru
  • PF—French Polynesia
  • PG—Papua New Guinea
  • PH—Philippines
  • PK—Pakistan
  • PL—Poland
  • PM—Saint Pierre and Miquelon
  • PN—Pitcairn
  • PS—Palestine
  • PT—Portugal
  • PY—Paraguay
  • QA—Qatar
  • RE—Reunion
  • RO—Romania
  • RS—Serbia
  • RU—Russian Federation
  • RW—Rwanda
  • SA—Saudi Arabia
  • SB—Solomon Islands
  • SC—Seychelles
  • SD—Sudan
  • SE—Sweden
  • SG—Singapore
  • SH—Saint Helena, Ascension and Tristan da Cunha
  • SI—Slovenia
  • SJ—Svalbard and Jan Mayen
  • SK—Slovakia
  • SL—Sierra Leone
  • SM—San Marino
  • SN—Senegal
  • SO—Somalia
  • SR—Suriname
  • SS—South Sudan
  • ST—Sao Tome and Principe
  • SV—El Salvador
  • SX—Sint Maarten (Dutch part)
  • SY—Syrian Arab Republic
  • SZ—Swaziland
  • TC—Turks and Caicos Islands
  • TD—Chad
  • TF—French Southern Territories
  • TG—Togo
  • TH—Thailand
  • TJ—Tajikistan
  • TK—Tokelau
  • TL—Timor-Leste
  • TM—Turkmenistan
  • TN—Tunisia
  • TO—Tonga
  • TR—Turkey
  • TT—Trinidad and Tobago
  • TV—Tuvalu
  • TW—Taiwan
  • TZ—Tanzania, United Republic of
  • UA—Ukraine
  • UG—Uganda
  • US—United States
  • UY—Uruguay
  • UZ—Uzbekistan
  • VA—Holy See (Vatican City State)
  • VC—Saint Vincent and the Grenadines
  • VE—Venezuela, Bolivarian Republic of
  • VG—Virgin Islands, British
  • VN—Vietnam
  • VU—Vanuatu
  • WF—Wallis and Futuna
  • WS—Samoa
  • YE—Yemen
  • YT—Mayotte
  • ZA—South Africa
  • ZM—Zambia
  • ZW—Zimbabwe
HotelName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the hotel.
HotelStayEmssnFctrId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The hotel stay mission factors that are used to calculate the emissions.
This is a relationship field.
Relationship Name
HotelStayEmssnFctr
Relationship Type
Lookup
Refers To
HotelStayEmssnFctr
IsRecordLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the hotel stay energy use record is locked for editing because the associated carbon footprint is locked for editing.
The default value is 'false'.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name for this energy use record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
RoomCount
Type
double
Properties
Create, Filter, Sort, Update
Description
The number of rooms in the hotel. This value is used to calculate the emissions.
RoomType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of room.
Scope3CrbnFtprntId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The scope 3 carbon footprint record that's associated with this energy use record.
This is a relationship field.
Relationship Name
Scope3CrbnFtprnt
Relationship Type
Lookup
Refers To
Scope3CrbnFtprnt
Scope3EmissionsInTco2e
Type
double
Properties
Filter, Nillable, Sort
Description
The total scope 3 emissions in metric tonnes of carbon dioxide equivalent.
Scope3EmssnSrcId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The scope 3 emission source that's associated with this energy use record.
This is a relationship field.
Relationship Name
Scope3EmssnSrc
Relationship Type
Lookup
Refers To
Scope3EmssnSrc
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from when the values of this energy use record are valid.
StayNightsCount
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of nights of hotel stay. This value is used to calculate the emissions.
SuplScope3Emissions
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The supplemental scope 3 emissions value that’s added to the calculated total scope 3 emissions value.
SupplierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This is a relationship field.
Relationship Name
Supplier
Relationship Type
Lookup
Refers To
Supplier
TravelerName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the traveler.