GraphQL API Changelog

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

Type OnSiteJobsAppointmentBookingDetailsInput was added
Type OnSiteJobsRequestBookingDetailsInput was added
Type OnSiteJobsUpdateAppointmentInput was added
Type OnSiteJobsAppointmentCancellationCategory was added
Type OnSiteJobsExternalJobTypeMappingType was added
Type OnSiteJobsCommsStrategy was added
Type OnSiteJobsAppointmentStatus was added
Type OnSiteJobsCancellationCategory was added
Type OnSiteJobsJobTypeType was added
Type OnSiteJobsAppointmentSlotResultsType was added
Type OnSiteJobsAppointmentSlotType was added
Type OnSiteJobsAppointmentType was added
Type OnSiteJobsAppointmentConnectionTypeConnection was added
Type OnSiteJobsAppointmentConnectionTypeEdge was added
Type OnSiteJobsAppointmentActionConnectionTypeConnection was added
Type OnSiteJobsAppointmentActionConnectionTypeEdge was added
Type OnSiteJobsAppointmentActionType was added
Type OnSiteJobsAppointmentActionTriggerStage was added
Type OnSiteJobsWorkflowStatus was added
Type CoreSiteworksAppointmentType was added
Type CancelOnSiteJobsAppointment was added
Type CancelOnSiteJobsAppointmentInputType was added
Type UpdateOnSiteJobsAppointment was added
Type StartOnSiteJobsAppointmentBookingSession was added
Type StartOnSiteJobsAppointmentBookingSessionForRequest was added
Type StartOnSiteJobsAppointmentReschedulingSession was added
Type StartOnSiteJobsTimeslotPickingSession was added
Type CreateOnSiteJobsAppointment was added
Type CreateOnSiteJobsAppointmentWithDate was added
Type CreateOnSiteJobsAppointmentWithoutDateOrTime was added
Type CreateOnSiteJobsAppointmentWithoutBooking was added
Type OnSiteJobsCreateAppointmentInput was added
Type PickTimeslotForOnSiteJobsAppointment was added
Input Field orderSubmittedAt: DateTime was added to input type EnrollmentInput
Field createOnSiteJobsAppointmentWithoutBooking was added to object type Mutation
Field startOnSiteJobsAppointmentBookingSession was added to object type Mutation
Field updateOnSiteJobsAppointment was added to object type Mutation
Field createOnSiteJobsAppointment was added to object type Mutation
Field startOnSiteJobsAppointmentBookingSessionForRequest was added to object type Mutation
Field startOnSiteJobsTimeslotPickingSession was added to object type Mutation
Field createOnSiteJobsAppointmentWithDate was added to object type Mutation
Field cancelOnSiteJobsAppointment was added to object type Mutation
Field startOnSiteJobsAppointmentReschedulingSession was added to object type Mutation
Field createOnSiteJobsAppointmentWithoutDateOrTime was added to object type Mutation
Field pickTimeslotForOnSiteJobsAppointment was added to object type Mutation
Field appointmentCheckResults was added to object type OnSiteJobsCheckResultsType
Field canCreateAppointment was added to object type OnSiteJobsCheckResultsType
Field hasAppointmentWarnings was added to object type OnSiteJobsCheckResultsType
Field appointments was added to object type CoreSiteworksRequestType
Field getOnSiteJobsAppointmentSlots was added to object type Query
Field getOnSiteJobsAppointmentByExternalReference was added to object type Query
Field getOnSiteJobsAppointmentById was added to object type Query
Field getOnSiteJobsJobTypes was added to object type Query
Field appointments was added to object type OnSiteJobsRequestType

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 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 EntityAccessConnectionTypeConnection was removed
Type EntityAccessConnectionTypeEdge was removed
Type EntityAccessType was removed
Type AccessibleEntityUnion was removed
Type AccountAccessConnectionTypeConnection was added
Type AccountAccessConnectionTypeEdge was added
Type AccountAccessType was added
Type BusinessAccessConnectionTypeConnection was added
Type BusinessAccessConnectionTypeEdge was added
Type BusinessAccessType was added
AffiliateOrganisationType.accessibleBusinesses type changed from EntityAccessConnectionTypeConnection to BusinessAccessConnectionTypeConnection
AffiliateOrganisationType.accessibleAccounts type changed from EntityAccessConnectionTypeConnection to AccountAccessConnectionTypeConnection

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

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

