FrgtHaulingEnrgyUse

Represents the energy consumption related to freight hauling. 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.
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.
Distance
Type
double
Properties
Create, Filter, Sort, Update
Description
The distance travelled by the freight vehicle.
DistanceUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the distance travelled.
Possible values are:
  • Kilometers
  • Miles
  • Nautical Miles
The default value is 'Kilometers'.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until when the values of this energy use record are valid.
FreightHaulingMode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The mode for freight hauling.
Possible values are:
  • Air
  • Rail
  • Road
  • Water
FrgtHaulingEmssnFctrId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The freight hauling emission factors that are used to calculate the emissions.
This is a relationship field.
Relationship Name
FrgtHaulingEmssnFctr
Relationship Type
Lookup
Refers To
FrgtHaulingEmssnFctr
IsRecordLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the freight hauling 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.
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 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
Scope3Category
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The scope 3 freight category to allocate to this energy use record. This value is added to the corresponding scope 3 category in the carbon footprint.
Possible values are:
  • Downstream Transportation and Distribution
  • Upstream Transportation and Distribution
The default value is 'Downstream Transportation and Distribution'.
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 field is automatically associated with an existing carbon footprint record or if a carbon footprint record doesn't exist for that year, a new carbon footprint record is generated based on the asset and start or end dates of the 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.
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
Weight
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The weight transported by the freight vehicle.
WeightUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The unit of measure for the weight transported by the freight vehicle.
Possible values are:
  • KG—kg
  • LB—lb
  • LONG_TON—Long Ton
  • METRIC_TONNE—Metric Tonne
  • SHORT_TON—Short Ton
The default value is 'KG'.

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.

FrgtHaulingEnrgyUseChangeEvent (API Version 63.0)
Change events are available for the object.
FrgtHaulingEnrgyUseFeed
Feed tracking is available for the object.
FrgtHaulingEnrgyUseHistory
History is available for tracked fields of the object.
FrgtHaulingEnrgyUseShare
Sharing is available for the object.