GraphQL API Changelog

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

Field paymentUuid was added to object type AccountRepaymentType

Type _BooleanParam was added
Input Field boolean: _BooleanParam was added to input type _QuotingParam

Type PartnerCommissionType was added
Type PartnerCommissionContractConfigType was added
Type PartnerCommissionInput was added
Type PartnerCommissionContractConfigInput was added
Enum value Smc was added to ConsumptionUnit enum
Input Field partnercommission: PartnerCommissionInput was added to input type OneOfTermInput
Deprecation reason on field AccountPaymentType.id changed from None to
The 'id' field is deprecated.

Please use uuid instead.

- Marked as deprecated on 2026-05-28.
- Scheduled for removal on or after 2026-08-28.
AccountPaymentType.id type changed from ID! to ID

Type ExtraDetailFieldType was added
ExtraDetailInput.fieldType type changed from String to ExtraDetailFieldType!
ExtraDetailInput.fieldValue type changed from String to String!

Field uuid was added to object type AccountPaymentType

PartnerUserType.organisation type changed from AffiliateOrganisationType! to AffiliateOrganisationType

Type PossibleError was added
Type RateLimit was added

Type ExtraQuotingParamsType was added
Type ForecastConsumptionEntryType was added
Type ConsumptionSplitType was added
Type ForecastConsumptionEntryInput was added
Type ConsumptionSplitInput was added
Input Field forecastConsumptionEntries: [ForecastConsumptionEntryInput] was added to input type UpdateQuoteConfigurationInput
Field extraQuotingParams was added to object type QuoteConfigurationType

Type SendAgreementRescissionConfirmation was added
Type SendAgreementRescissionMessageInput was added
Field sendAgreementRescissionConfirmation was added to object type Mutation

Deprecation reason on field LeadOutput.assignedToTeamIdentifier changed from None to
The 'assignedToTeamIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
Deprecation reason on field LeadOutput.assignedToUserIdentifier changed from None to
The 'assignedToUserIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
Deprecation reason on field LeadOutput.assignedToAffiliateNumber changed from None to
The 'assignedToAffiliateNumber' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.

Type QuoteBillDueDateConfigurationType was added
Input Field emergencyApprovalDetails removed from input type CreateOnSiteJobsRequestInputType

Enum value RATES_REQUEST_FAILED was added to QuoteConfigurationStatus enum

Enum value VALIDATING was added to RolloverStatus enum
Enum value PENDING_VALIDATION was added to RolloverStatus enum
Enum value VALIDATING was added to AgreementRolloverStatus enum
Enum value PENDING_VALIDATION was added to AgreementRolloverStatus enum

Type BillRepresentationContextType was added
Field context was added to object type BillRepresentationType
Field message was added to object type Query
Field account was added to object type Message
Field id was added to object type Message
Field accountUser was added to object type Message

Field isFinal was added to object type StatementType
Field isFinal was added to object type StatementDetailsBillingDocumentType
Field isFinal was added to object type StatementBillingDocumentType

Type PartnerUserType was added
Type PartnerUserPermission was added
Field partnerUser was added to object type Query
Enum value ACCEPTED was added to QuoteConfigurationStatus enum
Enum value REJECTED was added to QuoteConfigurationStatus enum
Enum value SENT was added to QuoteConfigurationStatus enum
Enum value READY was added to QuoteConfigurationStatus enum
Enum value FINALISED was removed from QuoteConfigurationStatus enum

Type UpdateLeadAssignment was removed
Type UpdateLeadAssignmentInput was removed
Field updateLeadAssignment was removed from object type Mutation
Deprecation reason on field Lead.assignedToUserIdentifier changed from None to
The 'assignedToUserIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
Deprecation reason on field Lead.assignedToTeamIdentifier changed from None to
The 'assignedToTeamIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.

Type QuoteConfigurationStatus was added
Field status was added to object type QuoteConfigurationType
Input Field status: QuoteConfigurationStatus was added to input type UpdateQuoteConfigurationInput

Type CompleteReminder was added
Type CompleteReminderInput was added
Field completeReminder was added to object type Mutation

Type AttachAgreementsToContractsOutput was added
Type AttachAgreementsToContractsInput was added
Type DetachAgreementsFromContractsOutput was added
Type DetachAgreementsFromContractsInput was added
Field attachAgreementsToContracts was added to object type Mutation
Field detachAgreementsFromContracts was added to object type Mutation

Enum value BOTTOMLINE_PTX_BATCHED_HD_NHH was added to Vendor enum
Enum value BOTTOMLINE_PTX_BATCHED_HD was added to Vendor enum

Enum value FCM was added to NotifiableApplicationExternalProvider enum

Type QuoteContractedVolumeConfigurationType was added
Type QuoteContractedVolumePeriodType was added

Deprecation reason on field Lead.salesChannel changed from None to
The 'salesChannel' field is deprecated.

Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity.

- Marked as deprecated on 2025-06-17.
- Scheduled for removal on or after 2025-10-17.
Deprecation reason on field LeadOutput.salesChannel changed from None to
The 'salesChannel' field is deprecated.

Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity.

- Marked as deprecated on 2025-06-17.
- Scheduled for removal on or after 2025-10-17.

