DRAFT Carbon Call - Discoverable Data & Metadata (v1.0.230919)

1. Introduction

Carbon accounting has a data problem. This data problem has many compounding causes, many of which can be traced back to a lack of data sharing between organizations. The issue of data sharing can be broken down into 2 basic categories:

• what to share

• how to share

Within each category, there are major subcategories like data discoverability and privacy that also need to be addressed. There are multiple initiatives across the industry to address these issues, but they are not being designed in a way that will allow them to work together. This specification will help connect these initiatives and provide a framework for future initiatives to be designed in a way that will allow them to work together. Some basic capabilities need to be provided in order to effectively enable data sharing.

Carbon Call is working on establishing a common smart dictionary to help establish a baseline of common terms and definitions so that parties can agree on the language of carbon accounting. We also need to establish what data needs to be shared in a way that is extensible for industry sectors and different jurisdictions. Common infrastructure for how to share data is also needed, which includes the ability to discover and control who can access the data.

This framework is primarily concerned with what to share, via a flexible data model that can allow for organizations to share standard reporting metadata as well as establish context or defined extensions to support custom metadata between organizations or well understood vertical industry metadata.

For example, the Metadata Framework would allow for one organization to request a custom set of metadata that is only relavent to their business relationship and would be meaningless to other parties. This ad hoc metadata can then be added to the metadata messages passed between the organizations and be machine readable and understood without manual intervention. These are refered to as PropertyContextExtension for individual properties or MetaTag for the entire report, in the framework.

For metadata that would be highly relavent for a certain industry vertical, like manufacturing or retail, a defined metadata extension can be established and reused by organizations in those verticals without having to negotiate what the metadata messages would be up front. These are refered to as MetadataExtension extensions in the framework.

Metadata produced in the framework follows the discoverable data identifier recommend and the metadata will travel with a report by having the same GRID. For consideration, would be the use this same framework for non-reporting data sharing between organizations. For example, the WBCSD:PACT initiative has defined the Pathfinder 2.0 Framework for the exchanging of Product Footprint data, which includes the Product Carbon Footprint (PCF). It defines a data model or schema for what a Product Footprint looks like, or the what to share, as well as a way to establish MetadataExtension. It does not define a way to allow for organizations to define ad hoc requests for additional metadata. This metadata framework could also support the ability for organizations to request additional metadata about portions of a PCF that could be restricted or not relavent to other organizations.

How to share metadata can be more complex. It is recommended that for public, non-restricted metadata to travel alongside regular reporting channels with the enhanced discovery capabilities using GRID. For the sharing of restricted or private data where control of sharing is desired, it is recommended that the Carbon Call follow the emerging Data Spaces standards in development. Data Spaces address broad requirements for establishing data sharing networks where organizations can control what data they share as well as discover data that is available by other parties using multi-layered policy and data sharing contracts. A 1.0 Data Space specification standard is expected to be completed by the Eclipse Foundation in early 2024 and interoperable vendor implementations are expected to follow to become more widely available.

The Carbon Call Metadata Framework will be designed to be compatible with the Data Space specification and will be updated as the Data Space specification evolves.

This specification is a work in progress and is subject to change. It is not a final or otherwise published version.

1.1. Status of this Document

Comments regarding the document are welcome, please file issues directly on GitHub.

1.2. Scope

The scope of this document is to reach consensus on a Discoverable Sustainability Dat and Metadata.

1.3. Intended Audience

This technical specification is for

• software developers who want to build software to edit, exchange or store data in the format defined by this specification

• business analysts who want to understand the data model and data dictionary defined by this specification

• data scientists who want to understand the data model and data dictionary defined by this specification

• anyone else who wants to understand the data model and data dictionary defined by this specification

1.4. About the Carbon Call Discoverable Data & Metadata Expert Workgroups

The Carbon Call Discoverable Data & Metadata Expert Workgroups is a group of experts from the Carbon Call community who are working to define a how sustainability data can be made discoverable and usable with the use of and inclusion of metadata.

1.5. Disclaimer

