GET request/customer/{CustomerId}/site/{SiteId}/meter/gas?ProductId={ProductId}

Display Customer Site's Gas meter information

Request Information

URI Parameters

Name	Type	Additional information
CustomerId	integer	Required
ProductId	byte	Required
SiteId	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of GasMeterView

Name	Type	Additional information
AnnualValue	decimal number	None.
availableSupplyCapacity	decimal number	None.
Commission	decimal number	None.
ComparisionTypeId	integer	None.
Comparison	boolean	None.
Consumption	integer	None.
ConsumptionPeriodId	integer	None.
CurrentContractEndDate	date	None.
CustomerId	integer	None.
DateCreated	date	None.
DateModified	date	None.
existingArrangement	DcDaMeterDetails	None.
Included	boolean	None.
IsAmr	byte	None.
IsCommisionFromCustomer	boolean	None.
IsCommisionFromSite	boolean	None.
IsImport	boolean	None.
IsinBespokeQuote	boolean	None.
MeterId	integer	None.
MeterSerialNumber	string	None.
meterVoltage	string	None.
MPRN	string	None.
MPRNOverwritten	boolean	None.
OutOfContract	boolean	None.
PreferredContractEndDate	date	None.
PreferredContractStartDate	date	None.
SiteId	integer	None.
StandingCharge	decimal number	None.
StandingChargePeriodId	integer	None.
SupplierId	integer	None.
Type	string	None.
UnitRate	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "siteId": 1,
    "meterId": 2,
    "customerId": 3,
    "annualValue": 1.0,
    "dateCreated": "2025-11-05T12:22:27.4088624+00:00",
    "dateModified": "2025-11-05T12:22:27.4088624+00:00",
    "isinBespokeQuote": true,
    "supplierId": 1,
    "mprn": "sample string 6",
    "mprnOverwritten": true,
    "isAmr": 64,
    "standingCharge": 1.0,
    "unitRate": 1.0,
    "consumption": 1,
    "comparisionTypeId": 9,
    "standingChargePeriodId": 10,
    "consumptionPeriodId": 11,
    "currentContractEndDate": "2025-11-05T12:22:27.4088624+00:00",
    "preferredContractStartDate": "2025-11-05T12:22:27.4088624+00:00",
    "preferredContractEndDate": "2025-11-05T12:22:27.4088624+00:00",
    "isCommisionFromCustomer": true,
    "isCommisionFromSite": true,
    "commission": 1.0,
    "meterVoltage": "sample string 12",
    "availableSupplyCapacity": 1.0,
    "outOfContract": true,
    "comparison": true,
    "type": "sample string 15",
    "included": true,
    "meterSerialNumber": "sample string 17",
    "isImport": true,
    "existingArrangement": {
      "dcda": {
        "hasExistingArrangement": true,
        "providerName": "sample string 1",
        "startEndDate": "2025-11-05T12:22:27.4088624+00:00"
      },
      "mop": {
        "hasExistingArrangement": true,
        "providerName": "sample string 1",
        "startEndDate": "2025-11-05T12:22:27.4088624+00:00"
      },
      "meterConnectionTypeName": "sample string 1",
      "meterConnectionTypeId": 2
    }
  },
  {
    "siteId": 1,
    "meterId": 2,
    "customerId": 3,
    "annualValue": 1.0,
    "dateCreated": "2025-11-05T12:22:27.4088624+00:00",
    "dateModified": "2025-11-05T12:22:27.4088624+00:00",
    "isinBespokeQuote": true,
    "supplierId": 1,
    "mprn": "sample string 6",
    "mprnOverwritten": true,
    "isAmr": 64,
    "standingCharge": 1.0,
    "unitRate": 1.0,
    "consumption": 1,
    "comparisionTypeId": 9,
    "standingChargePeriodId": 10,
    "consumptionPeriodId": 11,
    "currentContractEndDate": "2025-11-05T12:22:27.4088624+00:00",
    "preferredContractStartDate": "2025-11-05T12:22:27.4088624+00:00",
    "preferredContractEndDate": "2025-11-05T12:22:27.4088624+00:00",
    "isCommisionFromCustomer": true,
    "isCommisionFromSite": true,
    "commission": 1.0,
    "meterVoltage": "sample string 12",
    "availableSupplyCapacity": 1.0,
    "outOfContract": true,
    "comparison": true,
    "type": "sample string 15",
    "included": true,
    "meterSerialNumber": "sample string 17",
    "isImport": true,
    "existingArrangement": {
      "dcda": {
        "hasExistingArrangement": true,
        "providerName": "sample string 1",
        "startEndDate": "2025-11-05T12:22:27.4088624+00:00"
      },
      "mop": {
        "hasExistingArrangement": true,
        "providerName": "sample string 1",
        "startEndDate": "2025-11-05T12:22:27.4088624+00:00"
      },
      "meterConnectionTypeName": "sample string 1",
      "meterConnectionTypeId": 2
    }
  }
]

