> For the complete documentation index, see [llms.txt](https://india-energy-stack.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://india-energy-stack.gitbook.io/docs/schemas/electricitycredential/v1.2.md). # v1.2 > **Files** — [attributes.yaml](https://india-energy-stack.github.io/ies-accelerator/schemas/ElectricityCredential/v1.2/attributes.yaml) · [schema.json](https://india-energy-stack.github.io/ies-accelerator/schemas/ElectricityCredential/v1.2/schema.json) · [context.jsonld](https://india-energy-stack.github.io/ies-accelerator/schemas/ElectricityCredential/v1.2/context.jsonld) · [vocab.jsonld](https://india-energy-stack.github.io/ies-accelerator/schemas/ElectricityCredential/v1.2/vocab.jsonld) · [examples/](https://github.com/India-Energy-Stack/ies-accelerator/tree/main/schemas/ElectricityCredential/v1.2/examples/README.md) > **Upstream authority and mirror status.** [`beckn/DEG/specification/schema/ElectricityCredential/v1.2/`](https://github.com/beckn/DEG/tree/main/specification/schema/ElectricityCredential/v1.2) is canonical. Run `python -X utf8 -B scripts/verify_ec_mirror.py` from the repository root to compare this directory with pinned commit [`84a4de0d749ce17b58ec37d18c4a13deace9c023`](https://github.com/beckn/DEG/commit/84a4de0d749ce17b58ec37d18c4a13deace9c023), selected as the immutable 2026-06-26 v1.2 upstream tree current when this launch gate was introduced. As of 2026-07-26, that verifier reports drift in seven of eight files (the bundled `schema.json` matches); this directory must not be represented as a synchronized verbatim mirror until an independently reviewed upstream refresh makes the verifier pass. ## ElectricityCredential v1.2 W3C Verifiable Credential (VC Data Model 2.0) issued per meter by electricity distribution utilities. v1.2 introduces a **composable EnergyResource hierarchy**: each entry in `energyResources[]` is discriminated by `type` into one of seven typed kinds, each with a typed `attributes` bag. All power and capacity fields use **QuantitativeValue `{value, unit}`** with short unit aliases (`kW`, `kWh`, `kVA`, `kVAR`, `kV`, `MW`, `MWh`, `MVA`, `MVAR`, `V`, `W`) mapped to QUDT IRIs via JSON-LD context. ### Structure ``` credentialSubject ├── id (optional — customer DID) ├── customerProfile (required — non-PII) │ ├── customerNumber (required — CA number) │ ├── idRef (optional — external identity reference) │ ├── energyResources[] (required — all physical assets, min 1) │ │ ├── id (meter serial for METER; stable id for DERs) │ │ ├── type (discriminator — see kinds below) │ │ ├── attributes (kind-specific bag inheriting EnergyResourceCommonAttributes) │ │ ├── subResources[] (child resource ids or inline objects) │ │ └── parentResources[] (parent resource ids — e.g. the meter a DER sits behind) │ └── consumptionProfiles[] (optional — tariff/load per meter, linked via meterId) └── customerDetails (optional — PII) ├── fullName (PII — only here) ├── installationAddress └── serviceConnectionDate ``` ### EnergyResource kinds | Kind | `type` values | CIM class (IEC 61970/61968) | | ------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | `EnergyResourceMeter` | `METER` | `cim:Meter` / `cim:EndDevice` (IEC 61968-9) | | `EnergyResourceGenerator` | `SOLAR_PV`, `WIND`, `HYDRO`, `BIOGAS`, `CHP`, `FUEL_CELL` | `cim:GeneratingUnit` subtypes (IEC 61970-302) | | `EnergyResourceStorage` | `BESS` | `cim:BatteryUnit` (IEC 61970-302) | | `EnergyResourceEVCharger` | `EV_CHARGER`, `EV_V2G` | `cim:ElectricVehicleChargingStation` (CIM17+) | | `EnergyResourceInverter` | `INVERTER` | `cim:PowerElectronicsConnection` (IEC 61970-302) | | `EnergyResourceLoad` | `SMART_HVAC`, `SMART_WATER_HEATER`, `CONTROLLABLE_LOAD` | `cim:EnergyConsumer` / `cim:ConformLoad` (IEC 61970-301) | | `EnergyResourceNetwork` | `DT`, `BUS`, `FEEDER`, `MICROGRID` | `cim:PowerTransformer`, `cim:BusbarSection`, `cim:Feeder`, `cim:Substation` (IEC 61970-301) | **Deprecated type aliases** (still valid for backward compatibility): `SOLAR` → use `SOLAR_PV`; `BATTERY` → use `BESS`. ### v1.1 → v1.2 migration | Change | v1.1 (scalar) | v1.2 (QuantitativeValue) | | ------------------- | ------------------------------------------------------- | -------------------------------------------------------------------- | | Power fields | `ratedPowerKw`, `maxExportKw`, `maxImportKw` (number) | `ratedPower`, `maxExport`, `maxImport` (`{value, unit: W\|kW\|MW}`) | | Generator nameplate | `nominalPowerKw` (number) | `nominalPower` (`{value, unit: W\|kW\|MW}`) | | Storage capacity | `storageCapacityKwh` (number) | `storageCapacity` (`{value, unit: kWh\|MWh}`) | | Apparent power | `ratedApparentPowerKva` (number) | `ratedApparentPower` (`{value, unit: kVA\|MVA}`) | | Reactive power | `maxReactivePowerKvar`, `minReactivePowerKvar` (number) | `maxReactivePower`, `minReactivePower` (`{value, unit: kVAR\|MVAR}`) | | Network voltage | `nominalVoltageKv` (number) | `nominalVoltage` (`{value, unit: V\|kV}`) | | Tariff load | `sanctionedLoadKw`, `contractMaxDemandKw` (number) | `sanctionedLoad`, `contractMaxDemand` (`{value, unit: W\|kW\|MW}`) | ### Files | File | Description | | ----------------------------------------- | -------------------------------------------------------------------------- | | `attributes.yaml` | OpenAPI 3.1.1 schema with composable EnergyResource hierarchy | | `schema.json` | Bundled JSON Schema (draft 2020-12) — self-contained | | `context.jsonld` | JSON-LD context with unit aliases (kW→qudt:KiloW, kWh→qudt:KiloW-HR, etc.) | | `vocab.jsonld` | RDF vocabulary with CIM class alignments | | `examples/example.json` | Single meter + SOLAR\_PV + WIND + 2× BESS | | `examples/example-submetering.json` | Building main meter + 2 tenant sub-meters + rooftop solar | | `examples/example-parallel-metering.json` | Import meter + export meter (solar FIT) | For full documentation see the [upstream README](https://github.com/beckn/DEG/tree/main/specification/schema/ElectricityCredential/v1.2/README.md). *** ### Field reference *Auto-generated from `schema.json`. A field name in **bold** with a trailing **\*** is required; all others are optional. **Type** shows units for QuantitativeValue models. Where a field is derived from a standard, its description begins with **Based on** and the standard reference (from the field's `x-standard` annotation). One table per object.* #### ElectricityCredential v1.2 | Field | Type | Description | | -------------------------- | ------------ | ----------- | | **`id`** \* | uri | — | | **`type`** \* | list of text | — | | **`issuer`** \* | object | — | | **`validFrom`** \* | date-time | — | | `validUntil` | date-time | — | | `credentialStatus` | object | — | | **`credentialSubject`** \* | object | — | | `proof` | object | — | #### CustomerDetails | Field | Type | Description | | ------------------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`fullName`** \* | text | **Based on** CIM (IEC 61968-1 Customer.name). Full name of the customer as per ID proof. | | `careOf` | object | Care-of (c/o) reference person used to uniquely identify / disambiguate a customer who may share the same fullName with others in a locality (e.g. a village). Pairs a name with an optional, gender-neutral relationship. | | **`installationAddress`** \* | Location | **Based on** GeoJSON RFC 7946; schema.org PostalAddress; CIM (IEC 61968-1 ServiceLocation). Physical location of the metered installation. geo (GeoJSON Point, coordinates \[longitude, latitude]) is required; address (schema.org PostalAddress fields) is optional. | | **`serviceConnectionDate`** \* | date-time | **Based on** CIM (IEC 61968-1 ServiceLocation activation date). Date and time the service connection was activated, with timezone offset (ISO 8601). | #### Location | Field | Type | Description | | ------------ | --------------- | ----------- | | **`geo`** \* | GeoJSONGeometry | — | | `address` | Address | — | #### GeoJSONGeometry | Field | Type | Description | | ------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `bbox` | list of number | Optional bounding box `[west, south, east, north]` in degrees. | | `coordinates` | list of — | Coordinates per RFC 7946 for all types **except** GeometryCollection. Order is **\[lon, lat, (alt)]**. For Polygons, this is an array of linear rings; each ring is an array of positions. | | `geometries` | list of GeoJSONGeometry | Member geometries when `type` is **GeometryCollection**. | | **`type`** \* | `Point` / `LineString` / `Polygon` / `MultiPoint` / `MultiLineString` / `MultiPolygon` / `GeometryCollection` | — | #### Address | Field | Type | Description | | ----------------- | ---- | ------------------------------------------------- | | `addressCountry` | text | Country name or ISO-3166-1 alpha-2 code. | | `addressLocality` | text | City/locality. | | `addressRegion` | text | State/region/province. | | `extendedAddress` | text | Address extension (apt/suite/floor, C/O). | | `postalCode` | text | Postal/ZIP code. | | `streetAddress` | text | Street address (building name/number and street). | #### CustomerProfile | Field | Type | Description | | ------------------------ | -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | **`customerNumber`** \* | text | Utility customer account (CA) number. | | `idRef` | IdRef | — | | **`energyResources`** \* | list of EnergyResource | All physical energy assets for this account. Each entry is discriminated by 'type' into one of seven composable kinds. | | `consumptionProfiles` | list of ConsumptionProfile | Tariff and load characteristics per meter connection. Each entry links to a METER via meterId. | #### IdRef | Field | Type | Description | | ------------------ | ---- | ------------------------------------------------------- | | **`issuedBy`** \* | uri | DID or URI of the issuing authority. | | **`subjectId`** \* | text | Subject identifier in authority-domain:id-value format. | #### EnergyResourceMeter | Field | Type | Description | | ----------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------- | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | text | Asset-class discriminator. Must be "METER". CIM cim:Meter (IEC 61968-9). | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceMeterAttributes | — | #### EnergyResourceCommon | Field | Type | Description | | ----------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------- | | `id` | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | `type` | text | Asset class discriminator. Constrained to a kind-specific enum or const in each typed kind schema. | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceCommonAttributes | Attribute bag. Inherits EnergyResourceCommonAttributes via allOf plus kind-specific fields. | #### EnergyResourceCommonAttributes | Field | Type | Description | | ------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | #### QVPower | Field | Type | Description | | -------------- | ----------------- | ----------- | | **`value`** \* | number | — | | **`unit`** \* | `W` / `kW` / `MW` | — | #### EnergyResourceMeterAttributes | Field | Type | Description | | ------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `meterCapability` | `Electromechanical` / `CMRI` / `AMR` / `AMI` | **Based on** CIM (IEC 61968-9 AmiBillingReadyKind). Communication/automation generation. Electromechanical: induction-disc. CMRI: manual optical-port (India legacy). AMR: one-way automated read. AMI: two-way smart meter. | | `energyDirection` | `Forward` / `Reverse` / `Bidirectional` / `Net` | **Based on** CIM (FlowDirectionKind); ESPI NAESB REQ.21. Energy flow direction metered at this point. | | `functions` | list of `ToU` / `NetMetering` / `MaxDemand` / `LoadControl` / `TamperDetection` / `PowerQuality` / `EventLogging` | **Based on** CIM (IEC 61968-9 EndDeviceFunction). Active meter capabilities. | | `feeder` | text | Feeder identifier this meter is supplied from. | | `bus` | text | Busbar identifier at the meter's connection point. | | `communicationTechnology` | `PLC` / `RF_Mesh` / `GPRS` / `NB-IoT` / `LoRa` / `ZigBee` / `Other` | Last-mile physical-layer communication technology. | | `applicationProtocol` | `DLMS_COSEM` / `ANSI_C12_18` / `IEC_61850` / `Modbus` / `Other` | Application-layer protocol for meter data. DLMS\_COSEM: IEC 62056, mandatory for India AMI per BIS IS 16444. ANSI\_C12\_18: North American. Orthogonal to communicationTechnology (physical layer). | #### EnergyResourceGenerator | Field | Type | Description | | ----------------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | `SOLAR_PV` / `SOLAR` / `WIND` / `HYDRO` / `BIOGAS` / `CHP` / `FUEL_CELL` | Asset-class discriminator. SOLAR is deprecated — use SOLAR\_PV. | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceGeneratorAttributes | — | #### EnergyResourceGeneratorAttributes | Field | Type | Description | | ------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `nominalPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.nominalP). Nominal (nameplate) power output. Use when distinct from maxExport (peak). | | `efficiency` | number | Conversion efficiency as a percentage (0–100). Most relevant for FUEL\_CELL and CHP resources. | | `dcArrayCapacity` | QVPower (`W` / `kW` / `MW`) | **Based on** IS 16221 (PV module qualification); IEC 61727 (PV grid interface). DC-side nameplate capacity of a photovoltaic array at Standard Test Conditions (industry term: "kWp"). For PV systems this is typically larger than the AC-side maxExport because of inverter clipping and DC-to-AC ratios. Relevant for SOLAR\_PV resources. The unit is the standard QUDT power alias kW — the STC/peak semantic is documented here, not encoded in the unit string. | #### EnergyResourceStorage | Field | Type | Description | | ----------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------- | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | `BESS` / `BATTERY` | Asset-class discriminator. BATTERY is deprecated — use BESS. CIM: BatteryUnit (IEC 61970-302). | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceStorageAttributes | — | #### EnergyResourceStorageAttributes | Field | Type | Description | | ------------------------ | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `storageCapacity` | QVEnergy (`kWh` / `MWh`) | **Based on** CIM (IEC 61970-302 BatteryUnit.ratedE). Rated stored-energy capacity. Replaces storageCapacityKwh from v1.0. | | `storageType` | `LithiumIon` / `LeadAcid` / `FlowBattery` / `NaS` / `NiCd` / `Flywheel` / `Other` | Battery storage technology type. | | `stateOfHealthPct` | number | Battery state-of-health as a percentage (0–100). | | `roundTripEfficiencyPct` | number | **Based on** IEC 62933-2-1 (performance test method). AC-to-AC round-trip efficiency as a percentage (0–100): the fraction of energy returned to the grid relative to energy drawn during a full charge/discharge cycle. Distinct from stateOfHealthPct (cumulative life indicator) and from inverter conversion efficiency. | #### QVEnergy | Field | Type | Description | | -------------- | ------------- | ----------- | | **`value`** \* | number | — | | **`unit`** \* | `kWh` / `MWh` | — | #### EnergyResourceEVCharger | Field | Type | Description | | ----------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | `EV_CHARGER` / `EV_V2G` | Asset-class discriminator. EV\_CHARGER: EVSE hardware. EV\_V2G: Vehicle-to-Grid capable EVSE with ISO 15118-20 / OCPP 2.1 BPT. | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceEVChargerAttributes | — | #### EnergyResourceEVChargerAttributes | Field | Type | Description | | ------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `connectorType` | `Type1` / `Type2` / `CCS1` / `CCS2` / `CHAdeMO` / `GB_T` / `NACS` / `Other` | Physical connector standard. Type1: IEC 62196-2 Type 1 (J1772). Type2: IEC 62196-2 Type 2 (Mennekes). CCS1/CCS2: Combined Charging System DC fast charge. CHAdeMO: CHAdeMO DC fast charge. GB\_T: GB/T 20234. NACS: SAE J3400. | | `controlProtocol` | `OCPP_1.6` / `OCPP_2.0.1` / `OCPP_2.1` / `ISO_15118_2` / `ISO_15118_20` / `Other` | EVSE control and smart-charging protocol. | | `v2xProtocol` | `CHAdeMO_V2G` / `CCS_BPT` / `ISO_15118_20_AC_BPT` / `ISO_15118_20_DC_BPT` / `Other` | Vehicle-to-Grid / V2X protocol. Present only for EV\_V2G resources. | #### EnergyResourceInverter | Field | Type | Description | | ----------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------- | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | text | Asset-class discriminator. Must be "INVERTER". CIM: PowerElectronicsConnection (IEC 61970-302). | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceInverterAttributes | — | #### EnergyResourceInverterAttributes | Field | Type | Description | | ------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `ratedApparentPower` | QVApparentPower (`kVA` / `MVA`) | **Based on** SunSpec DER Model 702 (maxVA); CIM (IEC 61970-302 PowerElectronicsConnection.ratedS). Rated apparent power. Replaces ratedApparentPowerKva from v1.0. | | `maxReactivePower` | QVReactivePower (`kVAR` / `MVAR`) | **Based on** SunSpec DER Model 702 (maxVar); CIM (IEC 61970-302 PowerElectronicsConnection.maxQ). Maximum reactive power injection (leading / over-excited). Replaces maxReactivePowerKvar from v1.0. | | `minReactivePower` | QVReactivePower (`kVAR` / `MVAR`) | **Based on** SunSpec DER Model 702 (maxVarNeg); CIM (IEC 61970-302 PowerElectronicsConnection.minQ). Maximum reactive power absorption (lagging / under-excited). Value is typically negative. Replaces minReactivePowerKvar from v1.0. | | `rideThroughCategory` | `CategoryI` / `CategoryII` / `CategoryIII` | **Based on** IEEE 1547-2018 (ride-through category). Abnormal operating performance category. CategoryI: basic. CategoryII: enhanced for distribution-connected DER. CategoryIII: advanced for large/transmission-connected DER. | | `operatingMode` | `GridFollowing` / `GridForming` / `Standby` | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.inverterMode). Inverter grid-interaction mode. GridFollowing: PLL-based sync. GridForming: own V/f reference (microgrid islanding, black-start). Standby: energised but not injecting. | | `voltVarEnabled` | yes / no | **Based on** IEEE 2030.5 (opModVoltVar); SunSpec DER Model 705. Volt-VAr curve active. | | `freqDroopEnabled` | yes / no | **Based on** IEEE 1547-2018; SunSpec DER Model 711. Frequency-Watt droop active. | | `enterServiceRampTimeSec` | number | **Based on** SunSpec DER Model 703 (ESRmpTms). Seconds to ramp from 0 to rated power after reconnection. | #### QVApparentPower | Field | Type | Description | | -------------- | ------------- | ----------- | | **`value`** \* | number | — | | **`unit`** \* | `kVA` / `MVA` | — | #### QVReactivePower | Field | Type | Description | | -------------- | --------------- | ----------- | | **`value`** \* | number | — | | **`unit`** \* | `kVAR` / `MVAR` | — | #### EnergyResourceLoad | Field | Type | Description | | ----------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | `SMART_HVAC` / `SMART_WATER_HEATER` / `CONTROLLABLE_LOAD` | Asset-class discriminator. CIM: EnergyConsumer / ConformLoad (IEC 61970-301). | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceLoadAttributes | — | #### EnergyResourceLoadAttributes | Field | Type | Description | | ------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `controlProtocol` | `OpenADR_2.0b` / `OCPP_2.0.1` / `SunSpec_Modbus` / `EEBus` / `Modbus` / `Other` | Demand-response / control protocol supported by this load device. | | `loadCategory` | `Heating` / `Cooling` / `WaterHeating` / `Lighting` / `EV` / `Industrial` / `Other` | **Based on** CIM (IEC 61970-301 ConformLoad classification). Functional category of this load. | #### EnergyResourceNetwork | Field | Type | Description | | ----------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`id`** \* | text | Stable identifier for this resource. For METER resources the meter serial number is conventional. | | **`type`** \* | `DT` / `BUS` / `FEEDER` / `MICROGRID` | Asset-class discriminator. DT → PowerTransformer, BUS → BusbarSection, FEEDER → Feeder (EquipmentContainer), MICROGRID → Substation / microgrid container (IEC 61970-301). | | `subResources` | list of text or EnergyResource | Topology — child resources. Each item is EITHER a bare id string OR an inline EnergyResource object. | | `parentResources` | list of text | Upward topology — ids of parent resources. | | `attributes` | EnergyResourceNetworkAttributes | — | #### EnergyResourceNetworkAttributes | Field | Type | Description | | ------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `make` | text | Manufacturer (free text). | | `model` | text | Model (free text). | | `ratedPower` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 EndDeviceInfo.ratedPower; IEC 61970 GeneratingUnit.maxOperatingP). Manufacturer-rated peak power (nameplate value in principal direction). Kept for backward compatibility — prefer maxExport. | | `maxExport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970 GeneratingUnit.maxOperatingP; IEC 61970-302 PowerElectronicsConnection.maxP, injection). Maximum power this resource injects to the grid (generates/discharges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max discharge rate. Supersedes ratedPower. | | `maxImport` | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61970-302 PowerElectronicsConnection.maxP, absorption). Maximum power this resource draws from the grid (absorbs/charges). Always ≥0. For bidirectional resources (BESS, V2G) this is the max charge rate. | | `telemetryProvider` | text | Vendor API / data source identifier for telemetry. | | `commissioningDate` | date-time | ISO 8601 date-time the asset was commissioned. | | `location` | Location | Physical location of this asset. | | `serialNumber` | text | **Based on** CIM (IEC 61968-9 EndDeviceInfo.serialNumber). Manufacturer-assigned device serial number from the equipment nameplate. Distinct from id (which is the network-issued DID). | | `inspection` | object | **Based on** IEEE 1547-2018 Cl. 11 (commissioning); CEA Connectivity Regs 2013 (amended 2018). Commissioning / safety inspection record for the asset. Captured by the distribution licensee at energisation and on re-certification events. | | `aggregator` | object | **Based on** IEEE 2030.5; IEC 61850-7-420 (DER control roles). Third-party flexibility / demand-response enrolment for this asset. Present when an aggregator is authorised to dispatch or observe the resource. Controllability flag is asset-level; the asset may still be observable even when controllable is false. | | `nominalVoltage` | QVVoltage (`V` / `kV`) | **Based on** CIM (IEC 61970-301 BaseVoltage.nominalVoltage). Nominal operating voltage. Replaces nominalVoltageKv from v1.0. | | `zone` | text | Operating zone or region identifier used by the utility. | | `substationId` | text | Parent substation identifier per utility records. | | `feederCode` | text | Feeder code per utility records. Relevant for FEEDER and DT resources. | #### QVVoltage | Field | Type | Description | | -------------- | ---------- | ----------- | | **`value`** \* | number | — | | **`unit`** \* | `V` / `kV` | — | #### ConsumptionProfile | Field | Type | Description | | --------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`meterId`** \* | text | Matches the id of a METER entry in customerProfile.energyResources\[]. | | **`sanctionedLoad`** \* | QVPower (`W` / `kW` / `MW`) | **Based on** CIM (IEC 61968-9 UsagePoint). Sanctioned/approved import load. | | `sanctionedExportLoad` | QVPower (`W` / `kW` / `MW`) | Sanctioned/approved grid export limit. | | `billingCycleDay` | integer | Day of month on which the billing cycle resets. | | `contractMaxDemand` | QVPower (`W` / `kW` / `MW`) | Maximum demand contracted with the utility for this connection. | | **`tariffCategoryCode`** \* | text | **Based on** CIM (IEC 61968-9 UsagePoint.serviceCategory). Billing/tariff category code assigned by the utility. | | `premisesType` | `Residential` / `Commercial` / `Industrial` / `Agricultural` | Type of premises at the metering point. | | `connectionType` | `Single-phase` / `Three-phase` | **Based on** CIM (IEC 61968-9 UsagePoint.phaseCode). Electrical connection type. | | `paymentMode` | `POSTPAID` / `PREPAID` | **Based on** CIM (IEC 61968-9 AmiBillingReadyKind, ESPI). Billing/payment modality. POSTPAID: consume now, pay later. PREPAID: pay-before-use. | | `serviceStatus` | `active` / `suspended` / `closed` | **Based on** CIM (IEC 61968-9 UsagePoint.status). Lifecycle state of the service connection (the UsagePoint), not of the meter device itself. 'active' = currently energised and billable; 'suspended' = temporarily disconnected (non-payment, inspection, fault) with the contract still on record; 'closed' = permanently terminated. Distinct from the meter device's operational state. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://india-energy-stack.gitbook.io/docs/schemas/electricitycredential/v1.2.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.