Type CorrectivePeriodType was added
Type CorrectivePeriodMarketConfigType was added
Type CorrectivePeriodInput was added
Type CorrectivePeriodMarketConfigInput was added
Input Field correctiveperiod: CorrectivePeriodInput was added to input type OneOfTermInput

Enum value ANZ was added to Vendor enum

Type AccountDebtPositionType was added
Type LedgerDebtPositionType was added
Type LedgerDebtPositionStatus was added
Field accountDebtPosition was added to object type Query

Field ratesAgreedAt was added to object type Agreement
Field ratesAgreedAt was added to object type CommonAgreementType
Field ratesAgreedAt of type DateTime was added to interface AgreementInterface

Type ValidateAddress was added
Type ValidateAddressInput was added
Type AddressFieldGroupInput was added
Type AddressFieldInput was added
Field errors was added to object type AddressFieldConfigType
Field validateAddress was added to object type Mutation

Type PartnerViewerType was added
Type PartnerViewerPermission was added
Field partnerViewer was added to object type Query

Type RecordActivatedPaymentMethod was added
Type PaymentMethodType was added
Type RecordActivatedPaymentMethodInput was added
Type PaymentMethodActionIntentOneOfInput was added
Type PaymentMethodActionIntentOptionsInput was added
Type PaymentMethodActionIntentTargetType was added
Type FinancialAccountDetailsOneOfInput was added
Type CardDetailsInput was added
Type CardType was added
Type CardPaymentNetwork was added
Type BACSDirectDebitDetailsInput was added
Type SEPADirectDebitDetailsInput was added
Type ACHDirectDebitDetailsInput was added
Type AusBECSDirectDebitDetailsInput was added
Type ACSSDebitDetailsInput was added
Type NzlBECSDirectDebitDetailsInput was added
Type JPNDirectDebitDetailsInput was added
Type BPAYDetailsInput was added
Field recordActivatedPaymentMethod was added to object type Mutation
Enum value CHARGEBACK was added to RepaymentReason enum

Enum value MEGAWATT_HOURS was added to Units enum

Type CompleteApproval was added
Type CompletedApproval was added
Type CompleteApprovalInputType was added
Field completeApproval was added to object type Mutation

Type DayType was added
Input Field numberOfDays: Int was added to input type BillDueDateInput
Input Field typeOfDays: DayType was added to input type BillDueDateInput
Field numberOfDays was added to object type BillDueDateType
Field typeOfDays was added to object type BillDueDateType

Argument displayableNumber: String added to Query.business
Field displayableNumber was added to object type BusinessType

Type AddressFieldDescriptorType was added
Type AddressFieldGroupType was added
Type AddressFieldConfigType was added
Type AddressFieldTypeEnum was added
Type AddressFieldValidationRuleType was added
Type AddressFieldOptionType was added
Field addressFields was added to object type Query

Input Field email removed from input type ObtainJSONWebTokenInput
Input Field password removed from input type ObtainJSONWebTokenInput
Input Field captchaResponse removed from input type ObtainJSONWebTokenInput

Enum value DEBT_DISCONNECTION was added to LeaveSupplierSubType enum

Type CollectionProcessStepStatus was added
UpdateCollectionProcessRecordLatestStepInputType.status type changed from String! to CollectionProcessStepStatus!
CollectionProcessStepType.status type changed from String to CollectionProcessStepStatus

Deprecation reason on field Lead.assignedToOrganization changed from None to
The 'assignedToOrganization' field is deprecated.

Please use 'assignedToTeamIdentifier' instead.

- Marked as deprecated on 2026-05-07.
- Scheduled for removal on or after 2026-07-07.

Type BespokeRateItemTypeEnum was added
Input Field rateSpecificationType: String was added to input type BespokeRateItemInput
Field rateSpecificationType was added to object type BespokeRateItemType

Type Municipalities was added
GasProductCatalogueRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.city type changed from String! to Municipalities!

Type ReadingQualityMeta was added
Type MeterDataQualities was added
Field qualities was added to object type Reading

Type AccountUserDetailInput was added
Argument detail: AccountUserDetailInput added to Query.accountUser

Type UpdateCollectionProcessRecordLatestStep was added
Type UpdateCollectionProcessRecordLatestStepOutputType was added
Type CollectionProcessStepType was added
Type UpdateCollectionProcessRecordLatestStepInputType was added
Field updateCollectionProcessRecordLatestStep was added to object type Mutation

Enum value UNSUPPORTED_FEATURE was removed from AccountReminderTypes enum

CreateReminderInput.dueAt type changed from DateTime! to DateTime

Type RetireCustomerAsset was added
Type RetireCustomerAssetInput was added
Field retireCustomerAsset was added to object type Mutation

Type RepaymentReason was added
Field reason was added to object type AccountRepaymentType

Field quoteConfiguration was added to object type UpdateQuoteConfigurationOutput
Field quoteConfigurationNumber was removed from object type UpdateQuoteConfigurationOutput

Deprecation reason on field Query.energyMixData changed from None to
The 'energyMixData' field is deprecated.

This is no longer being used.

- Marked as deprecated on 2026-05-05.
- Scheduled for removal on or after 2026-06-01.

Enum value SAP was added to OnSiteJobsAgent enum

Type BaseInstigateContractTerminationInput was removed
Type ContractTerminationInstigated was removed
Field instigateContractTermination was removed from object type Mutation

