GraphQL API Changelog

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

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

Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from AccountReminderTypes enum

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

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

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

Field possibleErrors was added to object type TriggerElectricityHouseMoveOut

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

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

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

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

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

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

Input Field externalIdentifier: String was added to input type SimpleServicesEnrollmentMarketInput

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

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

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

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

Deprecation reason on field Mutation.instigateContractVariation changed from None to The 'instigateContractVariation' field is deprecated. This is a legacy mutation. The varyContractTerms should be used instead. - Marked as deprecated on 2026-03-05. - Scheduled for removal on or after 2026-04-11.
Deprecation reason on field Mutation.varyContractTerms changed from The 'varyContractTerms' field is deprecated. This is a legacy mutation. The instigateContractVariation should be used instead. - Marked as deprecated on 2026-01-20. - Scheduled for removal on or after 2026-02-27. to None

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

Enum value POST_APPOINTMENT_ABORTED was added to OnSiteJobsAppointmentActionTriggerStage enum

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

Enum value CUSTOM was added to Vendor enum

Enum value SERVICE_TICKET was added to AccountPaymentTransactionTypeChoices enum

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

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

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

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

Field hasLifeSupportRecord was added to object type PropertyType

Deprecation reason on field Query.siteworksRequests changed from None to The 'siteworksRequests' field is deprecated. Please use getOnSiteJobsRequests instead. - Marked as deprecated on 2026-03-01. - Scheduled for removal on or after 2026-09-01.
Deprecation reason on field Mutation.updateSiteworksRequest changed from None to The 'updateSiteworksRequest' field is deprecated. Please use updateOnSiteJobsRequest instead. - Marked as deprecated on 2026-03-01. - Scheduled for removal on or after 2026-09-01.

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

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

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

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

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

Enum value AMPERE_MONTHS was added to UnitType enum

Input Field leaveSupplierNumber: String was added to input type EnrollmentInput

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

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

Enum value D0010_CREATION_FAILURE was removed from AccountReminderTypes enum

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

Input Field hideOnSupportSite: Boolean was added to input type CallMetadataItemInput

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

Input Field accountNumber: String was added to input type CreateLeadInput

Input Field ledgerNumber: String was added to input type FixedPaymentScheduleInput

Input Field emergencyApprovalDetails: String was added to input type CreateOnSiteJobsRequestInputType

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

Field tags was added to object type InkConversation

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

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

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

Enum value OTHER was added to OnSiteJobsAppointmentActionTriggerStage enum

Field agreement was added to object type Query

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

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

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

Field category was added to object type PropertyHazardType

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

Input Field businessId: Int was added to input type CreateReminderInput

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

Type ReadingType was added

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

Field agreementsForRollover was added to object type Query

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

Field priority was added to object type PropertyHazardType

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

Field field was added to object type ExtraDetail

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

Input Field cancelConflictingSchedules: Boolean was added to input type SwitchAccountToVariablePaymentScheduleInput

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

Argument appointmentIdToReschedule: UUID added to Mutation.startOnSiteJobsAppointmentBookingSession

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

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

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

Field accountNumber was added to object type InkConversation

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

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

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

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

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

Enum value FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITHOUT_CUSTOMER_CONSULTATION was added to AccountReminderTypes enum

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

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

Field account was added to object type CommonAgreementType

Enum value KW_DEMAND_DAYS was added to UnitType enum

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

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

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

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

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

Field openingBalance was added to object type PeriodBasedDocumentType

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

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

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

Field getElectricityServiceOrderById was added to object type Query

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

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

EndMeterDataIssueFlowInputType.status type changed from String! to MeterDataIssueFlowStatus!

Input Field sendComms: Boolean was added to input type UpdateHardshipAgreementInput

Input Field leadId removed from input type CreateOpportunityAndLeadInput

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

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

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

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

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

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

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

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

Field canRescindAgreement was added to object type Query

Input Field accountNumber: String was added to input type CloseInkLiveChaConversationtInput

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

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

Type CreateOrUpdateTimeSeriesEntries was added
Type CreateOrUpdateTimeSeriesEntriesInput was added
Field createOrUpdateTimeSeriesEntries was added to object type Mutation
Deprecation reason on field Mutation.createTimeSeriesPrices changed from None to The 'createTimeSeriesPrices' field is deprecated. Please use the 'createOrUpdateTimeSeriesEntries' mutation instead. - Marked as deprecated on 2025-02-03. - Scheduled for removal on or after 2025-03-01.