Input Field geographicalId: String was added to input type RichAddressInput
Input Field geographicalId: String was added to input type BillingAddressDetailsInput
Field geographicalId was added to object type PropertyRichAddressType
Field geographicalId was added to object type RichAddressType

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 AmendContractSubjectOutput was added
Type AmendContractSubjectInput was added
Type SubjectAdditionInput was added
Type SubjectRemovalInput 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 creationSalesChannel was added to object type OpportunityOutput
Field conversionSalesChannel was added to object type OpportunityOutput

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 flowId was added to object type RegisterLeadFlowStatusEvent
Field possibleErrors was removed from object type RegisterLeadFlowStatusEvent
Field accountNumber was added to object type SetPaymentPreference
Field possibleErrors was removed from object type SetPaymentPreference
Field accountNumber was added to object type StopAutomatedPayments
Field possibleErrors was removed from object type StopAutomatedPayments
Field roleCode was added to object type GrantUserAccessToBusiness
Field possibleErrors was removed from object type GrantUserAccessToBusiness
Field flowId was added to object type RegisterOpportunityFlowStatusEvent
Field possibleErrors was removed from object type RegisterOpportunityFlowStatusEvent
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 portfolioNumber was added to object type AddPortfolioReference
Field possibleErrors was removed from object type AddPortfolioReference
Field roleCode was added to object type RevokeUserAccessFromBusiness
Field possibleErrors was removed from object type RevokeUserAccessFromBusiness

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

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

Enum value SWEB was added to OnSiteJobsAgent 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

Field supplyVoltage was added to object type P0DetailsAcceptance
Field cieSupplyType was added to object type P0DetailsAcceptance
Field cieLowVoltageInstalledPower was added to object type P0DetailsAcceptance
Field cieSupplyVoltage was added to object type P0DetailsAcceptance

Type UpdatePropertyAddress was added
Type UpdatePropertyAddressInput was added
Field updatePropertyAddress was added to object type Mutation

Field autoRenewable was added to object type SocialBonus

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 EstimatedSupplyPointReadingType was added
Field estimatedSupplyPointReadings 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 was added to object type OutboundCallType
Field tags was added to object type InboundCallType
Field tags of type [CallTagType]! was added to interface CallInterface

Enum value STRIPE_CONNECT_HD was added to Vendor enum
Enum value STRIPE_CONNECT_HD_NHH 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

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

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

Argument supplyPointExternalIdentifier: String added to AccountBillingInfo.marketSupplyAgreements
Argument supplyPointExternalIdentifier: String added to Account.marketSupplyAgreements

Enum value ESSENTIAL_WATER_FIELD was removed from OnSiteJobsAgent enum

Enum value ESSENTIAL_WATER_FIELD was added to OnSiteJobsAgent enum

Enum value DANKORT was added to CardPaymentNetwork enum

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

Enum value AGREEMENT was added to StorylineEntryTypes enum

Input Field supplyPointIdentifier: String was added to input type TimeSeriesSpecificationEligibilityScheduleInput
Input Field supplyPointIdentifier: String was added to input type RateGroupEligibilityScheduleInput
Field supplyPointIdentifier was added to object type TimeSeriesSpecificationEligibilityScheduleType
Field supplyPointIdentifier was added to object type RateGroupEligibilityScheduleType

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

Input Field reference: String was added to input type PaymentMethodInput

Field overrideFixedAmount was added to object type PartnerCommissionContractConfigType
Input Field triggerId: String was added to input type AddStorylineToInkConversationInput
Field triggerId was added to object type InkStoryline
Input Field overrideFixedAmount: Decimal was added to input type PartnerCommissionContractConfigInput

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

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

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 passportNumber was added to object type AccountUserMeta
Field passportCountry was added to object type AccountUserMeta
Field consents was added to object type LeadContactDetailsType

Field identifier was added to object type CollectiveBillType

LatePaymentFeesInput.percentageIntervalDays type changed from Decimal to Int
LatePaymentFeesInput.flatFeeAmount type changed from Decimal to Int
LatePaymentFeesType.percentageIntervalDays type changed from Decimal to Int
LatePaymentFeesType.flatFeeAmount type changed from Decimal to Int

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

