Reference¶

This section describes all available custom functions provided by IBM Envizi for Excel.

Each function calls the IBM Envizi Emissions API from Excel to calculate greenhouse gas (GHG) emissions based on provided inputs.

General Notes¶

All functions must be entered directly into Excel cells.
Arguments in square brackets ([ ]) are optional.
Errors are returned as Excel error messages.
Units must follow the supported unit conventions defined in Envizi.

Functions¶

Location-based Emissions¶

Syntax

=ENVIZI.LOCATION(type, value, unit, country, [stateProvince], [date], [powerGrid])

Parameters

type – Activity type
value – Numeric activity value
unit – Unit of measurement (default: kWh if not specified)
country – ISO alpha-3 country code
stateProvince (optional) – Geographic state or province
date (optional) – Activity date
powerGrid (optional) – Power grid region identifier

—

Alternate Syntax (factorId)

=ENVIZI.LOCATION_BY_FACTORID(factorId, value, [unit])

factorId – Factor ID from Envizi
value – Numeric activity value
unit (optional) – Unit of measurement

Outputs

Column	Description
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e). This is the sum of all GHGs weighted by their global warming potential (GWP).
`CO2`	Direct carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`directCO2`	Direct CO2 emissions explicitly reported when available.
`Unit`	Unit of measurement for the emissions result.
`Description`	Provides details on the factor set used in the calculation.
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Stationary Source Emissions¶

=ENVIZI.STATIONARY(type, value, unit, country, [stateProvince], [date])

=ENVIZI.STATIONARY_BY_FACTORID(factorId, value, unit)

Outputs

Column	Description
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e). This is the sum of all GHGs weighted by their global warming potential (GWP).
`CO2`	Direct carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`directCO2`	Direct CO2 emissions explicitly reported when available.
`Unit`	Unit of measurement for the emissions result.
`Description`	Provides details on the factor set used in the calculation.
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Fugitive Emissions¶

=ENVIZI.FUGITIVE(type, value, unit, country, [stateProvince], [date])

=ENVIZI.FUGITIVE_BY_FACTORID(factorId, value, unit)

Outputs

Column	Description
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e). This is the sum of all GHGs weighted by their global warming potential (GWP).
`CO2`	Direct carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`directCO2`	Direct CO2 emissions explicitly reported when available.
`Unit`	Unit of measurement for the emissions result.
`Description`	Provides details on the factor set used in the calculation.
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Mobile Emissions¶

=ENVIZI.MOBILE(type, value, unit, country, [stateProvince], [date])

=ENVIZI.MOBILE_BY_FACTORID(factorId, value, unit)

Outputs

Column	Description
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e). This is the sum of all GHGs weighted by their global warming potential (GWP).
`CO2`	Direct carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`directCO2`	Direct CO2 emissions explicitly reported when available.
`Unit`	Unit of measurement for the emissions result.
`Description`	Provides details on the factor set used in the calculation.
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Transportation and Distribution¶

=ENVIZI.TRANSPORTATION_AND_DISTRIBUTION(type, value, unit, country, [stateProvince], [date])

=ENVIZI.TRANSPORTATION_AND_DISTRIBUTION_BY_FACTORID(factorId, value, unit)

Outputs

Column	Description
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e). This is the sum of all GHGs weighted by their global warming potential (GWP).
`CO2`	Direct carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`directCO2`	Direct CO2 emissions explicitly reported when available.
`Unit`	Unit of measurement for the emissions result.
`Description`	Provides details on the factor set used in the calculation.
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Calculation¶

=ENVIZI.CALCULATION(type, value, unit, country, [stateProvince], [date], [powerGrid])

=ENVIZI.CALCULATION_BY_FACTORID(factorId, value, unit)

Outputs

Column	Description
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e). This is the sum of all GHGs weighted by their global warming potential (GWP).
`CO2`	Direct carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`directCO2`	Direct CO2 emissions explicitly reported when available.
`Unit`	Unit of measurement for the emissions result.
`Description`	Provides details on the factor set used in the calculation.
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Factor¶

=ENVIZI.FACTOR(type, unit, country, [stateProvince], [date])

=ENVIZI.FACTORBYID(factorId, [unit])

Outputs

