Skip to main content

Input fields

externalIdentifier : String! required

The market supply point identification number.

monthlyPaymentAmount : Int

The monthly payment amount to set for a regular payment schedule.

Data required for move-in enrollment with change of tenancy by transfer and a new product.

Data required for registering a brand new supply point.

product : String! required

The code of the product to be enrolled.

productCharacteristics : GenericScalar

A JSON object containing the product characteristics for the selected product.

ratesAgreedAt : DateTime

The datetime when the rates of the product were agreed. This is usually the datetime corresponding to when the quote/offer was generated.

requestedSupplyStartDate : Date

The requested supply start date for the supply point.

requestedSupplyStartDateType : RequestedDateType

The requested supply start date type for the supply point.

Data required for retailer switch enrollment, optionally carrying administrative (change of tenancy) and/or technical changes.

supplyPointCharacteristicsList : [CharacteristicValueInput]

List of supply point characteristics.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "externalIdentifier": "17451946", "monthlyPaymentAmount": 53, "moveInData": ElectricityProductCatalogMoveInEnrollmentMarketInput, "newSupplyData": ElectricityProductCatalogNewSupplyEnrollmentMarketInput, "product": "find-fall-writer-bad-return", "productCharacteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType, "ratesAgreedAt": "2024-08-13T01:26:53.453254+00:00", "requestedSupplyStartDate": "1975-12-05", "requestedSupplyStartDateType": "AS_SOON_AS_POSSIBLE", "retailerSwitchData": ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput, "supplyPointCharacteristicsList": CharacteristicValueInput }