Type ConsentOutput was removed
Default value for input field LegacyMarketDataInput.addressDetails changed from None to Undefined
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
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 callId was added to object type CallRecordingDetailType

Type OrganisationReferenceType was added
Type ReplacePartnerReferences was added
Type ReplacePartnerReferencesInputType was added
Type OrganisationReferenceInput was added
Field replacePartnerReferences was added to object type Mutation
Field references was added to object type AffiliateOrganisationType

Field possibleErrors was removed from object type AddProperty
Field possibleErrors was removed from object type AllowRepaymentSubmission
Field possibleErrors was removed from object type UpdateOpportunityStage
Field possibleErrors was removed from object type CreateCallMetadata
Field possibleErrors was removed from object type AddSignupReferralOnAccount
Field possibleErrors was removed from object type SendVerificationEmail
Field possibleErrors was removed from object type UpdateBillingAddress
Field possibleErrors was removed from object type RefundPayment
Field possibleErrors was removed from object type UpdateDCAProceeding
Field possibleErrors was removed from object type DeletePropertyDescendants
Field possibleErrors was removed from object type CreateOpportunityForLead
Field possibleErrors was removed from object type UpdateBillingDetails
Field possibleErrors was removed from object type CreatePortfolio
Field possibleErrors was removed from object type CreateMetadata
Field possibleErrors was removed from object type CommenceDCAProceeding
Field possibleErrors was removed from object type UpdateAccountUser
Field possibleErrors was removed from object type RequestDoubleOptIn
Field possibleErrors was removed from object type CreateCreditTransferPermission
Field possibleErrors was removed from object type CreateInkLiveChatMessage
Field possibleErrors was removed from object type RedeemLoyaltyPointsForAccountCredit
Field possibleErrors was removed from object type AssessCollectionProcessRecordForPause
Field possibleErrors was removed from object type GetEmbeddedSecretForNewPaymentInstruction
Field possibleErrors was removed from object type AssociateCallWithAccount
Field possibleErrors was removed from object type CancelRepaymentRequest
Field possibleErrors was removed from object type UpdateAccountBillingAddress
Field possibleErrors was removed from object type UpdateAccountReference
Field possibleErrors was removed from object type UpdateAPIException
Field possibleErrors was removed from object type UpdateMetadata
Field possibleErrors was removed from object type UpdateAffiliateLink
Field possibleErrors was removed from object type RecordInvalidatedPaymentMethod
Field possibleErrors was removed from object type MoveToBucket
Field possibleErrors was removed from object type ValidateAddress
Field possibleErrors was removed from object type CreateSolarWalletRelationship
Field possibleErrors was removed from object type UpdatePaymentDetails
Field possibleErrors was removed from object type CompleteStandalonePayment
Field possibleErrors was removed from object type JoinSupplierAcceptTermsAndConditions
Field possibleErrors was removed from object type CompleteApproval
Field possibleErrors was removed from object type ReactivateCollectionProcessRecord
Field possibleErrors was removed from object type CreateContributionAgreement
Field possibleErrors was removed from object type UpdateLeadDetails
Field possibleErrors was removed from object type CreateOpportunityAndLead
Field possibleErrors was removed from object type RemoveBankDetailsForLead
Field possibleErrors was removed from object type TransferLedgerBalance
Field possibleErrors was removed from object type TriggerCollectionProcessMessage
Field possibleErrors was removed from object type CreateExternalMessage
Field possibleErrors was removed from object type AssignInkBucket
Field possibleErrors was removed from object type RevokeAgreement
Field possibleErrors was removed from object type InvalidateRefreshTokensForUser
Field possibleErrors was removed from object type CreateNewAgreementFromProductSwitchProcess
Field possibleErrors was removed from object type InitiateStandalonePayment
Field possibleErrors was removed from object type InitiateProductSwitch
Field possibleErrors was removed from object type UpdateAgentAuxiliaryStatus
Field possibleErrors was removed from object type UpdateCommsDeliveryPreference
Field possibleErrors was removed from object type RequestPrintedBill
Field possibleErrors was removed from object type EscalateInkConversation
Field possibleErrors was removed from object type UpdateAccountBillingEmail
Field possibleErrors was removed from object type UpdateAffiliateOrganisation
Field possibleErrors was removed from object type RedeemReferralClaimCode
Field possibleErrors was removed from object type CreatePartnerUser
Field possibleErrors was removed from object type CreateScheduledTransactions
Field possibleErrors was removed from object type GeneratePreSignedToken
Field possibleErrors was removed from object type CreateBusiness
Field possibleErrors was removed from object type UpdateSiteworksRequest
Field possibleErrors was removed from object type AwardLoyaltyPoints
Field possibleErrors was removed from object type UpdatePassword
Field possibleErrors was removed from object type TransferLeadOpportunities
Field possibleErrors was removed from object type RecordActivatedPaymentMethod
Field possibleErrors was removed from object type SubmitGasSelfReading
Field possibleErrors was removed from object type CreateAccountReference
Field possibleErrors was removed from object type RegisterEVChargerLead
Field possibleErrors was removed from object type UpdateAgreementRollover
Field possibleErrors was removed from object type StartCollectionProcess
Field possibleErrors was removed from object type CreateCustomerFeedback
Field possibleErrors was removed from object type InvalidatePreSignedTokensForUser
Field possibleErrors was removed from object type TransferLoyaltyPointsBetweenUsers
Field possibleErrors was removed from object type CreateOpportunityFileAttachment
Field possibleErrors was removed from object type UpdateLeadStage
Field possibleErrors was removed from object type UpdateMessageTags
Field possibleErrors was removed from object type AddChildToProperty
Field possibleErrors was removed from object type CreateLead
Field possibleErrors was removed from object type ConnectAiAgentToCall
Field possibleErrors was removed from object type BulkAwardLoyaltyPoints
Field possibleErrors was removed from object type BackendScreenEvent
Field possibleErrors was removed from object type RegisterCustomerAsset
Field possibleErrors was removed from object type SetOpportunityOutcome
Field possibleErrors was removed from object type AddPartnerUserToTeam
Field possibleErrors was removed from object type AcceptGoodsQuote
Field possibleErrors was removed from object type CreateAffiliateOrganisation
Field possibleErrors was removed from object type UpdateAccountReferralStatus
Field possibleErrors was removed from object type VerifyIdentity
Field possibleErrors was removed from object type CreateMfaDevice
Field possibleErrors was removed from object type UpdateCollectionProcessRecordToActive
Field possibleErrors was removed from object type AmendPayment
Field possibleErrors was removed from object type ScheduleQuoteFollowUp
Field possibleErrors was removed from object type UpdateCollectionProcessRecordLatestStep
Field possibleErrors was removed from object type RemovePropertyFromHierarchy
Field possibleErrors was removed from object type DeductLoyaltyPoints
Field possibleErrors was removed from object type UpdateOpportunityExtraDetails
Field possibleErrors was removed from object type CreateCollectionProcessEvent
Field possibleErrors was removed from object type CreateOfferGroupForQuoting
Field possibleErrors was removed from object type InvalidatePreSignedToken
Field possibleErrors was removed from object type CreateOrUpdateLoyaltyCardMutation
Field possibleErrors was removed from object type GenerateAffiliatesAudioRecordingPreSignedUrl
Field possibleErrors was removed from object type CreateAccountPaymentSchedule
Field possibleErrors was removed from object type UpdateDocumentAccessibilityPreference
Field possibleErrors was removed from object type VerifyCustomer
Field possibleErrors was removed from object type SetUpDirectDebitInstructionForBusiness
Field possibleErrors was removed from object type DeleteMfaDevice
Field possibleErrors was removed from object type InitiateHostedStandalonePayment
Field possibleErrors was removed from object type UpdateOfferGroupOnOpportunity
Field possibleErrors was removed from object type CreateComplaint
Field possibleErrors was removed from object type CreateAPIException
Field possibleErrors was removed from object type FetchGeneratePaymentFingerprint
Field possibleErrors was removed from object type CreateCampaignItems
Field possibleErrors was removed from object type UpdateOnSiteJobsRequest
Field possibleErrors was removed from object type ConfirmDoubleOptIn
Field possibleErrors was removed from object type UpdateOptionsLanguagePreference
Field possibleErrors was removed from object type RetireCustomerAsset
Field possibleErrors was removed from object type AssociateItemToCollectionProcess
Field possibleErrors was removed from object type CancelPayment
Field possibleErrors was removed from object type CreateQuoteForAccount
Field possibleErrors was removed from object type AddBusinessToSegmentMutation
Field possibleErrors was removed from object type SendOfferQuoteSummary
Field possibleErrors was removed from object type UpdateAgreementPeriod
Field possibleErrors was removed from object type CreateAPICall
Field possibleErrors was removed from object type AcceptOfferForQuoting
Field possibleErrors was removed from object type CloseOpenPrintBatch
Field possibleErrors was removed from object type UpdateActivePurchase
Field possibleErrors was removed from object type AddParentToProperty
Field possibleErrors was removed from object type UpdateNotesOnOpportunity
Field possibleErrors was removed from object type InvalidatePaymentInstruction
Field possibleErrors was removed from object type SendQuoteSummary
Field possibleErrors was removed from object type RecordPendingPayment
Field possibleErrors was removed from object type RegisterPhoneLead
Field possibleErrors was removed from object type SetUpDirectDebitInstructionFromStoredDetails
Field possibleErrors was removed from object type CreateInboundCall
Field possibleErrors was removed from object type DetachSupplyPointFromEstimationGroup
Field possibleErrors was removed from object type GenerateInkPresignedUrl
Field possibleErrors was removed from object type CreatePostEvents
Field possibleErrors was removed from object type NextOperationsTeamRoundRobin
Field possibleErrors was removed from object type CreateAPIExceptionEvent
Field possibleErrors was removed from object type StoreBankDetailsForLead
Field possibleErrors was removed from object type RemovePartnerUserFromTeam
Field possibleErrors was removed from object type LinkAccountToBusiness
Field possibleErrors was removed from object type DeletePushNotificationBinding
Field possibleErrors was removed from object type UpdateAccountUserConsents
Field possibleErrors was removed from object type RecordDepositAgreementAccepted
Field possibleErrors was removed from object type UpdateCampaignAccountExpiryDate
Field possibleErrors was removed from object type UpdateAgreementRescission
Field possibleErrors was removed from object type UpdateCollectionProcessRecordToComplete
Field possibleErrors was removed from object type StoreDirectDebitPaymentMethodDetails
Field possibleErrors was removed from object type BlockRepaymentSubmission
Field possibleErrors was removed from object type SendAgreementRescissionConfirmation
Field possibleErrors was removed from object type CreateGoodsQuoteWithoutAccount
Field possibleErrors was removed from object type DeleteAccountReference
Field possibleErrors was removed from object type RemoveCampaignItems
Field possibleErrors was removed from object type WithdrawDunning
Field possibleErrors was removed from object type RunAgreementRollover
Field possibleErrors was removed from object type AddPropertyToHierarchy
Field possibleErrors was removed from object type RevokePartnerUserAccess
Field possibleErrors was removed from object type PauseCollectionProcess
Field possibleErrors was removed from object type PurchaseVouchers
Field possibleErrors was removed from object type RecordSuccessfulPayment
Field possibleErrors was removed from object type CloseDCAProceeding
Field possibleErrors was removed from object type RecordFailedPayment
Field possibleErrors was removed from object type SubmitAllowedRepayment
Field possibleErrors was removed from object type ValidateMfaDevice
Field possibleErrors was removed from object type AddStorylineToInkConversation
Field possibleErrors was removed from object type CreateAudioRecording
Field possibleErrors was removed from object type UpdateOpportunityDetails
Field possibleErrors was removed from object type SelectProducts
Field possibleErrors was removed from object type UpdateAccountConsents
Field possibleErrors was removed from object type CloseInkConversation
Field possibleErrors was removed from object type CreateExternalMessageEvent
Field possibleErrors was removed from object type UpdateAutoTopUpAmount
Field possibleErrors was removed from object type ExtendAgreementPeriod
Field possibleErrors was removed from object type SwitchAccountToVariablePaymentSchedule
Field possibleErrors was removed from object type CreateGoodsPurchase
Field possibleErrors was removed from object type ShareGoodsQuote
Field possibleErrors was removed from object type PauseDunning
Field possibleErrors was removed from object type EndContributionAgreement
Field possibleErrors was removed from object type ObtainLongLivedRefreshToken
Field possibleErrors was removed from object type RemoveItemsFromRiskList
Field possibleErrors was removed from object type EnrollAccountInLoyaltyProgram
Field possibleErrors was removed from object type CreatePortfolioUserRole
Field possibleErrors was removed from object type CreateAccountReminder
Field possibleErrors was removed from object type StartCustomerVerification
Field possibleErrors was removed from object type CreateAPIExceptionNote
Field possibleErrors was removed from object type TerminateCreditTransferPermission
Field possibleErrors was removed from object type GenerateLeadsFileAttachmentDownloadPreSignedUrl
Field possibleErrors was removed from object type ApproveRepayment
Field possibleErrors was removed from object type AddItemsToRiskList
Field possibleErrors was removed from object type CreateQuote
Field possibleErrors was removed from object type CreateInternalCompany
Field possibleErrors was removed from object type CreateAffiliateLink
Field possibleErrors was removed from object type AddNoteToInkConversation
Field possibleErrors was removed from object type GenerateLeadsFileAttachmentsPreSignedUrl
Field possibleErrors was removed from object type UnenrollAccountFromLoyaltyProgram
Field possibleErrors was removed from object type ResumeCollectionProcess
Field possibleErrors was removed from object type CollectPayment
Field possibleErrors was removed from object type InvalidateRefreshToken
Field possibleErrors was removed from object type StorePaymentInstruction
Field possibleErrors was removed from object type MarkPrintBatchAsProcessed
Field possibleErrors was removed from object type CreatePaymentActionIntent
Field possibleErrors was removed from object type SubmitRepaymentRequest
Field possibleErrors was removed from object type PayoutReferralForAccount
Field possibleErrors was removed from object type CreateAgreement
Field possibleErrors was removed from object type VerifyEmail
Field possibleErrors was removed from object type SetLoyaltyPointsUser
Field possibleErrors was removed from object type CloseInkLiveChatConversation
Field possibleErrors was removed from object type GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
Field possibleErrors was removed from object type TerminateSolarWalletRelationship
Field possibleErrors was removed from object type UpdateAPIExceptionNote
Field possibleErrors was removed from object type FetchPreSignedLinkForOpportunityAttachment
Field possibleErrors was removed from object type CreateDepositAgreement
Field possibleErrors was removed from object type CreatePaymentMethodActionIntent
Field possibleErrors was removed from object type CreateReferral
Field possibleErrors was removed from object type CreateOnSiteJobsRequest
Field possibleErrors was removed from object type CreateExternalAccountUserEvent
Field possibleErrors was removed from object type AssociateArchivedCallRecordingsWithCalls
Field possibleErrors was removed from object type GetHostedUrlForNewPaymentInstruction
Field possibleErrors was removed from object type CollectDeposit
Field possibleErrors was removed from object type GetOrCreateAgreement
Field possibleErrors was removed from object type CreateGoodsQuote
Field possibleErrors was removed from object type PublishTransactionalMessagingExternalTrigger
Field possibleErrors was removed from object type AssignSupplyPointToEstimationGroup
Field possibleErrors was removed from object type CreateAccountCharge
Field possibleErrors was removed from object type UpdateOpportunityAssignment

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.
CreateOpportunityAndLeadInput.address type changed from RichAddressInput! to RichAddressInput
Field contactAddress was added to object type LeadContactDetailsType
Input Field contactAddress: RichAddressInput was added to input type LeadContactDetailsInput

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 AccountInterface.bills
Argument includeInvoices: Boolean added to Account.bills

