POST request/customer/{CustomerId}/site/{SiteId}/meters
Submits meter details for a customer site.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId | integer |
Required |
|
| SiteId | integer |
Required |
Body Parameters
Collection of MpxnPost| Name | Description | Type | Additional information |
|---|---|---|---|
| AnnualConsumption | string |
None. |
|
| AnnualConsumptionEfd | string |
None. |
|
| AnnualConsumptionQualityIndicator | string |
None. |
|
| Comparison | boolean |
None. |
|
| ConnectionType | string |
None. |
|
| ConsumerType | string |
None. |
|
| Consumption | integer |
None. |
|
| CurrentSupplierName | string |
None. |
|
| DataAggregatorMpid | string |
None. |
|
| DataCollectorMpid | string |
None. |
|
| DomesticConsumerIndicator | string |
None. |
|
| DuosTariffId | string |
None. |
|
| EnergisationStatus | string |
None. |
|
| EnergyDirection | string |
None. |
|
| existingArrangement | DcDaMeterDetails |
None. |
|
| ExitZone | string |
None. |
|
| FuelId | byte |
None. |
|
| GSPGroupId | string |
None. |
|
| IndustryDataAggregatorEfDate | string |
None. |
|
| IndustryDatacollectorEfDate | string |
None. |
|
| IndustryMeterType | string |
None. |
|
| IndustryMeterTypeDescription | string |
None. |
|
| IndustrySupplierEFDate | string |
None. |
|
| IsAmr | byte |
None. |
|
| lastMeterReadType | string |
None. |
|
| lastMeterReadTypeDescription | string |
None. |
|
| ldzId | string |
None. |
|
| MeterSerialNumber | string |
None. |
|
| MeterStatus | string |
None. |
|
| MeterTimeswitchClass | integer |
None. |
|
| MHHSIndicator | string |
None. |
|
| Mpxn | string |
None. |
|
| RelationshipStatusIndicator | string |
None. |
|
| StandardSettlementCode | integer |
None. |
|
| SupplierEfd | string |
None. |
|
| SupplierId | integer |
None. |
|
| SupplierMPID | string |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"mpxn": "sample string 1",
"isAmr": 64,
"standardSettlementCode": 1,
"meterTimeswitchClass": 1,
"supplierId": 1,
"fuelId": 64,
"comparison": true,
"consumption": 1,
"meterSerialNumber": "sample string 5",
"energyDirection": "sample string 6",
"energisationStatus": "sample string 7",
"meterStatus": "sample string 8",
"gspGroupId": "sample string 9",
"exitZone": "sample string 10",
"dataAggregatorMpid": "sample string 11",
"industryDataAggregatorEfDate": "sample string 12",
"dataCollectorMpid": "sample string 13",
"industryDatacollectorEfDate": "sample string 14",
"mhhsIndicator": "sample string 15",
"connectionType": "sample string 16",
"annualConsumption": "sample string 17",
"annualConsumptionEfd": "sample string 18",
"annualConsumptionQualityIndicator": "sample string 19",
"lastMeterReadType": "sample string 20",
"lastMeterReadTypeDescription": "sample string 21",
"duosTariffId": "sample string 22",
"consumerType": "sample string 23",
"domesticConsumerIndicator": "sample string 24",
"relationshipStatusIndicator": "sample string 25",
"industrySupplierEFDate": "sample string 26",
"industryMeterType": "sample string 27",
"industryMeterTypeDescription": "sample string 28",
"ldzId": "sample string 29",
"supplierMPID": "sample string 30",
"supplierEfd": "sample string 31",
"currentSupplierName": "sample string 32",
"existingArrangement": {
"dcda": {
"hasExistingArrangement": true,
"providerName": "sample string 1",
"startEndDate": "2026-08-05T04:22:24.7385968+00:00"
},
"mop": {
"hasExistingArrangement": true,
"providerName": "sample string 1",
"startEndDate": "2026-08-05T04:22:24.7385968+00:00"
},
"meterConnectionTypeName": "sample string 1",
"meterConnectionTypeId": 2
}
},
{
"mpxn": "sample string 1",
"isAmr": 64,
"standardSettlementCode": 1,
"meterTimeswitchClass": 1,
"supplierId": 1,
"fuelId": 64,
"comparison": true,
"consumption": 1,
"meterSerialNumber": "sample string 5",
"energyDirection": "sample string 6",
"energisationStatus": "sample string 7",
"meterStatus": "sample string 8",
"gspGroupId": "sample string 9",
"exitZone": "sample string 10",
"dataAggregatorMpid": "sample string 11",
"industryDataAggregatorEfDate": "sample string 12",
"dataCollectorMpid": "sample string 13",
"industryDatacollectorEfDate": "sample string 14",
"mhhsIndicator": "sample string 15",
"connectionType": "sample string 16",
"annualConsumption": "sample string 17",
"annualConsumptionEfd": "sample string 18",
"annualConsumptionQualityIndicator": "sample string 19",
"lastMeterReadType": "sample string 20",
"lastMeterReadTypeDescription": "sample string 21",
"duosTariffId": "sample string 22",
"consumerType": "sample string 23",
"domesticConsumerIndicator": "sample string 24",
"relationshipStatusIndicator": "sample string 25",
"industrySupplierEFDate": "sample string 26",
"industryMeterType": "sample string 27",
"industryMeterTypeDescription": "sample string 28",
"ldzId": "sample string 29",
"supplierMPID": "sample string 30",
"supplierEfd": "sample string 31",
"currentSupplierName": "sample string 32",
"existingArrangement": {
"dcda": {
"hasExistingArrangement": true,
"providerName": "sample string 1",
"startEndDate": "2026-08-05T04:22:24.7385968+00:00"
},
"mop": {
"hasExistingArrangement": true,
"providerName": "sample string 1",
"startEndDate": "2026-08-05T04:22:24.7385968+00:00"
},
"meterConnectionTypeName": "sample string 1",
"meterConnectionTypeId": 2
}
}
]
text/html
Sample:
[{"mpxn":"sample string 1","isAmr":64,"standardSettlementCode":1,"meterTimeswitchClass":1,"supplierId":1,"fuelId":64,"comparison":true,"consumption":1,"meterSerialNumber":"sample string 5","energyDirection":"sample string 6","energisationStatus":"sample string 7","meterStatus":"sample string 8","gspGroupId":"sample string 9","exitZone":"sample string 10","dataAggregatorMpid":"sample string 11","industryDataAggregatorEfDate":"sample string 12","dataCollectorMpid":"sample string 13","industryDatacollectorEfDate":"sample string 14","mhhsIndicator":"sample string 15","connectionType":"sample string 16","annualConsumption":"sample string 17","annualConsumptionEfd":"sample string 18","annualConsumptionQualityIndicator":"sample string 19","lastMeterReadType":"sample string 20","lastMeterReadTypeDescription":"sample string 21","duosTariffId":"sample string 22","consumerType":"sample string 23","domesticConsumerIndicator":"sample string 24","relationshipStatusIndicator":"sample string 25","industrySupplierEFDate":"sample string 26","industryMeterType":"sample string 27","industryMeterTypeDescription":"sample string 28","ldzId":"sample string 29","supplierMPID":"sample string 30","supplierEfd":"sample string 31","currentSupplierName":"sample string 32","existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:22:24.7385968+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:22:24.7385968+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}},{"mpxn":"sample string 1","isAmr":64,"standardSettlementCode":1,"meterTimeswitchClass":1,"supplierId":1,"fuelId":64,"comparison":true,"consumption":1,"meterSerialNumber":"sample string 5","energyDirection":"sample string 6","energisationStatus":"sample string 7","meterStatus":"sample string 8","gspGroupId":"sample string 9","exitZone":"sample string 10","dataAggregatorMpid":"sample string 11","industryDataAggregatorEfDate":"sample string 12","dataCollectorMpid":"sample string 13","industryDatacollectorEfDate":"sample string 14","mhhsIndicator":"sample string 15","connectionType":"sample string 16","annualConsumption":"sample string 17","annualConsumptionEfd":"sample string 18","annualConsumptionQualityIndicator":"sample string 19","lastMeterReadType":"sample string 20","lastMeterReadTypeDescription":"sample string 21","duosTariffId":"sample string 22","consumerType":"sample string 23","domesticConsumerIndicator":"sample string 24","relationshipStatusIndicator":"sample string 25","industrySupplierEFDate":"sample string 26","industryMeterType":"sample string 27","industryMeterTypeDescription":"sample string 28","ldzId":"sample string 29","supplierMPID":"sample string 30","supplierEfd":"sample string 31","currentSupplierName":"sample string 32","existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:22:24.7385968+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:22:24.7385968+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}}]
application/xml, text/xml
Sample:
<ArrayOfMpxnPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
<MpxnPost>
<AnnualConsumption>sample string 17</AnnualConsumption>
<AnnualConsumptionEfd>sample string 18</AnnualConsumptionEfd>
<AnnualConsumptionQualityIndicator>sample string 19</AnnualConsumptionQualityIndicator>
<Comparison>true</Comparison>
<ConnectionType>sample string 16</ConnectionType>
<ConsumerType>sample string 23</ConsumerType>
<Consumption>1</Consumption>
<CurrentSupplierName>sample string 32</CurrentSupplierName>
<DataAggregatorMpid>sample string 11</DataAggregatorMpid>
<DataCollectorMpid>sample string 13</DataCollectorMpid>
<DomesticConsumerIndicator>sample string 24</DomesticConsumerIndicator>
<DuosTariffId>sample string 22</DuosTariffId>
<EnergisationStatus>sample string 7</EnergisationStatus>
<EnergyDirection>sample string 6</EnergyDirection>
<ExitZone>sample string 10</ExitZone>
<FuelId>64</FuelId>
<GSPGroupId>sample string 9</GSPGroupId>
<IndustryDataAggregatorEfDate>sample string 12</IndustryDataAggregatorEfDate>
<IndustryDatacollectorEfDate>sample string 14</IndustryDatacollectorEfDate>
<IndustryMeterType>sample string 27</IndustryMeterType>
<IndustryMeterTypeDescription>sample string 28</IndustryMeterTypeDescription>
<IndustrySupplierEFDate>sample string 26</IndustrySupplierEFDate>
<IsAmr>64</IsAmr>
<MHHSIndicator>sample string 15</MHHSIndicator>
<MeterSerialNumber>sample string 5</MeterSerialNumber>
<MeterStatus>sample string 8</MeterStatus>
<MeterTimeswitchClass>1</MeterTimeswitchClass>
<Mpxn>sample string 1</Mpxn>
<RelationshipStatusIndicator>sample string 25</RelationshipStatusIndicator>
<StandardSettlementCode>1</StandardSettlementCode>
<SupplierEfd>sample string 31</SupplierEfd>
<SupplierId>1</SupplierId>
<SupplierMPID>sample string 30</SupplierMPID>
<existingArrangement>
<MeterConnectionTypeId>2</MeterConnectionTypeId>
<MeterConnectionTypeName>sample string 1</MeterConnectionTypeName>
<dcda>
<HasExistingArrangement>true</HasExistingArrangement>
<ProviderName>sample string 1</ProviderName>
<StartEndDate>2026-08-05T04:22:24.7385968+00:00</StartEndDate>
</dcda>
<mop>
<HasExistingArrangement>true</HasExistingArrangement>
<ProviderName>sample string 1</ProviderName>
<StartEndDate>2026-08-05T04:22:24.7385968+00:00</StartEndDate>
</mop>
</existingArrangement>
<lastMeterReadType>sample string 20</lastMeterReadType>
<lastMeterReadTypeDescription>sample string 21</lastMeterReadTypeDescription>
<ldzId>sample string 29</ldzId>
</MpxnPost>
<MpxnPost>
<AnnualConsumption>sample string 17</AnnualConsumption>
<AnnualConsumptionEfd>sample string 18</AnnualConsumptionEfd>
<AnnualConsumptionQualityIndicator>sample string 19</AnnualConsumptionQualityIndicator>
<Comparison>true</Comparison>
<ConnectionType>sample string 16</ConnectionType>
<ConsumerType>sample string 23</ConsumerType>
<Consumption>1</Consumption>
<CurrentSupplierName>sample string 32</CurrentSupplierName>
<DataAggregatorMpid>sample string 11</DataAggregatorMpid>
<DataCollectorMpid>sample string 13</DataCollectorMpid>
<DomesticConsumerIndicator>sample string 24</DomesticConsumerIndicator>
<DuosTariffId>sample string 22</DuosTariffId>
<EnergisationStatus>sample string 7</EnergisationStatus>
<EnergyDirection>sample string 6</EnergyDirection>
<ExitZone>sample string 10</ExitZone>
<FuelId>64</FuelId>
<GSPGroupId>sample string 9</GSPGroupId>
<IndustryDataAggregatorEfDate>sample string 12</IndustryDataAggregatorEfDate>
<IndustryDatacollectorEfDate>sample string 14</IndustryDatacollectorEfDate>
<IndustryMeterType>sample string 27</IndustryMeterType>
<IndustryMeterTypeDescription>sample string 28</IndustryMeterTypeDescription>
<IndustrySupplierEFDate>sample string 26</IndustrySupplierEFDate>
<IsAmr>64</IsAmr>
<MHHSIndicator>sample string 15</MHHSIndicator>
<MeterSerialNumber>sample string 5</MeterSerialNumber>
<MeterStatus>sample string 8</MeterStatus>
<MeterTimeswitchClass>1</MeterTimeswitchClass>
<Mpxn>sample string 1</Mpxn>
<RelationshipStatusIndicator>sample string 25</RelationshipStatusIndicator>
<StandardSettlementCode>1</StandardSettlementCode>
<SupplierEfd>sample string 31</SupplierEfd>
<SupplierId>1</SupplierId>
<SupplierMPID>sample string 30</SupplierMPID>
<existingArrangement>
<MeterConnectionTypeId>2</MeterConnectionTypeId>
<MeterConnectionTypeName>sample string 1</MeterConnectionTypeName>
<dcda>
<HasExistingArrangement>true</HasExistingArrangement>
<ProviderName>sample string 1</ProviderName>
<StartEndDate>2026-08-05T04:22:24.7385968+00:00</StartEndDate>
</dcda>
<mop>
<HasExistingArrangement>true</HasExistingArrangement>
<ProviderName>sample string 1</ProviderName>
<StartEndDate>2026-08-05T04:22:24.7385968+00:00</StartEndDate>
</mop>
</existingArrangement>
<lastMeterReadType>sample string 20</lastMeterReadType>
<lastMeterReadTypeDescription>sample string 21</lastMeterReadTypeDescription>
<ldzId>sample string 29</ldzId>
</MpxnPost>
</ArrayOfMpxnPost>
Response Information
Resource Description
booleanResponse Formats
application/json, text/json, text/html
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>