Type UpdateQuoteConfigurationOutput was added
Type UpdateQuoteConfigurationInput was added
Type BespokeRateTermInput was added
Type UpdateBespokeRateScheduleInput was added
Type UpdateBespokeRateItemInput was added
Type ExtraDetailInput was added
Field updateQuoteConfiguration was added to object type Mutation

Type BuildEnrollmentPayload was added
Type BuildEnrollmentPayloadInput was added
Field buildEnrollmentPayload was added to object type Query

Input Field assignedToUserIdentifier: String was added to input type OpportunitiesQueryInput
Input Field assignedToTeamIdentifier: String was added to input type OpportunitiesQueryInput
Input Field assignedToUserIdentifier: String was added to input type UpdateLeadDetailsInput
Input Field assignedToTeamIdentifier: String was added to input type UpdateLeadDetailsInput
Field assignedToUserIdentifier was added to object type LeadOutput
Field assignedToTeamIdentifier was added to object type LeadOutput
Deprecation reason on field LeadOutput.assignedToTeam changed from None to
The 'assignedToTeam' field is deprecated.

Please use 'assignedToTeamIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
Deprecation reason on field LeadOutput.assignedToUser changed from None to
The 'assignedToUser' field is deprecated.

Please use 'assignedToUserIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
Input Field assignedToUserIdentifier: String was added to input type UpdateOpportunityAssignmentInput
Input Field assignedToTeamIdentifier: String was added to input type UpdateOpportunityAssignmentInput
Input Field assignedToUserIdentifier: String was added to input type CreateLeadInput
Input Field assignedToTeamIdentifier: String was added to input type CreateLeadInput
Input Field assignedToUserIdentifier: String was added to input type CreateOpportunityAndLeadInput
Input Field assignedToTeamIdentifier: String was added to input type CreateOpportunityAndLeadInput
Input Field assignedToUserIdentifier: String was added to input type UpdateLeadAssignmentInput
Input Field assignedToTeamIdentifier: String was added to input type UpdateLeadAssignmentInput
Field assignedToUserIdentifier was added to object type Lead
Field assignedToTeamIdentifier was added to object type Lead
Deprecation reason on field Lead.assignedToUsername changed from None to
The 'assignedToUsername' field is deprecated.

Please use 'assignedToUserIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
Input Field assignedToUserIdentifier: String was added to input type CreateOpportunityForLeadInput
Input Field assignedToTeamIdentifier: String was added to input type CreateOpportunityForLeadInput
Input Field assignedToUserIdentifier: String was added to input type LeadsQueryInput
Input Field assignedToTeamIdentifier: String was added to input type LeadsQueryInput
Field assignedToUserIdentifier was added to object type OpportunityOutput
Field assignedToTeamIdentifier was added to object type OpportunityOutput
Deprecation reason on field OpportunityOutput.assignedToTeam changed from None to
The 'assignedToTeam' field is deprecated.

Please use 'assignedToTeamIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
Deprecation reason on field OpportunityOutput.assignedToUser changed from None to
The 'assignedToUser' field is deprecated.

Please use 'assignedToUserIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.

Type RescindContractOutput was added
Type RescindContractInput was added
Field rescindContract was added to object type Mutation
Field rescindedAt was added to object type ContractDetails
Field rescindedAt was added to object type Contract

Field source was removed from object type Reading
Field quality was removed from object type Reading

Type LocaltimeMidnightAlignedDateField was removed
CreateContractInput.signedAtDate type changed from LocaltimeMidnightAlignedDateField to IndustryMidnightAlignedDateField

Enum value AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING was removed from AccountReminderTypes enum

Enum value INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE was removed from AccountReminderTypes enum

Input Field device: String was added to input type AccountSearchInputType
Enum value SOLAR_EXPORT_CREDITS_EXCESS was removed from AccountReminderTypes enum

Type LocaltimeMidnightAlignedDateField was added
Enum value METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_ACCEPTED was removed from AccountReminderTypes enum
Input Field signedAtDate: LocaltimeMidnightAlignedDateField was added to input type CreateContractInput
Input Field validFromDate: IndustryMidnightAlignedDateField was added to input type CreateContractInput
Input Field validToDate: IndustryMidnightAlignedDateField was added to input type CreateContractInput
CreateContractInput.signedAt type changed from DateTime! to DateTime
CreateContractInput.validFrom type changed from DateTime! to DateTime

Type IndustryMidnightAlignedDateField was added
Input Field validFromDate: IndustryMidnightAlignedDateField was added to input type ActualizeContractInput
ActualizeContractInput.validFrom type changed from DateTime! to DateTime
Input Field applicableAtDate: IndustryMidnightAlignedDateField was added to input type VaryContractTermsInput
Input Field validToDate: IndustryMidnightAlignedDateField was added to input type TerminateContractInput
TerminateContractInput.validTo type changed from DateTime! to DateTime

Type SMSContentInput was added
Input Field smsContent: SMSContentInput was added to input type CreateExternalMessageInput
CreateExternalMessageInput.emailContent type changed from EmailContentInput! to EmailContentInput

Enum value NEEDS_ATTENTION was added to AgreementRolloverStatus enum
Enum value NEEDS_ATTENTION was added to RolloverStatus enum