Default value for input field ElectricityAgreementTransferEnrollmentMarketInput.requestedSupplyStartDateType changed from None to Undefined
Default value for input field ElectricityAgreementTransferEnrollmentMarketInput.requestedSupplyStartDate changed from Undefined to None
Default value for input field GasAgreementTransferEnrollmentMarketInput.requestedSupplyStartDate changed from Undefined to None
Default value for input field GasProductCatalogEnrollmentMarketInput.requestedSupplyStartDate changed from Undefined to None
Default value for input field GasProductCatalogEnrollmentMarketInput.requestedSupplyStartDateType changed from None to Undefined
Default value for input field ElectricityProductCatalogEnrollmentMarketInput.requestedSupplyStartDate changed from Undefined to None
Default value for input field ElectricityProductCatalogEnrollmentMarketInput.requestedSupplyStartDateType changed from None to Undefined

Enum value OCR was added to AccountPaymentTransactionTypeChoices enum

AffiliateOrganisationType.number type changed from String to String!

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

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

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

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

Input Field workScheduleIdentifier: String was added to input type ConnectAiAgentToCallInput

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

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 was added to LeadContactRoles enum
Enum value ACCOUNT_REPRESENTATIVE_WITH_AUTHORIZATION 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 dueDate was added to object type StatementDetailsBillingDocumentType
Field scheduledPaymentDate was added to object type StatementDetailsBillingDocumentType
Deprecation reason on field StatementDetailsBillingDocumentType.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

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
Enum value MANAGE_LCT_ORDERS was added to ExpiringTokenScope enum
Input Field goal: String was added to input type ConnectAiAgentToCallInput
Field revokePartnerUserAccess was added to object type Mutation

ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput.essentialIndicator type changed from EssentialIndicator! to EssentialIndicator

ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.atrTariff type changed from ElectricityATRChoices! to ElectricityATRChoices
ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.atrContractType type changed from ATRType! to ATRType

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

ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.essentialIndicator type changed from EssentialIndicator! to EssentialIndicator
ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.selfConsumptionType type changed from SelfConsumptionType! to SelfConsumptionType

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

