VehicleAssetEnrgyUse

Represents the fuel consumption related to vehicles. 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
AircraftFuelEconomy
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The fuel economy of the aircraft.
AircraftFuelEconomyInGph
Type
double
Properties
Filter, Nillable, Sort
Description
The fuel economy of the aircraft in gallons per hour.
AircraftFuelEconomyUnit
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the fuel economy of the aircraft.
Possible values are:
  • GALLONS_PER_HOUR—Gallons per Hour
  • LITERS_PER_HOUR—Liters per Hour
AircraftType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of aircraft.
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.
CostCenter
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The cost center associated with this energy use record.
Distance
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The distance traveled. For a fleet vehicle, the distance is calculated if you’ve already entered the fuel efficiency and fuel consumption.
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
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.
FlightDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the flight was taken.
FlightDurationInHours
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The duration of the flight in hours.
FuelConsumption
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The calculated fuel consumption when you enter the distance and fuel effeciency
FuelConsumptionUnit
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the consumed fuel. For custom fuel unit of measure, if the NamespacePrefix exists then this value is {NamespacePrefix}_custom_{DeveloperName of the SustainabilityUom object}; for example, ftPackage_custom_bundle, else this value is custom_{DeveloperName of the SustainabilityUom object}; for example, custom_bundle.
Possible values are:
  • LITERS—Liters
  • UsGallons—US Gallons
  • kWh
FuelEfficiency
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The fuel efficiency value. For a fleet vehicle, the fuel efficiency is calculated if you’ve already entered the distance and fuel consumption.
FuelEfficiencyInMpg
Type
double
Properties
Filter, Nillable, Sort
Description
The fuel efficiency of the vehicle in miles per gallons.
FuelEfficiencyUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the fuel efficiency of the vehicle.
Possible values are:
  • LITRES_PER_100KM—L per 100 km
  • MILES_PER_GALLON—Miles per Gallon
The default value is 'LITRES_PER_100KM'.
FuelType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of fuel consumed for this energy use record. For custom fuels, if the NamespacePrefix exists then this value is {NamespacePrefix}_custom_{DeveloperName of the FuelType object}; for example, ftPackage_custom_wood, else this value is custom_{DeveloperName of the FuelType object}; for example, custom_wood.
Possible values are:
  • AutogasLPG—Autogas/LPG
  • Biodiesel
  • CompressedNaturalGasCNG—Compressed Natural Gas (CNG)
  • Diesel
  • Electricity
  • Ethanol
  • Gasoline
  • JetFuel—Jet Fuel
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'.
IsRecordLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the vehicle asset 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.
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
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.
Scope3GhgCategory
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the scope 3 GHG category for the total scope 3 emissions related to the energy use by the stationary asset environmental source.
Possible values are:
  • Scope3BusinessTravel—Business Travel
  • TotScp3DnstrmLsdAsset—Downstream Leased Asset
  • TotScp3DnstrmTrnspDstr—Downstream Transportation and Distribution
  • TotScp3EmpComut—Employee Commuting
  • TotScp3UpstrmTrnspDstr—Upstream Transportation and Distribution
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.
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
TotalFuelConsumptionInGal
Type
double
Properties
Filter, Nillable, Sort
Description
The total fuel consumed in US gallons.
TotalFuelConsumptionInLiter
Type
double
Properties
Filter, Nillable, Sort
Description
The total fuel consumed in liters. For a private jet, the fuel consumption and fuel consumption unit values are prioritized for calculations over the aircraft fuel economy and aircraft fuel economy unit values. For a fleet vehicle, the total fuel consumption value is the fuel consumption value converted to liters.
VehicleAssetCrbnFtprntId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The vehicle asset carbon footprint record that's associated with this energy use record.
This is a relationship field.
Relationship Name
VehicleAssetCrbnFtprnt
Relationship Type
Lookup
Refers To
VehicleAssetCrbnFtprnt
VehicleAssetEmssnSrcId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The vehicle asset emission source that's associated with this energy use record.
This is a relationship field.
Relationship Name
VehicleAssetEmssnSrc
Relationship Type
Lookup
Refers To
VehicleAssetEmssnSrc

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.

VehicleAssetEnrgyUseChangeEvent (API Version 63.0)
Change events are available for the object.
VehicleAssetEnrgyUseFeed
Feed tracking is available for the object.
VehicleAssetEnrgyUseHistory
History is available for tracked fields of the object.
VehicleAssetEnrgyUseShare
Sharing is available for the object.