GraphQL API Changelog

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

Field latestOccupancyPeriods was added to object type PropertyType

Input Field orderSubmittedAt: DateTime was added to input type EnrollmentInput

Type UpdateBusiness was added
Type UpdateBusinessInput was added
Field updateBusiness was added to object type Mutation

Type CampaignAccountStatus was added
Argument status: CampaignAccountStatus added to Query.campaigns

Enum value AI_RESOLVED was added to ConversationClosedReasonChoices enum

Type ContractReferencesType was added
Field contractReferences was added to object type JoinSupplierProcessType
Field contractIdentifiers was removed from object type JoinSupplierProcessType

Type AccessorAccessConnectionTypeConnection was removed
Type AccessorAccessConnectionTypeEdge was removed
Type AccessorAccessType was removed
Type AccessorUnion was removed
Type PartnerUserAccessorAccessConnectionTypeConnection was added
Type PartnerUserAccessorAccessConnectionTypeEdge was added
Type PartnerUserAccessorAccessType was added
Field partnerUserAccessors was added to object type AffiliateOrganisationType
Field accessors was removed from object type AffiliateOrganisationType

Type PredictedBillSteppedTariffNotSupportedErrorType was added
Union member PredictedBillSteppedTariffNotSupportedErrorType was added to PredictedBillErrorUnion Union type

Type RecordInitiatedPayment was added
Type RecordInitiatedPaymentInput was added
Type InitiatedPaymentDetailsInput was added
Type PaymentUUIDOnlyActionIntentInput was added
Field recordInitiatedPayment was added to object type Mutation

Type ContractIdentifiersInput was removed
Type ContractReferencesInput was added
Input Field contractReferences: ContractReferencesInput was added to input type EnrollmentInput
Input Field contractIdentifiersInput removed from input type EnrollmentInput

Type AccessorAccessConnectionTypeConnection was added
Type AccessorAccessConnectionTypeEdge was added
Type AccessorAccessType was added
Type AccessorUnion was added
Field accessors was added to object type AffiliateOrganisationType

Input Field externalReference: NonEmptyString was added to input type OnSiteJobsUpdateAppointmentInput

Enum value INDUSTRY_EXCEPTION_UNSOLICITED_CHANGE_ENLR_OR_SPLR was added to AccountReminderTypes enum

Enum value INFOBIP was added to VoiceVendor enum

Enum value STRIPE_CONNECT_HD_NHH_VOICE was added to Vendor enum
Enum value STRIPE_CONNECT_HD_VOICE was added to Vendor enum

Type PartnerAccessType was added
Field accessiblePartner was added to object type PartnerViewerType

Field description was added to object type QuantityType

Field geographicalId was added to object type RichAddressType
Input Field geographicalId: String was added to input type BillingAddressDetailsInput
Input Field geographicalId: String was added to input type RichAddressInput
Field geographicalId was added to object type PropertyRichAddressType
Enum value ANDROID_FCM was added to NotifiableApplicationService enum
Enum value IOS_FCM was added to NotifiableApplicationService enum

Type CreateAccountManualHold was added
Type AccountManualHoldType was added
Type CreateAccountManualHoldInput was added
Field createAccountManualHold was added to object type Mutation

Field accessibleBusinesses was added to object type AffiliateOrganisationType

Deprecation reason on field ResetPasswordMutationPayload.clientMutationId changed from None to
The 'clientMutationId' field is deprecated.

This field is a relic of early Relay conventions and is no longer necessary.

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

Enum value GENESYS was added to VoiceVendor enum

Type SubjectRemovalInput was added
Type AmendContractSubjectOutput was added
Type AmendContractSubjectInput was added
Type SubjectAdditionInput was added
Type SubjectUpdateInput was added
Type CallerIdentificationRestrictionsInput was added
Input Field callerIdentificationRestrictions: CallerIdentificationRestrictionsInput was added to input type CreateInboundCallInput
Field amendContractSubject was added to object type Mutation

Field conversionSalesChannel was added to object type OpportunityOutput
Field creationSalesChannel was added to object type OpportunityOutput

Input Field alignRequestStatusWithAppointment: Boolean was added to input type OnSiteJobsCreateAppointmentInput

Field code was added to object type Collection

Type CreateContractGroupOutput was added
Type CreateContractGroupInput was added
Type ManagingPartyInput was added
Field createContractGroup was added to object type Mutation

Input Field reasonCode: RepaymentReason was added to input type RequestRepaymentInputType

Field roleCode was added to object type GrantUserAccessToBusiness
Field possibleErrors was removed from object type GrantUserAccessToBusiness
Field flowId was added to object type RegisterLeadFlowStatusEvent
Field possibleErrors was removed from object type RegisterLeadFlowStatusEvent
Field roleCode was added to object type RevokeUserAccessFromBusiness
Field possibleErrors was removed from object type RevokeUserAccessFromBusiness
Field roleCode was added to object type AddUserToPortfolio
Field possibleErrors was removed from object type AddUserToPortfolio
Field reminderId was added to object type CompleteReminder
Field possibleErrors was removed from object type CompleteReminder
Field flowId was added to object type RegisterOpportunityFlowStatusEvent
Field possibleErrors was removed from object type RegisterOpportunityFlowStatusEvent
Field accountNumber was added to object type StopAutomatedPayments
Field possibleErrors was removed from object type StopAutomatedPayments
Field supplyPointIdentifier was added to object type ChangeSupplierForSupplyPoint
Field possibleErrors was removed from object type ChangeSupplierForSupplyPoint
Field portfolioNumber was added to object type AddPortfolioReference
Field possibleErrors was removed from object type AddPortfolioReference
Field accountNumber was added to object type SetPaymentPreference
Field possibleErrors was removed from object type SetPaymentPreference

Type EntityAccessConnectionTypeConnection was added
Type EntityAccessConnectionTypeEdge was added
Type EntityAccessType was added
Type AccessibleEntityUnion was added
Type RoleAssignment was added
Type AccessScope was added
Type PaymentScheduleChangeEventType was added
Type PaymentScheduleChangeCategory was added
Field changeHistory was added to object type PaymentScheduleType
Field accessibleAccounts was added to object type AffiliateOrganisationType

Input Field postalAddress: RichAddressInput was added to input type AdHocRecipientInput

Type PredictedBillAgreementNotFoundErrorType was added
Type PredictedBillCannotEstimateConcessionsErrorType was added
Union member PredictedBillAgreementNotFoundErrorType was added to PredictedBillErrorUnion Union type
Union member PredictedBillCannotEstimateConcessionsErrorType was added to PredictedBillErrorUnion Union type

Type UserRole was added
Type RoleInterface was added
Type PartnerRole was added
Type PartnerUserRole was added
Type BusinessRole was added

Field hasAutocomplete was added to object type AddressFieldConfigType

Type InstalmentByMonthlyAmountScheduleType was added
Type InstalmentByTotalAmountScheduleType was added
Type InstalmentByMonthlyAmountScheduleInput was added
Type InstalmentPeriodEnum was added
Type InstalmentByTotalAmountScheduleInput was added
Input Field instalmentByTotalAmount: InstalmentByTotalAmountScheduleInput was added to input type PaymentScheduleDetailsInput
Input Field instalmentByMonthlyAmount: InstalmentByMonthlyAmountScheduleInput was added to input type PaymentScheduleDetailsInput
Field instalmentByTotalAmount was added to object type PaymentScheduleDataType
Field instalmentByMonthlyAmount was added to object type PaymentScheduleDataType

Input Field paymentUuid: String was added to input type PaymentActionIntentOneOfInput

Input Field externalProvider: String was added to input type DeletePushNotificationBindingInput

Enum value NZL_SERVICE_ORDER_INCOMPLETED was added to AccountReminderTypes enum

Field recordChargedBackPayment was added to object type Mutation
Type RecordChargedBackPayment was added
Type RecordChargedBackPaymentInput was added
Type ChargedBackPaymentDetailsInput was added
Field autocompleteAddressFieldOptions was added to object type Query
Enum value REFUND_ELIGIBILITY was added to StorylineAnalyzerTypeChoices enum

Enum value SWEB was added to OnSiteJobsAgent enum

Type PickTimeslotForOnSiteJobsAppointment was added
Field pickTimeslotForOnSiteJobsAppointment was added to object type Mutation

Enum value AED_FILS was removed from LineItemCurrency enum

Enum value UNCONFIRMED was added to OnSiteJobsAppointmentStatus enum

Type TriggerStandalonePaymentRequest was added
Type PaymentNotification was added
Type TriggerStandalonePaymentRequestInput was added
Type AdHocRecipientInput was added
Field triggerStandalonePaymentRequest was added to object type Mutation

Input Field replyToMessageRelayId: ID was added to input type SendInkOutboundMessageInput
Input Field useFullReplyThread: Boolean was added to input type SendInkOutboundMessageInput

Enum value PROPOSED_TARIFF_NOT_FOUND was added to ServiceOrderCompletionReason enum
Enum value UNABLE_TO_DETERMINE_EFFECTIVE_DATE was added to ServiceOrderCompletionReason enum
Enum value CURRENT_TARIFF_NOT_FOUND was added to ServiceOrderCompletionReason enum

Type GetMpbContact was added
Type GetMpbContactInput was added
Type UpdatePropertyAddress was added
Type UpdatePropertyAddressInput was added
Field updatePropertyAddress was added to object type Mutation
Field getMpbContact was added to object type Query

Type SendTrustpilotReviewInvitation was added
Type SendTrustpilotReviewInvitationInput was added
Field sendTrustpilotReviewInvitation was added to object type Mutation

Type ApplicableRateValidityPeriodType was added
Field isSalesTax was added to object type ApplicableRateType
Field unitDisplay was added to object type ApplicableRateType
Field category was added to object type ApplicableRateType
Field currency was added to object type ApplicableRateType
Field sourceSystem was added to object type ApplicableRateType
Field validityPeriod was added to object type ApplicableRateType
Field rates was added to object type SupplyProductType

Type StartOnSiteJobsTimeslotPickingSession was added
Field startOnSiteJobsTimeslotPickingSession was added to object type Mutation

Type EstimatedSupplyPointReadingType was added
Field estimatedSupplyPointReadings was added to object type Query

Type GetStandingDataForNmiQueryInput was added
Field getStandingDataForNmi was added to object type Query

Input Field externalProvider: String was added to input type RegisterPushNotificationBindingInput

Type CallConnectionTypeConnection was added
Type CallConnectionTypeEdge was added
Field calls was added to object type Query
Field tags of type [CallTagType]! was added to interface CallInterface
Field tags was added to object type OutboundCallType
Field tags was added to object type InboundCallType

Enum value STRIPE_CONNECT_HD_NHH was added to Vendor enum
Enum value STRIPE_CONNECT_HD was added to Vendor enum

Field characteristics was added to object type PriceForStream
Field schemes was added to object type PriceForStream
Deprecation reason on field PriceForStream.schemeLabels changed from None to
The 'schemeLabels' field is deprecated.

Please use 'schemes' instead.

- Marked as deprecated on 2026-07-17.
- Scheduled for removal on or after 2026-07-31.
Deprecation reason on field PriceForStream.characteristicMapping changed from None to
The 'characteristicMapping' field is deprecated.

Please use 'characteristics' instead.

- Marked as deprecated on 2026-07-17.
- Scheduled for removal on or after 2026-07-31.
Field characteristics was added to object type VariantProfile
Field schemes was added to object type VariantProfile
Deprecation reason on field VariantProfile.characteristicValues changed from None to
The 'characteristicValues' field is deprecated.

Please use 'characteristics' instead.

- Marked as deprecated on 2026-07-17.
- Scheduled for removal on or after 2026-07-31.
Deprecation reason on field VariantProfile.schemeLabels changed from None to
The 'schemeLabels' field is deprecated.

Please use 'schemes' instead.

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

Input Field contractIdentifiers removed from input type EnrollmentInput

Field waterSupplyPoints was added to object type PropertyType

Type LegacyQuotedProduct was added

Type LegacyQuotedProduct was removed

Type SendInkOutboundMessage was added
Type SendInkOutboundMessageInput was added
Type InkSendMessageInput was added
Field externalId was added to object type AccountUserType
Field sendInkOutboundMessage was added to object type Mutation

Type CreateFamilyIssuesSuppressedCommAccountEvent was added
Field createFamilyIssuesSuppressedCommAccountEvent was added to object type Mutation

Field termsAndConditions was added to object type SupplyProductType
Deprecation reason on field SupplyProductType.termsAndConditionsTypes changed from None to
The 'termsAndConditionsTypes' field is deprecated.

This field returned the incorrect terms and conditions. Please use 'termsAndConditions' instead.

- Marked as deprecated on 2026-07-14.
- Scheduled for removal on or after 2026-09-14.
Input Field externalReference: String was added to input type CreateOnSiteJobsRequestInputType

Enum value ESSENTIAL_WATER_FIELD was added to OnSiteJobsAgent enum

Enum value NO_ACTIVE_METER_DATA was added to ServiceOrderCompletionReason enum

Enum value ADDITIONAL_CREDIT was added to BandCategory enum
Enum value KVAR_DAYS was added to UnitType enum

Enum value ESSENTIAL_WATER_FIELD was removed from OnSiteJobsAgent enum

Enum value ESSENTIAL_WATER_FIELD was added to OnSiteJobsAgent enum

Type CreateStandingDataRegisterPendingUpdate was removed
Type CreateStandingDataRegisterPendingUpdateInput was removed
Type CreateStandingDataPendingUpdate was added
Type CreateStandingDataPendingUpdateInput was added
Field createStandingDataPendingUpdate was added to object type Mutation
Field createStandingDataRegisterPendingUpdate was removed from object type Mutation

Enum value DANKORT was added to CardPaymentNetwork enum
Enum value DANKORT was added to CardSchemeEnumType enum