Type AddPartnerUserToTeam was added
Type AddPartnerUserToTeamInput was added
Type ElectricityProductCatalogRetailerSwitchAdministrativeChangesInput was added
Type ElectricityProductCatalogRetailerSwitchTechnicalChangesInput was added
Type PowerControlType was added
Type Voltage was added
Type SocialBonus was added
Type SocialBonusRequest was added
Field addPartnerUserToTeam was added to object type Mutation
Input Field administrativeChanges: ElectricityProductCatalogRetailerSwitchAdministrativeChangesInput was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field technicalChanges: ElectricityProductCatalogRetailerSwitchTechnicalChangesInput was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Default value for input field ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput.subsectionType changed from None to Undefined
Field socialBonuses was added to object type ElectricitySupplyPoint

Enum value IPSI_REDUCED was added to TaxTypesCode enum
Enum value IPSI_STANDARD was added to TaxTypesCode enum
Enum value IPSI_EXEMPT was added to TaxTypesCode enum
Enum value IPSI_SUPERREDUCED was added to TaxTypesCode enum

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 'BASER' to Undefined

Type ElectricityProductCatalogRetailerSwitchAdministrativeChangesInput was removed
Type ElectricityProductCatalogRetailerSwitchTechnicalChangesInput was removed
Type PowerControlType was removed
Type Voltage was removed
Type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput was added
Input Field technicalChanges removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field administrativeChanges removed from input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field retailerSwitchWithChangeOfTenancyData: ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput was added to input type ElectricityProductCatalogEnrollmentMarketInput

