Newer Version Available

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

StnryAssetEnrgyUse

Represents the energy consumption related to stationary assets across multiple fuel types. 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
AllocatedRenewableEnergyInKwh
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The total renewable energy purchased by the organization and allocated to this energy use record.
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.
Ch4EmissionsInKg
Type
double
Properties
Filter, Nillable, Sort
Description
The CH4 emissions that are calculated for this energy use record.
Co2EmissionsInKg
Type
double
Properties
Filter, Nillable, Sort
Description
The CO2 emissions that are calculated for this energy use record.
DataGapFillingMethodName
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The data gap filling method that's used if this record was generated by the application.
Possible values are:
  • BUILDING_BENCHMARK—Building Energy Intensity
  • DAILY_AVERAGE_CURRENT_YEAR—Current Year Daily Average
  • DAILY_AVERAGE_LAST_YEAR—Previous Year Daily Average
  • Manual
  • REGIONAL_BENCHMARK—Regional Building Energy Intensity
ElectricityEmissionFactorsId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The electricity emissions factors record associated with this location.
This is a relationship field.
Relationship Name
ElectricityEmissionFactors
Relationship Type
Lookup
Refers To
ElectricityEmssnFctrSet
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until when the values of this energy use record are valid.
FinalEnergyConsumption
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The final energy consumption calculated using the data gap-filling method.
FuelConsumption
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount of fuel consumed during the data entry period.
FuelConsumptionInGigajoule
Type
double
Properties
Filter, Nillable, Sort
Description
The amount of fuel consumed during the data entry period in GJ (gigajoules).
FuelConsumptionInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The amount of fuel consumed during the data entry period in kWh.
FuelConsumptionUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the consumed fuel.
Possible values are:
  • 1000m3—1000 m3
  • GJ
  • GWh
  • Kiloliters
  • Liters
  • MJ
  • MMBtu
  • MWh
  • Therms
  • Tonnes
  • UkGallons—Uk Gallons
  • UsGallons—Us Gallons
  • ccf
  • kG—kg
  • kWh
  • kcal
  • lbs
  • longTons—long tons
  • m3
  • shortTons—short tons
The default value is 'kWh'.
FuelType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of fuel consumed for this energy use record.
Possible values are:
  • CityGas—City Gas
  • Cooling
  • Diesel
  • Electricity
  • FuelOil—Fuel Oil
  • Heat
  • HeavyOil—Heavy Oil
  • Kerosene
  • LightOil—Light Oil
  • LiquidNaturalGasLNG—Liquid Natural Gas (LNG)
  • NaturalGas—Natural Gas
  • Propane
  • Refrigerant
  • Steam
IsCompanyOwnedAsset
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the asset is owned by the organization.
The default value is 'false'.
IsPueMonthlyRange
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the monthly power usage effectiveness range is between 1 and 2.
The default value is 'false'.
IsRecordLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates that the stationary asset energy use record is locked for editing because the associated carbon footprint is locked for editing.
The default value is 'false'.
IsSystemGeneratedRecord
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the energy use record was created by data gap filling.
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.
LocBasedElectrFrBiomassInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from biomass for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFrNuclearInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from nuclear power for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFrOthrFuelInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from other fuel energy sources for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFromCoalInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from coal for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFromGasInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from gas for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFromHydroInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from hydroelectric energy sources for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFromOilInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from oil for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFromSolarInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from solar photovoltaic energy sources for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBasedElectrFromWindInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from wind for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBsdElectrFrGeothermalInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from geothermal energy sources for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBsdElectrFrNonRenewablesKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from geothermal energy sources for all the associated energy use records, that’s used to calculate emissions using the location-based method.
LocBsdElectrOthrFossilFuelKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from other fossil fuel energy sources for all the associated energy use records, that’s used to calculate emissions using the location-based method.
MktBasedElectrFrBiomassInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from biomass for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFrNuclearInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from nuclear power for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFromCoalInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from coal for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFromGasInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from gas for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFromHydroInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from hydroelectric energy sources for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFromOilInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from oil for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFromSolarInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from solar photovoltaic energy sources for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrFromWindInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from wind for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBasedElectrOthrFuelInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from other fuel energy sources for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBsdElectrFrGeothermalInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from geothermal energy sources for all the associated energy use records, that’s used to calculate emissions using the market-based method.
MktBsdElectrFrNonRenewablesKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The percentage of total non-renewable energy generated from coal, gas, nuclear, oil, and other sources for this market.
MktBsdElectrOthrFossilFuelKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total electricity generated from other fossil fuel energy sources for all the associated energy use records, that’s used to calculate emissions using the market-based method.
N2oEmissionsInKg
Type
double
Properties
Filter, Nillable, Sort
Description
The N2O emissions that are calculated for this energy use record.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name for this energy use record.
NormalizedMoElectrCnsmpInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The normalized value of the average monthly electricity consumption that’s calculated based on the electricity consumption, report start date, and report end date.
OccupiedFloorArea
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The value to override the occupied floor area of the associated stationary asset.
OccupiedFloorAreaInSqft
Type
double
Properties
Filter, Nillable, Sort
Description
The floor area occupied by the stationary asset associated with this energy use record in square foot.
OccupiedFloorAreaUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the occupied floor area of the stationary asset associated with this energy use record.
Possible values are:
  • m2
  • sqft