Type StartGroupedCollectionProcess was added
Type StartGroupedCollectionProcessOutput was added
Type StartGroupedCollectionProcessInput was added
Field startGroupedCollectionProcess was added to object type Mutation

Type CreateOnSiteJobsAppointmentWithoutDateOrTime was added
Field createOnSiteJobsAppointmentWithoutDateOrTime was added to object type Mutation

Type SendLifeSupportNotification was added
Type SendLifeSupportNotificationInput was added
Field sendLifeSupportNotification was added to object type Mutation

Type LifeSupportRecordV2Type was added
Field getLifeSupportRecordsByNmi was added to object type Query

Enum value AGREEMENT was added to StorylineEntryTypes enum

Input Field nmi: String was added to input type ServiceOrderCompletionDetails

Type ApplicableRateConnection was added
Type ApplicableRateEdge was added
Type ApplicableRateType was added
Field agreementRates was added to object type Query

Enum value NZL_REGISTRY_REQUEST_SUPERSEDED was added to AccountReminderTypes enum

Enum value NZL_REGISTRY_REQUEST_REJECTED was added to AccountReminderTypes enum

CommonAgreementType.ratesAgreedAt type changed from DateTime to DateTime!

Type ImportTrancheRate was added
Type ImportTrancheRateInput was added
Type TrancheMarketName was added
Type TrancheRateUnit was added
Field importTrancheRate was added to object type Mutation

Enum value PENDING was added to ContractStatus enum

Type CreateCreditCardInstruction was removed
Type CreateCreditCardInstructionInput was removed
Field createCreditCardInstruction was removed from object type Mutation
Input Field reference: String was added to input type PaymentMethodInput

Type AccountCannotSelectProductErrorType was added
Union member AccountCannotSelectProductErrorType was added to GasProductSwitchingErrorUnion Union type
Union member AccountCannotSelectProductErrorType was added to ElectricityProductSwitchingErrorUnion Union type

Field triggerId was added to object type InkStoryline
Input Field triggerId: String was added to input type AddStorylineToInkConversationInput

Input Field validFrom removed from input type ActualizeContractInput
ActualizeContractInput.validFromDate type changed from IndustryMidnightAlignedDateField to IndustryMidnightAlignedDateField!
Input Field validTo removed from input type CreateContractInput
Input Field validFrom removed from input type CreateContractInput
Input Field signedAt removed from input type CreateContractInput
CreateContractInput.signedAtDate type changed from IndustryMidnightAlignedDateField to IndustryMidnightAlignedDateField!
CreateContractInput.validFromDate type changed from IndustryMidnightAlignedDateField to IndustryMidnightAlignedDateField!
Input Field validTo removed from input type TerminateContractInput
TerminateContractInput.validToDate type changed from IndustryMidnightAlignedDateField to IndustryMidnightAlignedDateField!
Input Field applicableAt removed from input type VaryContractTermsInput

Field taxNumber was added to object type CreateShellAccountPayload
Input Field taxNumber: String was added to input type CreateShellAccountInput

Type RefundVoucherInput was added
Type RefundVoucher was added
Field refundVoucher was added to object type Mutation

Type AgentAuxiliaryStatusType was added
Field agentAuxiliaryStatus was added to object type Query

Field callDirection was added to object type CallRecordingDetailType

Enum value EXPIRED was added to QuoteConfigurationStatus enum

Type ConsentOutput was added
Field consents was added to object type LeadContactDetailsType

Type InvalidLoyaltyCardNumberError was added
Union member InvalidLoyaltyCardNumberError was added to ElectricityProductSwitchingErrorUnion Union type
Union member InvalidLoyaltyCardNumberError was added to GasProductSwitchingErrorUnion Union type

Field identifier was added to object type CollectiveBillType

ProductDmoReferenceType.ntcCombination type changed from [String!]! to [String]!
Field planId was added to object type ElectricityPriceReferenceType
Field planId of type String was added to interface PriceReferenceInterface
Enum value WESTPAC_QUICKSTREAM_RED_ENERGY was added to Vendor enum
Enum value WESTPAC_QUICKSTREAM_LUMO_ENERGY was added to Vendor enum

Field isHeld was added to object type InvoiceType
Field isHeld was added to object type InvoiceBillingDocumentType
Field isHeld was added to object type PeriodBasedDocumentType
Argument supplyPointsToMarketNamesMapping: [SupplyPointIdentifierToMarketNameMappingInput] added to Query.getOnSiteJobsJobTypes
Argument supplyPointInternalIds: [Int] added to Query.getOnSiteJobsJobTypes
Removed argument requestId from Query.getOnSiteJobsJobTypes

Type ConsentOutput was removed
Field consents was removed from object type OpportunityOutput
Default value for input field EnrollmentInput.bankDetails changed from None to Undefined
Default value for input field EnrollmentInput.contractIdentifiersInput changed from None to Undefined
Default value for input field EnrollmentInput.instructionDetails changed from None to Undefined
Default value for input field EnrollmentInput.salesInfo changed from None to Undefined
Default value for input field EnrollmentInput.paymentSchedule changed from None to Undefined
Default value for input field EnrollmentInput.paymentSlipDetails changed from None to Undefined
Default value for input field EnrollmentInput.securityDeposit changed from None to Undefined
Field consents was removed from object type Lead
Default value for input field LegacyMarketDataInput.addressDetails changed from None to Undefined
Field consents was removed from object type LeadOutput

Type UpdateAccountBillingName was added
Type UpdateAccountBillingNameInput was added
Field updateAccountBillingName was added to object type Mutation

Input Field consents: [ConsentTypeInput] was added to input type LeadContactDetailsInput

Field estimatedControlledLoad2Cost was added to object type CostEstimation
Field estimatedControlledLoad2StandingCharge was added to object type CostEstimation
Field estimatedControlledLoad1Cost was added to object type CostEstimation
Field estimatedControlledLoad1StandingCharge was added to object type CostEstimation

Enum value WORK_REQUEST_COMPLETION was added to ServiceOrderCompletionReason enum
Enum value UNABLE_TO_DETERMINE_COMPLETION_CODES was added to ServiceOrderCompletionReason enum
Enum value UNSUPPORTED_JOB_TYPE was added to ServiceOrderCompletionReason enum

Enum value NO_MATCHING_REGISTERS was added to ServiceOrderCompletionReason enum
Field callId was added to object type CallRecordingDetailType