Type ElectricityProductCatalogRetailerSwitchWithChangeOfTenancyEnrollmentMarketInput was removed
Type ElectricityProductCatalogRetailerSwitchAdministrativeChangesInput was added
Type ElectricityProductCatalogRetailerSwitchTechnicalChangesInput was added
Type PowerControlType was added
Type Voltage was added
Input Field retailerSwitchWithChangeOfTenancyData removed from input type ElectricityProductCatalogEnrollmentMarketInput
Input Field technicalChanges: ElectricityProductCatalogRetailerSwitchTechnicalChangesInput was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput
Input Field administrativeChanges: ElectricityProductCatalogRetailerSwitchAdministrativeChangesInput was added to input type ElectricityProductCatalogRetailerSwitchEnrollmentMarketInput

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

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

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

Type P0RejectionReasonCode was added
Field reasonDescription was added to object type P0DetailsRejection
P0DetailsRejection.reasonCode type changed from String to P0RejectionReasonCode
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 cubicMetres was added to ConsumptionUnit enum

Type TrancheTargetResidualFeeType was added
Type TrancheTargetResidualFeeMarketType was added
Type TrancheTargetResidualFeeInput was added
Type TrancheTargetResidualFeeMarketInput was added
Input Field storedPaymentMethodDetailsReference: String was added to input type EnrollmentInput
Input Field tranchetargetresidualfee: TrancheTargetResidualFeeInput was added to input type OneOfTermInput

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 QuoteBespokeRateConfigurationType
Field type was added to object type QuoteContractedVolumeConfigurationType

