SustainabilityUom

Represents the unit of measure (UOM) values for custom fuel types in an org. Track fuel consumption and emission results with the flexibility to add custom fuel types and UOM values.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

SustainabilityUom components have the suffix .sustainabilityUom and are stored in the sustainabilityUoms folder.

Version

SustainabilityUom components are available in API version 56.0 and later.

Special Access Rules

The Net Zero Cloud permission set license is required to access this object along with the user access for carbon accounting and org access for custom fuels and UOMs.

Fields

Field Name	Description
description	Field Type string Description The description of the unit of measure.
isProductUom	Field Type boolean Description Indicates whether the unit of measure is for a product that the company has procured in its supply chain operations (`true`) or not (`false`). The default value is `false`.
isProtected	Field Type boolean Description An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is `false`.
isStationaryAssetUom	Field Type boolean Description Indicates whether the unit of measure is used in the stationary asset calculations (`true`) or (`false`). The default value is `false`.
isVehicleAssetUom	Field Type boolean Description Indicates whether the unit of measure is used in the vehicle asset calculations (`true`) or (`false`). The default value is `false`.
masterLabel	Field Type string Description Required. The label assigned to this object.
unitType	Field Type UnitType (enumeration of type string) Description Required. The type of unit used for conversions or calculations. Values are: `Energy` `Other` `Volume` `Weight`

Declarative Metadata Sample Definition

The following is an example of a SustainabilityUom component.

The following is an example package.xml that references the previous definition.

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Net Zero Cloud Developer Guide