GraphQL API Changelog

This page shows the history of changes to the GraphQL schema.

Enum value OCPP was added to ProviderChoices enum

Type OnSiteJobsAppointmentType was added
Type OnSiteJobsAppointmentStatus was added
Argument ids: [UUID] added to Query.siteworksRequests
Field appointments was added to object type CoreSiteworksRequestType

Enum value INTERNAL_TESTING was added to IntegrationStatus enum

Field paymentDueDate was added to object type StatementBillingDocumentType

Enum value SMART_PREPAY_TOP_UP_MULTIPLE_ACTIVE_PROCESSES was removed from AccountReminderTypes enum

Type WaterFiltersOutput was added
Union member WaterFiltersOutput was added to UtilityFiltersOutput Union type

Enum value TRACE_FINAL_HB was added to CollectionCampaignType enum

Input Field accountNumber: String was added to input type CreateInkInboundMessageInput

Enum value STRIPE_CONNECT_VOICE was added to Vendor enum

Enum value FAILURE_CAUSE_ERROR was added to SmartFlexChargingErrorCause enum
Enum value NO_SCHEDULED_CHARGE was added to SmartFlexChargingErrorCause enum

Field paymentMethods was added to object type BusinessType
Argument includeDebtLedgers: Boolean added to AccountType.ledgers
Argument includeDebtLedgers: Boolean added to AccountInterface.ledgers

Type OpportunityOutcome was added
Input Field lossReason: String was added to input type SetOpportunityOutcomeInput
Input Field opportunityNumber: ID was added to input type SetOpportunityOutcomeInput
Input Field opportunityId removed from input type SetOpportunityOutcomeInput
SetOpportunityOutcomeInput.outcome type changed from String to OpportunityOutcome
Default value for input field SetOpportunityOutcomeInput.outcome changed from Undefined to None
Field debtLedger of type LedgerInterface was added to interface LedgerInterface
Field debtLedger was added to object type LedgerType

Enum value OUTBOUND_TRIAL was added to CollectionCampaignType enum

Type SpringElectricityComparisonType was added
Enum value CHARITY_SPECIALISED_SUPPORT was added to CollectionCampaignType enum
Field getSpringElectricityComparison was added to object type Query

Enum value GAS_READING_INFORMATION was added to ReadingStatisticTypeEnum enum

Field vehicle was added to object type SelectUserVehicleListItem
Deprecation reason on field SelectUserVehicleListItem.userVehicle changed from None to The 'userVehicle' field is deprecated. Please use 'SelectUserVehicleListItem.vehicle' instead. - Marked as deprecated on 2025-04-10. - Scheduled for removal on or after 2025-07-10.

Input Field subdomain: String! was added to input type AudioRecordingInputType

Field currentEstimatedSsd was added to object type CancelEnrolmentDataType

Type UpdateProductPricesOutput was added
Type RateGroupPrices was added
Type PriceForStream was added
Type UpdateProductPricesInput was added
Type RateGroupPricesInput was added
Type PriceForStreamInput was added
Field updateProductPrices was added to object type Mutation

Enum value YELLOW_UNIT was added to AllBandSubCategories enum
Enum value BLACK_UNIT was added to AllBandSubCategories enum

Enum value LIVE_CHAT was added to InkCommunicationChannel enum

Type TerminateContractInput was removed
Type BaseTerminateContractInput was added
Type PaymentPreferenceConnectionTypeConnection was added
Type PaymentPreferenceConnectionTypeEdge was added
Type PaymentPreferenceUnion was added
Type PreferredInstruction was added
Type UserManagedPayment was added
Field paymentPreferences of type PaymentPreferenceConnectionTypeConnection was added to interface LedgerInterface
Field paymentPreferences was added to object type LedgerType
Type for argument input on field Mutation.terminateAccountContract changed from TerminateContractInput! to BaseTerminateContractInput!
Type for argument input on field Mutation.terminateBusinessContract changed from TerminateContractInput! to BaseTerminateContractInput!

Input Field inferOperationsGroupAttributes: Boolean was added to input type EnqueueInboundCallInput

Type RequestDoubleOptIn was added
Type DoubleOptInInput was added
Field requestDoubleOptIn was added to object type Mutation

Enum value FAKE was removed from VoiceVendor enum
Enum value LEGACY_TWILIO_CTI was removed from VoiceVendor enum

Field isVariable was added to object type GuaranteeOfOriginConfigurationType
Deprecation reason on field GuaranteeOfOriginConfigurationType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
GetHostedUrlForNewPaymentInstructionInput.ledgerNumber type changed from String! to String
Field isVariable was added to object type ContractMetaDataType
Deprecation reason on field ContractMetaDataType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
Deprecation reason on field Mutation.setBatteryChargingPreferences changed from None to The 'setBatteryChargingPreferences' field is deprecated. Please use setDevicePreferences instead of this endpoint. - Marked as deprecated on 2025-04-04. - Scheduled for removal on or after 2025-07-04.
Field isVariable of type Boolean was added to interface TermInterface
Deprecation reason on field TermInterface.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
Field isVariable was added to object type TermType
Deprecation reason on field TermType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
Field isVariable was added to object type MinimumContractLengthType
Deprecation reason on field MinimumContractLengthType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
Field isVariable was added to object type TerminationFeeType
Deprecation reason on field TerminationFeeType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
Field isVariable was added to object type ProductRateOverrideConfigurationType
Deprecation reason on field ProductRateOverrideConfigurationType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.

Type WorkScheduleOpenOrClosedReason was added
Field openOrClosedReason was added to object type WorkScheduleType

Type LifecycleProcessesSortOrder was added
Argument sortOrder: LifecycleProcessesSortOrder added to Query.lifecycleProcesses

Enum value TG_PAYMENTS_MYPAY was added to Vendor enum

Input Field agreedFrom: DateTime was added to input type QuoteAccountOnProductsInput

