GroundTravelEnrgyUse

Represents the energy consumption related to ground travel. 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.
CostCenter
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The cost center associated with this energy use record.
CurrencyCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The currency in which the expense was made.
Possible values are:
  • AED
  • AFN
  • ALL
  • AMD
  • ANG
  • AOA
  • ARS
  • AUD
  • AWG
  • AZN
  • BAM
  • BBD
  • BDT
  • BGN
  • BHD
  • BIF
  • BMD
  • BND
  • BOB
  • BRL
  • BSD
  • BTN
  • BWP
  • BYN
  • BZD
  • CAD
  • CDF
  • CHF
  • CLP
  • CNY
  • COP
  • CRC
  • CSD
  • CUP
  • CVE
  • CZK
  • DJF
  • DKK
  • DOP
  • DZD
  • EGP
  • ERN
  • ETB
  • EUR
  • FJD
  • FKP
  • GBP
  • GEL
  • GHS
  • GIP
  • GMD
  • GNF
  • GTQ
  • GYD
  • HKD
  • HNL
  • HRK
  • HTG
  • HUF
  • IDR
  • ILS
  • INR
  • IQD
  • IRR
  • ISK
  • JMD
  • JOD
  • JPY
  • KES
  • KGS
  • KHR
  • KMF
  • KPW
  • KRW
  • KWD
  • KYD
  • KZT
  • LAK
  • LBP
  • LKR
  • LRD
  • LYD
  • MAD
  • MDL
  • MGA
  • MKD
  • MMK
  • MOP
  • MRU
  • MUR
  • MWK
  • MXN
  • MYR
  • MZN
  • NAD
  • NGN
  • NIO
  • NOK
  • NPR
  • NZD
  • OMR
  • PAB
  • PEN
  • PGK
  • PHP
  • PKR
  • PLN
  • PYG
  • QAR
  • RON
  • RSD
  • RUB
  • RWF
  • SAR
  • SBD
  • SCR
  • SDG
  • SEK
  • SGD
  • SHP
  • SLL
  • SOS
  • SRD
  • STN
  • SYP
  • SZL
  • THB
  • TJS
  • TND
  • TOP
  • TRY
  • TTD
  • TWD
  • TZS
  • UAH
  • UGX
  • USD
  • UYU
  • UZS
  • VES
  • VND
  • VUV
  • WST
  • XAF
  • XCD
  • XOF
  • XPF
  • YER
  • ZAR
The default value is 'USD'.
Distance
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The distance travelled during the data entry period.
DistanceUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unit of measure for the distance traveled.
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.
ExpenseType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of expense based on which emissions factors are used in the calculations.
Possible values are:
  • Limousine
  • PersonalCarDistance—Personal Car Distance
  • SubwayCrossState—Subway/Train/Trolley - Cross State/Country
  • SubwayLocalTransit—Subway/Train/Trolley - Local Public Transit
  • Taxi
GroundTravelEmssnFctrId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ground travel emission factors that are used to calculate the emissions.
This is a relationship field.
Relationship Name
GroundTravelEmssnFctr
Relationship Type
Lookup
Refers To
GroundTravelEmssnFctr
IsRecordLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the ground travel 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 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
PcmtEmssnFctrSetItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The procurement emissions factor set item that contains the emissions factor to be applied to this procurement item. This field is available in API version 57.0 and later.
This field is a relationship field.
Relationship Name
PcmtEmssnFctrSetItem
Relationship Type
Lookup
Refers To
PcmtEmssnFctrSetItem
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
Scope3GhgCategory
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the scope 3 GHG category for the total scope 3 emissions related to the energy use.
Possible values are:
  • BusinessTravel—Business Travel
  • EmployeeCommuting—Employee Commuting
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
The supplier associated with this record.
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.
TripCost
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The cost of the trip in the selected currency.

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.

GroundTravelEnrgyUseChangeEvent (API Version 63.0)
Change events are available for the object.
GroundTravelEnrgyUseFeed
Feed tracking is available for the object.
GroundTravelEnrgyUseHistory
History is available for tracked fields of the object.
GroundTravelEnrgyUseShare
Sharing is available for the object.