Skip to main content

GraphQL API Changelog

This page shows the history of changes to the GraphQL schema.
  • Field addOneWaySignupReward was added to object type Mutation
  • Type AddOneWaySignupReward was added
  • Type AddOneWaySignupRewardInput was added
  • Enum value CANCEL_ENROLLMENT was added to enum ExpiringTokenScope
  • Enum value CANCEL_ENROLLMENT was added to enum PreSignedTokenScope
  • Field CallInterface.id changed type from ID to ID!
  • Object type TestChargeError has description Errors can be of two kinds (assuming the user is querying this type with message,\nreasons, errorType, and descriptions fields):\n\n1. If we were unable to start a test charge, the response will be:\n \n {\n message: TestChargeRefused,\n reasons: [Returns a list of values from `TestChargeRefusalReason`],\n errorType: UNABLE_TO_INITIATE_TEST_CHARGE,\n descriptions: [Returns a list of descriptions for the refusal reasons]\n }\n\n\n Where descriptions can be:\n - DEVICE_LIVE: device is already live\n - DEVICE_ONBOARDING_IN_PROGRESS: test dispatch already in progress\n - DEVICE_RETIRED: device is retired\n - DEVICE_SUSPENDED: device is suspended\n - DEVICE_DISCONNECTED: device is disconnected\n - DEVICE_ALREADY_CHARGING: device is already charging\n - DEVICE_AWAY_FROM_HOME: device is away from home\n - DEVICE_NO_LOCATION_CONFIGURED: device has no location configured\n - DEVICE_LOCATION_UNABLE_TO_IDENTIFY: unable to identify device location\n - DEVICE_LOCATION_MISSING: device location is missing\n\n2. If an error occurred during a test charge, the response will be:\n \n {\n message: Test dispatch failed,\n reasons: [Returns a list of values from `TestDispatchAssessmentFailureReason`],\n errorType: UNABLE_TO_COMPLETE_TEST_CHARGE,\n descriptions: [Returns a list of descriptions for the refusal reasons]\n }\n\n\n Where descriptions can be:\n - ASSESSMENTS_FAILED: Both power-based and charge status-based assessments failed\n - NOT_AT_HOME: Device location not at home\n - UNKNOWN: Unknown failure\n - UNABLE_TO_COMMUNICATE: Unable to communicate with device\n - DEVICE_DISCONNECTED: Device disconnected\n - SOC_LIMIT_REACHED: State of charge limit reached\n - ERROR: Could not fetch the test charge failure reason\n - NONE: No failure reason\n
  • Field electricityMeterpoint was added to object type Query.
  • Field gasMeterpoint was added to object type Query
  • Field cancelEnrolment was added to object type Mutation
  • Type CancelEnrolment was added
  • Type CancelEnrolmentInput was added
  • Type WithdrawnReasons was added
  • Input field ledgerNumber of type String was added to input object type CommenceDCAProceedingInputType
  • Field label was added to interface PropertyInterface
  • Field label was added to object type PropertyType
  • Field wofUrls (deprecated) was removed from object type Query
  • Directive deprecated was added to field Urls.meterReadingSubmission

  • Directive deprecated was added to field Urls.tariffRenewal

  • Directive deprecated was added to field Urls.updateSensitiveCustomerData

  • Directive deprecated was added to field Urls.wheelOfFortuneElec

  • Directive deprecated was added to field Urls.wheelOfFortuneGas

  • Field Urls.meterReadingSubmission has deprecation reason The meterReadingSubmission field is deprecated.

    Fetching anonymous journey URLs via API is no longer supported.

    • Marked as deprecated on 2025-02-25.
    • Scheduled for removal on or after 2025-05-25.
  • Field Urls.meterReadingSubmission is deprecated

  • Field Urls.tariffRenewal has deprecation reason The tariffRenewal field is deprecated.

    Fetching anonymous journey URLs via API is no longer supported.

    • Marked as deprecated on 2025-02-25.
    • Scheduled for removal on or after 2025-05-25.
  • Field Urls.tariffRenewal is deprecated

  • Field Urls.updateSensitiveCustomerData has deprecation reason The updateSensitiveCustomerData field is deprecated.

    Fetching anonymous journey URLs via API is no longer supported.

    • Marked as deprecated on 2025-02-25.
    • Scheduled for removal on or after 2025-05-25.
  • Field Urls.updateSensitiveCustomerData is deprecated

  • Field Urls.wheelOfFortuneElec has deprecation reason The wheelOfFortuneElec field is deprecated.

    Fetching Wheel of Fortune URLs via API is no longer supported.

    • Marked as deprecated on 2025-02-25.
    • Scheduled for removal on or after 2025-08-25.
  • Field Urls.wheelOfFortuneElec is deprecated

  • Field Urls.wheelOfFortuneGas has deprecation reason The wheelOfFortuneGas field is deprecated.

    Fetching Wheel of Fortune URLs via API is no longer supported.

    • Marked as deprecated on 2025-02-25.
    • Scheduled for removal on or after 2025-08-25.
  • Field Urls.wheelOfFortuneGas is deprecated

  • 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-Possible-Errors header instead.\n- Marked as deprecated on 2025-02-05.\n- Scheduled for removal on or after 2025-03-05.
  • Input field ledgerNumber of type String was added to input object type RequestRepaymentInputType
  • Input field RequestRepaymentInputType.ledgerId changed type from String! to String
  • Directive deprecated was added to input field ledgerId in input object RequestRepaymentInputType
  • Type CompleteLeadActionInput was added
  • Type CoreSiteworksMarketSupplyPointType was added
  • Type CoreSiteworksRequestConnectionTypeEdge was added
  • Type RequestStatus was added
  • Type UpdateLeaveSupplierInput was added
  • Field QuoteType.consumptionEstimates is deprecated

  • Directive deprecated was added to field QuoteType.consumptionEstimates

  • Field QuoteType.consumptionEstimates has deprecation reason The consumption_estimates field is deprecated.

    Please use the consumptionEstimates query instead.

    • Marked as deprecated on 2025-01-20.
    • Scheduled for removal on or after 2025-04-20.
  • 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-123456789A\n\n- Marked as deprecated on 2024-10-22.\n- Scheduled for removal on or after 2025-06-25.
  • 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-123456789A\n\n- Marked as deprecated on 2024-10-22.\n- Scheduled for removal on or after 2025-06-25.
  • Field LedgerType.id is deprecated
  • 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 html was added to object type TermsAndConditions
  • Field pdfUrl was added to object type TermsAndConditions
  • Argument electricityOnly: Boolean added to field Query.addressUprns
  • 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

  • Field accountsCount (deprecated) was removed from object type NestedPortfolioType
  • Field accountsCount (deprecated) was removed from object type PortfolioType
  • Field accounts was added to object type PortfolioType
  • Type AccountConnectionTypeConnection was added
  • Type AccountConnectionTypeEdge was added
  • 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

  • Field gspGroupId was added to object type EligibleMetersPointsType
  • Field targetGsp was added to object type SavingSessionsEventType
  • Type TargetGspType was added
  • Argument includeRestrictedProducts: Boolean (with default value) added to field Query.availableProductsForMeterPoint
  • Field typedSource (deprecated) was removed from object type MeasurementsMetadataOutput
  • Type TypedSourceOutput was removed
  • Type UtilityType was removed