Field userId was added to object type ResetUserPasswordOutput
Deprecation reason on field ResetUserPasswordOutput.failureCodes changed from None to The 'failureCodes' field is deprecated. Please handle the KT-CT-5450 error and inspect the validationErrors[].code extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the failureCodes, failureReasons, or passwordUpdated fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
Deprecation reason on field ResetUserPasswordOutput.failureReasons changed from None to The 'failureReasons' field is deprecated. Please handle the KT-CT-5450 error and inspect the validationErrors[].message extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the failureCodes, failureReasons, or passwordUpdated fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
Deprecation reason on field ResetUserPasswordOutput.passwordUpdated changed from None to The 'passwordUpdated' field is deprecated. Please handle the KT-CT-5450 error instead. Note that the KT-CT-5450 error will not be raised if you request any of the failureCodes, failureReasons, or passwordUpdated fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.

Type CreateProductOutput was added
Type SupplyProductType was added
Type ProductAvailability was added
Type CreateProductInput was added
Type CharacteristicOverride was added
Field createProduct was added to object type Mutation

Type AssociateCallWithAccount was added
Type AssociateCallWithAccountInput was added
Field associateCallWithAccount was added to object type Mutation

Enum value VIEW_ACCOUNT_NUMBER was added to PreSignedTokenScope enum
Enum value VIEW_ACCOUNT_NUMBER was added to ExpiringTokenScope enum

Field marketName was added to object type GoodsPurchase

Type LoyaltyPointAwardEntryReasonCode was added
Input Field reasonCode: LoyaltyPointAwardEntryReasonCode was added to input type AwardLoyaltyPointsInput
Input Field reason removed from input type AwardLoyaltyPointsInput

Enum value LIVE_DEBT_COLLECTION_HB was added to CollectionCampaignType enum

Field isRiskListed was added to object type PaymentFingerPrintCheckType

Deprecation reason on field Query.bookSmartMeterInstallationUrl changed from None to The 'bookSmartMeterInstallationUrl' field is deprecated. A GraphQL query is not required to find out the URL for booking a smart meter installation. - Marked as deprecated on 2025-04-03. - Scheduled for removal on or after 2025-05-03.

Enum value HUAWEI_V2 was added to ProviderChoices enum

Type CallMetadataItemType was added
Type CreateCallMetadata was added
Type CallMetadataInput was added
Type CallMetadataItemInput was added
Type SkipSSDPayment was added
Type SkipSsdPaymentInput was added
Field metadata was added to object type OutboundCallType
Field createCallMetadata was added to object type Mutation
Field skipSsdPayment was added to object type Mutation
Field metadata was added to object type InboundCallType
Field metadata of type [CallMetadataItemType]! was added to interface CallInterface

Type PassthroughPercentageInput was added
Type BandChoices was added
Input Field passthroughPercentages: [PassthroughPercentageInput] was added to input type ElectricityProductInput
Field affiliateLink was added to object type JoinSupplierProcessDataType
Field salesChannel was added to object type JoinSupplierProcessDataType
Field salesSubchannel was added to object type JoinSupplierProcessDataType

Type AccountLoyaltyPointsType was added
Field loyaltyPointsBalance was added to object type Query

Type CancelEnrolmentDataType was added
Field cancelEnrolmentData was added to object type Query

Type CreateNewLead was removed
Type NewLeadType was removed
Type NewLeadInputType was removed
Field createNewLead was removed from object type Mutation

Field paymentMethods was added to object type AccountUserType

Argument readTo: DateTime added to Query.gasMeterReadings
Argument readFrom: DateTime added to Query.gasMeterReadings
Argument readTo: DateTime added to Query.electricityMeterReadings
Argument readFrom: DateTime added to Query.electricityMeterReadings

Field acceptsPayments was added to object type LedgerType
Field acceptsPayments of type Boolean was added to interface LedgerInterface

Argument accountNumber: String added to Query.accountContract
Type for argument identifier on field Query.accountContract changed from String! to String
Argument accountNumber: String added to Query.businessContract
Type for argument identifier on field Query.businessContract changed from String! to String
Enum value AGED_DEBT_TEAM was added to CollectionCampaignType enum
Enum value SUSPECTED_DEMOLITION was added to CollectionCampaignType enum

Enum value RESPECT_ESCALATION was added to CollectionCampaignType enum

Field opportunityValueByKey was added to object type Query
Field leadValueByKey was removed from object type Query

AddNoteToInkConversationInput.addedAt type changed from DateTime! to DateTime

Type PaymentInstructionConnectionTypeConnection was added
Type PaymentInstructionConnectionTypeEdge was added
Type PaymentInstructionStatus was added
Field paymentMethods of type PaymentInstructionConnectionTypeConnection was added to interface AccountInterface
Field supplementaryLedger was added to object type PaymentInstructionType
Field paymentMethods was added to object type AccountType

Type UpdateSupplyPointMetadata was added
Field updateSupplyPointMetadata was added to object type Mutation

Input Field requestedTerminationDate: Date! was added to input type TerminateContractInput
Input Field requestedTerminationAt removed from input type TerminateContractInput

Type PaymentFingerPrintCheckType was added
Type FetchGeneratePaymentFingerprint was added
Type FetchGeneratePaymentFingerprintInput was added
Field paymentFingerprintChecks was added to object type Query
Field fetchGeneratePaymentFingerprint was added to object type Mutation

Type InkTwilioWhatsApp was added
Union member InkTwilioWhatsApp was added to InkMessage Union type

Enum value TESLA_V2 was added to ProviderChoices enum

Deprecation reason on field Mutation.createHeatPumpGoodsQuote changed from None to The 'createHeatPumpGoodsQuote' field is deprecated. Mutation no longer in use. - Marked as deprecated on 2025-03-26. - Scheduled for removal on or after 2025-04-30.

Type ProductRateOverrideConfigurationType was added
Type IndexationOptionsType was added
Type ProductRateOverrideScheduleType was added
Type ProductRateOverrideItemType was added

