Sustainability API

With the Sustainability feature in Business Central, you can create connected apps that establish a point-to-point connection between Business Central and third-party sustainability solutions or services. To do so, you can typically create those connections using the standard REST API to interchange data. Once you have the API access enabled, you can write code that integrates your web service or SaaS solution with the sustainability features in the Business Central.

Note

Learn more about enabling APIs for Business Central in Enabling the APIs for Dynamics 365 Business Central.

sustainabilityAccountCategory

Represents the Sustainability Category in Business Central.

Methods

MethodReturn TypeDescription
GETsustainabilityAccountCategoryGets a sustainabilityAccountCategory object.
POSTsustainabilityAccountCategoryCreates a sustainabilityAccountCategory object.
DELETEnoneDeletes a sustainabilityAccountCategory object.
PATCHsustainabilityAccountCategoryUpdates a sustainabilityAccountCategory object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityAccountCategory. Noneditable.
codestringThe code of sustainabilityAccountCategory.
displayNamestringSpecifies the sustainabilityAccountCategory's name.
emmisionScopestringSpecifies the sustainabilityAccountCategory's emission scope. It can be "Scope 1," "Scope 2," or "Scope 3."
registerCO2booleanSpecifies the sustainabilityAccountCategory that's used to register CO2 emission.
registerCH4booleanSpecifies the sustainabilityAccountCategory that's used to register CH4 emission.
registerN20booleanSpecifies the sustainabilityAccountCategory that's used to register N2O emission.
calculationFoundationTypestringSpecifies the sustainabilityAccountCategory's formulas type.
emissionCalculationCustomValuestringSpecifies the sustainabilityAccountCategory's custom value for using in formulas.

sustainabilityAccountSubcategory

Represents the Sustainability Subcategory in Business Central.

MethodReturn TypeDescription
GETsustainabilityAccountSubcategoryGets a sustainabilityAccountSubcategory object.
POSTsustainabilityAccountSubcategoryCreates a sustainabilityAccountSubcategory object.
DELETEnoneDeletes a sustainabilityAccountSubcategory object.
PATCHsustainabilityAccountSubcategoryUpdates a sustainabilityAccountSubcategory object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityAccountSubcategory. Noneditable.
codestringThe code of sustainabilityAccountSubcategory.
displayNamestringSpecifies the sustainabilityAccountSubcategory's name.
categoryGUIDSpecifies the ID of the sustainabilityAccountSubcategory's category.
emmissionFactorCO2decimalSpecifies the CO2 emission factor for the sustainabilityAccountSubcategory.
emmissionFactorCH4decimalSpecifies the CH4 emission factor for the sustainabilityAccountSubcategory.
emmissionFactorN2OdecimalSpecifies the N2O emission factor for the sustainabilityAccountSubcategory.
renewableEnergybooleanSpecifies if the sustainabilityAccountSubcategory is a part of renewable energy.

sustainabilityAccount

Represents the Sustainability Accounts in Business Central.

MethodReturn TypeDescription
GETsustainabilityAccountGets a sustainabilityAccount object.
POSTsustainabilityAccountCreates a sustainabilityAccount object.
DELETEnoneDeletes a sustainabilityAccount object.
PATCHsustainabilityAccountUpdates a sustainabilityAccount object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityAccount. Noneditable.
numberstringSpecifies the number of sustainabilityAccount.
displayNamestringSpecifies the sustainabilityAccount's name.
categorystringSpecifies the sustainabilityAccount's category.
subcategorystringSpecifies the subcategory of the sustainabilityAccount's category.
accountTypestringThe type of the sustainabilityAccount that the account is related to. It can be "Posting," "Heading," "Total," "Begin Total" or "End Total."

sustainabilityJournalLine

Represents a Sustainability Journal Lines in Business Central.

