Skip to main content

GraphQL API Changelog

This page shows the history of changes to the GraphQL schema.
  • Type SMSEventType was added
  • Type SMSMessageType was added
  • Type AttachmentType was added
  • Field id was added to object type Reminder
  • Enum value SMS_RECEIVED was added to AccountEventType enum
  • Enum value SMS_SENT was added to AccountEventType enum
  • PushNotificationBindingType.messages type changed from PrintMessageTypeConnection! to [SMSMessageType!]!
  • Removed argument before from PushNotificationBindingType.messages
  • Removed argument after from PushNotificationBindingType.messages
  • Removed argument offset from PushNotificationBindingType.messages
  • Removed argument last from PushNotificationBindingType.messages
  • Removed argument first from PushNotificationBindingType.messages
  • Union member SMSEventType was added to AccountEvent Union type
  • Enum value SMART_PREPAY_TOP_UP_MULTIPLE_ACTIVE_PROCESSES was removed from AccountReminderTypes enum
  • Enum value STRIPE_CONNECT_VOICE was added to Vendor enum
  • Type TerminateContractInput was removed
  • Type BaseTerminateContractInput was added
  • Type for argument input on field Mutation.terminateBusinessContract changed from TerminateContractInput! to BaseTerminateContractInput!
  • Type for argument input on field Mutation.terminateAccountContract changed from TerminateContractInput! to BaseTerminateContractInput!
  • Enum value LEGACY_TWILIO_CTI was removed from VoiceVendor enum
  • Enum value FAKE was removed from VoiceVendor enum
  • Field isVariable was added to object type GuaranteeOfOriginConfigurationType
  • Deprecation reason on field GuaranteeOfOriginConfigurationType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • GetHostedUrlForNewPaymentInstructionInput.ledgerNumber type changed from String! to String
  • Field isVariable was added to object type ContractMetaDataType
  • Deprecation reason on field ContractMetaDataType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • Deprecation reason on field Mutation.setBatteryChargingPreferences changed from None to The 'setBatteryChargingPreferences' field is deprecated. Please use setDevicePreferences instead of this endpoint. - Marked as deprecated on 2025-04-04. - Scheduled for removal on or after 2025-07-04.
  • Field isVariable of type Boolean was added to interface TermInterface
  • Deprecation reason on field TermInterface.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • Field isVariable was added to object type TermType
  • Deprecation reason on field TermType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • Field isVariable was added to object type MinimumContractLengthType
  • Deprecation reason on field MinimumContractLengthType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • Field isVariable was added to object type TerminationFeeType
  • Deprecation reason on field TerminationFeeType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • Field isVariable was added to object type ProductRateOverrideConfigurationType
  • Deprecation reason on field ProductRateOverrideConfigurationType.isAmendable changed from None to The 'isAmendable' field is deprecated. This field has been replaced by isVariable. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-05-01.
  • Enum value TG_PAYMENTS_MYPAY was added to Vendor enum
  • Field userId was added to object type ResetUserPasswordOutput
  • Deprecation reason on field ResetUserPasswordOutput.passwordUpdated changed from None to The 'passwordUpdated' field is deprecated. Please handle the KT-CT-5450 error instead. Note that the KT-CT-5450 error will not be raised if you request any of the failureCodes, failureReasons, or passwordUpdated fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
  • Deprecation reason on field ResetUserPasswordOutput.failureCodes changed from None to The 'failureCodes' field is deprecated. Please handle the KT-CT-5450 error and inspect the validationErrors[].code extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the failureCodes, failureReasons, or passwordUpdated fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
  • Deprecation reason on field ResetUserPasswordOutput.failureReasons changed from None to The 'failureReasons' field is deprecated. Please handle the KT-CT-5450 error and inspect the validationErrors[].message extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the failureCodes, failureReasons, or passwordUpdated fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
  • Type CreateNewLead was removed
  • Type NewLeadType was removed
  • Type NewLeadInputType was removed
  • Field createNewLead was removed from object type Mutation
  • Field acceptsPayments of type Boolean was added to interface LedgerInterface
  • Field acceptsPayments was added to object type LedgerType
  • Argument accountNumber: String added to Query.businessContract
  • Type for argument identifier on field Query.businessContract changed from String! to String
  • Argument accountNumber: String added to Query.accountContract
  • Type for argument identifier on field Query.accountContract changed from String! to String
  • Field opportunityValueByKey was added to object type Query
  • Field leadValueByKey was removed from object type Query
  • Input Field requestedTerminationDate: Date! was added to input type TerminateContractInput
  • Input Field requestedTerminationAt removed from input type TerminateContractInput
  • Type UpdateLeadExtraDetails was removed
  • Type UpdateOpportunityExtraDetails was added
  • Input Field opportunityId: ID was added to input type UpdateExtraDetailsInput
  • Input Field leadId removed from input type UpdateExtraDetailsInput
  • Field updateOpportunityExtraDetails was added to object type Mutation
  • Field updateLeadExtraDetails was removed from object type Mutation
  • Enum value TESORO_SEPA_CORE was added to Vendor enum
  • Input Field leadType removed from input type NewLeadInputType
  • Field leadType was removed from object type NewLeadType
  • Type RateLimitInformation was removed
  • Field rateLimit was removed from object type Query
  • Enum value SMETS2_IHD_HEALTH_CHECK was removed from AccountReminderTypes enum
  • Enum value SMETS2_DATA_REQUEST_FOLLOWUP was removed from AccountReminderTypes enum
  • Enum value SMETS2_HEALTH_CHECK was removed from AccountReminderTypes enum
  • Field createDirectDebitInstruction was removed from object type Mutation
  • Type CreateDirectDebitInstruction was removed
  • Type CreateDirectDebitInstructionInput was removed
  • Type DirectDebitInstructionIBANInput was removed
  • Argument identifier: String added to field AccountInterface.bill
  • Argument identifier: String added to field AccountType.bill
  • Type for argument id on field AccountInterface.bill changed from ID! to ID
  • Type for argument id on field AccountType.bill changed from ID! to ID
  • Field linkedAccountNumbers was added to object type BusinessType
  • Directive deprecated was added to field BusinessType.linkedAccountNumber
  • Field BusinessType.linkedAccountNumber has deprecation reason The linkedAccountNumber field is deprecated. Please use linkedAccountNumbers instead, businesses can be related to multiple Accounts now. - Marked as deprecated on 2025-02-05. - Scheduled for removal on or after 2025-08-01.
  • Field BusinessType.linkedAccountNumber is deprecated
  • Field possibleErrors is deprecated on Mutation type. Please use the possibleErrors query or the X
  • Field possibleErrors was added to object type PossibleErrorsOutputType
  • Field possibleErrorsList was removed from object type PossibleErrorsOutputType
  • Field setLeadOutcome was added to object type Mutation
  • Type SetLeadOutcome was added
  • Type SetLeadOutcomeInput was added
  • Argument direction: EnergyProductDirection added to field Query.energyProducts
  • Argument after: String added to field CoreSiteworksRequestType.marketSupplyPoints
  • Argument before: String added to field CoreSiteworksRequestType.marketSupplyPoints
  • Argument first: Int added to field CoreSiteworksRequestType.marketSupplyPoints
  • Argument last: Int added to field CoreSiteworksRequestType.marketSupplyPoints
  • Field updateSiteworksRequest was added to object type Mutation
  • Object type CoreSiteworksRequestType has description A Siteworks Request
  • Type SiteworksRequestStatus was added
  • Type UUID was added
  • Type UpdateSiteworksRequest was added
  • Type UpdateSiteworksRequestInputType was added
  • Field CoreSiteworksRequestType.id changed type from ID! to UUID!
  • Field CoreSiteworksRequestType.marketSupplyPoints changed type from [CoreSiteworksMarketSupplyPointType]! to SupplyPointConnectionTypeConnection
  • Field CoreSiteworksRequestType.status changed type from RequestStatus! to SiteworksRequestStatus!
  • Type CoreSiteworksMarketSupplyPointType was removed
  • Field preferredSsd was added to object type AccountApplicationType
  • Description An enumeration. was removed from object type AccountApplicationStatus
  • Field cosLossStatus (deprecated) was removed from object type Agreement
  • Field completeLeadAction was added to object type Mutation
  • Type CompleteLeadActionInput was added
  • Type CompleteLeadAction was added
  • Field authorizedApplications was added to object type Query
  • Type AuthorizedApplication was added
  • Directive deprecated was added to field LedgerInterface.id
  • Directive deprecated was added to field LedgerType.id
  • Field LedgerInterface.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
  • Field LedgerInterface.id is deprecated
  • Field LedgerType.id has deprecation reason The ledgerId field is deprecated.\n\nPlease use ledgerNumber instead. This is in the form of L
  • Field LedgerType.id is deprecated
  • Field updateLeadExtraDetails was added to object type Mutation
  • Type UpdateExtraDetailsInput was added
  • Type UpdateLeadExtraDetails was added
  • Type \_UpdateExtraDetailsItem was added
  • Field getOrCreateAccountForLead was added to object type Mutation
  • Type GetOrCreateShellAccountForLead was added
  • Type GetOrCreateShellAccountForLeadInput was added
  • Field ledgerNumber was added to interface ReferralInterface
  • Field ledgerNumber was added to interface RewardInterface
  • Field ledgerNumber was added to object type ReferralType
  • Field ledgerNumber was added to object type RewardType
  • Directive deprecated was added to field ReferralInterface.ledgerId
  • Directive deprecated was added to field ReferralType.ledgerId
  • Directive deprecated was added to field RewardInterface.ledgerId
  • Directive deprecated was added to field RewardType.ledgerId
  • Field ReferralInterface.ledgerId has deprecation reason The ledgerId field is deprecated. Please use ledgerNumber instead. This is in the form of L-123456789A - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
  • Field ReferralInterface.ledgerId is deprecated
  • Field ReferralType.ledgerId has deprecation reason The ledgerId field is deprecated. Please use ledgerNumber instead. This is in the form of L-123456789A - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
  • Field ReferralType.ledgerId is deprecated
  • Field RewardInterface.ledgerId has deprecation reason The ledgerId field is deprecated. Please use ledgerNumber instead. This is in the form of L-123456789A - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
  • Field RewardInterface.ledgerId is deprecated
  • Field RewardType.ledgerId has deprecation reason The ledgerId field is deprecated. Please use ledgerNumber instead. This is in the form of L-123456789A - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
  • Field RewardType.ledgerId is deprecated
  • Argument ledgerNumber: String added to field BankTransferDetailsType.paymentReference
  • Type for argument ledgerId on field BankTransferDetailsType.paymentReference changed from ID! to ID
  • Directive deprecated was added to argument ledgerId of field paymentReference in type BankTransferDetailsType
  • Field supplyPoints was added to object type Query
  • Argument ledgerNumber: String added to field AccountInterface.paginatedPaymentForecast
  • Argument ledgerNumber: String added to field AccountInterface.paymentForecast
  • Argument ledgerNumber: String added to field AccountInterface.payments
  • Argument ledgerNumber: String added to field AccountInterface.transactions
  • Argument ledgerNumber: String added to field AccountType.paginatedPaymentForecast
  • Argument ledgerNumber: String added to field AccountType.paymentForecast
  • Argument ledgerNumber: String added to field AccountType.payments
  • Argument ledgerNumber: String added to field AccountType.transactions
  • Directive deprecated was added to argument ledgerId of field ledgers in type AccountInterface
  • Directive deprecated was added to argument ledgerId of field ledgers in type AccountType
  • Directive deprecated was added to argument ledgerId of field paginatedPaymentForecast in type AccountInterface
  • Directive deprecated was added to argument ledgerId of field paginatedPaymentForecast in type AccountType
  • Directive deprecated was added to argument ledgerId of field paymentForecast in type AccountInterface
  • Directive deprecated was added to argument ledgerId of field paymentForecast in type AccountType
  • Directive deprecated was added to argument ledgerId of field payments in type AccountInterface
  • Directive deprecated was added to argument ledgerId of field payments in type AccountType
  • Directive deprecated was added to argument ledgerId of field transactions in type AccountInterface
  • Directive deprecated was added to argument ledgerId of field transactions in type AccountType
  • Field CreateDirectDebitInstruction.directDebitInstruction is deprecated
  • Field CreateDirectDebitInstruction.directDebitInstruction has deprecation reason The CreateDirectDebitInstruction field is deprecated.
  • Directive deprecated was added to field CreateDirectDebitInstruction.directDebitInstruction
  • Input field activeAt of type DateTime was added to input object type TerminateCreditTransferPermissionInput
  • Input field sourceLedgerNumber of type String! was added to input object type TerminateCreditTransferPermissionInput
  • Input field targetLedgerNumber of type String! was added to input object type TerminateCreditTransferPermissionInput
  • Input field creditTransferPermissionId was removed from input object type TerminateCreditTransferPermissionInput
  • Field creditTransferPermissionId was removed from object type TerminateCreditTransferPermission
  • Type PossibleError was added
  • Input field ledgerNumber of type String was added to input object type StorePaymentInstructionInput
  • Directive deprecated was added to input field ledgerId in input object StorePaymentInstructionInput
  • Argument ledgerNumber: String added to field Query.dashboardScreen
  • Directive deprecated was added to argument ledgerId of field dashboardScreen in type Query
  • Argument includeCancelled: Boolean added to field Query.smartFlexOnboardingWizards
  • Argument includeCompleted: Boolean added to field Query.smartFlexOnboardingWizards
  • Field error was added to object type TestCharge
  • Type TestChargeError was added
  • Type TestChargeRefusalReason was added
  • Directive deprecated was added to field TestCharge.status
  • Field TestCharge.status is deprecated
  • Field TestCharge.status has deprecation reason The status field is deprecated. Please use isStarted and error instead. - Marked as deprecated on 2024-12-12. - Scheduled for removal on or after 2025-02-12.
  • Input field ledgerNumber of type String was added to input object type InitiateStandalonePaymentInput
  • Directive deprecated was added to input field ledgerId in input object InitiateStandalonePaymentInput
  • Directive deprecated was added to input field ledgerId in input object AccountLedgerInput
  • Input field AccountLedgerInput.ledgerId changed type from ID! to ID
  • Input field ledgerNumber of type String was added to input object type AccountLedgerInput
  • Field PortfolioType.ancestors changed type from NestedPortfolioConnectionTypeConnection to PortfolioConnectionTypeConnection
  • Field PortfolioType.descendants changed type from NestedPortfolioConnectionTypeConnection to PortfolioConnectionTypeConnection
  • Field PortfolioType.parent changed type from NestedPortfolioType to PortfolioType
  • Type NestedPortfolioConnectionTypeConnection was removed
  • Type NestedPortfolioConnectionTypeEdge was removed
  • Type NestedPortfolioType was removed
  • Input field ledgerNumber of type String was added to input object type CollectPaymentInput
  • Input field CollectPaymentInput.ledgerId changed type from ID! to ID
  • Directive deprecated was added to input field ledgerId in input object CollectPaymentInput
  • Type RetentionQuoteSupplyTypeChoices was removed
  • Input field RetentionQuoteInput.supplyType changed type from RetentionQuoteSupplyTypeChoices! to SupplyType!
  • Directive deprecated was added to field Mutation.resetPassword
  • Field Mutation.resetPassword has deprecation reason The resetPassword field is deprecated. Please use resetUserPassword instead. - Marked as deprecated on 2024-12-04. - Scheduled for removal on or after 2025-06-01. You can read more about this deprecation on: https://announcements.kraken.tech/announcements/public/81/
  • Field Mutation.resetPassword is deprecated
  • Input field ledgerNumber of type String was added to input object type PostCreditInput
  • Input field PostCreditInput.ledgerId changed type from ID! to ID
  • Directive deprecated was added to input field ledgerId in input object PostCreditInput
  • Field ledgerNumber was added to object type GoodsPurchase
  • Directive deprecated was added to field GoodsPurchase.ledgerId
  • Field GoodsPurchase.ledgerId has deprecation reason The ledgerId field is deprecated. Please use ledgerNumber instead. This is in the form of L-123456789A - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
  • Field GoodsPurchase.ledgerId is deprecated
  • Input field suppressCommunications of type Boolean was added to input object type InitiateProductSwitchInput
  • Field accountsCount (deprecated) was removed from object type NestedPortfolioType
  • Field accountsCount (deprecated) was removed from object type PortfolioType
  • Directive deprecated was added to field NestedPortfolioType.accountsCount
  • Directive deprecated was added to field PortfolioType.accountsCount
  • Field NestedPortfolioType.accountsCount has deprecation reason The accountsCount field is deprecated. Will be deleted in favor of field. - Marked as deprecated on 2024-11-27. - Scheduled for removal on or after 2024-12-02.
  • Field NestedPortfolioType.accountsCount is deprecated
  • Field PortfolioType.accountsCount has deprecation reason The accountsCount field is deprecated. Will be deleted in favor of field. - Marked as deprecated on 2024-11-27. - Scheduled for removal on or after 2024-12-02.
  • Field PortfolioType.accountsCount is deprecated
  • Argument expiresAt: DateTime was added to input RegisterPushNotificationBinding
  • Field typedSource (deprecated) was removed from object type MeasurementsMetadataOutput
  • Type TypedSourceOutput was removed
  • Type UtilityType was removed
On this page