While Carbon Call encourages the implementation of the technical specifications by all entities for interoperability, those organiazations and individuals who contributed to the development of this document does not assume responsibility for any consequences or damages resulting directly or indirectly from the use of this document.

1.6. License

The license can be found in Appendix A: License.

2. Terminology

Carbon Call

Carbon Call is a community of sustainability experts who are working together to define a common data model and data dictionary for sustainability data.

Report

A sustainability report is a document that describes the sustainability performance of an organization, a product, or a service. A sustainability report is also known as a sustainability disclosure, a sustainability statement, or a sustainability data sheet.

Product Footprint

A WBCSD:PACT Product Footprint a specification for a product footprint that is based on the WBCSD:PCF Product Carbon Footprint methodology. This framework is interoperable with the Pathfinder network and provides footprint extensions.

Dataspace

A Dataspace is an open specification for establishing data sharing networks between organizations to facilitate controlled sharing of data.

Metadata

Metadata is data that describes other data. Metadata is used to provide information about the data, such as how it was created, when it was last updated, and how it should be interpreted.

Report Metadata

A Sustainability Report Metadata is a set of metadata about a sustainability report that is used to discover, understand, and use the sustainability report.

Metatag

A simple name/value pair that is used to describe a piece of metadata.

Context

Metadata is applied to a context, i.e., a report, a section of a report, a property, etc. The context is the thing that the metadata is describing.

Report Context

Metadata that applies to the entire report.

Property Context Extension

Metadata that applies to a property of the report, e.g., a section or an individual property.

Global Report Identifier (GR.ID)

A Global Report Identifier (GR.ID) is a unique identifier for a sustainability report. The Global Report Identifier (GR.ID) is generated by the GR.ID platform collects a range of metadata about the report, and then calculates a unique hash (or fingerprint) for the report.

3. Discoverable Data and Metadata

Discoverable data defines the way data is packaged, identified and made available for discovery. Discoverable data is a key component of the Carbon Call data model and data dictionary. A part of the data be discovered are a set of metadata that describes the data. The metadata is used to discover, understand, and use the data.

3.1. Sustainability Report Schema

A report schema is a set of normative data elements that identify a report and describe the data contained in the report. The report schema is used to validate the report data and also provide a set of metadata about the report.

3.1.1. Properties

The Sustainability Report has the following properties:

3.2. Data Type: Metadata

Report Metadata contains non-normative information about the targeted report and its contents. Typically a report will follow a normative standard, or a defined set of rules, and the metadata will provide information about the report that is not covered by the standard. For example, the metadata may contain information about the organization that produced the report, the reporting period, the industry, the assurance provider, etc.

Here we have defined a set of normative metadata tags and also provide a mechanism for adding non-normative metadata tags that can be attached to a report or property context. See § 3.11 Data Type: Metatag for details.

3.2.1. Properties

A metadata object has the following properties:

3.3. Data Type: TimePeriod

A reporting period is a set of reporting period elements that describe the reporting period of a sustainability report.

3.3.1. Properties

3.4. Data Type: Industry

An industry is a set of industry elements that describe the industry of an organization.

3.4.1. Properties

Industry has the following properties:

3.5. Data Type: Activity

An activity, e.g., heating, cooling, & lighting a facility, travel, transportation, purchase. The activity metadata element can scope metatdata around a specific activity contained in the report.

3.5.1. Properties

Activity has the following properties:

3.6. Data Type: FactorAndSource

A factor and source is a set of factor and source elements that describe the factor and source of an activity.

3.6.1. Properties

Factor and source has the following properties:

3.7. Data Type: Governance

A governance is a set of governance elements that describe the governance the organization follows in the report.

3.7.1. Properties

Governance has the following properties:

3.8. Data Type: Methodology

A methodology is a set of methodology elements that describe the methodology used to prepare the report.

3.8.1. Properties

Methodology has the following properties:

3.9. Data Type: GeographicLocation

