POST request/Switch/Gas

Postcode upfront ONLY data capture for consumer energy quote and switching who is on a single fuel set up which means the property has access to only gas (This is a very rare occurrence as majority of households depend on power as opposed to gas only).

Request Information

URI Parameters

None.

Body Parameters

The gas bill. CurrentUsageEstimated Or CurrentCostEstimated must be entered. If both are entered CurrentUsageEstimated will take preference. EmailAddress is required if AccountManagementOnline is NOT 'UnInterested'. TariffValidToDate should be entered if the tariff's price is fixed from the energy supply start date.

BillGasBindingModel

Name	Type	Additional information
AccountManagementOnline	OnlineTariffOption	None.
BillConsumptionIsEstimated	boolean	Required
CurrentCostEstimated	decimal number	Data type: Currency Range: inclusive between 0 and 9000
CurrentPayMethod	PayMethod	Required
CurrentUsageEstimated	integer	Range: inclusive between 0 and 400000
CustomerId	integer	None.
EmailAddress	string	Data type: EmailAddress
IsHappyToBeAutoSwitched	boolean	None.
Postcode	string	Required Data type: PostalCode
ReferrerBranchCode	string	Required Max length: 10
SwitchOwnerReference	string	Max length: 50
SwitchType	SwitchType	Required
TariffId	integer	Required
TariffValidToDate	date	None.
UtilityPeriod	UtilityPeriod	Required

Request Formats

application/json, text/json

Sample:

{
  "tariffId": 1,
  "tariffValidToDate": "2025-04-04T10:47:43.0621884+00:00",
  "currentPayMethod": "MonthlyDirectDebit",
  "utilityPeriod": "Annually",
  "currentCostEstimated": 1.0,
  "currentUsageEstimated": 1,
  "postcode": "sample string 2",
  "switchType": "DualConsolidatedToDualConsolidated",
  "emailAddress": "sample string 3",
  "accountManagementOnline": "Tentative",
  "referrerBranchCode": "sample string 4",
  "billConsumptionIsEstimated": true,
  "isHappyToBeAutoSwitched": true,
  "customerId": 1,
  "switchOwnerReference": "sample string 7"
}

application/xml, text/xml

Sample:

<BillGasBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">
  <AccountManagementOnline>Tentative</AccountManagementOnline>
  <BillConsumptionIsEstimated>true</BillConsumptionIsEstimated>
  <CustomerId>1</CustomerId>
  <EmailAddress>sample string 3</EmailAddress>
  <IsHappyToBeAutoSwitched>true</IsHappyToBeAutoSwitched>
  <Postcode>sample string 2</Postcode>
  <ReferrerBranchCode>sample string 4</ReferrerBranchCode>
  <SwitchOwnerReference>sample string 7</SwitchOwnerReference>
  <SwitchType>DualConsolidatedToDualConsolidated</SwitchType>
  <CurrentCostEstimated>1</CurrentCostEstimated>
  <CurrentPayMethod>MonthlyDirectDebit</CurrentPayMethod>
  <CurrentUsageEstimated>1</CurrentUsageEstimated>
  <TariffId>1</TariffId>
  <TariffValidToDate>2025-04-04T10:47:43.0621884+00:00</TariffValidToDate>
  <UtilityPeriod>Annually</UtilityPeriod>
</BillGasBindingModel>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffValidToDate"

2025-04-04T10:47:43.0621884+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CurrentPayMethod"

MonthlyDirectDebit
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UtilityPeriod"

Annually
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CurrentCostEstimated"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CurrentUsageEstimated"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Postcode"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchType"

DualConsolidatedToDualConsolidated
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmailAddress"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AccountManagementOnline"

Tentative
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ReferrerBranchCode"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BillConsumptionIsEstimated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsHappyToBeAutoSwitched"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchOwnerReference"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

CustomerDtoResponse

Name	Type	Additional information
ApiVersion	string	None.
GeniusSwitchDto	GeniusSwitchDto	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "geniusSwitchDto": {
    "switchId": 1
  }
}

application/xml, text/xml

Sample:

<CustomerDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <GeniusSwitchDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <SwitchId xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Switch">1</SwitchId>
  </GeniusSwitchDto>
  <Uri>sample string 2</Uri>
</CustomerDtoResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiVersion"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Uri"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchDto.SwitchId"

1
--MultipartDataMediaFormatterBoundary1q2w3e--