Type OrganisationReferenceType was added
Type ReplacePartnerReferences was added
Type ReplacePartnerReferencesInputType was added
Type OrganisationReferenceInput was added
Field possibleErrors was removed from object type TransferLedgerBalance
Field possibleErrors was removed from object type StartCustomerVerification
Field possibleErrors was removed from object type AssociateItemToCollectionProcess
Field possibleErrors was removed from object type UpsertPropertyHazardByExternalIdentifier
Field possibleErrors was removed from object type CreateAPIException
Field possibleErrors was removed from object type SendCustomerDetailsRequest
Field possibleErrors was removed from object type GetOrCreateAgreement
Field possibleErrors was removed from object type StartOnSiteJobsAppointmentBookingSessionForRequest
Field possibleErrors was removed from object type AcceptOfferForQuoting
Field possibleErrors was removed from object type RetireCustomerAsset
Field possibleErrors was removed from object type AssociateArchivedCallRecordingsWithCalls
Field possibleErrors was removed from object type UpdateElecMeterPointAccessDetails
Field possibleErrors was removed from object type UpdateSiteworksRequest
Field possibleErrors was removed from object type CreateAPIExceptionEvent
Field possibleErrors was removed from object type GeneratePreSignedToken
Field possibleErrors was removed from object type RegisterEmail
Field possibleErrors was removed from object type FetchPreSignedLinkForOpportunityAttachment
Field possibleErrors was removed from object type InvalidateRefreshTokensForUser
Field possibleErrors was removed from object type PurchaseVouchers
Field possibleErrors was removed from object type ValidateMfaDevice
Field possibleErrors was removed from object type CreateOfferGroupForQuoting
Field possibleErrors was removed from object type RecordDepositAgreementAccepted
Field possibleErrors was removed from object type AddItemsToRiskList
Field possibleErrors was removed from object type VerifyCustomer
Field possibleErrors was removed from object type WaterMeterType
Field possibleErrors was removed from object type PreviewAndCreatePaymentPlan
Field possibleErrors was removed from object type CreateInternalCompany
Field possibleErrors was removed from object type DeleteMfaDevice
Field possibleErrors was removed from object type CollectDeposit
Field possibleErrors was removed from object type RecordPendingPayment
Field possibleErrors was removed from object type UpdateAccountUserConsents
Field possibleErrors was removed from object type StartCollectionProcess
Field possibleErrors was removed from object type CreateBusiness
Field possibleErrors was removed from object type ChangeCentrepayDeduction
Field possibleErrors was removed from object type CreateOpportunityAndLead
Field possibleErrors was removed from object type InitiateProductSwitch
Field possibleErrors was removed from object type InvalidatePaymentInstruction
Field possibleErrors was removed from object type ReactivateCollectionProcessRecord
Field possibleErrors was removed from object type WithdrawDunning
Field possibleErrors was removed from object type UpdateHardshipAgreement
Field possibleErrors was removed from object type UpdateAffiliateOrganisation
Field possibleErrors was removed from object type CreateContributionAgreement
Field possibleErrors was removed from object type UpdateOfferGroupOnOpportunity
Field possibleErrors was removed from object type PauseDunning
Field possibleErrors was removed from object type CreateOnSiteJobsAppointment
Field possibleErrors was removed from object type BulkAwardLoyaltyPoints
Field possibleErrors was removed from object type CreateNewAgreementFromProductSwitchProcess
Field possibleErrors was removed from object type ShareGoodsQuote
Field possibleErrors was removed from object type PayoutReferralForAccount
Field possibleErrors was removed from object type CreatePaymentMethodActionIntent
Field possibleErrors was removed from object type AssignInkBucket
Field possibleErrors was removed from object type UpdateAccountConsents
Field possibleErrors was removed from object type SetStandingDataPendingUpdatesStatus
Field possibleErrors was removed from object type DeletePushNotificationBinding
Field possibleErrors was removed from object type VerifyEmail
Field possibleErrors was removed from object type UpdateAPIException
Field possibleErrors was removed from object type CancelServiceOrders
Field possibleErrors was removed from object type CreateAccountPaymentSchedule
Field possibleErrors was removed from object type UpdateMetadata
Field possibleErrors was removed from object type CreateAccountReminder
Field possibleErrors was removed from object type CancelCentrepayDeduction
Field possibleErrors was removed from object type InitiateHostedStandalonePayment
Field possibleErrors was removed from object type UpdateLeadDetails
Field possibleErrors was removed from object type UpdateExportPaymentMethod
Field possibleErrors was removed from object type CreateDepositAgreement
Field possibleErrors was removed from object type StartOnSiteJobsAppointmentBookingSession
Field possibleErrors was removed from object type UpdateAccountReferralStatus
Field possibleErrors was removed from object type MoveToBucket
Field possibleErrors was removed from object type RemoveItemsFromRiskList
Field possibleErrors was removed from object type CreateStandingDataRegisterPendingUpdate
Field possibleErrors was removed from object type TransferLeadOpportunities
Field possibleErrors was removed from object type UpdateMessageTags
Field possibleErrors was removed from object type ApproveRepayment
Field possibleErrors was removed from object type BlockRepaymentSubmission
Field possibleErrors was removed from object type GenerateLeadsFileAttachmentDownloadPreSignedUrl
Field possibleErrors was removed from object type InvalidatePreSignedTokensForUser
Field possibleErrors was removed from object type RequestDoubleOptIn
Field possibleErrors was removed from object type ResolveMeterDataIssue
Field possibleErrors was removed from object type UpdateCommsDeliveryPreference
Field possibleErrors was removed from object type CreateMarketGatewayInboundMessageFlow
Field possibleErrors was removed from object type AddParentToProperty
Field possibleErrors was removed from object type CreatePaymentActionIntent
Field possibleErrors was removed from object type ObtainLongLivedRefreshToken
Field possibleErrors was removed from object type UpdateOnSiteJobsAppointment
Field possibleErrors was removed from object type StartOnSiteJobsAppointmentReschedulingSession
Field possibleErrors was removed from object type TriggerElectricityHouseMoveOut
Field possibleErrors was removed from object type VerifyIdentity
Field possibleErrors was removed from object type QuarantineElectricitySelfMeterRead
Field possibleErrors was removed from object type RegisterCustomerAsset
Field possibleErrors was removed from object type CreateAccountReference
Field possibleErrors was removed from object type SendLifeSupportRequest
Field possibleErrors was removed from object type AddPropertyToHierarchy
Field possibleErrors was removed from object type UpdateOpportunityDetails
Field possibleErrors was removed from object type RedeemLoyaltyPointsForAccountCredit
Field possibleErrors was removed from object type AssessCollectionProcessRecordForPause
Field possibleErrors was removed from object type SendQuoteSummary
Field possibleErrors was removed from object type ConnectAiAgentToCall
Field possibleErrors was removed from object type CreateGoodsQuote
Field possibleErrors was removed from object type DeletePropertyDescendants
Field possibleErrors was removed from object type MarkPrintBatchAsProcessed
Field possibleErrors was removed from object type HasFamilyIssues
Field possibleErrors was removed from object type UpdateAutoTopUpAmount
Field possibleErrors was removed from object type AddSignupReferralOnAccount
Field possibleErrors was removed from object type CreatePortfolioUserRole
Field possibleErrors was removed from object type RedeemReferralClaimCode
Field possibleErrors was removed from object type InitiateStandalonePayment
Field possibleErrors was removed from object type CreateCentrepayDeduction
Field possibleErrors was removed from object type SendAgreementRescissionConfirmation
Field possibleErrors was removed from object type DetachSupplyPointFromEstimationGroup
Field possibleErrors was removed from object type RemoveCampaignItems
Field possibleErrors was removed from object type CreatePostEvents
Field possibleErrors was removed from object type GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
Field possibleErrors was removed from object type CloseInkLiveChatConversation
Field possibleErrors was removed from object type TransferLoyaltyPointsBetweenUsers
Field possibleErrors was removed from object type UpsertPropertyHazardTypeByExternalIdentifier
Field possibleErrors was removed from object type CreateMfaDevice
Field possibleErrors was removed from object type AddBusinessToSegmentMutation
Field possibleErrors was removed from object type UpdateAccountReference
Field possibleErrors was removed from object type AddChildToProperty
Field possibleErrors was removed from object type SwitchAccountToVariablePaymentSchedule
Field possibleErrors was removed from object type LinkAccountToBusiness
Field possibleErrors was removed from object type CloseOpenPrintBatch
Field possibleErrors was removed from object type CreateDistributedEnergyResource
Field possibleErrors was removed from object type UpdateLeadStage
Field possibleErrors was removed from object type AwardLoyaltyPoints
Field possibleErrors was removed from object type TriggerCollectionProcessMessage
Field possibleErrors was removed from object type UpdateAccountBillingAddress
Field possibleErrors was removed from object type RevokeAgreement
Field possibleErrors was removed from object type CreateAPIExceptionNote
Field possibleErrors was removed from object type ExtendAgreementPeriod
Field possibleErrors was removed from object type GetHostedUrlForNewPaymentInstruction
Field possibleErrors was removed from object type UpdateAccountRichAddressMutation
Field possibleErrors was removed from object type RevokePartnerUserAccess
Field possibleErrors was removed from object type UpdateAPIExceptionNote
Field possibleErrors was removed from object type ResumeCollectionProcess
Field possibleErrors was removed from object type CreateGoodsQuoteWithoutAccount
Field possibleErrors was removed from object type ReadingType
Field possibleErrors was removed from object type RecordFailedPayment
Field possibleErrors was removed from object type CreateAccountCharge
Field possibleErrors was removed from object type CancelOnSiteJobsAppointment
Field possibleErrors was removed from object type CreateOnSiteJobsAppointmentWithoutBooking
Field possibleErrors was removed from object type CreateRegisterNTCOverride
Field possibleErrors was removed from object type CompleteServiceOrder
Field possibleErrors was removed from object type UpdateAgreementRescission
Field possibleErrors was removed from object type CommenceDCAProceeding
Field possibleErrors was removed from object type SetLastConsumerChangeDateRecordToBeExpired
Field possibleErrors was removed from object type CreateScheduledTransactions
Field references was added to object type AffiliateOrganisationType
Field possibleErrors was removed from object type ScheduleQuoteFollowUp
Field possibleErrors was removed from object type StoreDirectDebitPaymentMethodDetails
Field possibleErrors was removed from object type CancelPayment
Field possibleErrors was removed from object type CloseDCAProceeding
Field possibleErrors was removed from object type BackendScreenEvent
Field possibleErrors was removed from object type UpdateActivePurchase
Field possibleErrors was removed from object type SendVerificationEmail
Field possibleErrors was removed from object type CreateOnSiteJobsRequest
Field possibleErrors was removed from object type AssignSupplyPointToEstimationGroup
Field possibleErrors was removed from object type UpdateAccountBillingEmail
Field possibleErrors was removed from object type CompleteStandalonePayment
Field possibleErrors was removed from object type JoinSupplierAcceptTermsAndConditions
Field possibleErrors was removed from object type CreatePartnerUser
Field possibleErrors was removed from object type CreateCustomerFeedback
Field possibleErrors was removed from object type CreateAPICall
Field possibleErrors was removed from object type GenerateInkPresignedUrl
Field possibleErrors was removed from object type SetLoyaltyPointsUser
Field possibleErrors was removed from object type EndContributionAgreement
Field possibleErrors was removed from object type TriggerVmdRequest
Field possibleErrors was removed from object type DeductLoyaltyPoints
Field possibleErrors was removed from object type UpsertPropertyHazardByExternalIdentifierAndNmi
Field possibleErrors was removed from object type CreateQuoteForAccount
Field possibleErrors was removed from object type SelectProducts
Field possibleErrors was removed from object type CreateCollectionProcessEvent
Field possibleErrors was removed from object type StorePaymentInstruction
Field possibleErrors was removed from object type DetermineDefaultTariff
Field possibleErrors was removed from object type CreateAffiliateLink
Field possibleErrors was removed from object type CreateLead
Field possibleErrors was removed from object type CreateExternalMessageEvent
Field possibleErrors was removed from object type UpdateRegisterNTCOverride
Field possibleErrors was removed from object type UpdateAgreementPeriod
Field possibleErrors was removed from object type DeleteAccountReference
Field possibleErrors was removed from object type CreateExternalMessage
Field possibleErrors was removed from object type CreateAudioRecording
Field possibleErrors was removed from object type AssociateCallWithAccount
Field possibleErrors was removed from object type CreateExternalAccountUserEvent
Field possibleErrors was removed from object type UpdateCampaignAccountExpiryDate
Field possibleErrors was removed from object type AddProperty
Field possibleErrors was removed from object type GenerateLeadsFileAttachmentsPreSignedUrl
Field possibleErrors was removed from object type RecordSuccessfulPayment
Field possibleErrors was removed from object type CreateAgreement
Field possibleErrors was removed from object type TriggerC4Request
Field possibleErrors was removed from object type UpdateNotesOnOpportunity
Field possibleErrors was removed from object type UpdateOpportunityExtraDetails
Field possibleErrors was removed from object type AcceptGoodsQuote
Field possibleErrors was removed from object type RecordActivatedPaymentMethod
Field possibleErrors was removed from object type CreateCreditTransferPermission
Field possibleErrors was removed from object type UpdateAgreementRollover
Field possibleErrors was removed from object type PauseCollectionProcess
Field possibleErrors was removed from object type CreateInkLiveChatMessage
Field possibleErrors was removed from object type SubmitAllowedRepayment
Field possibleErrors was removed from object type StoreBankDetailsForLead
Field possibleErrors was removed from object type AmendPayment
Field possibleErrors was removed from object type CreateHardshipAgreement
Field possibleErrors was removed from object type AddPartnerUserToTeam
Field possibleErrors was removed from object type CollectPayment
Field possibleErrors was removed from object type CreateAffiliateOrganisation
Field possibleErrors was removed from object type CompleteApproval
Field possibleErrors was removed from object type TriggerPmdRequest
Field possibleErrors was removed from object type UpdateOnSiteJobsRequest
Field possibleErrors was removed from object type UpdateCollectionProcessRecordLatestStep
Field possibleErrors was removed from object type SendCDRNotification
Field possibleErrors was removed from object type SetUpDirectDebitInstructionFromStoredDetails
Field possibleErrors was removed from object type RefundPayment
Field possibleErrors was removed from object type CreateMeterDataIssueFlow
Field possibleErrors was removed from object type GenerateAffiliatesAudioRecordingPreSignedUrl
Field possibleErrors was removed from object type UpdateAffiliateLink
Field possibleErrors was removed from object type SetOpportunityOutcome
Field possibleErrors was removed from object type AddStorylineToInkConversation
Field possibleErrors was removed from object type RecordInvalidatedPaymentMethod
Field replacePartnerReferences was added to object type Mutation
Field possibleErrors was removed from object type AddNoteToInkConversation
Field possibleErrors was removed from object type CreateOpportunityForLead
Field possibleErrors was removed from object type UpdateCollectionProcessRecordToActive
Field possibleErrors was removed from object type CreateComplaint
Field possibleErrors was removed from object type SubmitRepaymentRequest
Field possibleErrors was removed from object type UpdateCollectionProcessRecordToComplete
Field possibleErrors was removed from object type SubmitMeterReadings
Field possibleErrors was removed from object type CreateDirectDebitInstruction
Field possibleErrors was removed from object type AllowRepaymentSubmission
Field possibleErrors was removed from object type RequestPrintedBill
Field possibleErrors was removed from object type CreateCampaignItems
Field possibleErrors was removed from object type CreateOpportunityFileAttachment
Field possibleErrors was removed from object type TariffChangeAutoDeterminationAndAssignment
Field possibleErrors was removed from object type CreatePortfolio
Field possibleErrors was removed from object type InvalidateRefreshToken
Field possibleErrors was removed from object type UpdateOpportunityAssignment
Field possibleErrors was removed from object type NextOperationsTeamRoundRobin
Field possibleErrors was removed from object type UnenrollAccountFromLoyaltyProgram
Field possibleErrors was removed from object type CreateInboundCall
Field possibleErrors was removed from object type SendChangeNMIDetailsRequest
Field possibleErrors was removed from object type SendSiteAccessNotification
Field possibleErrors was removed from object type UpdateOptionsLanguagePreference
Field possibleErrors was removed from object type UpdateOpportunityStage
Field possibleErrors was removed from object type CreateReferral
Field possibleErrors was removed from object type RemoveBankDetailsForLead
Field possibleErrors was removed from object type RemovePartnerUserFromTeam
Field possibleErrors was removed from object type ValidateAddress
Field possibleErrors was removed from object type ServiceOrderCoincidenceCheck
Field possibleErrors was removed from object type UpdatePassword
Field possibleErrors was removed from object type CreateOnSiteJobsAppointmentWithDate
Field possibleErrors was removed from object type InvalidatePreSignedToken
Field possibleErrors was removed from object type UpdateAgentAuxiliaryStatus
Field possibleErrors was removed from object type SetUpDirectDebitInstructionForBusiness
Field possibleErrors was removed from object type ManualReviewMeterDataIssue
Field possibleErrors was removed from object type RequestCADReport
Field possibleErrors was removed from object type ConfirmDoubleOptIn
Field possibleErrors was removed from object type PublishMeterDataIssueEmail
Field possibleErrors was removed from object type CreateCallMetadata
Field possibleErrors was removed from object type PublishTransactionalMessagingExternalTrigger
Field possibleErrors was removed from object type UpdateUserRichAddressMutation
Field possibleErrors was removed from object type EndMeterDataIssueFlow
Field possibleErrors was removed from object type CloseInkConversation
Field possibleErrors was removed from object type CreateGoodsPurchase
Field possibleErrors was removed from object type EscalateInkConversation
Field possibleErrors was removed from object type EnrollAccountInLoyaltyProgram
Field possibleErrors was removed from object type AddUserToAccount
Field possibleErrors was removed from object type UpdateDocumentAccessibilityPreference
Field possibleErrors was removed from object type UpdateDCAProceeding
Field possibleErrors was removed from object type FetchGeneratePaymentFingerprint
Field possibleErrors was removed from object type RunAgreementRollover
Field possibleErrors was removed from object type CreateMetadata
Field possibleErrors was removed from object type CreateOrUpdateLoyaltyCardMutation
Field possibleErrors was removed from object type CancelRepaymentRequest
Field possibleErrors was removed from object type TerminateCreditTransferPermission
Field possibleErrors was removed from object type SendOfferQuoteSummary
Field possibleErrors was removed from object type EndMarketGatewayInboundMessageFlow
Field possibleErrors was removed from object type GetEmbeddedSecretForNewPaymentInstruction
Field possibleErrors was removed from object type RemovePropertyFromHierarchy

Field usageReference was removed from object type QuotedProductType
Field usageReference was added to object type LegacyQuotedProduct
Field usageReference was added to object type MarketSupplyQuotedProductAsLegacyQuotedProduct
Field usageReference of type UsageReferenceInterface was added to interface QuotedProduct

Field usageReference was added to object type QuotedProductType

CreateElectricityQuoteInput.brand type changed from ID to String

Field hasControlledLoad of type Boolean was added to interface PriceReferenceInterface
Field hasControlledLoad was added to object type ElectricityPriceReferenceType

Enum value UPDATE_STANDING_DATA was added to ServiceOrderTypeChoices enum

Deprecation reason on field Query.defaultPaymentInstruction changed from
The 'defaultPaymentInstruction' field is deprecated.

Please use 'usablePaymentInstructions' on the Ledger type
to
get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.

- Marked as deprecated on 2026-01-28.
- Scheduled for removal on or after 2026-07-28. to The 'defaultPaymentInstruction' field is deprecated.

Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.

- Marked as deprecated on 2026-01-28.
- Scheduled for removal on or after 2027-01-28.

Field contacts was added to object type LeadOutput
Deprecation reason on field LeadOutput.billingName changed from None to
The 'billingName' field is deprecated.

Please use 'givenName' and 'familyName' on the lead contact with the ACCOUNT_HOLDER role instead.

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

Please use 'contactAddress' on the lead contact with the ACCOUNT_HOLDER role instead.

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

Please use 'contactAddress' on the lead contact with the ACCOUNT_HOLDER role instead.

- Marked as deprecated on 2026-06-18.
- Scheduled for removal on or after 2026-09-18.
Input Field contactAddress: RichAddressInput was added to input type LeadContactDetailsInput
CreateOpportunityAndLeadInput.address type changed from RichAddressInput! to RichAddressInput
Field contactAddress was added to object type LeadContactDetailsType

Deprecation reason on field PaymentScheduleType.scheduleType changed from
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.
to None

Field fullContentPlainText was added to object type InkEmail
Field fullContentHtml was added to object type InkEmail

Argument includeInvoices: Boolean added to AccountType.bills
Argument includeInvoices: Boolean added to AccountInterface.bills

Enum value OCR was added to AccountPaymentTransactionTypeChoices enum

AffiliateOrganisationType.number type changed from String to String!

Field tariffType of type String was added to interface PriceReferenceInterface
Field tariffType was added to object type ElectricityPriceReferenceType

Input Field touName: String was added to input type ForecastConsumptionEntryInput
Input Field touSchemeCode removed from input type ForecastConsumptionEntryInput
Field touName was added to object type ForecastConsumptionEntryType
Field touSchemeCode was removed from object type ForecastConsumptionEntryType

