emissions-api-sdk 1.0.13 → 1.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/dist/Constants.js +4 -1
- package/dist/api/AuditExport.js +73 -0
- package/dist/api/EconomicActivity.js +45 -0
- package/dist/api/Factor.js +1 -4
- package/dist/api/RealEstate.js +2 -1
- package/dist/coverage/clover.xml +75 -54
- package/dist/coverage/coverage-final.json +8 -7
- package/dist/coverage/lcov-report/index.html +15 -15
- package/dist/coverage/lcov-report/src/Client.ts.html +6 -6
- package/dist/coverage/lcov-report/src/Constants.ts.html +39 -30
- package/dist/coverage/lcov-report/src/api/AuditExport.ts.html +355 -0
- package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +137 -2
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +6 -12
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +6 -3
- package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/index.html +19 -4
- package/dist/coverage/lcov-report/src/index.html +7 -7
- package/dist/coverage/lcov-report/src/request.ts.html +8 -5
- package/dist/coverage/lcov-report/src/utils.ts.html +2 -2
- package/dist/coverage/lcov-report/test/index.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
- package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
- package/dist/coverage/lcov.info +86 -53
- package/dist/index.js +2 -1
- package/dist/interfaces/response/AuditExportResponse.js +2 -0
- package/dist/request.js +1 -0
- package/dist/types/Constants.d.ts +3 -0
- package/dist/types/api/AuditExport.d.ts +42 -0
- package/dist/types/api/EconomicActivity.d.ts +45 -0
- package/dist/types/api/Factor.d.ts +1 -4
- package/dist/types/api/RealEstate.d.ts +2 -1
- package/dist/types/index.d.ts +2 -0
- package/dist/types/interfaces/Config.d.ts +5 -1
- package/dist/types/interfaces/response/AuditExportResponse.d.ts +66 -0
- package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +1 -0
- package/docs/_sources/getting_started.rst.txt +226 -2
- package/docs/_sources/index.rst.txt +2 -0
- package/docs/_sources/reference.rst.txt +22 -0
- package/docs/genindex.html +27 -3
- package/docs/getting_started.html +226 -2
- package/docs/index.html +4 -0
- package/docs/reference.html +267 -4
- package/docs/searchindex.js +1 -1
- package/package.json +6 -5
- package/sphinx-build/source/getting_started.rst +226 -2
- package/sphinx-build/source/index.rst +2 -0
- package/sphinx-build/source/reference.rst +22 -0
- package/src/Constants.ts +3 -0
- package/src/api/AuditExport.ts +90 -0
- package/src/api/EconomicActivity.ts +45 -0
- package/src/api/Factor.ts +2 -5
- package/src/api/RealEstate.ts +2 -1
- package/src/index.ts +9 -1
- package/src/interfaces/Config.ts +6 -1
- package/src/interfaces/response/AuditExportResponse.ts +88 -0
- package/src/interfaces/response/TypeRecommenderResponse.ts +1 -0
- package/src/request.ts +1 -0
- package/test/auditExport.test.ts +68 -0
- package/docs/_static/base-stemmer.js +0 -476
- package/docs/_static/english-stemmer.js +0 -1066
|
@@ -472,8 +472,7 @@
|
|
|
472
472
|
<p>Currency conversion is available for the following calculation methods:</p>
|
|
473
473
|
<ul class="simple">
|
|
474
474
|
<li><p><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></p></li>
|
|
475
|
-
<li><p><code class="docutils literal notranslate"><span class="pre">
|
|
476
|
-
<li><p><code class="docutils literal notranslate"><span class="pre">PhysicalActivity.calculate()</span></code></p></li>
|
|
475
|
+
<li><p><code class="docutils literal notranslate"><span class="pre">Calculation.calculate()</span></code></p></li>
|
|
477
476
|
</ul>
|
|
478
477
|
</section>
|
|
479
478
|
<section id="supported-currencies">
|
|
@@ -1024,6 +1023,224 @@
|
|
|
1024
1023
|
</ul>
|
|
1025
1024
|
</section>
|
|
1026
1025
|
</section>
|
|
1026
|
+
<section id="finance-emissions-apis">
|
|
1027
|
+
<h2>Finance Emissions APIs<a class="headerlink" href="#finance-emissions-apis" title="Link to this heading">¶</a></h2>
|
|
1028
|
+
<p>The SDK supports three scope 3 finance-based emission APIs: <strong>Real Estate</strong>, <strong>Physical Activity</strong>, and <strong>Economic Activity</strong>. Each supports optional PCAF attribution to proportionally allocate emissions.</p>
|
|
1029
|
+
<section id="real-estate">
|
|
1030
|
+
<h3>Real Estate<a class="headerlink" href="#real-estate" title="Link to this heading">¶</a></h3>
|
|
1031
|
+
<p>Real Estate calculates scope 3 emissions from commercial and residential property. Attribution uses <code class="docutils literal notranslate"><span class="pre">propertyValue</span></code> to compute an attribution factor.</p>
|
|
1032
|
+
<p><strong>Without attribution:</strong></p>
|
|
1033
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">RealEstate</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1034
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span><span class="w"> </span><span class="p">},</span>
|
|
1035
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span><span class="w"> </span><span class="p">},</span>
|
|
1036
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1037
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Commercial Real Estate:Office"</span><span class="p">,</span>
|
|
1038
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
1039
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"m2"</span>
|
|
1040
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1041
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
1042
|
+
<span class="p">});</span>
|
|
1043
|
+
</pre></div>
|
|
1044
|
+
</div>
|
|
1045
|
+
<p><strong>With attribution (property value based):</strong></p>
|
|
1046
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">RealEstate</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1047
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span><span class="w"> </span><span class="p">},</span>
|
|
1048
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span><span class="w"> </span><span class="p">},</span>
|
|
1049
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1050
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Commercial Real Estate:Office"</span><span class="p">,</span>
|
|
1051
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
1052
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"m2"</span>
|
|
1053
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1054
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1055
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
|
|
1056
|
+
<span class="w"> </span><span class="s2">"propertyValue"</span><span class="o">:</span><span class="w"> </span><span class="mf">5000000.0</span>
|
|
1057
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1058
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
1059
|
+
<span class="p">});</span>
|
|
1060
|
+
</pre></div>
|
|
1061
|
+
</div>
|
|
1062
|
+
<div class="admonition note">
|
|
1063
|
+
<p class="admonition-title">Note</p>
|
|
1064
|
+
<p>Real estate attribution only accepts <code class="docutils literal notranslate"><span class="pre">propertyValue</span></code>. Using <code class="docutils literal notranslate"><span class="pre">totalEquity</span></code>, <code class="docutils literal notranslate"><span class="pre">totalDebt</span></code>, <code class="docutils literal notranslate"><span class="pre">evic</span></code>, or <code class="docutils literal notranslate"><span class="pre">revenue</span></code> will result in a 400 error.</p>
|
|
1065
|
+
</div>
|
|
1066
|
+
</section>
|
|
1067
|
+
<section id="physical-activity">
|
|
1068
|
+
<h3>Physical Activity<a class="headerlink" href="#physical-activity" title="Link to this heading">¶</a></h3>
|
|
1069
|
+
<p>Physical Activity calculates scope 3 emissions from physical activities. Attribution supports two methods: equity/debt for private companies, or EVIC for listed companies.</p>
|
|
1070
|
+
<p><strong>Without attribution:</strong></p>
|
|
1071
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">PhysicalActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1072
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span><span class="w"> </span><span class="p">},</span>
|
|
1073
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span><span class="w"> </span><span class="p">},</span>
|
|
1074
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1075
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Physical Activity Type"</span><span class="p">,</span>
|
|
1076
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
1077
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kg"</span>
|
|
1078
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1079
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
1080
|
+
<span class="p">});</span>
|
|
1081
|
+
</pre></div>
|
|
1082
|
+
</div>
|
|
1083
|
+
<p><strong>With attribution (equity/debt — private companies):</strong></p>
|
|
1084
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">PhysicalActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1085
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span><span class="w"> </span><span class="p">},</span>
|
|
1086
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span><span class="w"> </span><span class="p">},</span>
|
|
1087
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1088
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Physical Activity Type"</span><span class="p">,</span>
|
|
1089
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
1090
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kg"</span>
|
|
1091
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1092
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1093
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
|
|
1094
|
+
<span class="w"> </span><span class="s2">"totalEquity"</span><span class="o">:</span><span class="w"> </span><span class="mf">3000000.0</span><span class="p">,</span>
|
|
1095
|
+
<span class="w"> </span><span class="s2">"totalDebt"</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
|
|
1096
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1097
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
1098
|
+
<span class="p">});</span>
|
|
1099
|
+
</pre></div>
|
|
1100
|
+
</div>
|
|
1101
|
+
<p><strong>With attribution (EVIC — listed companies):</strong></p>
|
|
1102
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">PhysicalActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1103
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span><span class="w"> </span><span class="p">},</span>
|
|
1104
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span><span class="w"> </span><span class="p">},</span>
|
|
1105
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1106
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Physical Activity Type"</span><span class="p">,</span>
|
|
1107
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
1108
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kg"</span>
|
|
1109
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1110
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1111
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
|
|
1112
|
+
<span class="w"> </span><span class="s2">"evic"</span><span class="o">:</span><span class="w"> </span><span class="mf">10000000.0</span>
|
|
1113
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1114
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
1115
|
+
<span class="p">});</span>
|
|
1116
|
+
</pre></div>
|
|
1117
|
+
</div>
|
|
1118
|
+
<div class="admonition note">
|
|
1119
|
+
<p class="admonition-title">Note</p>
|
|
1120
|
+
<p>Physical activity attribution does not accept <code class="docutils literal notranslate"><span class="pre">propertyValue</span></code> or <code class="docutils literal notranslate"><span class="pre">revenue</span></code>. Use <code class="docutils literal notranslate"><span class="pre">totalEquity</span> <span class="pre">+</span> <span class="pre">totalDebt</span></code> for private companies, or <code class="docutils literal notranslate"><span class="pre">evic</span></code> for listed companies — not both.</p>
|
|
1121
|
+
</div>
|
|
1122
|
+
</section>
|
|
1123
|
+
<section id="economic-activity">
|
|
1124
|
+
<h3>Economic Activity<a class="headerlink" href="#economic-activity" title="Link to this heading">¶</a></h3>
|
|
1125
|
+
<p>Economic Activity calculates scope 3 spend-based emissions. Attribution supports equity/debt, EVIC, or revenue-based allocation.</p>
|
|
1126
|
+
<p><strong>Without attribution:</strong></p>
|
|
1127
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1128
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span><span class="w"> </span><span class="p">},</span>
|
|
1129
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span><span class="w"> </span><span class="p">},</span>
|
|
1130
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1131
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Accomodation"</span><span class="p">,</span>
|
|
1132
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
1133
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
1134
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1135
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
1136
|
+
<span class="p">});</span>
|
|
1137
|
+
</pre></div>
|
|
1138
|
+
</div>
|
|
1139
|
+
<p><strong>With attribution (revenue based):</strong></p>
|
|
1140
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1141
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span><span class="w"> </span><span class="p">},</span>
|
|
1142
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="w"> </span><span class="p">},</span>
|
|
1143
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1144
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"accomodation"</span><span class="p">,</span>
|
|
1145
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
|
|
1146
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
1147
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1148
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1149
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
|
|
1150
|
+
<span class="w"> </span><span class="s2">"revenue"</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
|
|
1151
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1152
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
1153
|
+
<span class="p">});</span>
|
|
1154
|
+
</pre></div>
|
|
1155
|
+
</div>
|
|
1156
|
+
<p><strong>With attribution (equity/debt — private companies):</strong></p>
|
|
1157
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1158
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span><span class="w"> </span><span class="p">},</span>
|
|
1159
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="w"> </span><span class="p">},</span>
|
|
1160
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1161
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"accomodation"</span><span class="p">,</span>
|
|
1162
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
|
|
1163
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
1164
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1165
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1166
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
|
|
1167
|
+
<span class="w"> </span><span class="s2">"totalEquity"</span><span class="o">:</span><span class="w"> </span><span class="mf">3000000.0</span><span class="p">,</span>
|
|
1168
|
+
<span class="w"> </span><span class="s2">"totalDebt"</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
|
|
1169
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1170
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
1171
|
+
<span class="p">});</span>
|
|
1172
|
+
</pre></div>
|
|
1173
|
+
</div>
|
|
1174
|
+
<p><strong>With attribution (EVIC — listed companies):</strong></p>
|
|
1175
|
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
|
|
1176
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span><span class="w"> </span><span class="p">},</span>
|
|
1177
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="w"> </span><span class="p">},</span>
|
|
1178
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1179
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"accomodation"</span><span class="p">,</span>
|
|
1180
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
|
|
1181
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
1182
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1183
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1184
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
|
|
1185
|
+
<span class="w"> </span><span class="s2">"evic"</span><span class="o">:</span><span class="w"> </span><span class="mf">10000000.0</span>
|
|
1186
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1187
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
1188
|
+
<span class="p">});</span>
|
|
1189
|
+
</pre></div>
|
|
1190
|
+
</div>
|
|
1191
|
+
<div class="admonition note">
|
|
1192
|
+
<p class="admonition-title">Note</p>
|
|
1193
|
+
<p><code class="docutils literal notranslate"><span class="pre">propertyValue</span></code> is not supported for economic activity. <code class="docutils literal notranslate"><span class="pre">totalEquity</span></code> and <code class="docutils literal notranslate"><span class="pre">totalDebt</span></code> must always be provided together.</p>
|
|
1194
|
+
</div>
|
|
1195
|
+
</section>
|
|
1196
|
+
<section id="attribution-summary">
|
|
1197
|
+
<h3>Attribution Summary<a class="headerlink" href="#attribution-summary" title="Link to this heading">¶</a></h3>
|
|
1198
|
+
<div class="table-wrapper colwidths-given docutils container">
|
|
1199
|
+
<table class="docutils align-default">
|
|
1200
|
+
<colgroup>
|
|
1201
|
+
<col style="width: 30.0%" />
|
|
1202
|
+
<col style="width: 14.0%" />
|
|
1203
|
+
<col style="width: 20.0%" />
|
|
1204
|
+
<col style="width: 12.0%" />
|
|
1205
|
+
<col style="width: 12.0%" />
|
|
1206
|
+
<col style="width: 12.0%" />
|
|
1207
|
+
</colgroup>
|
|
1208
|
+
<thead>
|
|
1209
|
+
<tr class="row-odd"><th class="head"><p>API</p></th>
|
|
1210
|
+
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">propertyValue</span></code></p></th>
|
|
1211
|
+
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">totalEquity</span></code> + <code class="docutils literal notranslate"><span class="pre">totalDebt</span></code></p></th>
|
|
1212
|
+
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">evic</span></code></p></th>
|
|
1213
|
+
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">revenue</span></code></p></th>
|
|
1214
|
+
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">outstandingAmount</span></code></p></th>
|
|
1215
|
+
</tr>
|
|
1216
|
+
</thead>
|
|
1217
|
+
<tbody>
|
|
1218
|
+
<tr class="row-even"><td><p>Real Estate</p></td>
|
|
1219
|
+
<td><p>✓</p></td>
|
|
1220
|
+
<td><p>✗</p></td>
|
|
1221
|
+
<td><p>✗</p></td>
|
|
1222
|
+
<td><p>✗</p></td>
|
|
1223
|
+
<td><p>Required</p></td>
|
|
1224
|
+
</tr>
|
|
1225
|
+
<tr class="row-odd"><td><p>Physical Activity</p></td>
|
|
1226
|
+
<td><p>✗</p></td>
|
|
1227
|
+
<td><p>✓</p></td>
|
|
1228
|
+
<td><p>✓</p></td>
|
|
1229
|
+
<td><p>✗</p></td>
|
|
1230
|
+
<td><p>Required</p></td>
|
|
1231
|
+
</tr>
|
|
1232
|
+
<tr class="row-even"><td><p>Economic Activity</p></td>
|
|
1233
|
+
<td><p>✗</p></td>
|
|
1234
|
+
<td><p>✓</p></td>
|
|
1235
|
+
<td><p>✓</p></td>
|
|
1236
|
+
<td><p>✓</p></td>
|
|
1237
|
+
<td><p>Required</p></td>
|
|
1238
|
+
</tr>
|
|
1239
|
+
</tbody>
|
|
1240
|
+
</table>
|
|
1241
|
+
</div>
|
|
1242
|
+
</section>
|
|
1243
|
+
</section>
|
|
1027
1244
|
</section>
|
|
1028
1245
|
|
|
1029
1246
|
</article>
|
|
@@ -1105,6 +1322,13 @@
|
|
|
1105
1322
|
<li><a class="reference internal" href="#exchange-rate-data">Exchange Rate Data</a></li>
|
|
1106
1323
|
</ul>
|
|
1107
1324
|
</li>
|
|
1325
|
+
<li><a class="reference internal" href="#finance-emissions-apis">Finance Emissions APIs</a><ul>
|
|
1326
|
+
<li><a class="reference internal" href="#real-estate">Real Estate</a></li>
|
|
1327
|
+
<li><a class="reference internal" href="#physical-activity">Physical Activity</a></li>
|
|
1328
|
+
<li><a class="reference internal" href="#economic-activity">Economic Activity</a></li>
|
|
1329
|
+
<li><a class="reference internal" href="#attribution-summary">Attribution Summary</a></li>
|
|
1330
|
+
</ul>
|
|
1331
|
+
</li>
|
|
1108
1332
|
</ul>
|
|
1109
1333
|
</li>
|
|
1110
1334
|
</ul>
|
package/docs/index.html
CHANGED
|
@@ -264,6 +264,7 @@
|
|
|
264
264
|
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#example-response">Example Response</a></li>
|
|
265
265
|
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#example-response-with-details">Example Response with Details</a></li>
|
|
266
266
|
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#currency-conversion-support">Currency Conversion Support</a></li>
|
|
267
|
+
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#finance-emissions-apis">Finance Emissions APIs</a></li>
|
|
267
268
|
</ul>
|
|
268
269
|
</li>
|
|
269
270
|
<li class="toctree-l1"><a class="reference internal" href="sdk.html">SDK</a><ul>
|
|
@@ -297,6 +298,7 @@
|
|
|
297
298
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#api">API</a></li>
|
|
298
299
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#type-recommender-api">Type Recommender API</a></li>
|
|
299
300
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#audit-log-api">Audit Log API</a></li>
|
|
301
|
+
<li class="toctree-l2"><a class="reference internal" href="reference.html#audit-export-api">Audit Export API</a></li>
|
|
300
302
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#global-metadata-api">Global Metadata API</a></li>
|
|
301
303
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#usage-api">Usage API</a></li>
|
|
302
304
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#interfaces">Interfaces</a></li>
|
|
@@ -332,6 +334,7 @@
|
|
|
332
334
|
<li><p><strong>Transportation & distribution</strong> – logistics and supply chain activities</p></li>
|
|
333
335
|
<li><p><strong>Real Estate</strong> – emissions from commercial and residential properties</p></li>
|
|
334
336
|
<li><p><strong>Economic Activity</strong> – spend-based emissions from business activities</p></li>
|
|
337
|
+
<li><p><strong>Physical Activity</strong> – scope 3 emissions from physical activities with attribution for private companies (equity/debt or EVIC-based)</p></li>
|
|
335
338
|
<li><p><strong>Generic</strong> – custom emission calculations</p></li>
|
|
336
339
|
</ul>
|
|
337
340
|
<p>The SDK is designed for embedding emission calculations in applications, building sustainability dashboards, automating large-scale datasets, and tracking carbon footprints.</p>
|
|
@@ -344,6 +347,7 @@
|
|
|
344
347
|
<li><p><strong>Factor Search API</strong> – search for emission factors with unit and scope filtering, with optional reranker control</p></li>
|
|
345
348
|
<li><p><strong>Usage API</strong> – retrieve organization billing-period or historical usage</p></li>
|
|
346
349
|
<li><p><strong>Audit Log API</strong> – manage whether API requests and responses are stored for auditing</p></li>
|
|
350
|
+
<li><p><strong>Audit Export API</strong> – export, monitor, and download organization audit data</p></li>
|
|
347
351
|
</ul>
|
|
348
352
|
</section>
|
|
349
353
|
</section>
|