The GeographicLocation is a data type that can represent a GNSS/GPS point location for projects like a facility or building and or a geographic area, like a land project using a polygon represented as a string or file. *Either the longitude and latitude or the string or file for the area must have a value.

3.9.1. Properties

3.10. Data Type: PrecisionMix

The mix of precision, by percentage, of the measurement specification used for the activity. The sum of all the mixes must be 100 for 100%.

3.10.1. Properties

3.11. Data Type: Metatag

A metatag is a user defined key-value pair that represents a metadata element. The key is a string that represents the name of the metadata element, and the value is a string that represents the value of the metadata element.

3.11.1. Properties

Metatag has the following properties:

3.12. Data Type: Metalink

A metalink is a URI or JSON path to other metadata related to the metadata it is attached to.

3.12.1. Properties

Metalink has the following properties:

3.13. Data Type: PropertyContextExtension

A property context allows for a grouping of metatags that are associated with a specific property. For example, a property context may be used to group metatags that are associated with a specific indicator, or a specific aspect.

3.13.1. Properties

PropertyContextExtension has the following properties:

3.14. Data Type: MetadataExtension

A metadata extension is a Json schema based extension that can be used to store data that is defined by another specification, industry or agreement.

3.14.1. Properties

3.15. Metadata Extension Schema File: MetadataExtensionDefinition

Every extension MUST define a valid JSON Schema document according to the JSON Schema specification. The extension schema file defines the data encoding and syntactical data validation details.

Authors of extension schema definitions SHOULD attempt to add as many validation rules as possible such that data validation can be automated as much as possible.

Extension schemas SHOULD be defined in a way to make illegal extension representations unrepresentable.

Additional details which are not representable in JSON Schema such as data semantics or validation rules, MUST be defined in the extension documentation (§ 3.16 Extension Documentation: ExtensionDocumentation).

3.16. Extension Documentation: ExtensionDocumentation

The extension documentation is a human-readable document that describes the extension in detail. Extension document MUST be written in English. The documentation CAN be offered as a translation in other languages as well.

The documentation MUST include:

1. Version of the extension and the document. The value MUST be a string in the format major.minor.patch as defined in Semantic Versioning 2.0.0.

2. If the extension was updated, the document MUST include a changelog. The changelog MUST contain a summary of the changes between subsequent versions.

3. A description of the extension, including the business case addressed by the extension and the business value gained by extending the Pathfinder Data Model. 2.1 This includes methodological alignment of the extension, especially covering the alignment with the Pathfinder Framework if applicable.

4. A public URL to the § 3.15 Metadata Extension Schema File: MetadataExtensionDefinition.

5. A license declaration covering the documentation, the extension schema file, and their use.

6. Electronic contact information on how to get in touch with the authors and maintainers of the extension.

3.17. Data Type: ProductFootprintExtension

A Product Footprint Extension is a set of metadata that is a companion to a Product Footprint. This extension is used to provide additional metadata about the product footprint, some of which can be private and only shared under a Dataspace contract.

3.17.1. Properties

A Product Footprint Extension has the following properties:

3.18. Data Type: Id

A Id MUST either be a UUID v4 as specified in [RFC4122].

or a unique key that can be represented as a string.

3.18.1. JSON Representation

Each Id MUST be encoded as a JSON String, see § 3.20.1 JSON Data Representation for details.

Example JSON string value:

3.19. Data Type: Decimal

A dotted-decimal number.

Example values:

3.19.1. JSON Representation

Each Decimal MUST be encoded as a JSON String.

3.20. Data Type: String

A regular UTF-8 String.

3.20.1. JSON Data Representation

Each String MUST be encoded as a JSON String.

3.21. Data Type: GRID

A Unique 8 digit alphanumeric identifier. Omits [0/O | 1/I] to avoid ambiguity, case insensitive. Example: R3AK.XF9B.24, where part1 = R3AK and part2 = XF9B, separated by a dot. The postfix checksum is 24 separated by a dot. has a 2 digit numeric checksum, postfix, used to avoid typos in situations where the GRID is retyped.

3.21.1. JSON Representation