Type PurchaseVouchers was added
Type LeadType was added
Field purchaseVouchers was added to object type Mutation
Field lead was added to object type PaymentInstructionOwnerType

Field textRegex was added to object type FunnelField

Enum value IEE_MINIMUM_B2B was added to TaxTypesCode enum

Enum value INVALID was added to LifecycleSupplyPointProcessStatus enum

Field fieldCode was added to object type QuoteConfigurationExtraDetailItemType
Field fieldValue was added to object type QuoteConfigurationExtraDetailItemType
Field fieldType was added to object type QuoteConfigurationExtraDetailItemType
Field valueType was removed from object type QuoteConfigurationExtraDetailItemType
Field value was removed from object type QuoteConfigurationExtraDetailItemType
Field code was removed from object type QuoteConfigurationExtraDetailItemType

Enum value ADYEN was added to Vendor enum

Type QuoteBespokeRateConfigurationType was added
Type QuoteTermInterface was added
Type QuoteBespokeRateScheduleType was added
Type QuoteBespokeRateItemType was added
Type QuoteConfigurationVariantProfileType was added
Type QuoteConfigurationType was added
Type QuoteConfigurationExtraDetailItemType was added
Enum value GAS_READING_REMOVED_INSTALLED_RECEIVED was removed from AccountReminderTypes enum
Field quoteConfigurationByNumber was added to object type Query

Enum value FIELDWORKS_SERVICE_ORDER_STATUS_UPDATED was removed from AccountReminderTypes enum

Enum value GAS_EXCEPTION_CUSTOMER_TRANSFER_CANCELLED was removed from AccountReminderTypes enum
Field isOfficial was added to object type ComplaintType

Type PublishApprovalApprovedEvent was removed
Type PublishApprovalApprovedEventInput was removed
Type InstigateContractVariationOutput was removed
Type InstigateContractVariationInput was removed
Type OnSiteJobsAppointmentBookingDetailsInput was removed
Type OnSiteJobsUpdateAppointmentInput was removed
Type OnSiteJobsAppointmentCancellationCategory was removed
Type OnSiteJobsExternalJobTypeMappingType was removed
Type OnSiteJobsCommsStrategy was removed
Type OnSiteJobsWorkCategory was removed
Type OnSiteJobsAppointmentStatus was removed
Type OnSiteJobsCancellationCategory was removed
Type CoreSiteworksAppointmentType was removed
Type OnSiteJobsAppointmentConnectionTypeConnection was removed
Type OnSiteJobsAppointmentConnectionTypeEdge was removed
Type OnSiteJobsAppointmentType was removed
Type OnSiteJobsAppointmentActionConnectionTypeConnection was removed
Type OnSiteJobsAppointmentActionConnectionTypeEdge was removed
Type OnSiteJobsAppointmentActionType was removed
Type OnSiteJobsAppointmentActionTriggerStage was removed
Type OnSiteJobsWorkflowStatus was removed
Type OnSiteJobsAppointmentSlotResultsType was removed
Type OnSiteJobsAppointmentSlotType was removed
Type OnSiteJobsJobTypeType was removed
Type CancelOnSiteJobsAppointment was removed
Type CancelOnSiteJobsAppointmentInputType was removed
Type UpdateOnSiteJobsAppointment was removed
Type StartOnSiteJobsAppointmentBookingSession was removed
Type CreateOnSiteJobsAppointment was removed
Type CreateOnSiteJobsAppointmentWithDate was removed
Type CreateOnSiteJobsAppointmentWithoutBooking was removed
Type OnSiteJobsCreateAppointmentInput was removed
Type InkConversationsConnection was added
Type InkConversationsEdge was added
Type ExtendAgreementPeriod was added
Type ExtendAgreementPeriodInput was added
Type AssociateArchivedRecordingsSummaryType was added
Type AssociateArchivedRecordingResultType was added
Type AssociateArchivedRecordingResultStatus was added
Field results was added to object type AssociateArchivedCallRecordingsWithCalls
Field summary was added to object type AssociateArchivedCallRecordingsWithCalls
Field receivedCount was removed from object type AssociateArchivedCallRecordingsWithCalls
Field params was added to object type Reminder
Input Field stepSlug removed from input type UpdateAgreementRescissionInput
Input Field stepName removed from input type UpdateAgreementRescissionInput
Enum value AWAITING_APPROVAL was added to CatalogComponentStatus enum
Field stepSlug was removed from object type AgreementRescissionType
Field stepName was removed from object type AgreementRescissionType
Field appointmentCheckResults was removed from object type OnSiteJobsCheckResultsType
Field hasAppointmentWarnings was removed from object type OnSiteJobsCheckResultsType
Field canCreateAppointment was removed from object type OnSiteJobsCheckResultsType
Field inkLiveChatConversations was added to object type Query
Field getOnSiteJobsJobTypes was removed from object type Query
Field getOnSiteJobsAppointmentByExternalReference was removed from object type Query
Field getOnSiteJobsAppointmentById was removed from object type Query
Field getOnSiteJobsAppointmentSlots was removed from object type Query
Input Field assignedToAffiliateNumber: String was added to input type UpdateLeadAssignmentInput
Field lastMessageAt was added to object type InkConversation
Enum value INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CANCELLED was removed from AccountReminderTypes enum
Enum value INDUSTRY_EXCEPTION_CHANGE_REQUEST_COMPLETED was removed from AccountReminderTypes enum
Enum value JPN_SUPPLY_POINT_FAILS_CAN_SUPPLY_CHECK was removed from AccountReminderTypes enum
Enum value INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_NEXT_SCHEDULED_READ_DATE_PAST was removed from AccountReminderTypes enum
Enum value INDUSTRY_MANUAL_ACTION_REQUIRED was removed from AccountReminderTypes enum
Enum value JPN_SHORT_TERM_MOVE_IN_REJECTION was removed from AccountReminderTypes enum
Field energyConsumptionWhP2 was added to object type SIPSGasMonthlyConsumption
Field energyConsumptionWhP1 was added to object type SIPSGasMonthlyConsumption
Field consumptionWhP2 was removed from object type SIPSGasMonthlyConsumption
Field consumptionWhP1 was removed from object type SIPSGasMonthlyConsumption
Field extendAgreementPeriod was added to object type Mutation
Field updateOnSiteJobsAppointment was removed from object type Mutation
Field createOnSiteJobsAppointment was removed from object type Mutation
Field publishApprovalApprovedEvent was removed from object type Mutation
Field createOnSiteJobsAppointmentWithDate was removed from object type Mutation
Field startOnSiteJobsAppointmentBookingSession was removed from object type Mutation
Field cancelOnSiteJobsAppointment was removed from object type Mutation
Field createOnSiteJobsAppointmentWithoutBooking was removed from object type Mutation
Field instigateContractVariation was removed from object type Mutation
Input Field assignedToTeamName: String was added to input type UpdateLeadDetailsInput
Input Field assignedToAffiliateNumber: String was added to input type UpdateLeadDetailsInput
Input Field assignedToUsername: String was added to input type UpdateLeadDetailsInput
Field required was added to object type FunnelField
Deprecation reason on field FunnelField.deprecated changed from None to
The 'deprecated' field is deprecated.