Argument idempotencyKey: String added to Mutation.purchaseVouchers
Argument idempotencyKey: String added to Mutation.purchaseVoucher

Enum value CONTROLLED_LOAD_TARIFF_EXT was added to ServiceOrderCompletionReason enum

Type RecordInvalidatedPaymentMethod was added
Type RecordInvalidatedPaymentMethodInput was added
Type InvalidationReason was added
Field recordInvalidatedPaymentMethod was added to object type Mutation

Type CallRecordingDetailEventType was added
Field events was added to object type CallRecordingDetailType

Type RemovePartnerUserFromTeam was added
Type RemovePartnerUserFromTeamInput was added
Field removePartnerUserFromTeam was added to object type Mutation

Enum value DATE was added to ExtraDetailFieldType enum
Field specificationIdentifier was added to object type CatalogProductType

Type TariffChangeAutoDeterminationAndAssignmentResult was added
Type ServiceOrderCompletionReason was added
Type TariffChangeAppliedType was added
Field autoDeterminationAndAssignmentResult was added to object type TariffChangeAutoDeterminationAndAssignment
Argument dryRun: Boolean added to Mutation.tariffChangeAutoDeterminationAndAssignment

Enum value LIGHT was added to OnSiteJobsAssetKind enum
Enum value POLE was added to OnSiteJobsAssetKind enum

Field surchargeAmount was removed from object type Query

Input Field idempotencyKey: String was added to input type UpdateLeaveSupplierInput
Input Field idempotencyKey: String was added to input type EnrollmentInput
Input Field idempotencyKey: String was added to input type LeaveSupplierInput

Input Field workScheduleIdentifier: String was added to input type ConnectAiAgentToCallInput

Enum value BOOLEAN was added to ExtraDetailFieldType enum
Input Field status removed from input type UpdateQuoteConfigurationInput
Field quoteConfigurationsByOpportunityNumber was added to object type Query

Input Field nationalId: String was added to input type LeadContactDetailsInput

Type SubmitAllowedRepayment was added
Field submitAllowedRepayment was added to object type Mutation

Enum value ACCOUNT_HOLDER was added to LeadContactRoles enum
Enum value ACCOUNT_REPRESENTATIVE_WITH_AUTHORIZATION was added to LeadContactRoles enum
Enum value ACCOUNT_REPRESENTATIVE was added to LeadContactRoles enum

Field dueDate was added to object type StatementBillingDocumentType
Field scheduledPaymentDate was added to object type StatementBillingDocumentType
Deprecation reason on field StatementBillingDocumentType.paymentDueDate changed from None to
The 'paymentDueDate' field is deprecated.

This field name is ambiguous and inconsistently populated. Use paymentDate for the date on which payment will be collected. Use dueDate for the last date any payment can be made before the bill is considered overdue.

- Marked as deprecated on 2026-06-15.
- Scheduled for removal on or after 2027-08-15.
Field dueDate was added to object type InvoiceBillingDocumentType
Field scheduledPaymentDate was added to object type InvoiceBillingDocumentType
Deprecation reason on field InvoiceBillingDocumentType.paymentDueDate changed from None to
The 'paymentDueDate' field is deprecated.

This field name is ambiguous and inconsistently populated. Use paymentDate for the date on which payment will be collected. Use dueDate for the last date any payment can be made before the bill is considered overdue.

- Marked as deprecated on 2026-06-15.
- Scheduled for removal on or after 2027-08-15.

Field partnerUserRoles was added to object type Query

Enum value COMMS8 was added to MeterInstallationTypeCodeType enum

Type PartnerUserRoleType was added
Field roles was added to object type PartnerUserType

Default value for input field OnSiteJobsAssetInput.fuelType changed from None to Undefined
Default value for input field OnSiteJobsUpdateRequestInput.status changed from None to Undefined

Type RemoveBankDetailsForLead was added
Type RemoveBankDetailsForLeadInput was added
Field removeBankDetailsForLead was added to object type Mutation

Type QuoteRateGroupEligibilityConfigurationType was added
Type QuoteRateGroupEligibilityScheduleType was added
Type QuoteRateGroupEligibilityPeriodType was added
Type QuoteTimeSeriesSpecificationEligibilityScheduleType was added

Enum value requested_payment was added to PaymentActionIntentTargetType enum

Type RevokePartnerUserAccess was added
Type RevokePartnerUserAccessType was added
Type RevokePartnerUserAccessInput was added
Enum value MANAGE_LCT_ORDERS was added to PreSignedTokenScope enum
Field revokePartnerUserAccess was added to object type Mutation
Enum value MANAGE_LCT_ORDERS was added to ExpiringTokenScope enum
Input Field goal: String was added to input type ConnectAiAgentToCallInput

Input Field appointmentOn: Date was added to input type OnSiteJobsUpdateAppointmentInput

Type CallRecordingDetailType was added
Field callRecordingDetail was added to object type Query

Field isRegulated of type Boolean! was added to interface PriceReferenceInterface
Field isRegulated was added to object type ElectricityPriceReferenceType

Type PartnerTeamType was added
Type PartnerTeamUserConnectionTypeConnection was added
Type PartnerTeamUserConnectionTypeEdge was added
Type PartnerTeamInput was added
Field partnerTeam was added to object type Query

Type InboundCallAverageWaitTimeForAttributesType was added
Field inboundCallAverageWaitTimeForAttributes was added to object type Query

Enum value COMMISSION_METER was added to ServiceOrderSubTypeChoices enum

Type AddPartnerUserToTeam was added
Type AddPartnerUserToTeamInput was added
Field addPartnerUserToTeam was added to object type Mutation

Type SetQuoteConfigurationRatesRequestErrorsOutput was added
Type SetQuoteConfigurationRatesRequestErrorsInput was added
Type RateRequestedErrorInput was added
Type RateRequestedErrorType was added
Input Field quoteConfigurationRatesRequestIdentifier: UUID was added to input type UpdateQuoteConfigurationInput
Field setQuoteConfigurationRatesRequestErrors was added to object type Mutation

Type CreatePartnerUser was added
Type CreatePartnerUserInput was added
Field createPartnerUser was added to object type Mutation

Type ContractIdentifiersInput was added
Input Field contractIdentifiersInput: ContractIdentifiersInput was added to input type EnrollmentInput

Default value for input field CreatePortfolioInput.brandCode changed from 'ESSENTIAL_ENERGY' to Undefined

Type EnergyMixDataType was removed
Field energyMixData was removed from object type Query

Type CallTranscriptConnectionTypeConnection was added
Type CallTranscriptConnectionTypeEdge was added
Type CallTranscriptType was added
Type CallTranscriptionStatus was added
Type CallTranscriptDownloadType was added
Type CallTranscriptionType was added
Field callTranscriptsInWindow was added to object type Query
Field callTranscripts was added to object type Query

Field preferredLanguage was added to object type LeadContactDetailsType
Input Field preferredLanguage: String was added to input type LeadContactDetailsInput

Deprecation reason on field Refund.amount changed from
The 'amount' field is deprecated.

Use amounts instead for a breakdown of the relevant net, tax, and gross amounts.

- Marked as deprecated on 2023-12-06.
- Scheduled for removal on or after 2024-06-01.
to None
Deprecation reason on field Credit.amount changed from
The 'amount' field is deprecated.

Use amounts instead for a breakdown of the relevant net, tax, and gross amounts.

- Marked as deprecated on 2023-12-06.
- Scheduled for removal on or after 2024-06-01.
to None
Deprecation reason on field TransactionType.amount changed from
The 'amount' field is deprecated.

Use amounts instead for a breakdown of the relevant net, tax, and gross amounts.

- Marked as deprecated on 2023-12-06.
- Scheduled for removal on or after 2024-06-01.
to None
Deprecation reason on field Payment.amount changed from
The 'amount' field is deprecated.

Use amounts instead for a breakdown of the relevant net, tax, and gross amounts.

- Marked as deprecated on 2023-12-06.
- Scheduled for removal on or after 2024-06-01.
to None
Deprecation reason on field Charge.amount changed from
The 'amount' field is deprecated.

Use amounts instead for a breakdown of the relevant net, tax, and gross amounts.

- Marked as deprecated on 2023-12-06.
- Scheduled for removal on or after 2024-06-01.
to None

Enum value PAYMENT_PLAN_MISSED_INSTALMENT was removed from AccountReminderTypes enum

Field touSchemeCode was removed from object type ConsumptionSplitType
Input Field touSchemeCode: String was added to input type ForecastConsumptionEntryInput
Field touSchemeCode was added to object type ForecastConsumptionEntryType
Input Field touSchemeCode removed from input type ConsumptionSplitInput

Deprecation reason on field AccountPaymentType.id changed from
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.
to
The 'id' field is deprecated.

Please use uuid instead.

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

Type StoreBankDetailsForLead was added
Type StoreBankDetailsForLeadInput was added
Field storeBankDetailsForLead was added to object type Mutation

CreatePaymentMethodActionIntentInput.targetType type changed from PaymentActionIntentTargetType! to PaymentMethodActionIntentTargetType!

Enum value KVA_KM_DAYS was added to UnitType enum

Enum value cubicMetres was added to ConsumptionUnit enum

Enum value DISTANCE was added to UnitType enum
Enum value DISTANCE_CHARGE was added to BandCategory enum

Input Field storedPaymentMethodDetailsReference: String was added to input type EnrollmentInput

Field type was added to object type QuoteBespokeRateConfigurationType
Field type of type NonEmptyString was added to interface QuoteTermInterface
Field type was added to object type QuoteBillDueDateConfigurationType
Field type was added to object type QuoteContractedVolumeConfigurationType

Enum value UNABLE_TO_COMMISSION_METER was added to ServiceOrderResponseCode enum
Enum value DEVICE_NOT_SUPPORTED was added to ServiceOrderResponseCode enum
Enum value SERVICE_NOT_SUPPORTED was added to ServiceOrderResponseCode enum
Enum value MSATS_EXCEPTION was added to ServiceOrderResponseCode enum

Type OnSiteJobsRequestBookingDetailsInput was added
Type StartOnSiteJobsAppointmentBookingSession was added
Field startOnSiteJobsAppointmentBookingSession was added to object type Mutation

Type TimeOfUseSchemeType was added
Type TimeSlotWithActivationRuleType was added
Type SeasonType was added
Field timeSlot was added to object type ConsumptionSplitType
Field touSchemeCode was added to object type ConsumptionSplitType
Field touScheme was removed from object type ConsumptionSplitType
Input Field timeSlot: String! was added to input type ConsumptionSplitInput
Input Field touSchemeCode: String! was added to input type ConsumptionSplitInput
Input Field touScheme removed from input type ConsumptionSplitInput
Field rateGroupTouScheme was added to object type Query

Field paymentUuid was added to object type AccountRepaymentType

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

Enum value Smc was added to ConsumptionUnit enum
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.fieldValue type changed from String to String!
ExtraDetailInput.fieldType type changed from String to ExtraDetailFieldType!

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 SupplyPointType was removed
Type CommonSupplyPointInterface was removed
Type HasReadings was removed
Type Units was removed
Type DevicesConnection was removed
Type DevicesEdge was removed
Type Device was removed
Type RegistersConnection was removed
Type RegistersEdge was removed
Type DeviceRegister was removed
Type WaterSupplyPointType was added
Field externalIdentifier of type String was added to interface SupplyPointInterface
MarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointType to SupplyPointInterface
Field externalIdentifier was added to object type ElectricitySupplyPointType
CommonAgreementType.supplyPoint type changed from SupplyPointType! to SupplyPointInterface!
Field externalIdentifier was added to object type GasSupplyPointType
Query.supplyPoint type changed from SupplyPointType to SupplyPointInterface
SupplyPointConnectionTypeEdge.node type changed from SupplyPointType to SupplyPointInterface

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.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.
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.

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

Enum value RATES_REQUEST_FAILED was added to QuoteConfigurationStatus enum

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

Type StartOnSiteJobsAppointmentBookingSession was removed
Type StartOnSiteJobsAppointmentBookingSessionForRequest was added
Field startOnSiteJobsAppointmentBookingSessionForRequest was added to object type Mutation
Field startOnSiteJobsAppointmentBookingSession was removed from object type Mutation

Type WaterSupplyPointType was removed
Type SupplyPointType was added
Type CommonSupplyPointInterface was added
Type HasReadings was added
Type Units was added
Type DevicesConnection was added
Type DevicesEdge was added
Type Device was added
Type RegistersConnection was added
Type RegistersEdge was added
Type DeviceRegister was added
CommonAgreementType.supplyPoint type changed from SupplyPointInterface! to SupplyPointType!
SupplyPointConnectionTypeEdge.node type changed from SupplyPointInterface to SupplyPointType
Query.supplyPoint type changed from SupplyPointInterface to SupplyPointType
MarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointInterface to SupplyPointType

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

Type SupplyPointType was removed
Type CommonSupplyPointInterface was removed
Type HasReadings was removed
Type Units was removed
Type DevicesConnection was removed
Type DevicesEdge was removed
Type Device was removed
Type RegistersConnection was removed
Type RegistersEdge was removed
Type DeviceRegister was removed
Type WaterSupplyPointType was added
CommonAgreementType.supplyPoint type changed from SupplyPointType! to SupplyPointInterface!
SupplyPointConnectionTypeEdge.node type changed from SupplyPointType to SupplyPointInterface
MarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointType to SupplyPointInterface
Query.supplyPoint type changed from SupplyPointType to SupplyPointInterface

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 REJECTED was added to QuoteConfigurationStatus enum
Enum value READY was added to QuoteConfigurationStatus enum
Enum value ACCEPTED was added to QuoteConfigurationStatus enum
Enum value SENT was added to QuoteConfigurationStatus enum
Enum value FINALISED was removed from QuoteConfigurationStatus enum