Each GRID MUST be encoded as a JSON String, see § 3.20.1 JSON Data Representation for details.

Example JSON string value:

3.22. Data Type: ReportFormat

The format of the report, this is a non-exhastive list and needs expanding. The value MUST be one of the following:

NO_REPORT_FORMAT

for No Report Format

PDF

for PDF

HTML

for HTML

DOCX

for DOCX

XLSX

for XLSX

CSV

for CSV

XML

for XML

JSON

for JSON

XBRL

for XBRL

3.22.1. JSON Representation

Each ReportFormat MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

3.23. Data Type: ReportingStandard

The reporting standard used for the report, this is a non-exhastive list and needs expanding. The value MUST be one of the following:

NO_REPORTING_STANDARD

for No Reporting Standard

GRI

for Global Reporting Initiative

CDP

for CDP, formerly Carbon Disclosure Project

SASB

for Sustainability Accounting Standards Board

IR

for International Integrated Reporting Council

3.23.1. JSON Representation

Each ReportingStandard MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

3.24. Data Type: ReportType

The type of report, this is a non-exhastive list and needs expanding. The value MUST be one of the following:

NO_REPORT_TYPE

for No Report Type

ANNUAL_REPORT

for Annual Report

FINANCIAL_REPORT

for Financial Report

PROXY_STATEMENT

for Proxy Statement

CSRD_REPORT

for Corporate Sustainability Report Declaration Report

CDP

for CDP, formerly Carbon Disclosure Project, Report

SASB

for Sustainability Accounting Standards Board Report

3.24.1. JSON Representation

Each ReportType MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

3.25. Data Type: MethodologyType

The methodology used for the report, this is a non-exhastive list and needs expanding. The value MUST be one of the following:

UNKNOWN

for Unknown

GHG_PROTOCOL

for GHG Protocol

ISO_14067

for ISO 14067

OTHER

for Other

3.25.1. JSON Representation

Each MethodologyType MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

3.26. Data Type: BoundaryApproach

The boundary approach used for the report, this is a non-exhastive list and needs expanding. The value MUST be one of the following:

OPERATIONAL_CONTROL

for Operational Control

FINANCIAL_CONTROL

for Financial Control

EQUITY_SHARE

for Equity Share

3.26.1. JSON Representation

Each BoundaryApproach MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

3.27. Data Type: Unit

Unit is the enumeration of accepted declared units with values, not complete.

liter

for unit liter

kilogram

for unit kilogram

cubic meter

for cubic meter

kilowatt

for kilowatt

megawatt

for megawatt

megajoule

for megajoule

ton kilometer

for ton kilometer

square meter

for square meter

TONNE_CO2E

for tonne of CO2e

TONNE_CO2

for tonne of CO2

TONNE_CH4

for tonne of CH4

TONNE_N2O

for tonne of N2O

MwH

for megawatt hour

KwH

for kilowatt hour

3.27.1. JSON Representation

The value of each Unit MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

3.28. Data Type: FactorType

FactorType is the enumeration of accepted declared factor types with values.

UNKNOWN

for Unknown

ESTIMATED

for Estimated

FACTORED

for Factored

MEASURED

for Measured

3.28.1. JSON Representation

The value of each FactorType MUST be encoded as a JSON String, see § 3.20 Data Type: String for details.

4. Samples

4.1. Sustainability Report