MethodReturn TypeDescription
GETsustainabilityJournalLineGets a sustainabilityJournalLine object.
POSTsustainabilityJournalLineCreates a sustainabilityJournalLine object.
DELETEnoneDeletes a sustainabilityJournalLine object.
PATCHsustainabilityJournalLineUpdates a sustainabilityJournalLine object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityJournalLine. Noneditable.
journalTemplateNamestringSpecifies the sustainabilityJournalLine's template name.
journalBatchNamestringSpecifies the sustainabilityJournalLine's batch name.
lineNumberintegerThe sustainabilityJournalLine number.
postingDatedateThe date that the journal line is posted.
documentTypestringSpecifies the sustainabilityJournalLine's document type.
documentNumberstringSpecifies a document number for the sustainabilityJournalLine line.
accountNumberGUIDThe ID of the sustainabilityAccount that the sustainabilityJournalLine is related to.
manualInputbooleanSpecifies if manual input of emissions is allowed in the sustainabilityJournalLine.
unitOfMeasureGUIDThe ID of unit of measure for the sustainabilityJournalLine.
fuelOrElectricitydecimalSpecifies the fuel or electricity consumption for the sustainabilityJournalLine.
distancedecimalSpecifies the distance used in the formula for the sustainabilityJournalLine.
customAmountdecimalSpecifies the custom amount used in the formula for the sustainabilityJournalLine.
installationMultiplierdecimalSpecifies the installation multiplier used in the formula for the sustainabilityJournalLine.
timeFactordecimalSpecifies the time factor used in the formula for the sustainabilityJournalLine.
emissionCO2decimalSpecifies the CO2 emission in the sustainabilityJournalLine if the manualInput is TRUE.
emissionCH4decimalSpecifies the CH4 emission in the sustainabilityJournalLine if the manualInput is TRUE.
emissionN2OdecimalSpecifies the N2O emission in the sustainabilityJournalLine if the manualInput is TRUE.
countryRegionGUIDThe country/region ID for the sustainabilityJournalLine.
responsibilityCenterGUIDThe responsibility center ID for the sustainabilityJournalLine.
sourceCodeGUIDThe source code ID for the sustainabilityJournalLine.
reasonCodeGUIDThe reason code ID for the sustainabilityJournalLine.

sustainabilityLedgerEntry

Represents the Sustainability Ledger Entries in Business Central.

MethodReturn TypeDescription
GETsustainabilityLedgerEntryGets a sustainabilityLedgerEntry object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityLedgerEntry. Noneditable.
entryNumberintegerSustainability Entry number.
postingDatedateThe date that the sustainability entry is posted.
documentTypestringSpecifies a document type for the sustainabilityLedgerEntry.
documentNumberstringSpecifies a document number for the sustainabilityLedgerEntry.
accountNumberstringSpecifies the sustainability account code in this specific sustainabilityLedgerEntry.
displayNamestringSpecifies the sustainability account name in this specific sustainabilityLedgerEntry.
emissionScopestringSpecifies the emission scope of the sustainabilityAccountCategory in the sustainabilityLedgerEntry. It can be "Scope 1," "Scope 2," or "Scope 3."
unitOfMeasurestringSpecifies the unit of measure code in the sustainabilityLedgerEntry.
emissionCO2decimalSpecifies the CO2 emission for the sustainabilityLedgerEntry.
emissionCH4decimalSpecifies the CH4 emission for the sustainabilityLedgerEntry.
emissionN2OdecimalSpecifies the N2O emission for the sustainabilityLedgerEntry.
countryRegionstringThe country/region code in the sustainabilityLedgerEntry.
responsibilityCenterstringThe responsibility center code in the sustainabilityLedgerEntry.
userIDGUIDThe user ID in this sustainabilityLedgerEntry.
sourceCodestringThe source code in the sustainabilityLedgerEntry.
reasonCodestringThe reason code in the sustainabilityLedgerEntry.

postedESGReportLine

Represents the Sust. Posted ESG Report Line in Business Central.

Methods

MethodReturn TypeDescription
GETpostedESGReportLineGets a postedESGReportLine object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the postedESGReportLine.
esgReportingTemplateNamestringSpecifies the postedESGReportLine's template name.
esgReportingNamestringSpecifies the postedESGReportLine's reporting name.
lineNostringSpecifies the postedESGReportLine's line number.
groupingstringSpecifies the postedESGReportLine's grouping info.
rowNostringSpecifies the postedESGReportLine's row number.
descriptionstringSpecifies the postedESGReportLine's description.
reportingCodestringSpecifies the postedESGReportLine's reporting code.
conceptLinkstringSpecifies the postedESGReportLine's concept link.
conceptstringSpecifies the postedESGReportLine's concept.
fieldTypestringSpecifies the postedESGReportLine's field type.
tableNointegerSpecifies the postedESGReportLine's table number.
sourcestringSpecifies the postedESGReportLine's source.
fieldNointegerSpecifies the postedESGReportLine's table field number.
fieldCaptionstringSpecifies the postedESGReportLine's field caption.
valueSettingsstringSpecifies the postedESGReportLine's value setting.
accountFilterstringSpecifies the postedESGReportLine's account filter.
reportingUnitstringSpecifies the postedESGReportLine's reporting unit of measure.
rowTypestringSpecifies the postedESGReportLine's row type.
rowTotalingstringSpecifies the postedESGReportLine's row totaling model.
calculateWithstringSpecifies the postedESGReportLine's calculate with information.
showbooleanSpecifies the postedESGReportLine's showing.
showWithstringSpecifies the postedESGReportLine's show with information.
roundingstringSpecifies the postedESGReportLine's rounding precision.