Default value for input field CancelOnSiteJobsAppointmentInputType.alignRequestStatus changed from False to True

Type UpdateLeadAssignment was removed
Type UpdateLeadAssignmentInput was removed
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.
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.
Field updateLeadAssignment was removed from object type Mutation

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

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 detachAgreementsFromContracts was added to object type Mutation
Field attachAgreementsToContracts 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 ADDITIONAL_CHARGE was added to BandCategory 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.

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 DistributionAgreementType
Field ratesAgreedAt was added to object type SimpleServicesAgreementType
Field ratesAgreedAt was added to object type GasAgreementType
Field ratesAgreedAt of type DateTime was added to interface AusAgreementInterface
Field ratesAgreedAt was added to object type CommonAgreementType
Field ratesAgreedAt was added to object type ElectricityAgreementType

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 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

RateInterface.rateIncludingTax type changed from Float! to Float
RateInterface.rateExcludingTax type changed from Float! to Float
ProductRateType.rateIncludingTax type changed from Float! to Float
ProductRateType.rateExcludingTax type changed from Float! to Float
GasRateType.rateIncludingTax type changed from Float! to Float
GasRateType.rateExcludingTax type changed from Float! to Float
ElectricityRateType.rateIncludingTax type changed from Float! to Float
ElectricityRateType.rateExcludingTax type changed from Float! to Float

Field ptjNumber was removed from object type NotifiedPartyTransactionType

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

OnSiteJobsCreateAppointmentInput.jobType type changed from String! to NonEmptyString!

Enum value PREMISES_NETWORK_SERVICE_PROVIDER was added to C4RequestRoleType enum

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

Deprecation reason on field NotifiedPartyTransactionType.ptjNumber changed from None to
The 'ptjNumber' field is deprecated.

This field is always null. There are no scenarios where a PTJ (internal job) is linked to a notified party transaction.

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

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.

Field estimateMeterReadings was added to object type Query

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

Type AccountUserDetailInput was added

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

Type DistributedEnergyResourceType was added
Field distributedEnergyResources was added to object type MeterPointType

Type TariffChangeAutoDeterminationAndAssignment was added
Type TariffChangeAutoDeterminationAndAssignmentOutcome was added
Field tariffChangeAutoDeterminationAndAssignment was added to object type Mutation

Enum value SAR_HALALAS was added to LineItemCurrency 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

Enum value REQUIRES_TIMESLOT was added to OnSiteJobsAppointmentStatus enum

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

ElectricityRegisterType.status type changed from RegisterStatus! to RegisterStatus

Input Field assignedToTeamIdentifier: String was added to input type CreateLeadInput
Input Field assignedToUserIdentifier: String was added to input type CreateLeadInput
Input Field assignedToTeamIdentifier: String was added to input type OpportunitiesQueryInput
Input Field assignedToUserIdentifier: String was added to input type OpportunitiesQueryInput
Field assignedToTeamIdentifier was added to object type OpportunityOutput
Field assignedToUserIdentifier was added to object type OpportunityOutput
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.
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.
Field assignedToTeamIdentifier was added to object type Lead
Field assignedToUserIdentifier 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 assignedToTeamIdentifier: String was added to input type LeadsQueryInput
Input Field assignedToUserIdentifier: String was added to input type LeadsQueryInput
Input Field assignedToTeamIdentifier: String was added to input type CreateOpportunityForLeadInput
Input Field assignedToUserIdentifier: String was added to input type CreateOpportunityForLeadInput
Input Field assignedToTeamIdentifier: String was added to input type UpdateOpportunityAssignmentInput
Input Field assignedToUserIdentifier: String was added to input type UpdateOpportunityAssignmentInput
Input Field assignedToTeamIdentifier: String was added to input type UpdateLeadAssignmentInput
Input Field assignedToUserIdentifier: String was added to input type UpdateLeadAssignmentInput
Input Field assignedToTeamIdentifier: String was added to input type CreateOpportunityAndLeadInput
Input Field assignedToUserIdentifier: String was added to input type CreateOpportunityAndLeadInput
Field assignedToTeamIdentifier was added to object type LeadOutput
Field assignedToUserIdentifier was added to object type LeadOutput
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.
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.
Input Field assignedToTeamIdentifier: String was added to input type UpdateLeadDetailsInput
Input Field assignedToUserIdentifier: String was added to input type UpdateLeadDetailsInput

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

Enum value CANCELLED_BY_SUPPLIER was added to OnSiteJobsAppointmentCancellationCategory enum

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
Input Field validToDate: IndustryMidnightAlignedDateField was added to input type CreateContractInput
Input Field signedAtDate: LocaltimeMidnightAlignedDateField was added to input type CreateContractInput
Input Field validFromDate: IndustryMidnightAlignedDateField was added to input type CreateContractInput
CreateContractInput.signedAt type changed from DateTime! to DateTime
CreateContractInput.validFrom type changed from DateTime! to DateTime
Enum value METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_ACCEPTED was removed from AccountReminderTypes enum

Type IndustryMidnightAlignedDateField was added
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
Input Field validFromDate: IndustryMidnightAlignedDateField was added to input type ActualizeContractInput
ActualizeContractInput.validFrom 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 LeadType was added
Type PurchaseVouchers was added
Field purchaseVouchers was added to object type Mutation
Field lead was added to object type PaymentInstructionOwnerType

Field cancelledAt was added to object type OnSiteJobsAppointmentType

Type ServiceOrderResponseStatus was removed
ServiceOrderCompletionDetails.closureCode type changed from ServiceOrderResponseStatus! to ServiceOrderStatus!

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

This mutation only applies
to
clients using the legacy finanicals system. Use collectPayment instead.

- Marked as deprecated on 2025-05-26.
- Scheduled for removal on or after 2026-05-26. to The 'makePaymentWithSavedCard' field is deprecated.

This mutation only applies to clients using the legacy finanicals system. Use collectPayment instead.

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

Field textRegex was added to object type FunnelField

Enum value CANCELLED_BY_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum

Enum value INVALID was added to LifecycleSupplyPointProcessStatus enum

Field fieldValue was added to object type QuoteConfigurationExtraDetailItemType
Field fieldType was added to object type QuoteConfigurationExtraDetailItemType
Field fieldCode was added to object type QuoteConfigurationExtraDetailItemType
Field value was removed from object type QuoteConfigurationExtraDetailItemType
Field code was removed from object type QuoteConfigurationExtraDetailItemType
Field valueType 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

Default value for input field OnSiteJobsUpdateAppointmentInput.status changed from None to Undefined
Default value for input field OnSiteJobsUpdateAppointmentInput.commsStrategy changed from None to Undefined
Default value for input field OnSiteJobsUpdateAppointmentInput.jobDetails changed from None to Undefined
Default value for input field OnSiteJobsUpdateAppointmentInput.cancellationCategory changed from None to Undefined
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

Field inkLiveChatConversations was added to object type Query
Field isWorkRequiredForServiceOrder was added to object type Query
Enum value ACCURACY_TEST was removed from OnSiteJobsWorkCategory enum
Field stepName was removed from object type AgreementRescissionType
Type ProductType was removed
Type PublishApprovalApprovedEvent was removed
Type PublishApprovalApprovedEventInput was removed
Type InstigateContractVariationOutput was removed
Type InstigateContractVariationInput was removed
Type CatalogProductTypeEnum was added
Type InkConversationsConnection was added
Type InkConversationsEdge was added
Type ExtendAgreementPeriod was added
Type ExtendAgreementPeriodInput was added
Type IsWorkRequiredForServiceOrderType was added
Type CompleteServiceOrder was added
Type CompleteServiceOrderInput was added
Type ServiceOrderCompletionDetails was added
Type ServiceOrderResponseStatus was added
Type ServiceOrderChargeInput was added
Type SimpleServicesAgreementType was added
Type AssociateArchivedRecordingsSummaryType was added
Type AssociateArchivedRecordingResultType was added
Type AssociateArchivedRecordingResultStatus was added
Type StartOnSiteJobsAppointmentReschedulingSession was added
Type SetLastConsumerChangeDateRecordToBeExpired was added
Type SetLastConsumerChangeDateRecordToBeExpiredInput 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
Field stepSlug was removed from object type AgreementRescissionType
Input Field assignedToAffiliateNumber: String was added to input type UpdateLeadAssignmentInput
Field lastMessageAt was added to object type InkConversation
Field completeServiceOrder was added to object type Mutation
Field extendAgreementPeriod was added to object type Mutation
Field startOnSiteJobsAppointmentReschedulingSession was added to object type Mutation
Field setLastConsumerChangeDateRecordToBeExpired was added to object type Mutation
Field instigateContractVariation was removed from object type Mutation
Field publishApprovalApprovedEvent was removed from object type Mutation
Removed argument appointmentIdToReschedule from Mutation.startOnSiteJobsAppointmentBookingSession
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
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 preferredDate was added to object type WorkRequestSpecOutputType
Input Field flowRunIdentifier: String! was added to input type PublishMeterDataIssueEmailInput
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
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
CatalogProductType.sourceProductType type changed from ProductType to CatalogProductTypeEnum
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
Enum value CANCELLED_BY_BUSINESS was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_SUPPLIER was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum
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
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
Input Field externalPropertyReference: String was added to input type AccountSearchInputType
Enum value GIGAJOULES_CONSUMPTION was added to UnitType enum
Enum value COMMS_HUB_REPLACEMENT was removed from OnSiteJobsWorkCategory enum
Enum value IHD_INSTALL was removed from OnSiteJobsWorkCategory enum
Enum value INVESTIGATE_FAULT was removed from OnSiteJobsWorkCategory enum
Enum value REINSTALL was removed from OnSiteJobsWorkCategory enum
Enum value REPLACE_SEALS was removed from OnSiteJobsWorkCategory enum
Enum value AD_HOC_READING was removed from OnSiteJobsWorkCategory enum
Enum value COMMISSION was removed from OnSiteJobsWorkCategory enum
Enum value REMOVE was removed from OnSiteJobsWorkCategory enum
Enum value MOVE was removed from OnSiteJobsWorkCategory enum
Enum value EXCHANGE was removed from OnSiteJobsWorkCategory enum
Enum value COMMS_HUB_POWER_CYCLE was removed from OnSiteJobsWorkCategory enum
Enum value CONFIRM_METER_DETAILS was removed from OnSiteJobsWorkCategory enum
Enum value ISOLATOR_SWITCH_INSTALL was removed from OnSiteJobsWorkCategory enum
Enum value BRACKET_INSTALLATION was removed from OnSiteJobsWorkCategory enum
Enum value METER_TAILS_UPGRADE was removed from OnSiteJobsWorkCategory enum
Enum value NEW_CONNECTION was removed from OnSiteJobsWorkCategory enum
Enum value EV was removed from OnSiteJobsWorkCategory enum

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

DetermineDefaultTariffInput.actualChangeDate type changed from Date! to DateTime!

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

Type DetermineDefaultTariff was added
Type RegisterTariffAssignment was added
Type DetermineDefaultTariffInput was added
Field determineDefaultTariff was added to object type Mutation

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

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
Field id was added to object type AccountNoteType
Input Field contractNote: ContractNoteInput was added to input type VaryContractTermsInput
Field note was added to object type CreateAccountNote

Input Field recipientEmails: String was added to input type PublishMeterDataIssueEmailInput

Type OpenedInput was added
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 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 JoinSupplierProcessType
Field stage was added to object type LeaveSupplierProcessType

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.

Type ConcessionCardValidationMethod was removed
ConcessionCardValidationType.method type changed from ConcessionCardValidationMethod to String

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

Type NotifiedPartyTransactionType was added
Field notifiedPartyTransactions was added to object type Query

Type SendLifeSupportRequest was added
Type SendLifeSupportRequestInput was added
Type LifeSupportRequestReason was added
Field sendLifeSupportRequest was added to object type Mutation
Input Field initiatingParticipantId: String was added to input type EssentialEnergyAppointmentJobDetailsInput

Enum value IFS was added to OnSiteJobsAgent enum

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 AccountType
Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface AccountInterface

Type CreateStandingDataRegisterPendingUpdate was added
Type CreateStandingDataRegisterPendingUpdateInput was added
Type MeterUpdateKey was added
Type RegisterUpdateKey was added
Type ParticipantRelationsUpdateKey was added
Type DataStreamUpdateKey was added
Type ProposedStandingDataUpdate was added
Field createStandingDataRegisterPendingUpdate was added to object type Mutation

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
Enum value APPOINTMENT_FAILED was added to OnSiteJobsRequestStatus enum

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 ACCOUNT_PROPERTY_EFFECTIVE_PERIOD was added to LinkedObjectType enum
Enum value PROPERTY 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

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

Type RegisterEmail was added
Type RegisterEmailInput was added
Type PaymentAdequacyChangeType was added
Field registerEmail was added to object type Mutation
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
Input Field analyzerResults: [InkStorylineAnalyzerResultInput!] was added to input type AddStorylineToInkConversationInput
Field analyzerResults was added to object type InkStoryline

Type RegisterCustomerAsset was added
Type RegisterCustomerAssetInput was added
Type CustomerAssetTypeEnum was added
Type BlackholeEmailAccountUserType was added
Type BlackholeEmailAccountType was added
Type AccountUserNameType was added
Type CustomerAssetType was added
Field customerAssets of type [CustomerAssetType] was added to interface AccountInterface
Field registerCustomerAsset was added to object type Mutation
Field customerAsset was added to object type Query
Field verifyUserDetails was added to object type Query
Field blackholeEmailAccountUser was added to object type Query
Field customerAssets was added to object type AccountType

Type AddUserToAccount was added
Type AddUserToAccountInput was added
Field addUserToAccount was added to object type Mutation

Field users was added to object type AccountType

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

