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

Add Customer Site's Gas meter information

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId		integer	Required
SiteId		integer	Required

Body Parameters

GasMeterPost

Name	Type	Additional information
availableSupplyCapacity	decimal number	None.
Commission	decimal number	None.
ComparisionTypeId	integer	None.
Comparison	boolean	None.
Consumption	integer	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.
MPRN	string	None.
MPRNOverwritten	boolean	None.
OutOfContract	boolean	None.
PreferredContractEndDate	date	None.
PreferredContractStartDate	date	None.
StandingCharge	decimal number	None.
StandingChargePeriodId	integer	None.
SupplierId	integer	None.
Type	string	None.
UnitRate	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "supplierId": 1,
  "mprn": "sample string 1",
  "mprnOverwritten": true,
  "isAmr": 64,
  "standingCharge": 1.0,
  "unitRate": 1.0,
  "consumption": 1,
  "comparisionTypeId": 4,
  "standingChargePeriodId": 5,
  "consumptionPeriodId": 6,
  "currentContractEndDate": "2025-06-26T11:42:18.3219543+00:00",
  "preferredContractStartDate": "2025-06-26T11:42:18.3219543+00:00",
  "preferredContractEndDate": "2025-06-26T11:42:18.3219543+00:00",
  "isCommisionFromCustomer": true,
  "isCommisionFromSite": true,
  "commission": 1.0,
  "meterVoltage": "sample string 7",
  "availableSupplyCapacity": 1.0,
  "outOfContract": true,
  "comparison": true,
  "type": "sample string 10",
  "included": true,
  "meterSerialNumber": "sample string 12",
  "isImport": true,
  "existingArrangement": {
    "dcda": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2025-06-26T11:42:18.3219543+00:00"
    },
    "mop": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2025-06-26T11:42:18.3219543+00:00"
    },
    "meterConnectionTypeName": "sample string 1",
    "meterConnectionTypeId": 2
  }
}

text/html

Sample:

{"supplierId":1,"mprn":"sample string 1","mprnOverwritten":true,"isAmr":64,"standingCharge":1.0,"unitRate":1.0,"consumption":1,"comparisionTypeId":4,"standingChargePeriodId":5,"consumptionPeriodId":6,"currentContractEndDate":"2025-06-26T11:42:18.3219543+00:00","preferredContractStartDate":"2025-06-26T11:42:18.3219543+00:00","preferredContractEndDate":"2025-06-26T11:42:18.3219543+00:00","isCommisionFromCustomer":true,"isCommisionFromSite":true,"commission":1.0,"meterVoltage":"sample string 7","availableSupplyCapacity":1.0,"outOfContract":true,"comparison":true,"type":"sample string 10","included":true,"meterSerialNumber":"sample string 12","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-06-26T11:42:18.3219543+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-06-26T11:42:18.3219543+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}}

application/xml, text/xml

Sample:

<GasMeterPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
  <Commission>1</Commission>
  <ComparisionTypeId>4</ComparisionTypeId>
  <Comparison>true</Comparison>
  <Consumption>1</Consumption>
  <ConsumptionPeriodId>6</ConsumptionPeriodId>
  <CurrentContractEndDate>2025-06-26T11:42:18.3219543+00:00</CurrentContractEndDate>
  <Included>true</Included>
  <IsAmr>64</IsAmr>
  <IsCommisionFromCustomer>true</IsCommisionFromCustomer>
  <IsCommisionFromSite>true</IsCommisionFromSite>
  <IsImport>true</IsImport>
  <MPRN>sample string 1</MPRN>
  <MPRNOverwritten>true</MPRNOverwritten>
  <MeterSerialNumber>sample string 12</MeterSerialNumber>
  <OutOfContract>true</OutOfContract>
  <PreferredContractEndDate>2025-06-26T11:42:18.3219543+00:00</PreferredContractEndDate>
  <PreferredContractStartDate>2025-06-26T11:42:18.3219543+00:00</PreferredContractStartDate>
  <StandingCharge>1</StandingCharge>
  <StandingChargePeriodId>5</StandingChargePeriodId>
  <SupplierId>1</SupplierId>
  <Type>sample string 10</Type>
  <UnitRate>1</UnitRate>
  <availableSupplyCapacity>1</availableSupplyCapacity>
  <existingArrangement>
    <MeterConnectionTypeId>2</MeterConnectionTypeId>
    <MeterConnectionTypeName>sample string 1</MeterConnectionTypeName>
    <dcda>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2025-06-26T11:42:18.3219543+00:00</StartEndDate>
    </dcda>
    <mop>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2025-06-26T11:42:18.3219543+00:00</StartEndDate>
    </mop>
  </existingArrangement>
  <meterVoltage>sample string 7</meterVoltage>
</GasMeterPost>

Response Information

Resource Description

GasPostResponse

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:

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