Column	Description
`factorSet`	The emission factor dataset used for calculation (e.g., DEFRA, EPA).
`source`	Reference source of the factor (e.g., publication, license link).
`activityType`	Category of data (e.g., Electricity - Scope 3).
`activityUnit`	Unit of input activity data (e.g., kWh, liters).
`name`	Human-readable name of the factor (e.g., “Electricity: UK - 2023”).
`Description`	Text description of the factor (e.g., “Electricity generated”).
`effectiveFrom`	Dates for which the factor is valid from.
`effectiveTo`	Dates for which the factor is valid to.
`publishedFrom`	Publication period of the factor set from.
`publishedTo`	Publication period of the factor set to.
`region`	Geographic region where the factor applies.
`Total CO2e`	The total emissions expressed as carbon dioxide equivalent (CO2e), sum of all GHGs weighted by GWP.
`CO2`	Carbon dioxide (CO2) emissions reported separately.
`CH4`	Methane (CH4) emissions reported separately.
`N2O`	Nitrous oxide (N2O) emissions reported separately.
`HFC`	Hydrofluorocarbon (HFC) emissions reported separately.
`PFC`	Perfluorocarbon (PFC) emissions reported separately.
`SF6`	Sulfur hexafluoride (SF6) emissions reported separately.
`NF3`	Nitrogen trifluoride (NF3) emissions reported separately.
`bioCO2`	Biogenic carbon dioxide (bioCO2) emissions, if applicable.
`indirectCO2e`	Indirect CO2 equivalent emissions reported separately.
`Unit`	Output measurement unit (typically kgCO2e).
`Transaction Id`	Unique identifier for the calculation transaction, used for reference and auditing.

—

Factor Search¶

=ENVIZI.FACTOR_SEARCH(search, country, [stateProvince], [date])

Outputs

Column	Description
`factorSet`	The emission factor dataset used for calculation (e.g., DEFRA, EPA).
`source`	Reference source of the factor (e.g., publication, license link).
`activityType`	Category of data (e.g., Electricity - Scope 3).
`activityUnit`	Unit of input activity data (e.g., kWh, liters).
`region`	Geographic region where the factor applies.
`factorId`	Factor ID from Envizi.

—

Metadata Functions¶

These functions provide data validation dropdowns to help users select valid values for API parameters.

Types¶

Syntax

=ENVIZI.TYPES(apiName)

Parameters

apiName – The name of the API (location, mobile, fugitive, stationary, calculation, transportationanddistribution, factor)

Description

Triggers a data validation dropdown for API types. Applies validation to the cell with available activity types for the specified API.

Example

=ENVIZI.TYPES("location")

—

Units¶

Syntax

=ENVIZI.UNITS(apiName, type)

Parameters

apiName – The name of the API (location, mobile, fugitive, stationary, calculation, transportationanddistribution, factor)
type – The type parameter to fetch units for (e.g., “electricity”)

Description

Triggers a data validation dropdown for API units. Fetches units on-demand from the API based on the specified type and applies validation to the cell.

Example

=ENVIZI.UNITS("location", "electricity")

—

Country¶

Syntax

=ENVIZI.COUNTRY(apiName)

Parameters

apiName – The name of the API (location, mobile, fugitive, stationary, calculation, transportationanddistribution, factor, factorsearch)

Description

Triggers a data validation dropdown for country selection. Fetches available countries from the API and applies validation to the cell with ISO alpha-3 country codes.

Example

=ENVIZI.COUNTRY("location")

—

State Province¶

Syntax

=ENVIZI.STATE_PROVINCE(apiName, country)

Parameters

apiName – The name of the API (location, mobile, fugitive, stationary, calculation, transportationanddistribution, factor, factorsearch)
country – The country alpha-3 code (e.g., “USA”, “CAN”)

Description

Triggers a data validation dropdown for state/province selection. Fetches state/province data for the specified country and applies validation to the cell.

Example

=ENVIZI.STATE_PROVINCE("location", "USA")

—

Power Grid¶

Syntax

=ENVIZI.POWER_GRID(apiName, country)

Parameters

apiName – The name of the API (location, mobile, fugitive, stationary, calculation, transportationanddistribution, factor, factorsearch)
country – The country alpha-3 code (e.g., “USA”, “CAN”)

Description

Triggers a data validation dropdown for power grid selection. Fetches power grid data for the specified country and applies validation to the cell with available power grid region identifiers.

Example

=ENVIZI.POWER_GRID("location", "USA")