Type TimeOfUseSchemeType was added
Type TimeSlotWithActivationRuleType was added
Type SeasonType was added
Field rateGroupTouScheme was added to object type Query

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 paymentUuid was added to object type AccountRepaymentType

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

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

Please use uuid instead.

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

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

Field uuid was added to object type AccountPaymentType

PartnerUserType.organisation type changed from AffiliateOrganisationType! to AffiliateOrganisationType

Type PossibleError was added
Type RateLimit was added

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

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

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

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

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

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

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

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

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

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

Enum value RATES_REQUEST_FAILED was added to QuoteConfigurationStatus enum

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

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

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

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

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

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

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

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

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

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

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

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

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

Enum value FCM was added to NotifiableApplicationExternalProvider enum

Type QuoteContractedVolumeConfigurationType was added
Type QuoteContractedVolumePeriodType was added

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

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

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

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

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

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

Enum value ANZ was added to Vendor enum

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

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

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

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

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

Enum value MEGAWATT_HOURS was added to Units enum

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

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

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

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

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

Enum value DEBT_DISCONNECTION was added to LeaveSupplierSubType enum

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

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

Please use 'assignedToTeamIdentifier' instead.

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

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

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

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

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

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

Enum value UNSUPPORTED_FEATURE was removed from AccountReminderTypes enum