Fields are not being deprecated

- Marked as deprecated on 2026-04-20.
- Scheduled for removal on or after 2026-05-20.
Input Field assignedToAffiliateNumber: String was added to input type UpdateOpportunityAssignmentInput
Field clientData was added to object type SIPSGasData
Enum value UPDATE_IN_PROGRESS was added to LifecycleSupplyPointProcessStatus enum
Enum value UPDATE_ERRORED was added to LifecycleSupplyPointProcessStatus enum
Enum value UPDATE_STALLED was added to LifecycleSupplyPointProcessStatus enum
Enum value UPDATE_FAILED was added to LifecycleSupplyPointProcessStatus enum
Enum value RESCINDED was added to ContractStatus enum
Field conversationRelayId was added to object type EscalateInkConversation
Field conversation was removed from object type EscalateInkConversation
Input Field archivedRecordingFileUri: URI! was added to input type ArchivedCallRecordingInput
Input Field publicRecordingFileUri removed from input type ArchivedCallRecordingInput
Input Field accountNumber: String! was added to input type EscalateInkConversationInput
Field appointments was removed from object type CoreSiteworksRequestType
Field appointments was removed from object type OnSiteJobsRequestType
Enum value IEE_MINIMUM was added to TaxTypesCode enum
Enum value IEH_REDUCED_B2B was added to TaxTypesCode enum
Field label was added to object type QuotingParamType
Deprecation reason on field SalesFunnel.uncollectedFields changed from None to
The 'uncollectedFields' field is deprecated.

Is not necessary since fields are part of a collection

- Marked as deprecated on 2026-04-20.
- Scheduled for removal on or after 2026-05-20.
Input Field params: JSONString was added to input type CreateReminderInput

Enum value INDUSTRY_WARNING_MESSAGE_RECEIVED was removed from AccountReminderTypes enum

Enum value REQUESTED was removed from OnSiteJobsAssetStatus enum

Type CreatePaymentMethodActionIntent was added
Type CreatePaymentMethodActionIntentInput was added
Type PaymentMethodOwnerInput was added
Field createPaymentMethodActionIntent was added to object type Mutation

Type TerminationFeeTypeEnum was added
TerminationFeeType.feeType type changed from TerminationFeeType to TerminationFeeTypeEnum

Type UpdateOptionsLanguagePreference was added
Type OptionsLanguagePreferenceChoices was added
Type OptionsLanguagePreferenceInput was added
Field updateOptionsLanguagePreference was added to object type Mutation

Type EscalateInkConversation was added
Type EscalateInkConversationInput was added
Enum value ESCALATE_INK_CONVERSATION was added to ExpiringTokenScope enum
Enum value ESCALATE_INK_CONVERSATION was added to PreSignedTokenScope enum
Field escalateInkConversation was added to object type Mutation

Type AssociateArchivedCallRecordingsWithCalls was added
Type AssociateArchivedCallRecordingsWithCallsInput was added
Type ArchivedCallRecordingInput was added
Type URI was added
Field associateArchivedCallRecordingsWithCalls was added to object type Mutation

Input Field contractNote: ContractNoteInput was added to input type TerminateContractInput
Input Field contractNote: ContractNoteInput was added to input type VaryContractTermsInput

Field id was added to object type AccountNoteType

