Distribute Energy Attribute Certificate Credits Action

Claim renewable electricity usage in stationary asset energy use records. This action assists sustainability managers by allocating renewable energy certificates to these records, streamlining the process of claiming renewable electricity and reducing CO2 emissions.

This action is available in API version 60.0 and later.

Special Access Rules

To access the Distribute Energy Attribute Certificate Credits action, you must have NZCMngEnrgyAttrCertCr org permission enabled. Admin can control user access to this feature in an org using MngEnrgyAttrCertCredit user permission.

Supported REST HTTP Methods

URI: /services/data/v54.0/actions/standard/dstrEnergyAttrCertCredits

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
`allocationMethod`	string	Required. The method used to allocate the specified credits. Valid values are: `Default` `Equally` `HighestEmissionsFirst` `HighestFactorFirst` `StartDateAsc` `StartDateDesc`
`city`	string	The city for which the stationary asset energy use records are filtered.
`country`	string	The country for which the stationary asset energy use records are filtered.
`endDate`	date	The end date to filter stationary asset energy use records. This is a required field when the Stationary Asset Energy Use IDs list is not specified. Valid date format is `YYYY-MM-DD`.
`energyAttributeCertCreditIds`	string	A comma-separated list of energy attribute certificate credit record IDs to be distributed.
`energyAttributeCertPurchaseId`	string	The ID of the energy attribute certificate purchase record to retrieve energy attribute certificate credit records.
`parentCompanyId`	string	The account ID of the parent company to retrieve stationary asset energy use records.
`startDate`	date	The start date to filter stationary asset energy use records. This is a required field when the Stationary Asset Energy Use IDs list is not specified. Valid date format is `YYYY-MM-DD`.
`state`	string	The state for which the stationary asset energy use records are filtered.
`stnryAssetCrbnFtprntId`	string	The ID of the stationary asset carbon footprint record to retrieve stationary asset energy use records.
`stationaryAssetEnergyUseIds`	string	A comma-separated list of stationary asset energy user record IDs for credit assignment

Outputs

Output	Type	Description
`actionDetails`	string	Additional details about the action’s execution.

Example

GET

This example shows how to get information about the Distribute Energy Attribute Certificate Credits action type.

1curl --include --request GET \
2--header "Authorization: Authorization: Bearer 00DR...xyz" \
3--header "Content-Type: application/json" \
4"https://instance.salesforce.com/services/data/v51.0/actions/standard/dstrEnergyAttrCertCredits"

POST

Here’s a request to retrieve records of Stationary Asset Energy Use by applying search filters based on credit IDs.

1{
2  "inputs": [
3    {
4      "allocationMethod": "equally",
5      "startDate": "2015-01-01",
6      "endDate": "2015-12-31",
7      "state": "California",
8      "city": "San Francisco",
9      "energyAttributeCertCreditIds": [
10        "16Uxx0000004MRkEAM",
11        "16Uxx0000002MRTkEAN"
12      ]
13    }
14  ]
15}

Here’s a response for this action.

1[
2  {
3    "actionName": "dstrEnergyAttrCertCredits",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "actionDetails": "The distribution process is in progress. Wait for the process to complete"
8    },
9    "version": 1
10  }
11]