sustainabilityValueEntry

Represents the Sustainability Value Entry in Business Central.

Methods

MethodReturn TypeDescription
GETsustainabilityValueEntryGets a sustainabilityValueEntry object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityValueEntry.
entryNointegerSpecifies the sustainabilityValueEntry's ledger entry number.
typestringSpecifies the sustainabilityValueEntry's document type.
nostringSpecifies the sustainabilityValueEntry's number.
postingDatedateSpecifies the sustainabilityValueEntry's document posting date.
itemLedgerEntryTypestringSpecifies the sustainabilityValueEntry's connected item ledger entry document type.
documentNostringSpecifies the sustainabilityValueEntry's document number.
itemNostringSpecifies the sustainabilityValueEntry's item number.
itemLedgerEntryNostringSpecifies the sustainabilityValueEntry's connected item ledger entry number.
valuedQuantitydecimalSpecifies the sustainabilityValueEntry's already valued quantity.
itemLedgerEntryQuantitydecimalSpecifies the sustainabilityValueEntry's quantity in the item ledger entry.
invoicedQuantitydecimalSpecifies the sustainabilityValueEntry's invoiced quantity.
co2EPerUnitdecimalSpecifies the sustainabilityValueEntry's carbon footprint per unit.
userIDstringSpecifies the sustainabilityValueEntry's user ID.
sourceCodestringSpecifies the sustainabilityValueEntry's source code.
accountNostringSpecifies the sustainabilityValueEntry's account number.
accountNamestringSpecifies the sustainabilityValueEntry's account name.
co2EAmountActualdecimalSpecifies the sustainabilityValueEntry's carbon footprint actual amount.
co2EAmountExpecteddecimalSpecifies the sustainabilityValueEntry's carbon footprint expected amount.
capacityLedgerEntryNointegerSpecifies the sustainabilityValueEntry's capacity ledger entry number.
documentDatedateSpecifies the sustainabilityValueEntry's document date.
documentTypestringSpecifies the sustainabilityValueEntry's document type.
documentLineNostringSpecifies the sustainabilityValueEntry's document line number.
jobNostringSpecifies the sustainabilityValueEntry's project number.
jobTaskNostringSpecifies the sustainabilityValueEntry's project task number.

sustainabilityPurchaseLine

Represents a Purchase Line in Business Central with value tracking information.