Type CompleteOpportunityAction was added
Type CompleteLeadAction was removed
Type CompleteLeadActionInput was removed
Type CompleteOpportunityActionInput was added
Field completeOpportunityAction was added to object type Mutation
Field completeLeadAction was removed from object type Mutation

Type SetLeadOutcome was removed
Type SetLeadOutcomeInput was removed
Type SetOpportunityOutcome was added
Type SetOpportunityOutcomeInput was added
Field setOpportunityOutcome was added to object type Mutation
Field setLeadOutcome was removed from object type Mutation

Type InkNote was added
Type AddNoteToInkConversationPayload was added
Type AddNoteToInkConversationInput was added
Field addNoteToInkConversation was added to object type Mutation

Type GuaranteeOfOriginConfigurationType was added
Type GuaranteeOfOriginPercentage was added

Type GetOrCreateShellAccountForLead was removed
Type GetOrCreateShellAccountForLeadInput was removed
Type GetOrCreateShellAccountForOpportunity was added
Type GetOrCreateShellAccountForOpportunityInput was added
Field getOrCreateAccountForOpportunity was added to object type Mutation
Field getOrCreateAccountForLead was removed from object type Mutation

Type UpdateLeadExtraDetails was removed
Type UpdateOpportunityExtraDetails was added
Input Field opportunityId: ID was added to input type UpdateExtraDetailsInput
Input Field leadId removed from input type UpdateExtraDetailsInput
Field updateOpportunityExtraDetails was added to object type Mutation
Field updateLeadExtraDetails was removed from object type Mutation

Type UpdateLeadState was removed
Type UpdateLeadStateInput was removed
Type UpdateOpportunityState was added
Type UpdateOpportunityStateInput was added
Field updateOpportunityState was added to object type Mutation
Field updateLeadState was removed from object type Mutation

Type TerminateContractInstigated was added
Type TerminateContractInput was added
Field terminateAccountContract was added to object type Mutation
Field terminateBusinessContract was added to object type Mutation

Type MpanInput was added
Type MprnInput was added
Input Field mpansWithMeters: [MpanInput] was added to input type CreateOrUpdateSiteworksAppointmentInput
Input Field mprnsWithMeters: [MprnInput] was added to input type CreateOrUpdateSiteworksAppointmentInput
Input Field electricityMeters removed from input type CreateOrUpdateSiteworksAppointmentInput
Input Field mpan removed from input type CreateOrUpdateSiteworksAppointmentInput
Input Field gasMeters removed from input type CreateOrUpdateSiteworksAppointmentInput
Input Field mprn removed from input type CreateOrUpdateSiteworksAppointmentInput

Type RTSPrimarySecondaryMPANs was added
Field siteworksGetRtsPrimarySecondaryMpans was added to object type Query

Type PublicChargingSession was added
Type ElectricDevice was added
Type DeviceChargingSessionConnection was added
Type DateTimePageInfo was added
Type DeviceChargingSessionEdge was added
Type SmartFlexChargingSession was added
Type DeviceChargingSession was added
Type Money was added
Type SmartFlexChargingType was added
Type SmartFlexDispatch was added
Type SmartFlexChargingProblem was added
Type SmartFlexChargingError was added
Type SmartFlexChargingErrorCause was added
Type SmartFlexChargingTruncation was added
Type SmartFlexChargingTruncationCause was added
Field chargingSessions was added to object type SmartFlexVehicle
SmartFlexVehicle implements new interface ElectricDevice
Field chargingSessions was added to object type SmartFlexChargePoint
SmartFlexChargePoint implements new interface ElectricDevice

Type TerminationFeeType was added
Type TermInterface was added
Type TermType was added
Type MinimumContractLengthType was added
Type ContractMetaDataType was added
Field terms was added to object type Contract

Field isInBlockingMigration was added to object type AccountType

Field isInBlockingMigration was removed from object type AccountType

Type DebtCollectionCampaignType was added
Field collectionCampaign was added to object type DebtCollectionProceedingType
Deprecation reason on field DebtCollectionProceedingType.campaign changed from None to The 'campaign' field is deprecated. Use collectionCampaign instead - Marked as deprecated on 2025-03-20. - Scheduled for removal on or after 2025-04-30.

Type Contract was added
Type ContractParty was added
Type ContractVersion was added
Field businessContract was added to object type Query
Field accountContract was added to object type Query

Enum value IF_CUSTOMER_GETS_IN_CONTACT_PLEASE_ASSIGN_INKS_TO_TEAM_HYPERCARE_IF_CUSTOMER_CALLS_IN_PLEASE_TRANSFER_CUSTOMER_TO_0808_164_1500_IMMEDIATELY_AND_POST_IN_WARRANT_INVOLUNTARY_SWITCHING_HELP was added to CollectionCampaignType enum

Type JoinSupplierProcessDataType was added
Field currentProcessData was added to object type JoinSupplierProcessType

Type AccountCampaignConnectionTypeConnection was added
Type AccountCampaignConnectionTypeEdge was added
Field campaigns was added to object type Query

Input Field inferLanguageAttribute: Boolean was added to input type EnqueueInboundCallInput

Enum value EMAIL was added to SmartMeterInterestSourceChoices enum

Input Field baseUrl: String was added to input type RequestPasswordResetInput

Field referringUserTotalPaymentAmount was added to object type ReferralConnectionTypeConnection

Type AddSignupReferralOnAccount was added
Type AddSignupReferralOnAccountInput was added
Field addSignupReferralOnAccount was added to object type Mutation

Type EnrollAccountInLoyaltyProgram was added
Type EnrollAccountInLoyaltyProgramOutcome was added
Type EnrollAccountInLoyaltyProgramInput was added
Field enrollAccountInLoyaltyProgram was added to object type Mutation

Enum value PPA_EXPORT_INTERVENTION_REQUIRED was added to AccountReminderTypes enum

Enum value TESORO_SEPA_CORE was added to Vendor enum

Input Field leadType removed from input type NewLeadInputType
Field leadType was removed from object type NewLeadType