{
  "grid": "7DT6.R5BF.32",
  "metadata": {
    "grid": "7DT6.R5BF.32",
    "organizationIdentifier": "LEI: 254900OPPU84GM83MG36",
    "organizationName": "CarbonCall",
    "domicile": "US",
    "operatingCountries": [
      "US",
      "CN",
      "GB"
    ],
    "languages": [
      "En",
      "Zh"
    ],
    "reportType": "SustainabilityReport",
    "reportIssueDate": "2021-01-01",
    "reportingPeriod": {
      "startDate": "2020-01-01",
      "endDate": "2020-12-31"
    },
    "reportReplaces": "",
    "location": "https://carboncall.io/reportFromPeriod.json",
    "industry": {
      "prefix": "ISIC",
      "code": "6201"
    },
    "performance": "{'Perf1':{'name':'Perf1','type':'performance','value':127000,'unit':'tCO2e'},'Perf2':{'name':'Perf2','type':'performance','value':0,'min':0,'max':100,'step':1,'unit':'%'}} ",
    "goverance": {
      "intendedUse": "Public",
      "restrictedAccess": false,
      "reportOwner": "CarbonCall"
    },
    "methodology": {
      "methodologyType": "GhgProtocol",
      "percentageOfTotalPortfolioReported": "100",
      "percentageOfEstimatedCalculations": "82",
      "boundaryApproach": "OperationalControl"
    },
    "reportFormat": "IXBRL",
    "reportingStandard": "ISSB",
    "assurance": "DE_BaFIN: 1234567890",
    "priorReport": "",
    "reportHash": "dftaae3297i89798adsdf832adfs912231azsdf",
    "activities": [
      {
        "activityType": "Heating",
        "unitOfMeasure": "TonneCo2E",
        "activityAmount": "198.31",
        "activityPeriod": {
          "startDate": "2020-01-01",
          "endDate": "2020-12-31"
        },
        "activityDescription": "Heating of buildings",
        "activityLocation": {
          "longitude": "123.456",
          "latitude": "0.12123",
          "geoJsonOrKml": "",
          "geographicLocationFile": ""
        },
        "activityFactorAndSource": {
          "factorType": "Factored",
          "factorUnit": "TonneHfc",
          "factorSource": "https://www.epa.gov/energy/greenhouse-gases-equivalencies-calculator-calculations-and-references",
          "factorPrecision": {
            "low": 70,
            "medium": 20,
            "high": 10
          }
        },
        "relatedMetadata": [
          {
            "relatedMetadataPath": "Metadata/Activities/Heating/ActivityFactorAndSource"
          }
        ]
      }
    ],
    "reportContextExtensions": [
      {
        "key": "Author Contact Email",
        "value": "someone@somewhere.com",
        "relatedMetadata": []
      },
      {
        "key": "Author Contact Phone",
        "value": "123-456-7890",
        "relatedMetadata": []
      }
    ],
    "propertyContextExtensions": [
      {
        "propertyName": "Section 1.2.1",
        "metatags": [
          {
            "key": "Carbon Offset Ratio",
            "value": "1.2",
            "relatedMetadata": []
          }
        ],
        "relatedMetadata": []
      },
      {
        "propertyName": "Section 1.2.2",
        "metatags": [
          {
            "key": "GHG Adjustment Exception",
            "value": "GGP-1_2_2",
            "relatedMetadata": []
          }
        ],
        "relatedMetadata": []
      }
    ],
    "metatdataExtensions": [
      {
        "dataSchema": "https://carboncall.io/schemas/2024/01/01/CarbonCallMetadata.json",
        "documentation": "https://carboncall.io/docs/2024/01/01/CarbonCallMetadata.html",
        "data": "{'@context':'compliancemetrics.org','@type':'compliancemetrics.org/ComplianceMetric','name':'compliancemetrics.org/ComplianceMetric/1.0/1','jurisdiction':'eu','factorCompliance':0.5,'factorCompleteness':0.73,'factorCorrectness':0.9,'accessibility':100}"
      }
    ],
    "pfExtensions": [
      {
        "pfId": "db41d492-19e0-4430-9404-aa545f661525",
        "pcfPropertyData": [
          {
            "propertyName": "pcf/pCfExcludingBiogenic",
            "metatags": [
              {
                "key": "majorExcludingBiogenicSourcePCF_Id",
                "value": "133b7c8d-66b2-4033-9439-95f091b62935",
                "relatedMetadata": []
              }
            ],
            "relatedMetadata": []
          }
        ]
      }
    ],
    "relatedReports": [
      "SDJQ.BPUN.15",
      "ADCF.GPOM.16"
    ]
  },
  "report": "Cgw3RFQ2LlI1QkYuMzISGUxFSTogMjU0OTAwT1BQVTg0R004M01HMzYaCkNhcmJvbkNhbGwg7AEqBewBLusBMgIAAjgCQgoyMDIxLTAxLTAxShgKCjIwMjAtMDEtMDESCjIwMjAtMTItMzFaK2h0dHBzOi8vY2FyYm9uY2FsbC5pby9yZXBvcnRGcm9tUGVyaW9kLmpzb25iBhIENjIwMWqsAXsnUGVyZjEnOnsnbmFtZSc6J1BlcmYxJywndHlwZSc6J3BlcmZvcm1hbmNlJywndmFsdWUnOjEyNzAwMCwndW5pdCc6J3RDTzJlJ30sJ1BlcmYyJzp7J25hbWUnOidQZXJmMicsJ3R5cGUnOidwZXJmb3JtYW5jZScsJ3ZhbHVlJzowLCdtaW4nOjAsJ21heCc6MTAwLCdzdGVwJzoxLCd1bml0JzonJSd9fSByFAoGUHVibGljGgpDYXJib25DYWxsegsIARIDMTAwGgI4MoABAYgBApIBFERFX0JhRklOOiAxMjM0NTY3ODkwogEnZGZ0YWFlMzI5N2k4OTc5OGFkc2RmODMyYWRmczkxMjIzMWF6c2RmqgH8AQoHSGVhdGluZxoGMTk4LjMxIhgKCjIwMjAtMDEtMDESCjIwMjAtMTItMzEqFEhlYXRpbmcgb2YgYnVpbGRpbmdzMhIKBzEyMy40NTYSBzAuMTIxMjM6bggCEA0aYGh0dHBzOi8vd3d3LmVwYS5nb3YvZW5lcmd5L2dyZWVuaG91c2UtZ2FzZXMtZXF1aXZhbGVuY2llcy1jYWxjdWxhdG9yLWNhbGN1bGF0aW9ucy1hbmQtcmVmZXJlbmNlcyIGCEYQFBgKQjUKM01ldGFkYXRhL0FjdGl2aXRpZXMvSGVhdGluZy9BY3Rpdml0eUZhY3RvckFuZFNvdXJjZbIBLQoUQXV0aG9yIENvbnRhY3QgRW1haWwSFXNvbWVvbmVAc29tZXdoZXJlLmNvbbIBJAoUQXV0aG9yIENvbnRhY3QgUGhvbmUSDDEyMy00NTYtNzg5MLoBKwoNU2VjdGlvbiAxLjIuMRIaChNDYXJib24gT2Zmc2V0IFJhdGlvEgMxLjK6ATYKDVNlY3Rpb24gMS4yLjISJQoYR0hHIEFkanVzdG1lbnQgRXhjZXB0aW9uEglHR1AtMV8yXzLCAYADCkBodHRwczovL2NhcmJvbmNhbGwuaW8vc2NoZW1hcy8yMDI0LzAxLzAxL0NhcmJvbkNhbGxNZXRhZGF0YS5qc29uEj1odHRwczovL2NhcmJvbmNhbGwuaW8vZG9jcy8yMDI0LzAxLzAxL0NhcmJvbkNhbGxNZXRhZGF0YS5odG1sGvwBeydAY29udGV4dCc6J2NvbXBsaWFuY2VtZXRyaWNzLm9yZycsJ0B0eXBlJzonY29tcGxpYW5jZW1ldHJpY3Mub3JnL0NvbXBsaWFuY2VNZXRyaWMnLCduYW1lJzonY29tcGxpYW5jZW1ldHJpY3Mub3JnL0NvbXBsaWFuY2VNZXRyaWMvMS4wLzEnLCdqdXJpc2RpY3Rpb24nOidldScsJ2ZhY3RvckNvbXBsaWFuY2UnOjAuNSwnZmFjdG9yQ29tcGxldGVuZXNzJzowLjczLCdmYWN0b3JDb3JyZWN0bmVzcyc6MC45LCdhY2Nlc3NpYmlsaXR5JzoxMDB9ygGOAQokZGI0MWQ0OTItMTllMC00NDMwLTk0MDQtYWE1NDVmNjYxNTI1EmYKGHBjZi9wQ2ZFeGNsdWRpbmdCaW9nZW5pYxJKCiJtYWpvckV4Y2x1ZGluZ0Jpb2dlbmljU291cmNlUENGX0lkEiQxMzNiN2M4ZC02NmIyLTQwMzMtOTQzOS05NWYwOTFiNjI5MzXSAQxTREpRLkJQVU4uMTXSAQxBRENGLkdQT00uMTY="
}