The default value is 'sqft'.
OtherEmssnFctrId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The other emission factors that are used to calculate the emissions.
This is a relationship field.
Relationship Name
OtherEmssnFctr
Relationship Type
Lookup
Refers To
OtherEmssnFctrSet
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
PowerUsageEffectiveness
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The ratio that describes how efficiently a computer data center uses the energy.
ProposedEnergyConsumption
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The energy consumption proposed by the data gap-filling method
RefrigerantEmssnFctrId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The refrigerant emissions factor record containing global warming potential values.
This is a relationship field.
Relationship Name
RefrigerantEmssnFctr
Relationship Type
Lookup
Refers To
RefrigerantEmssnFctr
RenewableEnergyType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of renewable energy that's accounted for in allocated renewable energy.
Possible values are:
  • BIOMASS—Biomass
  • GEOTHERMAL—Geothermal
  • HYDROELECTRICITY—Hydroelectricity
  • SOLAR—Solar
  • WIND—Wind
Scope1EmissionsInTco2e
Type
double
Properties
Filter, Nillable, Sort
Description
The total scope 1 emissions from all the associated energy use records and supplemental emissions.
Scope2LocBasedEmssnInTco2e
Type
double
Properties
Filter, Nillable, Sort
Description
The total scope 2 emissions value that’s calculated based on the location-based data of grid emissions.
Scope2MktBasedEmssnInTco2e
Type
double
Properties
Filter, Nillable, Sort
Description
The total scope 2 emissions value that's calculated based on the utility-provided emissions data and allocated renewable energy.
Scope3DnstrmEmissionsInTco2e
Type
double
Properties
Filter, Nillable, Sort
Description
The scope 3 emissions from downstream activities. This value is calculated based on the scope 3 downstream emission values and supplemental scope 3 downstream emission values of all the associated energy use records.
Scope3UpstrmEmissionsInTco2e
Type
double
Properties
Filter, Nillable, Sort
Description
The scope 3 emissions from upstream activities. This value is calculated based on the scope 3 upstream emission values and supplemental scope 3 upstream emission values of all the associated energy use records.
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from when the values of this energy use record are valid.
StnryAssetCrbnFtprntId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The stationary asset carbon footprint record associated with this energy use record.
This is a relationship field.
Relationship Name
StnryAssetCrbnFtprnt
Relationship Type
Lookup
Refers To
StnryAssetCrbnFtprnt
StnryAssetEnvrSrcId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The stationary asset environmental source record associated with this energy use record.
This is a relationship field.
Relationship Name
StnryAssetEnvrSrc
Relationship Type
Lookup
Refers To
StnryAssetEnvrSrc
SuplScope1Emissions
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The supplemental scope 1 emissions value that’s added to the calculated total scope 1 emissions value
SuplScope2LocationBasedEmssn
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The supplemental scope 2 location-based emissions value that’s added to the calculated total scope 2 location-based emissions value
SuplScope2MarketBasedEmssn
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The supplemental scope 2 market-based emissions value that’s added to the calculated total scope 2 market-based emissions value
SuplScope3DnstrmEmissions
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The supplemental scope 3 emissions value from downstream activities that’s added to the calculated total scope 3 emissions value
SuplScope3UpstrmEmissions
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The supplemental scope 3 emissions value from upstream activities that’s added to the calculated total scope 3 emissions value
SupplierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The supplier that is associated with this energy use record.
This is a relationship field.
Relationship Name
Supplier
Relationship Type
Lookup
Refers To
Supplier
TotRnwlEnrgyExclHydroInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total renewable energy excluding hydroelectric energy. This value is calculated based on the market-based grid mix values and allocated renewable energy values.
TotalFloorArea
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The value to override the total floor area of the associated stationary asset environmental source.
TotalFloorAreaInSqft
Type
double
Properties
Filter, Nillable, Sort
Description
The total floor area of the stationary asset associated with this energy use record in square foot.
TotalFloorAreaUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the total floor area of the stationary asset associated with this energy use record.
Possible values are:
  • m2
  • sqft
The default value is 'sqft'.
TotalFuelConsumptionInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total fuel consumed in kWh. This value is calculated by multiplying the electricity consumed with the power usage effectiveness value.
TotalRenewableEnergyInKwh
Type
double
Properties
Filter, Nillable, Sort
Description
The total renewable energy in kWh that's calculated based on the market-based grid mix values and the allocated renewable energy value.