Type ServiceablePropertyConnectionTypeConnection was added
Type ServiceablePropertyConnectionTypeEdge was added
Type ServiceablePropertyType was added
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
Field serviceableProperties was added to object type Query

Argument excludeEstimates: Boolean added to MeterDetailType.readings

Enum value CANCELLED_BY_CUSTOMER was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_PROVIDER___ERROR_IN_MIDDLEWARE was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_BUSINESS was removed from OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_PROVIDER was removed from OnSiteJobsAppointmentCancellationCategory enum

Enum value CANCELLED_BY_BUSINESS was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_SUPPLIER was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_PROVIDER was added to OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_CUSTOMER was removed from OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum
Enum value CANCELLED_BY_PROVIDER___ERROR_IN_MIDDLEWARE was removed from OnSiteJobsAppointmentCancellationCategory enum
Field location was added to object type MeterDetailType
Field size was added to object type MeterDetailType
Field accessInformation was added to object type MeterDetailType

Input Field totalBatteryOutputCapacityKw: Decimal was added to input type DistributedEnergyResourceConfigurationInput
DistributedEnergyResourceConfigurationInput.panelOutputKw type changed from Decimal! to Decimal
DistributedEnergyResourceConfigurationInput.inverterSizeKw type changed from Decimal! to Decimal
DistributedEnergyResourceConfigurationInput.approvedExportLimitKw type changed from Decimal! to Decimal

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.leads
Argument offset: Int added to Query.opportunities

Field recipientParticipantId was added to object type DistributionElectricityServiceOrderType
Field initiatingParticipantId was added to object type DistributionElectricityServiceOrderType

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 of type [ContractNoteType] was added to interface ContractJourneyInterface
Input Field accountUserId: ID was added to input type VerifyIdentityInput
Input Field familyName: String! was added to input type VerifyIdentityInput
Input Field fullName removed from input type VerifyIdentityInput
VerifyIdentityInput.firstLineOfAddress type changed from String! to String
VerifyIdentityInput.accountNumber type changed from String! to String
Field notes was added to object type ContractCreationJourneyType
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 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!
Field legacyOrderDetails was added to object type Query
Field orderDetails was removed from object type Query

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 AccountUserCommsPreferencesType was added
Field commsPreferences was added to object type AccountUserType

Field lifeSupportContact was added to object type MeterPointType

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

Type EligibilityChecksResponseType was added
Type EligibilityCheckResultType was added
Field networkTariffEligibilityChecksForSupplyPoint was added to object type Query

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.openingBalance
Argument ledgerNumber: String added to PeriodBasedDocumentType.closingBalance

Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from AccountReminderTypes enum

Type CloseInkConversation was added
Type CloseInkConversationInput was added
Type ConversationClosedReasonChoices was added
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
OnSiteJobsUpdateRequestInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]

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

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

Field possibleErrors was added to object type TriggerElectricityHouseMoveOut

Type SubmitMeterReadingsInputType was added
Type MeterReadingInputType was added
Type ReadingReasonChoices was added
Argument input: SubmitMeterReadingsInputType! added to Mutation.submitMeterReadings

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

Type SendChangeNMIDetailsRequest was added
Type SendChangeNMIDetailsRequestOutputType was added
Type SendChangeNMIDetailsRequestInputType was added
Field sendChangeNmiDetailsRequest was added to object type Mutation

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

Input Field externalIdentifier: String was added to input type SimpleServicesEnrollmentMarketInput

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 CharacteristicValueInput 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 alignRequestStatusWithAppointment: Boolean was added to input type OnSiteJobsUpdateAppointmentInput
Input Field bypassTerminalAppointmentStatus: 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.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.
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

Type AddPropertyToHierarchy was added
Type AddPropertyToHierarchyInput was added
Argument ledgerNumber: String added to PeriodBasedDocumentType.transactions
Field addPropertyToHierarchy was added to object type Mutation
Argument ledgerNumber: String added to InvoiceType.transactions

Enum value POST_APPOINTMENT_ABORTED was added to OnSiteJobsAppointmentActionTriggerStage enum

Type SyncBusinessUserRoleType was added
Field businessUserRoles was added to object type UserSyncPayloadType
Field brand was added to object type SyncAccountType
Input Field accountTypes: [AccountTypeChoices] was added to input type AccountUserInputType
Input Field brands: [BrandChoices] was added to input type AccountUserInputType

Enum value CUSTOM was added to Vendor enum

Enum value SERVICE_TICKET was added to AccountPaymentTransactionTypeChoices enum

Type UpdateAgreementRescission was added
Type AgreementRescissionType was added
Type AgreementRescissionStatus was added
Type UpdateAgreementRescissionInput was added
Default value for argument hierarchyName on field PropertyType.ancestors changed from Undefined to 'default'
Type for argument hierarchyName on field PropertyType.ancestors changed from String! to String
Default value for argument hierarchyName on field PropertyType.descendants changed from Undefined to 'default'
Type for argument hierarchyName on field PropertyType.descendants changed from String! to String
Default value for argument hierarchyName on field PropertyType.parent changed from Undefined to 'default'
Type for argument hierarchyName on field PropertyType.parent changed from String! to String
Default value for argument hierarchyName on field PropertyInterface.ancestors changed from Undefined to 'default'
Type for argument hierarchyName on field PropertyInterface.ancestors changed from String! to String
Default value for argument hierarchyName on field PropertyInterface.descendants changed from Undefined to 'default'
Type for argument hierarchyName on field PropertyInterface.descendants changed from String! to String
Default value for argument hierarchyName on field PropertyInterface.parent changed from Undefined to 'default'
Type for argument hierarchyName on field PropertyInterface.parent changed from String! to String
Field updateAgreementRescission was added to object type Mutation

Type GenerateLeadsFileAttachmentDownloadPreSignedUrl was added
Type LeadsFileAttachmentDownloadPresignedUrlType was added
Type GenerateLeadsFileAttachmentDownloadPreSignedUrlInput was added
Field generateLeadsFileAttachmentDownloadPreSignedUrl was added to object type Mutation

Input Field organisationNumber: String was added to input type SalesInformationInput
Input Field organisationId removed from input type SalesInformationInput

Input Field supplyPointIdentifier: String was added to input type CreateAccountNoteInput
Input Field marketName: String was added to input type CreateAccountNoteInput
CreateAccountNoteInput.accountNumber type changed from String! to String

Field hasLifeSupportRecord was added to object type PropertyType

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

Please use getOnSiteJobsRequests instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.
Deprecation reason on field Mutation.updateSiteworksRequest changed from None to
The 'updateSiteworksRequest' field is deprecated.

Please use updateOnSiteJobsRequest instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.

Type ReadingConnectionTypeConnection was added
Type ReadingConnectionTypeEdge was added
Field readings was added to object type MeterDetailType

Argument number: String added to Query.affiliateOrganisation
Type for argument id on field Query.affiliateOrganisation changed from Int! to Int
Field number was added to object type AffiliateOrganisationType

Type PropertyConnection was added
Type PropertyEdge was added
Field descendants of type PropertyConnection was added to interface PropertyInterface
Field parent of type PropertyInterface was added to interface PropertyInterface
Field ancestors of type PropertyConnection was added to interface PropertyInterface
Field descendants was added to object type PropertyType
Field parent was added to object type PropertyType
Field ancestors was added to object type PropertyType

Type DetermineWorkRequestsResultType was added
Type WorkRequestSpecOutputType was added
Type TriggerPmdRequest was added
Type TriggerPmdRequestOutputType was added
Type RequestedDateRangeType was added
Type FailedDateRangeType was added
Type TriggerPmdRequestInputType was added
Type CancelServiceOrders was added
Type CancelServiceOrdersInput was added
Type CancelServiceOrdersMatchCriteria was added
Type CancelServiceOrdersCancellationReason was added
Type ServiceOrderResponseCode was added
Input Field ledgerNumber: String was added to input type PaymentPlanInput
Field typeDescription was added to object type DistributionElectricityServiceOrderType
Field subtypeDescription was added to object type DistributionElectricityServiceOrderType
Field cancelServiceOrders was added to object type Mutation
Field triggerPmdRequest was added to object type Mutation
Field transmissionNodeIdentifier was added to object type ElectricityMeterType
Input Field ledgerNumber: String was added to input type ReplaceLatestPaymentScheduleInput
Field determineRequiredWorkRequests was added to object type Query
Input Field ledgerNumber: String was added to input type PaymentScheduleInput
LeadContactDetailsInput.phoneNumber type changed from String! to String
LeadContactDetailsInput.givenName type changed from String! to String
LeadContactDetailsInput.familyName type changed from String! to String
LeadContactDetailsInput.email type changed from String! to String

Type UpdateAgreementRollover was added
Type UpdateAgreementRolloverInput was added
Type RolloverStatus was added
Field updateAgreementRollover was added to object type Mutation

Enum value AMPERE_MONTHS was added to UnitType enum

Input Field leaveSupplierNumber: String was added to input type EnrollmentInput

Type ContractNoteReasonType was added
Type ContractActivityTypeOptions was added
Field contractNoteReasons was added to object type Query
Query.opportunityProductSummary type changed from OpportunityProductSummary to [OpportunityProductSummary!]!
OpportunityProductSummary.productCharacteristics type changed from JSONString to GenericScalar

Input Field removeSupplyPoints: [LeadSupplyPoint] was added to input type UpdateOpportunityDetailsInput
Input Field addSupplyPoints: [LeadSupplyPoint] was added to input type UpdateOpportunityDetailsInput

Enum value D0010_CREATION_FAILURE was removed from AccountReminderTypes enum

Type ConnectAiAgentToCall was added
Type ConnectAiAgentToCallInput was added
Field connectAiAgentToCall was added to object type Mutation

Input Field hideOnSupportSite: Boolean was added to input type CallMetadataItemInput

Input Field funnelCode removed from input type CreateLeadInput
CreateLeadInput.address type changed from RichAddressInput! to RichAddressInput
CreateLeadInput.leadType type changed from LeadTypeChoices! to LeadTypeChoices
Default value for input field CreateLeadInput.leadType changed from Undefined to None
CreateLeadInput.salesChannel type changed from String! to String
Default value for input field CreateLeadInput.salesChannel changed from Undefined to None

Input Field accountNumber: String was added to input type CreateLeadInput

Input Field ledgerNumber: String was added to input type FixedPaymentScheduleInput

Input Field emergencyApprovalDetails: String was added to input type CreateOnSiteJobsRequestInputType

Type MeterDetailType was added
Field activeWaterMeters was added to object type PropertyType
Enum value WALMART_CASH was added to AccountPaymentTransactionTypeChoices enum
Enum value PAYPAL was added to AccountPaymentTransactionTypeChoices enum
Enum value MONEYGRAM was added to AccountPaymentTransactionTypeChoices enum
Enum value DESKTOP_DEPOSIT was added to AccountPaymentTransactionTypeChoices enum

Field tags was added to object type InkConversation

Type CreateOnSiteJobsAppointmentWithDate was added
Field createOnSiteJobsAppointmentWithDate was added to object type Mutation

Type SendOfferQuoteSummary was added
Type OfferQuoteSummaryInput was added
Field sendOfferQuoteSummary was added to object type Mutation

Type SubmitMeterReadings was added
Field submitMeterReadings was added to object type Mutation

Enum value OTHER was added to OnSiteJobsAppointmentActionTriggerStage enum

Field agreement was added to object type Query

Field status was removed from object type TriggerVmdRequestOutputType
Input Field status removed from input type TriggerVmdRequestInputType
Field status was removed from object type TriggerC4RequestOutputType
Input Field status removed from input type TriggerC4RequestInputType

Type PublishMeterDataIssueEmail was added
Type PublishMeterDataIssueEmailOutputType was added
Type PublishMeterDataIssueEmailInput was added
Field publishMeterDataIssueEmail was added to object type Mutation

Type TriggerVmdRequest was added
Type TriggerVmdRequestOutputType was added
Type TriggerVmdRequestInputType was added
Field triggerVmdRequest was added to object type Mutation

Field category was added to object type PropertyHazardType

Type for argument timeGranularity on field Device.readings changed from TimeGranularities! to TimeGranularities
Type for argument timeGranularity on field SupplyPointType.readings changed from TimeGranularities! to TimeGranularities
Type for argument timeGranularity on field HasReadings.readings changed from TimeGranularities! to TimeGranularities
Type for argument timeGranularity on field DeviceRegister.readings changed from TimeGranularities! to TimeGranularities

Input Field businessId: Int was added to input type CreateReminderInput

Field assignedToAffiliateNumber was added to object type OpportunityOutput
Field assignedToAffiliateNumber was added to object type LeadOutput

Type ReadingType was added

Type JoinSupplierLedgerAssignmentConnectionTypeConnection was added
Type JoinSupplierLedgerAssignmentConnectionTypeEdge was added
Type JoinSupplierLedgerAssignmentType was added
Type LedgerSupplyPointType was added
Field ledgerAssignments was added to object type JoinSupplierProcessType

Field agreementsForRollover was added to object type Query

Type SyncFamilyIssuesType was added
Field familyIssues was added to object type UserSyncPayloadType

Field priority was added to object type PropertyHazardType

Field subtype was added to object type LeaveSupplierProcessType
Field subtype was added to object type JoinSupplierProcessType
Enum value FIELDWORKS_METER_FAULT_NCOM_COMMS_FAILED was removed from AccountReminderTypes enum

Field field was added to object type ExtraDetail

Enum value NZ_SWITCHING_WITHDRAWAL was removed from AccountReminderTypes enum
Enum value NZ_METERING_QUERY was removed from AccountReminderTypes enum
Enum value NZ_DUNNING was removed from AccountReminderTypes enum
Enum value NZ_SOLAR_METER_CHANGE was removed from AccountReminderTypes enum
Enum value NZ_VACANT_PROPERTY was removed from AccountReminderTypes enum
Enum value NZ_BILLING_QUERY was removed from AccountReminderTypes enum

