SustainabilityUom | Metadata API Developer Guide

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`.
isWasteUom	Field Type: boolean Description: Indicates whether the unit of measure is used in the generated material waste calculations (`true`) or (`false`). The default value is `false`. This field is available in API version 65.0 and later.
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.

1<?xml version="1.0" encoding="UTF-8"?>
2<SustainabilityUom xmlns="http://soap.sforce.com/2006/04/metadata">
3   <description>Weight in Grams</description>
4   <isProductUom>true</isProductUom>
5   <isProtected>false</isProtected>
6   <isStationaryAssetUom>false</isStationaryAssetUom>
7   <isVehicleAssetUom>false</isVehicleAssetUom>
8   <isWasteUom>true</isWasteUom>
9   <masterLabel>Grams</masterLabel>
10   <unitType>Weight</unitType>
11</SustainabilityUom>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <fullName>Pkg</fullName>
4   <types>
5    <members>Grams</members>
6    <name>SustainabilityUom</name>
7   </types>
8   <version>68.0</version>
9</Package>

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.