Type CreateExternalMessageEvent was added
Type ExternalMessageEventType was added
Type MessageEventType was added
Type CreateExternalMessageEventInput was added
Type DeliveryFailedInput was added
Type DeferredInput was added
Type OpenedInput was added
Type ClickedInput was added
Input Field isHouseMove: Boolean was added to input type LeaveSupplierInput
Input Field isHouseMove: Boolean was added to input type UpdateLeaveSupplierInput
Field createExternalMessageEvent was added to object type Mutation

Enum value READ was added to InkMessageDeliveryStatus enum

Field stage was added to object type LeaveSupplierProcessType
Field stage was added to object type JoinSupplierProcessType

Deprecation reason on field Mutation.instigateContractTermination changed from None to
The 'instigateContractTermination' field is deprecated.

This is a legacy mutation. The terminateContract mutation should be used instead.

- Marked as deprecated on 2026-04-01.
- Scheduled for removal on or after 2026-04-30.

Field request was added to object type OnSiteJobsAppointmentType
Enum value POST_APPOINTMENT_RESCHEDULED was added to OnSiteJobsAppointmentActionTriggerStage enum

Enum value IFS was added to OnSiteJobsAgent enum

GasProductCatalogueRetailerSwitchEnrollmentMarketInput.estimatedAnnualFlow type changed from String! to Int
GasProductCatalogueRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.estimatedAnnualFlow type changed from String! to Int

Field billingTriggerConfiguration was added to object type LedgerType
Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface LedgerInterface
Field billingTriggerConfiguration was added to object type Account
Field billingTriggerConfiguration was added to object type LedgerWithPaymentsInstructions
Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface AccountInterface

Type TrancheTargetConfigurationType was added
Type TrancheTargetMarketConfigurationType was added
Type TrancheTargetConfigurationInput was added
Type TrancheTargetMarketConfigurationInput was added
Type CalculationPeriodFrequency was added
Input Field tranchetargetconfiguration: TrancheTargetConfigurationInput was added to input type OneOfTermInput

Type BulkAwardLoyaltyPoints was added
Type BulkAwardLoyaltyPointsInsertedItemResult was added
Type BulkAwardLoyaltyPointsFailedItemResult was added
Type BulkAwardLoyaltyPointsInput was added
Type BulkAwardLoyaltyPointsItemInput was added
Field bulkAwardLoyaltyPoints was added to object type Mutation

Field isReversed was added to object type VoucherRedemptionType

Field extraData was added to object type JoinSupplierProcessDataType

Type CreateAccountCredit was removed
Type CreateAccountCreditInput was removed
Type AccountCreditReasonType was removed
Argument accountNumbers: [NonEmptyString!] added to Query.getOnSiteJobsRequests
Field createAccountCredit was removed from object type Mutation

Enum value PROPERTY was added to LinkedObjectType enum
Enum value ACCOUNT_PROPERTY_EFFECTIVE_PERIOD was added to LinkedObjectType enum

Type UpdateCampaignAccountExpiryDate was added
Type UpdateCampaignAccountExpiryDateInput was added
Field updateCampaignAccountExpiryDate was added to object type Mutation

Type BillingTriggerConfigurationsForTarget was added
Type BillingTriggerTargetReference was added
Type BillingTriggerTargetType was added
Type BillingTriggerConfiguration was added
Type BillingOperationFrequency was added
Type BillingTriggerOperationType was added
Type BillingTriggerFrequency was added
Type BillingOperationTemporalParamsType was added
Type BillingTriggerConfigurationsConnection was added
Type BillingTriggerConfigurationsEdge was added
Type TargetInput was added
Field billingTriggerConfigurations was added to object type Query

Enum value CUSTOM was added to PaymentType enum

Type PaymentScheduleDataType was added
Type RegularScheduleType was added
Type BillTriggeredScheduleType was added
Type BalanceTriggeredScheduleType was added
Type BillTriggeredBalanceTargetScheduleType was added
Field paymentScheduleData was added to object type JoinSupplierProcessDataType

Argument decimalPlaces: Int added to ProductInterface.prices
Argument decimalPlaces: Int added to Product.prices

Input Field timestamp: DateTime! was added to input type PaymentDetailsInput
Input Field timestamp: DateTime! was added to input type FailedPaymentDetailsInput
Input Field timestamp: DateTime! was added to input type SuccessfulPaymentDetailsInput

Type PaymentAdequacyChangeType was added
Field latestAppliedPaymentAdequacyChange was added to object type PaymentAdequacyDetailsType

Argument excludeByDisplayName: [String] added to Query.vouchersForAccount

Type InkStorylineAnalyzerResult was added
Type InkStorylineAnalyzerResultInput was added
Type StorylineAnalyzerTypeChoices was added
Field analyzerResults was added to object type InkStoryline
Input Field analyzerResults: [InkStorylineAnalyzerResultInput!] was added to input type AddStorylineToInkConversationInput

Type RegisterCustomerAsset was added
Type RegisterCustomerAssetInput was added
Type CustomerAssetTypeEnum was added
Type CustomerAssetType was added
Field customerAsset was added to object type Query
Field customerAssets of type [CustomerAssetType] was added to interface AccountInterface
Field customerAssets was added to object type Account
Field registerCustomerAsset was added to object type Mutation