text/html

Sample:

[{"siteId":1,"meterId":2,"customerId":3,"annualValue":1.0,"dateCreated":"2025-11-05T12:22:27.4088624+00:00","dateModified":"2025-11-05T12:22:27.4088624+00:00","isinBespokeQuote":true,"supplierId":1,"mprn":"sample string 6","mprnOverwritten":true,"isAmr":64,"standingCharge":1.0,"unitRate":1.0,"consumption":1,"comparisionTypeId":9,"standingChargePeriodId":10,"consumptionPeriodId":11,"currentContractEndDate":"2025-11-05T12:22:27.4088624+00:00","preferredContractStartDate":"2025-11-05T12:22:27.4088624+00:00","preferredContractEndDate":"2025-11-05T12:22:27.4088624+00:00","isCommisionFromCustomer":true,"isCommisionFromSite":true,"commission":1.0,"meterVoltage":"sample string 12","availableSupplyCapacity":1.0,"outOfContract":true,"comparison":true,"type":"sample string 15","included":true,"meterSerialNumber":"sample string 17","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-11-05T12:22:27.4088624+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-11-05T12:22:27.4088624+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}},{"siteId":1,"meterId":2,"customerId":3,"annualValue":1.0,"dateCreated":"2025-11-05T12:22:27.4088624+00:00","dateModified":"2025-11-05T12:22:27.4088624+00:00","isinBespokeQuote":true,"supplierId":1,"mprn":"sample string 6","mprnOverwritten":true,"isAmr":64,"standingCharge":1.0,"unitRate":1.0,"consumption":1,"comparisionTypeId":9,"standingChargePeriodId":10,"consumptionPeriodId":11,"currentContractEndDate":"2025-11-05T12:22:27.4088624+00:00","preferredContractStartDate":"2025-11-05T12:22:27.4088624+00:00","preferredContractEndDate":"2025-11-05T12:22:27.4088624+00:00","isCommisionFromCustomer":true,"isCommisionFromSite":true,"commission":1.0,"meterVoltage":"sample string 12","availableSupplyCapacity":1.0,"outOfContract":true,"comparison":true,"type":"sample string 15","included":true,"meterSerialNumber":"sample string 17","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-11-05T12:22:27.4088624+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-11-05T12:22:27.4088624+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}}]

application/xml, text/xml

Sample:

