GraphQL API Changelog
This page shows the history of changes to the GraphQL schema.- Type
StartCustomerVerification
was added - Type
VerificationProcess
was added - Type
StartCustomerVerificationInput
was added - Field startCustomerVerification was added to object type
Mutation
- Type
UpdateLeadStatus
was removed - Type
UpdateLeadStatusInput
was removed - Type
UpdateLeadAssignment
was added - Type
UpdateLeadAssignmentInput
was added - Type
CreatePostEvents
was added - Type
CreatePostEventsInput
was added - Type
PostEventInput
was added - Type
AllocationIntentionType
was added - Type
TransactionTypes
was added - Field allocationIntentions was added to object type
BillingDocumentPositionType
- Field updateLeadAssignment was added to object type
Mutation
- Field createPostEvents was added to object type
Mutation
- Field updateLeadStatus was removed from object type
Mutation
- Enum value DECOMMISSIONING was added to
LeaveSupplierReason
enum
- Type
UpdateOpportunityAssignment
was added - Type
UpdateOpportunityAssignmentInput
was added - Field updateOpportunityAssignment was added to object type
Mutation
- Type
CustomerFeedbackSourceChoices
was added - Argument feedbackSource: CustomerFeedbackSourceChoices added to
Query
.customerFeedbackForms
- Input Field feedbackSource: String was added to input type
CreateCustomerFeedbackInputType
- Type
BaseInitializeUserInput
was added - Type
InitializeAccountInput
was removed - Type
InitializeUserInput
was removed - Type
BaseInitializeAccountInput
was added - Type for argument input on field
Mutation
.initializeUser changed from InitializeUserInput! to BaseInitializeUserInput! - Type for argument input on field
Mutation
.initializeAccount changed from InitializeAccountInput! to BaseInitializeAccountInput!
- Type
PermissionGrapheneType
was added - Field permissions was added to object type
ThirdPartyOrganizationType
- Enum value VERIFY_CUSTOMER_DETAILS was added to
PreSignedTokenScope
enum - Enum value VERIFY_CUSTOMER_DETAILS was added to
ExpiringTokenScope
enum
- Enum value TRANSACTIONAL_MESSAGING_PUBLISHING_ERROR was added to
CollectionProcessAssociatedItemType
enum
- Deprecation reason on field
GenerateInkPresignedUrl
.presignedPostFields changed from The 'presignedPostFields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12. to The 'presignedPostFields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-25.
- Type
BillingDocumentPositionType
was added - Field documentDebtPosition was added to object type
StatementBillingDocumentType
- Field documentDebtPosition was added to object type
InvoiceBillingDocumentType
- Field documentDebtPosition was added to object type
PeriodBasedDocumentType
- Type
CreateQuoteForAccount
was added - Type
MarketSupplyQuoteRequestType
was added - Type
MarketSupplyQuotedSupplyPointConnectionTypeConnection
was added - Type
MarketSupplyQuotedSupplyPointConnectionTypeEdge
was added - Type
MarketSupplyQuotedSupplyPointType
was added - Type
MarketSupplyQuotedProductConnectionTypeConnection
was added - Type
MarketSupplyQuotedProductConnectionTypeEdge
was added - Type
MarketSupplyQuotedProductType
was added - Type
TermsAndConditionsConnectionTypeConnection
was added - Type
TermsAndConditionsConnectionTypeEdge
was added - Type
CreateQuoteForAccountInput
was added - Field createQuoteForAccount was added to object type
Mutation
- Type
LeaveSupplierType
was added - Input Field leaveSupplierType: LeaveSupplierType! was added to input type
GasTerminationInput
- Input Field leaveSupplierType: LeaveSupplierType! was added to input type
ElectricityTerminationInput
- Field inkMessageTextContent was added to object type
Query
- Type
CanModifyPaymentsType
was added - Field canModifyPayments was added to object type
AccountType
- Deprecation reason on field
ReferralSchemeType
.referrerFamilyName changed from The 'referringFamilyName' field is deprecated. Only make use of the referrerGivenName for privacy reasons. - Marked as deprecated on 2022-11-07. - Scheduled for removal on or after 2023-01-07. to The 'referrerFamilyName' field is deprecated. Only make use of the referrerGivenName for privacy reasons. - Marked as deprecated on 2022-11-07. - Scheduled for removal on or after 2023-01-07. - Deprecation reason on field
GenerateInkPresignedUrl
.presignedPostFields changed from The 'presigned_post_fields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12. to The 'presignedPostFields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12. - Deprecation reason on field
UpsideDispatchType
.deltaKwh changed from The 'delta_kwh' field is deprecated. delta has replaced deltaKwh for increased precision. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. to The 'deltaKwh' field is deprecated. delta has replaced deltaKwh for increased precision. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. - Deprecation reason on field
UpsideDispatchType
.startDt changed from The 'start_dt' field is deprecated. start has replaced start_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. to The 'startDt' field is deprecated. start has replaced start_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. - Deprecation reason on field
UpsideDispatchType
.endDt changed from The 'end_dt' field is deprecated. end has replaced end_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. to The 'endDt' field is deprecated. end has replaced end_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01.
- Enum value JOURNEY_IN_PROGRESS was added to
ContractStatus
enum - Enum value TERMINATING was removed from
ContractStatus
enum
- Field availableProducts was added to object type
Query
- Default value for input field
UpdateLeaveSupplierInput
.marketData changed from Undefined to None - Default value for input field
LeaveSupplierInput
.marketData changed from Undefined to None
- Input Field specificationCode: String was added to input type
CreateProductInput
- Input Field specificationIdentifier removed from input type
CreateProductInput
- Type
CreateCustomerFeedback
was added - Type
CreateCustomerFeedbackInputType
was added - Field createCustomerFeedback was added to object type
Mutation
- Type
CustomerFeedbackFormConnectionTypeConnection
was added - Type
CustomerFeedbackFormConnectionTypeEdge
was added - Type
CustomerFeedbackFormType
was added - Field customerFeedbackForms was added to object type
Query
- Field code of type String was added to interface
RewardInterface
- Field code was added to object type
RewardType
- Deprecation reason on field
PaymentScheduleType
.scheduleType changed from None to The 'scheduleType' field is deprecated. Use paymentPreferences query instead. - Marked as deprecated on 2025-07-07. - Scheduled for removal on or after 2026-07-07.
- Field relayId was added to object type
InkLiveChat
- Field id was removed from object type
InkLiveChat
- Field liveChatConversation was removed from object type
InkLiveChat
- Input Field accountUserId: String was added to input type
DeductLoyaltyPointsInput
- Field number was added to object type
JoinSupplierProcessType
- Enum value ECOBEE_V2 was added to
ProviderChoices
enum
- Type
ConsentTypeType
was added - Field type was added to object type
ConsentType
- Input Field liveChatRelayId: ID! was added to input type
SendLiveChatMessageInput
- Input Field liveChatId removed from input type
SendLiveChatMessageInput
- Input Field allowUnpausing: Boolean was added to input type
AssessCollectionProcessRecordForPauseInputType
- Type
VerifyCustomer
was added - Type
VerifyCustomerInput
was added - Type
CustomerVerificationType
was added - Field verifyCustomer was added to object type
Mutation
- Input Field funnelCode: String! was added to input type
CreateOpportunityInput
- Input Field funnelId removed from input type
CreateOpportunityInput
- Type
LeaveSupplierSubType
was added - Type
InboundCallAverageWaitTimeType
was added - Input Field subtype: LeaveSupplierSubType was added to input type
UpdateLeaveSupplierInput
- Field inboundCallAverageWaitTime was added to object type
Query
- Input Field subtype: LeaveSupplierSubType was added to input type
LeaveSupplierInput
- Type
SetPaymentPreference
was added - Type
SetPaymentPreferenceInput
was added - Type
StopAutomatedPayments
was added - Type
StopAutomatedPaymentsInput
was added - Deprecation reason on field
Query
.wheelOfFortuneSpins changed from None to The 'wheelOfFortuneSpins' field is deprecated. We're migrating the system the Wheel of Fortune runs on. Octopus Energy UK customers can find the new API under api.backend.octopus.energy/v1/graphql/ - Marked as deprecated on 2025-06-24. - Scheduled for removal on or after 2025-09-24. - Deprecation reason on field
Query
.wheelOfFortuneSegments changed from None to The 'wheelOfFortuneSegments' field is deprecated. We're migrating the system the Wheel of Fortune runs on. Octopus Energy UK customers can find the new API under api.backend.octopus.energy/v1/graphql/ - Marked as deprecated on 2025-06-24. - Scheduled for removal on or after 2025-09-24. - Field stopAutomatedPayments was added to object type
Mutation
- Field setPaymentPreference was added to object type
Mutation
- Deprecation reason on field
Mutation
.spinWheelOfFortune changed from None to The 'spinWheelOfFortune' field is deprecated. We're migrating the system the Wheel of Fortune runs on. Octopus Energy UK customers can find the new API under api.backend.octopus.energy/v1/graphql/ - Marked as deprecated on 2025-06-24. - Scheduled for removal on or after 2025-09-24.
- Type
ComplaintContactTypeConnection
was removed - Type
ComplaintContactTypeEdge
was removed - Type
AccountReminderConnectionTypeConnection
was added - Type
AccountReminderConnectionTypeEdge
was added - Type
ComplaintConnectionTypeConnection
was added - Type
ComplaintConnectionTypeEdge
was added - Type
ComplaintContactConnectionTypeConnection
was added - Type
ComplaintContactConnectionTypeEdge
was added ComplaintType
.creationDate type changed from Date! to DateComplaintType
.contacts type changed from ComplaintContactTypeConnection to ComplaintContactConnectionTypeConnection- Field reminders of type AccountReminderConnectionTypeConnection was added to interface
AccountInterface
- Field complaints of type ComplaintConnectionTypeConnection was added to interface
AccountInterface
- Field reminders was added to object type
AccountType
- Field complaints was added to object type
AccountType
- Field isKrakenManaged was added to object type
Reminder
- Field createdAt was added to object type
Reminder
- Type
_DefaultMarketTerminationInput
was removed - Type
ElectricityTerminationInput
was added - Type
LeaveSupplierReason
was added - Type
GasTerminationInput
was added - Input Field gasSupplyPointData: [GasTerminationInput] was added to input type
LeaveSupplierMarketInputType
- Input Field electricitySupplyPointData: [ElectricityTerminationInput] was added to input type
LeaveSupplierMarketInputType
- Input Field supplyPointData removed from input type
LeaveSupplierMarketInputType
- Field assigneeUsername was added to object type
Reminder
- Field reopenInkConversation was added to object type
Reminder
- Field assigneeTeamName was added to object type
Reminder
- Input Field assigneeUsername: String was added to input type
CreateReminderInput
- Input Field reopenInkConversation: Boolean was added to input type
CreateReminderInput
- Input Field assigneeTeamName: String was added to input type
CreateReminderInput
- Input Field opportunityNumber: String was added to input type
GetOrCreateShellAccountForOpportunityInput
- Input Field opportunityId removed from input type
GetOrCreateShellAccountForOpportunityInput
- Type
EpexDayAheadPriceConnectionTypeConnection
was added - Type
EpexDayAheadPriceConnectionTypeEdge
was added - Type
EpexDayAheadPriceType
was added - Field epexDayAheadPrices was added to object type
Query
- Input Field opportunityNumber: String! was added to input type
UpdateOpportunityStageInput
- Input Field opportunityId removed from input type
UpdateOpportunityStageInput
UpdateOpportunityStageInput
.stage type changed from String to String!- Input Field opportunityNumber: String! was added to input type
UpdateExtraDetailsInput
- Input Field opportunityId removed from input type
UpdateExtraDetailsInput
- Field totalCharges was added to object type
InvoiceBillingDocumentType
- Field totalCredits was added to object type
InvoiceBillingDocumentType
- Field transactions was added to object type
InvoiceBillingDocumentType
- Field totalCharges was added to object type
StatementBillingDocumentType
- Field totalCredits was added to object type
StatementBillingDocumentType
- Field transactions was added to object type
StatementBillingDocumentType
- Type
CreateOpportunity
was added - Type
CreateOpportunityInput
was added - Type
LeadContactDetailsInput
was added - Type
_CreateOpportunityExtraDetailsItem
was added - Field createOpportunity was added to object type
Mutation
_UpdateExtraDetailsItem
.value type changed from String to GenericScalar
- Enum value BILLING_AMENDED_METER_READ_INTERVAL_LEGACY was removed from
AccountReminderTypes
enum - Enum value BILLING_AMENDED_INTERVAL_DATA_RECEIVED_CAUSING_OVERCHARGE was removed from
AccountReminderTypes
enum - Enum value OBSOLETE_BILLING_AMENDED_STANDING_DATA_REGISTER_DELETED was removed from
AccountReminderTypes
enum - Enum value OBSOLETE_BILLING_AMENDED_STANDING_DATA_REGISTER_CHANGED was removed from
AccountReminderTypes
enum - Enum value BILLING_BACKDATED_CONCESSION_RECEIVED was removed from
AccountReminderTypes
enum - Enum value BILLING_BACKDATED_UMS_RECORD_RECEIVED was removed from
AccountReminderTypes
enum
- Enum value LIVE_CHAT was added to
ExternalAccountEventSubCategory
enum
- Type
RegisterOpportunityFlowStatusEvent
was added - Type
RegisterOpportunityFlowStatusEventInput
was added - Field registerOpportunityFlowStatusEvent was added to object type
Mutation
- Type
OpportunityOutput
was added - Field opportunityByNumber was added to object type
Query
- Input Field currentStage: String was added to input type
UpdateOpportunityStageInput
- Type
BaseTermType
was removed - Type
PaysByDirectDebitType
was added - Type
BillingDocumentIssuanceFrequencyType
was added - Type
RateGroupEligibilityType
was added - Type
LatePaymentFeesType
was added - Type
TimeOfUseOverrideType
was added - Type
DelayerDaysType
was added - Type
CharacteristicOverrideConfigurationType
was added
- Field status was added to object type
PreferredInstruction
- Field product was added to object type
CommonAgreementType
- Field id was added to object type
SupplyProductType
- Type
TriggerProcessingStatus
was added - Type
ScheduleTrigger
was added - Type
AmountStrategy
was added - Type
UnenrollAccountFromLoyaltyProgram
was added - Type
UnenrollAccountFromLoyaltyProgramOutcome
was added - Type
UnenrollAccountFromLoyaltyProgramInput
was added - Type
InitializeAccountResult
was added - Type
InitializeAccountInput
was added - Type
InitializeUserResult
was added - Type
InitializeUserInput
was added - Type
AddItemsToRiskList
was added - Type
RiskListItemType
was added - Type
RiskListItemInputType
was added - Type
RemoveItemsFromRiskList
was added - Type
AssessCollectionProcessRecordForPause
was added - Type
AssessCollectionProcessRecordForPauseOutputType
was added - Type
AssessCollectionProcessRecordForPauseInputType
was added - Type
UpdateDCAProceeding
was added - Type
DCAProceedingUpdateStatus
was added - Type
UpdateDCAProceedingInputType
was added - Type
ComplaintType
was added - Type
ComplaintContactTypeConnection
was added - Type
ComplaintContactTypeEdge
was added - Type
ComplaintContactType
was added - Type
LoyaltyPointsProgramEligibilityType
was added - Type
LoyaltyPointsProgramEligibilityInput
was added - Type
LeadBlockListValidationOutput
was added - Type
LeadBlockListValidationInput
was added - Type
SelectInverterMake
was added - Type
SelectInverterMakeListItem
was added - Type
InverterVariantType
was added - Type
SelectInverterMakeForSmartFlexOnboarding
was added - Type
SelectInverterMakeInput
was added - Type
ChargingSessionType
was added - Type
FlexDevicePreferenceSetting
was added - Type
FlexDevicePreferenceSettingInterface
was added - Type
FlexDevicePreferenceScheduleSettingInterface
was added - Type
FlexDevicePreferenceScheduleSetting
was added - Type
WaitForTransition
was added - Field preferenceSetting was added to object type
SmartFlexBattery
- Field preferenceSetting was added to object type
SmartFlexChargePoint
- Argument sessionTypes: [ChargingSessionType] added to
SmartFlexChargePoint
.chargingSessions - Argument sessionTypes: [ChargingSessionType] added to
ElectricDevice
.chargingSessions - Field preferenceSetting of type FlexDevicePreferenceSettingInterface was added to interface
SmartFlexDeviceInterface
- Field updateDcaProceeding was added to object type
Mutation
- Field initializeUser was added to object type
Mutation
- Field unenrollAccountFromLoyaltyProgram was added to object type
Mutation
- Field selectInverterMakeForSmartFlexOnboarding was added to object type
Mutation
- Field addItemsToRiskList was added to object type
Mutation
- Field initializeAccount was added to object type
Mutation
- Field assessCollectionProcessRecordForPause was added to object type
Mutation
- Field removeItemsFromRiskList was added to object type
Mutation
- Field preferenceSetting was added to object type
SmartFlexVehicle
- Argument sessionTypes: [ChargingSessionType] added to
SmartFlexVehicle
.chargingSessions - Field processingStatus was added to object type
Trigger
- Field preferenceSetting was added to object type
SmartFlexDevice
- Field preferenceSetting was added to object type
SmartFlexInverter
- Field complaint was added to object type
Query
- Field businessAccountReferralRewardScheme was added to object type
Query
- Field leadBlocklistValidations was added to object type
Query
- Field eligibilityToJoinLoyaltyPointsProgram was added to object type
Query
- Field totalPayments was added to object type
InvoiceType
- Input Field amountStrategy: AmountStrategy was added to input type
CreateAccountPaymentScheduleInput
- Input Field trigger: ScheduleTrigger was added to input type
CreateAccountPaymentScheduleInput
- Field maxRecurrence was added to object type
ReferralSchemeType
- Deprecation reason on field
GenerateInkPresignedUrl
.presignedPostFields changed from Replaced in favor of fields. to The 'presigned_post_fields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12. - Field isLateFailed
Payment
was added to object typePayment
- Enum value JPN_CONFIRM_PAYMENT_FOR_DUNNING_CAMPAIGN was removed from
AccountReminderTypes
enum - Enum value JPN_CALL_FOR_DUNNING_CAMPAIGN was removed from
AccountReminderTypes
enum - Enum value JPN_SUPPLY_DETAILS_UPDATE_CONFIRMATION was removed from
AccountReminderTypes
enum
- Enum value MYENERGI_V2 was added to
ProviderChoices
enum
- Type
InkLiveChatMessageInput
was added - Type
SendLiveChatMessagePayload
was added - Type
SendLiveChatMessageInput
was added - Input Field liveChat: InkLiveChatMessageInput was added to input type
InkMessageInput
- Field sendLiveChatMessage was added to object type
Mutation
- Type
MessageConnection
was added - Type
MessageEdge
was added - Type
Message
was added - Type
Channel
was added - Field isActive was added to object type
CommonAgreementType
- Field isRevoked was added to object type
CommonAgreementType
- Field agreedTo was added to object type
CommonAgreementType
- Field agreedFrom was added to object type
CommonAgreementType
- Field marketSupplyAgreements was added to object type
AccountType
- Field messages was added to object type
Trigger
- Field createdAt was added to object type
Trigger
- Field triggerTypeCode was added to object type
Trigger
- Field closingBalance was added to object type
PeriodBasedDocumentType
- Enum value HOMEOWNER_ASSOCIATION was added to
BusinessTypeOptions
enum
- Enum value ACCEPT_FIT_TERMS was added to
PreSignedTokenScope
enum - Enum value ACCEPT_FIT_TERMS was added to
ExpiringTokenScope
enum
- Type
PublishTransactionalMessagingExternalTrigger
was added - Type
PublishTransactionalMessagingExternalTriggerInput
was added - Field publishTransactionalMessagingExternalTrigger was added to object type
Mutation
- Deprecation reason on field
Query
.plannedDispatches changed from None to The 'plannedDispatches' field is deprecated. Please use 'flexPlannedDispatches' instead. - Marked as deprecated on 2025-05-27. - Scheduled for removal on or after 2025-08-27.
- Type
OnSiteJobsAppointmentStatus
was removed - Type
AppointmentStatus
was added OnSiteJobsAppointmentType
.status type changed from OnSiteJobsAppointmentStatus to AppointmentStatus
- Field flexPlannedDispatches was added to object type
Query
- Enum value TEST was added to
SmartFlexChargingType
enum
InitiateLiveChatInput
.accountNumber type changed from String to String!
- Type
UpdateLeadStatus
was added - Type
UpdateLeadStatusInput
was added - Field updateLeadStatus was added to object type
Mutation
- Type
BaseInstigateAccountContractTerminationInput
was added - Type for argument input on field
Mutation
.instigateAccountContractTermination changed from BaseInstigateContractTerminationInput! to BaseInstigateAccountContractTerminationInput! - Input Field partyIdentifier removed from input type
BaseInstigateContractTerminationInput
- Field possibleErrors was added to object type
UpdatePassword
- Field property was added to object type
SupplyPointType
- Type
ReadingsConnection
was added - Type
ReadingsEdge
was added - Type
Reading
was added - Type
ReadingTypes
was added - Type
TimeGranularities
was added - Field readings was added to object type
SupplyPointType
- Field supplyPoint was added to object type
Query
EnqueueInboundCallInput
.callId type changed from ID to ID!
- Input Field instructionReference: String was added to input type
RequestRepaymentInputType
- Enum value L was added to
ConsumptionUnit
enum
- Input Field ipAddress: String was added to input type
ConfirmDoubleOptInInput
- Input Field ipAddress: String! was added to input type
DoubleOptInInput
- Type
SupplyPointContextDataType
was added - Field supplyPointContexts was added to object type
JoinSupplierProcessDataType
- Field supplyPoint was added to object type
CommonAgreementType
- Input Field lossReason removed from input type
SetOpportunityOutcomeInput
- Enum value SMARTFLEX_CONNECT was added to
ProviderChoices
enum
- Type
NonEmptyID
was added UpdateLeaveSupplierInput
.leaveSupplierProcessId type changed from ID! to NonEmptyID!CancelLeaveSupplierInput
.leaveSupplierProcessId type changed from ID! to NonEmptyID!
- Enum value CANCELLATION_PENDING was removed from
RequestStatus
enum
- Enum value SENT_TO_MOP was removed from
RequestStatus
enum - Enum value FLOW_SENDING was removed from
RequestStatus
enum
- Enum value UPDATE_BLACKHOLE_EMAIL_NO_ACCOUNT_NUMBER was added to
PreSignedTokenScope
enum - Enum value UPDATE_BLACKHOLE_EMAIL_NO_ACCOUNT_NUMBER was added to
ExpiringTokenScope
enum
- Type
InitiateLiveChatPayload
was added - Type
InkLiveChat
was added - Type
InitiateLiveChatInput
was added - Field initiateLiveChat was added to object type
Mutation
- Type
PaymentSlipDetailsInput
was added - Input Field paymentSlipDetails: PaymentSlipDetailsInput was added to input type
EnrollmentInput
- Field title was added to object type
Contract
- Argument userNumber: String added to
Mutation
.updateAccountUserConsents
- Deprecation reason on field
Mutation
.deleteBoostCharge changed from None to The 'deleteBoostCharge' field is deprecated. Please use 'updateBoostCharge' instead. - Marked as deprecated on 2025-05-12. - Scheduled for removal on or after 2025-08-12. - Deprecation reason on field
Mutation
.deauthenticateDevice changed from None to The 'deauthenticateDevice' field is deprecated. Please use 'deauthenticateFlexDevice' instead. - Marked as deprecated on 2025-05-12. - Scheduled for removal on or after 2025-08-12. - Deprecation reason on field
Mutation
.triggerBoostCharge changed from None to The 'triggerBoostCharge' field is deprecated. Please use 'updateBoostCharge' instead. - Marked as deprecated on 2025-05-12. - Scheduled for removal on or after 2025-08-12.
- Type
ConfirmDoubleOptIn
was added - Type
ConfirmDoubleOptInInput
was added - Field confirmDoubleOptIn was added to object type
Mutation
- Type
TriggerType
was removed - Type
TerminateContractInstigated
was removed - Type
BaseTerminateContractInput
was removed - Type
Trigger
was added - Type
ContractTerminationInstigated
was added - Type
BaseInstigateContractTerminationInput
was added - Type
DeauthenticateFlexDevice
was added - Type
DeauthenticateFlexDeviceInput
was added - Field noticePeriod was added to object type
Product
- Enum value CANCELLATION_IN_PROGRESS was added to
LifecycleSupplyPointProcessStatus
enum - Enum value REVERSAL_STALLED was added to
LifecycleSupplyPointProcessStatus
enum - Enum value REVERSAL_ERRORED was added to
LifecycleSupplyPointProcessStatus
enum - Enum value CANCELLATION_STALLED was added to
LifecycleSupplyPointProcessStatus
enum - Enum value CANCELLATION_ERRORED was added to
LifecycleSupplyPointProcessStatus
enum - Enum value REVERSAL_FAILED was added to
LifecycleSupplyPointProcessStatus
enum - Enum value REVERSAL_IN_PROGRESS was added to
LifecycleSupplyPointProcessStatus
enum - Enum value CANCELLATION_FAILED was added to
LifecycleSupplyPointProcessStatus
enum PublishTransactionalMessagingTrigger
.trigger type changed from TriggerType to Trigger- Enum value CONSUMPTION_BREAKDOWN was added to
ReadingStatisticTypeEnum
enum - Enum value BYD was added to
ProviderChoices
enum - Field instigateAccountContractTermination was added to object type
Mutation
- Field deauthenticateFlexDevice was added to object type
Mutation
- Field instigateBusinessContractTermination was added to object type
Mutation
- Field terminateAccountContract was removed from object type
Mutation
- Field terminateBusinessContract was removed from object type
Mutation
- Field trigger was added to object type
Query
- Type for argument createdAfter on field
Query
.siteworksRequests changed from DateTime! to DateTime
- Type
InvoiceTotalType
was added - Field totalMonetaryAmount was added to object type
AccountLoyaltyPointsType
- Field billingAddress was added to object type
BusinessType
CreateProductInput
.termsAndConditionsTypes type changed from [String!] to [String!]!- Field totalCharges was added to object type
InvoiceType
- Field transactions was added to object type
InvoiceType
- Field isAnnulled was added to object type
InvoiceType
- Field totalCredits was added to object type
InvoiceType
- Enum value UNISSUED_TRANSACTIONS was added to
TransactionTypeFilter
enum - Enum value ISSUED_TRANSACTIONS was removed from
TransactionTypeFilter
enum - Argument maxRange: Int added to
Query
.availableProductSwitchDates
- Type
UpdateBoostChargeInput
was added - Type
UpdateBoostChargeAction
was added - Field updateBoostCharge was added to object type
Mutation
- Type
SmartFlexInverter
was added - Type
SmartFlexInverterTelemetry
was added - Type
InverterTelemetry
was added - Type
ConnectionStatus
was added - Type
BatteryTelemetry
was added - Type
SolarTelemetry
was added - Type
GridTelemetry
was added - Type
SiteTelemetry
was added
- Enum value AMEND_PAYMENTS was added to
ExpiringTokenScope
enum - Enum value AMEND_PAYMENTS was added to
PreSignedTokenScope
enum
- Field number was added to object type
AccountUserType
- Field propertyId of type String was added to interface
SmartFlexDeviceInterface
- Field propertyId was added to object type
SmartFlexDevice
- Field propertyId was added to object type
SmartFlexBattery
- Field propertyId was added to object type
SmartFlexChargePoint
- Field propertyId was added to object type
SmartFlexVehicle
- Type
CompleteOpportunityAction
was removed - Type
CompleteOpportunityActionInput
was removed - Field completeOpportunityAction was removed from object type
Mutation
- Type
TermType
was removed - Type
BaseTermType
was added
- Field earliestCancellationDate was added to object type
Agreement
- Type
ContractStatus
was added - Field status was added to object type
Contract
- Field pausedDays was added to object type
CollectionProcessDetailsType
- Type
UpdateOpportunityState
was removed - Type
UpdateOpportunityStateInput
was removed - Type
UpdateOpportunityStage
was added - Type
UpdateOpportunityStageInput
was added - Field updateOpportunityStage was added to object type
Mutation
- Field updateOpportunityState was removed from object type
Mutation
- Type
SMSEventType
was added - Type
SMSMessageType
was added - Type
AttachmentType
was added - Field id was added to object type
Reminder
- Enum value SMS_RECEIVED was added to
AccountEventType
enum - Enum value SMS_SENT was added to
AccountEventType
enum PushNotificationBindingType
.messages type changed from PrintMessageTypeConnection! to [SMSMessageType!]!- Removed argument before from
PushNotificationBindingType
.messages - Removed argument after from
PushNotificationBindingType
.messages - Removed argument offset from
PushNotificationBindingType
.messages - Removed argument last from
PushNotificationBindingType
.messages - Removed argument first from
PushNotificationBindingType
.messages - Union member SMSEventType was added to
AccountEvent
Union type
- Type
CollectionProcessRecordAssociatedItemType
was added - Field associatedItems was added to object type
CollectionProcessDetailsType
- Enum value ACCEPT_FIT_SCHEDULE was added to
PreSignedTokenScope
enum - Enum value ACCEPT_FIT_SCHEDULE was added to
ExpiringTokenScope
enum
- Input Field ledgerNumber: String was added to input type
CloseDCAProceedingInputType
- Field ledgerNumber was added to object type
DCAProceedingClosureStatus
- Type
AssociateItemToCollectionProcess
was added - Type
AssociateItemToCollectionProcessOutputType
was added - Type
AssociateItemToCollectionProcessInputType
was added - Type
CollectionProcessAssociatedItemType
was added - Field associateItemToCollectionProcess was added to object type
Mutation
- 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
- 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
- Field debtLedger was added to object type
LedgerType
- Field debtLedger of type
LedgerInterface
was added to interfaceLedgerInterface
- Type
OpportunityOutcome
was added - Input Field opportunityNumber: ID was added to input type
SetOpportunityOutcomeInput
- Input Field lossReason: String 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
- 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
- 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
- Type
TerminateContractInput
was removed - Type
BaseTerminateContractInput
was added - Type for argument input on field
Mutation
.terminateBusinessContract changed from TerminateContractInput! to BaseTerminateContractInput! - Type for argument input on field
Mutation
.terminateAccountContract changed from TerminateContractInput! to BaseTerminateContractInput!
- Type
PaymentPreferenceConnectionTypeConnection
was added - Type
PaymentPreferenceConnectionTypeEdge
was added - Type
PaymentPreferenceUnion
was added - Type
PreferredInstruction
was added - Type
UserManagedPayment
was added - Field paymentPreferences was added to object type
LedgerType
- Field paymentPreferences of type PaymentPreferenceConnectionTypeConnection was added to interface
LedgerInterface
- 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 LEGACY_TWILIO_CTI was removed from
VoiceVendor
enum - Enum value FAKE 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
- Field userId was added to object type
ResetUserPasswordOutput
- 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. - 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.
- 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
- Field isRiskListed was added to object type
PaymentFingerPrintCheckType
- 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 - Field metadata was added to object type
OutboundCallType
- Field metadata of type [CallMetadataItemType]! was added to interface
CallInterface
- Field metadata was added to object type
InboundCallType
- Field createCallMetadata was added to object type
Mutation
- 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
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
- Type
UnitRateForecastType
was added - Field unitRateForecast was added to object type
Agreement
- Field acceptsPayments of type Boolean was added to interface
LedgerInterface
- Field acceptsPayments was added to object type
LedgerType
- Argument accountNumber: String added to
Query
.businessContract - Type for argument identifier on field
Query
.businessContract changed from String! to String - Argument accountNumber: String added to
Query
.accountContract - Type for argument identifier on field
Query
.accountContract changed from String! to String
- 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
- 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
- Type
CompleteLeadAction
was removed - Type
CompleteLeadActionInput
was removed - Type
CompleteOpportunityAction
was added - Type
CompleteOpportunityActionInput
was added - Type
ProductRateOverrideConfigurationType
was added - Type
IndexationOptionsType
was added - Type
ProductRateOverrideScheduleType
was added - Type
ProductRateOverrideItemType
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
AddNoteToInkConversationPayload
was added - Type
InkNote
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
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
Energy
was added - Type
EnergyUnit
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
ContractMetaDataType
was added - Type
TermInterface
was added - Type
MinimumContractLengthType
was added - Type
TermType
was added - Type
TerminationFeeType
was added - Field terms was added to object type
Contract
- 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
- 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
- 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
- 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!OutboundCallType
.id type changed from ID to ID!PhoneNumberIdentificationType
.accountUserAllMatches type changed from AccountUserConnectionTypeConnection to AccountUserConnectionTypeConnection!PhoneNumberIdentificationType
.accountAllMatches type changed from AccountConnectionTypeConnection to AccountConnectionTypeConnection!CallInterface
.id type changed from ID to ID!
- 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
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
BusinessDetailType
was added - 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 SMETS2_HEALTH_CHECK was removed from
AccountReminderTypes
enum
- 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
- Type
OwnerInput
was added - Type
PaymentInstructionOwnerTypeChoices
was added - Type
PaymentInstructionOwnerType
was added - Input Field owners: [OwnerInput] was added to input type
SetUpDirectDebitInstructionInput
- 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
- Field segmentName was added to object type
BusinessType
- Type
CreateAudioRecording
was added - Type
AudioRecordingType
was added - Type
AppSessionType
was added - Type
AppSessionSalesMode
was added - Type
OutcomeType
was added - Type
AppSessionOutcomeType
was added - Type
AppSessionOutcomeCategory
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
- Type
PaymentInstructionOwnerTypeChoices
was added - Input field owners of type [OwnerInput] was added to input object type
SetUpDirectDebitInstructionInput
- Type
OwnerInput
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 [TermsAndConditionsType
]
- Type
CallInterface
was added - Type
InboundCallType
was added - Type
OutboundCallType
was added - Field call was added to object type
Query
- Input field
CreateQuoteInputParams
.postcode changed type from String! to String - Input field address of type
RichAddressInput
was added to input object type CreateQuoteInputParams - Input field electricity of type
SupplyTypeQuoteInput
was added to input object type CreateQuoteInputParams - Input field gas of type
SupplyTypeQuoteInput
was added to input object type CreateQuoteInputParams - Input field journeyType of type
String
was added to input object type CreateQuoteInputParams - Type
SupplyTypeQuoteInput
was added - Directive deprecated was added to input field city in input object
CreateQuoteInputParams
- Directive deprecated was added to input field elecProductCode in input object
CreateQuoteInputParams
- Directive deprecated was added to input field electricityAnnualConsumption in input object
CreateQuoteInputParams
- Directive deprecated was added to input field electricityAnnualNighttimeConsumption in input object
CreateQuoteInputParams
- Directive deprecated was added to input field electricityNetworkOperatorNumber in input object
CreateQuoteInputParams
- Directive deprecated was added to input field gasAnnualConsumption in input object
CreateQuoteInputParams
- Directive deprecated was added to input field gasNetworkOperatorNumber in input object
CreateQuoteInputParams
- Directive deprecated was added to input field gasProductCode in input object
CreateQuoteInputParams
- Directive deprecated was added to input field postcode in input object
CreateQuoteInputParams
- Field createDirectDebitInstruction was removed from object type Mutation
- Type CreateDirectDebitInstruction was removed
- Type CreateDirectDebitInstructionInput was removed
- Type DirectDebitInstructionIBANInput was removed
- Field delayConfiguration was added to object type
PaymentScheduleType
- Type
PaymentScheduleDelayConfigurationType
was added
- Field
QuotedProduct
.wasSelected changed type from Boolean to Boolean! - Field affiliateSessionId was added to object type
CreateQuoteOutput
- Field electricitySupplyPoint was added to object type
CreateQuoteOutput
- Field gasSupplyPoint was added to object type
CreateQuoteOutput
- Field requestedAt was added to object type
CreateQuoteOutput
- Field monthlyStandingCharge was added to object type
QuotedProduct
- Field netMonthlyStandingCharge was added to object type
QuotedProduct
- Field totalEstimatedAnnualBill was added to object type
QuotedProduct
- Field unitRateInformation was added to object type
QuotedProduct
- Type
QuotedProductConnection
was added - Type
QuotedProductEdge
was added - Type
QuotedSupplyPointType
was added - Field
QuotedProduct
.product changed type from Product to Product! - Directive deprecated was added to field
CreateQuoteOutput
.electricityQuote - Directive deprecated was added to field
CreateQuoteOutput
.gasQuote - Directive deprecated was added to field
QuotedProduct
.clientParams - Field
CreateQuoteOutput
.electricityQuote is deprecated - Field
CreateQuoteOutput
.electricityQuote has deprecation reason The electricityQuote field is deprecated. Use theCreateQuoteOutput
.electricitySupplyPoint field instead. - Marked as deprecated on 2025-02-11. - Scheduled for removal on or after 2025-05-11. - Field
CreateQuoteOutput
.gasQuote is deprecated - Field
CreateQuoteOutput
.gasQuote has deprecation reason The gasQuote field is deprecated. Use theCreateQuoteOutput
.gasSupplyPoint field instead. - Marked as deprecated on 2025-02-11. - Scheduled for removal on or after 2025-05-11. - Field
QuotedProduct
.clientParams is deprecated - Field
QuotedProduct
.clientParams has deprecation reason The clientParams field is deprecated. Use the fields on theQuotedProduct
type instead. - Marked as deprecated on 2025-02-11. - Scheduled for removal on or after 2025-05-11.
- Field fields was added to object type
AffiliateAudioRecordingPresignedPostType
- 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
- Type
AwardLoyaltyPointsInput
was added - Field awardLoyaltyPoints was added to object type
Mutation
- Type
AwardLoyaltyPoints
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 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
- Type
GenerateAffiliatesAudioRecordingPreSignedUrlInput
was added - Field generateAffiliatesAudioRecordingPreSignedUrl was added to object type
Mutation
- Type
AffiliateAudioRecordingPresignedPostType
was added - Type
GenerateAffiliatesAudioRecordingPreSignedUrl
was added
- Argument direction: EnergyProductDirection added to field Query.energyProducts
- Field
CoreSiteworksRequestType
.status changed type from RequestStatus! to String!
- Type SiteworksRequestStatus was added
- Type
UUID
was added - Type CoreSiteworksMarketSupplyPointType was removed
- Type
UpdateSiteworksRequestInputType
was added - 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
UpdateSiteworksRequest
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
BillTransactionType
was added - Type
BillCharge
was added - Type
BillCredit
was added - Type
BillPayment
was added - Type
BillRefund
was added - Type
BillTransactionConnectionTypeConnection
was added - Type
BillTransactionConnectionTypeEdge
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
- Description An enumeration. was removed from object type
AccountApplicationStatus
- Field preferredSsd was added to object type
AccountApplicationType
- Argument status:
AccountApplicationStatus
added to field AccountInterface.applications
- Field cosLossStatus (deprecated) was removed from object type
Agreement
- Field collectiveWinterWorkout was added to object type
Query
- Field personalWinterWorkout was added to object type
Query
- Type
WinterWorkoutPeriodType
was added - Type
WinterWorkoutType
was added
- Input field
RequestRepaymentInputType
.ledgerId changed type from String! to String - Input field ledgerNumber of type
String
was added to input object type RequestRepaymentInputType - Directive deprecated was added to input field ledgerId in input object
RequestRepaymentInputType
- Type CoreSiteworksMarketSupplyPointType was added
- Type
RequestStatus
was added - Field siteworksRequests was added to object type
Query
- Type
CoreSiteworksRequestConnectionTypeConnection
was added - Type
CoreSiteworksRequestConnectionTypeEdge
was added - Type
CoreSiteworksRequestType
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 authorizedApplications was added to object type Query
- Type AuthorizedApplication was added
- Directive deprecated was added to field
LedgerInterface
.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 - Directive deprecated was added to field
LedgerType
.id - 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
- 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 number was added to interface
SupplementaryLedgerInterface
- Field number was added to object type
SupplementaryLedgerType
- Directive deprecated was added to field
SupplementaryLedgerInterface
.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 - Directive deprecated was added to field
SupplementaryLedgerType
.id - 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 updateLeadExtraDetails was added to object type Mutation
- Type UpdateLeadExtraDetails was added
- Type \_UpdateExtraDetailsItem was added
- Type
UpdateExtraDetailsInput
was added
- Field getOrCreateAccountForLead was added to object type Mutation
- Type GetOrCreateShellAccountForLead was added
- Type GetOrCreateShellAccountForLeadInput was added
- Field ledgerNumber was added to interface
ReferralInterface
- Field ledgerNumber was added to interface
RewardInterface
- Directive deprecated was added to field
ReferralInterface
.ledgerId - Directive deprecated was added to field
RewardInterface
.ledgerId - Field
ReferralInterface
.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
ReferralInterface
.ledgerId is deprecated - Field
RewardInterface
.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
RewardInterface
.ledgerId is deprecated - Field ledgerNumber was added to object type
ReferralType
- Field ledgerNumber was added to object type
RewardType
- Directive deprecated was added to field
ReferralType
.ledgerId - Directive deprecated was added to field
RewardType
.ledgerId - Field
ReferralType
.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
ReferralType
.ledgerId is deprecated - Field
RewardType
.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
RewardType
.ledgerId is deprecated
- Type for argument ledgerId on field
BankTransferDetailsType
.paymentReference changed from ID! to ID - Argument ledgerNumber:
String
added to field BankTransferDetailsType.paymentReference - Directive deprecated was added to argument ledgerId of field paymentReference in type
BankTransferDetailsType
TestChargeError
object implements SmartFlexOnboardingErrorInterface interface- Type
SmartFlexOnboardingErrorInterface
was added - Type
TestChargeErrorType
was added - 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
- 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 supplyPoints was added to object type
Query
- 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 - Directive deprecated was added to argument ledgerId of field ledgers in type
AccountInterface
- Directive deprecated was added to argument ledgerId of field paginatedPaymentForecast in type
AccountInterface
- Directive deprecated was added to argument ledgerId of field paymentForecast in type
AccountInterface
- Directive deprecated was added to argument ledgerId of field payments in type
AccountInterface
- Directive deprecated was added to argument ledgerId of field transactions in type
AccountInterface
- 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
AccountType
- 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
AccountType
- 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
AccountType
- Field isSensitive was added to object type
AccountUserDetailType
- Field CreateDirectDebitInstruction.directDebitInstruction is deprecated
- Field CreateDirectDebitInstruction.directDebitInstruction has deprecation reason The CreateDirectDebitInstruction field is deprecated.
- Directive deprecated was added to field CreateDirectDebitInstruction.directDebitInstruction
- 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
- 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
- Type PossibleError was added
- Type
CreateCreditTransferPermissionInput
was added - Field createCreditTransferPermission was added to object type
Mutation
- Type
CreateCreditTransferPermission
was added
- Type
Vendor
was added - Input field vendorName of type Vendor! was added to input object type
InstructionDetailsInput
- 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
- 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
SetUpDirectDebitInstructionInput
.ledgerId changed type from ID! to ID - Input field ledgerNumber of type
String
was added to input object type SetUpDirectDebitInstructionInput - 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
- Input field
AccountLedgerInput
.ledgerId changed type from ID! to ID - Directive deprecated was added to input field ledgerId in input object
AccountLedgerInput
- Input field ledgerNumber of type
String
was added to input object type AccountLedgerInput
- Field key was added to object type
RegenerateSecretKey
- Input field
UpdateAutoTopUpAmountInput
.ledgerId changed type from Int! to Int - Input field ledgerNumber of type
String
was added to input object type UpdateAutoTopUpAmountInput - Directive deprecated was added to input field ledgerId in input object
UpdateAutoTopUpAmountInput
- Field
PortfolioType
.ancestors changed type from NestedPortfolioConnectionTypeConnection to PortfolioConnectionTypeConnection - Type NestedPortfolioConnectionTypeConnection was removed
- Type NestedPortfolioConnectionTypeEdge was removed
- Type NestedPortfolioType was removed
- Field
PortfolioType
.descendants changed type from NestedPortfolioConnectionTypeConnection to PortfolioConnectionTypeConnection - Field
PortfolioType
.parent changed type from NestedPortfolioType
toPortfolioType
- Argument integrationDeviceId:
String
added to field Query.devices - Field integrationDeviceId was added to interface
SmartFlexDeviceInterface
- Field integrationDeviceId was added to object type
SmartFlexBattery
- Field integrationDeviceId was added to object type
SmartFlexChargePoint
- Field integrationDeviceId was added to object type
SmartFlexDevice
- Field integrationDeviceId was added to object type
SmartFlexVehicle
- Input field
CollectPaymentInput
.ledgerId changed type from ID! to ID - Input field ledgerNumber of type
String
was added to input object type CollectPaymentInput - Directive deprecated was added to input field ledgerId in input object
CollectPaymentInput
- Type RetentionQuoteSupplyTypeChoices was removed
- Input field
RetentionQuoteInput
.supplyType changed type from RetentionQuoteSupplyTypeChoices! to SupplyType!
- 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
PostCreditInput
.ledgerId changed type from ID! to ID - Input field ledgerNumber of type
String
was added to input object type PostCreditInput - 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
- Type
SwitchAccountToVariablePaymentScheduleInput
was added - Field switchAccountToVariablePaymentSchedule was added to object type
Mutation
- Type
SwitchAccountToVariablePaymentSchedule
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
- 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
- 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
- Directive deprecated was added to field
PortfolioType
.accountsCount - 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
SendVerificationEmail
.verificationStatus changed type from VerificationRequestStatus to Boolean
- Input field
CloseDCAProceedingInputType
.stoppedDate changed type from String! to Date!
- Type
VerificationRequestStatus
was added - Field verificationStatus was added to object type
Query
- Type
EmailVerificationStatus
was added
- Type
VerificationRequestStatus
was added - Type
SendVerificationEmailInput
was added - Field sendVerificationEmail was added to object type
Mutation
- Type
SendVerificationEmail
was added
- Input field
CloseDCAProceedingInputType
.campaign changed type from String! to String
- Argument expiresAt:
DateTime
was added to input RegisterPushNotificationBinding
- Type
PossibleErrorsInputType
was added - Field possibleErrors was added to object type
Query
- Type
PossibleErrorsOutputType
was added
- Type TypedSourceOutput was removed
- Type UtilityType was removed
- Field typedSource (deprecated) was removed from object type
MeasurementsMetadataOutput
- Argument fields: [String] added to field
CombinedRateLimitInformation
.fieldSpecificRateLimits
- Field fieldSpecificRateLimits was added to object type
CombinedRateLimitInformation
- Type
FieldSpecificRateLimitInformation
was added - Type
FieldSpecificRateLimitInformationConnectionTypeConnection
was added - Type
FieldSpecificRateLimitInformationConnectionTypeEdge
was added