POST request/customer/{CustomerId}/site/{SiteId}/meter/electric

Submits electricity meter details for a customer site.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId		integer	Required
SiteId		integer	Required

Body Parameters

ElectricityMeterPost

Name	Type	Additional information
AnnualConsumption	integer	None.
AnnualConsumptionEfd	date	None.
AnnualConsumptionQualityIndicator	string	None.
AnnualConsumptionQualityIndicatorDescription	string	None.
availableSupplyCapacity	decimal number	None.
Commission	decimal number	None.
Comparison	boolean	None.
ConnectionType	string	None.
ConsumerType	string	None.
ConsumptionPeriodId	integer	None.
CurrentContractEndDate	date	None.
DataAggregatorEfDate	date	None.
DataAggregatorMpid	string	None.
DatacollectorEfDate	date	None.
DataCollectorMpid	string	None.
DomesticConsumerIndicator	string	None.
DomesticConsumerIndicatorDescription	string	None.
DuosTariffId	string	None.
EnergisationStatus	string	None.
EnergisationStatusDescription	string	None.
EnergyDirection	string	None.
EnergyDirectionDescription	string	None.
existingArrangement	DcDaMeterDetails	None.
ExitZone	string	None.
GSPGroupId	string	None.
Included	boolean	None.
IndustryAnnualConsumption	string	None.
IndustryAnnualConsumptionEfd	string	None.
IndustryCurrentSupplierMPID	string	None.
IndustryCurrentSupplierName	string	None.
IndustryDataAggregatorEfDate	string	None.
IndustryDatacollectorEfDate	string	None.
IndustryMeterType	string	None.
IndustryMeterTypeDescription	string	None.
IndustrySupplierEFDate	string	None.
IsAmr	byte	None.
IsCommisionFromCustomer	boolean	None.
IsCommisionFromSite	boolean	None.
IsImport	boolean	None.
IsIndustryUpdateRequired	boolean	None.
ldzId	string	None.
MeterSerialNumber	string	None.
MeterStatus	string	None.
MeterTimeswitchClass	integer	None.
meterVoltage	string	None.
MHHSIndicator	string	None.
MHHSIndicatorDescription	string	None.
MPAN	string	None.
MPANOverwritten	boolean	None.
MpanParts	Dictionary of string [key] and string [value]	None.
NightUnitRate	decimal number	None.
NightUsage	integer	None.
OutOfContract	boolean	None.
PreferredContractEndDate	date	None.
PreferredContractStartDate	date	None.
rateNames	RateNames	None.
RateType	RateType	None.
RelationshipStatusIndicator	string	None.
RelationshipStatusIndicatorDescription	string	None.
StandardSettlementCode	integer	None.
StandingCharge	decimal number	None.
StandingChargePeriodId	integer	None.
SupplierEFDate	date	None.
SupplierId	integer	None.
Type	string	None.
UnitRate	decimal number	None.
Usage	integer	None.
WeekendUnitRate	decimal number	None.
WeekendUsage	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "supplierId": 1,
  "mpan": "sample string 1",
  "mpanParts": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "mpanOverwritten": true,
  "isAmr": 64,
  "standingCharge": 1.0,
  "unitRate": 1.0,
  "usage": 1,
  "nightUnitRate": 1.0,
  "nightUsage": 1,
  "weekendUnitRate": 1.0,
  "weekendUsage": 1,
  "standingChargePeriodId": 4,
  "consumptionPeriodId": 5,
  "currentContractEndDate": "2026-08-05T04:22:12.3164819+00:00",
  "preferredContractStartDate": "2026-08-05T04:22:12.3164819+00:00",
  "preferredContractEndDate": "2026-08-05T04:22:12.3164819+00:00",
  "isCommisionFromCustomer": true,
  "isCommisionFromSite": true,
  "commission": 1.0,
  "rateType": "Single",
  "meterVoltage": "sample string 6",
  "availableSupplyCapacity": 1.0,
  "included": true,
  "outOfContract": true,
  "comparison": true,
  "type": "sample string 10",
  "standardSettlementCode": 1,
  "rateNames": {
    "unitRateName": "sample string 1",
    "nightUnitRateName": "sample string 2",
    "weekendUnitRateName": "sample string 3"
  },
  "meterSerialNumber": "sample string 11",
  "isImport": true,
  "existingArrangement": {
    "dcda": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2026-08-05T04:22:12.3164819+00:00"
    },
    "mop": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2026-08-05T04:22:12.3164819+00:00"
    },
    "meterConnectionTypeName": "sample string 1",
    "meterConnectionTypeId": 2
  },
  "meterTimeswitchClass": 1,
  "meterStatus": "sample string 12",
  "gspGroupId": "sample string 13",
  "exitZone": "sample string 14",
  "dataAggregatorMpid": "sample string 15",
  "industryDataAggregatorEfDate": "sample string 16",
  "industryDatacollectorEfDate": "sample string 17",
  "industrySupplierEFDate": "sample string 18",
  "dataAggregatorEfDate": "2026-08-05T04:22:12.3164819+00:00",
  "dataCollectorMpid": "sample string 19",
  "datacollectorEfDate": "2026-08-05T04:22:12.3164819+00:00",
  "mhhsIndicator": "sample string 20",
  "connectionType": "sample string 21",
  "industryAnnualConsumption": "sample string 22",
  "annualConsumption": 1,
  "industryAnnualConsumptionEfd": "sample string 23",
  "annualConsumptionEfd": "2026-08-05T04:22:12.3164819+00:00",
  "annualConsumptionQualityIndicator": "sample string 24",
  "duosTariffId": "sample string 25",
  "consumerType": "sample string 26",
  "domesticConsumerIndicator": "sample string 27",
  "relationshipStatusIndicator": "sample string 28",
  "supplierEFDate": "2026-08-05T04:22:12.3164819+00:00",
  "industryMeterType": "sample string 29",
  "industryMeterTypeDescription": "sample string 30",
  "industryCurrentSupplierName": "sample string 31",
  "industryCurrentSupplierMPID": "sample string 32",
  "ldzId": "sample string 33",
  "energyDirection": "sample string 34",
  "energisationStatus": "sample string 35",
  "energisationStatusDescription": "sample string 36",
  "energyDirectionDescription": "sample string 37",
  "mhhsIndicatorDescription": "sample string 38",
  "annualConsumptionQualityIndicatorDescription": "sample string 39",
  "domesticConsumerIndicatorDescription": "sample string 40",
  "relationshipStatusIndicatorDescription": "sample string 41",
  "isIndustryUpdateRequired": true
}

