Skip to main content

Input fields

consentGranularity : ConsentGranularityValue

The consent granularity for reading data sharing (MHHS only).

daContract : Int

The ID of the Data Aggregator (DA) contract.

dataServiceContract : Int

The ID of the Data Service contract (MHHS only).

dcContract : Int

The ID of the Data Collector (DC) contract.

isChangeOfTenancy : Boolean

Whether this is a change of tenancy.

isDeenergised : Boolean

Whether the meter point is de-energised.

isExport : Boolean

Whether this is an export meter point.

isHalfHourly : Boolean

Whether this meter point uses half-hourly settlement.

isInternalTransfer : Boolean

Whether this is an internal transfer.

isNewConnection : Boolean

Whether this is a new connection.

isNonDomestic : Boolean

Whether this is a non-domestic (business) meter point.

mdrMpid : String

The Meter Data Retriever MPID (MHHS only).

measurementClass : MeasurementClass

The measurement class for the meter point.

meteringServiceContract : Int

The ID of the Metering Service contract (MHHS only).

meterTimeswitchCode : Int

The meter timeswitch code (MTC).

migrateToMhhs : Boolean

Whether to migrate this meter point to Market-wide Half Hourly Settlement (MHHS).

mopContract : Int

The ID of the Meter Operator (MOP) contract.

profileClass : Int

The profile class for the meter point.

The read frequency (MHHS only).

readingCycle : RegularReadingCycle

The reading cycle for the meter point.

retrievalMethod : RetrievalMethod

The method used to retrieve meter readings.

standardSettlementConfiguration : String

The standard settlement configuration (SSC) code.

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

{ "consentGranularity": "HALF_HOURLY", "daContract": 10, "dataServiceContract": 10, "dcContract": 40, "isChangeOfTenancy": true, "isDeenergised": true, "isExport": true, "isHalfHourly": true, "isInternalTransfer": true, "isNewConnection": true, "isNonDomestic": true, "mdrMpid": "49980750", "measurementClass": "NHH_METERED", "meteringServiceContract": 96, "meterTimeswitchCode": 21, "migrateToMhhs": true, "mopContract": 54, "profileClass": 73, "readFrequency": "WEEKLY", "readingCycle": "ANNUAL", "retrievalMethod": "VISUAL", "standardSettlementConfiguration": "education-across-these-also-standard" }