4.2. Sustainability Report Metadata

{
  "grid": "7DT6.R5BF.32",
  "organizationIdentifier": "LEI: 254900OPPU84GM83MG36",
  "organizationName": "CarbonCall",
  "domicile": "US",
  "operatingCountries": [
    "US",
    "CN",
    "GB"
  ],
  "languages": [
    "En",
    "Zh"
  ],
  "reportType": "SustainabilityReport",
  "reportIssueDate": "2021-01-01",
  "reportingPeriod": {
    "startDate": "2020-01-01",
    "endDate": "2020-12-31"
  },
  "reportReplaces": "",
  "location": "https://carboncall.io/reportFromPeriod.json",
  "industry": {
    "prefix": "ISIC",
    "code": "6201"
  },
  "performance": "{'Perf1':{'name':'Perf1','type':'performance','value':127000,'unit':'tCO2e'},'Perf2':{'name':'Perf2','type':'performance','value':0,'min':0,'max':100,'step':1,'unit':'%'}} ",
  "goverance": {
    "intendedUse": "Public",
    "restrictedAccess": false,
    "reportOwner": "CarbonCall"
  },
  "methodology": {
    "methodologyType": "GhgProtocol",
    "percentageOfTotalPortfolioReported": "100",
    "percentageOfEstimatedCalculations": "82",
    "boundaryApproach": "OperationalControl"
  },
  "reportFormat": "IXBRL",
  "reportingStandard": "ISSB",
  "assurance": "DE_BaFIN: 1234567890",
  "priorReport": "",
  "reportHash": "dftaae3297i89798adsdf832adfs912231azsdf",
  "activities": [
    {
      "activityType": "Heating",
      "unitOfMeasure": "TonneCo2E",
      "activityAmount": "198.31",
      "activityPeriod": {
        "startDate": "2020-01-01",
        "endDate": "2020-12-31"
      },
      "activityDescription": "Heating of buildings",
      "activityLocation": {
        "longitude": "123.456",
        "latitude": "0.12123",
        "geoJsonOrKml": "",
        "geographicLocationFile": ""
      },
      "activityFactorAndSource": {
        "factorType": "Factored",
        "factorUnit": "TonneHfc",
        "factorSource": "https://www.epa.gov/energy/greenhouse-gases-equivalencies-calculator-calculations-and-references",
        "factorPrecision": {
          "low": 70,
          "medium": 20,
          "high": 10
        }
      },
      "relatedMetadata": [
        {
          "relatedMetadataPath": "Metadata/Activities/Heating/ActivityFactorAndSource"
        }
      ]
    }
  ],
  "reportContextExtensions": [
    {
      "key": "Author Contact Email",
      "value": "someone@somewhere.com",
      "relatedMetadata": []
    },
    {
      "key": "Author Contact Phone",
      "value": "123-456-7890",
      "relatedMetadata": []
    }
  ],
  "propertyContextExtensions": [
    {
      "propertyName": "Section 1.2.1",
      "metatags": [
        {
          "key": "Carbon Offset Ratio",
          "value": "1.2",
          "relatedMetadata": []
        }
      ],
      "relatedMetadata": []
    },
    {
      "propertyName": "Section 1.2.2",
      "metatags": [
        {
          "key": "GHG Adjustment Exception",
          "value": "GGP-1_2_2",
          "relatedMetadata": []
        }
      ],
      "relatedMetadata": []
    }
  ],
  "metatdataExtensions": [
    {
      "dataSchema": "https://carboncall.io/schemas/2024/01/01/CarbonCallMetadata.json",
      "documentation": "https://carboncall.io/docs/2024/01/01/CarbonCallMetadata.html",
      "data": "{'@context':'compliancemetrics.org','@type':'compliancemetrics.org/ComplianceMetric','name':'compliancemetrics.org/ComplianceMetric/1.0/1','jurisdiction':'eu','factorCompliance':0.5,'factorCompleteness':0.73,'factorCorrectness':0.9,'accessibility':100}"
    }
  ],
  "pfExtensions": [
    {
      "pfId": "21f9e79a-1239-4080-8151-08cd1ecbfaf8",
      "pcfPropertyData": [
        {
          "propertyName": "pcf/pCfExcludingBiogenic",
          "metatags": [
            {
              "key": "majorExcludingBiogenicSourcePCF_Id",
              "value": "8237be0b-b059-4829-83d8-ebb938cae092",
              "relatedMetadata": []
            }
          ],
          "relatedMetadata": []
        }
      ]
    }
  ],
  "relatedReports": [
    "SDJQ.BPUN.15",
    "ADCF.GPOM.16"
  ]
}
Response headers
 content-type: application/json; charset=utf-8 
 date: Tue,19 Sep 2023 14:37:34 G

