GET request/customer/{customerId}/summary

Display a specific customer's company summary

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

integer

Required

Body Parameters

None.

Response Information

Resource Description

CustomerSummaryDto
NameDescriptionTypeAdditional information
ElectricityCommission

string

None.

GasCommission

string

None.

TotalAnnualLiveElecCommission

string

None.

TotalAnnualLiveElecQuantity

string

None.

TotalAnnualLiveElecValue

string

None.

TotalAnnualLiveGasCommission

string

None.

TotalAnnualLiveGasQuantity

string

None.

TotalAnnualLiveGasValue

string

None.

TotalLiveElecSite

string

None.

TotalLiveGasSite

string

None.

Response Formats

application/json, text/json

Sample:
{
  "totalLiveElecSite": "sample string 1",
  "totalLiveGasSite": "sample string 2",
  "totalAnnualLiveElecQuantity": "sample string 3",
  "totalAnnualLiveGasQuantity": "sample string 4",
  "totalAnnualLiveElecValue": "sample string 5",
  "totalAnnualLiveGasValue": "sample string 6",
  "totalAnnualLiveElecCommission": "sample string 7",
  "totalAnnualLiveGasCommission": "sample string 8",
  "gasCommission": "sample string 9",
  "electricityCommission": "sample string 10"
}

text/html

Sample:
{"totalLiveElecSite":"sample string 1","totalLiveGasSite":"sample string 2","totalAnnualLiveElecQuantity":"sample string 3","totalAnnualLiveGasQuantity":"sample string 4","totalAnnualLiveElecValue":"sample string 5","totalAnnualLiveGasValue":"sample string 6","totalAnnualLiveElecCommission":"sample string 7","totalAnnualLiveGasCommission":"sample string 8","gasCommission":"sample string 9","electricityCommission":"sample string 10"}

application/xml, text/xml

Sample:
<CustomerSummaryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.CustomerDto">
  <ElectricityCommission>sample string 10</ElectricityCommission>
  <GasCommission>sample string 9</GasCommission>
  <TotalAnnualLiveElecCommission>sample string 7</TotalAnnualLiveElecCommission>
  <TotalAnnualLiveElecQuantity>sample string 3</TotalAnnualLiveElecQuantity>
  <TotalAnnualLiveElecValue>sample string 5</TotalAnnualLiveElecValue>
  <TotalAnnualLiveGasCommission>sample string 8</TotalAnnualLiveGasCommission>
  <TotalAnnualLiveGasQuantity>sample string 4</TotalAnnualLiveGasQuantity>
  <TotalAnnualLiveGasValue>sample string 6</TotalAnnualLiveGasValue>
  <TotalLiveElecSite>sample string 1</TotalLiveElecSite>
  <TotalLiveGasSite>sample string 2</TotalLiveGasSite>
</CustomerSummaryDto>