GraphQL API Changelog
This page shows the history of changes to the GraphQL schema.- Field paymentUuid was added to object type
AccountRepaymentType
- Type
_BooleanParamwas added - Input Field boolean: _BooleanParam was added to input type
_QuotingParam
- Enum value Smc was added to
ConsumptionUnitenum - Deprecation reason on field
AccountPaymentType.id changed from None toThe '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
ExtraDetailFieldTypewas added ExtraDetailInput.fieldValue type changed from String to String!ExtraDetailInput.fieldType type changed from String to ExtraDetailFieldType!
- Field uuid was added to object type
AccountPaymentType PartnerUserType.organisation type changed from AffiliateOrganisationType! to AffiliateOrganisationType
- Type
PossibleErrorwas added - Type
RateLimitwas added
- Type
ExtraQuotingParamsTypewas added - Type
ForecastConsumptionEntryTypewas added - Type
ConsumptionSplitTypewas added - Type
ForecastConsumptionEntryInputwas added - Type
ConsumptionSplitInputwas added - Input Field forecastConsumptionEntries: [ForecastConsumptionEntryInput] was added to input type
UpdateQuoteConfigurationInput - Field extraQuotingParams was added to object type
QuoteConfigurationType
- Type
SupplyPointTypewas removed - Type
CommonSupplyPointInterfacewas removed - Type
HasReadingswas removed - Type
Unitswas removed - Type
DevicesConnectionwas removed - Type
DevicesEdgewas removed - Type
Devicewas removed - Type
RegistersConnectionwas removed - Type
RegistersEdgewas removed - Type
DeviceRegisterwas removed - Type
WaterSupplyPointTypewas added - Field externalIdentifier of type String was added to interface
SupplyPointInterface MarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointType to SupplyPointInterface- Field externalIdentifier was added to object type
ElectricitySupplyPointType CommonAgreementType.supplyPoint type changed from SupplyPointType! to SupplyPointInterface!- Field externalIdentifier was added to object type
GasSupplyPointType Query.supplyPoint type changed from SupplyPointType to SupplyPointInterfaceSupplyPointConnectionTypeEdge.node type changed from SupplyPointType to SupplyPointInterface
- Type
SendAgreementRescissionConfirmationwas added - Type
SendAgreementRescissionMessageInputwas added - Field sendAgreementRescissionConfirmation was added to object type
Mutation
- Deprecation reason on field
LeadOutput.assignedToTeamIdentifier changed from None toThe 'assignedToTeamIdentifier' field is deprecated.
Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19. - Deprecation reason on field
LeadOutput.assignedToAffiliateNumber changed from None toThe 'assignedToAffiliateNumber' field is deprecated.
Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19. - Deprecation reason on field
LeadOutput.assignedToUserIdentifier changed from None toThe 'assignedToUserIdentifier' field is deprecated.
Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
- Type
QuoteBillDueDateConfigurationTypewas added - Input Field emergencyApprovalDetails removed from input type
CreateOnSiteJobsRequestInputType
- Enum value RATES_REQUEST_FAILED was added to
QuoteConfigurationStatusenum
- Enum value PENDING_VALIDATION was added to
AgreementRolloverStatusenum - Enum value VALIDATING was added to
AgreementRolloverStatusenum - Enum value PENDING_VALIDATION was added to
RolloverStatusenum - Enum value VALIDATING was added to
RolloverStatusenum
- Type
StartOnSiteJobsAppointmentBookingSessionwas removed - Type
StartOnSiteJobsAppointmentBookingSessionForRequestwas added - Field startOnSiteJobsAppointmentBookingSessionForRequest was added to object type
Mutation - Field startOnSiteJobsAppointmentBookingSession was removed from object type
Mutation
- Type
WaterSupplyPointTypewas removed - Type
SupplyPointTypewas added - Type
CommonSupplyPointInterfacewas added - Type
HasReadingswas added - Type
Unitswas added - Type
DevicesConnectionwas added - Type
DevicesEdgewas added - Type
Devicewas added - Type
RegistersConnectionwas added - Type
RegistersEdgewas added - Type
DeviceRegisterwas added CommonAgreementType.supplyPoint type changed from SupplyPointInterface! to SupplyPointType!SupplyPointConnectionTypeEdge.node type changed from SupplyPointInterface to SupplyPointTypeQuery.supplyPoint type changed from SupplyPointInterface to SupplyPointTypeMarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointInterface to SupplyPointType
- Type
BillRepresentationContextTypewas added - Field context was added to object type
BillRepresentationType - Field accountUser was added to object type
Message - Field id was added to object type
Message - Field account was added to object type
Message - Field message was added to object type
Query
- Type
SupplyPointTypewas removed - Type
CommonSupplyPointInterfacewas removed - Type
HasReadingswas removed - Type
Unitswas removed - Type
DevicesConnectionwas removed - Type
DevicesEdgewas removed - Type
Devicewas removed - Type
RegistersConnectionwas removed - Type
RegistersEdgewas removed - Type
DeviceRegisterwas removed - Type
WaterSupplyPointTypewas added CommonAgreementType.supplyPoint type changed from SupplyPointType! to SupplyPointInterface!SupplyPointConnectionTypeEdge.node type changed from SupplyPointType to SupplyPointInterfaceMarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointType to SupplyPointInterfaceQuery.supplyPoint type changed from SupplyPointType to SupplyPointInterface
- Field isFinal was added to object type
StatementBillingDocumentType
- Type
PartnerUserTypewas added - Type
PartnerUserPermissionwas added - Field partnerUser was added to object type
Query - Enum value REJECTED was added to
QuoteConfigurationStatusenum - Enum value READY was added to
QuoteConfigurationStatusenum - Enum value ACCEPTED was added to
QuoteConfigurationStatusenum - Enum value SENT was added to
QuoteConfigurationStatusenum - Enum value FINALISED was removed from
QuoteConfigurationStatusenum
- Default value for input field
CancelOnSiteJobsAppointmentInputType.alignRequestStatus changed from False to True
- Type
UpdateLeadAssignmentwas removed - Type
UpdateLeadAssignmentInputwas removed - Deprecation reason on field
Lead.assignedToTeamIdentifier changed from None toThe 'assignedToTeamIdentifier' field is deprecated.
Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19. - Deprecation reason on field
Lead.assignedToUserIdentifier changed from None toThe 'assignedToUserIdentifier' field is deprecated.
Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19. - Field updateLeadAssignment was removed from object type
Mutation
- Type
QuoteConfigurationStatuswas added - Input Field status: QuoteConfigurationStatus was added to input type
UpdateQuoteConfigurationInput - Field status was added to object type
QuoteConfigurationType
- Type
CompleteReminderwas added - Type
CompleteReminderInputwas added - Field completeReminder was added to object type
Mutation
- Type
AttachAgreementsToContractsOutputwas added - Type
AttachAgreementsToContractsInputwas added - Type
DetachAgreementsFromContractsOutputwas added - Type
DetachAgreementsFromContractsInputwas added - Field detachAgreementsFromContracts was added to object type
Mutation - Field attachAgreementsToContracts was added to object type
Mutation
- Enum value ADDITIONAL_CHARGE was added to
BandCategoryenum
- Enum value FCM was added to
NotifiableApplicationExternalProviderenum
- Type
QuoteContractedVolumeConfigurationTypewas added - Type
QuoteContractedVolumePeriodTypewas added
- Deprecation reason on field
Lead.salesChannel changed from None toThe 'salesChannel' field is deprecated.
Sales channel information is being removed from theLeadmodel. 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 toThe 'salesChannel' field is deprecated.
Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity.
- Marked as deprecated on 2025-06-17.
- Scheduled for removal on or after 2025-10-17.
- Enum value ANZ was added to
Vendorenum
- Type
AccountDebtPositionTypewas added - Type
LedgerDebtPositionTypewas added - Type
LedgerDebtPositionStatuswas added - Field accountDebtPosition was added to object type
Query
- Field ratesAgreedAt was added to object type
DistributionAgreementType - Field ratesAgreedAt was added to object type
SimpleServicesAgreementType - Field ratesAgreedAt was added to object type
GasAgreementType - Field ratesAgreedAt of type DateTime was added to interface
AusAgreementInterface - Field ratesAgreedAt was added to object type
CommonAgreementType - Field ratesAgreedAt was added to object type
ElectricityAgreementType
- Type
ValidateAddresswas added - Type
ValidateAddressInputwas added - Type
AddressFieldGroupInputwas added - Type
AddressFieldInputwas added - Field errors was added to object type
AddressFieldConfigType - Field validateAddress was added to object type
Mutation
- Type
PartnerViewerTypewas added - Type
PartnerViewerPermissionwas added - Field partnerViewer was added to object type
Query
- Type
RecordActivatedPaymentMethodwas added - Type
PaymentMethodTypewas added - Type
RecordActivatedPaymentMethodInputwas added - Type
PaymentMethodActionIntentOneOfInputwas added - Type
PaymentMethodActionIntentOptionsInputwas added - Type
PaymentMethodActionIntentTargetTypewas added - Type
FinancialAccountDetailsOneOfInputwas added - Type
CardDetailsInputwas added - Type
BACSDirectDebitDetailsInputwas added - Type
SEPADirectDebitDetailsInputwas added - Type
ACHDirectDebitDetailsInputwas added - Type
AusBECSDirectDebitDetailsInputwas added - Type
ACSSDebitDetailsInputwas added - Type
NzlBECSDirectDebitDetailsInputwas added - Type
JPNDirectDebitDetailsInputwas added - Type
BPAYDetailsInputwas added - Field recordActivatedPaymentMethod was added to object type
Mutation - Enum value CHARGEBACK was added to
RepaymentReasonenum
RateInterface.rateIncludingTax type changed from Float! to FloatRateInterface.rateExcludingTax type changed from Float! to FloatProductRateType.rateIncludingTax type changed from Float! to FloatProductRateType.rateExcludingTax type changed from Float! to FloatGasRateType.rateIncludingTax type changed from Float! to FloatGasRateType.rateExcludingTax type changed from Float! to FloatElectricityRateType.rateIncludingTax type changed from Float! to FloatElectricityRateType.rateExcludingTax type changed from Float! to Float
- Field ptjNumber was removed from object type
NotifiedPartyTransactionType
- Enum value MEGAWATT_HOURS was added to
Unitsenum
- Type
CompleteApprovalwas added - Type
CompletedApprovalwas added - Type
CompleteApprovalInputTypewas added - Field completeApproval was added to object type
Mutation
OnSiteJobsCreateAppointmentInput.jobType type changed from String! to NonEmptyString!
- Enum value PREMISES_NETWORK_SERVICE_PROVIDER was added to
C4RequestRoleTypeenum
- Argument displayableNumber: String added to
Query.business - Field displayableNumber was added to object type
BusinessType
- Type
AddressFieldDescriptorTypewas added - Type
AddressFieldGroupTypewas added - Type
AddressFieldConfigTypewas added - Type
AddressFieldTypeEnumwas added - Type
AddressFieldValidationRuleTypewas added - Type
AddressFieldOptionTypewas 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
LeaveSupplierSubTypeenum
- Deprecation reason on field
NotifiedPartyTransactionType.ptjNumber changed from None toThe 'ptjNumber' field is deprecated.
This field is always null. There are no scenarios where a PTJ (internal job) is linked to a notified party transaction.
- Marked as deprecated on 2026-05-11.
- Scheduled for removal on or after 2026-08-11.
- Type
CollectionProcessStepStatuswas 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 toThe 'assignedToOrganization' field is deprecated.
Please use 'assignedToTeamIdentifier' instead.
- Marked as deprecated on 2026-05-07.
- Scheduled for removal on or after 2026-07-07.
- Field estimateMeterReadings was added to object type
Query
- Type
ReadingQualityMetawas added - Type
MeterDataQualitieswas added - Field qualities was added to object type
Reading
- Type
AccountUserDetailInputwas added
- Type
UpdateCollectionProcessRecordLatestStepwas added - Type
UpdateCollectionProcessRecordLatestStepOutputTypewas added - Type
CollectionProcessStepTypewas added - Type
UpdateCollectionProcessRecordLatestStepInputTypewas added - Field updateCollectionProcessRecordLatestStep was added to object type
Mutation
- Enum value UNSUPPORTED_FEATURE was removed from
AccountReminderTypesenum
- Type
DistributedEnergyResourceTypewas added - Field distributedEnergyResources was added to object type
MeterPointType
- Type
TariffChangeAutoDeterminationAndAssignmentwas added - Type
TariffChangeAutoDeterminationAndAssignmentOutcomewas added - Field tariffChangeAutoDeterminationAndAssignment was added to object type
Mutation
- Enum value SAR_HALALAS was added to
LineItemCurrencyenum
CreateReminderInput.dueAt type changed from DateTime! to DateTime
- Type
RetireCustomerAssetwas added - Type
RetireCustomerAssetInputwas added - Field retireCustomerAsset was added to object type
Mutation
- Type
RepaymentReasonwas 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 toThe '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
OnSiteJobsAgentenum
- Type
BaseInstigateContractTerminationInputwas removed - Type
ContractTerminationInstigatedwas removed - Field instigateContractTermination was removed from object type
Mutation
- Enum value REQUIRES_TIMESLOT was added to
OnSiteJobsAppointmentStatusenum
- Type
UpdateQuoteConfigurationOutputwas added - Type
UpdateQuoteConfigurationInputwas added - Type
BespokeRateTermInputwas added - Type
UpdateBespokeRateScheduleInputwas added - Type
UpdateBespokeRateItemInputwas added - Type
ExtraDetailInputwas added - Field updateQuoteConfiguration was added to object type
Mutation
ElectricityRegisterType.status type changed from RegisterStatus! to RegisterStatus
- Input Field assignedToTeamIdentifier: String was added to input type
CreateLeadInput - Input Field assignedToUserIdentifier: String was added to input type
CreateLeadInput - Input Field assignedToTeamIdentifier: String was added to input type
OpportunitiesQueryInput - Input Field assignedToUserIdentifier: String was added to input type
OpportunitiesQueryInput - Field assignedToTeamIdentifier was added to object type
OpportunityOutput - Field assignedToUserIdentifier was added to object type
OpportunityOutput - Deprecation reason on field
OpportunityOutput.assignedToUser changed from None toThe 'assignedToUser' field is deprecated.
Please use 'assignedToUserIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22. - Deprecation reason on field
OpportunityOutput.assignedToTeam changed from None toThe 'assignedToTeam' field is deprecated.
Please use 'assignedToTeamIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22. - Field assignedToTeamIdentifier was added to object type
Lead - Field assignedToUserIdentifier was added to object type
Lead - Deprecation reason on field
Lead.assignedToUsername changed from None toThe 'assignedToUsername' field is deprecated.
Please use 'assignedToUserIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22. - Input Field assignedToTeamIdentifier: String was added to input type
LeadsQueryInput - Input Field assignedToUserIdentifier: String was added to input type
LeadsQueryInput - Input Field assignedToTeamIdentifier: String was added to input type
CreateOpportunityForLeadInput - Input Field assignedToUserIdentifier: String was added to input type
CreateOpportunityForLeadInput - Input Field assignedToTeamIdentifier: String was added to input type
UpdateOpportunityAssignmentInput - Input Field assignedToUserIdentifier: String was added to input type
UpdateOpportunityAssignmentInput - Input Field assignedToTeamIdentifier: String was added to input type
UpdateLeadAssignmentInput - Input Field assignedToUserIdentifier: String was added to input type
UpdateLeadAssignmentInput - Input Field assignedToTeamIdentifier: String was added to input type
CreateOpportunityAndLeadInput - Input Field assignedToUserIdentifier: String was added to input type
CreateOpportunityAndLeadInput - Field assignedToTeamIdentifier was added to object type
LeadOutput - Field assignedToUserIdentifier was added to object type
LeadOutput - Deprecation reason on field
LeadOutput.assignedToUser changed from None toThe 'assignedToUser' field is deprecated.
Please use 'assignedToUserIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22. - Deprecation reason on field
LeadOutput.assignedToTeam changed from None toThe 'assignedToTeam' field is deprecated.
Please use 'assignedToTeamIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22. - Input Field assignedToTeamIdentifier: String was added to input type
UpdateLeadDetailsInput - Input Field assignedToUserIdentifier: String was added to input type
UpdateLeadDetailsInput
- Type
RescindContractOutputwas added - Type
RescindContractInputwas added - Field rescindContract was added to object type
Mutation - Field rescindedAt was added to object type
ContractDetails - Field rescindedAt was added to object type
Contract
- Enum value CANCELLED_BY_SUPPLIER was added to
OnSiteJobsAppointmentCancellationCategoryenum
- Field source was removed from object type
Reading - Field quality was removed from object type
Reading
- Type
LocaltimeMidnightAlignedDateFieldwas removed CreateContractInput.signedAtDate type changed from LocaltimeMidnightAlignedDateField to IndustryMidnightAlignedDateField
- Enum value AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING was removed from
AccountReminderTypesenum
- Enum value INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE was removed from
AccountReminderTypesenum
- Input Field device: String was added to input type
AccountSearchInputType - Enum value SOLAR_EXPORT_CREDITS_EXCESS was removed from
AccountReminderTypesenum
- Type
LocaltimeMidnightAlignedDateFieldwas added - Input Field validToDate: IndustryMidnightAlignedDateField was added to input type
CreateContractInput - Input Field signedAtDate: LocaltimeMidnightAlignedDateField was added to input type
CreateContractInput - Input Field validFromDate: IndustryMidnightAlignedDateField was added to input type
CreateContractInput CreateContractInput.signedAt type changed from DateTime! to DateTimeCreateContractInput.validFrom type changed from DateTime! to DateTime- Enum value METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_ACCEPTED was removed from
AccountReminderTypesenum
- Type
IndustryMidnightAlignedDateFieldwas added - Input Field applicableAtDate: IndustryMidnightAlignedDateField was added to input type
VaryContractTermsInput - Input Field validToDate: IndustryMidnightAlignedDateField was added to input type
TerminateContractInput TerminateContractInput.validTo type changed from DateTime! to DateTime- Input Field validFromDate: IndustryMidnightAlignedDateField was added to input type
ActualizeContractInput ActualizeContractInput.validFrom type changed from DateTime! to DateTime
- Type
SMSContentInputwas 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
AgreementRolloverStatusenum - Enum value NEEDS_ATTENTION was added to
RolloverStatusenum
- Type
LeadTypewas added - Type
PurchaseVoucherswas added - Field purchaseVouchers was added to object type
Mutation - Field lead was added to object type
PaymentInstructionOwnerType
- Field cancelledAt was added to object type
OnSiteJobsAppointmentType
- Type
ServiceOrderResponseStatuswas removed ServiceOrderCompletionDetails.closureCode type changed from ServiceOrderResponseStatus! to ServiceOrderStatus!
- Deprecation reason on field
Mutation.makePaymentWithSavedCard changed fromThe 'makePaymentWithSavedCard' field is deprecated.
to
This mutation only appliesclients using the legacy finanicals system. Use collectPayment instead.
- Marked as deprecated on 2025-05-26.
- Scheduled for removal on or after 2026-05-26. to The 'makePaymentWithSavedCard' field is deprecated.
This mutation only applies to clients using the legacy finanicals system. Use collectPayment instead.
- Marked as deprecated on 2025-05-26.
- Scheduled for removal on or after 2026-07-26.
- Field textRegex was added to object type
FunnelField
- Enum value CANCELLED_BY_SUPPLIER was removed from
OnSiteJobsAppointmentCancellationCategoryenum
- Enum value INVALID was added to
LifecycleSupplyPointProcessStatusenum
- Field fieldValue was added to object type
QuoteConfigurationExtraDetailItemType - Field fieldType was added to object type
QuoteConfigurationExtraDetailItemType - Field fieldCode was added to object type
QuoteConfigurationExtraDetailItemType - Field value was removed from object type
QuoteConfigurationExtraDetailItemType - Field code was removed from object type
QuoteConfigurationExtraDetailItemType - Field valueType was removed from object type
QuoteConfigurationExtraDetailItemType
- Enum value ADYEN was added to
Vendorenum
- Type
QuoteBespokeRateConfigurationTypewas added - Type
QuoteTermInterfacewas added - Type
QuoteBespokeRateScheduleTypewas added - Type
QuoteBespokeRateItemTypewas added - Type
QuoteConfigurationVariantProfileTypewas added - Type
QuoteConfigurationTypewas added - Type
QuoteConfigurationExtraDetailItemTypewas added - Enum value GAS_READING_REMOVED_INSTALLED_RECEIVED was removed from
AccountReminderTypesenum - Field quoteConfigurationByNumber was added to object type
Query
- Default value for input field
OnSiteJobsUpdateAppointmentInput.status changed from None to Undefined - Default value for input field
OnSiteJobsUpdateAppointmentInput.commsStrategy changed from None to Undefined - Default value for input field
OnSiteJobsUpdateAppointmentInput.jobDetails changed from None to Undefined - Default value for input field
OnSiteJobsUpdateAppointmentInput.cancellationCategory changed from None to Undefined - Enum value FIELDWORKS_SERVICE_ORDER_STATUS_UPDATED was removed from
AccountReminderTypesenum
- Enum value GAS_EXCEPTION_CUSTOMER_TRANSFER_CANCELLED was removed from
AccountReminderTypesenum - Field isOfficial was added to object type
ComplaintType
- Field inkLiveChatConversations was added to object type
Query - Field isWorkRequiredForServiceOrder was added to object type
Query - Enum value ACCURACY_TEST was removed from
OnSiteJobsWorkCategoryenum - Field stepName was removed from object type
AgreementRescissionType - Type
ProductTypewas removed - Type
PublishApprovalApprovedEventwas removed - Type
PublishApprovalApprovedEventInputwas removed - Type
InstigateContractVariationOutputwas removed - Type
InstigateContractVariationInputwas removed - Type
CatalogProductTypeEnumwas added - Type
InkConversationsConnectionwas added - Type
InkConversationsEdgewas added - Type
ExtendAgreementPeriodwas added - Type
ExtendAgreementPeriodInputwas added - Type
IsWorkRequiredForServiceOrderTypewas added - Type
CompleteServiceOrderwas added - Type
CompleteServiceOrderInputwas added - Type
ServiceOrderCompletionDetailswas added - Type
ServiceOrderResponseStatuswas added - Type
ServiceOrderChargeInputwas added - Type
SimpleServicesAgreementTypewas added - Type
AssociateArchivedRecordingsSummaryTypewas added - Type
AssociateArchivedRecordingResultTypewas added - Type
AssociateArchivedRecordingResultStatuswas added - Type
StartOnSiteJobsAppointmentReschedulingSessionwas added - Type
SetLastConsumerChangeDateRecordToBeExpiredwas added - Type
SetLastConsumerChangeDateRecordToBeExpiredInputwas added - Field results was added to object type
AssociateArchivedCallRecordingsWithCalls - Field summary was added to object type
AssociateArchivedCallRecordingsWithCalls - Field receivedCount was removed from object type
AssociateArchivedCallRecordingsWithCalls - Field params was added to object type
Reminder - Field stepSlug was removed from object type
AgreementRescissionType - Input Field assignedToAffiliateNumber: String was added to input type
UpdateLeadAssignmentInput - Field lastMessageAt was added to object type
InkConversation - Field completeServiceOrder was added to object type
Mutation - Field extendAgreementPeriod was added to object type
Mutation - Field startOnSiteJobsAppointmentReschedulingSession was added to object type
Mutation - Field setLastConsumerChangeDateRecordToBeExpired was added to object type
Mutation - Field instigateContractVariation was removed from object type
Mutation - Field publishApprovalApprovedEvent was removed from object type
Mutation - Removed argument appointmentIdToReschedule from
Mutation.startOnSiteJobsAppointmentBookingSession - Field required was added to object type
FunnelField - Deprecation reason on field
FunnelField.deprecated changed from None toThe 'deprecated' field is deprecated.
Fields are not being deprecated
- Marked as deprecated on 2026-04-20.
- Scheduled for removal on or after 2026-05-20. - Input Field assignedToAffiliateNumber: String was added to input type
UpdateOpportunityAssignmentInput - Enum value RESCINDED was added to
ContractStatusenum - Field conversationRelayId was added to object type
EscalateInkConversation - Field conversation was removed from object type
EscalateInkConversation - Input Field archivedRecordingFileUri: URI! was added to input type
ArchivedCallRecordingInput - Input Field publicRecordingFileUri removed from input type
ArchivedCallRecordingInput - Input Field accountNumber: String! was added to input type
EscalateInkConversationInput - Field preferredDate was added to object type
WorkRequestSpecOutputType - Input Field flowRunIdentifier: String! was added to input type
PublishMeterDataIssueEmailInput - Field label was added to object type
QuotingParamType - Deprecation reason on field
SalesFunnel.uncollectedFields changed from None toThe 'uncollectedFields' field is deprecated.
Is not necessary since fields are part of a collection
- Marked as deprecated on 2026-04-20.
- Scheduled for removal on or after 2026-05-20. - Input Field params: JSONString was added to input type
CreateReminderInput - Input Field stepSlug removed from input type
UpdateAgreementRescissionInput - Input Field stepName removed from input type
UpdateAgreementRescissionInput - Enum value AWAITING_APPROVAL was added to
CatalogComponentStatusenum CatalogProductType.sourceProductType type changed from ProductType toCatalogProductTypeEnum- Enum value INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CANCELLED was removed from
AccountReminderTypesenum - Enum value INDUSTRY_EXCEPTION_CHANGE_REQUEST_COMPLETED was removed from
AccountReminderTypesenum - Enum value JPN_SUPPLY_POINT_FAILS_CAN_SUPPLY_CHECK was removed from
AccountReminderTypesenum - Enum value INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_NEXT_SCHEDULED_READ_DATE_PAST was removed from
AccountReminderTypesenum - Enum value INDUSTRY_MANUAL_ACTION_REQUIRED was removed from
AccountReminderTypesenum - Enum value JPN_SHORT_TERM_MOVE_IN_REJECTION was removed from
AccountReminderTypesenum - Enum value CANCELLED_BY_BUSINESS was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_SUPPLIER was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was removed from
OnSiteJobsAppointmentCancellationCategoryenum - Input Field assignedToTeamName: String was added to input type
UpdateLeadDetailsInput - Input Field assignedToAffiliateNumber: String was added to input type
UpdateLeadDetailsInput - Input Field assignedToUsername: String was added to input type
UpdateLeadDetailsInput - Enum value UPDATE_IN_PROGRESS was added to
LifecycleSupplyPointProcessStatusenum - Enum value UPDATE_ERRORED was added to
LifecycleSupplyPointProcessStatusenum - Enum value UPDATE_STALLED was added to
LifecycleSupplyPointProcessStatusenum - Enum value UPDATE_FAILED was added to
LifecycleSupplyPointProcessStatusenum - Input Field externalPropertyReference: String was added to input type
AccountSearchInputType - Enum value GIGAJOULES_CONSUMPTION was added to
UnitTypeenum - Enum value COMMS_HUB_REPLACEMENT was removed from
OnSiteJobsWorkCategoryenum - Enum value IHD_INSTALL was removed from
OnSiteJobsWorkCategoryenum - Enum value INVESTIGATE_FAULT was removed from
OnSiteJobsWorkCategoryenum - Enum value REINSTALL was removed from
OnSiteJobsWorkCategoryenum - Enum value REPLACE_SEALS was removed from
OnSiteJobsWorkCategoryenum - Enum value AD_HOC_READING was removed from
OnSiteJobsWorkCategoryenum - Enum value COMMISSION was removed from
OnSiteJobsWorkCategoryenum - Enum value REMOVE was removed from
OnSiteJobsWorkCategoryenum - Enum value MOVE was removed from
OnSiteJobsWorkCategoryenum - Enum value EXCHANGE was removed from
OnSiteJobsWorkCategoryenum - Enum value COMMS_HUB_POWER_CYCLE was removed from
OnSiteJobsWorkCategoryenum - Enum value CONFIRM_METER_DETAILS was removed from
OnSiteJobsWorkCategoryenum - Enum value ISOLATOR_SWITCH_INSTALL was removed from
OnSiteJobsWorkCategoryenum - Enum value BRACKET_INSTALLATION was removed from
OnSiteJobsWorkCategoryenum - Enum value METER_TAILS_UPGRADE was removed from
OnSiteJobsWorkCategoryenum - Enum value NEW_CONNECTION was removed from
OnSiteJobsWorkCategoryenum - Enum value EV was removed from
OnSiteJobsWorkCategoryenum
- Enum value INDUSTRY_WARNING_MESSAGE_RECEIVED was removed from
AccountReminderTypesenum
- Enum value REQUESTED was removed from
OnSiteJobsAssetStatusenum
- Type
CreatePaymentMethodActionIntentwas added - Type
CreatePaymentMethodActionIntentInputwas added - Type
PaymentMethodOwnerInputwas added - Field createPaymentMethodActionIntent was added to object type
Mutation
DetermineDefaultTariffInput.actualChangeDate type changed from Date! to DateTime!
- Type
UpdateOptionsLanguagePreferencewas added - Type
OptionsLanguagePreferenceChoiceswas added - Type
OptionsLanguagePreferenceInputwas added - Field updateOptionsLanguagePreference was added to object type
Mutation
- Type
DetermineDefaultTariffwas added - Type
RegisterTariffAssignmentwas added - Type
DetermineDefaultTariffInputwas added - Field determineDefaultTariff was added to object type
Mutation
- Type
EscalateInkConversationwas added - Type
EscalateInkConversationInputwas added - Enum value ESCALATE_INK_CONVERSATION was added to
ExpiringTokenScopeenum - Field escalateInkConversation was added to object type
Mutation - Enum value ESCALATE_INK_CONVERSATION was added to
PreSignedTokenScopeenum
- Type
AssociateArchivedCallRecordingsWithCallswas added - Type
AssociateArchivedCallRecordingsWithCallsInputwas added - Type
ArchivedCallRecordingInputwas added - Type
URIwas added - Field associateArchivedCallRecordingsWithCalls was added to object type
Mutation
- Input Field contractNote: ContractNoteInput was added to input type
TerminateContractInput - Field id was added to object type
AccountNoteType - Input Field contractNote: ContractNoteInput was added to input type
VaryContractTermsInput - Field note was added to object type
CreateAccountNote
- Input Field recipientEmails: String was added to input type
PublishMeterDataIssueEmailInput
- Type
OpenedInputwas added - Type
CreateExternalMessageEventwas added - Type
ExternalMessageEventTypewas added - Type
MessageEventTypewas added - Type
CreateExternalMessageEventInputwas added - Type
DeliveryFailedInputwas added - Type
DeferredInputwas added - Type
ClickedInputwas 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
InkMessageDeliveryStatusenum
- Field stage was added to object type
JoinSupplierProcessType - Field stage was added to object type
LeaveSupplierProcessType
- Deprecation reason on field
Mutation.instigateContractTermination changed from None toThe 'instigateContractTermination' field is deprecated.
This is a legacy mutation. The terminateContract mutation should be used instead.
- Marked as deprecated on 2026-04-01.
- Scheduled for removal on or after 2026-04-30.
- Type
ConcessionCardValidationMethodwas removed ConcessionCardValidationType.method type changed from ConcessionCardValidationMethod to String
- Field request was added to object type
OnSiteJobsAppointmentType - Enum value POST_APPOINTMENT_RESCHEDULED was added to
OnSiteJobsAppointmentActionTriggerStageenum
- Type
NotifiedPartyTransactionTypewas added - Field notifiedPartyTransactions was added to object type
Query
- Type
SendLifeSupportRequestwas added - Type
SendLifeSupportRequestInputwas added - Type
LifeSupportRequestReasonwas added - Field sendLifeSupportRequest was added to object type
Mutation - Input Field initiatingParticipantId: String was added to input type
EssentialEnergyAppointmentJobDetailsInput
- Enum value IFS was added to
OnSiteJobsAgentenum
- Field billingTriggerConfiguration was added to object type
LedgerType - Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface
LedgerInterface - Field billingTriggerConfiguration was added to object type
AccountType - Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface
AccountInterface
- Type
CreateStandingDataRegisterPendingUpdatewas added - Type
CreateStandingDataRegisterPendingUpdateInputwas added - Type
MeterUpdateKeywas added - Type
RegisterUpdateKeywas added - Type
ParticipantRelationsUpdateKeywas added - Type
DataStreamUpdateKeywas added - Type
ProposedStandingDataUpdatewas added - Field createStandingDataRegisterPendingUpdate was added to object type
Mutation
- Type
BulkAwardLoyaltyPointswas added - Type
BulkAwardLoyaltyPointsInsertedItemResultwas added - Type
BulkAwardLoyaltyPointsFailedItemResultwas added - Type
BulkAwardLoyaltyPointsInputwas added - Type
BulkAwardLoyaltyPointsItemInputwas added - Field bulkAwardLoyaltyPoints was added to object type
Mutation
- Field isReversed was added to object type
VoucherRedemptionType - Enum value APPOINTMENT_FAILED was added to
OnSiteJobsRequestStatusenum
- Type
CreateAccountCreditwas removed - Type
CreateAccountCreditInputwas removed - Type
AccountCreditReasonTypewas removed - Argument accountNumbers: [NonEmptyString!] added to
Query.getOnSiteJobsRequests - Field createAccountCredit was removed from object type
Mutation
- Enum value ACCOUNT_PROPERTY_EFFECTIVE_PERIOD was added to
LinkedObjectTypeenum - Enum value PROPERTY was added to
LinkedObjectTypeenum
- Type
UpdateCampaignAccountExpiryDatewas added - Type
UpdateCampaignAccountExpiryDateInputwas added - Field updateCampaignAccountExpiryDate was added to object type
Mutation
- Type
BillingTriggerConfigurationsForTargetwas added - Type
BillingTriggerTargetReferencewas added - Type
BillingTriggerTargetTypewas added - Type
BillingTriggerConfigurationwas added - Type
BillingOperationFrequencywas added - Type
BillingTriggerOperationTypewas added - Type
BillingTriggerFrequencywas added - Type
BillingOperationTemporalParamsTypewas added - Type
BillingTriggerConfigurationsConnectionwas added - Type
BillingTriggerConfigurationsEdgewas added - Type
TargetInputwas added - Field billingTriggerConfigurations was added to object type
Query
- Enum value CUSTOM was added to
PaymentTypeenum
- Type
PaymentScheduleDataTypewas added - Type
RegularScheduleTypewas added - Type
BillTriggeredScheduleTypewas added - Type
BalanceTriggeredScheduleTypewas added - Type
BillTriggeredBalanceTargetScheduleTypewas added - Field paymentScheduleData was added to object type
JoinSupplierProcessDataType
- Input Field timestamp: DateTime! was added to input type
PaymentDetailsInput - Input Field timestamp: DateTime! was added to input type
SuccessfulPaymentDetailsInput - Input Field timestamp: DateTime! was added to input type
FailedPaymentDetailsInput
- Type
RegisterEmailwas added - Type
RegisterEmailInputwas added - Type
PaymentAdequacyChangeTypewas added - Field registerEmail was added to object type
Mutation - Field latestAppliedPaymentAdequacyChange was added to object type
PaymentAdequacyDetailsType
- Argument excludeByDisplayName: [String] added to
Query.vouchersForAccount
- Type
InkStorylineAnalyzerResultwas added - Type
InkStorylineAnalyzerResultInputwas added - Type
StorylineAnalyzerTypeChoiceswas added - Input Field analyzerResults: [InkStorylineAnalyzerResultInput!] was added to input type
AddStorylineToInkConversationInput - Field analyzerResults was added to object type
InkStoryline
- Type
RegisterCustomerAssetwas added - Type
RegisterCustomerAssetInputwas added - Type
CustomerAssetTypeEnumwas added - Type
BlackholeEmailAccountUserTypewas added - Type
BlackholeEmailAccountTypewas added - Type
AccountUserNameTypewas added - Type
CustomerAssetTypewas added - Field customerAssets of type [CustomerAssetType] was added to interface
AccountInterface - Field registerCustomerAsset was added to object type
Mutation - Field customerAsset was added to object type
Query - Field verifyUserDetails was added to object type
Query - Field blackholeEmailAccountUser was added to object type
Query - Field customerAssets was added to object type
AccountType
- Type
AddUserToAccountwas added - Type
AddUserToAccountInputwas added - Field addUserToAccount was added to object type
Mutation
- Field users was added to object type
AccountType
- Type
CreateInternalCompanywas added - Type
CreateInternalCompanyResultTypewas added - Type
CreateInternalCompanyInputwas added - Field createInternalCompany was added to object type
Mutation
- Type
ServiceablePropertyConnectionTypeConnectionwas added - Type
ServiceablePropertyConnectionTypeEdgewas added - Type
ServiceablePropertyTypewas added - Type
PushNotificationEventTypewas added - Type
PushNotificationMessageTypewas added - Enum value PUSH_NOTIFICATION_SENT was added to
AccountEventTypeenum - Union member PushNotificationEventType was added to
AccountEventUnion type - Field serviceableProperties was added to object type
Query
- Argument excludeEstimates: Boolean added to
MeterDetailType.readings
- Enum value CANCELLED_BY_CUSTOMER was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_PROVIDER___ERROR_IN_MIDDLEWARE was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_BUSINESS was removed from
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_SUPPLIER was removed from
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_PROVIDER was removed from
OnSiteJobsAppointmentCancellationCategoryenum
- Enum value CANCELLED_BY_BUSINESS was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_SUPPLIER was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_PROVIDER was added to
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_CUSTOMER was removed from
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was removed from
OnSiteJobsAppointmentCancellationCategoryenum - Enum value CANCELLED_BY_PROVIDER___ERROR_IN_MIDDLEWARE was removed from
OnSiteJobsAppointmentCancellationCategoryenum - Field location was added to object type
MeterDetailType - Field size was added to object type
MeterDetailType - Field accessInformation was added to object type
MeterDetailType
- Input Field totalBatteryOutputCapacityKw: Decimal was added to input type
DistributedEnergyResourceConfigurationInput DistributedEnergyResourceConfigurationInput.panelOutputKw type changed from Decimal! to DecimalDistributedEnergyResourceConfigurationInput.inverterSizeKw type changed from Decimal! to DecimalDistributedEnergyResourceConfigurationInput.approvedExportLimitKw type changed from Decimal! to Decimal
- Enum value DUPLICATE_CARD_FINGERPRINTS was added to
AccountReminderTypesenum - Enum value DUPLICATE_CARD_FINGERPRINTs was removed from
AccountReminderTypesenum - Argument offset: Int added to
Query.leads - Argument offset: Int added to
Query.opportunities
- Field recipientParticipantId was added to object type
DistributionElectricityServiceOrderType - Field initiatingParticipantId was added to object type
DistributionElectricityServiceOrderType
- Field refundedAt was added to object type
VoucherPurchaseType - Argument excludeRefunded: Boolean added to
Query.vouchersForAccount
- Type
PublishApprovalApprovedEventwas added - Type
PublishApprovalApprovedEventInputwas added - Field publishApprovalApprovedEvent was added to object type
Mutation
- Type
RecordFailedPaymentwas added - Type
RecordFailedPaymentInputwas added - Type
FailedPaymentDetailsInputwas added - Type
FailureReasonwas added - Type
InternalCompanyConnectionTypeConnectionwas added - Type
InternalCompanyConnectionTypeEdgewas added - Type
RoutingAttributeTypewas 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
ContractNoteInputwas added - Type
ContractNoteTypewas added - Field notes was added to object type
ContractDetails - Field notes of type [ContractNoteType] was added to interface
ContractJourneyInterface - Input Field accountUserId: ID was added to input type
VerifyIdentityInput - Input Field familyName: String! was added to input type
VerifyIdentityInput - Input Field fullName removed from input type
VerifyIdentityInput VerifyIdentityInput.firstLineOfAddress type changed from String! to StringVerifyIdentityInput.accountNumber type changed from String! to String- Field notes was added to object type
ContractCreationJourneyType CreateExternalMessageInput.accountNumber type changed from String to String!- Input Field contractNote: ContractNoteInput was added to input type
InstigateContractVariationInput - Field notes was added to object type
Contract - Input Field contractNote: ContractNoteInput was added to input type
BaseInstigateContractTerminationInput
- Type
EnrollmentReversedwas added - Type
ReverseEnrollmentInputwas added - Field reverseEnrollment was added to object type
Mutation
- Type
LeaveSupplierReversedwas added - Type
ReverseLeaveSupplierInputwas added - Field reverseLeaveSupplier was added to object type
Mutation
- Type
OrderDetailsTypewas removed - Type
OrderTypewas removed - Type
OrderCustomerTypewas removed - Type
OrderLineTypewas removed - Type
OrderItemTypewas removed - Type
ItemProfileTypewas removed - Type
OrderLinePeriodTypewas removed - Type
OrderLineDateRangeTypewas removed - Type
OrderLineDurationTypewas removed - Type
OrderResourcewas removed - Type
ProcessOrderOutputwas removed - Type
LegacyOrderDetailsTypewas added - Type
LegacyOrderTypewas added - Type
LegacyOrderCustomerTypewas added - Type
LegacyOrderLineTypewas added - Type
LegacyOrderItemTypewas added - Type
LegacyItemProfileTypewas added - Type
LegacyOrderLinePeriodTypewas added - Type
LegacyOrderLineDateRangeTypewas added - Type
LegacyOrderLineDurationTypewas added - Type
LegacyOrderResourcewas added - Type
LegacyProcessOrderOutputwas added - Type
OnSiteJobsExternalJobTypeMappingTypewas added - Field externalJobTypeMapping was added to object type
OnSiteJobsAppointmentType - Deprecation reason on field
OnSiteJobsAppointmentType.externalJobType changed from None toThe '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
AccountReminderTypesenum - Deprecation reason on field
Mutation.createAccountCredit changed fromThe 'createAccountCredit' field is deprecated.
to
Use postCredit mutation as it is ledger aware.
- Marked as deprecated on 2022-07-04.
- Scheduled for removal on or after 2024-01-01.The 'createAccountCredit' field is deprecated.
Use postCredit mutation as it is ledger aware.
- Marked as deprecated on 2022-07-04.
- Scheduled for removal on or after 2026-03-30. Mutation.legacyProcessOrder type changed from ProcessOrderOutput! to LegacyProcessOrderOutput!- Field legacyOrderDetails was added to object type
Query - Field orderDetails was removed from object type
Query
- Type
InternalCompanyTypewas added - Type
SearchCriteriaInputwas 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
AccountUserCommsPreferencesTypewas added - Field commsPreferences was added to object type
AccountUserType
- Field lifeSupportContact was added to object type
MeterPointType
- Type
UpdateAgentAuxiliaryStatuswas added - Type
UpdateAgentAuxiliaryStatusInputwas added - Field updateAgentAuxiliaryStatus was added to object type
Mutation
- Type
EligibilityChecksResponseTypewas added - Type
EligibilityCheckResultTypewas added - Field networkTariffEligibilityChecksForSupplyPoint was added to object type
Query
- Type
RecordPendingPaymentwas added - Type
RecordPendingPaymentInputwas added - Type
PaymentDetailsInputwas added - Type
CreateExternalMessagewas added - Type
ExternalMessageTypewas added - Type
CreateExternalMessageInputwas added - Type
EmailContentInputwas added - Field createExternalMessage was added to object type
Mutation - Field recordPendingPayment was added to object type
Mutation
- Argument ledgerNumber: String added to
PeriodBasedDocumentType.openingBalance - Argument ledgerNumber: String added to
PeriodBasedDocumentType.closingBalance
- Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from
AccountReminderTypesenum
- Type
CloseInkConversationwas added - Type
CloseInkConversationInputwas added - Type
ConversationClosedReasonChoiceswas added OnSiteJobsCreateAppointmentInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]OnSiteJobsUpdateAppointmentInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]CreateOnSiteJobsRequestInputType.supplyPointInternalIds type changed from [Int] to [Int!]CreateOnSiteJobsRequestInputType.supplyPointIdentifierToMarketNameMapping type changed from [SupplyPointIdentifierToMarketNameMappingInput] to [SupplyPointIdentifierToMarketNameMappingInput!]CreateOnSiteJobsRequestInputType.assets type changed from [OnSiteJobsAssetInput]! to [OnSiteJobsAssetInput!]!- Field closeInkConversation was added to object type
Mutation OnSiteJobsUpdateRequestInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
InkStorylineEntry.contentId type changed from Int to BigIntInkStorylineEntryInput.contentId type changed from Int to BigInt
- Input Field knowledgeArticleIds: [Int!] was added to input type
AddStorylineToInkConversationInput - Field knowledgeArticleIds was added to object type
InkStoryline - Field params was added to object type
CommonAgreementType
- Field possibleErrors was added to object type
TriggerElectricityHouseMoveOut
- Type
SubmitMeterReadingsInputTypewas added - Type
MeterReadingInputTypewas added - Type
ReadingReasonChoiceswas added - Argument input: SubmitMeterReadingsInputType! added to
Mutation.submitMeterReadings
- Type
DeletePropertyDescendantswas added - Type
DeletePropertyDescendantsInputwas added - Field deletePropertyDescendants was added to object type
Mutation
- Type
RemovePropertyFromHierarchywas added - Type
RemovePropertyFromHierarchyInputwas added - Field removePropertyFromHierarchy was added to object type
Mutation
- Type
AddParentToPropertywas added - Type
AddParentToPropertyInputwas added - Field addParentToProperty was added to object type
Mutation
- Type
SendChangeNMIDetailsRequestwas added - Type
SendChangeNMIDetailsRequestOutputTypewas added - Type
SendChangeNMIDetailsRequestInputTypewas added - Field sendChangeNmiDetailsRequest was added to object type
Mutation
- Field deadlineDate was added to object type
OnSiteJobsAppointmentType - Field createdAt was added to object type
OnSiteJobsAppointmentType - Field preferredStartDate was added to object type
OnSiteJobsAppointmentType
- Input Field externalIdentifier: String was added to input type
SimpleServicesEnrollmentMarketInput
- Type
RecordSuccessfulPaymentwas added - Type
RecordSuccessfulPaymentInputwas added - Type
NoticePrioritywas added - Type
SuccessfulPaymentDetailsInputwas added - Type
PaymentActionIntentOneOfInputwas added - Type
PaymentActionIntentOptionsInputwas added - Type
PaymentMethodInputwas added - Field recordSuccessfulPayment was added to object type
Mutation
- Type
SimpleServicesMarketDataSourceInputwas added - Type
SimpleServicesQuotedSupplyPointInputwas added - Type
SimpleServicesProductCatalogInputwas added - Type
CharacteristicValueInputwas added - Type
SimpleServicesAgreementTransferInputwas added - Input Field marketDataSource: SimpleServicesMarketDataSourceInput was added to input type
SimpleServicesEnrollmentMarketInput - Input Field externalIdentifier removed from input type
SimpleServicesEnrollmentMarketInput - Input Field quotedSupplyPointId removed from input type
SimpleServicesEnrollmentMarketInput
- Input Field alignRequestStatusWithAppointment: Boolean was added to input type
OnSiteJobsUpdateAppointmentInput - Input Field bypassTerminalAppointmentStatus: Boolean was added to input type
OnSiteJobsUpdateAppointmentInput
- Type
AddChildToPropertywas added - Type
AddChildToPropertyInputwas added - Field addChildToProperty was added to object type
Mutation
- Deprecation reason on field
Mutation.instigateContractVariation changed from None toThe 'instigateContractVariation' field is deprecated.
This is a legacy mutation. The varyContractTerms should be used instead.
- Marked as deprecated on 2026-03-05.
- Scheduled for removal on or after 2026-04-11. - Deprecation reason on field
Mutation.varyContractTerms changed fromThe 'varyContractTerms' field is deprecated.
to None
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.
- Type
AddPropertyToHierarchywas added - Type
AddPropertyToHierarchyInputwas added - Argument ledgerNumber: String added to
PeriodBasedDocumentType.transactions - Field addPropertyToHierarchy was added to object type
Mutation - Argument ledgerNumber: String added to
InvoiceType.transactions
- Enum value POST_APPOINTMENT_ABORTED was added to
OnSiteJobsAppointmentActionTriggerStageenum
- Type
SyncBusinessUserRoleTypewas added - Field businessUserRoles was added to object type
UserSyncPayloadType - Field brand was added to object type
SyncAccountType - Input Field accountTypes: [AccountTypeChoices] was added to input type
AccountUserInputType - Input Field brands: [BrandChoices] was added to input type
AccountUserInputType
- Enum value CUSTOM was added to
Vendorenum
- Enum value SERVICE_TICKET was added to
AccountPaymentTransactionTypeChoicesenum
- Type
UpdateAgreementRescissionwas added - Type
AgreementRescissionTypewas added - Type
AgreementRescissionStatuswas added - Type
UpdateAgreementRescissionInputwas added - Default value for argument hierarchyName on field
PropertyType.ancestors changed from Undefined to 'default' - Type for argument hierarchyName on field
PropertyType.ancestors changed from String! to String - Default value for argument hierarchyName on field
PropertyType.descendants changed from Undefined to 'default' - Type for argument hierarchyName on field
PropertyType.descendants changed from String! to String - Default value for argument hierarchyName on field
PropertyType.parent changed from Undefined to 'default' - Type for argument hierarchyName on field
PropertyType.parent changed from String! to String - Default value for argument hierarchyName on field
PropertyInterface.ancestors changed from Undefined to 'default' - Type for argument hierarchyName on field
PropertyInterface.ancestors changed from String! to String - Default value for argument hierarchyName on field
PropertyInterface.descendants changed from Undefined to 'default' - Type for argument hierarchyName on field
PropertyInterface.descendants changed from String! to String - Default value for argument hierarchyName on field
PropertyInterface.parent changed from Undefined to 'default' - Type for argument hierarchyName on field
PropertyInterface.parent changed from String! to String - Field updateAgreementRescission was added to object type
Mutation
- Type
GenerateLeadsFileAttachmentDownloadPreSignedUrlwas added - Type
LeadsFileAttachmentDownloadPresignedUrlTypewas added - Type
GenerateLeadsFileAttachmentDownloadPreSignedUrlInputwas added - Field generateLeadsFileAttachmentDownloadPreSignedUrl was added to object type
Mutation
- Input Field organisationNumber: String was added to input type
SalesInformationInput - Input Field organisationId removed from input type
SalesInformationInput
- Input Field supplyPointIdentifier: String was added to input type
CreateAccountNoteInput - Input Field marketName: String was added to input type
CreateAccountNoteInput CreateAccountNoteInput.accountNumber type changed from String! to String
- Field hasLifeSupportRecord was added to object type
PropertyType
- Deprecation reason on field
Query.siteworksRequests changed from None toThe 'siteworksRequests' field is deprecated.
Please use getOnSiteJobsRequests instead.
- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01. - Deprecation reason on field
Mutation.updateSiteworksRequest changed from None toThe 'updateSiteworksRequest' field is deprecated.
Please use updateOnSiteJobsRequest instead.
- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.
- Type
ReadingConnectionTypeConnectionwas added - Type
ReadingConnectionTypeEdgewas added - Field readings was added to object type
MeterDetailType
- Argument number: String added to
Query.affiliateOrganisation - Type for argument id on field
Query.affiliateOrganisation changed from Int! to Int - Field number was added to object type
AffiliateOrganisationType
- Type
PropertyConnectionwas added - Type
PropertyEdgewas added - Field descendants of type PropertyConnection was added to interface
PropertyInterface - Field parent of type
PropertyInterfacewas added to interfacePropertyInterface - Field ancestors of type PropertyConnection was added to interface
PropertyInterface - Field descendants was added to object type
PropertyType - Field parent was added to object type
PropertyType - Field ancestors was added to object type
PropertyType
- Type
DetermineWorkRequestsResultTypewas added - Type
WorkRequestSpecOutputTypewas added - Type
TriggerPmdRequestwas added - Type
TriggerPmdRequestOutputTypewas added - Type
RequestedDateRangeTypewas added - Type
FailedDateRangeTypewas added - Type
TriggerPmdRequestInputTypewas added - Type
CancelServiceOrderswas added - Type
CancelServiceOrdersInputwas added - Type
CancelServiceOrdersMatchCriteriawas added - Type
CancelServiceOrdersCancellationReasonwas added - Type
ServiceOrderResponseCodewas added - Input Field ledgerNumber: String was added to input type
PaymentPlanInput - Field typeDescription was added to object type
DistributionElectricityServiceOrderType - Field subtypeDescription was added to object type
DistributionElectricityServiceOrderType - Field cancelServiceOrders was added to object type
Mutation - Field triggerPmdRequest was added to object type
Mutation - Field transmissionNodeIdentifier was added to object type
ElectricityMeterType - Input Field ledgerNumber: String was added to input type
ReplaceLatestPaymentScheduleInput - Field determineRequiredWorkRequests was added to object type
Query - Input Field ledgerNumber: String was added to input type
PaymentScheduleInput LeadContactDetailsInput.phoneNumber type changed from String! to StringLeadContactDetailsInput.givenName type changed from String! to StringLeadContactDetailsInput.familyName type changed from String! to StringLeadContactDetailsInput.email type changed from String! to String
- Type
UpdateAgreementRolloverwas added - Type
UpdateAgreementRolloverInputwas added - Type
RolloverStatuswas added - Field updateAgreementRollover was added to object type
Mutation
- Enum value AMPERE_MONTHS was added to
UnitTypeenum
- Input Field leaveSupplierNumber: String was added to input type
EnrollmentInput
- Type
ContractNoteReasonTypewas added - Type
ContractActivityTypeOptionswas added - Field contractNoteReasons was added to object type
Query Query.opportunityProductSummary type changed from OpportunityProductSummary to [OpportunityProductSummary!]!OpportunityProductSummary.productCharacteristics type changed from JSONString to GenericScalar
- Input Field removeSupplyPoints: [LeadSupplyPoint] was added to input type
UpdateOpportunityDetailsInput - Input Field addSupplyPoints: [LeadSupplyPoint] was added to input type
UpdateOpportunityDetailsInput
- Enum value D0010_CREATION_FAILURE was removed from
AccountReminderTypesenum
- Type
ConnectAiAgentToCallwas added - Type
ConnectAiAgentToCallInputwas added - Field connectAiAgentToCall was added to object type
Mutation
- Input Field hideOnSupportSite: Boolean was added to input type
CallMetadataItemInput
- Input Field funnelCode removed from input type
CreateLeadInput CreateLeadInput.address type changed from RichAddressInput! to RichAddressInputCreateLeadInput.leadType type changed from LeadTypeChoices! to LeadTypeChoices- Default value for input field
CreateLeadInput.leadType changed from Undefined to None CreateLeadInput.salesChannel type changed from String! to String- Default value for input field
CreateLeadInput.salesChannel changed from Undefined to None
- Input Field accountNumber: String was added to input type
CreateLeadInput
- Input Field ledgerNumber: String was added to input type
FixedPaymentScheduleInput
- Input Field emergencyApprovalDetails: String was added to input type
CreateOnSiteJobsRequestInputType
- Type
MeterDetailTypewas added - Field activeWaterMeters was added to object type
PropertyType - Enum value WALMART_CASH was added to
AccountPaymentTransactionTypeChoicesenum - Enum value PAYPAL was added to
AccountPaymentTransactionTypeChoicesenum - Enum value MONEYGRAM was added to
AccountPaymentTransactionTypeChoicesenum - Enum value DESKTOP_DEPOSIT was added to
AccountPaymentTransactionTypeChoicesenum
- Field tags was added to object type
InkConversation
- Type
CreateOnSiteJobsAppointmentWithDatewas added - Field createOnSiteJobsAppointmentWithDate was added to object type
Mutation
- Type
SendOfferQuoteSummarywas added - Type
OfferQuoteSummaryInputwas added - Field sendOfferQuoteSummary was added to object type
Mutation
- Type
SubmitMeterReadingswas added - Field submitMeterReadings was added to object type
Mutation
- Enum value OTHER was added to
OnSiteJobsAppointmentActionTriggerStageenum
- Field agreement was added to object type
Query
- Field status was removed from object type
TriggerVmdRequestOutputType - Input Field status removed from input type
TriggerVmdRequestInputType - Field status was removed from object type
TriggerC4RequestOutputType - Input Field status removed from input type
TriggerC4RequestInputType
- Type
PublishMeterDataIssueEmailwas added - Type
PublishMeterDataIssueEmailOutputTypewas added - Type
PublishMeterDataIssueEmailInputwas added - Field publishMeterDataIssueEmail was added to object type
Mutation
- Type
TriggerVmdRequestwas added - Type
TriggerVmdRequestOutputTypewas added - Type
TriggerVmdRequestInputTypewas added - Field triggerVmdRequest was added to object type
Mutation
- Field category was added to object type
PropertyHazardType
- Type for argument timeGranularity on field
Device.readings changed from TimeGranularities! to TimeGranularities - Type for argument timeGranularity on field
SupplyPointType.readings changed from TimeGranularities! to TimeGranularities - Type for argument timeGranularity on field
HasReadings.readings changed from TimeGranularities! to TimeGranularities - Type for argument timeGranularity on field
DeviceRegister.readings changed from TimeGranularities! to TimeGranularities
- Input Field businessId: Int was added to input type
CreateReminderInput
- Field assignedToAffiliateNumber was added to object type
OpportunityOutput - Field assignedToAffiliateNumber was added to object type
LeadOutput
- Type
ReadingTypewas added
- Type
JoinSupplierLedgerAssignmentConnectionTypeConnectionwas added - Type
JoinSupplierLedgerAssignmentConnectionTypeEdgewas added - Type
JoinSupplierLedgerAssignmentTypewas added - Type
LedgerSupplyPointTypewas added - Field ledgerAssignments was added to object type
JoinSupplierProcessType
- Field agreementsForRollover was added to object type
Query
- Type
SyncFamilyIssuesTypewas added - Field familyIssues was added to object type
UserSyncPayloadType
- Field priority was added to object type
PropertyHazardType
- Field subtype was added to object type
LeaveSupplierProcessType - Field subtype was added to object type
JoinSupplierProcessType - Enum value FIELDWORKS_METER_FAULT_NCOM_COMMS_FAILED was removed from
AccountReminderTypesenum
- Field field was added to object type
ExtraDetail
- Enum value NZ_SWITCHING_WITHDRAWAL was removed from
AccountReminderTypesenum - Enum value NZ_METERING_QUERY was removed from
AccountReminderTypesenum - Enum value NZ_DUNNING was removed from
AccountReminderTypesenum - Enum value NZ_SOLAR_METER_CHANGE was removed from
AccountReminderTypesenum - Enum value NZ_VACANT_PROPERTY was removed from
AccountReminderTypesenum - Enum value NZ_BILLING_QUERY was removed from
AccountReminderTypesenum
- Input Field cancelConflictingSchedules: Boolean was added to input type
SwitchAccountToVariablePaymentScheduleInput
- Type
GetOrCreateAgreementwas added - Field getOrCreateAgreement was added to object type
Mutation
- Argument appointmentIdToReschedule: UUID added to
Mutation.startOnSiteJobsAppointmentBookingSession
- Type
EssentialEnergyAppointmentJobDetailsInputwas added - Input Field jobDetails: EssentialEnergyAppointmentJobDetailsInput! was added to input type
OnSiteJobsAppointmentBookingDetailsInput - Input Field jobDetails: EssentialEnergyAppointmentJobDetailsInput was added to input type
OnSiteJobsUpdateAppointmentInput - Input Field jobDetails: EssentialEnergyAppointmentJobDetailsInput! was added to input type
OnSiteJobsCreateAppointmentInput
- Field reversalsAfterClose of type StatementReversalsAfterClose! was added to interface
BillInterface - Field reversalsAfterClose was added to object type
InvoiceType - Field reversalsAfterClose was added to object type
CollectiveBillType - Field reversalsAfterClose was added to object type
PreKrakenBillType - Field reversalsAfterClose was added to object type
PeriodBasedDocumentType
- Input Field details: [DetailsInputType] was added to input type
BaseInitializeUserInput
- Field accountNumber was added to object type
InkConversation
- Field conversationRelayId was added to object type
InkPost - Field conversationRelayId was added to object type
InkEmail - Field conversationRelayId was added to object type
InkGenericMessage
- Enum value ON_SITE was added to
OnSiteJobsAppointmentStatusenum - Enum value EN_ROUTE was added to
OnSiteJobsAppointmentStatusenum
- Type
ManualReviewMeterDataIssuewas added - Type
ManualReviewMeterDataIssueOutputTypewas added - Type
ManualReviewMeterDataIssueInputTypewas added - Field manualReviewMeterDataIssue was added to object type
Mutation
- Type
ContactPersonTypewas added - Field serviceComment was added to object type
ContactPersonPhoneType - Field customerDetail was added to object type
DistributionServiceOrderRequestType - Field contactDetail was added to object type
DistributionServiceOrderRequestType
- Type
CreateCollectionProcessEventwas added - Type
CollectionProcessEventOutputTypewas added - Type
CreateCollectionProcessEventInputTypewas added - Type
CollectionProcessEventTypeEnumwas added - Enum value REACTIVATION_HISTORY was removed from
CollectionProcessAssociatedItemTypeenum - Field createCollectionProcessEvent was added to object type
Mutation
- Enum value FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITHOUT_CUSTOMER_CONSULTATION was added to
AccountReminderTypesenum
- Field account was added to object type
CommonAgreementType
- Enum value KW_DEMAND_DAYS was added to
UnitTypeenum
- Type
DistributionServiceOrderRequestTypewas added - Field request was added to object type
DistributionElectricityServiceOrderType
- Input Field waiveExitFee: Boolean was added to input type
BaseInstigateContractTerminationInput - Default value for input field
TerminateContractInput.waiveExitFee changed from Undefined to False
- Input Field supplyPoints: [LeadSupplyPoint] was added to input type
CreateOpportunityAndLeadInput
- Type
TerminateAgreementwas added - Type
TerminateAgreementInputwas added CreateReminderInput.accountNumber type changed from String! to String- Field terminateAgreement was added to object type
Mutation
- Field offerGroupIdentifier was added to object type
JoinSupplierProcessDataType - Input Field offerGroupIdentifier: NonEmptyString was added to input type
SalesInformationInput
- Field openingBalance was added to object type
PeriodBasedDocumentType
CoreSiteworksAppointmentType.externalReference type changed from String to String!CoreSiteworksRequestType.reason type changed from String to String!
- Input Field flowRunIdentifier: String! was added to input type
ResolveMeterDataIssueInputType
- Input Field preferredContactMethod: String was added to input type
CreateComplaintInputType - Input Field preferredCommunicationMethod removed from input type
CreateComplaintInputType
- Field getElectricityServiceOrderById was added to object type
Query
- Type
MarketParticipantTypewas added - Field multiplier was added to object type
ElectricityRegisterType - Field marketParticipant was added to object type
Query - Field model was added to object type
ElectricityMeterType
- Type
TriggerCollectionProcessMessagewas added - Type
TriggerCollectionProcessMessageOutputwas added - Type
TriggerCollectionProcessMessageInputwas added - Field triggerCollectionProcessMessage was added to object type
Mutation
EndMeterDataIssueFlowInputType.status type changed from String! to MeterDataIssueFlowStatus!
- Input Field sendComms: Boolean was added to input type
UpdateHardshipAgreementInput
- Input Field leadId removed from input type
CreateOpportunityAndLeadInput
- Type
LeadSupplyPointTypewas added - Type
LeadSupplyPointFiltersInputwas added - Type
SupplyPointMarketNameEnumwas added - Field supplyPoints was added to object type
OpportunityOutput - Input Field supplyPointMarkets: [SupplyPointMarketNameEnum] was added to input type
OpportunitiesQueryInput
- Type
LeadSupplyPointwas added - Input Field supplyPoints: [LeadSupplyPoint] was added to input type
CreateOpportunityForLeadInput
- Type
CreateTemplateOutputwas removed - Type
TemplateTypewas removed - Type
TemplateStatuswas removed - Type
TemplateGroupTypewas removed - Type
GroupCategorywas removed - Type
TemplateLineItemTypewas removed - Type
CurrencyTypewas removed - Type
CreateTemplateInputwas removed - Type
TemplateGroupInputwas removed - Type
TemplateLineItemInputwas removed - Type
UpdateTemplateOutputwas removed - Type
UpdateTemplateInputwas removed - Type
DeleteTemplateOutputwas removed - Type
ActivateTemplatesOutputwas removed - Type
ExpireTemplatesOutputwas removed - Type
CreateInputOutputwas removed - Type
InputTypewas removed - Type
Sectionwas removed - Type
CreateInputInputwas removed - Type
UpdateInputOutputwas removed - Type
UpdateInputInputwas removed - Type
DeleteInputOutputwas removed - Type
TemplateFilterInputwas removed - Type
TemplateNodesTypewas removed - Type
RateBuilderNodeTypewas removed - Type
LabelValueTypewas removed - Type
SalesTaxNodeTypewas removed - Field template was removed from object type
Query - Field latestTemplate was removed from object type
Query - Field latestActiveTemplate was removed from object type
Query - Field templateNodesOptions was removed from object type
Query - Field catalogInput was removed from object type
Query - Field catalogInputs was removed from object type
Query - Field templates was removed from object type
Query - Field updateTemplate was removed from object type
Mutation - Field expireTemplates was removed from object type
Mutation - Field activateTemplates was removed from object type
Mutation - Field deleteTemplate was removed from object type
Mutation - Field deleteCatalogInput was removed from object type
Mutation - Field updateCatalogInput was removed from object type
Mutation - Field createTemplate was removed from object type
Mutation - Field createCatalogInput was removed from object type
Mutation
- Type
TriggerC4Requestwas added - Type
TriggerC4RequestOutputTypewas added - Type
TriggerC4RequestInputTypewas added - Type
C4RequestRoleTypewas added - Field triggerC4Request was added to object type
Mutation
- Type
CreateHardshipAgreementwas added - Type
CreateHardshipAgreementInputwas added - Type
HardshipTypeEnumwas added - Type
HardshipEntryReasonEnumwas added - Type
HardshipExitReasonEnumwas added - Type
UpdateHardshipAgreementwas added - Type
UpdateHardshipAgreementInputwas added - Type
HardshipAgreementExitReasonwas added - Field exitReasonDetails was added to object type
HardshipAgreementType - Field endDate was added to object type
HardshipAgreementType - Field createdAt was added to object type
HardshipAgreementType - Field exitReason was added to object type
HardshipAgreementType - Field updateHardshipAgreement was added to object type
Mutation - Field createHardshipAgreement was added to object type
Mutation
- Type
MoveToBucketwas added - Type
MoveToBucketInputwas added - Field moveToBucket was added to object type
Mutation - Field conversationId was added to object type
InkEmail - Field conversationId was added to object type
InkGenericMessage - Field conversationId was added to object type
InkPost
- Type
ResolveMeterDataIssuewas added - Type
ResolveMeterDataIssueOutputTypewas added - Type
MeterDataIssueStatuswas added - Type
ResolveMeterDataIssueInputTypewas added - Field resolveMeterDataIssue was added to object type
Mutation
- Type
ChangeRetailerForSupplyPointwas removed - Type
ChangeRetailerForSupplyPointInputwas removed - Field changeRetailerForSupplyPoint was removed from object type
Mutation
- Field canRescindAgreement was added to object type
Query
- Input Field accountNumber: String was added to input type
CloseInkLiveChaConversationtInput
- Input Field opportunityAddress: RichAddressInput was added to input type
CreateOpportunityAndLeadInput - Input Field useSameAddressAsBilling: Boolean was added to input type
CreateOpportunityForLeadInput
- Type
UpdateOpportunityDetailswas added - Type
UpdateOpportunityDetailsInputwas added - Field updateOpportunityDetails was added to object type
Mutation
- Type
CreateOrUpdateTimeSeriesEntrieswas added - Type
CreateOrUpdateTimeSeriesEntriesInputwas added - Field createOrUpdateTimeSeriesEntries was added to object type
Mutation - Deprecation reason on field
Mutation.createTimeSeriesPrices changed from None toThe 'createTimeSeriesPrices' field is deprecated.
Please use the 'createOrUpdateTimeSeriesEntries' mutation instead.
- Marked as deprecated on 2025-02-03.
- Scheduled for removal on or after 2025-03-01.
- Field wasCreated was added to object type
CreateContractOutput
- Type
HasFamilyIssueswas added - Type
HasFamilyIssuesInputTypewas added - Type
CommsDeliveryPreferenceEnumwas added - Field hasFamilyIssues was added to object type
Mutation
- Field rescissionDeadlineAt was added to object type
ElectricityAgreementType - Input Field rescissionDeadlineAt: DateTime was added to input type
CreateAgreementInput - Field rescissionDeadlineAt was added to object type
GasAgreementType - Field rescissionDeadlineAt was added to object type
DistributionAgreementType - Field rescissionDeadlineAt of type DateTime was added to interface
AusAgreementInterface - Field rescissionDeadlineAt was added to object type
CommonAgreementType
- Input Field assignedToTeamName: String was added to input type
CreateOpportunityForLeadInput - Input Field assignedToUsername: String was added to input type
CreateOpportunityForLeadInput - Input Field assignedToTeamName: String was added to input type
CreateOpportunityAndLeadInput - Input Field assignedToUsername: String was added to input type
CreateOpportunityAndLeadInput
- Input Field assignedToTeamName: String was added to input type
CreateLeadInput - Input Field assignedToUsername: String was added to input type
CreateLeadInput
- Input Field useForAutomatedPayments: Boolean was added to input type
CreateDirectDebitInstructionInput
- Input Field assignedToAffiliateNumber: String was added to input type
CreateOpportunityAndLeadInput - Input Field affiliateOrganisationId removed from input type
CreateOpportunityAndLeadInput - Input Field assignedToAffiliateNumber: String was added to input type
CreateOpportunityForLeadInput - Input Field affiliateOrganisationId removed from input type
CreateOpportunityForLeadInput
- Input Field useForAutomatedPayments: Boolean was added to input type
SetUpDirectDebitInstructionInput - Input Field useForAutomatedPayments: Boolean was added to input type
StorePaymentInstructionInput - Field supportSiteUrl was added to object type
EmailType
- Type
EndMeterDataIssueFlowwas added - Type
EndMeterDataIssueFlowOutputTypewas added - Type
EndMeterDataIssueFlowInputTypewas added - Field endMeterDataIssueFlow was added to object type
Mutation
- Input Field assignedToAffiliateNumber: String was added to input type
OpportunitiesQueryInput - Input Field createdByOrganization removed from input type
OpportunitiesQueryInput - Input Field assignedToAffiliateNumber: String was added to input type
LeadsQueryInput - Input Field createdByOrganization removed from input type
LeadsQueryInput
- Input Field assignedToAffiliateNumber: String was added to input type
CreateLeadInput - Input Field affiliateOrganisationId removed from input type
CreateLeadInput
- Field hasActiveDunningProcess was added to object type
AccountType - Field hasActiveDebtCollectionProceeding was added to object type
AccountType - Field isMeasured was added to object type
AccountType
- Field phones was added to object type
OutageContactType - Deprecation reason on field
OutageContactType.phoneNumber2 changed from None toThe 'phoneNumber2' field is deprecated.
Use the phones field to get all phone details associated with the contact person.
- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30. - Deprecation reason on field
OutageContactType.phone2 changed from None toThe 'phone2' field is deprecated.
Use the phones field to get all phone details associated with the contact person.
- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30. - Deprecation reason on field
OutageContactType.phoneNumber1 changed from None toThe 'phoneNumber1' field is deprecated.
Use the phones field to get all phone details associated with the contact person.
- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30. - Deprecation reason on field
OutageContactType.phoneNumber2ServiceType changed from None toThe 'phoneNumber2ServiceType' field is deprecated.
Use the phones field to get all phone details associated with the contact person.
- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30. - Deprecation reason on field
OutageContactType.phone1 changed from None toThe 'phone1' field is deprecated.
Use the phones field to get all phone details associated with the contact person.
- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30. - Deprecation reason on field
OutageContactType.phoneNumber1ServiceType changed from None toThe 'phoneNumber1ServiceType' field is deprecated.
Use the phones field to get all phone details associated with the contact person.
- Marked as deprecated on 2026-01-30.
- Scheduled for removal on or after 2026-05-30.
- Type
SendCustomerDetailsRequestwas added - Type
SendCustomerDetailsRequestInputTypewas added - Type
RequestReasonwas added - Field sendCustomerDetailsRequest was added to object type
Mutation
- Type
UpdateOfferGroupOnOpportunitywas added - Type
UpdateOfferGroupOnOpportunityInputwas added - Field updateOfferGroupOnOpportunity was added to object type
Mutation
- Field storedPaymentMethodDetailsReference was added to object type
JoinSupplierProcessDataType
- Deprecation reason on field
Query.defaultPaymentInstruction changed from None toThe 'defaultPaymentInstruction' field is deprecated.
Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.
- Marked as deprecated on 2026-01-28.
- Scheduled for removal on or after 2026-07-28.
- Input Field lastContactedSupportUserId: Int was added to input type
CreateCustomerFeedbackInputType - Field trigger was added to object type
PaymentScheduleType
- Type
CreatePaymentActionIntentwas added - Type
CreatePaymentActionIntentInputwas added - Type
PaymentActionIntentTargetTypewas added - Field createPaymentActionIntent was added to object type
Mutation
- Type
PaymentTermsInputwas added - Type
PaymentTermsInvalidErrorTypewas added - Input Field paymentTerms: PaymentTermsInput was added to input type
BillAndPaymentInput - Union member PaymentTermsInvalidErrorType was added to
ProcessHouseMoveErrorUnionUnion type
- Type
Unitswas added - Argument units: [Units] added to
SupplyPointType.readings - Argument units: [Units] added to
HasReadings.readings - Argument units: [Units] added to
Device.readings - Argument units: [Units] added to
DeviceRegister.readings
- Type
WaterMeterTypewas added - Type
WaterMeterCategorywas added - Type
WaterMeterCapabilityTypewas added - Type
WaterMeterStatuswas added - Enum value TBD was added to
BusinessTypeChoicesenum - Enum value TO_BE_DETERMINED was added to
BusinessTypeOptionsenum - Enum value FINALIZE_ACCOUNT_SETUP was added to
ExpiringTokenScopeenum - Input Field isRootCause: Boolean was added to input type
InkStorylineEntryInput - Field isRootCause was added to object type
InkStorylineEntry - Enum value FINALIZE_ACCOUNT_SETUP was added to
PreSignedTokenScopeenum
- Type
CreateMeterDataIssueFlowwas added - Type
CreateMeterDataIssueFlowOutputTypewas added - Type
MeterDataIssueFlowStatuswas added - Type
CreateMeterDataIssueFlowInputTypewas added - Field createMeterDataIssueFlow was added to object type
Mutation
- Type
CharacteristicTypewas added - Type
CharacteristicValueUnionwas added - Type
StringCharacteristicValueTypewas added - Type
IntegerCharacteristicValueTypewas added - Field characteristic of type CharacteristicType was added to interface
CharacteristicValueInterface
- Input Field stageCode: String was added to input type
LeadsQueryInput
- Input Field productOfferingId: String was added to input type
OpportunitiesQueryInput - Field agreementRollover was added to object type
Query
UpdateLeadStageInput.currentStage type changed from String! to NonEmptyString!UpdateOpportunityStageInput.currentStage type changed from String to NonEmptyString!
- Type
CharacteristicValueInterfacewas added - Field characteristicValues was added to object type
CommonAgreementType - Field order was added to object type
SalesFunnelStage - Field funnel was added to object type
LeadOutput
- Field numberOfOccupants was added to object type
OccupancyPeriodType
- Enum value INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_MISSING_BUSINESS_ACCEPTANCE was added to
AccountReminderTypesenum - Enum value INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_REJECTED was added to
AccountReminderTypesenum
- Type
ProcessOrderInputwas removed - Type
OrderInputwas removed - Type
CustomerOrderInputwas removed - Type
OrderLineInputwas removed - Type
OrderItemInputwas removed - Type
ItemProfileInputwas removed - Type
MarketDataInputwas removed - Type
OrderLinePeriodInputwas removed - Field processOrder was removed from object type
Mutation
- Enum value DKK_ORE was added to
LineItemCurrencyenum - Enum value DNK_ORE was removed from
LineItemCurrencyenum
- Enum value DNK_ORE was added to
LineItemCurrencyenum
- Enum value INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_REQUEST_REJECTED was added to
AccountReminderTypesenum
- Type
CreateAgreementwas added - Type
CreateAgreementInputwas added - Field createAgreement was added to object type
Mutation
- Field instigateBusinessContractTermination was removed from object type
Mutation
PushNotificationBindingType.messages type changed from [SMSMessageType!]! to PrintMessageTypeConnection!- Argument first: Int added to
PushNotificationBindingType.messages - Argument offset: Int added to
PushNotificationBindingType.messages - Argument before: String added to
PushNotificationBindingType.messages - Argument last: Int added to
PushNotificationBindingType.messages - Argument after: String added to
PushNotificationBindingType.messages
- Type
InstigateContractVariationOutputwas added - Type
InstigateContractVariationInputwas added - Field instigateContractVariation was added to object type
Mutation - Deprecation reason on field
Mutation.varyContractTerms changed from None toThe 'varyContractTerms' field is deprecated.
This is a legacy mutation. The instigateContractVariation should be used instead.
- Marked as deprecated on 2026-01-20.
- Scheduled for removal on or after 2026-02-27.
- Input Field identifier removed from input type
CreateContractInput
- Field supplyPointInternalIdentifier was added to object type
OnSiteJobsAssetType - Deprecation reason on field
OnSiteJobsAssetType.supplyPointIdentifier changed from None toThe 'supplyPointIdentifier' field is deprecated.
Use 'supplyPointInternalIdentifier' instead. This field is being removed as the underlying model field is being removed.
- Marked as deprecated on 2026-01-16.
- Scheduled for removal on or after 2026-03-01. OnSiteJobsAssetType.supplyPointIdentifier type changed from String! to String
- Type
CollectionProcessTypeswas added - Field targetObjectIdentifier was added to object type
CollectionProcessDetailsType - Field collectionProcessType was added to object type
CollectionProcessDetailsType
- Type
ExtraDetailwas added - Field extraDetailItems was added to object type
LeadOutput - Deprecation reason on field
LeadOutput.extraDetails changed from None toThe 'extraDetails' field is deprecated.
Use extraDetailsItems instead, which provides a structured key/value format.
- Marked as deprecated on 2026-01-14.
- Scheduled for removal on or after 2026-07-14. - Input Field extraDetailItems: [ExtraDetailsItem] was added to input type
LeadContactDetailsInput - Input Field extraDetails removed from input type
LeadContactDetailsInput - Field extraDetailItems was added to object type
OpportunityOutput - Deprecation reason on field
OpportunityOutput.extraDetails changed from None toThe 'extraDetails' field is deprecated.
Use extraDetailsItems instead, which provides a structured key/value format.
- Marked as deprecated on 2026-01-14.
- Scheduled for removal on or after 2026-07-14.
- Type
CreateInputOutputwas added - Type
InputTypewas added - Type
Sectionwas added - Type
CreateInputInputwas added - Type
UpdateInputOutputwas added - Type
UpdateInputInputwas added - Type
DeleteInputOutputwas added - Type
TemplateNodesTypewas added - Type
RateBuilderNodeTypewas added - Type
LabelValueTypewas added - Type
SalesTaxNodeTypewas added - Field updateCatalogInput was added to object type
Mutation - Field deleteCatalogInput was added to object type
Mutation - Field createCatalogInput was added to object type
Mutation - Field templateNodesOptions was added to object type
Query - Field catalogInputs was added to object type
Query - Field catalogInput was added to object type
Query
- Type for argument filters on field
Query.searchLead changed from SearchLeadFilters to SearchLeadFilters!
- Type
ExportRepaymentDetailsTypewas added - Type
UpdateExportPaymentMethodwas added - Type
UpdateExportPaymentMethodInputwas added - Type
ExportPaymentMethodEnumwas added - Field updateExportPaymentMethod was added to object type
Mutation - Field exportRepaymentDetails was added to object type
Query
- Argument statuses: [String] added to
Query.getStandingDataPendingUpdatesByNmi - Removed argument status from
Query.getStandingDataPendingUpdatesByNmi - Field updatedAt was added to object type
GetStandingDataPendingUpdates - Field createdAt was added to object type
GetStandingDataPendingUpdates
- Field location was added to object type
ElectricityMeterType - Field disconnectionMethod was added to object type
MeterPointType - Field sharedFuseGroupIdentifier was added to object type
MeterPointType
- Type
RunAgreementRolloverwas added - Type
RunAgreementRolloverInputwas added - Field runAgreementRollover was added to object type
Mutation
- Field assigneeTeamId was added to object type
Reminder - Field assigneeId was added to object type
Reminder - Input Field assigneeTeamId: ID was added to input type
CreateReminderInput - Input Field assigneeId: ID was added to input type
CreateReminderInput
- Type
CreateTemplateOutputwas added - Type
CreateTemplateInputwas added - Type
TemplateGroupInputwas added - Type
TemplateLineItemInputwas added - Type
UpdateTemplateOutputwas added - Type
UpdateTemplateInputwas added - Type
DeleteTemplateOutputwas added - Type
ActivateTemplatesOutputwas added - Type
ExpireTemplatesOutputwas added - Field activateTemplates was added to object type
Mutation - Field deleteTemplate was added to object type
Mutation - Field updateTemplate was added to object type
Mutation - Field expireTemplates was added to object type
Mutation - Field createTemplate was added to object type
Mutation
- Type
TemplateTypewas added - Type
TemplateStatuswas added - Type
TemplateGroupTypewas added - Type
GroupCategorywas added - Type
TemplateLineItemTypewas added - Type
CurrencyTypewas added - Type
TemplateFilterInputwas added - Field latestActiveTemplate was added to object type
Query - Field latestTemplate was added to object type
Query - Field templates was added to object type
Query - Field template was added to object type
Query
- Type
ShowInputFieldErrorsActionTypewas added - Type
InputFieldErrorTypewas added - Type
FormScreenTypewas added - Union member FormScreenType was added to
BackendScreenTypeUnion type - Union member ShowInputFieldErrors
ActionTypewas added toActionTypeUnion type
- Enum value WATER was added to
OnSiteJobsWorkCategoryenum - Enum value SEWER was added to
OnSiteJobsWorkCategoryenum - Enum value SUPPLY_SERVICE_WORKS was added to
OnSiteJobsWorkCategoryenum - Enum value INTERNAL was added to
OnSiteJobsWorkCategoryenum - Enum value METERING_SERVICE_WORKS was added to
OnSiteJobsWorkCategoryenum
- Type
OpportunityAttachmentCategorywas added CreateOpportunityFileAttachmentInput.category type changed from String! to OpportunityAttachmentCategory!GenerateLeadsFileAttachmentPreSignedUrlInput.category type changed from String! to OpportunityAttachmentCategory!OpportunityAttachment.category type changed from String toOpportunityAttachmentCategory
- Input Field freeText: String was added to input type
LeadsQueryInput
- Field isPinned was added to object type
KrakenVersionType - Argument supplyPointInternalIds: [Int] added to
Query.getOnSiteJobsCheckResults - Type for argument supplyPointIdentifierToMarketNameMapping on field
Query.getOnSiteJobsCheckResults changed from [SupplyPointIdentifierToMarketNameMappingInput]! to [SupplyPointIdentifierToMarketNameMappingInput]
- Type
RevokeContractOutputwas added - Type
RevokeContractInputwas added - Field clientMutationId was removed from object type
AddNoteToInkConversation - Field revokeContract was added to object type
Mutation - Field clientMutationId was removed from object type
AssignInkBucket - Field clientMutationId was removed from object type
CreateInkInboundMessage - Field clientMutationId was removed from object type
UpdateMessageTags
- Type
CreateAgreementRolloverwas added - Type
AgreementRolloverTypewas added - Type
AgreementRolloverRolloverTypewas added - Type
AgreementRolloverStatuswas added - Type
CreateAgreementRolloverInputwas added - Field createAgreementRollover was added to object type
Mutation - Argument supplyPointInternalIds: [Int] added to
Query.getOnSiteJobsRequests
APIExceptionType.userId type changed from Int to BigInt- Field concessionCreditToDate was added to object type
PredictedBillComponentsType
QuoteComponentType.quotingParamsInputData type changed from JSONString to [QuotingParamType]- Field value was added to object type
QuotingParamType - Field source was added to object type
QuotingParamType
- Type
ChangeSupplierForSupplyPointwas added - Type
ChangeSupplierForSupplyPointInputwas added - Field changeSupplierForSupplyPoint was added to object type
Mutation
- Input Field addonBands: [String] was added to input type
MarketAcquisitionDetailsInput - Input Field addonBands: [String] was added to input type
ElectricityAcquisitionDetailsInput - Input Field addonBands: [String] was added to input type
GasAcquisitionDetailsInput
- Type
GetOrCreateShellAccountForOpportunitywas removed - Type
GetOrCreateShellAccountForOpportunityInputwas removed - Type
OpportunityAttachmentwas added - Input Field createdByOrganization: String was added to input type
OpportunitiesQueryInput - Input Field salesChannel: String was added to input type
OpportunitiesQueryInput - Input Field leadType: LeadTypeChoices was added to input type
LeadsQueryInput - Field attachments was added to object type
OpportunityOutput - Field getOrCreateAccountForOpportunity was removed from object type
Mutation
- Type
UpdateAccountReferralStatuswas added - Type
UpdateAccountReferralStatusInputwas added - Field updateAccountReferralStatus was added to object type
Mutation
- Type
MeterReadingEstimationReadingConnectionwas added - Type
MeterReadingEstimationReadingEdgewas added - Type
MeterReadingEstimationReadingTypewas added - Type
AssignSupplyPointToEstimationGroupwas added - Type
AssignedSupplyPointEstimationGroupTypewas added - Type
AssignSupplyPointToEstimationGroupInputwas added - Type
DetachSupplyPointFromEstimationGroupwas added - Type
DeletedSupplyPointEstimationGroupTypewas added - Type
DetachSupplyPointFromEstimationGroupInputwas added - Field detachSupplyPointFromEstimationGroup was added to object type
Mutation - Field assignSupplyPointToEstimationGroup was added to object type
Mutation
- Argument supportUserName: String! added to
Query.agentCallCenterStatus - Removed argument supportUserId from
Query.agentCallCenterStatus
- Type
RetrieveOpportunityFileAttachmentInputwas removed - Type
FetchPreSignedLinkForOpportunityAttachmentwas added - Type
FetchPreSignedLinkForOpportunityAttachmentInputwas added - Field presignedUrl was added to object type
OpportunityFileAttachment - Field fetchUrl was removed from object type
OpportunityFileAttachment - Field retrieveOpportunityFileAttachment was removed from object type
Query - Field fetchPreSignedLinkForOpportunityAttachment was added to object type
Mutation
- Type
ContractFiltersInputwas added - Field contracts was added to object type
Query
- Field createdBy was added to object type
OnSiteJobsRequestType
- Input Field affiliateDetails: AffiliateDetails was added to input type
ProcessHouseMoveInput
OnSiteJobsAssetType.supplyPointIdentifier type changed from String to String!
- Type
Periodwas added - Field productOffering was added to object type
OpportunityOutput CreateLeadInput.nationalId type changed from String! to String- Default value for input field
CreateLeadInput.nationalId changed from Undefined to None CreateOpportunityAndLeadInput.nationalId type changed from String! to String- Field period was added to object type
SupplyOrServiceCharge
- Type
SalesFunnelRulewas added - Type
OpportunityFileAttachmentwas added - Type
RetrieveOpportunityFileAttachmentInputwas added - Field retrieveOpportunityFileAttachment was added to object type
Query - Field rules was added to object type
SalesFunnel
- Type
AgentCallCenterStatusTypewas added - Field agentCallCenterStatus was added to object type
Query
- Type
ServiceOrderCoincidenceCheckwas added - Type
CoincidenceCheckOutcomewas added - Field serviceOrderCoincidenceCheck was added to object type
Mutation
- Enum value PARTIALLY_COMPLETE was added to
OnSiteJobsAppointmentStatusenum - Enum value DISPATCHED was added to
OnSiteJobsAppointmentStatusenum
- Input Field userNumber: String was added to input type
RequestPasswordResetInput RequestPasswordResetInput.email type changed from String! to String- Field userNumber was added to object type
RequestPasswordResetOutputType