text/html

Sample:

{"supplierId":1,"mpan":"sample string 1","mpanParts":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"mpanOverwritten":true,"isAmr":64,"standingCharge":1.0,"unitRate":1.0,"usage":1,"nightUnitRate":1.0,"nightUsage":1,"weekendUnitRate":1.0,"weekendUsage":1,"standingChargePeriodId":4,"consumptionPeriodId":5,"currentContractEndDate":"2026-08-05T04:22:12.3164819+00:00","preferredContractStartDate":"2026-08-05T04:22:12.3164819+00:00","preferredContractEndDate":"2026-08-05T04:22:12.3164819+00:00","isCommisionFromCustomer":true,"isCommisionFromSite":true,"commission":1.0,"rateType":"Single","meterVoltage":"sample string 6","availableSupplyCapacity":1.0,"included":true,"outOfContract":true,"comparison":true,"type":"sample string 10","standardSettlementCode":1,"rateNames":{"unitRateName":"sample string 1","nightUnitRateName":"sample string 2","weekendUnitRateName":"sample string 3"},"meterSerialNumber":"sample string 11","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:22:12.3164819+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:22:12.3164819+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2},"meterTimeswitchClass":1,"meterStatus":"sample string 12","gspGroupId":"sample string 13","exitZone":"sample string 14","dataAggregatorMpid":"sample string 15","industryDataAggregatorEfDate":"sample string 16","industryDatacollectorEfDate":"sample string 17","industrySupplierEFDate":"sample string 18","dataAggregatorEfDate":"2026-08-05T04:22:12.3164819+00:00","dataCollectorMpid":"sample string 19","datacollectorEfDate":"2026-08-05T04:22:12.3164819+00:00","mhhsIndicator":"sample string 20","connectionType":"sample string 21","industryAnnualConsumption":"sample string 22","annualConsumption":1,"industryAnnualConsumptionEfd":"sample string 23","annualConsumptionEfd":"2026-08-05T04:22:12.3164819+00:00","annualConsumptionQualityIndicator":"sample string 24","duosTariffId":"sample string 25","consumerType":"sample string 26","domesticConsumerIndicator":"sample string 27","relationshipStatusIndicator":"sample string 28","supplierEFDate":"2026-08-05T04:22:12.3164819+00:00","industryMeterType":"sample string 29","industryMeterTypeDescription":"sample string 30","industryCurrentSupplierName":"sample string 31","industryCurrentSupplierMPID":"sample string 32","ldzId":"sample string 33","energyDirection":"sample string 34","energisationStatus":"sample string 35","energisationStatusDescription":"sample string 36","energyDirectionDescription":"sample string 37","mhhsIndicatorDescription":"sample string 38","annualConsumptionQualityIndicatorDescription":"sample string 39","domesticConsumerIndicatorDescription":"sample string 40","relationshipStatusIndicatorDescription":"sample string 41","isIndustryUpdateRequired":true}

application/xml, text/xml

Sample:

<ElectricityMeterPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
  <AnnualConsumption>1</AnnualConsumption>
  <AnnualConsumptionEfd>2026-08-05T04:22:12.3164819+00:00</AnnualConsumptionEfd>
  <AnnualConsumptionQualityIndicator>sample string 24</AnnualConsumptionQualityIndicator>
  <AnnualConsumptionQualityIndicatorDescription>sample string 39</AnnualConsumptionQualityIndicatorDescription>
  <Commission>1</Commission>
  <Comparison>true</Comparison>
  <ConnectionType>sample string 21</ConnectionType>
  <ConsumerType>sample string 26</ConsumerType>
  <ConsumptionPeriodId>5</ConsumptionPeriodId>
  <CurrentContractEndDate>2026-08-05T04:22:12.3164819+00:00</CurrentContractEndDate>
  <DataAggregatorEfDate>2026-08-05T04:22:12.3164819+00:00</DataAggregatorEfDate>
  <DataAggregatorMpid>sample string 15</DataAggregatorMpid>
  <DataCollectorMpid>sample string 19</DataCollectorMpid>
  <DatacollectorEfDate>2026-08-05T04:22:12.3164819+00:00</DatacollectorEfDate>
  <DomesticConsumerIndicator>sample string 27</DomesticConsumerIndicator>
  <DomesticConsumerIndicatorDescription>sample string 40</DomesticConsumerIndicatorDescription>
  <DuosTariffId>sample string 25</DuosTariffId>
  <EnergisationStatus>sample string 35</EnergisationStatus>
  <EnergisationStatusDescription>sample string 36</EnergisationStatusDescription>
  <EnergyDirection>sample string 34</EnergyDirection>
  <EnergyDirectionDescription>sample string 37</EnergyDirectionDescription>
  <ExitZone>sample string 14</ExitZone>
  <GSPGroupId>sample string 13</GSPGroupId>
  <Included>true</Included>
  <IndustryAnnualConsumption>sample string 22</IndustryAnnualConsumption>
  <IndustryAnnualConsumptionEfd>sample string 23</IndustryAnnualConsumptionEfd>
  <IndustryCurrentSupplierMPID>sample string 32</IndustryCurrentSupplierMPID>
  <IndustryCurrentSupplierName>sample string 31</IndustryCurrentSupplierName>
  <IndustryDataAggregatorEfDate>sample string 16</IndustryDataAggregatorEfDate>
  <IndustryDatacollectorEfDate>sample string 17</IndustryDatacollectorEfDate>
  <IndustryMeterType>sample string 29</IndustryMeterType>
  <IndustryMeterTypeDescription>sample string 30</IndustryMeterTypeDescription>
  <IndustrySupplierEFDate>sample string 18</IndustrySupplierEFDate>
  <IsAmr>64</IsAmr>
  <IsCommisionFromCustomer>true</IsCommisionFromCustomer>
  <IsCommisionFromSite>true</IsCommisionFromSite>
  <IsImport>true</IsImport>
  <IsIndustryUpdateRequired>true</IsIndustryUpdateRequired>
  <MHHSIndicator>sample string 20</MHHSIndicator>
  <MHHSIndicatorDescription>sample string 38</MHHSIndicatorDescription>
  <MPAN>sample string 1</MPAN>
  <MPANOverwritten>true</MPANOverwritten>
  <MeterSerialNumber>sample string 11</MeterSerialNumber>
  <MeterStatus>sample string 12</MeterStatus>
  <MeterTimeswitchClass>1</MeterTimeswitchClass>
  <MpanParts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MpanParts>
  <NightUnitRate>1</NightUnitRate>
  <NightUsage>1</NightUsage>
  <OutOfContract>true</OutOfContract>
  <PreferredContractEndDate>2026-08-05T04:22:12.3164819+00:00</PreferredContractEndDate>
  <PreferredContractStartDate>2026-08-05T04:22:12.3164819+00:00</PreferredContractStartDate>
  <RateType>Single</RateType>
  <RelationshipStatusIndicator>sample string 28</RelationshipStatusIndicator>
  <RelationshipStatusIndicatorDescription>sample string 41</RelationshipStatusIndicatorDescription>
  <StandardSettlementCode>1</StandardSettlementCode>
  <StandingCharge>1</StandingCharge>
  <StandingChargePeriodId>4</StandingChargePeriodId>
  <SupplierEFDate>2026-08-05T04:22:12.3164819+00:00</SupplierEFDate>
  <SupplierId>1</SupplierId>
  <Type>sample string 10</Type>
  <UnitRate>1</UnitRate>
  <Usage>1</Usage>
  <WeekendUnitRate>1</WeekendUnitRate>
  <WeekendUsage>1</WeekendUsage>
  <availableSupplyCapacity>1</availableSupplyCapacity>
  <existingArrangement>
    <MeterConnectionTypeId>2</MeterConnectionTypeId>
    <MeterConnectionTypeName>sample string 1</MeterConnectionTypeName>
    <dcda>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2026-08-05T04:22:12.3164819+00:00</StartEndDate>
    </dcda>
    <mop>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2026-08-05T04:22:12.3164819+00:00</StartEndDate>
    </mop>
  </existingArrangement>
  <ldzId>sample string 33</ldzId>
  <meterVoltage>sample string 6</meterVoltage>
  <rateNames>
    <NightUnitRateName>sample string 2</NightUnitRateName>
    <UnitRateName>sample string 1</UnitRateName>
    <WeekendUnitRateName>sample string 3</WeekendUnitRateName>
  </rateNames>
</ElectricityMeterPost>

Response Information

Resource Description

ElectricPostResponse

Name	Description	Type	Additional information
Id		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1
}

text/html

Sample:

{"id":1}

application/xml, text/xml

Sample:

<ElectricPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
  <Id>1</Id>
</ElectricPostResponse>