Field wasCreated was added to object type CreateContractOutput

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

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

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

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

Input Field useForAutomatedPayments: Boolean was added to input type CreateDirectDebitInstructionInput

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

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

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

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

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

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

Field phones was added to object type OutageContactType
Deprecation reason on field OutageContactType.phoneNumber2 changed from None to The 'phoneNumber2' field is deprecated. Use the phones field to get all phone details associated with the contact person. - Marked as deprecated on 2026-01-30. - Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phone2 changed from None to The 'phone2' field is deprecated. Use the phones field to get all phone details associated with the contact person. - Marked as deprecated on 2026-01-30. - Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phoneNumber1 changed from None to The 'phoneNumber1' field is deprecated. Use the phones field to get all phone details associated with the contact person. - Marked as deprecated on 2026-01-30. - Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phoneNumber2ServiceType changed from None to The 'phoneNumber2ServiceType' field is deprecated. Use the phones field to get all phone details associated with the contact person. - Marked as deprecated on 2026-01-30. - Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phone1 changed from None to The 'phone1' field is deprecated. Use the phones field to get all phone details associated with the contact person. - Marked as deprecated on 2026-01-30. - Scheduled for removal on or after 2026-05-30.
Deprecation reason on field OutageContactType.phoneNumber1ServiceType changed from None to The 'phoneNumber1ServiceType' field is deprecated. Use the phones field to get all phone details associated with the contact person. - Marked as deprecated on 2026-01-30. - Scheduled for removal on or after 2026-05-30.

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

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

Field storedPaymentMethodDetailsReference was added to object type JoinSupplierProcessDataType

Deprecation reason on field Query.defaultPaymentInstruction changed from None to The 'defaultPaymentInstruction' field is deprecated. Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger. - Marked as deprecated on 2026-01-28. - Scheduled for removal on or after 2026-07-28.

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

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

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

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

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

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

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

Input Field stageCode: String was added to input type LeadsQueryInput

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

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

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

Field numberOfOccupants was added to object type OccupancyPeriodType

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

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

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

Enum value DNK_ORE was added to LineItemCurrency enum

Enum value INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_REQUEST_REJECTED was added to AccountReminderTypes enum

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

Field instigateBusinessContractTermination was removed from object type Mutation

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

Type InstigateContractVariationOutput was added
Type InstigateContractVariationInput was added
Field instigateContractVariation was added to object type Mutation
Deprecation reason on field Mutation.varyContractTerms changed from None to The 'varyContractTerms' field is deprecated. This is a legacy mutation. The instigateContractVariation should be used instead. - Marked as deprecated on 2026-01-20. - Scheduled for removal on or after 2026-02-27.

Input Field identifier removed from input type CreateContractInput

Field supplyPointInternalIdentifier was added to object type OnSiteJobsAssetType
Deprecation reason on field OnSiteJobsAssetType.supplyPointIdentifier changed from None to The 'supplyPointIdentifier' field is deprecated. Use 'supplyPointInternalIdentifier' instead. This field is being removed as the underlying model field is being removed. - Marked as deprecated on 2026-01-16. - Scheduled for removal on or after 2026-03-01.
OnSiteJobsAssetType.supplyPointIdentifier type changed from String! to String

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

Type ExtraDetail was added
Field extraDetailItems was added to object type LeadOutput
Deprecation reason on field LeadOutput.extraDetails changed from None to The 'extraDetails' field is deprecated. Use extraDetailsItems instead, which provides a structured key/value format. - Marked as deprecated on 2026-01-14. - Scheduled for removal on or after 2026-07-14.
Input Field extraDetailItems: [ExtraDetailsItem] was added to input type LeadContactDetailsInput
Input Field extraDetails removed from input type LeadContactDetailsInput
Field extraDetailItems was added to object type OpportunityOutput
Deprecation reason on field OpportunityOutput.extraDetails changed from None to The 'extraDetails' field is deprecated. Use extraDetailsItems instead, which provides a structured key/value format. - Marked as deprecated on 2026-01-14. - Scheduled for removal on or after 2026-07-14.

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

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

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

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

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

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

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

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

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

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

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

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

Input Field freeText: String was added to input type LeadsQueryInput

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

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

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

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

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

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

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

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

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

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

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

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

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

Field createdBy was added to object type OnSiteJobsRequestType

Input Field affiliateDetails: AffiliateDetails was added to input type ProcessHouseMoveInput

OnSiteJobsAssetType.supplyPointIdentifier type changed from String to String!

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

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

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

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

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

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

On this page