Appendix A: License

MIT License

Copyright (c) 2023 Carbon Call

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Appendix B: Changelog

Here we will document changes in the specification as they are made.

Version 1.0.20230627 (June 27, 2023)

• Adding ReportType enum, see § 3.24 Data Type: ReportType for details.

• Adding reportContextExtension a collection of Metatag to Metadata, see § 3.2.1 Properties for details.

• Adding propertyContexts a collection of PropertyContextExtension to Metadata, see § 3.2.1 Properties for details.

• Addition relatedReports to Metadata, see § 3.2.1 Properties for details.

Version 1.0.20230725 (July 25, 2023)

• Adding Goverance type, see § 3.7 Data Type: Governance for details.

Version 1.0.20230728 (July 28, 2023)

• Added data type Metalink, see § 3.12 Data Type: Metalink for details.

• Added Metalinks to Activity, MetaTag and PropertyContextExtension, see § 3.5.1 Properties, § 3.11.1 Properties and § 3.13.1 Properties for details.

• Added data type GeographicLocation, see § 3.9 Data Type: GeographicLocation for details.

• Changed ReportingPeriod to TimePeriod for reuse.

• Added IntendedUse, RestrictedAccess and ReportOwner to Governance, see § 3.7.1 Properties for details.

• Added data type MethodologyType, see § 3.25 Data Type: MethodologyType for details.

