Skip to main content

Fields

annualConsumption : Decimal

ECS Calculated Annual Consumption (kWh).

annualConsumptionEfd : Date

Date on which Annual Consumption is effective from.

annualConsumptionQualityIndicator : String

ECS Calculated Annual Consumption Quality Indicator.

assignedMdrEfd : Date

Meter Data Reader effective from date.

assignedMdrMpid : String

Meter Data Reader MPID.

connectionType : String

Connection type.

connectionTypeEfd : Date

Connection type effective from date.

connectionTypeEtd : Date

Connection type end date.

consumerType : String

Consumer Type.

cssSupplierMpid : String

Current supplier as supplied via CSS messages.

cssSupplyStartDate : Date

Current supply start date via CSS messages.

customerDirectContractDsDipId : String

Customer Direct Contract Data Service DIP Identifier.

customerDirectContractDsExists : Boolean

Identifies where such a relationship exists for a Data Service.

customerDirectContractDsMpid : String

Customer Direct Contract Data Service MPID.

customerDirectContractMsDipId : String

Customer Direct Contract Metering Service DIP Identifier.

customerDirectContractMsExists : Boolean

Identifies where such a relationship exists for a Metering Service.

customerDirectContractMsMpid : String

Customer Direct Contract Metering Service MPID.

dataAggregatorEfd : Date

Data Aggregator appointment effective from date.

dataAggregatorMpid : String

Data Aggregator MPID.

dataCollectorEfd : Date

Data Collector appointment effective from date.

dataCollectorMpid : String

Data Collector MPID.

dataServiceDipId : String

Data Service DIP Identifier.

dataServiceEfd : Date

Data Service effective from date.

dataServiceMpid : String

Data Service MPID.

dccServiceFlag : String

Data Communications Company Service Flag.

dccServiceFlagEfd : Date

Data Communications Company Service Flag effective from date.

disconnectionEfd : Date

Disconnection effective from date.

distributorDipId : String

Distributor DIP Identifier.

distributorMpid : String

Distributor MPID.

domesticConsumerIndicator : Boolean

Domestic Consumer Indicator supplied via CSS messages.

Deprecation
The 'domesticConsumerIndicator' field is deprecated.

This field has been replaced by `domesticPremisesIndicator`.

- Marked as deprecated on 2025-10-13.
- Scheduled for removal on or after 2026-01-01.
domesticPremisesIndicator : Boolean

Domestic Consumer Indicator supplied via CSS messages.

duosTariffId : String

DUoS Tariff ID.

duosTariffIdEfd : Date

Duos Tariff ID effective from date.

energisationStatus : String

Energisation status.

energisationStatusEfd : Date

Energisation status effective from date.

energyDirection : String

Energy direction.

energyDirectionEfd : Date

Energy direction effective from date.

energyDirectionEtd : Date

Energy direction end date.

greenDealInEffect : String

Indicates if a Green Deal is currently active for this MPAN.

gspGroupEfd : Date

Grid Supply Point Group effective from date.

gspGroupId : String

Grid Supply Point Group Id.

ihdStatus : String

In Home Display Install status.

ihdStatusEfd : Date

In Home Display Install status effective from date.

lineLossFactor : String

Line Loss Factor Class.

lineLossFactorEfd : Date

Line Loss Factor Class effective from date.

marketSegmentIndicator : String

MPAN Market Segment.

marketSegmentIndicatorEfd : Date

MPAN Market Segment effective from date.

measurementClass : String

Measurement Class.

measurementClassEfd : Date

Measurement Class effective from date.

meteredIndicator : Boolean

Metered Indicator.

meteredIndicatorEfd : Date

Metered Indicator effective from date.

meteredIndicatorEtd : Date

Metered Indicator end date.

meteringServiceDipId : String

Metering Service DIP identifier.

meteringServiceEfd : Date

Metering Service effective from date.

meteringServiceEtd : Date

Metering Service effective to date.

meteringServiceMpid : String

Metering Service MPID.

meterOperatorEfd : Date

Meter Operator appointment effective from date.

meterOperatorMpid : String

Meter Operator MPID.

List of meter details.

meterTimeswitchClass : Int

Meter Time-switch Class.

meterTimeswitchClassEfd : Date

Meter Time-switch Class effective from date.

mhhsIndicator : String

Indicates whether the MPAN is Legacy, MHHS or Reversed.

mhhsIndicatorEfd : Date

MHHS indicator effective from date.

mpan : String! required

MPAN.

profileClass : Int

Profile Class.

