Sync Sustainability Credit

Synchronize your organization’s carbon footprint sustainability credits from the MarketPlace to NetZero Cloud. The API popluates the SustainabilityCredit, SustainabilityPurchase, and CrbnCreditProject records in Netzero Cloud.

Resource

1/connect/sustainability/sync-sustainability-credits

Example URI

1https://yourInstance.salesforce.com/services/data/61.0/connect/sustainability/sync-sustainability-credits

Available version

57.0

Requires Chatter

HTTP methods

POST

Request body for POST

JSON example

1{ 
2        "sustainabilityCarbonCredits":
3        [
4            {
5                "description":"", //optional for integration
6                "sustainabilityPurchaseId": "1Os8N000000KyjGSAS", // External Id for purchase optional for integration
7                "status":"", //optional for integration
8                "crbnCreditProjectId": "01t8N000000Fd86QAC", // External id for Project
9                "creditsIssueDate":"", //optional for integration
10                "creditsRetiredDate":"", //optional for integration
11                "creditsPurchased":1000, //required for integration
12                "creditsUnit":"tCO2e", //required
13                "costPerUnit":"", //optional for integration
14                "vintageYear":"", //optional for integration
15                "purchaseDate":"", //optional for integration
16                "externalIdentifier":"", //required for integration
17                                         //Format : func GUID(Id + OrderItemNumber)
18            },
19            {...}, {...}
20        ]
21        "sustainabilityPurchases":
22        [
23            {
24                "name":"101",//required for integration
25                "type":"CARBON_CREDITS", //required for integration
26                "billingAddress":""{
27                        "street": "",
28                        "city": "",
29                        "state": "",
30                        "postalCode": "",
31                        "country": ""
32                    },//optional for integration
33                "description":"",//optional for integration
34                "purchaseOrderNumber":"",//optional for integration
35                "invoiceNumber":"",//optional for integration
36                "externalIdentifier":"NZM-00000101"//required for integration; 
37                                                   //Format : "NZM-" + <OrderNumber>
38             },
39            {...}, {...}
40        ]
41        "carbonCreditProjects":
42        [
43            {
44                "name":"Wind Farm in New Zealand",//required for integration
45                "mitigationType":"",//optional for integration
46                "projectType":"",//optional for integration
47                "country":"US",//optional for integration
48                "region":"NorthAmerica",//optional for integration
49                "standardAgencyName":"",//optional for integration
50                "voluntaryRegistryName":"Gold Standard",//optional for integration
51                "additionalBenefits":"",//optional for integration
52                "projectUrl":"",//optional for integration
53                "description":"",//optional for integration
54                "fundedBy":"",//optional for integration
55                "verifiedBy":"",//optional for integration
56                "projRegistryIdentifier":"1-56856-912-2",
57                "externalIdentifier":"",//required for integration
58                                        //Format : registry identifier + registry project ID
59                "crbnCrMethodology":""//optional for integration
60             },
61             {...}, {...}
62        ]    
63    }

Properties

Name	Type	Description	Required or Optional	Available Version
`carbonCreditProjects`	Carbon Credit Project Input[]	The details of an environmental project that generates carbon credits by removing greenhouse gases or preventing a certain quantity of greenhouse gases from being released.	Required	57.0
`sustainabilityCarbonCredits`	Sustainability Credit Input[]	The total carbon credit purchased for the carbon credit project, which is the cumulative value of all the associated sustainability credits.	Required	57.0
`sustainabilityPurchases`	Sustainability Purchase Input[]	Information related to the purchase of sustainability credits such as carbon credits.	Required	57.0

Response body for POST

Sync Sustainability Carbon Credit Output

Net Zero Cloud Developer Guide

Sync Sustainability Credit