Input fields

externalIdentifier : String! required

The market supply point identification number.
joinSwimlaneType : JoinSwimlaneType! required
monthlyPaymentAmount : Int

The monthly payment amount for this supply_point to set for a regular or instalment payment schedule.
moveInTransactionTypeCode : MoveInTransactionTypeCode
note : String

Additional notes.
priorityCategory : PriorityCategory
product : String! required

The code of the product to be enrolled.
productCharacteristicsList : [CharacteristicValueInput]

List of product characteristics for the selected product.
rateOverrides : [RatesInputType!]

Rates that will override a product's rates in a resulting agreement.
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! required

The requested supply start date for the supply point.
supplyPointCharacteristicsList : [CharacteristicValueInput]

List of supply point characteristics.
totalPaymentAmount : Int

The total payment amount for this supply point to use to calculate instalments for an instalment payment schedule.
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": "33024126", "joinSwimlaneType": "SWITCH", "monthlyPaymentAmount": 36, "moveInTransactionTypeCode": "STANDARD", "note": "task-finally-into-nearly-though", "priorityCategory": "STANDARD", "product": "trouble-suddenly-range-attorney-cost", "productCharacteristicsList": CharacteristicValueInput, "rateOverrides": RatesInputType, "ratesAgreedAt": "2000-04-28T03:44:36.523582+00:00", "requestedSupplyStartDate": "2025-11-16", "supplyPointCharacteristicsList": CharacteristicValueInput, "totalPaymentAmount": 93 }