• Added data type BoundaryApproach, see § 3.26 Data Type: BoundaryApproach for details.

• Added data type Unit, see § 3.27 Data Type: Unit for details.

• Added data type FactorType, see § 3.28 Data Type: FactorType for details.

• Added data type Methodology, see § 3.8 Data Type: Methodology for details.

• Added data type FactorAndSource, see § 3.6 Data Type: FactorAndSource for details.

• Added data type Activity, see § 3.5 Data Type: Activity for details.

• Updated samples, see § 4 Samples for details.

Version 1.0.20230906 (September 6, 2023)

• Moved to CarbonCall GitHub organization.

• Added ProductFootprintExtension data type, see § 3.17 Data Type: ProductFootprintExtension for details.

• Added Dataspaces to definitions.

• Placeholders for synchronization with the Pathfinder Framework and business case.

Version 1.0.230911 (September 11, 2023)

• Added Id to data type ProductFootprintExtension, see § 3.17.1 Properties for details.

• Added pcfPropertyData to data type ProductFootprintExtension, see § 3.17.1 Properties for details.

Version 1.0.230912 (September 12, 2023)

• Synced overview with business case.

Version 1.0.230919 (September 19, 2023)

• Renamed PropertyContext to *PropertyContextExtension, see § 3.13 Data Type: PropertyContextExtension for details.