MethodReturn TypeDescription
GETsustainabilityPurchaseLineGets a sustainabilityPurchaseLine object.
POSTsustainabilityPurchaseLineCreates a sustainabilityPurchaseLine object.
PATCHsustainabilityPurchaseLineUpdates a sustainabilityPurchaseLine object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityPurchaseLine. Noneditable.
documentTypestringSpecifies the sustainabilityPurchaseLine's document type.
documentNumberstringSpecifies the sustainabilityPurchaseLine's document number.
lineNumberstringSpecifies the sustainabilityPurchaseLine's line number in the document.
nostringSpecifies the sustainabilityPurchaseLine's item number.
descriptionstringSpecifies the sustainabilityPurchaseLine's description.
description2stringSpecifies the sustainabilityPurchaseLine's description 2.
sustAccountNostringSpecifies the sustainabilityPurchaseLine's sustainability account number.
sustAccountNamestringSpecifies the sustainabilityPurchaseLine's sustainability account name.
energySourceCodestringSpecifies the sustainabilityPurchaseLine's energy source code.
quantitydecimalSpecifies the sustainabilityPurchaseLine's quantity.
directUnitCostdecimalSpecifies the sustainabilityPurchaseLine's direct unit cost.
lineDiscountdecimalSpecifies the sustainabilityPurchaseLine's line discount.
lineDiscountAmountdecimalSpecifies the sustainabilityPurchaseLine's line discount amount.
amountIncludingVatdecimalSpecifies the sustainabilityPurchaseLine's amount including VAT.
amountdecimalSpecifies the sustainabilityPurchaseLine's amount.
renewableEnergybooleanSpecifies the sustainabilityPurchaseLine's renewable energy compliance.
emissionCO2decimalSpecifies the sustainabilityPurchaseLine's CO2 emission.
emissionCH4decimalSpecifies the sustainabilityPurchaseLine's CH4 emission.
emissionN2OdecimalSpecifies the sustainabilityPurchaseLine's N2O emission.
energyConsumptiondecimalSpecifies the sustainabilityPurchaseLine's energy consumption amount.
sourceOfEmissionDatastringSpecifies the sustainabilityPurchaseLine's source of emission data.
emissionVerifiedbooleanSpecifies if the sustainabilityPurchaseLine's emission is verified.
cbamCompliancebooleanSpecifies if the sustainabilityPurchaseLine's CBAM status is verified.
invoiceDiscountAmountdecimalSpecifies the sustainabilityPurchaseLine's invoice discount amount.
totalEmissionCostdecimalSpecifies the sustainabilityPurchaseLine's total emission amount.
jobNumberstringSpecifies the sustainabilityPurchaseLine's project number.
currencyCodestringSpecifies the sustainabilityPurchaseLine's currency code.
unitCostdecimalSpecifies the sustainabilityPurchaseLine's unit cost.
lineAmountdecimalSpecifies the sustainabilityPurchaseLine's line amount.

sustainabilityGoal

Represents a Sustainability Goals in Business Central.

MethodReturn TypeDescription
GETsustainabilityGoalGets a sustainabilityGoal object.
POSTsustainabilityGoalCreates a sustainabilityGoal object.
PATCHsustainabilityGoalUpdates a sustainabilityGoal object.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sustainabilityGoal. Noneditable.
scorecardNostringSpecifies the sustainabilityGoal's scorecard number.
nostringSpecifies the sustainabilityGoal's goal number.
lineNostringSpecifies the sustainabilityGoal's line number for the specific goal.
namestringSpecifies the sustainabilityGoal's goal name.
ownerstringSpecifies the sustainabilityGoal's owner.
responsibilityCenterstringSpecifies the sustainabilityGoal's responsibility center.
countryRegionCodestringSpecifies the sustainabilityGoal's country/region code.
unitOfMeasurestringSpecifies the sustainabilityGoal's unit of measure.
startDatedateSpecifies the sustainabilityGoal's start date.
endDatedateSpecifies the sustainabilityGoal's end date.
baselineStartDatedateSpecifies the sustainabilityGoal's baseline start date.
baselineEndDatedateSpecifies the sustainabilityGoal's baseline end date.
baselineForCO2decimalSpecifies the sustainabilityGoal's baseline for CO2.
baselineForCH4decimalSpecifies the sustainabilityGoal's baseline for CH4.
baselineForN2OdecimalSpecifies the sustainabilityGoal's baseline for N2O.
baselineForWasteIntensitydecimalSpecifies the sustainabilityGoal's baseline for waste intensity.
baselineForWaterIntensitydecimalSpecifies the sustainabilityGoal's baseline for water intensity.
currentValueForCO2decimalSpecifies the sustainabilityGoal's CO2 current value.
currentValueForCH4decimalSpecifies the sustainabilityGoal's CH4 current value.
currentValueForN2OdecimalSpecifies the sustainabilityGoal's N2O current value.
currentValueForWasteIntdecimalSpecifies the sustainabilityGoal's waste intensity current value.
currentValueForWaterIntdecimalSpecifies the sustainabilityGoal's water intensity current value.
mainGoalbooleanSpecifies the sustainabilityGoal's main goal.
targetValueForCH4decimalSpecifies the sustainabilityGoal's targeted value for CH4.
targetValueForCO2decimalSpecifies the sustainabilityGoal's targeted value for CO2.
targetValueForN2OdecimalSpecifies the sustainabilityGoal's targeted value for N2O.
targetValueForWasteIntdecimalSpecifies the sustainabilityGoal's targeted value for waste intensity.
targetValueForWaterIntdecimalSpecifies the sustainabilityGoal's targeted value for water intensity.

Sustainability management overview
Sustainability setup
How to record emissions
Working with chart of sustainability accounts and ledger
Ad hoc analysis of sustainability data
Sustainability reports and analytics in Business Central
Work with Business Central