Skip to main content

GraphQL API Changelog

This page shows the history of changes to the GraphQL schema.
  • Enum value Smc was added to ConsumptionUnit enum
  • Deprecation reason on field AccountPaymentType.id changed from None to
    The 'id' field is deprecated.

    Please use uuid instead.

    - Marked as deprecated on 2026-05-28.
    - Scheduled for removal on or after 2026-08-28.
  • AccountPaymentType.id type changed from ID! to ID
  • Type SupplyPointType was removed
  • Type CommonSupplyPointInterface was removed
  • Type HasReadings was removed
  • Type Units was removed
  • Type DevicesConnection was removed
  • Type DevicesEdge was removed
  • Type Device was removed
  • Type RegistersConnection was removed
  • Type RegistersEdge was removed
  • Type DeviceRegister was removed
  • Type WaterSupplyPointType was added
  • Field externalIdentifier of type String was added to interface SupplyPointInterface
  • MarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointType to SupplyPointInterface
  • Field externalIdentifier was added to object type ElectricitySupplyPointType
  • CommonAgreementType.supplyPoint type changed from SupplyPointType! to SupplyPointInterface!
  • Field externalIdentifier was added to object type GasSupplyPointType
  • Query.supplyPoint type changed from SupplyPointType to SupplyPointInterface
  • SupplyPointConnectionTypeEdge.node type changed from SupplyPointType to SupplyPointInterface
  • Deprecation reason on field LeadOutput.assignedToTeamIdentifier changed from None to
    The 'assignedToTeamIdentifier' field is deprecated.

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

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

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

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

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

    - Marked as deprecated on 2026-05-19.
    - Scheduled for removal on or after 2026-07-19.
  • Type StartOnSiteJobsAppointmentBookingSession was removed
  • Type StartOnSiteJobsAppointmentBookingSessionForRequest was added
  • Field startOnSiteJobsAppointmentBookingSessionForRequest was added to object type Mutation
  • Field startOnSiteJobsAppointmentBookingSession was removed from object type Mutation
  • Type SupplyPointType was removed
  • Type CommonSupplyPointInterface was removed
  • Type HasReadings was removed
  • Type Units was removed
  • Type DevicesConnection was removed
  • Type DevicesEdge was removed
  • Type Device was removed
  • Type RegistersConnection was removed
  • Type RegistersEdge was removed
  • Type DeviceRegister was removed
  • Type WaterSupplyPointType was added
  • CommonAgreementType.supplyPoint type changed from SupplyPointType! to SupplyPointInterface!
  • SupplyPointConnectionTypeEdge.node type changed from SupplyPointType to SupplyPointInterface
  • MarketSupplyQuotedSupplyPointType.supplyPoint type changed from SupplyPointType to SupplyPointInterface
  • Query.supplyPoint type changed from SupplyPointType to SupplyPointInterface
  • Type UpdateLeadAssignment was removed
  • Type UpdateLeadAssignmentInput was removed
  • Deprecation reason on field Lead.assignedToTeamIdentifier changed from None to
    The 'assignedToTeamIdentifier' field is deprecated.

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

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

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

    - Marked as deprecated on 2026-05-19.
    - Scheduled for removal on or after 2026-07-19.
  • Field updateLeadAssignment was removed from object type Mutation
  • Enum value BOTTOMLINE_PTX_BATCHED_HD_NHH was added to Vendor enum
  • Enum value BOTTOMLINE_PTX_BATCHED_HD was added to Vendor enum
  • Deprecation reason on field Lead.salesChannel changed from None to
    The 'salesChannel' field is deprecated.

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

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

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

    - Marked as deprecated on 2025-06-17.
    - Scheduled for removal on or after 2025-10-17.
  • Enum value ANZ was added to Vendor enum
  • Field ptjNumber was removed from object type NotifiedPartyTransactionType
  • Enum value MEGAWATT_HOURS was added to Units enum
  • Argument displayableNumber: String added to Query.business
  • Field displayableNumber was added to object type BusinessType
  • Input Field email removed from input type ObtainJSONWebTokenInput
  • Input Field password removed from input type ObtainJSONWebTokenInput
  • Input Field captchaResponse removed from input type ObtainJSONWebTokenInput
  • Deprecation reason on field NotifiedPartyTransactionType.ptjNumber changed from None to
    The 'ptjNumber' field is deprecated.

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

    - Marked as deprecated on 2026-05-11.
    - Scheduled for removal on or after 2026-08-11.
  • Deprecation reason on field Lead.assignedToOrganization changed from None to
    The 'assignedToOrganization' field is deprecated.

    Please use 'assignedToTeamIdentifier' instead.

    - Marked as deprecated on 2026-05-07.
    - Scheduled for removal on or after 2026-07-07.
  • Field estimateMeterReadings was added to object type Query
  • Enum value UNSUPPORTED_FEATURE was removed from AccountReminderTypes enum
  • Field quoteConfiguration was added to object type UpdateQuoteConfigurationOutput
  • Field quoteConfigurationNumber was removed from object type UpdateQuoteConfigurationOutput
  • Deprecation reason on field Query.energyMixData changed from None to
    The 'energyMixData' field is deprecated.

    This is no longer being used.

    - Marked as deprecated on 2026-05-05.
    - Scheduled for removal on or after 2026-06-01.
  • Type BaseInstigateContractTerminationInput was removed
  • Type ContractTerminationInstigated was removed
  • Field instigateContractTermination was removed from object type Mutation
  • Input Field assignedToTeamIdentifier: String was added to input type CreateLeadInput
  • Input Field assignedToUserIdentifier: String was added to input type CreateLeadInput
  • Input Field assignedToTeamIdentifier: String was added to input type OpportunitiesQueryInput
  • Input Field assignedToUserIdentifier: String was added to input type OpportunitiesQueryInput
  • Field assignedToTeamIdentifier was added to object type OpportunityOutput
  • Field assignedToUserIdentifier was added to object type OpportunityOutput
  • Deprecation reason on field OpportunityOutput.assignedToUser changed from None to
    The 'assignedToUser' field is deprecated.

    Please use 'assignedToUserIdentifier' instead.

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

    Please use 'assignedToTeamIdentifier' instead.

    - Marked as deprecated on 2026-04-22.
    - Scheduled for removal on or after 2026-06-22.
  • Field assignedToTeamIdentifier was added to object type Lead
  • Field assignedToUserIdentifier was added to object type Lead
  • Deprecation reason on field Lead.assignedToUsername changed from None to
    The 'assignedToUsername' field is deprecated.

    Please use 'assignedToUserIdentifier' instead.

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

    Please use 'assignedToUserIdentifier' instead.

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

    Please use 'assignedToTeamIdentifier' instead.

    - Marked as deprecated on 2026-04-22.
    - Scheduled for removal on or after 2026-06-22.
  • Input Field assignedToTeamIdentifier: String was added to input type UpdateLeadDetailsInput
  • Input Field assignedToUserIdentifier: String was added to input type UpdateLeadDetailsInput
  • Field source was removed from object type Reading
  • Field quality was removed from object type Reading
  • Type LocaltimeMidnightAlignedDateField was removed
  • CreateContractInput.signedAtDate type changed from LocaltimeMidnightAlignedDateField to IndustryMidnightAlignedDateField
  • Enum value AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING was removed from AccountReminderTypes enum
  • Enum value INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE was removed from AccountReminderTypes enum
  • Input Field device: String was added to input type AccountSearchInputType
  • Enum value SOLAR_EXPORT_CREDITS_EXCESS was removed from AccountReminderTypes enum
  • Type ServiceOrderResponseStatus was removed
  • ServiceOrderCompletionDetails.closureCode type changed from ServiceOrderResponseStatus! to ServiceOrderStatus!
  • Deprecation reason on field Mutation.makePaymentWithSavedCard changed from
    The 'makePaymentWithSavedCard' field is deprecated.

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

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

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

    - Marked as deprecated on 2025-05-26.
    - Scheduled for removal on or after 2026-07-26.
  • Enum value CANCELLED_BY_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum
  • Enum value ADYEN was added to Vendor enum
  • Enum value GAS_EXCEPTION_CUSTOMER_TRANSFER_CANCELLED was removed from AccountReminderTypes enum
  • Field isOfficial was added to object type ComplaintType
  • Field inkLiveChatConversations was added to object type Query
  • Field isWorkRequiredForServiceOrder was added to object type Query
  • Enum value ACCURACY_TEST was removed from OnSiteJobsWorkCategory enum
  • Field stepName was removed from object type AgreementRescissionType
  • Type ProductType was removed
  • Type PublishApprovalApprovedEvent was removed
  • Type PublishApprovalApprovedEventInput was removed
  • Type InstigateContractVariationOutput was removed
  • Type InstigateContractVariationInput was removed
  • Type CatalogProductTypeEnum was added
  • Type InkConversationsConnection was added
  • Type InkConversationsEdge was added
  • Type ExtendAgreementPeriod was added
  • Type ExtendAgreementPeriodInput was added
  • Type IsWorkRequiredForServiceOrderType was added
  • Type CompleteServiceOrder was added
  • Type CompleteServiceOrderInput was added
  • Type ServiceOrderCompletionDetails was added
  • Type ServiceOrderResponseStatus was added
  • Type ServiceOrderChargeInput was added
  • Type SimpleServicesAgreementType was added
  • Type AssociateArchivedRecordingsSummaryType was added
  • Type AssociateArchivedRecordingResultType was added
  • Type AssociateArchivedRecordingResultStatus was added
  • Type StartOnSiteJobsAppointmentReschedulingSession was added
  • Type SetLastConsumerChangeDateRecordToBeExpired was added
  • Type SetLastConsumerChangeDateRecordToBeExpiredInput was added
  • Field results was added to object type AssociateArchivedCallRecordingsWithCalls
  • Field summary was added to object type AssociateArchivedCallRecordingsWithCalls
  • Field receivedCount was removed from object type AssociateArchivedCallRecordingsWithCalls
  • Field params was added to object type Reminder
  • Field stepSlug was removed from object type AgreementRescissionType
  • Input Field assignedToAffiliateNumber: String was added to input type UpdateLeadAssignmentInput
  • Field lastMessageAt was added to object type InkConversation
  • Field completeServiceOrder was added to object type Mutation
  • Field extendAgreementPeriod was added to object type Mutation
  • Field startOnSiteJobsAppointmentReschedulingSession was added to object type Mutation
  • Field setLastConsumerChangeDateRecordToBeExpired was added to object type Mutation
  • Field instigateContractVariation was removed from object type Mutation
  • Field publishApprovalApprovedEvent was removed from object type Mutation
  • Removed argument appointmentIdToReschedule from Mutation.startOnSiteJobsAppointmentBookingSession
  • Field required was added to object type FunnelField
  • Deprecation reason on field FunnelField.deprecated changed from None to
    The 'deprecated' field is deprecated.

    Fields are not being deprecated

    - Marked as deprecated on 2026-04-20.
    - Scheduled for removal on or after 2026-05-20.
  • Input Field assignedToAffiliateNumber: String was added to input type UpdateOpportunityAssignmentInput
  • Enum value RESCINDED was added to ContractStatus enum
  • Field conversationRelayId was added to object type EscalateInkConversation
  • Field conversation was removed from object type EscalateInkConversation
  • Input Field archivedRecordingFileUri: URI! was added to input type ArchivedCallRecordingInput
  • Input Field publicRecordingFileUri removed from input type ArchivedCallRecordingInput
  • Input Field accountNumber: String! was added to input type EscalateInkConversationInput
  • Field preferredDate was added to object type WorkRequestSpecOutputType
  • Input Field flowRunIdentifier: String! was added to input type PublishMeterDataIssueEmailInput
  • Field label was added to object type QuotingParamType
  • Deprecation reason on field SalesFunnel.uncollectedFields changed from None to
    The 'uncollectedFields' field is deprecated.

    Is not necessary since fields are part of a collection

    - Marked as deprecated on 2026-04-20.
    - Scheduled for removal on or after 2026-05-20.
  • Input Field params: JSONString was added to input type CreateReminderInput
  • Input Field stepSlug removed from input type UpdateAgreementRescissionInput
  • Input Field stepName removed from input type UpdateAgreementRescissionInput
  • Enum value AWAITING_APPROVAL was added to CatalogComponentStatus enum
  • CatalogProductType.sourceProductType type changed from ProductType to CatalogProductTypeEnum
  • Enum value INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CANCELLED was removed from AccountReminderTypes enum
  • Enum value INDUSTRY_EXCEPTION_CHANGE_REQUEST_COMPLETED was removed from AccountReminderTypes enum
  • Enum value JPN_SUPPLY_POINT_FAILS_CAN_SUPPLY_CHECK was removed from AccountReminderTypes enum
  • Enum value INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_NEXT_SCHEDULED_READ_DATE_PAST was removed from AccountReminderTypes enum
  • Enum value INDUSTRY_MANUAL_ACTION_REQUIRED was removed from AccountReminderTypes enum
  • Enum value JPN_SHORT_TERM_MOVE_IN_REJECTION was removed from AccountReminderTypes enum
  • Enum value CANCELLED_BY_BUSINESS was added to OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_SUPPLIER was added to OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum
  • Input Field assignedToTeamName: String was added to input type UpdateLeadDetailsInput
  • Input Field assignedToAffiliateNumber: String was added to input type UpdateLeadDetailsInput
  • Input Field assignedToUsername: String was added to input type UpdateLeadDetailsInput
  • Enum value UPDATE_IN_PROGRESS was added to LifecycleSupplyPointProcessStatus enum
  • Enum value UPDATE_ERRORED was added to LifecycleSupplyPointProcessStatus enum
  • Enum value UPDATE_STALLED was added to LifecycleSupplyPointProcessStatus enum
  • Enum value UPDATE_FAILED was added to LifecycleSupplyPointProcessStatus enum
  • Input Field externalPropertyReference: String was added to input type AccountSearchInputType
  • Enum value GIGAJOULES_CONSUMPTION was added to UnitType enum
  • Enum value COMMS_HUB_REPLACEMENT was removed from OnSiteJobsWorkCategory enum
  • Enum value IHD_INSTALL was removed from OnSiteJobsWorkCategory enum
  • Enum value INVESTIGATE_FAULT was removed from OnSiteJobsWorkCategory enum
  • Enum value REINSTALL was removed from OnSiteJobsWorkCategory enum
  • Enum value REPLACE_SEALS was removed from OnSiteJobsWorkCategory enum
  • Enum value AD_HOC_READING was removed from OnSiteJobsWorkCategory enum
  • Enum value COMMISSION was removed from OnSiteJobsWorkCategory enum
  • Enum value REMOVE was removed from OnSiteJobsWorkCategory enum
  • Enum value MOVE was removed from OnSiteJobsWorkCategory enum
  • Enum value EXCHANGE was removed from OnSiteJobsWorkCategory enum
  • Enum value COMMS_HUB_POWER_CYCLE was removed from OnSiteJobsWorkCategory enum
  • Enum value CONFIRM_METER_DETAILS was removed from OnSiteJobsWorkCategory enum
  • Enum value ISOLATOR_SWITCH_INSTALL was removed from OnSiteJobsWorkCategory enum
  • Enum value BRACKET_INSTALLATION was removed from OnSiteJobsWorkCategory enum
  • Enum value METER_TAILS_UPGRADE was removed from OnSiteJobsWorkCategory enum
  • Enum value NEW_CONNECTION was removed from OnSiteJobsWorkCategory enum
  • Enum value EV was removed from OnSiteJobsWorkCategory enum
  • Enum value INDUSTRY_WARNING_MESSAGE_RECEIVED was removed from AccountReminderTypes enum
  • Enum value REQUESTED was removed from OnSiteJobsAssetStatus enum
  • Deprecation reason on field Mutation.instigateContractTermination changed from None to
    The 'instigateContractTermination' field is deprecated.

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

    - Marked as deprecated on 2026-04-01.
    - Scheduled for removal on or after 2026-04-30.
  • Type ConcessionCardValidationMethod was removed
  • ConcessionCardValidationType.method type changed from ConcessionCardValidationMethod to String
  • Field 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 CreateAccountCredit was removed
  • Type CreateAccountCreditInput was removed
  • Type AccountCreditReasonType was removed
  • Argument accountNumbers: [NonEmptyString!] added to Query.getOnSiteJobsRequests
  • Field createAccountCredit was removed from object type Mutation
  • Argument excludeByDisplayName: [String] added to Query.vouchersForAccount
  • Enum value CANCELLED_BY_CUSTOMER was added to OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_PROVIDER___ERROR_IN_MIDDLEWARE was added to OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER was added to OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_BUSINESS was removed from OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_SUPPLIER was removed from OnSiteJobsAppointmentCancellationCategory enum
  • Enum value CANCELLED_BY_PROVIDER was removed from OnSiteJobsAppointmentCancellationCategory enum
  • Enum value DUPLICATE_CARD_FINGERPRINTS was added to AccountReminderTypes enum
  • Enum value DUPLICATE_CARD_FINGERPRINTs was removed from AccountReminderTypes enum
  • Argument offset: Int added to Query.leads
  • Argument offset: Int added to Query.opportunities
  • Field refundedAt was added to object type VoucherPurchaseType
  • Argument excludeRefunded: Boolean added to Query.vouchersForAccount
  • Type OrderDetailsType was removed
  • Type OrderType was removed
  • Type OrderCustomerType was removed
  • Type OrderLineType was removed
  • Type OrderItemType was removed
  • Type ItemProfileType was removed
  • Type OrderLinePeriodType was removed
  • Type OrderLineDateRangeType was removed
  • Type OrderLineDurationType was removed
  • Type OrderResource was removed
  • Type ProcessOrderOutput was removed
  • Type LegacyOrderDetailsType was added
  • Type LegacyOrderType was added
  • Type LegacyOrderCustomerType was added
  • Type LegacyOrderLineType was added
  • Type LegacyOrderItemType was added
  • Type LegacyItemProfileType was added
  • Type LegacyOrderLinePeriodType was added
  • Type LegacyOrderLineDateRangeType was added
  • Type LegacyOrderLineDurationType was added
  • Type LegacyOrderResource was added
  • Type LegacyProcessOrderOutput was added
  • Type OnSiteJobsExternalJobTypeMappingType was added
  • Field externalJobTypeMapping was added to object type OnSiteJobsAppointmentType
  • Deprecation reason on field OnSiteJobsAppointmentType.externalJobType changed from None to
    The 'externalJobType' field is deprecated.

    Please use externalJobTypeMapping instead.

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

    Use postCredit mutation as it is ledger aware.

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

    Use postCredit mutation as it is ledger aware.

    - Marked as deprecated on 2022-07-04.
    - Scheduled for removal on or after 2026-03-30.
  • Mutation.legacyProcessOrder type changed from ProcessOrderOutput! to LegacyProcessOrderOutput!
  • Field legacyOrderDetails was added to object type Query
  • Field orderDetails was removed from object type Query
  • Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from AccountReminderTypes enum
  • 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
  • Enum value CUSTOM was added to Vendor 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
  • Input Field organisationNumber: String was added to input type SalesInformationInput
  • Input Field organisationId removed from input type SalesInformationInput
  • 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.
  • 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
  • Enum value AMPERE_MONTHS was added to UnitType enum
  • Input Field leaveSupplierNumber: String was added to input type EnrollmentInput
  • Enum value D0010_CREATION_FAILURE was removed from AccountReminderTypes enum
  • 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
  • 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 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
  • Field assignedToAffiliateNumber was added to object type OpportunityOutput
  • Field assignedToAffiliateNumber was added to object type LeadOutput
  • Field agreementsForRollover was added to object type Query
  • 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
  • Argument appointmentIdToReschedule: UUID added to Mutation.startOnSiteJobsAppointmentBookingSession
  • 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 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
  • Enum value KW_DEMAND_DAYS was added to UnitType enum
  • 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
  • Input Field leadId removed from input type CreateOpportunityAndLeadInput
  • 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 ChangeRetailerForSupplyPoint was removed
  • Type ChangeRetailerForSupplyPointInput was removed
  • Field changeRetailerForSupplyPoint was removed from object type Mutation
  • Field canRescindAgreement was added to object type Query
  • 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.
  • Input Field assignedToTeamName: String was added to input type CreateLeadInput
  • Input Field assignedToUsername: String was added to input type CreateLeadInput
  • 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 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.
  • 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.
  • 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 INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_REQUEST_REJECTED was added to AccountReminderTypes enum
  • Field instigateBusinessContractTermination was removed from object type Mutation
  • 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 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 for argument filters on field Query.searchLead changed from SearchLeadFilters to SearchLeadFilters!
  • 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 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
  • Argument supportUserName: String! added to Query.agentCallCenterStatus
  • Removed argument supportUserId from Query.agentCallCenterStatus
On this page