POST request/Comparison/Results
Provides a comparison of ALL possible energy plans that a business could potentially switch to.
Request Information
URI Parameters
None.
Body Parameters
The results filter.
ResultsBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CommissionMinimumMargin | decimal number |
None. |
|
| CommissionUplift | decimal number |
None. |
|
| ContractType | ContractTypeEnum |
None. |
|
| HasAutomaticMeterReading | boolean |
None. |
|
| IsBasedOnPreferredNewContractEndDate | boolean |
None. |
|
| IsSwitchable | boolean |
None. |
|
| LengthOfContract | LengthOfContract |
None. |
|
| PayMethod | PayMethod |
None. |
|
| SiteId | integer |
Required |
|
| Skip | integer |
None. |
|
| Take | integer |
None. |
|
| UtilityType | UtilityType |
Required |
|
| WithZeroStandingCharge | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"utilityType": "Electricity",
"payMethod": "DirectDebit",
"contractType": "Standard",
"lengthOfContract": "One",
"withZeroStandingCharge": true,
"isSwitchable": true,
"skip": 1,
"take": 1,
"isBasedOnPreferredNewContractEndDate": true,
"hasAutomaticMeterReading": true,
"commissionUplift": 1.0,
"commissionMinimumMargin": 1.0,
"siteId": 1
}
text/html
Sample:
{"utilityType":"Electricity","payMethod":"DirectDebit","contractType":"Standard","lengthOfContract":"One","withZeroStandingCharge":true,"isSwitchable":true,"skip":1,"take":1,"isBasedOnPreferredNewContractEndDate":true,"hasAutomaticMeterReading":true,"commissionUplift":1.0,"commissionMinimumMargin":1.0,"siteId":1}
application/xml, text/xml
Sample:
<ResultsBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.BindingModel"> <SiteId>1</SiteId> <CommissionMinimumMargin>1</CommissionMinimumMargin> <CommissionUplift>1</CommissionUplift> <ContractType>Standard</ContractType> <HasAutomaticMeterReading>true</HasAutomaticMeterReading> <IsBasedOnPreferredNewContractEndDate>true</IsBasedOnPreferredNewContractEndDate> <IsSwitchable>true</IsSwitchable> <LengthOfContract>One</LengthOfContract> <PayMethod>DirectDebit</PayMethod> <Skip>1</Skip> <Take>1</Take> <WithZeroStandingCharge>true</WithZeroStandingCharge> <UtilityType>Electricity</UtilityType> </ResultsBindingModel>
Response Information
Resource Description
ResultsDtoResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ApiVersion | string |
None. |
|
| ResultsDto | ResultsDto |
None. |
|
| Uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"apiVersion": "sample string 1",
"uri": "sample string 2",
"resultsDto": {
"results": [
{
"switchKey": "sample string 1",
"switchKeyInfo": "sample string 2",
"payMethod": "DirectDebit",
"contractType": "Standard",
"lengthOfContract": "One",
"lengthOfContractInDays": 1,
"withZeroStandingCharge": true,
"switchOption": "None",
"comparisonType": "Acquisition",
"priceTypeBasedOn": "Current",
"hasAutomaticMeterReading": true,
"isBasedOnPreferredNewContractEndDate": true,
"isSimulated": true,
"exitZone": "sample string 3",
"localDistributionZone": "sample string 4",
"distributionNetworkOperatorAreaId": "sample string 5",
"contractStartDate": "2025-06-28T03:15:53.1271785+00:00",
"contractEndDate": "2025-06-28T03:15:53.1271785+00:00",
"vatType": "Standard",
"rateType": "Single",
"tariffId": 6,
"tariffName": "sample string 7",
"tariffDetails": [
"sample string 1",
"sample string 2"
],
"supplierId": 64,
"supplierName": "sample string 9",
"supplierDescription": "sample string 10",
"standingCharge": 1.0,
"standingChargeUnit": "PencePerDay",
"totalStandingCharge": 1.0,
"tariffRateInfos": [
{
"totalUsage": 1.0,
"usageUnit": "Monthly",
"totalCost": 1.0,
"rateMeterType": "Single",
"unitRate": 1.0,
"unitRateUnit": "PencePerKwh"
},
{
"totalUsage": 1.0,
"usageUnit": "Monthly",
"totalCost": 1.0,
"rateMeterType": "Single",
"unitRate": 1.0,
"unitRateUnit": "PencePerKwh"
}
],
"savingsExcludingVat": 1.0,
"savingsIncludingVat": 1.0,
"totalCostIncludinglvat": 1.0,
"totalCostExcludingVat": 1.0,
"totalVat": 1.0,
"totalUsage": 1.0,
"includesCommissionUpLift": true,
"includesCommissionFromMug": true,
"includesCommissionMinimumMargin": true,
"totalCommission": 14.0,
"commission": 15.0
},
{
"switchKey": "sample string 1",
"switchKeyInfo": "sample string 2",
"payMethod": "DirectDebit",
"contractType": "Standard",
"lengthOfContract": "One",
"lengthOfContractInDays": 1,
"withZeroStandingCharge": true,
"switchOption": "None",
"comparisonType": "Acquisition",
"priceTypeBasedOn": "Current",
"hasAutomaticMeterReading": true,
"isBasedOnPreferredNewContractEndDate": true,
"isSimulated": true,
"exitZone": "sample string 3",
"localDistributionZone": "sample string 4",
"distributionNetworkOperatorAreaId": "sample string 5",
"contractStartDate": "2025-06-28T03:15:53.1271785+00:00",
"contractEndDate": "2025-06-28T03:15:53.1271785+00:00",
"vatType": "Standard",
"rateType": "Single",
"tariffId": 6,
"tariffName": "sample string 7",
"tariffDetails": [
"sample string 1",
"sample string 2"
],
"supplierId": 64,
"supplierName": "sample string 9",
"supplierDescription": "sample string 10",
"standingCharge": 1.0,
"standingChargeUnit": "PencePerDay",
"totalStandingCharge": 1.0,
"tariffRateInfos": [
{
"totalUsage": 1.0,
"usageUnit": "Monthly",
"totalCost": 1.0,
"rateMeterType": "Single",
"unitRate": 1.0,
"unitRateUnit": "PencePerKwh"
},
{
"totalUsage": 1.0,
"usageUnit": "Monthly",
"totalCost": 1.0,
"rateMeterType": "Single",
"unitRate": 1.0,
"unitRateUnit": "PencePerKwh"
}
],
"savingsExcludingVat": 1.0,
"savingsIncludingVat": 1.0,
"totalCostIncludinglvat": 1.0,
"totalCostExcludingVat": 1.0,
"totalVat": 1.0,
"totalUsage": 1.0,
"includesCommissionUpLift": true,
"includesCommissionFromMug": true,
"includesCommissionMinimumMargin": true,
"totalCommission": 14.0,
"commission": 15.0
}
]
}
}
text/html
Sample:
{"apiVersion":"sample string 1","uri":"sample string 2","resultsDto":{"results":[{"switchKey":"sample string 1","switchKeyInfo":"sample string 2","payMethod":"DirectDebit","contractType":"Standard","lengthOfContract":"One","lengthOfContractInDays":1,"withZeroStandingCharge":true,"switchOption":"None","comparisonType":"Acquisition","priceTypeBasedOn":"Current","hasAutomaticMeterReading":true,"isBasedOnPreferredNewContractEndDate":true,"isSimulated":true,"exitZone":"sample string 3","localDistributionZone":"sample string 4","distributionNetworkOperatorAreaId":"sample string 5","contractStartDate":"2025-06-28T03:15:53.1271785+00:00","contractEndDate":"2025-06-28T03:15:53.1271785+00:00","vatType":"Standard","rateType":"Single","tariffId":6,"tariffName":"sample string 7","tariffDetails":["sample string 1","sample string 2"],"supplierId":64,"supplierName":"sample string 9","supplierDescription":"sample string 10","standingCharge":1.0,"standingChargeUnit":"PencePerDay","totalStandingCharge":1.0,"tariffRateInfos":[{"totalUsage":1.0,"usageUnit":"Monthly","totalCost":1.0,"rateMeterType":"Single","unitRate":1.0,"unitRateUnit":"PencePerKwh"},{"totalUsage":1.0,"usageUnit":"Monthly","totalCost":1.0,"rateMeterType":"Single","unitRate":1.0,"unitRateUnit":"PencePerKwh"}],"savingsExcludingVat":1.0,"savingsIncludingVat":1.0,"totalCostIncludinglvat":1.0,"totalCostExcludingVat":1.0,"totalVat":1.0,"totalUsage":1.0,"includesCommissionUpLift":true,"includesCommissionFromMug":true,"includesCommissionMinimumMargin":true,"totalCommission":14.0,"commission":15.0},{"switchKey":"sample string 1","switchKeyInfo":"sample string 2","payMethod":"DirectDebit","contractType":"Standard","lengthOfContract":"One","lengthOfContractInDays":1,"withZeroStandingCharge":true,"switchOption":"None","comparisonType":"Acquisition","priceTypeBasedOn":"Current","hasAutomaticMeterReading":true,"isBasedOnPreferredNewContractEndDate":true,"isSimulated":true,"exitZone":"sample string 3","localDistributionZone":"sample string 4","distributionNetworkOperatorAreaId":"sample string 5","contractStartDate":"2025-06-28T03:15:53.1271785+00:00","contractEndDate":"2025-06-28T03:15:53.1271785+00:00","vatType":"Standard","rateType":"Single","tariffId":6,"tariffName":"sample string 7","tariffDetails":["sample string 1","sample string 2"],"supplierId":64,"supplierName":"sample string 9","supplierDescription":"sample string 10","standingCharge":1.0,"standingChargeUnit":"PencePerDay","totalStandingCharge":1.0,"tariffRateInfos":[{"totalUsage":1.0,"usageUnit":"Monthly","totalCost":1.0,"rateMeterType":"Single","unitRate":1.0,"unitRateUnit":"PencePerKwh"},{"totalUsage":1.0,"usageUnit":"Monthly","totalCost":1.0,"rateMeterType":"Single","unitRate":1.0,"unitRateUnit":"PencePerKwh"}],"savingsExcludingVat":1.0,"savingsIncludingVat":1.0,"totalCostIncludinglvat":1.0,"totalCostExcludingVat":1.0,"totalVat":1.0,"totalUsage":1.0,"includesCommissionUpLift":true,"includesCommissionFromMug":true,"includesCommissionMinimumMargin":true,"totalCommission":14.0,"commission":15.0}]}}
application/xml, text/xml
Sample:
<ResultsDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.DtoResponse">
<ApiVersion>sample string 1</ApiVersion>
<ResultsDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Dto">
<d2p1:Results>
<d2p1:ResultDto>
<d2p1:Commission>15</d2p1:Commission>
<d2p1:ComparisonType>Acquisition</d2p1:ComparisonType>
<d2p1:ContractEndDate>2025-06-28T03:15:53.1271785+00:00</d2p1:ContractEndDate>
<d2p1:ContractStartDate>2025-06-28T03:15:53.1271785+00:00</d2p1:ContractStartDate>
<d2p1:ContractType>Standard</d2p1:ContractType>
<d2p1:DistributionNetworkOperatorAreaId>sample string 5</d2p1:DistributionNetworkOperatorAreaId>
<d2p1:ExitZone>sample string 3</d2p1:ExitZone>
<d2p1:HasAutomaticMeterReading>true</d2p1:HasAutomaticMeterReading>
<d2p1:IncludesCommissionFromMug>true</d2p1:IncludesCommissionFromMug>
<d2p1:IncludesCommissionMinimumMargin>true</d2p1:IncludesCommissionMinimumMargin>
<d2p1:IncludesCommissionUpLift>true</d2p1:IncludesCommissionUpLift>
<d2p1:IsBasedOnPreferredNewContractEndDate>true</d2p1:IsBasedOnPreferredNewContractEndDate>
<d2p1:IsSimulated>true</d2p1:IsSimulated>
<d2p1:LengthOfContract>One</d2p1:LengthOfContract>
<d2p1:LengthOfContractInDays>1</d2p1:LengthOfContractInDays>
<d2p1:LocalDistributionZone>sample string 4</d2p1:LocalDistributionZone>
<d2p1:PayMethod>DirectDebit</d2p1:PayMethod>
<d2p1:PriceTypeBasedOn>Current</d2p1:PriceTypeBasedOn>
<d2p1:RateType>Single</d2p1:RateType>
<d2p1:SavingsExcludingVat>1</d2p1:SavingsExcludingVat>
<d2p1:SavingsIncludingVat>1</d2p1:SavingsIncludingVat>
<d2p1:StandingCharge>1</d2p1:StandingCharge>
<d2p1:StandingChargeUnit>PencePerDay</d2p1:StandingChargeUnit>
<d2p1:SupplierDescription>sample string 10</d2p1:SupplierDescription>
<d2p1:SupplierId>64</d2p1:SupplierId>
<d2p1:SupplierName>sample string 9</d2p1:SupplierName>
<d2p1:SwitchKey>sample string 1</d2p1:SwitchKey>
<d2p1:SwitchKeyInfo>sample string 2</d2p1:SwitchKeyInfo>
<d2p1:SwitchOption>None</d2p1:SwitchOption>
<d2p1:TariffDetails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:TariffDetails>
<d2p1:TariffId>6</d2p1:TariffId>
<d2p1:TariffName>sample string 7</d2p1:TariffName>
<d2p1:TariffRateInfos xmlns:d5p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.Switch">
<d5p1:TariffRateInfo>
<d5p1:RateMeterType>Single</d5p1:RateMeterType>
<d5p1:UnitRate>1</d5p1:UnitRate>
<d5p1:UnitRateUnit>PencePerKwh</d5p1:UnitRateUnit>
<d5p1:TotalCost>1</d5p1:TotalCost>
<d5p1:TotalUsage>1</d5p1:TotalUsage>
<d5p1:UsageUnit>Monthly</d5p1:UsageUnit>
</d5p1:TariffRateInfo>
<d5p1:TariffRateInfo>
<d5p1:RateMeterType>Single</d5p1:RateMeterType>
<d5p1:UnitRate>1</d5p1:UnitRate>
<d5p1:UnitRateUnit>PencePerKwh</d5p1:UnitRateUnit>
<d5p1:TotalCost>1</d5p1:TotalCost>
<d5p1:TotalUsage>1</d5p1:TotalUsage>
<d5p1:UsageUnit>Monthly</d5p1:UsageUnit>
</d5p1:TariffRateInfo>
</d2p1:TariffRateInfos>
<d2p1:TotalCommission>14</d2p1:TotalCommission>
<d2p1:TotalCostExcludingVat>1</d2p1:TotalCostExcludingVat>
<d2p1:TotalCostIncludinglvat>1</d2p1:TotalCostIncludinglvat>
<d2p1:TotalStandingCharge>1</d2p1:TotalStandingCharge>
<d2p1:TotalUsage>1</d2p1:TotalUsage>
<d2p1:TotalVat>1</d2p1:TotalVat>
<d2p1:VatType>Standard</d2p1:VatType>
<d2p1:WithZeroStandingCharge>true</d2p1:WithZeroStandingCharge>
</d2p1:ResultDto>
<d2p1:ResultDto>
<d2p1:Commission>15</d2p1:Commission>
<d2p1:ComparisonType>Acquisition</d2p1:ComparisonType>
<d2p1:ContractEndDate>2025-06-28T03:15:53.1271785+00:00</d2p1:ContractEndDate>
<d2p1:ContractStartDate>2025-06-28T03:15:53.1271785+00:00</d2p1:ContractStartDate>
<d2p1:ContractType>Standard</d2p1:ContractType>
<d2p1:DistributionNetworkOperatorAreaId>sample string 5</d2p1:DistributionNetworkOperatorAreaId>
<d2p1:ExitZone>sample string 3</d2p1:ExitZone>
<d2p1:HasAutomaticMeterReading>true</d2p1:HasAutomaticMeterReading>
<d2p1:IncludesCommissionFromMug>true</d2p1:IncludesCommissionFromMug>
<d2p1:IncludesCommissionMinimumMargin>true</d2p1:IncludesCommissionMinimumMargin>
<d2p1:IncludesCommissionUpLift>true</d2p1:IncludesCommissionUpLift>
<d2p1:IsBasedOnPreferredNewContractEndDate>true</d2p1:IsBasedOnPreferredNewContractEndDate>
<d2p1:IsSimulated>true</d2p1:IsSimulated>
<d2p1:LengthOfContract>One</d2p1:LengthOfContract>
<d2p1:LengthOfContractInDays>1</d2p1:LengthOfContractInDays>
<d2p1:LocalDistributionZone>sample string 4</d2p1:LocalDistributionZone>
<d2p1:PayMethod>DirectDebit</d2p1:PayMethod>
<d2p1:PriceTypeBasedOn>Current</d2p1:PriceTypeBasedOn>
<d2p1:RateType>Single</d2p1:RateType>
<d2p1:SavingsExcludingVat>1</d2p1:SavingsExcludingVat>
<d2p1:SavingsIncludingVat>1</d2p1:SavingsIncludingVat>
<d2p1:StandingCharge>1</d2p1:StandingCharge>
<d2p1:StandingChargeUnit>PencePerDay</d2p1:StandingChargeUnit>
<d2p1:SupplierDescription>sample string 10</d2p1:SupplierDescription>
<d2p1:SupplierId>64</d2p1:SupplierId>
<d2p1:SupplierName>sample string 9</d2p1:SupplierName>
<d2p1:SwitchKey>sample string 1</d2p1:SwitchKey>
<d2p1:SwitchKeyInfo>sample string 2</d2p1:SwitchKeyInfo>
<d2p1:SwitchOption>None</d2p1:SwitchOption>
<d2p1:TariffDetails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</d2p1:TariffDetails>
<d2p1:TariffId>6</d2p1:TariffId>
<d2p1:TariffName>sample string 7</d2p1:TariffName>
<d2p1:TariffRateInfos xmlns:d5p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.Switch">
<d5p1:TariffRateInfo>
<d5p1:RateMeterType>Single</d5p1:RateMeterType>
<d5p1:UnitRate>1</d5p1:UnitRate>
<d5p1:UnitRateUnit>PencePerKwh</d5p1:UnitRateUnit>
<d5p1:TotalCost>1</d5p1:TotalCost>
<d5p1:TotalUsage>1</d5p1:TotalUsage>
<d5p1:UsageUnit>Monthly</d5p1:UsageUnit>
</d5p1:TariffRateInfo>
<d5p1:TariffRateInfo>
<d5p1:RateMeterType>Single</d5p1:RateMeterType>
<d5p1:UnitRate>1</d5p1:UnitRate>
<d5p1:UnitRateUnit>PencePerKwh</d5p1:UnitRateUnit>
<d5p1:TotalCost>1</d5p1:TotalCost>
<d5p1:TotalUsage>1</d5p1:TotalUsage>
<d5p1:UsageUnit>Monthly</d5p1:UsageUnit>
</d5p1:TariffRateInfo>
</d2p1:TariffRateInfos>
<d2p1:TotalCommission>14</d2p1:TotalCommission>
<d2p1:TotalCostExcludingVat>1</d2p1:TotalCostExcludingVat>
<d2p1:TotalCostIncludinglvat>1</d2p1:TotalCostIncludinglvat>
<d2p1:TotalStandingCharge>1</d2p1:TotalStandingCharge>
<d2p1:TotalUsage>1</d2p1:TotalUsage>
<d2p1:TotalVat>1</d2p1:TotalVat>
<d2p1:VatType>Standard</d2p1:VatType>
<d2p1:WithZeroStandingCharge>true</d2p1:WithZeroStandingCharge>
</d2p1:ResultDto>
</d2p1:Results>
</ResultsDto>
<Uri>sample string 2</Uri>
</ResultsDtoResponse>