Input Field runPaymentAdequacy: Boolean was added to input type SwitchMeterPointProductsInput
Input Field updatePaymentAmount removed from input type SwitchMeterPointProductsInput

Type RateLimitInformation was removed
Field rateLimit was removed from object type Query

Type PrepareAccountSupplyPointInput was added
Type SupplyPointInfoInput was added
Input Field supplyPointInfoList: [PrepareAccountSupplyPointInput] was added to input type PrepareAccountInput

Input Field waitingBehaviourUrl: String was added to input type EnqueueInboundCallInput

InboundCallType.id type changed from ID to ID!
CallInterface.id type changed from ID to ID!
OutboundCallType.id type changed from ID to ID!
PhoneNumberIdentificationType.accountUserAllMatches type changed from AccountUserConnectionTypeConnection to AccountUserConnectionTypeConnection!
PhoneNumberIdentificationType.accountAllMatches type changed from AccountConnectionTypeConnection to AccountConnectionTypeConnection!

Enum value CANCEL_ENROLLMENT was added to ExpiringTokenScope enum
Enum value CANCEL_ENROLLMENT was added to PreSignedTokenScope enum

Type WorkScheduleType was added
Field workSchedule was added to object type Query

Type EnqueueInboundCall was added
Type EnqueueInboundCallInput was added
Field enqueueInboundCall was added to object type Mutation

Type PhoneNumberIdentificationType was added
Type AccountUserConnectionTypeConnection was added
Type AccountUserConnectionTypeEdge was added
Field initialCallerIdentification was added to object type InboundCallType

Type OctoPointsType was removed
Type OctoPointsAccountType was removed
Type OctoPointsAccountEventType was removed
Type EventReasonChoices was removed
Type RedeemOctoPointsForAccountCredit was removed
Type RedeemOctoPointsInput was removed
Field octoPoints was removed from object type Query
Field redeemOctoPointsForAccountCredit was removed from object type Mutation

Type ReferralStatus was added
Argument status: ReferralStatus added to AccountInterface.referrals
Argument status: ReferralStatus added to AccountType.referrals

Enum value SMETS2_IHD_HEALTH_CHECK was removed from AccountReminderTypes enum
Enum value SMETS2_DATA_REQUEST_FOLLOWUP was removed from AccountReminderTypes enum

Type OctoplusEnrollmentStatus was added
Type BusinessDetailType was added
Field enrollmentStatus was added to object type OctoplusAccountInfoType
Deprecation reason on field OctoplusAccountInfoType.isOctoplusEnrolled changed from None to The 'isEnrolled' field is deprecated. Please use enrollmentStatus instead - Marked as deprecated on 2025-02-20. - Scheduled for removal on or after 2025-08-01.
Field details was added to object type BusinessType

Type CreateInboundCall was added
Type CreateInboundCallInput was added
Type VoiceVendor was added
Field createInboundCall was added to object type Mutation

Enum value FINAL_DEBT_COLLECTION_HB was added to CollectionCampaignType enum

Directive deprecated was added to input field mpan in input object CreateOrUpdateSiteworksAppointmentInput
Directive deprecated was added to input field mprn in input object CreateOrUpdateSiteworksAppointmentInput

Input Field winterOffPeak: Decimal was added to input type ElectricityBespokeRates
Input Field capacityMarket: Decimal was added to input type ElectricityBespokeRates
Input Field nuclearRab: Decimal was added to input type ElectricityBespokeRates
Input Field tnuos: Decimal was added to input type ElectricityBespokeRates
Input Field summerOffPeak: Decimal was added to input type ElectricityBespokeRates
Input Field summerPeak: Decimal was added to input type ElectricityBespokeRates
Input Field winterPeak: Decimal was added to input type ElectricityBespokeRates

Field gasMeterpoint was added to object type Query
Field electricityMeterpoint was added to object type Query

Type CancelEnrolment was added
Type CancelEnrolmentInput was added
Type WithdrawnReasons was added
Enum value UNKNOWN was added to ExportTechnologyType enum
Field cancelEnrolment was added to object type Mutation

Enum value SMETS2_HEALTH_CHECK was removed from AccountReminderTypes enum

Input Field owners: [OwnerInput] was added to input type CreateDirectDebitInstructionInput

Field ledgerNumber was added to object type DCAProceedingCommencementStatus
Input Field ledgerNumber: String was added to input type CommenceDCAProceedingInputType

Field label of type String was added to interface PropertyInterface
Field label was added to object type PropertyType

Field wofUrls was removed from object type Query

Type OwnerInput was added
Type PaymentInstructionOwnerTypeChoices was added
Type PaymentInstructionOwnerType was added
Input Field owners: [OwnerInput] was added to input type SetUpDirectDebitInstructionInput
Deprecation reason on field Urls.wheelOfFortuneGas changed from None to The 'wheelOfFortuneGas' field is deprecated. Fetching Wheel of Fortune URLs via API is no longer supported. - Marked as deprecated on 2025-02-25. - Scheduled for removal on or after 2025-08-25.
Deprecation reason on field Urls.meterReadingSubmission changed from None to The 'meterReadingSubmission' field is deprecated. Fetching anonymous journey URLs via API is no longer supported. - Marked as deprecated on 2025-02-25. - Scheduled for removal on or after 2025-05-25.
Deprecation reason on field Urls.updateSensitiveCustomerData changed from None to The 'updateSensitiveCustomerData' field is deprecated. Fetching anonymous journey URLs via API is no longer supported. - Marked as deprecated on 2025-02-25. - Scheduled for removal on or after 2025-05-25.
Deprecation reason on field Urls.tariffRenewal changed from None to The 'tariffRenewal' field is deprecated. Fetching anonymous journey URLs via API is no longer supported. - Marked as deprecated on 2025-02-25. - Scheduled for removal on or after 2025-05-25.
Deprecation reason on field Urls.wheelOfFortuneElec changed from None to The 'wheelOfFortuneElec' field is deprecated. Fetching Wheel of Fortune URLs via API is no longer supported. - Marked as deprecated on 2025-02-25. - Scheduled for removal on or after 2025-08-25.
Field owners was added to object type DirectDebitInstructionType
Field owners was added to object type PaymentInstructionType