CreateReminderInput.dueAt type changed from DateTime! to DateTime

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

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

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

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

This is no longer being used.

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

Enum value SAP was added to OnSiteJobsAgent enum

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

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

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

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

Please use 'assignedToTeamIdentifier' instead.

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

Please use 'assignedToUserIdentifier' instead.

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

Please use 'assignedToUserIdentifier' instead.

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

Please use 'assignedToTeamIdentifier' instead.

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

Please use 'assignedToUserIdentifier' instead.

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

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

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

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

Enum value AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING was removed from AccountReminderTypes enum

Enum value INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE was removed from AccountReminderTypes enum

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

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

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

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

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

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

Field textRegex was added to object type FunnelField

Enum value IEE_MINIMUM_B2B was added to TaxTypesCode enum

Enum value INVALID was added to LifecycleSupplyPointProcessStatus enum

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

Enum value ADYEN was added to Vendor enum

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

Enum value FIELDWORKS_SERVICE_ORDER_STATUS_UPDATED was removed from AccountReminderTypes enum

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

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

Fields are not being deprecated

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

Is not necessary since fields are part of a collection

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

Enum value INDUSTRY_WARNING_MESSAGE_RECEIVED was removed from AccountReminderTypes enum

Enum value REQUESTED was removed from OnSiteJobsAssetStatus enum

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

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

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

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

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

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

Field id was added to object type AccountNoteType

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

Enum value READ was added to InkMessageDeliveryStatus enum

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

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

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

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

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

Enum value IFS was added to OnSiteJobsAgent enum

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

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

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

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

Field isReversed was added to object type VoucherRedemptionType

Field extraData was added to object type JoinSupplierProcessDataType

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

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

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

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

Enum value CUSTOM was added to PaymentType enum

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

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

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

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

Argument excludeByDisplayName: [String] added to Query.vouchersForAccount

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

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

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

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

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

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

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

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

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

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

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

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

Please use externalJobTypeMapping instead.

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

Use postCredit mutation as it is ledger aware.

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

Use postCredit mutation as it is ledger aware.

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

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

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

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

Field a529Validation was removed from object type Query

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

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

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

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

Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from AccountReminderTypes enum

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

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

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

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

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

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

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

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

Input Field externalIdentifier: String was added to input type SimpleServicesEnrollmentMarketInput

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

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

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

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

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

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

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

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

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

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