POST request/quickquote
Add a new quick quote
Request Information
URI Parameters
None.
Body Parameters
QuickQouteRequestName | Description | Type | Additional information |
---|---|---|---|
ChannelId | integer |
None. |
|
CompanyType | byte |
None. |
|
ComparisionTypeId | integer |
None. |
|
ConsumptionPeriodId | integer |
None. |
|
ContractEndDate | date |
None. |
|
ContractStartDate | date |
None. |
|
CurrentSupplierId | integer |
None. |
|
DayRate | decimal number |
None. |
|
DayUsage | integer |
None. |
|
EnergyDirection | string |
None. |
|
EveningWeekendRate | decimal number |
None. |
|
EveningWeekendUsage | integer |
None. |
|
IsAmr |
E.g. IsAMR is 0,1 or 2 (0=Dumb, 1= AMR, 2=Smart) |
byte |
None. |
MeterSerialNumber | string |
None. |
|
Mpan | string |
None. |
|
Mprn | string |
None. |
|
NightUnitRate | decimal number |
None. |
|
NightUsage | integer |
None. |
|
PostCode | string |
None. |
|
RateType | RateType |
None. |
|
SiteAddress | AddressInfo |
None. |
|
StandardSettlementCode | integer |
None. |
|
StandingCharge | decimal number |
None. |
|
Status | Status |
None. |
|
UnitRate | decimal number |
None. |
|
UnitUsage | integer |
None. |
|
WeekDayRate | decimal number |
None. |
|
WeekDayUsage | integer |
None. |
|
WeekendUnitRate | decimal number |
None. |
|
WeekendUsage | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "postCode": "sample string 1", "mpan": "sample string 2", "mprn": "sample string 3", "comparisionTypeId": 4, "consumptionPeriodId": 5, "channelId": 1, "isAmr": 64, "contractStartDate": "2025-06-26T20:48:29.9842564+00:00", "contractEndDate": "2025-06-26T20:48:29.9842564+00:00", "siteAddress": { "line1": "sample string 1", "line2": "sample string 2", "city": "sample string 3", "county": "sample string 4", "postcode": "sample string 5" }, "rateType": "Single", "currentSupplierId": 7, "unitRate": 1.0, "unitUsage": 1, "dayRate": 1.0, "dayUsage": 1, "nightUnitRate": 1.0, "nightUsage": 1, "weekDayRate": 1.0, "weekDayUsage": 1, "eveningWeekendRate": 1.0, "eveningWeekendUsage": 1, "weekendUnitRate": 1.0, "weekendUsage": 1, "status": "Saved", "standingCharge": 1.0, "companyType": 64, "standardSettlementCode": 8, "meterSerialNumber": "sample string 9", "energyDirection": "sample string 10" }
text/html
Sample:
{"postCode":"sample string 1","mpan":"sample string 2","mprn":"sample string 3","comparisionTypeId":4,"consumptionPeriodId":5,"channelId":1,"isAmr":64,"contractStartDate":"2025-06-26T20:48:29.9842564+00:00","contractEndDate":"2025-06-26T20:48:29.9842564+00:00","siteAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"rateType":"Single","currentSupplierId":7,"unitRate":1.0,"unitUsage":1,"dayRate":1.0,"dayUsage":1,"nightUnitRate":1.0,"nightUsage":1,"weekDayRate":1.0,"weekDayUsage":1,"eveningWeekendRate":1.0,"eveningWeekendUsage":1,"weekendUnitRate":1.0,"weekendUsage":1,"status":"Saved","standingCharge":1.0,"companyType":64,"standardSettlementCode":8,"meterSerialNumber":"sample string 9","energyDirection":"sample string 10"}
application/xml, text/xml
Sample:
<QuickQouteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuickQuoteDto"> <ChannelId>1</ChannelId> <CompanyType>64</CompanyType> <ComparisionTypeId>4</ComparisionTypeId> <ConsumptionPeriodId>5</ConsumptionPeriodId> <ContractEndDate>2025-06-26T20:48:29.9842564+00:00</ContractEndDate> <ContractStartDate>2025-06-26T20:48:29.9842564+00:00</ContractStartDate> <CurrentSupplierId>7</CurrentSupplierId> <DayRate>1</DayRate> <DayUsage>1</DayUsage> <EnergyDirection>sample string 10</EnergyDirection> <EveningWeekendRate>1</EveningWeekendRate> <EveningWeekendUsage>1</EveningWeekendUsage> <IsAmr>64</IsAmr> <MeterSerialNumber>sample string 9</MeterSerialNumber> <Mpan>sample string 2</Mpan> <Mprn>sample string 3</Mprn> <NightUnitRate>1</NightUnitRate> <NightUsage>1</NightUsage> <PostCode>sample string 1</PostCode> <RateType>Single</RateType> <SiteAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default"> <d2p1:City>sample string 3</d2p1:City> <d2p1:County>sample string 4</d2p1:County> <d2p1:Line1>sample string 1</d2p1:Line1> <d2p1:Line2>sample string 2</d2p1:Line2> <d2p1:Postcode>sample string 5</d2p1:Postcode> </SiteAddress> <StandardSettlementCode>8</StandardSettlementCode> <StandingCharge>1</StandingCharge> <Status>Saved</Status> <UnitRate>1</UnitRate> <UnitUsage>1</UnitUsage> <WeekDayRate>1</WeekDayRate> <WeekDayUsage>1</WeekDayUsage> <WeekendUnitRate>1</WeekendUnitRate> <WeekendUsage>1</WeekendUsage> </QuickQouteRequest>
Response Information
Resource Description
QuickQouteResponseName | Description | Type | Additional information |
---|---|---|---|
CustomerId | integer |
None. |
|
MeterId | integer |
None. |
|
SiteId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "meterId": 1, "siteId": 2, "customerId": 1 }
text/html
Sample:
{"meterId":1,"siteId":2,"customerId":1}
application/xml, text/xml
Sample:
<QuickQouteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuickQuoteDto"> <CustomerId>1</CustomerId> <MeterId>1</MeterId> <SiteId>2</SiteId> </QuickQouteResponse>