Type CreateInternalCompany was added
Type CreateInternalCompanyResultType was added
Type CreateInternalCompanyInput was added
Field createInternalCompany was added to object type Mutation

Type PushNotificationEventType was added
Type PushNotificationMessageType was added
Enum value PUSH_NOTIFICATION_SENT was added to AccountEventType enum
Union member PushNotificationEventType was added to AccountEvent Union type

Enum value DUPLICATE_CARD_FINGERPRINTS was added to AccountReminderTypes enum
Enum value DUPLICATE_CARD_FINGERPRINTs was removed from AccountReminderTypes enum
Argument offset: Int added to Query.opportunities
Argument offset: Int added to Query.leads

Field refundedAt was added to object type VoucherPurchaseType
Argument excludeRefunded: Boolean added to Query.vouchersForAccount

Type PublishApprovalApprovedEvent was added
Type PublishApprovalApprovedEventInput was added
Field publishApprovalApprovedEvent was added to object type Mutation

Type RecordFailedPayment was added
Type RecordFailedPaymentInput was added
Type FailedPaymentDetailsInput was added
Type FailureReason was added
Type InternalCompanyConnectionTypeConnection was added
Type InternalCompanyConnectionTypeEdge was added
Type RoutingAttributeType was added
Field routingAttributes was added to object type Query
Field internalCompanies was added to object type Query
Field recordFailedPayment was added to object type Mutation

Type ContractNoteInput was added
Type ContractNoteType was added
Field notes was added to object type ContractDetails
Field notes was added to object type ContractCreationJourneyType
Field notes of type [ContractNoteType] was added to interface ContractJourneyInterface
CreateExternalMessageInput.accountNumber type changed from String to String!
Input Field contractNote: ContractNoteInput was added to input type InstigateContractVariationInput
Field notes was added to object type Contract
Input Field contractNote: ContractNoteInput was added to input type BaseInstigateContractTerminationInput

Type EnrollmentReversed was added
Type ReverseEnrollmentInput was added
Field reverseEnrollment was added to object type Mutation

Type LeaveSupplierReversed was added
Type ReverseLeaveSupplierInput was added
Field reverseLeaveSupplier was added to object type Mutation

Type OrderDetailsType was removed
Type OrderType was removed
Type OrderCustomerType was removed
Type OrderLineType was removed
Type OrderItemType was removed
Type ItemProfileType was removed
Type OrderLinePeriodType was removed
Type OrderLineDateRangeType was removed
Type OrderLineDurationType was removed
Type OrderResource was removed
Type ProcessOrderOutput was removed
Type LegacyOrderDetailsType was added
Type LegacyOrderType was added
Type LegacyOrderCustomerType was added
Type LegacyOrderLineType was added
Type LegacyOrderItemType was added
Type LegacyItemProfileType was added
Type LegacyOrderLinePeriodType was added
Type LegacyOrderLineDateRangeType was added
Type LegacyOrderLineDurationType was added
Type LegacyOrderResource was added
Type LegacyProcessOrderOutput was added
Type OnSiteJobsExternalJobTypeMappingType was added
Field legacyOrderDetails was added to object type Query
Field orderDetails was removed from object type Query
Field externalJobTypeMapping was added to object type OnSiteJobsAppointmentType
Deprecation reason on field OnSiteJobsAppointmentType.externalJobType changed from None to
The 'externalJobType' field is deprecated.

Please use externalJobTypeMapping instead.

- Marked as deprecated on 2026-03-17.
- Scheduled for removal on or after 2026-04-17.
Enum value JPN_BILLING_PATTERN_CHANGED_DUE_TO_READING_DATE_CHANGE was removed from AccountReminderTypes enum
Deprecation reason on field Mutation.createAccountCredit changed from
The 'createAccountCredit' field is deprecated.

Use postCredit mutation as it is ledger aware.

- Marked as deprecated on 2022-07-04.
- Scheduled for removal on or after 2024-01-01.
to
The 'createAccountCredit' field is deprecated.

Use postCredit mutation as it is ledger aware.

- Marked as deprecated on 2022-07-04.
- Scheduled for removal on or after 2026-03-30.
Mutation.legacyProcessOrder type changed from ProcessOrderOutput! to LegacyProcessOrderOutput!

Type InternalCompanyType was added
Type SearchCriteriaInput was added
Field internalCompany was added to object type Query

Input Field contractIdentifiers: [String] was added to input type EnrollmentInput
Field contractIdentifiers was added to object type JoinSupplierProcessType

Type ATRType was added
Input Field subsectionType: SubsectionType was added to input type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput
Input Field reeCode: String was added to input type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput
ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.atrContractType type changed from SubsectionType! to ATRType!
Enum value TDVE61EMB was added to ElectricityATRChoices enum
Enum value TDVE62EMB was added to ElectricityATRChoices enum
Enum value TDVE30EMB was added to ElectricityATRChoices enum
Enum value TDVE62 was added to ElectricityATRChoices enum
Input Field reeCode: String was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput

Field a529Validation was removed from object type Query

Type PromotionAssignmentPeriodType was removed
Type PromotionAssignmentPeriodInput was removed
Input Field assignmentPeriod removed from input type PromotionAssignmentScheduleInput
Field assignmentPeriod was removed from object type PromotionAssignmentScheduleType