Input Field cancelConflictingSchedules: Boolean was added to input type SwitchAccountToVariablePaymentScheduleInput

Type GetOrCreateAgreement was added
Field getOrCreateAgreement was added to object type Mutation

Argument appointmentIdToReschedule: UUID added to Mutation.startOnSiteJobsAppointmentBookingSession

Type EssentialEnergyAppointmentJobDetailsInput was added
Input Field jobDetails: EssentialEnergyAppointmentJobDetailsInput! was added to input type OnSiteJobsAppointmentBookingDetailsInput
Input Field jobDetails: EssentialEnergyAppointmentJobDetailsInput was added to input type OnSiteJobsUpdateAppointmentInput
Input Field jobDetails: EssentialEnergyAppointmentJobDetailsInput! was added to input type OnSiteJobsCreateAppointmentInput

Field reversalsAfterClose of type StatementReversalsAfterClose! was added to interface BillInterface
Field reversalsAfterClose was added to object type InvoiceType
Field reversalsAfterClose was added to object type CollectiveBillType
Field reversalsAfterClose was added to object type PreKrakenBillType
Field reversalsAfterClose was added to object type PeriodBasedDocumentType

Input Field details: [DetailsInputType] was added to input type BaseInitializeUserInput

Field accountNumber was added to object type InkConversation

Field conversationRelayId was added to object type InkPost
Field conversationRelayId was added to object type InkEmail
Field conversationRelayId was added to object type InkGenericMessage

Enum value ON_SITE was added to OnSiteJobsAppointmentStatus enum
Enum value EN_ROUTE was added to OnSiteJobsAppointmentStatus enum

Type ManualReviewMeterDataIssue was added
Type ManualReviewMeterDataIssueOutputType was added
Type ManualReviewMeterDataIssueInputType was added
Field manualReviewMeterDataIssue was added to object type Mutation

Type ContactPersonType was added
Field serviceComment was added to object type ContactPersonPhoneType
Field customerDetail was added to object type DistributionServiceOrderRequestType
Field contactDetail was added to object type DistributionServiceOrderRequestType

Type CreateCollectionProcessEvent was added
Type CollectionProcessEventOutputType was added
Type CreateCollectionProcessEventInputType was added
Type CollectionProcessEventTypeEnum was added
Enum value REACTIVATION_HISTORY was removed from CollectionProcessAssociatedItemType enum
Field createCollectionProcessEvent was added to object type Mutation

Enum value FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITHOUT_CUSTOMER_CONSULTATION was added to AccountReminderTypes enum

Argument subdomain: String added to Query.appSessions
Type for argument postcode on field Query.appSessions changed from String! to String

Field accounts was added to object type Trigger
Field accountsLinkedAt was added to object type Trigger

Field account was added to object type CommonAgreementType

Enum value KW_DEMAND_DAYS was added to UnitType enum

Type DistributionServiceOrderRequestType was added
Field request was added to object type DistributionElectricityServiceOrderType

Input Field waiveExitFee: Boolean was added to input type BaseInstigateContractTerminationInput
Default value for input field TerminateContractInput.waiveExitFee changed from Undefined to False

Input Field supplyPoints: [LeadSupplyPoint] was added to input type CreateOpportunityAndLeadInput

Type TerminateAgreement was added
Type TerminateAgreementInput was added
CreateReminderInput.accountNumber type changed from String! to String
Field terminateAgreement was added to object type Mutation

Field offerGroupIdentifier was added to object type JoinSupplierProcessDataType
Input Field offerGroupIdentifier: NonEmptyString was added to input type SalesInformationInput

Field openingBalance was added to object type PeriodBasedDocumentType

CoreSiteworksAppointmentType.externalReference type changed from String to String!
CoreSiteworksRequestType.reason type changed from String to String!

Input Field flowRunIdentifier: String! was added to input type ResolveMeterDataIssueInputType

Input Field preferredContactMethod: String was added to input type CreateComplaintInputType
Input Field preferredCommunicationMethod removed from input type CreateComplaintInputType

Field getElectricityServiceOrderById was added to object type Query

Type MarketParticipantType was added
Field multiplier was added to object type ElectricityRegisterType
Field marketParticipant was added to object type Query
Field model was added to object type ElectricityMeterType

Type TriggerCollectionProcessMessage was added
Type TriggerCollectionProcessMessageOutput was added
Type TriggerCollectionProcessMessageInput was added
Field triggerCollectionProcessMessage was added to object type Mutation

EndMeterDataIssueFlowInputType.status type changed from String! to MeterDataIssueFlowStatus!

Input Field sendComms: Boolean was added to input type UpdateHardshipAgreementInput

Input Field leadId removed from input type CreateOpportunityAndLeadInput

Type LeadSupplyPointType was added
Type LeadSupplyPointFiltersInput was added
Type SupplyPointMarketNameEnum was added
Field supplyPoints was added to object type OpportunityOutput
Input Field supplyPointMarkets: [SupplyPointMarketNameEnum] was added to input type OpportunitiesQueryInput

Type LeadSupplyPoint was added
Input Field supplyPoints: [LeadSupplyPoint] was added to input type CreateOpportunityForLeadInput

Type CreateTemplateOutput was removed
Type TemplateType was removed
Type TemplateStatus was removed
Type TemplateGroupType was removed
Type GroupCategory was removed
Type TemplateLineItemType was removed
Type CurrencyType was removed
Type CreateTemplateInput was removed
Type TemplateGroupInput was removed
Type TemplateLineItemInput was removed
Type UpdateTemplateOutput was removed
Type UpdateTemplateInput was removed
Type DeleteTemplateOutput was removed
Type ActivateTemplatesOutput was removed
Type ExpireTemplatesOutput was removed
Type CreateInputOutput was removed
Type InputType was removed
Type Section was removed
Type CreateInputInput was removed
Type UpdateInputOutput was removed
Type UpdateInputInput was removed
Type DeleteInputOutput was removed
Type TemplateFilterInput was removed
Type TemplateNodesType was removed
Type RateBuilderNodeType was removed
Type LabelValueType was removed
Type SalesTaxNodeType was removed
Field template was removed from object type Query
Field latestTemplate was removed from object type Query
Field latestActiveTemplate was removed from object type Query
Field templateNodesOptions was removed from object type Query
Field catalogInput was removed from object type Query
Field catalogInputs was removed from object type Query
Field templates was removed from object type Query
Field updateTemplate was removed from object type Mutation
Field expireTemplates was removed from object type Mutation
Field activateTemplates was removed from object type Mutation
Field deleteTemplate was removed from object type Mutation
Field deleteCatalogInput was removed from object type Mutation
Field updateCatalogInput was removed from object type Mutation
Field createTemplate was removed from object type Mutation
Field createCatalogInput was removed from object type Mutation

Type TriggerC4Request was added
Type TriggerC4RequestOutputType was added
Type TriggerC4RequestInputType was added
Type C4RequestRoleType was added
Field triggerC4Request was added to object type Mutation

Type CreateHardshipAgreement was added
Type CreateHardshipAgreementInput was added
Type HardshipTypeEnum was added
Type HardshipEntryReasonEnum was added
Type HardshipExitReasonEnum was added
Type UpdateHardshipAgreement was added
Type UpdateHardshipAgreementInput was added
Type HardshipAgreementExitReason was added
Field exitReasonDetails was added to object type HardshipAgreementType
Field endDate was added to object type HardshipAgreementType
Field createdAt was added to object type HardshipAgreementType
Field exitReason was added to object type HardshipAgreementType
Field updateHardshipAgreement was added to object type Mutation
Field createHardshipAgreement was added to object type Mutation

Type MoveToBucket was added
Type MoveToBucketInput was added
Field moveToBucket was added to object type Mutation
Field conversationId was added to object type InkEmail
Field conversationId was added to object type InkGenericMessage
Field conversationId was added to object type InkPost

Type ResolveMeterDataIssue was added
Type ResolveMeterDataIssueOutputType was added
Type MeterDataIssueStatus was added
Type ResolveMeterDataIssueInputType was added
Field resolveMeterDataIssue was added to object type Mutation

Type ChangeRetailerForSupplyPoint was removed
Type ChangeRetailerForSupplyPointInput was removed
Field changeRetailerForSupplyPoint was removed from object type Mutation

Field canRescindAgreement was added to object type Query

Input Field accountNumber: String was added to input type CloseInkLiveChaConversationtInput

Input Field opportunityAddress: RichAddressInput was added to input type CreateOpportunityAndLeadInput
Input Field useSameAddressAsBilling: Boolean was added to input type CreateOpportunityForLeadInput

Type UpdateOpportunityDetails was added
Type UpdateOpportunityDetailsInput was added
Field updateOpportunityDetails was added to object type Mutation

Type CreateOrUpdateTimeSeriesEntries was added
Type CreateOrUpdateTimeSeriesEntriesInput was added
Field createOrUpdateTimeSeriesEntries was added to object type Mutation
Deprecation reason on field Mutation.createTimeSeriesPrices changed from None to
The 'createTimeSeriesPrices' field is deprecated.

Please use the 'createOrUpdateTimeSeriesEntries' mutation instead.

- Marked as deprecated on 2025-02-03.
- Scheduled for removal on or after 2025-03-01.

Field wasCreated was added to object type CreateContractOutput

Type HasFamilyIssues was added
Type HasFamilyIssuesInputType was added
Type CommsDeliveryPreferenceEnum was added
Field hasFamilyIssues was added to object type Mutation

Field rescissionDeadlineAt was added to object type ElectricityAgreementType
Input Field rescissionDeadlineAt: DateTime was added to input type CreateAgreementInput
Field rescissionDeadlineAt was added to object type GasAgreementType
Field rescissionDeadlineAt was added to object type DistributionAgreementType
Field rescissionDeadlineAt of type DateTime was added to interface AusAgreementInterface
Field rescissionDeadlineAt was added to object type CommonAgreementType

Input Field assignedToTeamName: String was added to input type CreateOpportunityForLeadInput
Input Field assignedToUsername: String was added to input type CreateOpportunityForLeadInput
Input Field assignedToTeamName: String was added to input type CreateOpportunityAndLeadInput
Input Field assignedToUsername: String was added to input type CreateOpportunityAndLeadInput

Input Field assignedToTeamName: String was added to input type CreateLeadInput
Input Field assignedToUsername: String was added to input type CreateLeadInput

Input Field useForAutomatedPayments: Boolean was added to input type CreateDirectDebitInstructionInput

Input Field assignedToAffiliateNumber: String was added to input type CreateOpportunityAndLeadInput
Input Field affiliateOrganisationId removed from input type CreateOpportunityAndLeadInput
Input Field assignedToAffiliateNumber: String was added to input type CreateOpportunityForLeadInput
Input Field affiliateOrganisationId removed from input type CreateOpportunityForLeadInput

Input Field useForAutomatedPayments: Boolean was added to input type SetUpDirectDebitInstructionInput
Input Field useForAutomatedPayments: Boolean was added to input type StorePaymentInstructionInput
Field supportSiteUrl was added to object type EmailType

Type EndMeterDataIssueFlow was added
Type EndMeterDataIssueFlowOutputType was added
Type EndMeterDataIssueFlowInputType was added
Field endMeterDataIssueFlow was added to object type Mutation

Input Field assignedToAffiliateNumber: String was added to input type OpportunitiesQueryInput
Input Field createdByOrganization removed from input type OpportunitiesQueryInput
Input Field assignedToAffiliateNumber: String was added to input type LeadsQueryInput
Input Field createdByOrganization removed from input type LeadsQueryInput

Input Field assignedToAffiliateNumber: String was added to input type CreateLeadInput
Input Field affiliateOrganisationId removed from input type CreateLeadInput

Field hasActiveDunningProcess was added to object type AccountType
Field hasActiveDebtCollectionProceeding was added to object type AccountType
Field isMeasured was added to object type AccountType

Field phones was added to object type OutageContactType
Deprecation reason on field OutageContactType.phoneNumber2 changed from None to
The 'phoneNumber2' field is deprecated.

Use the phones field to get all phone details associated with the contact person.

- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phone2 changed from None to
The 'phone2' field is deprecated.

Use the phones field to get all phone details associated with the contact person.

- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phoneNumber1 changed from None to
The 'phoneNumber1' field is deprecated.

Use the phones field to get all phone details associated with the contact person.

- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phoneNumber2ServiceType changed from None to
The 'phoneNumber2ServiceType' field is deprecated.

Use the phones field to get all phone details associated with the contact person.

- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phone1 changed from None to
The 'phone1' field is deprecated.

Use the phones field to get all phone details associated with the contact person.

- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phoneNumber1ServiceType changed from None to
The 'phoneNumber1ServiceType' field is deprecated.

Use the phones field to get all phone details associated with the contact person.

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

Type SendCustomerDetailsRequest was added
Type SendCustomerDetailsRequestInputType was added
Type RequestReason was added
Field sendCustomerDetailsRequest was added to object type Mutation

Type UpdateOfferGroupOnOpportunity was added
Type UpdateOfferGroupOnOpportunityInput was added
Field updateOfferGroupOnOpportunity was added to object type Mutation

Field storedPaymentMethodDetailsReference was added to object type JoinSupplierProcessDataType

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

Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.

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

Input Field lastContactedSupportUserId: Int was added to input type CreateCustomerFeedbackInputType
Field trigger was added to object type PaymentScheduleType

Type CreatePaymentActionIntent was added
Type CreatePaymentActionIntentInput was added
Type PaymentActionIntentTargetType was added
Field createPaymentActionIntent was added to object type Mutation

Type PaymentTermsInput was added
Type PaymentTermsInvalidErrorType was added
Input Field paymentTerms: PaymentTermsInput was added to input type BillAndPaymentInput
Union member PaymentTermsInvalidErrorType was added to ProcessHouseMoveErrorUnion Union type