Field account of type AccountType was added to interface CallInterface
Field account was added to object type InboundCallType
Field account was added to object type OutboundCallType

Type CharityDonationSettings was added
Type CharityDonationAmountChoices was added
Type OptInToCharityDonation was added
Type CharityDonationInput was added
Type UpdateCharityDonation was added
Type OptOutOfCharityDonation was added
Field charityDonationSettings was added to object type Query
Field updateCharityDonation was added to object type Mutation
Field optInToCharityDonation was added to object type Mutation
Field optOutOfCharityDonation was added to object type Mutation

Field accountUrls was removed from object type Query

Field segmentName was added to object type BusinessType

Enum value PORTFOLIO_MANAGEMENT was added to CollectionCampaignType enum

Type CreateAudioRecording was added
Type AudioRecordingType was added
Type AppSessionType was added
Type AppSessionSalesMode was added
Type OutcomeType was added
Type AudioRecordingInputType was added
Type OutcomeInput was added
Type AppSessionTypeChoices was added
Type AppSessionOutcomeCategories was added
Type PhotoInput was added
Field createAudioRecording was added to object type Mutation

Field createAudioRecording was added to object type Mutation
Type AppSessionOutcomeCategories was added
Type AppSessionOutcomeCategory was added
Type AppSessionOutcomeType was added
Type AppSessionSalesMode was added
Type AppSessionType was added
Type AppSessionTypeChoices was added
Type AudioRecordingInputType was added
Type AudioRecordingType was added
Type CreateAudioRecording was added
Type OutcomeInput was added
Type OutcomeType was added
Type PhotoInput was added

Input field owners of type [OwnerInput] was added to input object type SetUpDirectDebitInstructionInput
Type OwnerInput was added
Type PaymentInstructionOwnerTypeChoices was added

Field owners was added to object type DirectDebitInstructionType
Field owners was added to object type PaymentInstructionType
Type PaymentInstructionOwnerType was added

Field Query.termsAndConditionsForProduct changed type from TermsAndConditionsType to GbrTermsAndConditionsType
Type GbrTermsAndConditionsType was added

Field call was added to object type Query
Type CallInterface was added
Type InboundCallType was added
Type OutboundCallType was added

Field supplyEndDate was added to object type ActiveCosLossProcess

Field delayConfiguration was added to object type PaymentScheduleType
Type PaymentScheduleDelayConfigurationType was added

Field getActiveCosLossProcessesForAccount was added to object type Query
Type ActiveCosLossProcess was added
Type CosLossProcessFuelType was added

Field canRenewTariff was added to object type ElectricityMeterPointType
Field canRenewTariff was added to object type GasMeterPointType

Field isDueTariffRenewal was added to object type ElectricityMeterPointType
Field isDueTariffRenewal was added to object type GasMeterPointType

Field sendDecommissionRequest was added to object type Mutation
Type SendDecommissionRequest was added
Type SendDecommissionRequestInput was added

Field fields was added to object type AffiliateAudioRecordingPresignedPostType

Argument identifier: String added to field AccountInterface.bill
Argument identifier: String added to field AccountType.bill

Type for argument id on field AccountInterface.bill changed from ID! to ID
Type for argument id on field AccountType.bill changed from ID! to ID

Field awardLoyaltyPoints was added to object type Mutation
Type AwardLoyaltyPoints was added
Type AwardLoyaltyPointsInput was added

Field linkedAccountNumbers was added to object type BusinessType
Directive deprecated was added to field BusinessType.linkedAccountNumber
Field BusinessType.linkedAccountNumber has deprecation reason The linkedAccountNumber field is deprecated. Please use linkedAccountNumbers instead, businesses can be related to multiple Accounts now. - Marked as deprecated on 2025-02-05. - Scheduled for removal on or after 2025-08-01.
Field BusinessType.linkedAccountNumber is deprecated

Field possibleErrors is deprecated on Mutation type. Please use the possibleErrors query or the X

Field standingChargeUplifts was added to object type ElectricityAgreementType
Field standingChargeUplifts was added to object type GasAgreementType
Type ElectricityContractStandingChargeUplift was added
Type GasContractStandingChargeUplift was added

Field possibleErrors was added to object type PossibleErrorsOutputType
Field possibleErrorsList was removed from object type PossibleErrorsOutputType

Field setLeadOutcome was added to object type Mutation
Type SetLeadOutcome was added
Type SetLeadOutcomeInput was added

Field generateAffiliatesAudioRecordingPreSignedUrl was added to object type Mutation
Type AffiliateAudioRecordingPresignedPostType was added
Type GenerateAffiliatesAudioRecordingPreSignedUrl was added
Type GenerateAffiliatesAudioRecordingPreSignedUrlInput was added

Argument direction: EnergyProductDirection added to field Query.energyProducts

Field electricityMeterPoints was added to object type SiteworksAppointmentType
Field gasMeterPoints was added to object type SiteworksAppointmentType

Field optInInvitationBatchId was added to object type SavingSessionsEventType

Field CoreSiteworksRequestType.status changed type from RequestStatus! to String!

Field direction was added to object type ElectricityMeterPointType
Type ElectricityDirection was added

Directive deprecated was added to argument savingSessionsEnrolmentOptions of field joinOctoplusCampaign in type Mutation
Directive deprecated was added to field EnrolmentOutcome.savingSessions
Field EnrolmentOutcome.savingSessions has deprecation reason The savingSessions field is deprecated. joinOctoplusCampaign mutation no longer performs Saving Sessions enrollment. Please use joinSavingSessionsCampaign mutation for enrollment to Saving Sessions. - Marked as deprecated on 2025-01-22. - Scheduled for removal on or after 2025-04-22.
Field EnrolmentOutcome.savingSessions is deprecated