Type UpdateAgentAuxiliaryStatus was added
Type UpdateAgentAuxiliaryStatusInput was added
Field updateAgentAuxiliaryStatus was added to object type Mutation

Type RecordPendingPayment was added
Type RecordPendingPaymentInput was added
Type PaymentDetailsInput was added
Type CreateExternalMessage was added
Type ExternalMessageType was added
Type CreateExternalMessageInput was added
Type EmailContentInput was added
Field createExternalMessage was added to object type Mutation
Field recordPendingPayment was added to object type Mutation

Argument ledgerNumber: String added to PeriodBasedDocumentType.closingBalance
Argument ledgerNumber: String added to PeriodBasedDocumentType.openingBalance

Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from AccountReminderTypes enum

Type CloseInkConversation was added
Type CloseInkConversationInput was added
Type ConversationClosedReasonChoices was added
OnSiteJobsUpdateRequestInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
OnSiteJobsCreateAppointmentInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
OnSiteJobsUpdateAppointmentInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
CreateOnSiteJobsRequestInputType.supplyPointInternalIds type changed from [Int] to [Int!]
CreateOnSiteJobsRequestInputType.supplyPointIdentifierToMarketNameMapping type changed from [SupplyPointIdentifierToMarketNameMappingInput] to [SupplyPointIdentifierToMarketNameMappingInput!]
CreateOnSiteJobsRequestInputType.assets type changed from [OnSiteJobsAssetInput]! to [OnSiteJobsAssetInput!]!
Field closeInkConversation was added to object type Mutation

InkStorylineEntryInput.contentId type changed from Int to BigInt
InkStorylineEntry.contentId type changed from Int to BigInt

Field knowledgeArticleIds was added to object type InkStoryline
Field params was added to object type CommonAgreementType
Input Field knowledgeArticleIds: [Int!] was added to input type AddStorylineToInkConversationInput

Type DeletePropertyDescendants was added
Type DeletePropertyDescendantsInput was added
Field deletePropertyDescendants was added to object type Mutation

Type RemovePropertyFromHierarchy was added
Type RemovePropertyFromHierarchyInput was added
Field removePropertyFromHierarchy was added to object type Mutation

Type AddParentToProperty was added
Type AddParentToPropertyInput was added
Field addParentToProperty was added to object type Mutation

Field createdAt was added to object type OnSiteJobsAppointmentType
Field preferredStartDate was added to object type OnSiteJobsAppointmentType
Field deadlineDate was added to object type OnSiteJobsAppointmentType

Type ATRType was removed
Input Field reeCode removed from input type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput
Input Field subsectionType removed from input type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput
ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.atrContractType type changed from ATRType! to SubsectionType!
Input Field estimatedAnnualConsumption removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field reeCode removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field atrContractType removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field atrTariff removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field power removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field selfConsumptionType removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field cnae removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field subsectionType removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput

Input Field externalIdentifier: String was added to input type SimpleServicesEnrollmentMarketInput

Type ATRType was added
Input Field power: [Float]! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field estimatedAnnualConsumption: Int was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field selfConsumptionType: SelfConsumptionType! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field atrContractType: ATRType! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field atrTariff: ElectricityATRChoices! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field reeCode: String! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field cnae: String! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field subsectionType: SubsectionType! was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field reeCode: String! was added to input type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput
Input Field subsectionType: SubsectionType! was added to input type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput
ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.atrContractType type changed from SubsectionType! to ATRType!

Type RecordSuccessfulPayment was added
Type RecordSuccessfulPaymentInput was added
Type NoticePriority was added
Type SuccessfulPaymentDetailsInput was added
Type PaymentActionIntentOneOfInput was added
Type PaymentActionIntentOptionsInput was added
Type PaymentMethodInput was added
Field recordSuccessfulPayment was added to object type Mutation

Type SimpleServicesMarketDataSourceInput was added
Type SimpleServicesQuotedSupplyPointInput was added
Type SimpleServicesProductCatalogInput was added
Type SimpleServicesAgreementTransferInput was added
Input Field marketDataSource: SimpleServicesMarketDataSourceInput was added to input type SimpleServicesEnrollmentMarketInput
Input Field externalIdentifier removed from input type SimpleServicesEnrollmentMarketInput
Input Field quotedSupplyPointId removed from input type SimpleServicesEnrollmentMarketInput

Input Field bypassTerminalAppointmentStatus: Boolean was added to input type OnSiteJobsUpdateAppointmentInput
Input Field alignRequestStatusWithAppointment: Boolean was added to input type OnSiteJobsUpdateAppointmentInput

Type AddChildToProperty was added
Type AddChildToPropertyInput was added
Field addChildToProperty was added to object type Mutation

Deprecation reason on field Mutation.varyContractTerms changed from
The 'varyContractTerms' field is deprecated.

This is a legacy mutation. The instigateContractVariation should be used instead.

- Marked as deprecated on 2026-01-20.
- Scheduled for removal on or after 2026-02-27.
to None
Deprecation reason on field Mutation.instigateContractVariation changed from None to
The 'instigateContractVariation' field is deprecated.

This is a legacy mutation. The varyContractTerms should be used instead.

- Marked as deprecated on 2026-03-05.
- Scheduled for removal on or after 2026-04-11.