Skip to main content

Fields

agreement : AgreementType

The agreement created for the activation process.

annualConsumption : ElectricityAnnualConsumption

The annual consumption linked to this activation process.

Deprecation
The 'annualConsumption' field is deprecated.

Use the field 'annualConsumptionByTemporalClass' instead.

- Marked as deprecated on 2026-06-23.
- Scheduled for removal on or after 2026-12-31.
annualConsumptionByTemporalClass : [AnnualConsumptionByTemporalClassType]

The annual consumption per temporal class linked to this activation process.

billingAddress : AddressType

The addresses fields.

caseId : String
id : ID! required

ID of the activation process.

isIbanStoredForSetupOfInstruction : Boolean

If an IBAN for activation is already stored on the activation process.

journeyType : JourneyType! required

The type of journey the client is in, either commissioning or change of supplier.

providerCalendarId : String

The provider calendar.

quotedProduct : QuotedProduct

The quoted product of the activation process.

requestedSupplyStartDate : Date! required

Requested supply start date.

status : ActivationProcessStatus! required

Status of the activation process.

storedIban : String

The stored IBAN for the activation process.

subscribedMaxPower : Decimal
subscriptionType : ActivationProcessSubscriptionType! required
supplyPoint : SupplyPointType

The supply point linked to the agreement of the activation process.

userEmail : String! required

The email of the identified user.

userFamilyName : String! required

The family name of the identified user.

userGivenName : String! required

The given name of the identified user.

userMobile : String! required

The mobile of the identified user.

withdrawalPeriodEndsAt : DateTime! required
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

{ "agreement": AgreementType, "annualConsumptionByTemporalClass": [AnnualConsumptionByTemporalClassType], "billingAddress": AddressType, "caseId": "47167418", "id": "81439920", "isIbanStoredForSetupOfInstruction": true, "journeyType": "COMMISSIONING", "prm": ElectricityMeterPoint, "providerCalendarId": "50776886", "quotedProduct": QuotedProduct, "requestedSupplyStartDate": "2022-02-09", "status": "NEW", "storedIban": "us-senior-have-lead-goal", "subscribedMaxPower": "1.0", "subscriptionType": "CDF", "supplyPoint": SupplyPointType, "userEmail": "how-likely-admit-camera-collection", "userFamilyName": "Knight", "userGivenName": "Monica", "userMobile": "represent-change-leader-physical-career", "withdrawalPeriodEndsAt": "1974-07-06T03:52:25.186291+00:00" }