Argument after: String added to field CoreSiteworksRequestType.marketSupplyPoints
Argument before: String added to field CoreSiteworksRequestType.marketSupplyPoints
Argument first: Int added to field CoreSiteworksRequestType.marketSupplyPoints
Argument last: Int added to field CoreSiteworksRequestType.marketSupplyPoints
Field updateSiteworksRequest was added to object type Mutation
Object type CoreSiteworksRequestType has description A Siteworks Request
Type SiteworksRequestStatus was added
Type UUID was added
Type UpdateSiteworksRequest was added
Type UpdateSiteworksRequestInputType was added
Field CoreSiteworksRequestType.id changed type from ID! to UUID!
Field CoreSiteworksRequestType.marketSupplyPoints changed type from [CoreSiteworksMarketSupplyPointType]! to SupplyPointConnectionTypeConnection
Field CoreSiteworksRequestType.status changed type from RequestStatus! to SiteworksRequestStatus!
Type CoreSiteworksMarketSupplyPointType was removed

Field isRts was added to object type ElectricityMeterType

Field canAddHeatpump was added to object type EnergyIqDataType
Field canAddSolar was added to object type EnergyIqDataType

Type BillCharge was added
Type BillCredit was added
Type BillPayment was added
Type BillRefund was added
Type BillTransactionConnectionTypeConnection was added
Type BillTransactionConnectionTypeEdge was added
Type BillTransactionType was added
Field transactions was added to object type PeriodBasedDocumentType

Argument status: AccountApplicationStatus added to field Account.applications

AccountApplicationStatus added to field Account.applications

Argument status: AccountApplicationStatus added to field AccountType.applications

Field preferredSsd was added to object type AccountApplicationType
Description An enumeration. was removed from object type AccountApplicationStatus

Argument status: AccountApplicationStatus added to field AccountInterface.applications

Field regionalResults was added to object type SavingSessionsType
Type SavingSessionsRegionalResultType was added

Input field ledgerNumber of type String was added to input object type RequestRepaymentInputType
Input field RequestRepaymentInputType.ledgerId changed type from String! to String
Directive deprecated was added to input field ledgerId in input object RequestRepaymentInputType

Field siteworksRequests was added to object type Query
Type CoreSiteworksMarketSupplyPointType was added
Type CoreSiteworksRequestConnectionTypeConnection was added
Type CoreSiteworksRequestConnectionTypeEdge was added
Type CoreSiteworksRequestType was added
Type RequestStatus was added

Field updateLeaveSupplier was added to object type Mutation
Type LeaveSupplierUpdated was added
Type UpdateLeaveSupplierInput was added

Field completeLeadAction was added to object type Mutation
Type CompleteLeadActionInput was added
Type CompleteLeadAction was added

Field QuoteType.consumptionEstimates is deprecated
Directive deprecated was added to field QuoteType.consumptionEstimates
Field QuoteType.consumptionEstimates has deprecation reason The consumption_estimates field is deprecated. Please use the consumptionEstimates query instead. - Marked as deprecated on 2025-01-20. - Scheduled for removal on or after 2025-04-20.

Field authorizedApplications was added to object type Query
Type AuthorizedApplication was added

Directive deprecated was added to field LedgerInterface.id
Directive deprecated was added to field LedgerType.id
Field LedgerInterface.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
Field LedgerInterface.id is deprecated
Field LedgerType.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
Field LedgerType.id is deprecated

Enum value INTERNAL was added to enum ExternalAccountEventSubCategory
Enum value SALES was added to enum ExternalAccountEventCategory

Argument isCurrentRecord: Boolean added to field Query.getEnergyIqData

Field completionType was added to object type CollectionProcessDetailsType

Field isComplete was added to object type CollectionProcessDetailsType

Field GoodsPurchase.ledgerId changed type from String to ID
Field GoodsQuote.id changed type from Int to ID
Field GoodsQuoteShare.id changed type from Int to ID
Field NewLeadType.id changed type from Int to ID
Input field AcceptGoodsQuoteInput.quoteId changed type from Int! to ID!
Input field ProductToQuoteInput.productId changed type from Int! to ID!

Field bespokeRates was added to object type ElectricityAgreementType
Field bespokeRates was added to object type GasAgreementType
Field bespokeStandingCharges was added to object type ElectricityAgreementType
Field bespokeStandingCharges was added to object type GasAgreementType
Type BespokeNonHalfHourlyElectricityStandingChargePaymentMethod was added
Type BespokeNonHalfHourlyElectricityUnitRatePaymentMethod was added
Type BespokeNonHalfHourlyElectricityUnitRateRateType was added
Type BespokeNonHalfHourlyGasStandingChargePaymentMethod was added
Type BespokeNonHalfHourlyGasUnitRatePaymentMethod was added
Type ElectricityBespokeRate was added
Type ElectricityBespokeStandingCharge was added
Type GasBespokeRate was added
Type GasBespokeStandingCharge was added

Field number was added to interface SupplementaryLedgerInterface
Field number was added to object type SupplementaryLedgerType
Field number was added to object type PrepayPaymentLedgerType
Directive deprecated was added to field SupplementaryLedgerInterface.id
Directive deprecated was added to field SupplementaryLedgerType.id
Directive deprecated was added to field PrepayPaymentLedgerType.id
Field SupplementaryLedgerInterface.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
Field SupplementaryLedgerInterface.id is deprecated
Field SupplementaryLedgerType.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
Field SupplementaryLedgerType.id is deprecated
Field PrepayPaymentLedgerType.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
Field PrepayPaymentLedgerType.id is deprecated

Field WeatherCompensationConfiguration.allowableRange is deprecated
Field WeatherCompensationConfiguration.allowableRange has deprecation reason The allowableRange field is deprecated.
Directive deprecated was added to field WeatherCompensationConfiguration.allowableRange

Field allowableMaximumTemperatureRange was added to object type WeatherCompensationConfiguration

