---
schema_version: "1"
id: 409f2ab801ec3d67c87e804c7294ee274ec321db1216bac174de2336cef03c5b
title: SustainabilityUom
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_sustainabilityuom.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sustainabilityuom.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 92d58764954fc6dc9c66ec8b44c3cf1b9c0d735529bd049050a30d4d6faac076
description: 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.
---
# 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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d882754e101">Field Name</th>

              <th class="featureTableHeader  " id="d882754e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description of the unit of measure.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isProductUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Indicates whether the unit of measure is for a
                  product that the company has procured in its supply
                  chain operations (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type.</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isStationaryAssetUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Indicates whether the unit of measure is used in the
                  stationary asset calculations (<samp class="codeph nolang">true</samp>) or (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isVehicleAssetUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the unit of measure is used in the vehicle asset calculations
                  (<samp class="codeph nolang">true</samp>) or
                  (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">isWasteUom</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the unit of measure is used in the
                  generated material waste calculations (<samp class="codeph nolang">true</samp>) or (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                <p class="p">This field is available in API version 65.0 and
                  later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The label assigned to this object.</p>

              </td>


            </tr>

            <tr>
              <td class="entry" headers="d882754e101" data-title="Field Name"><span class="keyword parmname">unitType</span></td>

              <td class="entry" headers="d882754e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: UnitType
                  (enumeration of type string)</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The type of unit used for conversions or
                  calculations.</p>

                <p class="p">Values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Energy</samp></li>

                  <li class="li"><samp class="codeph nolang">Other</samp></li>

                  <li class="li"><samp class="codeph nolang">Volume</samp></li>

                  <li class="li"><samp class="codeph nolang">Weight</samp></li>

                </ul>

              </td>


            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a SustainabilityUom component.

<?xml version="1.0" encoding="UTF-8"?>
<SustainabilityUom xmlns="http://soap.sforce.com/2006/04/metadata">
   <description\>Weight in Grams</description\>
   <isProductUom\>true</isProductUom\>
   <isProtected\>false</isProtected\>
   <isStationaryAssetUom\>false</isStationaryAssetUom\>
   <isVehicleAssetUom\>false</isVehicleAssetUom\>
   <isWasteUom\>true</isWasteUom\>
   <masterLabel\>Grams</masterLabel\>
   <unitType\>Weight</unitType\>
</SustainabilityUom\>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <fullName\>Pkg</fullName\>
   <types\>
    <members\>Grams</members\>
    <name\>SustainabilityUom</name\>
   </types\>
   <version\>68.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).