Type Units was added
Argument units: [Units] added to SupplyPointType.readings
Argument units: [Units] added to HasReadings.readings
Argument units: [Units] added to Device.readings
Argument units: [Units] added to DeviceRegister.readings

Type WaterMeterType was added
Type WaterMeterCategory was added
Type WaterMeterCapabilityType was added
Type WaterMeterStatus was added
Enum value TBD was added to BusinessTypeChoices enum
Enum value TO_BE_DETERMINED was added to BusinessTypeOptions enum
Enum value FINALIZE_ACCOUNT_SETUP was added to ExpiringTokenScope enum
Input Field isRootCause: Boolean was added to input type InkStorylineEntryInput
Field isRootCause was added to object type InkStorylineEntry
Enum value FINALIZE_ACCOUNT_SETUP was added to PreSignedTokenScope enum

Type CreateMeterDataIssueFlow was added
Type CreateMeterDataIssueFlowOutputType was added
Type MeterDataIssueFlowStatus was added
Type CreateMeterDataIssueFlowInputType was added
Field createMeterDataIssueFlow was added to object type Mutation

Type CharacteristicType was added
Type CharacteristicValueUnion was added
Type StringCharacteristicValueType was added
Type IntegerCharacteristicValueType was added
Field characteristic of type CharacteristicType was added to interface CharacteristicValueInterface

Input Field stageCode: String was added to input type LeadsQueryInput

Input Field productOfferingId: String was added to input type OpportunitiesQueryInput
Field agreementRollover was added to object type Query

UpdateLeadStageInput.currentStage type changed from String! to NonEmptyString!
UpdateOpportunityStageInput.currentStage type changed from String to NonEmptyString!

Type CharacteristicValueInterface was added
Field characteristicValues was added to object type CommonAgreementType
Field order was added to object type SalesFunnelStage
Field funnel was added to object type LeadOutput

Field numberOfOccupants was added to object type OccupancyPeriodType

Enum value INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_MISSING_BUSINESS_ACCEPTANCE was added to AccountReminderTypes enum
Enum value INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_REJECTED was added to AccountReminderTypes enum

Type ProcessOrderInput was removed
Type OrderInput was removed
Type CustomerOrderInput was removed
Type OrderLineInput was removed
Type OrderItemInput was removed
Type ItemProfileInput was removed
Type MarketDataInput was removed
Type OrderLinePeriodInput was removed
Field processOrder was removed from object type Mutation

Enum value DKK_ORE was added to LineItemCurrency enum
Enum value DNK_ORE was removed from LineItemCurrency enum

Enum value DNK_ORE was added to LineItemCurrency enum

Enum value INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_REQUEST_REJECTED was added to AccountReminderTypes enum

Type CreateAgreement was added
Type CreateAgreementInput was added
Field createAgreement was added to object type Mutation

Field instigateBusinessContractTermination was removed from object type Mutation

PushNotificationBindingType.messages type changed from [SMSMessageType!]! to PrintMessageTypeConnection!
Argument first: Int added to PushNotificationBindingType.messages
Argument offset: Int added to PushNotificationBindingType.messages
Argument before: String added to PushNotificationBindingType.messages
Argument last: Int added to PushNotificationBindingType.messages
Argument after: String added to PushNotificationBindingType.messages

Type InstigateContractVariationOutput was added
Type InstigateContractVariationInput was added
Field instigateContractVariation was added to object type Mutation
Deprecation reason on field Mutation.varyContractTerms changed from None to
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.

Input Field identifier removed from input type CreateContractInput

Field supplyPointInternalIdentifier was added to object type OnSiteJobsAssetType
Deprecation reason on field OnSiteJobsAssetType.supplyPointIdentifier changed from None to
The 'supplyPointIdentifier' field is deprecated.

Use 'supplyPointInternalIdentifier' instead. This field is being removed as the underlying model field is being removed.

- Marked as deprecated on 2026-01-16.
- Scheduled for removal on or after 2026-03-01.
OnSiteJobsAssetType.supplyPointIdentifier type changed from String! to String

Type CollectionProcessTypes was added
Field targetObjectIdentifier was added to object type CollectionProcessDetailsType
Field collectionProcessType was added to object type CollectionProcessDetailsType

Type ExtraDetail was added
Field extraDetailItems was added to object type LeadOutput
Deprecation reason on field LeadOutput.extraDetails changed from None to
The 'extraDetails' field is deprecated.

Use extraDetailsItems instead, which provides a structured key/value format.

- Marked as deprecated on 2026-01-14.
- Scheduled for removal on or after 2026-07-14.
Input Field extraDetailItems: [ExtraDetailsItem] was added to input type LeadContactDetailsInput
Input Field extraDetails removed from input type LeadContactDetailsInput
Field extraDetailItems was added to object type OpportunityOutput
Deprecation reason on field OpportunityOutput.extraDetails changed from None to
The 'extraDetails' field is deprecated.

Use extraDetailsItems instead, which provides a structured key/value format.

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

Type CreateInputOutput was added
Type InputType was added
Type Section was added
Type CreateInputInput was added
Type UpdateInputOutput was added
Type UpdateInputInput was added
Type DeleteInputOutput was added
Type TemplateNodesType was added
Type RateBuilderNodeType was added
Type LabelValueType was added
Type SalesTaxNodeType was added
Field updateCatalogInput was added to object type Mutation
Field deleteCatalogInput was added to object type Mutation
Field createCatalogInput was added to object type Mutation
Field templateNodesOptions was added to object type Query
Field catalogInputs was added to object type Query
Field catalogInput was added to object type Query

Type for argument filters on field Query.searchLead changed from SearchLeadFilters to SearchLeadFilters!

Type ExportRepaymentDetailsType was added
Type UpdateExportPaymentMethod was added
Type UpdateExportPaymentMethodInput was added
Type ExportPaymentMethodEnum was added
Field updateExportPaymentMethod was added to object type Mutation
Field exportRepaymentDetails was added to object type Query

Argument statuses: [String] added to Query.getStandingDataPendingUpdatesByNmi
Removed argument status from Query.getStandingDataPendingUpdatesByNmi
Field updatedAt was added to object type GetStandingDataPendingUpdates
Field createdAt was added to object type GetStandingDataPendingUpdates

Field location was added to object type ElectricityMeterType
Field disconnectionMethod was added to object type MeterPointType
Field sharedFuseGroupIdentifier was added to object type MeterPointType

Type RunAgreementRollover was added
Type RunAgreementRolloverInput was added
Field runAgreementRollover was added to object type Mutation

Field assigneeTeamId was added to object type Reminder
Field assigneeId was added to object type Reminder
Input Field assigneeTeamId: ID was added to input type CreateReminderInput
Input Field assigneeId: ID was added to input type CreateReminderInput

Type CreateTemplateOutput was added
Type CreateTemplateInput was added
Type TemplateGroupInput was added
Type TemplateLineItemInput was added
Type UpdateTemplateOutput was added
Type UpdateTemplateInput was added
Type DeleteTemplateOutput was added
Type ActivateTemplatesOutput was added
Type ExpireTemplatesOutput was added
Field activateTemplates was added to object type Mutation
Field deleteTemplate was added to object type Mutation
Field updateTemplate was added to object type Mutation
Field expireTemplates was added to object type Mutation
Field createTemplate was added to object type Mutation

Type TemplateType was added
Type TemplateStatus was added
Type TemplateGroupType was added
Type GroupCategory was added
Type TemplateLineItemType was added
Type CurrencyType was added
Type TemplateFilterInput was added
Field latestActiveTemplate was added to object type Query
Field latestTemplate was added to object type Query
Field templates was added to object type Query
Field template was added to object type Query

Type ShowInputFieldErrorsActionType was added
Type InputFieldErrorType was added
Type FormScreenType was added
Union member FormScreenType was added to BackendScreenType Union type
Union member ShowInputFieldErrorsActionType was added to ActionType Union type

Enum value WATER was added to OnSiteJobsWorkCategory enum
Enum value SEWER was added to OnSiteJobsWorkCategory enum
Enum value SUPPLY_SERVICE_WORKS was added to OnSiteJobsWorkCategory enum
Enum value INTERNAL was added to OnSiteJobsWorkCategory enum
Enum value METERING_SERVICE_WORKS was added to OnSiteJobsWorkCategory enum

Type OpportunityAttachmentCategory was added
CreateOpportunityFileAttachmentInput.category type changed from String! to OpportunityAttachmentCategory!
GenerateLeadsFileAttachmentPreSignedUrlInput.category type changed from String! to OpportunityAttachmentCategory!
OpportunityAttachment.category type changed from String to OpportunityAttachmentCategory

Input Field freeText: String was added to input type LeadsQueryInput

Field isPinned was added to object type KrakenVersionType
Argument supplyPointInternalIds: [Int] added to Query.getOnSiteJobsCheckResults
Type for argument supplyPointIdentifierToMarketNameMapping on field Query.getOnSiteJobsCheckResults changed from [SupplyPointIdentifierToMarketNameMappingInput]! to [SupplyPointIdentifierToMarketNameMappingInput]

Type RevokeContractOutput was added
Type RevokeContractInput was added
Field clientMutationId was removed from object type AddNoteToInkConversation
Field revokeContract was added to object type Mutation
Field clientMutationId was removed from object type AssignInkBucket
Field clientMutationId was removed from object type CreateInkInboundMessage
Field clientMutationId was removed from object type UpdateMessageTags

Type CreateAgreementRollover was added
Type AgreementRolloverType was added
Type AgreementRolloverRolloverType was added
Type AgreementRolloverStatus was added
Type CreateAgreementRolloverInput was added
Field createAgreementRollover was added to object type Mutation
Argument supplyPointInternalIds: [Int] added to Query.getOnSiteJobsRequests

APIExceptionType.userId type changed from Int to BigInt
Field concessionCreditToDate was added to object type PredictedBillComponentsType

QuoteComponentType.quotingParamsInputData type changed from JSONString to [QuotingParamType]
Field value was added to object type QuotingParamType
Field source was added to object type QuotingParamType

Type ChangeSupplierForSupplyPoint was added
Type ChangeSupplierForSupplyPointInput was added
Field changeSupplierForSupplyPoint was added to object type Mutation

Input Field addonBands: [String] was added to input type MarketAcquisitionDetailsInput
Input Field addonBands: [String] was added to input type ElectricityAcquisitionDetailsInput
Input Field addonBands: [String] was added to input type GasAcquisitionDetailsInput

Type GetOrCreateShellAccountForOpportunity was removed
Type GetOrCreateShellAccountForOpportunityInput was removed
Type OpportunityAttachment was added
Input Field createdByOrganization: String was added to input type OpportunitiesQueryInput
Input Field salesChannel: String was added to input type OpportunitiesQueryInput
Input Field leadType: LeadTypeChoices was added to input type LeadsQueryInput
Field attachments was added to object type OpportunityOutput
Field getOrCreateAccountForOpportunity was removed from object type Mutation

Type UpdateAccountReferralStatus was added
Type UpdateAccountReferralStatusInput was added
Field updateAccountReferralStatus was added to object type Mutation

Type MeterReadingEstimationReadingConnection was added
Type MeterReadingEstimationReadingEdge was added
Type MeterReadingEstimationReadingType was added
Type AssignSupplyPointToEstimationGroup was added
Type AssignedSupplyPointEstimationGroupType was added
Type AssignSupplyPointToEstimationGroupInput was added
Type DetachSupplyPointFromEstimationGroup was added
Type DeletedSupplyPointEstimationGroupType was added
Type DetachSupplyPointFromEstimationGroupInput was added
Field detachSupplyPointFromEstimationGroup was added to object type Mutation
Field assignSupplyPointToEstimationGroup was added to object type Mutation

Argument supportUserName: String! added to Query.agentCallCenterStatus
Removed argument supportUserId from Query.agentCallCenterStatus

Type RetrieveOpportunityFileAttachmentInput was removed
Type FetchPreSignedLinkForOpportunityAttachment was added
Type FetchPreSignedLinkForOpportunityAttachmentInput was added
Field presignedUrl was added to object type OpportunityFileAttachment
Field fetchUrl was removed from object type OpportunityFileAttachment
Field retrieveOpportunityFileAttachment was removed from object type Query
Field fetchPreSignedLinkForOpportunityAttachment was added to object type Mutation

Type ContractFiltersInput was added
Field contracts was added to object type Query

Field createdBy was added to object type OnSiteJobsRequestType

Input Field affiliateDetails: AffiliateDetails was added to input type ProcessHouseMoveInput

OnSiteJobsAssetType.supplyPointIdentifier type changed from String to String!

Type Period was added
Field productOffering was added to object type OpportunityOutput
CreateLeadInput.nationalId type changed from String! to String
Default value for input field CreateLeadInput.nationalId changed from Undefined to None
CreateOpportunityAndLeadInput.nationalId type changed from String! to String
Field period was added to object type SupplyOrServiceCharge

Type SalesFunnelRule was added
Type OpportunityFileAttachment was added
Type RetrieveOpportunityFileAttachmentInput was added
Field retrieveOpportunityFileAttachment was added to object type Query
Field rules was added to object type SalesFunnel

Type AgentCallCenterStatusType was added
Field agentCallCenterStatus was added to object type Query

Type ServiceOrderCoincidenceCheck was added
Type CoincidenceCheckOutcome was added
Field serviceOrderCoincidenceCheck was added to object type Mutation

Enum value PARTIALLY_COMPLETE was added to OnSiteJobsAppointmentStatus enum
Enum value DISPATCHED was added to OnSiteJobsAppointmentStatus enum

Input Field userNumber: String was added to input type RequestPasswordResetInput
RequestPasswordResetInput.email type changed from String! to String
Field userNumber was added to object type RequestPasswordResetOutputType

On this page