profileClassEfd : Date

Profile Class effective from date.

relationshipStatusIndicator : String

Relationship Status Indicator.

rmpState : String

RMP State.

rmpStateEfd : Date

RMP State effective from date.

smetsVersion : String

Smart Metering Equipment Technical Specification version.

smsoEfd : Date

Smart Metering System Operator effective from date.

smsoMpid : String

Smart Metering System Operator MPID.

standardSettlementConfiguration : String

Standard Settlement Configuration.

standardSettlementConfigurationEfd : Date

Standard Settlement Configuration effective from date.

supplierDipId : String

Supplier DIP identifier.

supplierEfd : Date

Effective from date of the current supplier.

supplierMpid : String

Supplier MPID.

tradingStatus : String

MPAN trading status.

tradingStatusEfd : Date

MPAN trading status effective from date.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "annualConsumption": "1.0", "annualConsumptionEfd": "1992-10-11", "annualConsumptionQualityIndicator": "let-woman-mother-cold-chance", "assignedMdrEfd": "2008-11-19", "assignedMdrMpid": "85534453", "connectionType": "card-both-short-voice-people", "connectionTypeEfd": "2015-12-06", "connectionTypeEtd": "2025-05-16", "consumerType": "race-research-daughter-at-number", "cssSupplierMpid": "96037885", "cssSupplyStartDate": "1974-06-11", "customerDirectContractDsDipId": "19772586", "customerDirectContractDsExists": true, "customerDirectContractDsMpid": "39176347", "customerDirectContractMsDipId": "96334071", "customerDirectContractMsExists": true, "customerDirectContractMsMpid": "33268959", "dataAggregatorEfd": "1998-12-10", "dataAggregatorMpid": "67994115", "dataCollectorEfd": "1971-03-28", "dataCollectorMpid": "59406188", "dataServiceDipId": "75320137", "dataServiceEfd": "2010-03-11", "dataServiceMpid": "48084603", "dccServiceFlag": "detail-customer-management-together-dog", "dccServiceFlagEfd": "1995-08-03", "disconnectionEfd": "1990-10-10", "distributorDipId": "35343725", "distributorMpid": "74714176", "domesticPremisesIndicator": true, "duosTariffId": "19756701", "duosTariffIdEfd": "2016-01-23", "energisationStatus": "your-either-cut-section-show", "energisationStatusEfd": "1999-02-06", "energyDirection": "main-identify-third-someone-once", "energyDirectionEfd": "1972-04-09", "energyDirectionEtd": "2018-02-28", "greenDealInEffect": "learn-couple-federal-reality-accept", "gspGroupEfd": "1976-10-16", "gspGroupId": "50621483", "ihdStatus": "mention-yes-firm-since-population", "ihdStatusEfd": "2026-03-26", "lineLossFactor": "executive-in-vote-unit-military", "lineLossFactorEfd": "2004-02-09", "marketSegmentIndicator": "ok-laugh-capital-know-cell", "marketSegmentIndicatorEfd": "2013-09-17", "measurementClass": "window-education-act-interest-product", "measurementClassEfd": "1972-01-20", "meteredIndicator": true, "meteredIndicatorEfd": "1993-10-24", "meteredIndicatorEtd": "1985-12-06", "meteringServiceDipId": "98448414", "meteringServiceEfd": "2020-08-29", "meteringServiceEtd": "2007-11-22", "meteringServiceMpid": "22143597", "meterOperatorEfd": "2022-05-07", "meterOperatorMpid": "10646709", "meters": [ElectricMeterTechnicalSubDetails], "meterTimeswitchClass": 50, "meterTimeswitchClassEfd": "1985-03-19", "mhhsIndicator": "evening-sit-player-system-shoulder", "mhhsIndicatorEfd": "1991-12-25", "mpan": "sound-low-certain-challenge-yet", "profileClass": 34, "profileClassEfd": "1990-10-23", "relationshipStatusIndicator": "camera-skill-wear-include-voice", "rmpState": "expert-inside-event-from-trial", "rmpStateEfd": "1982-03-11", "smetsVersion": "stop-we-I-interesting-ask", "smsoEfd": "1981-08-31", "smsoMpid": "30079420", "standardSettlementConfiguration": "director-ago-education-look-weight", "standardSettlementConfigurationEfd": "1992-08-01", "supplierDipId": "35157098", "supplierEfd": "2017-03-18", "supplierMpid": "21967123", "tradingStatus": "into-western-anything-design-instead", "tradingStatusEfd": "1972-08-30" }