Net Zero Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Net Zero Cloud
Net Zero Cloud Standard Objects
Net Zero Cloud Overview
AirTravelEmssnFctr
AirTravelEnrgyUse
AntiCorruptionInitSum
AnnualEmssnInventory
AnnualEmssnRdctnTarget
BldgEnrgyIntensity
BldgEnrgyIntensityVal
BldgSizeCategory
CleanEnergyProject
ContentLink
ContentSource
CrbnCreditAlloc
CrbnCreditAllocItem
CrbnCreditDistribution
CrbnCreditProject
CrbnEmssnScopeAlloc
CrbnEmssnScopeAllocVal
Disclosure
DisclosureDefinition
DisclosureDefinitionVersion
DisclosureType
DisclsReportingPeriod
DivrsEquityInclSum
EconomicPerformanceSum
ElectricityEmssnFctrSet
EmissionsActivity
EmissionsAllocation
EmissionsForecastFact
EmploymentCompensationSummary
EmpBenefitSummary
EmployeeDevelopmentSum
EmployeeDemographicSum
EmssnRdctnCommitment
EmssnReductionTarget
EnergyAttrCertCredit
EnergyAttrCertPurchase
EnergyAttrCreditDstr
EnvironmentalRisk
FrgtHaulingEmssnFctr
FrgtHaulingEnrgyUse
FuelType
FuelTypeSustnUom
GeneratedWaste
GovtFinancialAsstSum
GroundTravelEmssnFctr
GroundTravelEnrgyUse
InfoLibraryExternalDocument
HotelStayEmssnFctr
HotelStayEnrgyUse
ImpactRiskOpportunity
ImpactRiskOpportunityScore
ImpactRiskOpportunityTopic
ImpcRiskOppAssessment
ImpcRiskOppAssessmentTopic
InflationRate
ManagedCareProgramPrfm
MaterialityAssessment
MaterialityMatrixScore
MaterialityStakeholder
MaterialityStkhldrCatg
MaterialityTopic
MaterialityTopicDocClauseSet
MaterialityTopicQstn
MaterialityTopicReference
OrgIncidentSummary
OtherEmssnFctrSet
OtherEmssnFctrSetItem
PcmtEmssnFctrSet
PcmtEmssnFctrSetItem
ProductEmissionsFactor
ProgramInitiative
ProgramInitiativeEnrl
ReferenceDataLoadLog
RefrigerantEmssnFctr
RentalCarEmssnFctr
RentalCarEnrgyUse
Scope3CrbnFtprnt
Scope3EmssnSrc
Scope3PcmtItem
Scope3PcmtSummary
SearchableReferenceDocument
StnryAssetAnnualFact
StnryAssetCrbnFtprnt
StnryAssetCrbnFtprntItm
StnryAssetEnrgyUse
StnryAssetEnvrSrc
StnryAssetWaterActvty
StnryAssetWaterFtprnt
StnryAssetWtrFtprntItm
SocialContributionSum
Supplier
SupplierProduct
SustainabilityCredit
SustainabilityPurchase
SustainabilityScorecard
SustainabilityUom
SustnUomConversion
TaxDisclosureSummary
VehicleAssetCrbnFtprnt
VehicleAssetEmssnSrc
VehicleAssetEnrgyUse
WasteFootprint
WasteFootprintItem
WstDispoEmssnFctrSet
WstDispoEmssnFctrSetItm
Net Zero Cloud Fields on Standard Objects
Net Zero Cloud Associated Objects
Net Zero Cloud Business APIs
Net Zero Cloud Standard Invocable Actions
Net Zero Cloud Metadata API Types
Net Zero Cloud Tooling API Objects
Net Zero Cloud Fields on Tooling Objects
Net Zero Cloud Calculations
PDF

BldgEnrgyIntensity

Represents the average energy intensity by fuel type across a set of buildings. You can derive this data from published sources. Alternatively, you can do so by using energy use records as the data source and then setting up a window of time with some characteristics of the building size and type. 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
AnnualEnergyIntensityInKwhM2
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The average energy consumption intensity for a year in kWh per square meter. The fuel-specific energy consumption intensities are stored in the associated building energy intensity value records.
AnnualEnergyIntensityInKwhSqft
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The average energy consumption intensity for a year in kWh per square foot. The fuel-specific energy consumption intensities are stored in the associated building energy intensity value records.
AreSysGenEnrgyUseRecIncluded
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
"Indicates whether to include records created when filling data gaps (true) or not (false). Note: Including these records could result in inaccurate calculations."
The default value is 'false'.
AveragePowerUsageEffectiveness
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
AveragingWindowEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until when the energy use records are considered to calculate the building energy intensity.
AveragingWindowStartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from when the energy use records are considered to calculate the building energy intensity.
BldgEnergyIntensityIdentifier
Type
textarea
Properties
Create, Nillable, Update
Description
The unique external identifier for the building energy intensity record.
BuildingAssetType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The stationary asset type of the asset for which the building energy intensity is calculated.
BuildingSize
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
BuildingSizeCategoryId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The building size category record for the stationary asset. You can add appropriate building size ranges by creating or editing building size category records.
This is a relationship field.
Relationship Name
BuildingSizeCategory
Relationship Type
Lookup
Refers To
BldgSizeCategory
BusinessRegion
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The business region. If you select the business region, you can't select the country and state.
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the country. You can enter a country only when you don’t select the business region.
EmissionFactorDataSource
Type
textarea
Properties
Create, Nillable, Update
Description
The source of the emissions factor reference data.
EmissionFactorUpdateYear
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The year when the emissions factor reference data was last updated by a publishing authority.
ExternalIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The external identifier for the emissions factor.
IsRecordLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates that the record is locked for editing.
The default value is false.
LastCalculatedDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the record was most recently calculated.
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.
MaximumBuildingSizeInM2
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The maximum size of the building in square meters. This value is used to calculate building energy intensity.
MaximumBuildingSizeInSqft
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The maximum size of the building in square feet. This value is used to calculate building energy intensity.
MinimumBuildingSizeInM2
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum size of the building in square meters. This value is used to calculate building energy intensity.
MinimumBuildingSizeInSqft
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum size of the building in square meters. This value is used to calculate building energy intensity.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the 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
ReferenceDataLoadLogId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The reference data load log record that's associated with the emissions factor.
This field is a relationship field.
Relationship Name
ReferenceDataLoadLog
Relationship Type
Lookup
Refers To
ReferenceDataLoadLog
RegionalDivision
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The regional division for this building energy intensity record.
Possible values are:
  • EastNorthCentral—East North Central
  • EastSouthCentral—East South Central
  • MiddleAtlantic—Middle Atlantic
  • Mountain
  • NewEngland—New England
  • Pacific
  • SouthAtlantic—South Atlantic
  • WestNorthCentral—West North Central
  • WestSouthCentral—West South Central
ShouldLockDtastUpdtForRec
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the emissions factor record can be locked from dataset updates.
The default value is false.
State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the state. You can enter a state only when you don’t select the business region and don’t enter multiple countries.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

BldgEnrgyIntensityFeed
Feed tracking is available for the object.
BldgEnrgyIntensityHistory
History is available for tracked fields of the object.
BldgEnrgyIntensityShare
Sharing is available for the object.