Field allowableMinimumTemperatureRange was added to object type WeatherCompensationConfiguration

Field updateLeadExtraDetails was added to object type Mutation
Type UpdateExtraDetailsInput was added
Type UpdateLeadExtraDetails was added
Type \_UpdateExtraDetailsItem was added

Field getOrCreateAccountForLead was added to object type Mutation
Type GetOrCreateShellAccountForLead was added
Type GetOrCreateShellAccountForLeadInput was added

Field chatbotRealtimeToken was added to object type Query

Directive deprecated was added to field TestChargeError.refusalReasons
Field descriptions was added to object type TestChargeError
Field errorType was added to object type TestChargeError
Field reasons was added to object type TestChargeError
TestChargeError object implements SmartFlexOnboardingErrorInterface interface
Type SmartFlexOnboardingErrorInterface was added
Type TestChargeErrorType was added
Field TestChargeError.refusalReasons has deprecation reason The refusalReasons field is deprecated.\n\nPlease use and instead.\n\n
Field TestChargeError.refusalReasons is deprecated

Field accountNumber was added to object type OccupancyPeriodType

Field getEnergyIqData was added to object type Query
Type EnergyIqDataType was added

Field createSupplyPointMetadata was added to object type Mutation
Type CreateSupplyPointMetadata was added
Type SupplyPointMetadataInput was added

Field supplyPoints was added to object type Query
Field meterPoint was added to object type SupplyPointType
Type MeterPointType was added

Argument ledgerNumber: String added to field AccountInterface.paginatedPaymentForecast
Argument ledgerNumber: String added to field AccountInterface.paymentForecast
Argument ledgerNumber: String added to field AccountInterface.payments
Argument ledgerNumber: String added to field AccountInterface.transactions
Argument ledgerNumber: String added to field AccountType.paginatedPaymentForecast
Argument ledgerNumber: String added to field AccountType.paymentForecast
Argument ledgerNumber: String added to field AccountType.payments
Argument ledgerNumber: String added to field AccountType.transactions
Directive deprecated was added to argument ledgerId of field ledgers in type AccountInterface
Directive deprecated was added to argument ledgerId of field ledgers in type AccountType
Directive deprecated was added to argument ledgerId of field paginatedPaymentForecast in type AccountInterface
Directive deprecated was added to argument ledgerId of field paginatedPaymentForecast in type AccountType
Directive deprecated was added to argument ledgerId of field paymentForecast in type AccountInterface
Directive deprecated was added to argument ledgerId of field paymentForecast in type AccountType
Directive deprecated was added to argument ledgerId of field payments in type AccountInterface
Directive deprecated was added to argument ledgerId of field payments in type AccountType
Directive deprecated was added to argument ledgerId of field transactions in type AccountInterface
Directive deprecated was added to argument ledgerId of field transactions in type AccountType

Field isSensitive was added to object type AccountUserDetailType

Field creditTransferPermissionsData was added to interface LedgerInterface
Field creditTransferPermissionsData was added to object type LedgerType
Type CreditTransferPermissionFromSourceLedgerType was added
Type CreditTransferPermissionToTargetLedgerType was added
Type CreditTransferPermissionsDataType was added

Input field ledgerNumber of type String was added to input object type GetEmbeddedSecretForNewPaymentInstructionInput
Directive deprecated was added to input field ledgerId in input object GetEmbeddedSecretForNewPaymentInstructionInput

Enum value JEDLIX_V2 was added to enum ProviderChoices

Enum value DAY_AHEAD_HH_INDEX was added to enum AllBandSubCategories

Enum value INDUSTRY_READINGS_NOT_SENT was removed from enum AccountReminderTypes

Input field activeAt of type DateTime was added to input object type TerminateCreditTransferPermissionInput
Input field sourceLedgerNumber of type String! was added to input object type TerminateCreditTransferPermissionInput
Input field targetLedgerNumber of type String! was added to input object type TerminateCreditTransferPermissionInput
Input field creditTransferPermissionId was removed from input object type TerminateCreditTransferPermissionInput
Field creditTransferPermissionId was removed from object type TerminateCreditTransferPermission

Error handling enhanced with ReadingIsNotSequential exception added to FitCreateMeterReadings mutation

Type PossibleError was added

Field createCreditTransferPermission was added to object type Mutation
Type CreateCreditTransferPermission was added
Type CreateCreditTransferPermissionInput was added

Input field vendorName of type Vendor! was added to input object type InstructionDetailsInput
Type Vendor was added

Field failureCodes was added to object type ResetUserPasswordOutput

Input field ledgerNumber of type String was added to input object type StorePaymentInstructionInput
Directive deprecated was added to input field ledgerId in input object StorePaymentInstructionInput

Argument ledgerNumber: String added to field Query.dashboardScreen
Directive deprecated was added to argument ledgerId of field dashboardScreen in type Query

Argument includeCancelled: Boolean added to field Query.smartFlexOnboardingWizards
Argument includeCompleted: Boolean added to field Query.smartFlexOnboardingWizards

Field error was added to object type TestCharge
Type TestChargeError was added
Type TestChargeRefusalReason was added
Directive deprecated was added to field TestCharge.status
Field TestCharge.status is deprecated
Field TestCharge.status has deprecation reason The status field is deprecated. Please use isStarted and error instead. - Marked as deprecated on 2024-12-12. - Scheduled for removal on or after 2025-02-12.

Input field ledgerNumber of type String was added to input object type SetUpDirectDebitInstructionInput
Input field SetUpDirectDebitInstructionInput.ledgerId changed type from ID! to ID
Directive deprecated was added to input field ledgerId in input object SetUpDirectDebitInstructionInput

Input field ledgerNumber of type String was added to input object type InitiateStandalonePaymentInput
Directive deprecated was added to input field ledgerId in input object InitiateStandalonePaymentInput

Directive deprecated was added to input field ledgerId in input object AccountLedgerInput
Input field AccountLedgerInput.ledgerId changed type from ID! to ID
Input field ledgerNumber of type String was added to input object type AccountLedgerInput

