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

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId		integer	Required
SiteId		integer	Required

Body Parameters

ElectricityMeterPost

Name	Type	Additional information
availableSupplyCapacity	decimal number	None.
Commission	decimal number	None.
Comparison	boolean	None.
ConsumptionPeriodId	integer	None.
CurrentContractEndDate	date	None.
existingArrangement	DcDaMeterDetails	None.
Included	boolean	None.
IsAmr	byte	None.
IsCommisionFromCustomer	boolean	None.
IsCommisionFromSite	boolean	None.
IsImport	boolean	None.
MeterSerialNumber	string	None.
meterVoltage	string	None.
MPAN	string	None.
MPANOverwritten	boolean	None.
NightUnitRate	decimal number	None.
NightUsage	integer	None.
OutOfContract	boolean	None.
PreferredContractEndDate	date	None.
PreferredContractStartDate	date	None.
rateNames	RateNames	None.
RateType	RateType	None.
StandardSettlementCode	integer	None.
StandingCharge	decimal number	None.
StandingChargePeriodId	integer	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",
  "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": "2025-06-26T05:16:53.8759868+00:00",
  "preferredContractStartDate": "2025-06-26T05:16:53.8759868+00:00",
  "preferredContractEndDate": "2025-06-26T05:16:53.8759868+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": 11,
  "rateNames": {
    "unitRateName": "sample string 1",
    "nightUnitRateName": "sample string 2",
    "weekendUnitRateName": "sample string 3"
  },
  "meterSerialNumber": "sample string 12",
  "isImport": true,
  "existingArrangement": {
    "dcda": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2025-06-26T05:16:53.8759868+00:00"
    },
    "mop": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2025-06-26T05:16:53.8759868+00:00"
    },
    "meterConnectionTypeName": "sample string 1",
    "meterConnectionTypeId": 2
  }
}

text/html

Sample:

{"supplierId":1,"mpan":"sample string 1","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":"2025-06-26T05:16:53.8759868+00:00","preferredContractStartDate":"2025-06-26T05:16:53.8759868+00:00","preferredContractEndDate":"2025-06-26T05:16:53.8759868+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":11,"rateNames":{"unitRateName":"sample string 1","nightUnitRateName":"sample string 2","weekendUnitRateName":"sample string 3"},"meterSerialNumber":"sample string 12","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-06-26T05:16:53.8759868+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-06-26T05:16:53.8759868+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}}

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">
  <Commission>1</Commission>
  <Comparison>true</Comparison>
  <ConsumptionPeriodId>5</ConsumptionPeriodId>
  <CurrentContractEndDate>2025-06-26T05:16:53.8759868+00:00</CurrentContractEndDate>
  <Included>true</Included>
  <IsAmr>64</IsAmr>
  <IsCommisionFromCustomer>true</IsCommisionFromCustomer>
  <IsCommisionFromSite>true</IsCommisionFromSite>
  <IsImport>true</IsImport>
  <MPAN>sample string 1</MPAN>
  <MPANOverwritten>true</MPANOverwritten>
  <MeterSerialNumber>sample string 12</MeterSerialNumber>
  <NightUnitRate>1</NightUnitRate>
  <NightUsage>1</NightUsage>
  <OutOfContract>true</OutOfContract>
  <PreferredContractEndDate>2025-06-26T05:16:53.8759868+00:00</PreferredContractEndDate>
  <PreferredContractStartDate>2025-06-26T05:16:53.8759868+00:00</PreferredContractStartDate>
  <RateType>Single</RateType>
  <StandardSettlementCode>11</StandardSettlementCode>
  <StandingCharge>1</StandingCharge>
  <StandingChargePeriodId>4</StandingChargePeriodId>
  <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>2025-06-26T05:16:53.8759868+00:00</StartEndDate>
    </dcda>
    <mop>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2025-06-26T05:16:53.8759868+00:00</StartEndDate>
    </mop>
  </existingArrangement>
  <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>