<ArrayOfGasMeterView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
  <GasMeterView>
    <Commission>1</Commission>
    <ComparisionTypeId>9</ComparisionTypeId>
    <Comparison>true</Comparison>
    <Consumption>1</Consumption>
    <ConsumptionPeriodId>11</ConsumptionPeriodId>
    <CurrentContractEndDate>2025-11-05T12:22:27.4088624+00:00</CurrentContractEndDate>
    <Included>true</Included>
    <IsAmr>64</IsAmr>
    <IsCommisionFromCustomer>true</IsCommisionFromCustomer>
    <IsCommisionFromSite>true</IsCommisionFromSite>
    <IsImport>true</IsImport>
    <MPRN>sample string 6</MPRN>
    <MPRNOverwritten>true</MPRNOverwritten>
    <MeterSerialNumber>sample string 17</MeterSerialNumber>
    <OutOfContract>true</OutOfContract>
    <PreferredContractEndDate>2025-11-05T12:22:27.4088624+00:00</PreferredContractEndDate>
    <PreferredContractStartDate>2025-11-05T12:22:27.4088624+00:00</PreferredContractStartDate>
    <StandingCharge>1</StandingCharge>
    <StandingChargePeriodId>10</StandingChargePeriodId>
    <SupplierId>1</SupplierId>
    <Type>sample string 15</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-11-05T12:22:27.4088624+00:00</StartEndDate>
      </dcda>
      <mop>
        <HasExistingArrangement>true</HasExistingArrangement>
        <ProviderName>sample string 1</ProviderName>
        <StartEndDate>2025-11-05T12:22:27.4088624+00:00</StartEndDate>
      </mop>
    </existingArrangement>
    <meterVoltage>sample string 12</meterVoltage>
    <AnnualValue>1</AnnualValue>
    <CustomerId>3</CustomerId>
    <DateCreated>2025-11-05T12:22:27.4088624+00:00</DateCreated>
    <DateModified>2025-11-05T12:22:27.4088624+00:00</DateModified>
    <IsinBespokeQuote>true</IsinBespokeQuote>
    <MeterId>2</MeterId>
    <SiteId>1</SiteId>
  </GasMeterView>
  <GasMeterView>
    <Commission>1</Commission>
    <ComparisionTypeId>9</ComparisionTypeId>
    <Comparison>true</Comparison>
    <Consumption>1</Consumption>
    <ConsumptionPeriodId>11</ConsumptionPeriodId>
    <CurrentContractEndDate>2025-11-05T12:22:27.4088624+00:00</CurrentContractEndDate>
    <Included>true</Included>
    <IsAmr>64</IsAmr>
    <IsCommisionFromCustomer>true</IsCommisionFromCustomer>
    <IsCommisionFromSite>true</IsCommisionFromSite>
    <IsImport>true</IsImport>
    <MPRN>sample string 6</MPRN>
    <MPRNOverwritten>true</MPRNOverwritten>
    <MeterSerialNumber>sample string 17</MeterSerialNumber>
    <OutOfContract>true</OutOfContract>
    <PreferredContractEndDate>2025-11-05T12:22:27.4088624+00:00</PreferredContractEndDate>
    <PreferredContractStartDate>2025-11-05T12:22:27.4088624+00:00</PreferredContractStartDate>
    <StandingCharge>1</StandingCharge>
    <StandingChargePeriodId>10</StandingChargePeriodId>
    <SupplierId>1</SupplierId>
    <Type>sample string 15</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-11-05T12:22:27.4088624+00:00</StartEndDate>
      </dcda>
      <mop>
        <HasExistingArrangement>true</HasExistingArrangement>
        <ProviderName>sample string 1</ProviderName>
        <StartEndDate>2025-11-05T12:22:27.4088624+00:00</StartEndDate>
      </mop>
    </existingArrangement>
    <meterVoltage>sample string 12</meterVoltage>
    <AnnualValue>1</AnnualValue>
    <CustomerId>3</CustomerId>
    <DateCreated>2025-11-05T12:22:27.4088624+00:00</DateCreated>
    <DateModified>2025-11-05T12:22:27.4088624+00:00</DateModified>
    <IsinBespokeQuote>true</IsinBespokeQuote>
    <MeterId>2</MeterId>
    <SiteId>1</SiteId>
  </GasMeterView>
</ArrayOfGasMeterView>