Field key was added to object type RegenerateSecretKey

Directive deprecated was added to input field ledgerId in input object UpdateAutoTopUpAmountInput
Input field ledgerNumber of type String was added to input object type UpdateAutoTopUpAmountInput
Input field UpdateAutoTopUpAmountInput.ledgerId changed type from Int! to Int

Field PortfolioType.ancestors changed type from NestedPortfolioConnectionTypeConnection to PortfolioConnectionTypeConnection
Field PortfolioType.descendants changed type from NestedPortfolioConnectionTypeConnection to PortfolioConnectionTypeConnection
Field PortfolioType.parent changed type from NestedPortfolioType to PortfolioType
Type NestedPortfolioConnectionTypeConnection was removed
Type NestedPortfolioConnectionTypeEdge was removed
Type NestedPortfolioType was removed

Argument integrationDeviceId: String added to field Query.devices
Field integrationDeviceId was added to object type SmartFlexBattery
Field integrationDeviceId was added to interface SmartFlexDeviceInterface
Field integrationDeviceId was added to object type SmartFlexChargePoint
Field integrationDeviceId was added to object type SmartFlexDevice
Field integrationDeviceId was added to object type SmartFlexHeatPump
Field integrationDeviceId was added to object type SmartFlexInverter
Field integrationDeviceId was added to object type SmartFlexStorageHeaters
Field integrationDeviceId was added to object type SmartFlexVehicle

Input field ledgerNumber of type String was added to input object type CollectPaymentInput
Input field CollectPaymentInput.ledgerId changed type from ID! to ID
Directive deprecated was added to input field ledgerId in input object CollectPaymentInput

Field html was added to object type TermsAndConditions
Field pdfUrl was added to object type TermsAndConditions

Argument electricityOnly: Boolean added to field Query.addressUprns
Directive deprecated was added to field Mutation.resetPassword
Field Mutation.resetPassword has deprecation reason The resetPassword field is deprecated. Please use resetUserPassword instead. - Marked as deprecated on 2024-12-04. - Scheduled for removal on or after 2025-06-01. You can read more about this deprecation on: https://announcements.kraken.tech/announcements/public/81/
Field Mutation.resetPassword is deprecated

Input field ledgerNumber of type String was added to input object type PostCreditInput
Input field PostCreditInput.ledgerId changed type from ID! to ID
Directive deprecated was added to input field ledgerId in input object PostCreditInput

Field ledgerNumber was added to object type GoodsPurchase
Directive deprecated was added to field GoodsPurchase.ledgerId
Field GoodsPurchase.ledgerId has deprecation reason The ledgerId field is deprecated. Please use ledgerNumber instead. This is in the form of L-123456789A - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
Field GoodsPurchase.ledgerId is deprecated

Field termsAndConditions was added to object type QuoteRequest
Field termsAndConditions was added to object type QuoteRequestBase
Input field StartSmartOnboardingProcessInput.termsAndConditions changed type from TermsAndConditions to TermsAndConditionsInput
TermsAndConditions kind changed from InputObjectTypeDefinition to ObjectTypeDefinition
Type TermsAndConditionsInput was added

Field switchAccountToVariablePaymentSchedule was added to object type Mutation
Type SwitchAccountToVariablePaymentSchedule was added
Type SwitchAccountToVariablePaymentScheduleInput was added

Input field suppressCommunications of type Boolean was added to input object type InitiateProductSwitchInput

Field accountsCount (deprecated) was removed from object type NestedPortfolioType
Field accountsCount (deprecated) was removed from object type PortfolioType

Field co2SavingInKgFromConsumption was added to object type ElectricitySupplyPoint
Field treesSavedFromConsumption was added to object type ElectricitySupplyPoint

Directive deprecated was added to input field ledgerId in input object InitiateHostedStandalonePaymentInput

Field accounts was added to object type PortfolioType
Type AccountConnectionTypeConnection was added
Type AccountConnectionTypeEdge was added

Directive deprecated was added to field NestedPortfolioType.accountsCount
Directive deprecated was added to field PortfolioType.accountsCount
Field NestedPortfolioType.accountsCount has deprecation reason The accountsCount field is deprecated. Will be deleted in favor of field. - Marked as deprecated on 2024-11-27. - Scheduled for removal on or after 2024-12-02.
Field NestedPortfolioType.accountsCount is deprecated
Field PortfolioType.accountsCount has deprecation reason The accountsCount field is deprecated. Will be deleted in favor of field. - Marked as deprecated on 2024-11-27. - Scheduled for removal on or after 2024-12-02.
Field PortfolioType.accountsCount is deprecated

Field gspGroupId was added to object type EligibleMetersPointsType
Field targetGsp was added to object type SavingSessionsEventType
Type TargetGspType was added

Argument includeRestrictedProducts: Boolean (with default value) added to field Query.availableProductsForMeterPoint

Field SendVerificationEmail.verificationStatus changed type from VerificationRequestStatus to Boolean

Input field CloseDCAProceedingInputType.stoppedDate changed type from String! to Date!

Field verificationStatus was added to object type Query
Type EmailVerificationStatus was added
Type VerificationRequestStatus was added

Field sendVerificationEmail was added to object type Mutation
Type SendVerificationEmail was added
Type SendVerificationEmailInput was added
Type VerificationRequestStatus was added

Input field CloseDCAProceedingInputType.campaign changed type from String! to String

Argument expiresAt: DateTime was added to input RegisterPushNotificationBinding

Field possibleErrors was added to object type Query
Type PossibleErrorsInputType was added
Type PossibleErrorsOutputType was added

Enum value GBP was added to enum CurrencyOptions

Field addressUprns was added to object type Query
Type AddressUPRNTypeConnection was added
Type AddressUPRNTypeEdge was added
Type UniqueRELAddressType was added

Field typedSource (deprecated) was removed from object type MeasurementsMetadataOutput
Type TypedSourceOutput was removed
Type UtilityType was removed