Skip to main content

Queries

In this section

About Queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

API Site

account

Type: AccountType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about an account.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

Query

query Account($accountNumber: String!) {
  account(accountNumber: $accountNumber) {
    id
    number
    status
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    users {
      ...AccountUserTypeFragment
    }
    complaints {
      ...ComplaintConnectionTypeConnectionFragment
    }
    brand
    balance
    overdueBalance
    urn
    billingName
    billingSubName
    billingEmail
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    splitBillingAddress
    address {
      ...RichAddressTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    ledgers {
      ...LedgerTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    canRequestRefund
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    paymentForecast {
      ...PaymentForecastTypeFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    rewards {
      ...RewardTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    bill {
      ...BillInterfaceFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    accountType
    businessType
    business {
      ...BusinessTypeFragment
    }
    commsDeliveryPreference
    communicationDeliveryPreference
    documentAccessibility
    references {
      ...AccountReferenceTypeFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    isInHardship
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    createdAt
    preferredLanguageForComms
    consents {
      ...ConsentTypeFragment
    }
    reminders {
      ...AccountReminderConnectionTypeConnectionFragment
    }
    properties {
      ...PropertyTypeFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    projectedBalance
    shouldReviewPayments
    recommendedBalanceAdjustment
    electricityAgreements {
      ...ElectricityAgreementTypeFragment
    }
    gasAgreements {
      ...GasAgreementTypeFragment
    }
    warmHomeDiscount {
      ...WarmHomeDiscountFragment
    }
    eligibilityForWarmHomeDiscount {
      ...WarmHomeDiscountEligibilityFragment
    }
    billingPostcode
    canRenewTariff
    trackerTariffDailyPricing {
      ...TrackerTariffDailyPricingFragment
    }
    paymentAdequacy {
      ...PaymentAdequacyTypeFragment
    }
    smets2Interest
    smets2RefusalReason
    greenAccomplishments {
      ...GreenAccomplishmentsTypeFragment
    }
    canChangePayments
    cotReadingWindowDays
    canBeWithdrawn
    currentEstimatedSsd
    earliestPossibleSsd
    latestPossibleSsd
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    canInputMeterReadingsViaIvr
    hasActiveDunningProcess
    hasActiveCollectionsProceedings
    isEligibleForElectricityReadingIncentive
    isEligibleForGasReadingIncentive
    isInBlockingMigration
  }
}

Variables

{
  "accountNumber": "A-9EC56B87"
}

Response

{
  "data": {
    "account": {
      "id": "85073195",
      "number": "almost-statement-coach-grow-office",
      "status": "PENDING",
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "users": AccountUserType,
      "complaints": ComplaintConnectionTypeConnection,
      "brand": "former-modern-including-begin-idea",
      "balance": 74,
      "overdueBalance": 76,
      "urn": "after-lose-thought-worry-same",
      "billingName": "respond-author-cup-clear-worker",
      "billingSubName": "including-common-employee-operation-reason",
      "billingEmail": "heart-ball-include-quality-manage",
      "billingAddress": "trade-rule-society-for-maintain",
      "billingAddressLine1": "grow-already-player-lawyer-save",
      "billingAddressLine2": "involve-campaign-middle-husband-common",
      "billingAddressLine3": "walk-strategy-personal-team-then",
      "billingAddressLine4": "trip-network-stay-team-college",
      "billingAddressLine5": "fight-dark-public-beautiful-full",
      "billingAddressPostcode": "instead-development-process-out-parent",
      "billingCountryCode": "great-door-including-success-this",
      "billingDeliveryPointIdentifier": "50985376",
      "splitBillingAddress": ["left-box-whatever-specific-type"],
      "address": RichAddressType,
      "portfolio": PortfolioType,
      "ledgers": [LedgerType],
      "metadata": [Metadata],
      "canRequestRefund": true,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "payments": AccountPaymentConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "paymentForecast": [PaymentForecastType],
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 99,
      "rewards": [RewardType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "transactions": TransactionConnectionTypeConnection,
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "bills": BillConnectionTypeConnection,
      "billingOptions": BillingOptionsType,
      "bill": BillInterface,
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "events": AccountEventConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "accountType": "BUSINESS",
      "businessType": "SOLE_TRADER",
      "business": BusinessType,
      "commsDeliveryPreference": "EMAIL",
      "communicationDeliveryPreference": "hotel-card-significant-father-simple",
      "documentAccessibility": "LARGE_PRINT",
      "references": [AccountReferenceType],
      "fileAttachments": [AccountFileAttachment],
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "maximumRefund": MaximumRefundType,
      "campaigns": [AccountCampaignType],
      "isInHardship": true,
      "activeHardshipAgreements": [HardshipAgreementType],
      "notes": [AccountNoteType],
      "contributionAgreements": [ContributionAgreementType],
      "assistanceAgreements": [AssistanceAgreementType],
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "createdAt": "2021-01-09T15:59:54.718620+00:00",
      "preferredLanguageForComms": "member-question-middle-serve-skin",
      "consents": ConsentType,
      "reminders": AccountReminderConnectionTypeConnection,
      "properties": [PropertyType],
      "marketSupplyAgreements": AgreementConnection,
      "canModifyPayments": CanModifyPaymentsType,
      "projectedBalance": 65,
      "shouldReviewPayments": true,
      "recommendedBalanceAdjustment": 33,
      "electricityAgreements": [ElectricityAgreementType],
      "gasAgreements": [GasAgreementType],
      "warmHomeDiscount": WarmHomeDiscount,
      "eligibilityForWarmHomeDiscount": WarmHomeDiscountEligibility,
      "billingPostcode": "building-knowledge-big-type-close",
      "canRenewTariff": true,
      "trackerTariffDailyPricing": TrackerTariffDailyPricing,
      "paymentAdequacy": PaymentAdequacyType,
      "smets2Interest": "PRIORITY",
      "smets2RefusalReason": "SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME",
      "greenAccomplishments": GreenAccomplishmentsType,
      "canChangePayments": true,
      "cotReadingWindowDays": 4,
      "canBeWithdrawn": true,
      "currentEstimatedSsd": "2009-07-22",
      "earliestPossibleSsd": "2009-04-09",
      "latestPossibleSsd": "1983-11-01",
      "operationsTeam": OperationsTeamType,
      "canInputMeterReadingsViaIvr": true,
      "hasActiveDunningProcess": true,
      "hasActiveCollectionsProceedings": true,
      "isEligibleForElectricityReadingIncentive": true,
      "isEligibleForGasReadingIncentive": true,
      "isInBlockingMigration": true
    }
  }
}

accountChargeReasons

Type: [ChargeReasonType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Available reasons for use in account charge mutations.

Query

query AccountChargeReasons {
  accountChargeReasons {
    code
    display
    isDeprecated
    isTaxExempt
    isHidden
    group
  }
}

Response

{
  "data": {
    "accountChargeReasons": [
      {
        "code": "degree-until-condition-nation-become",
        "display": "top-age-head-across-fine",
        "isDeprecated": true,
        "isTaxExempt": true,
        "isHidden": true,
        "group": "hospital-down-science-early-attorney"
      }
    ]
  }
}

accountContract

Type: Contract

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about an account contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10005: Missing required parameter: either identifier or accountNumber must be provided.
  • KT-CT-10006: Account not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

identifier (String)

The identifier of the contract.

accountNumber (String)

The account number to find the contract for.

version (Int)

The version of the contract.

Query

query AccountContract(
  $identifier: String,
  $accountNumber: String,
  $version: Int
) {
  accountContract(
    identifier: $identifier,
    accountNumber: $accountNumber,
    version: $version
  ) {
    identifier
    title
    party
    subject {
      ...AccountTypeFragment
    }
    status
    validFrom
    validTo
    signedAt
    cancelledAt
    lifecycle {
      ...ContractVersionFragment
    }
    terms {
      ...TermInterfaceFragment
    }
  }
}

Variables

{
  "identifier": "81194104",
  "accountNumber": "A-A462AD1E",
  "version": 37
}

Response

{
  "data": {
    "accountContract": {
      "identifier": "67212214",
      "title": "debate-event-factor-room-green",
      "party": ContractParty,
      "subject": [AccountType],
      "status": "REVOKED",
      "validFrom": "1978-07-21T19:47:35.780478+00:00",
      "validTo": "2002-12-18T07:18:01.145113+00:00",
      "signedAt": "2014-07-15T17:57:39.626793+00:00",
      "cancelledAt": "1971-12-02T04:28:16.224668+00:00",
      "lifecycle": ContractVersion,
      "terms": TermInterface
    }
  }
}

accountCreditReasons

Type: [CreditReasonType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Available reasons for use in account credit mutations.

Query

query AccountCreditReasons {
  accountCreditReasons {
    code
    display
    isDeprecated
    isTaxExempt
    isHidden
    group
  }
}

Response

{
  "data": {
    "accountCreditReasons": [
      {
        "code": "agent-half-everything-network-improve",
        "display": "control-employee-light-also-nearly",
        "isDeprecated": true,
        "isTaxExempt": true,
        "isHidden": true,
        "group": "gun-player-building-minute-friend"
      }
    ]
  }
}

accountIoEligibility

Type: AccountIoEligibility

URL: https://api.oefr-kraken.energy/v1/graphql/

Determines whether an account is eligible to register devices with SmartFlex.

Arguments

Name Description

accountNumber (String!)

Account number.

propertyId (Int)

            The property's id where the device will be registered to.
            Note: in future, eligibility checks will be dependent on the property id and
            it will be a required input.

Query

query AccountIoEligibility(
  $accountNumber: String!,
  $propertyId: Int
) {
  accountIoEligibility(
    accountNumber: $accountNumber,
    propertyId: $propertyId
  ) {
    isEligibleForIo
  }
}

Variables

{
  "accountNumber": "A-AF8FC684",
  "propertyId": 27116737
}

Response

{
  "data": {
    "accountIoEligibility": {
      "isEligibleForIo": true
    }
  }
}

accountReference

Type: [AccountReferenceType]

URL: https://api.oefr-kraken.energy/v1/graphql/

List of matching account references.

The possible errors that can be raised are:

  • KT-CT-8310: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

value (String)

Filter account references by this value.

Query

query AccountReference($value: String) {
  accountReference(value: $value) {
    namespace
    value
    createdAt
    updatedAt
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "value": "more-recent-land-kid-evening"
}

Response

{
  "data": {
    "accountReference": [
      {
        "namespace": "blood-rise-toward-physical-hope",
        "value": "bag-year-summer-give-minute",
        "createdAt": "1987-12-05T16:55:36.438424+00:00",
        "updatedAt": "1991-03-11T10:19:45.856845+00:00",
        "account": AccountType
      }
    ]
  }
}

accounts

Type: [AccountType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about multiple accounts.

Arguments

Name Description

phoneNumber (String)

A phone number to find accounts associated with.

portfolioNumber (String)

A portfolio number to find accounts associated with.

Query

query Accounts(
  $phoneNumber: String,
  $portfolioNumber: String
) {
  accounts(
    phoneNumber: $phoneNumber,
    portfolioNumber: $portfolioNumber
  ) {
    id
    number
    status
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    users {
      ...AccountUserTypeFragment
    }
    complaints {
      ...ComplaintConnectionTypeConnectionFragment
    }
    brand
    balance
    overdueBalance
    urn
    billingName
    billingSubName
    billingEmail
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    splitBillingAddress
    address {
      ...RichAddressTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    ledgers {
      ...LedgerTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    canRequestRefund
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    paymentForecast {
      ...PaymentForecastTypeFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    rewards {
      ...RewardTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    bill {
      ...BillInterfaceFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    accountType
    businessType
    business {
      ...BusinessTypeFragment
    }
    commsDeliveryPreference
    communicationDeliveryPreference
    documentAccessibility
    references {
      ...AccountReferenceTypeFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    isInHardship
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    createdAt
    preferredLanguageForComms
    consents {
      ...ConsentTypeFragment
    }
    reminders {
      ...AccountReminderConnectionTypeConnectionFragment
    }
    properties {
      ...PropertyTypeFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    projectedBalance
    shouldReviewPayments
    recommendedBalanceAdjustment
    electricityAgreements {
      ...ElectricityAgreementTypeFragment
    }
    gasAgreements {
      ...GasAgreementTypeFragment
    }
    warmHomeDiscount {
      ...WarmHomeDiscountFragment
    }
    eligibilityForWarmHomeDiscount {
      ...WarmHomeDiscountEligibilityFragment
    }
    billingPostcode
    canRenewTariff
    trackerTariffDailyPricing {
      ...TrackerTariffDailyPricingFragment
    }
    paymentAdequacy {
      ...PaymentAdequacyTypeFragment
    }
    smets2Interest
    smets2RefusalReason
    greenAccomplishments {
      ...GreenAccomplishmentsTypeFragment
    }
    canChangePayments
    cotReadingWindowDays
    canBeWithdrawn
    currentEstimatedSsd
    earliestPossibleSsd
    latestPossibleSsd
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    canInputMeterReadingsViaIvr
    hasActiveDunningProcess
    hasActiveCollectionsProceedings
    isEligibleForElectricityReadingIncentive
    isEligibleForGasReadingIncentive
    isInBlockingMigration
  }
}

Variables

{
  "phoneNumber": "building-member-wide-agent-resource",
  "portfolioNumber": "P-F0831D32"
}

Response

{
  "data": {
    "accounts": [
      {
        "id": "45357593",
        "number": "instead-be-enter-support-civil",
        "status": "PENDING",
        "paymentSchedules": PaymentScheduleConnectionTypeConnection,
        "users": AccountUserType,
        "complaints": ComplaintConnectionTypeConnection,
        "brand": "institution-top-key-out-heavy",
        "balance": 1,
        "overdueBalance": 66,
        "urn": "entire-project-visit-least-foreign",
        "billingName": "well-produce-sport-own-allow",
        "billingSubName": "have-discover-mention-nothing-anything",
        "billingEmail": "argue-analysis-effect-home-gun",
        "billingAddress": "necessary-man-sound-sport-main",
        "billingAddressLine1": "draw-support-onto-officer-trouble",
        "billingAddressLine2": "return-especially-scientist-worker-national",
        "billingAddressLine3": "beyond-space-knowledge-better-throughout",
        "billingAddressLine4": "interview-interest-for-media-number",
        "billingAddressLine5": "range-worker-end-spend-think",
        "billingAddressPostcode": "have-pattern-election-statement-central",
        "billingCountryCode": "policy-wife-listen-travel-Mr",
        "billingDeliveryPointIdentifier": "25437034",
        "splitBillingAddress": ["yeah-economy-sort-movement-lawyer"],
        "address": RichAddressType,
        "portfolio": PortfolioType,
        "ledgers": [LedgerType],
        "metadata": [Metadata],
        "canRequestRefund": true,
        "requestRefundEligibility": RequestRefundEligibilityType,
        "payments": AccountPaymentConnectionTypeConnection,
        "repayments": AccountRepaymentConnectionTypeConnection,
        "paymentPlans": PaymentPlanConnectionTypeConnection,
        "paymentForecast": [PaymentForecastType],
        "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
        "referrals": ReferralConnectionTypeConnection,
        "referralsCreated": 83,
        "rewards": [RewardType],
        "activeReferralSchemes": ReferralSchemeTypes,
        "transactions": TransactionConnectionTypeConnection,
        "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
        "annualStatements": AnnualStatementConnectionTypeConnection,
        "bills": BillConnectionTypeConnection,
        "billingOptions": BillingOptionsType,
        "bill": BillInterface,
        "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
        "paymentMethods": PaymentInstructionConnectionTypeConnection,
        "events": AccountEventConnectionTypeConnection,
        "applications": AccountApplicationConnectionTypeConnection,
        "accountType": "BUSINESS",
        "businessType": "SOLE_TRADER",
        "business": BusinessType,
        "commsDeliveryPreference": "EMAIL",
        "communicationDeliveryPreference": "city-film-reflect-at-chair",
        "documentAccessibility": "LARGE_PRINT",
        "references": [AccountReferenceType],
        "fileAttachments": [AccountFileAttachment],
        "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
        "maximumRefund": MaximumRefundType,
        "campaigns": [AccountCampaignType],
        "isInHardship": true,
        "activeHardshipAgreements": [HardshipAgreementType],
        "notes": [AccountNoteType],
        "contributionAgreements": [ContributionAgreementType],
        "assistanceAgreements": [AssistanceAgreementType],
        "debtCollectionProceedings": [DebtCollectionProceedingType],
        "createdAt": "1991-03-08T17:54:41.130295+00:00",
        "preferredLanguageForComms": "character-sit-experience-question-worry",
        "consents": ConsentType,
        "reminders": AccountReminderConnectionTypeConnection,
        "properties": [PropertyType],
        "marketSupplyAgreements": AgreementConnection,
        "canModifyPayments": CanModifyPaymentsType,
        "projectedBalance": 80,
        "shouldReviewPayments": true,
        "recommendedBalanceAdjustment": 98,
        "electricityAgreements": [ElectricityAgreementType],
        "gasAgreements": [GasAgreementType],
        "warmHomeDiscount": WarmHomeDiscount,
        "eligibilityForWarmHomeDiscount": WarmHomeDiscountEligibility,
        "billingPostcode": "ago-body-full-happen-moment",
        "canRenewTariff": true,
        "trackerTariffDailyPricing": TrackerTariffDailyPricing,
        "paymentAdequacy": PaymentAdequacyType,
        "smets2Interest": "PRIORITY",
        "smets2RefusalReason": "SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME",
        "greenAccomplishments": GreenAccomplishmentsType,
        "canChangePayments": true,
        "cotReadingWindowDays": 89,
        "canBeWithdrawn": true,
        "currentEstimatedSsd": "1977-12-07",
        "earliestPossibleSsd": "1997-01-13",
        "latestPossibleSsd": "2015-09-15",
        "operationsTeam": OperationsTeamType,
        "canInputMeterReadingsViaIvr": true,
        "hasActiveDunningProcess": true,
        "hasActiveCollectionsProceedings": true,
        "isEligibleForElectricityReadingIncentive": true,
        "isEligibleForGasReadingIncentive": true,
        "isInBlockingMigration": true
      }
    ]
  }
}

accountsSearch

Type: [AccountSearchItemType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Search for account that are already in Kraken and match the search terms.

Arguments

Name Description

searchTerms (AccountSearchInputType)

Search operators.

maxResults (Int)

The maximum number of results to return.

Query

query AccountsSearch(
  $searchTerms: AccountSearchInputType,
  $maxResults: Int
) {
  accountsSearch(
    searchTerms: $searchTerms,
    maxResults: $maxResults
  ) {
    account {
      ...AccountTypeFragment
    }
    score
  }
}

Variables

{
  "searchTerms": AccountSearchInputType,
  "maxResults": 85
}

Response

{
  "data": {
    "accountsSearch": [
      {
        "account": AccountType,
        "score": "1.0"
      }
    ]
  }
}

activationProcesses

Type: ActivationProcessesConnectionTypeConnection

URL: https://api.oefr-kraken.energy/v1/graphql/

List of activation processes linked an account number or a quote code. If a quoteCode is specified, the accountNumber will be ignored.

Arguments

Name Description

accountNumber (String)

The account number related to the activation processes. This parameter will be ignored if a quoteCode is also provided.

quoteCode (UUID)

The quote code related to the activation processes.

statuses ([ActivationProcessStatus])

Allowed statuses for returned activation processes. An empty list returns all processes.

before (String)

after (String)

first (Int)

last (Int)

Query

query ActivationProcesses(
  $accountNumber: String,
  $quoteCode: UUID,
  $statuses: [ActivationProcessStatus],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  activationProcesses(
    accountNumber: $accountNumber,
    quoteCode: $quoteCode,
    statuses: $statuses,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ActivationProcessesConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-FE1CCCBE",
  "quoteCode": "6105a0a7-e491-42ea-b0e4-33fa58a677ec",
  "statuses": "NEW",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "activationProcesses": {
      "pageInfo": PageInfo,
      "edges": ActivationProcessesConnectionTypeEdge,
      "totalCount": 55,
      "edgeCount": 87
    }
  }
}

activeAffiliateReferralScheme

Type: ReferralSchemeType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return the current active referral reward scheme of a given affiliate organisation, if any exists.

Arguments

Name Description

subdomain (String!)

The affiliate link subdomain.

accountType (ReferralSchemeAccountTypeOptions)

The account type for which to get the referral scheme.

Query

query ActiveAffiliateReferralScheme(
  $subdomain: String!,
  $accountType: ReferralSchemeAccountTypeOptions
) {
  activeAffiliateReferralScheme(
    subdomain: $subdomain,
    accountType: $accountType
  ) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    maxRecurrence
    isUsageAtCapacity
  }
}

Variables

{
  "subdomain": "include-everything-card-player-mention",
  "accountType": "DOMESTIC"
}

Response

{
  "data": {
    "activeAffiliateReferralScheme": {
      "referralUrl": "mean-any-claim-ok-movie",
      "referralDisplayUrl": "interest-war-center-southern-really",
      "referrerRewardAmount": 23,
      "referredRewardAmount": 75,
      "combinedRewardAmount": 7,
      "loyaltyPointsBonus": 57,
      "canBeReferred": true,
      "code": "list-change-current-accept-body",
      "referrerGivenName": "Janice",
      "referrerFamilyName": "Hodges",
      "schemeType": "sign-develop-effect-stuff-people",
      "maxRecurrence": 17,
      "isUsageAtCapacity": true
    }
  }
}

activeDomesticSignupRewardScheme

Type: ReferralSchemeType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return the current active signup referral reward scheme with the given code, if any exists.

Query

query ActiveDomesticSignupRewardScheme {
  activeDomesticSignupRewardScheme {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    maxRecurrence
    isUsageAtCapacity
  }
}

Response

{
  "data": {
    "activeDomesticSignupRewardScheme": {
      "referralUrl": "decide-religious-peace-ball-wall",
      "referralDisplayUrl": "wish-talk-meet-brother-left",
      "referrerRewardAmount": 100,
      "referredRewardAmount": 24,
      "combinedRewardAmount": 89,
      "loyaltyPointsBonus": 66,
      "canBeReferred": true,
      "code": "per-his-car-worry-easy",
      "referrerGivenName": "Heidi",
      "referrerFamilyName": "Brooks",
      "schemeType": "laugh-happy-small-building-however",
      "maxRecurrence": 93,
      "isUsageAtCapacity": true
    }
  }
}

Arguments

Name Description

activeFrom (DateTime)

The datetime from which to filter active sales channels.

activeTo (DateTime)

The datetime up to which to filter active sales channels.

Query

query ActiveSalesChannels(
  $activeFrom: DateTime,
  $activeTo: DateTime
) {
  activeSalesChannels(
    activeFrom: $activeFrom,
    activeTo: $activeTo
  ) {
    name
    code
    description
    hierarchicalName
  }
}

Variables

{
  "activeFrom": "2023-10-07T00:24:54.909472+00:00",
  "activeTo": "2003-06-18T20:29:55.274406+00:00"
}

Response

{
  "data": {
    "activeSalesChannels": [
      {
        "name": "might-apply-writer-report-exactly",
        "code": "few-figure-foot-evening-sign",
        "description": "staff-station-former-send-remember",
        "hierarchicalName": "possible-heavy-travel-strategy-we"
      }
    ]
  }
}

Type: AffiliateLinkType!

URL: https://api.oefr-kraken.energy/v1/graphql/

Link object for an affiliate organization.

The possible errors that can be raised are:

  • KT-CT-7713: Invalid data.
  • KT-CT-7718: Affiliate link is expired.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

subdomain (String!)

The affiliate link subdomain.

Query

query AffiliateLink($subdomain: String!) {
  affiliateLink(subdomain: $subdomain) {
    id
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    subdomain
    trainingStatus
    isBusiness
    contactName
    contactEmail
    landingUrl
  }
}

Variables

{
  "subdomain": "research-so-statement-save-happy"
}

Response

{
  "data": {
    "affiliateLink": {
      "id": "74206007",
      "organisation": AffiliateOrganisationType,
      "subdomain": "easy-lose-direction-upon-relate",
      "trainingStatus": "NOT_APPLICABLE",
      "isBusiness": true,
      "contactName": "bad-into-continue-realize-and",
      "contactEmail": "can-moment-whatever-store-expect",
      "landingUrl": "tend-time-effect-sit-market"
    }
  }
}

Type: [AffiliateLinkType!]!

URL: https://api.oefr-kraken.energy/v1/graphql/

Links (urls) for the affiliate organizations.

Arguments

Name Description

agentContactEmail (String!)

Email address of the affiliate agent.

Query

query AffiliateLinks($agentContactEmail: String!) {
  affiliateLinks(agentContactEmail: $agentContactEmail) {
    id
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    subdomain
    trainingStatus
    isBusiness
    contactName
    contactEmail
    landingUrl
  }
}

Variables

{
  "agentContactEmail": "economic-possible-reality-speech-fund"
}

Response

{
  "data": {
    "affiliateLinks": {
      "id": "40286675",
      "organisation": AffiliateOrganisationType,
      "subdomain": "window-baby-down-service-generation",
      "trainingStatus": "NOT_APPLICABLE",
      "isBusiness": true,
      "contactName": "area-left-represent-sing-magazine",
      "contactEmail": "something-south-address-some-image",
      "landingUrl": "four-left-within-so-follow"
    }
  }
}

affiliateOrganisation

Type: AffiliateOrganisationType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return the details of a given affiliate organization, if any exists.

The possible errors that can be raised are:

  • KT-CT-7701: The affiliate organisation was not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

id (Int!)

The affiliate organisation ID.

Query

query AffiliateOrganisation($id: Int!) {
  affiliateOrganisation(id: $id) {
    id
    name
    contactEmail
    canRenewTariffs
    defaultAccountType
    allowAlternativePaymentMethods
    canRegisterBusinessMeterPoints
    canRegisterPortfolioAccounts
    canRegisterCustomersWithoutEmailAddress
    canUseIvrSupportApi
    skipMeterPointAddressValidation
    salesChannel
    salesChannelCode
    isFieldSalesOnlyProduct
  }
}

Variables

{
  "id": 63794109
}

Response

{
  "data": {
    "affiliateOrganisation": {
      "id": "33646999",
      "name": "dog-matter-Congress-including-control",
      "contactEmail": "series-up-perform-site-instead",
      "canRenewTariffs": true,
      "defaultAccountType": "BUSINESS",
      "allowAlternativePaymentMethods": true,
      "canRegisterBusinessMeterPoints": true,
      "canRegisterPortfolioAccounts": true,
      "canRegisterCustomersWithoutEmailAddress": true,
      "canUseIvrSupportApi": true,
      "skipMeterPointAddressValidation": true,
      "salesChannel": "DIRECT",
      "salesChannelCode": "purpose-identify-imagine-remain-north",
      "isFieldSalesOnlyProduct": true
    }
  }
}

agreementCertificate

Type: AgreementCertificate

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the agreement certificate for an agreement.

The possible errors that can be raised are:

  • KT-FR-4910: Unauthorized to access to this agreement.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

ID of the account.

agreementId (Int!)

ID of the agreement.

Query

query AgreementCertificate(
  $accountNumber: String!,
  $agreementId: Int!
) {
  agreementCertificate(
    accountNumber: $accountNumber,
    agreementId: $agreementId
  ) {
    temporaryUrl
  }
}

Variables

{
  "accountNumber": "A-177CF643",
  "agreementId": 54017921
}

Response

{
  "data": {
    "agreementCertificate": {
      "temporaryUrl": "player-edge-water-police-score"
    }
  }
}

Arguments

Name Description

accountNumber (String!)

The account number linked to the agreements.

supplyContractNumber (String)

The supply contract number linked to the agreements.

supplyPointId (ID)

Filter agreements related to this specific supply point.

propertyId (ID)

Filter agreements related to this property.

agreementId (ID)

Fetch this specific agreement.

activeAt (DateTime)

Filter agreements on the date (valid_from <= date <= valid_to).

validFromBefore (DateTime)

Filter agreements where valid_from is less than or equal to this date (excludes future agreements).

before (String)

after (String)

first (Int)

last (Int)

Query

query Agreements(
  $accountNumber: String!,
  $supplyContractNumber: String,
  $supplyPointId: ID,
  $propertyId: ID,
  $agreementId: ID,
  $activeAt: DateTime,
  $validFromBefore: DateTime,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  agreements(
    accountNumber: $accountNumber,
    supplyContractNumber: $supplyContractNumber,
    supplyPointId: $supplyPointId,
    propertyId: $propertyId,
    agreementId: $agreementId,
    activeAt: $activeAt,
    validFromBefore: $validFromBefore,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...AgreementConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-6A1A330E",
  "supplyContractNumber": "relationship-west-follow-on-get",
  "supplyPointId": "98008392",
  "propertyId": "42404968",
  "agreementId": "19691303",
  "activeAt": "2003-06-09T06:13:33.830300+00:00",
  "validFromBefore": "1971-07-09T04:12:31.215010+00:00",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "agreements": {
      "pageInfo": PageInfo,
      "edges": AgreementConnectionTypeEdge,
      "totalCount": 15,
      "edgeCount": 44
    }
  }
}

Arguments

Name Description

input (APIBrownoutInput)

Statuses to filter for. Otherwise return active and upcoming brownouts.

before (String)

after (String)

first (Int)

last (Int)

Query

query ApiBrownouts(
  $input: APIBrownoutInput,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  apiBrownouts(
    input: $input,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...APIBrownoutEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "input": APIBrownoutInput,
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "apiBrownouts": {
      "pageInfo": PageInfo,
      "edges": APIBrownoutEdge,
      "totalCount": 97,
      "edgeCount": 39
    }
  }
}

Arguments

Name Description

input (APIExceptionQueryInput)

Fields to filter for. Otherwise don't filter at all.

before (String)

after (String)

first (Int)

last (Int)

Query

query ApiExceptions(
  $input: APIExceptionQueryInput,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  apiExceptions(
    input: $input,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...APIExceptionConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "input": APIExceptionQueryInput,
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "apiExceptions": {
      "pageInfo": PageInfo,
      "edges": APIExceptionConnectionTypeEdge,
      "totalCount": 24,
      "edgeCount": 24
    }
  }
}

appSessions

Type: AppSessionConnectionTypeConnection!

URL: https://api.oefr-kraken.energy/v1/graphql/

App sessions recorded at the specified address.

Arguments

Name Description

postcode (String!)

The postcode of the address at which the app session was recorded.

before (String)

after (String)

first (Int)

last (Int)

Query

query AppSessions(
  $postcode: String!,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  appSessions(
    postcode: $postcode,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...AppSessionConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "postcode": "car-bank-goal-billion-region",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "appSessions": {
      "pageInfo": PageInfo,
      "edges": AppSessionConnectionTypeEdge,
      "totalCount": 94,
      "edgeCount": 68
    }
  }
}

authorizedApplications

Type: [AuthorizedApplication]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all the confidential-client applications the current user has authorized.

Query

query AuthorizedApplications {
  authorizedApplications {
    name
    clientId
  }
}

Response

{
  "data": {
    "authorizedApplications": [
      {
        "name": "director-shoulder-lay-offer-remember",
        "clientId": "59076399"
      }
    ]
  }
}

availableProductSwitchDates

Type: [Date]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get available dates for product switch.

The possible errors that can be raised are:

  • KT-CT-1501: Agreement not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

agreementId (Int!)

Agreement ID.

maxRange (Int)

The maximum number of days to look for available dates.

Query

query AvailableProductSwitchDates(
  $agreementId: Int!,
  $maxRange: Int
) {
  availableProductSwitchDates(
    agreementId: $agreementId,
    maxRange: $maxRange
  )
}

Variables

{
  "agreementId": 49324609,
  "maxRange": 20
}

Response

{
  "data": {
    "availableProductSwitchDates": ["1979-02-12"]
  }
}

availableProducts

Type: [SupplyProductType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get available products for the given market.

The possible errors that can be raised are:

  • KT-CT-4930: Unsupported market.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

marketName (String!)

Products available for the target market.

Query

query AvailableProducts($marketName: String!) {
  availableProducts(marketName: $marketName) {
    id
    code
    notes
    fullName
    displayName
    description
    availableFrom
    availableTo
    isHidden
    term
    endsAt
    brandCode
    marketName
    availabilityStatus
    termsContractType
    termsAndConditionsTypes {
      ...TermsAndConditionsTypeFragment
    }
    params
    tags {
      ...SupplyProductTagTypeFragment
    }
  }
}

Variables

{
  "marketName": "return-environment-thus-purpose-high"
}

Response

{
  "data": {
    "availableProducts": [
      {
        "id": "51901187",
        "code": "couple-fund-start-represent-poor",
        "notes": "high-bring-price-condition-whole",
        "fullName": "next-recognize-speech-central-Congress",
        "displayName": "our-attorney-agent-economy-why",
        "description": "military-season-easy-management-sea",
        "availableFrom": "2001-03-20T22:26:26.947300+00:00",
        "availableTo": "1972-11-02T12:46:14.104883+00:00",
        "isHidden": true,
        "term": 43,
        "endsAt": "2014-09-09T02:01:19.907716+00:00",
        "brandCode": "I-meet-lawyer-again-trouble",
        "marketName": "wide-majority-floor-issue-political",
        "availabilityStatus": "EVERYONE",
        "termsContractType": "prove-hospital-to-company-market",
        "termsAndConditionsTypes": TermsAndConditionsType,
        "params": {"key": "value"},
        "tags": SupplyProductTagType
      }
    ]
  }
}

backendScreen

Type: BackendScreenType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get mobile screen details to render.

The possible errors that can be raised are:

  • KT-CT-8001: No backend screen available.
  • KT-CT-8005: Backend screen does not support parameters.
  • KT-CT-8008: Incorrect or missing data necessary to build the screen.
  • KT-CT-8006: Error applying parameters to backend screen.
  • KT-CT-8009: Error translating screen content.
  • KT-CT-8010: Invalid step ID.
  • KT-CT-8011: Cannot rewind past a previous irreversible step.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

screenId (ID!)

The ID of the screen to return.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the screen.

maxVersionSupported (Int)

The maximum version of backend screens supported by the client.

Query

query BackendScreen(
  $screenId: ID!,
  $params: [BackendScreenParamInputType],
  $maxVersionSupported: Int
) {
  backendScreen(
    screenId: $screenId,
    params: $params,
    maxVersionSupported: $maxVersionSupported
  )
}

Variables

{
  "screenId": "33787097",
  "params": BackendScreenParamInputType,
  "maxVersionSupported": 41
}

Response

{
  "data": {
    "backendScreen": BackendScreenType
  }
}

backendScreenEventIds

Type: [String]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all registered backend screen event IDs.

Query

query BackendScreenEventIds {
  backendScreenEventIds
}

Response

{
  "data": {
    "backendScreenEventIds": ["far-by-board-daughter-name"]
  }
}

backendScreenIds

Type: [String]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all registered backend screen IDs.

Query

query BackendScreenIds {
  backendScreenIds
}

Response

{
  "data": {
    "backendScreenIds": ["scene-cover-especially-budget-nothing"]
  }
}

bankDetailsValidation

Type: BankDetailsValidationResult

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

Name Description

iban (NonEmptyString!)

The IBAN of the bank account.

Query

query BankDetailsValidation($iban: NonEmptyString!) {
  bankDetailsValidation(iban: $iban) {
    areValid
    message
  }
}

Variables

{
  "iban": "building-on-last-town-picture"
}

Response

{
  "data": {
    "bankDetailsValidation": {
      "areValid": true,
      "message": "act-rock-wonder-some-third"
    }
  }
}

bills

Type: FraBillsConnection

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the bills for an account and requested parameters.

Arguments

Name Description

accountNumber (String!)

The account number.

supplyPointId (ID)

The ID of the supply point.

propertyId (ID)

Filter bills related to this property.

supplyContractNumber (String)

Filter bills related to this supply contract.

documentId (ID)

Optional document id used to get a specific billing document. This parameter take precedence over the dates parameters.

fromDate (Date)

Optional date representing the beginning of the search results. This date value is inclusive.

toDate (Date)

Optional date representing the end of the search results. This date value is exclusive.

before (String)

after (String)

first (Int)

last (Int)

Query

query Bills(
  $accountNumber: String!,
  $supplyPointId: ID,
  $propertyId: ID,
  $supplyContractNumber: String,
  $documentId: ID,
  $fromDate: Date,
  $toDate: Date,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  bills(
    accountNumber: $accountNumber,
    supplyPointId: $supplyPointId,
    propertyId: $propertyId,
    supplyContractNumber: $supplyContractNumber,
    documentId: $documentId,
    fromDate: $fromDate,
    toDate: $toDate,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...FraBillsEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-53827010",
  "supplyPointId": "48226308",
  "propertyId": "25042596",
  "supplyContractNumber": "it-enough-defense-up-law",
  "documentId": "90323033",
  "fromDate": "2017-11-12",
  "toDate": "2019-12-09",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "bills": {
      "pageInfo": PageInfo,
      "edges": FraBillsEdge,
      "totalCount": 66,
      "edgeCount": 51
    }
  }
}

business

Type: BusinessType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about a business.

The possible errors that can be raised are:

  • KT-CT-11101: The viewer is not authorized to execute the query/mutation. Check the ownership/permissions of provided data.
  • KT-CT-11107: Unauthorized.
  • KT-CT-1605: Invalid input.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

id (ID)

The business ID.

details ([BusinessDetailInput])

List of business detail key-value pairs to filter by.

Query

query Business(
  $id: ID,
  $details: [BusinessDetailInput]
) {
  business(
    id: $id,
    details: $details
  ) {
    id
    name
    number
    businessType
    sectors
    details {
      ...BusinessDetailTypeFragment
    }
    billingAddress {
      ...RichAddressTypeFragment
    }
    legalAddress {
      ...RichAddressTypeFragment
    }
    linkedAccountNumber
    linkedAccountNumbers
    segmentName
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "id": "56128716",
  "details": BusinessDetailInput
}

Response

{
  "data": {
    "business": {
      "id": "66619159",
      "name": "order-safe-give-glass-Mrs",
      "number": "know-produce-strategy-they-know",
      "businessType": "SOLE_TRADER",
      "sectors": None,
      "details": [BusinessDetailType],
      "billingAddress": RichAddressType,
      "legalAddress": RichAddressType,
      "linkedAccountNumber": "A-39F70A3A",
      "linkedAccountNumbers": "23440558",
      "segmentName": "hundred-number-clear-education-question",
      "paymentMethods": PaymentInstructionConnectionTypeConnection
    }
  }
}

businessAccountReferralRewardScheme

Type: ReferralSchemeType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return a business referral reward scheme for the given account referral code.

Arguments

Name Description

code (String!)

Friend referral code.

Query

query BusinessAccountReferralRewardScheme($code: String!) {
  businessAccountReferralRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    maxRecurrence
    isUsageAtCapacity
  }
}

Variables

{
  "code": "see-attack-space-visit-name"
}

Response

{
  "data": {
    "businessAccountReferralRewardScheme": {
      "referralUrl": "know-war-take-produce-team",
      "referralDisplayUrl": "away-camera-subject-enter-keep",
      "referrerRewardAmount": 52,
      "referredRewardAmount": 84,
      "combinedRewardAmount": 65,
      "loyaltyPointsBonus": 89,
      "canBeReferred": true,
      "code": "water-white-young-resource-sound",
      "referrerGivenName": "Katherine",
      "referrerFamilyName": "Snow",
      "schemeType": "agent-each-author-race-better",
      "maxRecurrence": 75,
      "isUsageAtCapacity": true
    }
  }
}

businessContract

Type: Contract

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about an account contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10005: Missing required parameter: either identifier or accountNumber must be provided.
  • KT-CT-10006: Account not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

identifier (String)

The identifier of the contract.

accountNumber (String)

The account number to find the business contract for.

version (Int)

The version of the contract.

Query

query BusinessContract(
  $identifier: String,
  $accountNumber: String,
  $version: Int
) {
  businessContract(
    identifier: $identifier,
    accountNumber: $accountNumber,
    version: $version
  ) {
    identifier
    title
    party
    subject {
      ...AccountTypeFragment
    }
    status
    validFrom
    validTo
    signedAt
    cancelledAt
    lifecycle {
      ...ContractVersionFragment
    }
    terms {
      ...TermInterfaceFragment
    }
  }
}

Variables

{
  "identifier": "51440651",
  "accountNumber": "A-4884E712",
  "version": 54
}

Response

{
  "data": {
    "businessContract": {
      "identifier": "47134348",
      "title": "foot-civil-style-although-market",
      "party": ContractParty,
      "subject": [AccountType],
      "status": "REVOKED",
      "validFrom": "2015-07-31T08:33:29.079890+00:00",
      "validTo": "2004-01-04T09:42:58.503486+00:00",
      "signedAt": "1981-06-08T13:38:31.765922+00:00",
      "cancelledAt": "1975-10-26T18:11:54.700180+00:00",
      "lifecycle": ContractVersion,
      "terms": TermInterface
    }
  }
}

call

Type: CallInterface!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get a call for a given ID.

The possible errors that can be raised are:

  • KT-CT-11802: Call not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

id (ID!)

The call ID.

Query

query Call($id: ID!) {
  call(id: $id) {
    id
    account {
      ...AccountTypeFragment
    }
    metadata {
      ...CallMetadataItemTypeFragment
    }
  }
}

Variables

{
  "id": "74576454"
}

Response

{
  "data": {
    "call": {
      "id": "84184278",
      "account": AccountType,
      "metadata": CallMetadataItemType
    }
  }
}

callTag

Type: CallTagType!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the call tag for a given ID.

The possible errors that can be raised are:

  • KT-CT-11809: Call tag not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

id (ID!)

The call tag ID.

Query

query CallTag($id: ID!) {
  callTag(id: $id) {
    id
    name
    isActive
  }
}

Variables

{
  "id": "90432163"
}

Response

{
  "data": {
    "callTag": {
      "id": "69184827",
      "name": "nation-language-hundred-member-forget",
      "isActive": true
    }
  }
}

Arguments

Name Description

name (String)

Filter by call tag name.

isActive (Boolean)

Filter by active status.

before (String)

after (String)

first (Int)

last (Int)

Query

query CallTags(
  $name: String,
  $isActive: Boolean,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  callTags(
    name: $name,
    isActive: $isActive,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CallTagConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "name": "agree-food-mention-director-simple",
  "isActive": true,
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "callTags": {
      "pageInfo": PageInfo,
      "edges": CallTagConnectionTypeEdge,
      "totalCount": 36,
      "edgeCount": 44
    }
  }
}

Arguments

Name Description

accountNumber (String!)

The account number.

before (String)

after (String)

first (Int)

last (Int)

Query

query Campaigns(
  $accountNumber: String!,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  campaigns(
    accountNumber: $accountNumber,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...AccountCampaignConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-093A894F",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "campaigns": {
      "pageInfo": PageInfo,
      "edges": AccountCampaignConnectionTypeEdge,
      "totalCount": 52,
      "edgeCount": 46
    }
  }
}

Query

query ChargePointVariants {
  chargePointVariants {
    make
    models {
      ...ChargePointVariantModelTypeFragment
    }
  }
}

Response

{
  "data": {
    "chargePointVariants": [
      {
        "make": "commercial-throughout-everyone-six-fill",
        "models": [ChargePointVariantModelType]
      }
    ]
  }
}

collectionProcessDetails

Type: CollectionProcessDetailsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Collection process record details.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11206: Unable to retrieve disconnection related data for collection process.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

collectionProcessRecordNumber (String!)

The collection process record number.

Query

query CollectionProcessDetails($collectionProcessRecordNumber: String!) {
  collectionProcessDetails(collectionProcessRecordNumber: $collectionProcessRecordNumber) {
    collectionProcessRecordNumber
    isPaused
    isComplete
    isActive
    completionType
    associatedItems {
      ...CollectionProcessRecordAssociatedItemTypeFragment
    }
    pausedDays
  }
}

Variables

{
  "collectionProcessRecordNumber": "remember-couple-thought-at-yard"
}

Response

{
  "data": {
    "collectionProcessDetails": {
      "collectionProcessRecordNumber": "visit-heavy-play-south-control",
      "isPaused": true,
      "isComplete": true,
      "isActive": true,
      "completionType": "want-look-eight-better-book",
      "associatedItems": [CollectionProcessRecordAssociatedItemType],
      "pausedDays": 19
    }
  }
}

complaint

Type: ComplaintType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get a complaint.

The possible errors that can be raised are:

  • KT-CT-12301: Complaint not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

complaintId (Int!)

Query

query Complaint($complaintId: Int!) {
  complaint(complaintId: $complaintId) {
    id
    contacts {
      ...ComplaintContactConnectionTypeConnectionFragment
    }
    type
    subtype
    creationDate
    resolutionDate
    assigneeId
  }
}

Variables

{
  "complaintId": 22780881
}

Response

{
  "data": {
    "complaint": {
      "id": "42063296",
      "contacts": ComplaintContactConnectionTypeConnection,
      "type": "likely-letter-red-age-they",
      "subtype": "factor-left-politics-customer-could",
      "creationDate": "2003-02-28",
      "resolutionDate": "2003-12-09",
      "assigneeId": "81537224"
    }
  }
}

completedDispatches

Type: [UpsideDispatchType]

URL: https://api.oefr-kraken.energy/v1/graphql/

All completed device dispatches 12 hours behind, in reverse time order.

Arguments

Name Description

accountNumber (String!)

Query

query CompletedDispatches($accountNumber: String!) {
  completedDispatches(accountNumber: $accountNumber) {
    start
    end
    startDt
    endDt
    deltaKwh
    delta
    meta {
      ...UpsideDispatchMetaTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-248F8111"
}

Response

{
  "data": {
    "completedDispatches": [
      {
        "start": "2002-04-20T23:11:38.428612+00:00",
        "end": "1986-07-24T11:14:52.153981+00:00",
        "startDt": "song-check-in-allow-identify",
        "endDt": "road-she-box-child-budget",
        "deltaKwh": 43,
        "delta": "1.0",
        "meta": UpsideDispatchMetaType
      }
    ]
  }
}

consentTypes

Type: [ConsentTypeType]

URL: https://api.oefr-kraken.energy/v1/graphql/

A list of the consent types available.

Query

query ConsentTypes {
  consentTypes {
    code
    description
    name
    defaultValue
  }
}

Response

{
  "data": {
    "consentTypes": [
      {
        "code": "cultural-project-health-employee-stock",
        "description": "discussion-back-whom-chance-minute",
        "name": "such-matter-week-fight-color",
        "defaultValue": "ACCEPTED"
      }
    ]
  }
}

Arguments

Name Description

supplyPointId (String!)

The supply point id to obtain consumption forecast for. The supply point in an abstract representation of all types of industry meters.

accountNumber (String!)

The account number to obtain consumption forecast for.

startAt (DateTime!)

The start date time of forecasted data to get, this field is inclusive of the data range.

endAt (DateTime!)

The end date time of forecasted data to get, this field is exclusive of the data range.

aggregationTimeInterval (ConsumptionDataAggregationTimeInterval!)

Frequency by day, month or year to aggregate forecasted data.

before (String)

after (String)

first (Int)

last (Int)

Query

query ConsumptionForecast(
  $supplyPointId: String!,
  $accountNumber: String!,
  $startAt: DateTime!,
  $endAt: DateTime!,
  $aggregationTimeInterval: ConsumptionDataAggregationTimeInterval!,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  consumptionForecast(
    supplyPointId: $supplyPointId,
    accountNumber: $accountNumber,
    startAt: $startAt,
    endAt: $endAt,
    aggregationTimeInterval: $aggregationTimeInterval,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ConsumptionForecastConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "supplyPointId": "47634740",
  "accountNumber": "A-4E5A2B83",
  "startAt": "1979-03-03T20:33:39.155271+00:00",
  "endAt": "2010-11-20T13:13:10.129860+00:00",
  "aggregationTimeInterval": "DAILY",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "consumptionForecast": {
      "pageInfo": PageInfo,
      "edges": ConsumptionForecastConnectionTypeEdge,
      "totalCount": 58,
      "edgeCount": 66
    }
  }
}

contractCreationJourney

Type: ContractCreationJourneyType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about a contract creation journey.

The possible errors that can be raised are:

  • KT-CT-10017: The contract journey could not be found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String!)

The number of the contract journey.

Query

query ContractCreationJourney($number: String!) {
  contractCreationJourney(number: $number) {
    number
    status
    contractDetails {
      ...ContractDetailsFragment
    }
    journeyType
    requestedAt
    orderReference
    context {
      ...ContractCreationContextFragment
    }
  }
}

Variables

{
  "number": "affect-however-same-member-skill"
}

Response

{
  "data": {
    "contractCreationJourney": {
      "number": "charge-traditional-crime-simple-position",
      "status": "IN_PROGRESS",
      "contractDetails": ContractDetails,
      "journeyType": "CONTRACT_CREATION",
      "requestedAt": "2012-06-10T18:38:29.075058+00:00",
      "orderReference": "character-about-hope-impact-fast",
      "context": ContractCreationContext
    }
  }
}

Query

query ContributionSchemes {
  contributionSchemes {
    id
    code
    displayName
    taxable
    acceptingContributions
  }
}

Response

{
  "data": {
    "contributionSchemes": [
      {
        "id": "72957231",
        "code": "test-green-film-end-thousand",
        "displayName": "serious-shoulder-find-run-his",
        "taxable": true,
        "acceptingContributions": true
      }
    ]
  }
}

costOfCharge

Type: [CostOfChargeType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Aggregated cost of charge for an EV device.

Deprecated

The 'costOfCharge' field is deprecated.

Use `cost` field on `SmartFlexChargingSession` instead.

- Marked as deprecated on 2025-05-13.
- Scheduled for removal on or after 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/605/

Arguments

Name Description

accountNumber (String!)

frequency (DataFrequency!)

Frequency by day, week, month or year.

startDate (Date)

The start date of the results required. Overrides report date (end date) if provided.

Query

query CostOfCharge(
  $accountNumber: String!,
  $frequency: DataFrequency!,
  $startDate: Date
) {
  costOfCharge(
    accountNumber: $accountNumber,
    frequency: $frequency,
    startDate: $startDate
  ) {
    costOfChargeId
    krakenflexDeviceId
    reportDate
    isSmartCharge
    totalConsumption
    totalCostExclTax
    totalCostInclTax
  }
}

Variables

{
  "accountNumber": "A-3B25D266",
  "frequency": "DAILY",
  "startDate": "2006-11-09"
}

Response

{
  "data": {
    "costOfCharge": [
      {
        "costOfChargeId": "84637441",
        "krakenflexDeviceId": "43312427",
        "reportDate": "1983-03-16",
        "isSmartCharge": true,
        "totalConsumption": 997.18,
        "totalCostExclTax": 187.9,
        "totalCostInclTax": 162.6
      }
    ]
  }
}

customerFeedbackForms

Type: CustomerFeedbackFormConnectionTypeConnection

URL: https://api.oefr-kraken.energy/v1/graphql/

Returns all active customer feedback forms for the account's brand.

Arguments

Name Description

accountNumber (String!)

The account number.

feedbackSource (CustomerFeedbackSourceChoices)

Feedback sources currently supported.

before (String)

after (String)

first (Int)

last (Int)

Query

query CustomerFeedbackForms(
  $accountNumber: String!,
  $feedbackSource: CustomerFeedbackSourceChoices,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  customerFeedbackForms(
    accountNumber: $accountNumber,
    feedbackSource: $feedbackSource,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CustomerFeedbackFormConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-4A59001D",
  "feedbackSource": "FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "customerFeedbackForms": {
      "pageInfo": PageInfo,
      "edges": CustomerFeedbackFormConnectionTypeEdge,
      "totalCount": 14,
      "edgeCount": 19
    }
  }
}

dashboardScreen

Type: Dashboard

URL: https://api.oefr-kraken.energy/v1/graphql/

Get a dashboard screen to render in the form of a json list of sections containing cards or grouped cards each with an order attribute.

The possible errors that can be raised are:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-8001: No backend screen available.
  • KT-CT-8005: Backend screen does not support parameters.
  • KT-CT-8008: Incorrect or missing data necessary to build the screen.
  • KT-CT-8006: Error applying parameters to backend screen.
  • KT-CT-8009: Error translating screen content.
  • KT-CT-8010: Invalid step ID.
  • KT-CT-8011: Cannot rewind past a previous irreversible step.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

dashboardId (ID!)

The ID of the dashboard type screen to return.

accountNumber (String!)

The account number of the user.

maxVersionSupported (Int!)

The maximum version of dahshboard type screens supported by the client.

ledgerNumber (String)

The ledger number associated to the account.

propertyId (String)

The property id associated to the account.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the screen.

Query

query DashboardScreen(
  $dashboardId: ID!,
  $accountNumber: String!,
  $maxVersionSupported: Int!,
  $ledgerNumber: String,
  $propertyId: String,
  $params: [BackendScreenParamInputType]
) {
  dashboardScreen(
    dashboardId: $dashboardId,
    accountNumber: $accountNumber,
    maxVersionSupported: $maxVersionSupported,
    ledgerNumber: $ledgerNumber,
    propertyId: $propertyId,
    params: $params
  ) {
    id
    typename
    dashboardItems {
      ...SectionTypeFragment
    }
    serialisedDashboardItems
  }
}

Variables

{
  "dashboardId": "22137752",
  "accountNumber": "A-323ADADB",
  "maxVersionSupported": 1,
  "ledgerNumber": "available-effect-southern-red-spring",
  "propertyId": "61532615",
  "params": BackendScreenParamInputType
}

Response

{
  "data": {
    "dashboardScreen": {
      "id": "33410448",
      "typename": "turn-help-message-and-song",
      "dashboardItems": SectionType,
      "serialisedDashboardItems": "head-single-whom-story-such"
    }
  }
}

defaultPaymentInstruction

Type: PaymentInstructionType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the default payment instruction for the account's main ledger.

Arguments

Name Description

accountNumber (String!)

The account number.

instructionType (PaymentType)

Provide an option to get either a CARD or DIRECT_DEBIT instruction.

Query

query DefaultPaymentInstruction(
  $accountNumber: String!,
  $instructionType: PaymentType
) {
  defaultPaymentInstruction(
    accountNumber: $accountNumber,
    instructionType: $instructionType
  ) {
    id
    status
    sortCode
    iban
    accountHolder
    instructionType
    cardPaymentNetwork
    cardExpiryMonth
    cardExpiryYear
    supplementaryLedger {
      ...SupplementaryLedgerTypeFragment
    }
    bankCode
    accountType
    validFrom
    vendor
    cardNumber
    cardType
    maskedAccountIdentifier
    owners {
      ...PaymentInstructionOwnerTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-B0256242",
  "instructionType": "BPAY"
}

Response

{
  "data": {
    "defaultPaymentInstruction": {
      "id": "67744201",
      "status": "staff-owner-story-west-camera",
      "sortCode": "radio-marriage-in-recent-at",
      "iban": "shake-cover-notice-dinner-degree",
      "accountHolder": "type-sound-boy-administration-summer",
      "instructionType": "significant-hair-peace-watch-skin",
      "cardPaymentNetwork": "bed-PM-citizen-often-main",
      "cardExpiryMonth": 50,
      "cardExpiryYear": 72,
      "supplementaryLedger": SupplementaryLedgerType,
      "bankCode": "magazine-and-game-law-land",
      "accountType": "choice-per-order-whole-difference",
      "validFrom": "1977-11-17T13:17:41.180863+00:00",
      "vendor": "good-voice-need-think-the",
      "cardNumber": "director-board-form-area-positive",
      "cardType": "player-clear-party-son-environmental",
      "maskedAccountIdentifier": "88145908",
      "owners": [PaymentInstructionOwnerType]
    }
  }
}

defaultRawScore

Type: Int

URL: https://api.oefr-kraken.energy/v1/graphql/

Get default raw score for a customer feedback form.

The possible errors that can be raised are:

  • KT-CT-5513: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

formId (Int!)

Query

query DefaultRawScore($formId: Int!) {
  defaultRawScore(formId: $formId)
}

Variables

{
  "formId": 56616143
}

Response

{
  "data": {
    "defaultRawScore": 95
  }
}

depositAgreements

Type: [DepositAgreementOutput]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get deposit agreements for a given account.

Arguments

Name Description

accountNumber (String!)

Query

query DepositAgreements($accountNumber: String!) {
  depositAgreements(accountNumber: $accountNumber) {
    depositKey
    depositAmount
    acceptedAt
    fulfilledAt
    collectionDate
    dueDate
    returnStrategy
    currentEligibilityStatus {
      ...CurrentEligibilityStatusOutputFragment
    }
  }
}

Variables

{
  "accountNumber": "A-6AD4926B"
}

Response

{
  "data": {
    "depositAgreements": [
      {
        "depositKey": "activity-brother-number-question-heart",
        "depositAmount": 36,
        "acceptedAt": "2001-03-05T18:05:27.203381+00:00",
        "fulfilledAt": "2007-05-28T21:14:08.849633+00:00",
        "collectionDate": "2024-08-15",
        "dueDate": "2001-02-19",
        "returnStrategy": "even-reduce-indicate-style-film",
        "currentEligibilityStatus": CurrentEligibilityStatusOutput
      }
    ]
  }
}

detailedMeasures

Type: ElectricityDetailedMeasure!

URL: https://api.oefr-kraken.energy/v1/graphql/

List of detailed measures.

The possible errors that can be raised are:

  • KT-FR-4510: Invalid PRM.
  • KT-FR-8914: Industry consent missing.
  • KT-FR-4712: Invalid meter readings data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RequestElectricityDetailedMeasuresInput!)

Input fields for requesting detailed measures.

Query

query DetailedMeasures($input: RequestElectricityDetailedMeasuresInput!) {
  detailedMeasures(input: $input) {
    prmRef
    periodStartDate
    periodEndDate
    physicalMeasures {
      ...ElectricityPhysicalMeasureFragment
    }
  }
}

Response

{
  "data": {
    "detailedMeasures": {
      "prmRef": "picture-not-beautiful-reason-up",
      "periodStartDate": "1974-11-05",
      "periodEndDate": "1997-07-11",
      "physicalMeasures": [ElectricityPhysicalMeasure]
    }
  }
}

devices

Type: [SmartFlexDeviceInterface!]

URL: https://api.oefr-kraken.energy/v1/graphql/

A list of devices registered to an account.

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

propertyId (ID)

Only list devices registered to this property.

deviceId (String)

Only list the device with this ID.

integrationDeviceId (String)

Only list the device with this integration device ID.

Query

query Devices(
  $accountNumber: String!,
  $propertyId: ID,
  $deviceId: String,
  $integrationDeviceId: String
) {
  devices(
    accountNumber: $accountNumber,
    propertyId: $propertyId,
    deviceId: $deviceId,
    integrationDeviceId: $integrationDeviceId
  ) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "accountNumber": "A-D9FD3B08",
  "propertyId": "48951839",
  "deviceId": "41566781",
  "integrationDeviceId": "27462582"
}

Response

{
  "data": {
    "devices": [
      {
        "id": "72584420",
        "name": "poor-plant-and-chair-sit",
        "deviceType": "BATTERIES",
        "provider": "BYD",
        "integrationDeviceId": "65450236",
        "status": SmartFlexDeviceStatusInterface,
        "propertyId": "88962953",
        "alerts": SmartFlexDeviceAlertInterface,
        "onboardingWizard": SmartFlexOnboardingWizard,
        "preferences": SmartFlexDevicePreferencesInterface,
        "preferenceSetting": FlexDevicePreferenceSettingInterface,
        "reAuthenticationState": DeviceReAuthenticationInterface
      }
    ]
  }
}

domesticAccountReferralRewardScheme

Type: ReferralSchemeType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return a domestic referral reward scheme for the given account referral code.

Arguments

Name Description

code (String!)

Friend referral code.

Query

query DomesticAccountReferralRewardScheme($code: String!) {
  domesticAccountReferralRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    maxRecurrence
    isUsageAtCapacity
  }
}

Variables

{
  "code": "news-capital-soldier-perhaps-name"
}

Response

{
  "data": {
    "domesticAccountReferralRewardScheme": {
      "referralUrl": "why-arm-series-bring-gas",
      "referralDisplayUrl": "several-near-stand-agreement-music",
      "referrerRewardAmount": 20,
      "referredRewardAmount": 20,
      "combinedRewardAmount": 92,
      "loyaltyPointsBonus": 95,
      "canBeReferred": true,
      "code": "project-better-can-news-some",
      "referrerGivenName": "Michael",
      "referrerFamilyName": "Hernandez",
      "schemeType": "sometimes-long-I-building-common",
      "maxRecurrence": 12,
      "isUsageAtCapacity": true
    }
  }
}

domesticJoiningRewardScheme

Type: ReferralSchemeType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return a joining reward scheme with the given code, if it's active. A joining reward can be a signup reward or a promotional reward.

Arguments

Name Description

code (String!)

Reward code for the scheme.

Query

query DomesticJoiningRewardScheme($code: String!) {
  domesticJoiningRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    maxRecurrence
    isUsageAtCapacity
  }
}

Variables

{
  "code": "black-force-hit-these-debate"
}

Response

{
  "data": {
    "domesticJoiningRewardScheme": {
      "referralUrl": "newspaper-such-must-these-whatever",
      "referralDisplayUrl": "any-executive-defense-building-design",
      "referrerRewardAmount": 93,
      "referredRewardAmount": 24,
      "combinedRewardAmount": 42,
      "loyaltyPointsBonus": 69,
      "canBeReferred": true,
      "code": "good-keep-party-why-without",
      "referrerGivenName": "Andrew",
      "referrerFamilyName": "Jensen",
      "schemeType": "sport-simply-business-exist-look",
      "maxRecurrence": 67,
      "isUsageAtCapacity": true
    }
  }
}

domesticSignupRewardScheme

Type: ReferralSchemeType

URL: https://api.oefr-kraken.energy/v1/graphql/

Return a signup referral reward scheme with the given code, if it's active.

Arguments

Name Description

code (String!)

Reward code for the scheme.

Query

query DomesticSignupRewardScheme($code: String!) {
  domesticSignupRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    maxRecurrence
    isUsageAtCapacity
  }
}

Variables

{
  "code": "will-try-senior-method-music"
}

Response

{
  "data": {
    "domesticSignupRewardScheme": {
      "referralUrl": "particular-focus-tend-only-too",
      "referralDisplayUrl": "large-PM-mother-resource-learn",
      "referrerRewardAmount": 92,
      "referredRewardAmount": 97,
      "combinedRewardAmount": 68,
      "loyaltyPointsBonus": 38,
      "canBeReferred": true,
      "code": "call-about-Congress-senior-represent",
      "referrerGivenName": "Sandra",
      "referrerFamilyName": "Newton",
      "schemeType": "attack-hope-law-hotel-strong",
      "maxRecurrence": 79,
      "isUsageAtCapacity": true
    }
  }
}

electricVehicles

Type: [ElectricVehicleType]

URL: https://api.oefr-kraken.energy/v1/graphql/

All electric vehicle types and their details.

Arguments

Name Description

make (String)

Only return vehicle types for the specified make.

supportedProvider (ProviderChoices)

Only return vehicle types supported by the specified provider, e.g. Tesla.

isIntegrationLive (Boolean)

Only return vehicles that are currently integrated.

Query

query ElectricVehicles(
  $make: String,
  $supportedProvider: ProviderChoices,
  $isIntegrationLive: Boolean
) {
  electricVehicles(
    make: $make,
    supportedProvider: $supportedProvider,
    isIntegrationLive: $isIntegrationLive
  ) {
    make
    models {
      ...ElectricVehicleModelTypeFragment
    }
  }
}

Variables

{
  "make": "mind-professor-safe-production-coach",
  "supportedProvider": "BYD",
  "isIntegrationLive": true
}

Response

{
  "data": {
    "electricVehicles": [
      {
        "make": "late-trade-act-glass-me",
        "models": [ElectricVehicleModelType]
      }
    ]
  }
}

Arguments

Name Description

prmId (String!)

ID of the PRM.

accountNumber (String!)

ID of the account.

startDate (Date!)

Starting date (inclusive) for the query.

endDate (Date!)

End date (exclusive) for the query.

before (String)

after (String)

first (Int)

last (Int)

Query

query ElectricityConsumption(
  $prmId: String!,
  $accountNumber: String!,
  $startDate: Date!,
  $endDate: Date!,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  electricityConsumption(
    prmId: $prmId,
    accountNumber: $accountNumber,
    startDate: $startDate,
    endDate: $endDate,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ElectricityConsumptionEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "prmId": "48157757",
  "accountNumber": "A-086163AF",
  "startDate": "1992-05-18",
  "endDate": "1972-02-22",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "electricityConsumption": {
      "pageInfo": PageInfo,
      "edges": ElectricityConsumptionEdge,
      "totalCount": 47,
      "edgeCount": 98
    }
  }
}

Arguments

Name Description

prmId (String!)

ID of the PRM.

accountNumber (String!)

ID of the account.

periodStartAt (Date)

Starting period date (inclusive) of the reading.

periodEndAt (Date)

End period date (exclusive) of the reading.

calendarType (CalendarType)

The calendar type of the reading.

statusProcessed (ReadingStatus)

The processing status of the reading.

before (String)

after (String)

first (Int)

last (Int)

Query

query ElectricityReading(
  $prmId: String!,
  $accountNumber: String!,
  $periodStartAt: Date,
  $periodEndAt: Date,
  $calendarType: CalendarType,
  $statusProcessed: ReadingStatus,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  electricityReading(
    prmId: $prmId,
    accountNumber: $accountNumber,
    periodStartAt: $periodStartAt,
    periodEndAt: $periodEndAt,
    calendarType: $calendarType,
    statusProcessed: $statusProcessed,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ElectricityReadingEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "prmId": "86016438",
  "accountNumber": "A-F11D920E",
  "periodStartAt": "1989-12-07",
  "periodEndAt": "2018-01-23",
  "calendarType": "PROVIDER",
  "statusProcessed": "OK",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "electricityReading": {
      "pageInfo": PageInfo,
      "edges": ElectricityReadingEdge,
      "totalCount": 75,
      "edgeCount": 22
    }
  }
}

eligibilityToJoinLoyaltyPointsProgram

Type: LoyaltyPointsProgramEligibilityType

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if an account is eligible to join the loyalty points program.

The possible errors that can be raised are:

  • KT-CT-9202: Loyalty Points adapter not configured.
  • KT-CT-9218: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (LoyaltyPointsProgramEligibilityInput!)

Query

query EligibilityToJoinLoyaltyPointsProgram($input: LoyaltyPointsProgramEligibilityInput!) {
  eligibilityToJoinLoyaltyPointsProgram(input: $input) {
    isEligible
    primaryIneligibilityReason
  }
}

Variables

Response

{
  "data": {
    "eligibilityToJoinLoyaltyPointsProgram": {
      "isEligible": true,
      "primaryIneligibilityReason": "outside-before-fund-wish-teach"
    }
  }
}

eligibleDeviceTypes

Type: [KrakenFlexDeviceTypes]

URL: https://api.oefr-kraken.energy/v1/graphql/

A list of device types that are eligible for registration.

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

propertyId (Int)

            The property's id where the device will be registered to.
            Note: in future, eligible device types will be dependent on the property id and
            it will be a required input.

Query

query EligibleDeviceTypes(
  $accountNumber: String!,
  $propertyId: Int
) {
  eligibleDeviceTypes(
    accountNumber: $accountNumber,
    propertyId: $propertyId
  )
}

Variables

{
  "accountNumber": "A-0C2A147F",
  "propertyId": 63073843
}

Response

{
  "data": {
    "eligibleDeviceTypes": "BATTERIES"
  }
}

embeddedNetwork

Type: EmbeddedNetworkType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about an embedded network.

Arguments

Name Description

id (ID!)

Query

query EmbeddedNetwork($id: ID!) {
  embeddedNetwork(id: $id) {
    id
    name
    embeddedProperties {
      ...EmbeddedPropertyTypeFragment
    }
  }
}

Variables

{
  "id": "46798225"
}

Response

{
  "data": {
    "embeddedNetwork": {
      "id": "89136659",
      "name": "exist-protect-process-how-should",
      "embeddedProperties": [EmbeddedPropertyType]
    }
  }
}

Query

query EnergyMixData {
  energyMixData {
    carbonIntensityIndex
  }
}

Response

{
  "data": {
    "energyMixData": {
      "carbonIntensityIndex": "then-could-page-nation-five"
    }
  }
}

enodeLinkSession

Type: EnodeLinkSessionType

URL: https://api.oefr-kraken.energy/v1/graphql/

The user specific Enode link session details.

The possible errors that can be raised are:

  • KT-CT-4328: Invalid data.
  • KT-CT-1111: Unauthorized.
  • KT-CT-4319: Unable to get Enode link session.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'enodeLinkSession' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-10-30.
- Scheduled for removal on or after 2026-04-30.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/608/

Arguments

Name Description

accountNumber (String)

vendor (EnodeVendors)

Query

query EnodeLinkSession(
  $accountNumber: String,
  $vendor: EnodeVendors
) {
  enodeLinkSession(
    accountNumber: $accountNumber,
    vendor: $vendor
  ) {
    linkState
    linkUrl
  }
}

Variables

{
  "accountNumber": "A-4626B3D5",
  "vendor": "AUDI"
}

Response

{
  "data": {
    "enodeLinkSession": {
      "linkState": "organization-anyone-force-remember-collection",
      "linkUrl": "would-to-direction-start-toward"
    }
  }
}

Arguments

Name Description

periodStart (DateTime!)

The start of the period estimated.

periodEnd (DateTime!)

The end of the period estimated.

marketIdentifier (ID!)

This is the unique identifier used by the market to identify the supply point.

deviceId (ID)

The meter id to perform estimation on.

registerId (ID)

The meter's register identifier.

before (String)

after (String)

first (Int)

last (Int)

Query

query EstimateMeterReadings(
  $periodStart: DateTime!,
  $periodEnd: DateTime!,
  $marketIdentifier: ID!,
  $deviceId: ID,
  $registerId: ID,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  estimateMeterReadings(
    periodStart: $periodStart,
    periodEnd: $periodEnd,
    marketIdentifier: $marketIdentifier,
    deviceId: $deviceId,
    registerId: $registerId,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...MeterReadingEstimationReadingEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "periodStart": "2013-12-16T15:35:50.664695+00:00",
  "periodEnd": "2013-01-27T02:07:47.841881+00:00",
  "marketIdentifier": "15631405",
  "deviceId": "93984035",
  "registerId": "34747864",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "estimateMeterReadings": {
      "pageInfo": PageInfo,
      "edges": MeterReadingEstimationReadingEdge,
      "totalCount": 27,
      "edgeCount": 77
    }
  }
}

fanClubStatus

Type: [FanClubStatus]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get current status, historic discounts and future projections for a Fan Club source.

Arguments

Name Description

accountNumber (String)

The account number.

propertyId (Int)

The ID of the property.

Query

query FanClubStatus(
  $accountNumber: String,
  $propertyId: Int
) {
  fanClubStatus(
    accountNumber: $accountNumber,
    propertyId: $propertyId
  ) {
    discountSource
    name
    location
    windFarm
    accountNumbers
    propertyIds
    catchments
    thresholds {
      ...ThresholdFragment
    }
    current {
      ...DiscountDataFragment
    }
    historic {
      ...DiscountDataFragment
    }
    forecast {
      ...DiscountForecastFragment
    }
  }
}

Variables

{
  "accountNumber": "A-2D5026BF",
  "propertyId": 29684645
}

Response

{
  "data": {
    "fanClubStatus": [
      {
        "discountSource": "recently-strategy-my-hour-north",
        "name": "couple-just-add-when-allow",
        "location": "what-anything-level-training-together",
        "windFarm": "already-morning-something-official-pay",
        "accountNumbers": "right-wear-maintain-phone-choose",
        "propertyIds": 14,
        "catchments": "add-might-for-quickly-not",
        "thresholds": Threshold,
        "current": DiscountData,
        "historic": DiscountData,
        "forecast": DiscountForecast
      }
    ]
  }
}

flexPlannedDispatches

Type: [SmartFlexDispatch]

URL: https://api.oefr-kraken.energy/v1/graphql/

All planned device dispatches in time order.

Arguments

Name Description

deviceId (String!)

The SmartFlex device ID to get the planned dispatches for.

Query

query FlexPlannedDispatches($deviceId: String!) {
  flexPlannedDispatches(deviceId: $deviceId) {
    start
    end
    type
    energyAddedKwh
  }
}

Variables

{
  "deviceId": "85430091"
}

Response

{
  "data": {
    "flexPlannedDispatches": [
      {
        "start": "1970-06-16T06:47:12.595896+00:00",
        "end": "2023-04-24T08:12:48.156600+00:00",
        "type": "SMART",
        "energyAddedKwh": "1.0"
      }
    ]
  }
}

flexSupportedDevices

Type: FlexSupportedDevices

URL: https://api.oefr-kraken.energy/v1/graphql/

Devices capable of being registered with SmartFlex.

Arguments

Name Description

deviceType (KrakenFlexDeviceTypes!)

The device type to get the supported devices for.

Query

query FlexSupportedDevices($deviceType: KrakenFlexDeviceTypes!) {
  flexSupportedDevices(deviceType: $deviceType) {
    deviceType
    supportedMakes {
      ...FlexSupportedMakeFragment
    }
  }
}

Variables

{
  "deviceType": "BATTERIES"
}

Response

{
  "data": {
    "flexSupportedDevices": {
      "deviceType": "BATTERIES",
      "supportedMakes": FlexSupportedMake
    }
  }
}

Arguments

Name Description

productCode (String!)

The product code to fetch the terms and conditions for.

Query

query FraTermsAndConditionsForProduct($productCode: String!) {
  fraTermsAndConditionsForProduct(productCode: $productCode) {
    name
    documentUrl
    version
    effectiveFrom
  }
}

Variables

{
  "productCode": "indeed-society-fall-feel-seek"
}

Response

{
  "data": {
    "fraTermsAndConditionsForProduct": {
      "name": "parent-cold-leader-should-car",
      "documentUrl": "thank-small-positive-every-that",
      "version": "part-forget-foreign-central-reveal",
      "effectiveFrom": "1986-08-07T16:12:26.418235+00:00"
    }
  }
}

fraudMeterPointChecks

Type: FraudMeterPointCheckType

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if a given meter point ID is in suspicious meter point IDs list.

Arguments

Name Description

meterPointId (String!)

The meter point ID.

Query

query FraudMeterPointChecks($meterPointId: String!) {
  fraudMeterPointChecks(meterPointId: $meterPointId) {
    meterPointId
    isInSuspiciousList
  }
}

Variables

{
  "meterPointId": "80049782"
}

Response

{
  "data": {
    "fraudMeterPointChecks": {
      "meterPointId": "80255693",
      "isInSuspiciousList": true
    }
  }
}

fraudRiskLevel

Type: FinancialRiskLevelType

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if a given ID and type have a financial risk level.

Arguments

Name Description

identifierValue (String!)

The ID to be checked.

identifierType (String!)

The type of object the ID represents.

Query

query FraudRiskLevel(
  $identifierValue: String!,
  $identifierType: String!
) {
  fraudRiskLevel(
    identifierValue: $identifierValue,
    identifierType: $identifierType
  ) {
    identifierValue
    identifierType
    riskLevel
    isInRiskList
  }
}

Variables

{
  "identifierValue": "manager-husband-explain-watch-benefit",
  "identifierType": "sound-imagine-nor-before-bar"
}

Response

{
  "data": {
    "fraudRiskLevel": {
      "identifierValue": "39325847",
      "identifierType": "fill-play-artist-wind-note",
      "riskLevel": "1.0",
      "isInRiskList": true
    }
  }
}

Arguments

Name Description

pceRef (String!)

ID of the PCE.

accountNumber (String!)

ID of the account.

periodStartAt (Date)

Starting period date (inclusive) of the reading.

periodEndAt (Date)

End period date (exclusive) of the reading.

statusProcessed (ReadingStatus)

The processing status of the reading.

readingType (ReadingType)

The type of the reading.

energyQualification (ReadingQualification)

The reading's energy qualification.

before (String)

after (String)

first (Int)

last (Int)

Query

query GasReading(
  $pceRef: String!,
  $accountNumber: String!,
  $periodStartAt: Date,
  $periodEndAt: Date,
  $statusProcessed: ReadingStatus,
  $readingType: ReadingType,
  $energyQualification: ReadingQualification,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  gasReading(
    pceRef: $pceRef,
    accountNumber: $accountNumber,
    periodStartAt: $periodStartAt,
    periodEndAt: $periodEndAt,
    statusProcessed: $statusProcessed,
    readingType: $readingType,
    energyQualification: $energyQualification,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...GasReadingEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "pceRef": "money-TV-thought-Democrat-adult",
  "accountNumber": "A-79474457",
  "periodStartAt": "1993-06-28",
  "periodEndAt": "2014-09-05",
  "statusProcessed": "OK",
  "readingType": "A",
  "energyQualification": "M",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "gasReading": {
      "pageInfo": PageInfo,
      "edges": GasReadingEdge,
      "totalCount": 85,
      "edgeCount": 20
    }
  }
}

getEnergyLandscapeFieldsDescription

Type: [EnergyLandscapeFieldDescriptorType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Returns the fields description for the associated energy landscape.

The possible errors that can be raised are:

  • KT-FR-4915: The version is not supported or improperly configured.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

version (String)

The version of the energy landscape to query.

Query

query GetEnergyLandscapeFieldsDescription($version: String) {
  getEnergyLandscapeFieldsDescription(version: $version) {
    fieldName
    fieldObject {
      ...EnergyLandscapeFieldInterfaceFragment
    }
  }
}

Variables

{
  "version": "security-she-third-current-century"
}

Response

{
  "data": {
    "getEnergyLandscapeFieldsDescription": [
      {
        "fieldName": "raise-military-key-health-second",
        "fieldObject": EnergyLandscapeFieldInterface
      }
    ]
  }
}

Arguments

Name Description

externalReference (String!)

The external reference of the appointment to return.

agent (OnSiteJobsAgent!)

The agent for the appointment.

Query

query GetOnSiteJobsAppointmentByExternalReference(
  $externalReference: String!,
  $agent: OnSiteJobsAgent!
) {
  getOnSiteJobsAppointmentByExternalReference(
    externalReference: $externalReference,
    agent: $agent
  ) {
    id
    externalJobType
    startAt
    endAt
    externalReference
    jobDetails
    jobNotes
    comments
    cancellationSubCategory
    krakenWorkCategory
    agent
    status
    commsStrategy
    cancellationCategory
    appointmentActions {
      ...OnSiteJobsAppointmentActionConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "externalReference": "production-network-piece-information-ability",
  "agent": "GENERIC_AGENT"
}

Response

{
  "data": {
    "getOnSiteJobsAppointmentByExternalReference": {
      "id": "2d0f5867-728e-43ac-9350-4397c5d0c0bb",
      "externalJobType": "thus-service-condition-Congress-music",
      "startAt": "2001-09-19T07:46:34.733532+00:00",
      "endAt": "2003-02-20T05:32:04.859618+00:00",
      "externalReference": "politics-political-health-third-whether",
      "jobDetails": {"key": "value"},
      "jobNotes": {"key": "value"},
      "comments": "present-evidence-station-issue-rule",
      "cancellationSubCategory": "capital-knowledge-outside-there-radio",
      "krakenWorkCategory": "EXCHANGE",
      "agent": "GENERIC_AGENT",
      "status": "PENDING",
      "commsStrategy": "SEND_ALL",
      "cancellationCategory": "CANCELLED_BY_CUSTOMER",
      "appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection
    }
  }
}

Arguments

Name Description

appointmentId (UUID)

The Kraken ID of the appointment to return.

Query

query GetOnSiteJobsAppointmentById($appointmentId: UUID) {
  getOnSiteJobsAppointmentById(appointmentId: $appointmentId) {
    id
    externalJobType
    startAt
    endAt
    externalReference
    jobDetails
    jobNotes
    comments
    cancellationSubCategory
    krakenWorkCategory
    agent
    status
    commsStrategy
    cancellationCategory
    appointmentActions {
      ...OnSiteJobsAppointmentActionConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "appointmentId": "58eb94a1-0f61-40e0-ade5-8429f54e3003"
}

Response

{
  "data": {
    "getOnSiteJobsAppointmentById": {
      "id": "da013955-b075-4cfc-a13e-cb29cb9236f4",
      "externalJobType": "environment-game-act-operation-election",
      "startAt": "1992-04-16T11:35:44.318703+00:00",
      "endAt": "1987-09-17T12:00:34.038166+00:00",
      "externalReference": "still-set-sometimes-social-store",
      "jobDetails": {"key": "value"},
      "jobNotes": {"key": "value"},
      "comments": "American-reflect-whatever-vote-hope",
      "cancellationSubCategory": "kind-foot-international-edge-as",
      "krakenWorkCategory": "EXCHANGE",
      "agent": "GENERIC_AGENT",
      "status": "PENDING",
      "commsStrategy": "SEND_ALL",
      "cancellationCategory": "CANCELLED_BY_CUSTOMER",
      "appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection
    }
  }
}

getOnSiteJobsAppointmentSlots

Type: OnSiteJobsAppointmentSlotResultsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get appointment slot results using appointment booking session ID.

Arguments

Name Description

appointmentBookingSessionId (UUID!)

Appointment booking session ID to fetch slots for. ID can be obtained via startOnSiteJobsAppointmentBookingSession mutation.

appointmentDate (Date!)

Appointment date (inclusive) to fetch slots from.

Query

query GetOnSiteJobsAppointmentSlots(
  $appointmentBookingSessionId: UUID!,
  $appointmentDate: Date!
) {
  getOnSiteJobsAppointmentSlots(
    appointmentBookingSessionId: $appointmentBookingSessionId,
    appointmentDate: $appointmentDate
  ) {
    slots {
      ...OnSiteJobsAppointmentSlotTypeFragment
    }
    isComplete
  }
}

Variables

{
  "appointmentBookingSessionId": "bf4b813b-6d57-4f20-abcb-e9306c17e68d",
  "appointmentDate": "2003-07-05"
}

Response

{
  "data": {
    "getOnSiteJobsAppointmentSlots": {
      "slots": OnSiteJobsAppointmentSlotType,
      "isComplete": true
    }
  }
}

getOnSiteJobsJobTypes

Type: [OnSiteJobsJobTypeType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get available job types for an on-site jobs request.

Arguments

Name Description

requestId (UUID!)

The ID of the request for which to fetch available job types.

workCategory (OnSiteJobsWorkCategory)

Work category to filter job types by. If it's left as blank, all job types will be returned.

Query

query GetOnSiteJobsJobTypes(
  $requestId: UUID!,
  $workCategory: OnSiteJobsWorkCategory
) {
  getOnSiteJobsJobTypes(
    requestId: $requestId,
    workCategory: $workCategory
  ) {
    id
    name
  }
}

Variables

{
  "requestId": "228abe4b-7942-4369-84e8-de704894f903",
  "workCategory": "EXCHANGE"
}

Response

{
  "data": {
    "getOnSiteJobsJobTypes": [
      {
        "id": "95124150",
        "name": "top-peace-his-owner-marriage"
      }
    ]
  }
}

Arguments

Name Description

requestId (UUID)

The ID of the request to return.

Query

query GetOnSiteJobsRequestById($requestId: UUID) {
  getOnSiteJobsRequestById(requestId: $requestId) {
    id
    reason
    subReason
    isEmergency
    externalReference
    agent
    comment
    account
    marketSupplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
    property {
      ...PropertyTypeFragment
    }
    status
    overallActionsStatus
    requestActions {
      ...OnSiteJobsRequestActionConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
    appointments {
      ...OnSiteJobsAppointmentConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "requestId": "fedfddd5-cc22-471e-b69b-732ca41f215b"
}

Response

{
  "data": {
    "getOnSiteJobsRequestById": {
      "id": "a03cea7e-e1e5-4bf0-803f-7e932550fea2",
      "reason": "them-pattern-near-certain-certainly",
      "subReason": "whose-human-court-economic-environmental",
      "isEmergency": true,
      "externalReference": "seat-long-several-where-laugh",
      "agent": "firm-guy-price-assume-mother",
      "comment": "work-firm-listen-require-foreign",
      "account": "current-three-hope-daughter-medical",
      "marketSupplyPoints": SupplyPointConnectionTypeConnection,
      "property": PropertyType,
      "status": "HELD",
      "overallActionsStatus": "PENDING",
      "requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection,
      "appointments": OnSiteJobsAppointmentConnectionTypeConnection
    }
  }
}

Arguments

Name Description

supplyPointsToMarketNamesMapping ([SupplyPointIdentifierToMarketNameMappingInput])

A list of supply point identifiers to filter requests by.

statuses ([OnSiteJobsRequestStatus])

A list of statuses to filter requests by.

before (String)

after (String)

first (Int)

last (Int)

Query

query GetOnSiteJobsRequests(
  $supplyPointsToMarketNamesMapping: [SupplyPointIdentifierToMarketNameMappingInput],
  $statuses: [OnSiteJobsRequestStatus],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  getOnSiteJobsRequests(
    supplyPointsToMarketNamesMapping: $supplyPointsToMarketNamesMapping,
    statuses: $statuses,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...OnSiteJobsRequestConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "supplyPointsToMarketNamesMapping": SupplyPointIdentifierToMarketNameMappingInput,
  "statuses": "HELD",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "getOnSiteJobsRequests": {
      "pageInfo": PageInfo,
      "edges": OnSiteJobsRequestConnectionTypeEdge,
      "totalCount": 84,
      "edgeCount": 59
    }
  }
}

Arguments

Name Description

marketName (String!)

Market name of the products to list.

productType ([String])

Types of the products to filter by.

code ([String])

Code of the products to filter by.

before (String)

after (String)

first (Int)

last (Int)

Query

query GoodsProducts(
  $marketName: String!,
  $productType: [String],
  $code: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  goodsProducts(
    marketName: $marketName,
    productType: $productType,
    code: $code,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...GoodsProductConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "marketName": "executive-under-window-old-group",
  "productType": ["picture-the-almost-act-force"],
  "code": ["style-heart-out-true-throw"],
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "goodsProducts": {
      "pageInfo": PageInfo,
      "edges": GoodsProductConnectionTypeEdge,
      "totalCount": 79,
      "edgeCount": 28
    }
  }
}

Arguments

Name Description

accountNumber (String!)

The account number.

Query

query GoodsPurchases($accountNumber: String!) {
  goodsPurchases(accountNumber: $accountNumber) {
    code
    ledgerId
    ledgerNumber
    goodsSaleItems {
      ...GoodsSaleItemFragment
    }
    goodsGrants {
      ...GoodsGrantFragment
    }
    marketName
    marketParams
    clientParams
  }
}

Variables

{
  "accountNumber": "A-D3E40536"
}

Response

{
  "data": {
    "goodsPurchases": [
      {
        "code": "future-order-shake-college-plant",
        "ledgerId": "71143381",
        "ledgerNumber": "one-my-house-cover-everything",
        "goodsSaleItems": [GoodsSaleItem],
        "goodsGrants": [GoodsGrant],
        "marketName": "pressure-happy-perform-including-position",
        "marketParams": {"key": "value"},
        "clientParams": {"key": "value"}
      }
    ]
  }
}

goodsQuotes

Type: [GoodsQuote]

URL: https://api.oefr-kraken.energy/v1/graphql/

List quotes given an account number or retrieve a Goods quote given a quote code.

Arguments

Name Description

accountNumber (String)

The account number.

quoteCode (String)

The quote code.

Query

query GoodsQuotes(
  $accountNumber: String,
  $quoteCode: String
) {
  goodsQuotes(
    accountNumber: $accountNumber,
    quoteCode: $quoteCode
  ) {
    id
    code
    totalNetAmount
    quotedAt
    goodsQuotedProducts {
      ...GoodsQuotedProductFragment
    }
    hasQuoteExpired
  }
}

Variables

{
  "accountNumber": "A-0258B0D2",
  "quoteCode": "budget-heart-theory-personal-lot"
}

Response

{
  "data": {
    "goodsQuotes": [
      {
        "id": "65807624",
        "code": "where-finish-fine-group-writer",
        "totalNetAmount": 99,
        "quotedAt": "2000-02-23T16:40:48.294466+00:00",
        "goodsQuotedProducts": [GoodsQuotedProduct],
        "hasQuoteExpired": true
      }
    ]
  }
}

Query

query InboundCallAverageWaitTime {
  inboundCallAverageWaitTime {
    yesterday
    recent
  }
}

Response

{
  "data": {
    "inboundCallAverageWaitTime": {
      "yesterday": 26,
      "recent": 17
    }
  }
}

inkCommsTemplate

Type: String!

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the content of a given comms template name.

The possible errors that can be raised are:

  • KT-CT-7648: The comms template was not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

templateIdentifier (String!)

The identifier of the comms template.

Query

query InkCommsTemplate($templateIdentifier: String!) {
  inkCommsTemplate(templateIdentifier: $templateIdentifier)
}

Variables

{
  "templateIdentifier": "47559088"
}

Response

{
  "data": {
    "inkCommsTemplate": "science-certain-meeting-that-picture"
  }
}

inkConversation

Type: InkConversation!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the Ink conversation for a given account.

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-4177: Unauthorized.
  • KT-CT-7610: No Ink conversation for account.
  • KT-CT-7617: Must supply account number or relay id to get a conversation.
  • KT-CT-7638: Invalid conversation ID.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String)

The account number.

conversationRelayId (String)

The conversation's relay id.

Query

query InkConversation(
  $accountNumber: String,
  $conversationRelayId: String
) {
  inkConversation(
    accountNumber: $accountNumber,
    conversationRelayId: $conversationRelayId
  ) {
    id
    status
    contactChannelIdentities {
      ...InkContactChannelIdentitiesFragment
    }
    accountUsers {
      ...AccountUserTypeFragment
    }
    events {
      ...InkConversationEventsConnectionFragment
    }
    buckets {
      ...InkBucketFragment
    }
  }
}

Variables

{
  "accountNumber": "A-18EC094F",
  "conversationRelayId": "45854522"
}

Response

{
  "data": {
    "inkConversation": {
      "id": "49705194",
      "status": "OPEN",
      "contactChannelIdentities": InkContactChannelIdentities,
      "accountUsers": [AccountUserType],
      "events": InkConversationEventsConnection,
      "buckets": [InkBucket]
    }
  }
}

inkMessage

Type: InkMessage!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the content for a given message.

The possible errors that can be raised are:

  • KT-CT-7611: The message was not found.
  • KT-CT-7638: Invalid conversation ID.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

messageRelayId (String!)

The message's relay id.

Query

query InkMessage($messageRelayId: String!) {
  inkMessage(messageRelayId: $messageRelayId)
}

Variables

{
  "messageRelayId": "63001668"
}

Response

{
  "data": {
    "inkMessage": InkMessage
  }
}

inkMessageAttributes

Type: InkMessageAttributes!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get attributes of a message at time of query.

The possible errors that can be raised are:

  • KT-CT-7611: The message was not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

vendor (String!)

The message's vendor.

vendorId (String!)

The message's vendor id.

Query

query InkMessageAttributes(
  $vendor: String!,
  $vendorId: String!
) {
  inkMessageAttributes(
    vendor: $vendor,
    vendorId: $vendorId
  ) {
    accounts
    accountType
    buckets
    conversationId
    hourOccurredAt
    hoursWaiting
    isAssignedToUserBucket
    isFirstFromContact
    isNewThread
    opsTeam
    recentlyReceivedAutoReplies
    replyToCommsSms
    weekDayOccurredAt
  }
}

Variables

{
  "vendor": "learn-young-hair-television-not",
  "vendorId": "45746129"
}

Response

{
  "data": {
    "inkMessageAttributes": {
      "accounts": "color-hot-personal-south-even",
      "accountType": "southern-spend-follow-message-could",
      "buckets": ["like-there-value-eat-challenge"],
      "conversationId": 99784393,
      "hourOccurredAt": 46,
      "hoursWaiting": 36,
      "isAssignedToUserBucket": true,
      "isFirstFromContact": true,
      "isNewThread": true,
      "opsTeam": "although-experience-line-rise-suddenly",
      "recentlyReceivedAutoReplies": "listen-recognize-candidate-food-book",
      "replyToCommsSms": "soldier-single-store-some-way",
      "weekDayOccurredAt": 59
    }
  }
}

inkMessageTextContent

Type: String!

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the text content of a given message.

The possible errors that can be raised are:

  • KT-CT-7611: The message was not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

messageId (ID!)

The message's id or relay id.

Query

query InkMessageTextContent($messageId: ID!) {
  inkMessageTextContent(messageId: $messageId)
}

Variables

{
  "messageId": "39183468"
}

Response

{
  "data": {
    "inkMessageTextContent": "PM-American-season-vote-husband"
  }
}

isCustomerEligibleToGiveFeedbackFollowingCall

Type: Boolean

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if customer is eligible to give feedback following a phone call.

The possible errors that can be raised are:

  • KT-CT-5519: Voice call not found.
  • KT-CT-5521: Eligibility configuration not found.
  • KT-CT-5522: Invalid eligibility configuration.
  • KT-CT-5523: Invalid account or account user.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

Number of the account.

accountUserNumber (String!)

Number of the account user.

callId (Int!)

ID of the voice call.

Query

query IsCustomerEligibleToGiveFeedbackFollowingCall(
  $accountNumber: String!,
  $accountUserNumber: String!,
  $callId: Int!
) {
  isCustomerEligibleToGiveFeedbackFollowingCall(
    accountNumber: $accountNumber,
    accountUserNumber: $accountUserNumber,
    callId: $callId
  )
}

Variables

{
  "accountNumber": "A-F4B78D4F",
  "accountUserNumber": "U-4467114A",
  "callId": 52232728
}

Response

{
  "data": {
    "isCustomerEligibleToGiveFeedbackFollowingCall": true
  }
}

isCustomerEligibleToGiveFeedbackFollowingEmail

Type: Boolean

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if customer is eligible to give feedback following an email conversation.

The possible errors that can be raised are:

  • KT-CT-5520: Ink conversation not found.
  • KT-CT-5521: Eligibility configuration not found.
  • KT-CT-5522: Invalid eligibility configuration.
  • KT-CT-5523: Invalid account or account user.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

Number of the account.

accountUserNumber (String!)

Number of the account user.

inkConversationId (Int!)

ID of the Ink conversation.

conversationClosedAt (DateTime!)

Datetime when the conversation was closed.

Query

query IsCustomerEligibleToGiveFeedbackFollowingEmail(
  $accountNumber: String!,
  $accountUserNumber: String!,
  $inkConversationId: Int!,
  $conversationClosedAt: DateTime!
) {
  isCustomerEligibleToGiveFeedbackFollowingEmail(
    accountNumber: $accountNumber,
    accountUserNumber: $accountUserNumber,
    inkConversationId: $inkConversationId,
    conversationClosedAt: $conversationClosedAt
  )
}

Variables

{
  "accountNumber": "A-1A106AED",
  "accountUserNumber": "U-CDB36E53",
  "inkConversationId": 62316153,
  "conversationClosedAt": "1986-01-08T14:07:24.325166+00:00"
}

Response

{
  "data": {
    "isCustomerEligibleToGiveFeedbackFollowingEmail": true
  }
}

isPasswordResetTokenValid

Type: Boolean

URL: https://api.oefr-kraken.energy/v1/graphql/

Check validity of a password reset token.

Arguments

Name Description

userId (String!)

Base64 encoded user id.

token (String!)

Password reset token to check.

Query

query IsPasswordResetTokenValid(
  $userId: String!,
  $token: String!
) {
  isPasswordResetTokenValid(
    userId: $userId,
    token: $token
  )
}

Variables

{
  "userId": "57325681",
  "token": "most-race-their-church-way"
}

Response

{
  "data": {
    "isPasswordResetTokenValid": true
  }
}

isValidUfcMember

Type: MembershipResponseStatus

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if a given UFC member number is valid.

The possible errors that can be raised are:

  • KT-FR-7712: Invalid affiliate session.
  • KT-CT-1137: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (IsValidUFCMemberInputType!)

Query

query IsValidUfcMember($input: IsValidUFCMemberInputType!) {
  isValidUfcMember(input: $input)
}

Variables

Response

{
  "data": {
    "isValidUfcMember": "UNKNOWN"
  }
}

joinSupplierProcess

Type: JoinSupplierProcessType

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-10332: Join supplier process not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String!)

The join supplier process number, e.g. JS-12345678.

Query

query JoinSupplierProcess($number: String!) {
  joinSupplierProcess(number: $number) {
    id
    status
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
    number
    currentProcessData {
      ...JoinSupplierProcessDataTypeFragment
    }
  }
}

Variables

{
  "number": "music-yes-blood-local-because"
}

Response

{
  "data": {
    "joinSupplierProcess": {
      "id": "42099618",
      "status": "PENDING",
      "supplyPoints": SupplyPointConnectionTypeConnection,
      "number": "third-this-give-tough-others",
      "currentProcessData": JoinSupplierProcessDataType
    }
  }
}

Query

query KrakenVersion {
  krakenVersion {
    number
    SHA
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "number": "life-rate-wife-east-yourself",
      "SHA": "church-again-million-language-rather"
    }
  }
}

lastReadingDateForMeasurements

Type: Date

URL: https://api.oefr-kraken.energy/v1/graphql/

The last reading date for the measurements.

Arguments

Name Description

accountNumber (String!)

The account number linked to the agreements.

marketSupplyPointId (ID!)

The supply point ID.

readingFrequencyType (ReadingFrequencyType)

Frequency for the reading.

Query

query LastReadingDateForMeasurements(
  $accountNumber: String!,
  $marketSupplyPointId: ID!,
  $readingFrequencyType: ReadingFrequencyType
) {
  lastReadingDateForMeasurements(
    accountNumber: $accountNumber,
    marketSupplyPointId: $marketSupplyPointId,
    readingFrequencyType: $readingFrequencyType
  )
}

Variables

{
  "accountNumber": "A-4815D5B4",
  "marketSupplyPointId": "99192287",
  "readingFrequencyType": "RAW_INTERVAL"
}

Response

{
  "data": {
    "lastReadingDateForMeasurements": "2012-01-04"
  }
}

leadBlocklistValidations

Type: LeadBlockListValidationOutput

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

Name Description

blockListEntries (LeadBlockListValidationInput)

List of client-configured black list entry types.

Query

query LeadBlocklistValidations($blockListEntries: LeadBlockListValidationInput) {
  leadBlocklistValidations(blockListEntries: $blockListEntries) {
    valid
    blockListHits
  }
}

Variables

{
  "blockListEntries": LeadBlockListValidationInput
}

Response

{
  "data": {
    "leadBlocklistValidations": {
      "valid": true,
      "blockListHits": ["test-Democrat-employee-use-school"]
    }
  }
}

leadByNumber

Type: LeadOutput

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String)

Lead number.

Query

query LeadByNumber($number: String) {
  leadByNumber(number: $number) {
    leadId
    givenName
    familyName
    billingName
    billingAddress {
      ...AddressOutputFragment
    }
    billingRichAddress {
      ...RichAddressTypeFragment
    }
    email
    phoneNumber
    number
    stage
    extraDetails
    brand
    salesChannel
    assignedToTeam
    assignedToUser
    nationalId
    leadType
    consents {
      ...ConsentOutputFragment
    }
    accountNumber
  }
}

Variables

{
  "number": "money-step-decade-might-appear"
}

Response

{
  "data": {
    "leadByNumber": {
      "leadId": "23538758",
      "givenName": "Rachel",
      "familyName": "Bell",
      "billingName": "once-radio-work-perhaps-wind",
      "billingAddress": AddressOutput,
      "billingRichAddress": RichAddressType,
      "email": "actually-campaign-positive-issue-audience",
      "phoneNumber": "too-person-meet-owner-somebody",
      "number": "major-very-occur-myself-full",
      "stage": "generation-resource-stock-another-unit",
      "extraDetails": {"key": "value"},
      "brand": "everybody-before-them-model-wall",
      "salesChannel": "difference-herself-phone-north-reduce",
      "assignedToTeam": "statement-model-effort-produce-able",
      "assignedToUser": "put-only-series-sea-value",
      "nationalId": "35973439",
      "leadType": "customer-financial-me-thought-feel",
      "consents": [ConsentOutput],
      "accountNumber": "A-9E642C36"
    }
  }
}

leads

Type: LeadsConnection

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch all leads for this Kraken, with optional filtering.

Arguments

Name Description

input (LeadsQueryInput)

Input fields for retrieving leads.

before (String)

after (String)

first (Int)

last (Int)

Query

query Leads(
  $input: LeadsQueryInput,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  leads(
    input: $input,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...LeadsEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "input": LeadsQueryInput,
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "leads": {
      "pageInfo": PageInfo,
      "edges": LeadsEdge,
      "totalCount": 25,
      "edgeCount": 37
    }
  }
}

leaveSupplierProcess

Type: LeaveSupplierProcessType

URL: https://api.oefr-kraken.energy/v1/graphql/

Details associated with a LeaveSupplier process.

The possible errors that can be raised are:

  • KT-CT-10302: Invalid data.
  • KT-CT-10333: Missing either number of leave supplier process id.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String)

The leave supplier process number, e.g. LS-12345678.

Query

query LeaveSupplierProcess($number: String) {
  leaveSupplierProcess(number: $number) {
    id
    status
    number
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "number": "impact-second-for-really-eat"
}

Response

{
  "data": {
    "leaveSupplierProcess": {
      "id": "72544992",
      "status": "PENDING",
      "number": "beautiful-again-able-poor-player",
      "supplyPoints": SupplyPointConnectionTypeConnection
    }
  }
}

lifecycleProcesses

Type: LifecycleProcessesType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all lifecycle processes associated with an account.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

onlyActive (Boolean)

A flag to filter out only active/current processes.

sortOrder (LifecycleProcessesSortOrder)

The chronological order in which the lifecycle processes are sorted.

accountNumber (String!)

The account number, e.g. A-12345678.

Query

query LifecycleProcesses(
  $onlyActive: Boolean,
  $sortOrder: LifecycleProcessesSortOrder,
  $accountNumber: String!
) {
  lifecycleProcesses(
    onlyActive: $onlyActive,
    sortOrder: $sortOrder,
    accountNumber: $accountNumber
  ) {
    leaveSupplierProcesses {
      ...LeaveSupplierProcessConnectionTypeConnectionFragment
    }
    joinSupplierProcesses {
      ...JoinSupplierProcessConnectionTypeConnectionFragment
    }
    occupyPropertyProcesses {
      ...OccupyPropertyProcessConnectionTypeConnectionFragment
    }
    leavePropertyProcesses {
      ...LeavePropertyProcessConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "onlyActive": true,
  "sortOrder": "ASC",
  "accountNumber": "A-C3D0EA8F"
}

Response

{
  "data": {
    "lifecycleProcesses": {
      "leaveSupplierProcesses": LeaveSupplierProcessConnectionTypeConnection,
      "joinSupplierProcesses": JoinSupplierProcessConnectionTypeConnection,
      "occupyPropertyProcesses": OccupyPropertyProcessConnectionTypeConnection,
      "leavePropertyProcesses": LeavePropertyProcessConnectionTypeConnection
    }
  }
}

livePaymentAdequacyCalculation

Type: LivePaymentAdequacyCalculation

URL: https://api.oefr-kraken.energy/v1/graphql/

Get payment adequacy data with an up to date calculation.

The possible errors that can be raised are:

  • KT-CT-3963: Could not calculate live PA data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

ledgerNumber (String!)

Kraken ledger number.

Query

query LivePaymentAdequacyCalculation($ledgerNumber: String!) {
  livePaymentAdequacyCalculation(ledgerNumber: $ledgerNumber) {
    suggestedNewMonthlyAmount
    consumption {
      ...ConsumptionBreakdownConnectionTypeConnectionFragment
    }
    averageMonthlyCharge
    existingMonthlyAmount
    balanceAdjustment
    currentBalance
    targetBalance
    reviewedOn
  }
}

Variables

{
  "ledgerNumber": "must-national-stuff-star-source"
}

Response

{
  "data": {
    "livePaymentAdequacyCalculation": {
      "suggestedNewMonthlyAmount": 9,
      "consumption": ConsumptionBreakdownConnectionTypeConnection,
      "averageMonthlyCharge": 33,
      "existingMonthlyAmount": 88,
      "balanceAdjustment": 12,
      "currentBalance": 48,
      "targetBalance": 19,
      "reviewedOn": "2012-10-14"
    }
  }
}

loyaltyCards

Type: [LoyaltyCardType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all loyalty cards for the given account user.

Arguments

Name Description

accountUserId (String!)

Account user id.

Query

query LoyaltyCards($accountUserId: String!) {
  loyaltyCards(accountUserId: $accountUserId) {
    id
    scheme
    number
    status
  }
}

Variables

{
  "accountUserId": "58037291"
}

Response

{
  "data": {
    "loyaltyCards": [
      {
        "id": "94776031",
        "scheme": "through-education-exactly-even-push",
        "number": "something-hospital-Congress-program-control",
        "status": "group-back-lot-yet-career"
      }
    ]
  }
}

loyaltyPointLedgerEntry

Type: LoyaltyPointLedgerEntryType

URL: https://api.oefr-kraken.energy/v1/graphql/

Resolve a loyalty point ledger entry.

The possible errors that can be raised are:

  • KT-CT-9215: Loyalty points balance query disabled.
  • KT-CT-9223: Loyalty points ledger entry not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (LoyaltyPointLedgerEntryInput!)

Query

query LoyaltyPointLedgerEntry($input: LoyaltyPointLedgerEntryInput!) {
  loyaltyPointLedgerEntry(input: $input) {
    id
    ledgerType
    value
    balanceBroughtForward
    balanceCarriedForward
    reasonCode
    idempotencyKey
    postedAt
    accountNumber
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointLedgerEntry": {
      "id": "53694681",
      "ledgerType": "he-now-fall-coach-expect",
      "value": "expect-including-soldier-contain-term",
      "balanceBroughtForward": "watch-parent-happen-kind-poor",
      "balanceCarriedForward": "player-research-family-school-assume",
      "reasonCode": "past-quickly-east-trade-tonight",
      "idempotencyKey": "258e569e-654f-4d3b-97ee-6d9f8294e30b",
      "postedAt": "2010-12-13T21:04:52.073148+00:00",
      "accountNumber": "A-80A04082"
    }
  }
}

loyaltyPointLedgers

Type: [LoyaltyPointLedgerEntryType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the Loyalty Point ledger entries for the passed user.

Arguments

Name Description

input (LoyaltyPointLedgersInput)

The input object for retrieving a loyalty point ledger entry.

Query

query LoyaltyPointLedgers($input: LoyaltyPointLedgersInput) {
  loyaltyPointLedgers(input: $input) {
    id
    ledgerType
    value
    balanceBroughtForward
    balanceCarriedForward
    reasonCode
    idempotencyKey
    postedAt
    accountNumber
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointLedgers": [
      {
        "id": "94656883",
        "ledgerType": "hear-art-far-citizen-expect",
        "value": "soldier-effort-think-sometimes-surface",
        "balanceBroughtForward": "take-necessary-daughter-stand-something",
        "balanceCarriedForward": "effort-end-yeah-reality-else",
        "reasonCode": "me-art-responsibility-address-management",
        "idempotencyKey": "2e1d3661-a852-40a1-823e-76d63c912854",
        "postedAt": "2024-07-31T05:59:07.071826+00:00",
        "accountNumber": "A-A7A93613"
      }
    ]
  }
}

loyaltyPointsBalance

Type: AccountLoyaltyPointsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the loyalty points balance for an account.

The possible errors that can be raised are:

  • KT-CT-9218: Unauthorized.
  • KT-CT-9217: Unauthorized.
  • KT-CT-9215: Loyalty points balance query disabled.
  • KT-CT-9216: Unauthorized.
  • KT-CT-9222: Loyalty points balance query requires either accountNumber field (deprecated) or input object (preferred) with account number and optional account user id.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (LoyaltyPointsBalanceInput)

Query

query LoyaltyPointsBalance($input: LoyaltyPointsBalanceInput) {
  loyaltyPointsBalance(input: $input) {
    loyaltyPoints
    totalMonetaryAmount
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointsBalance": {
      "loyaltyPoints": 3,
      "totalMonetaryAmount": 57
    }
  }
}

metadata

Type: [Metadata]

URL: https://api.oefr-kraken.energy/v1/graphql/

Metadata for a linked object.

Arguments

Name Description

linkedObjectType (LinkedObjectType)

identifier (String!)

Query

query Metadata(
  $linkedObjectType: LinkedObjectType,
  $identifier: String!
) {
  metadata(
    linkedObjectType: $linkedObjectType,
    identifier: $identifier
  ) {
    key
    value
  }
}

Variables

{
  "linkedObjectType": "ACCOUNT",
  "identifier": "89112647"
}

Response

{
  "data": {
    "metadata": [
      {
        "key": "place-explain-different-social-Congress",
        "value": {"key": "value"}
      }
    ]
  }
}

metadataForKey

Type: Metadata

URL: https://api.oefr-kraken.energy/v1/graphql/

Metadata for a linked object with key.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-4124: Unauthorized.
  • KT-CT-8411: Invalid data.
  • KT-CT-4179: No metadata found with given key.
  • KT-CT-4155: Invalid data.
  • KT-CT-4177: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

linkedObjectType (LinkedObjectType)

identifier (String!)

key (String!)

Query

query MetadataForKey(
  $linkedObjectType: LinkedObjectType,
  $identifier: String!,
  $key: String!
) {
  metadataForKey(
    linkedObjectType: $linkedObjectType,
    identifier: $identifier,
    key: $key
  ) {
    key
    value
  }
}

Variables

{
  "linkedObjectType": "ACCOUNT",
  "identifier": "97574110",
  "key": "tough-four-instead-detail-movement"
}

Response

{
  "data": {
    "metadataForKey": {
      "key": "a-poor-minute-hard-sport",
      "value": {"key": "value"}
    }
  }
}

meterPointNumberByAddress

Type: String

URL: https://api.oefr-kraken.energy/v1/graphql/

The number of the meter point for the given address.

The possible errors that can be raised are:

  • KT-FR-4523: Invalid market name.
  • KT-CT-1601: Value cannot be empty.
  • KT-CT-4410: Invalid postcode.
  • KT-CT-1605: Invalid input.
  • KT-FR-4532: Service is unavailable on DNO's side.
  • KT-FR-4530: No meter point found.
  • KT-FR-4531: Several meter points were found. Please refine your criteria.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (MeterPointNumberByAddressInputType!)

Query

query MeterPointNumberByAddress($input: MeterPointNumberByAddressInputType!) {
  meterPointNumberByAddress(input: $input)
}

Variables

Response

{
  "data": {
    "meterPointNumberByAddress": "phone-team-mean-sit-view"
  }
}

mfaDevices

Type: [MfaDevice]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all MFA devices for the current user.

Query

query MfaDevices {
  mfaDevices {
    deviceType
    isConfirmed
  }
}

Response

{
  "data": {
    "mfaDevices": [
      {
        "deviceType": "time-scientist-customer-article-drive",
        "isConfirmed": true
      }
    ]
  }
}

Arguments

Name Description

id (ID!)

The ID of the object

Query

query Node($id: ID!) {
  node(id: $id) {
    id
  }
}

Variables

{
  "id": "67579265"
}

Response

{
  "data": {
    "node": {
      "id": "90568358"
    }
  }
}

ocppConnection

Type: OCPPConnectionType

URL: https://api.oefr-kraken.energy/v1/graphql/

To confirm whether a device is connected to OCPP.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4311: Unable to confirm OCPP connection.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

Query

query OcppConnection($accountNumber: String!) {
  ocppConnection(accountNumber: $accountNumber) {
    isConnected
  }
}

Variables

{
  "accountNumber": "A-36951273"
}

Response

{
  "data": {
    "ocppConnection": {
      "isConnected": true
    }
  }
}

ocppDetails

Type: OCPPDetailsType

URL: https://api.oefr-kraken.energy/v1/graphql/

The user specific generated OCPP details.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

Query

query OcppDetails($accountNumber: String!) {
  ocppDetails(accountNumber: $accountNumber) {
    url
    username
  }
}

Variables

{
  "accountNumber": "A-E98F24DB"
}

Response

{
  "data": {
    "ocppDetails": {
      "url": "sometimes-door-option-doctor-population",
      "username": "tend-newspaper-knowledge-central-like"
    }
  }
}

offerForQuoting

Type: OfferType

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

Name Description

identifier (ID)

The identifier of the offer to query.

Query

query OfferForQuoting($identifier: ID) {
  offerForQuoting(identifier: $identifier) {
    identifier
    quote {
      ...QuoteType_Fragment
    }
    description
    validFrom
    validTo
    acceptedAt
    rejectedAt
    createdBy {
      ...ActorTypeFragment
    }
  }
}

Variables

{
  "identifier": "62608810"
}

Response

{
  "data": {
    "offerForQuoting": {
      "identifier": "99315615",
      "quote": QuoteType_,
      "description": "new-including-him-my-yet",
      "validFrom": "1998-05-03T08:37:54.190229+00:00",
      "validTo": "1991-12-14T13:08:03.265688+00:00",
      "acceptedAt": "1978-12-04T07:06:55.462989+00:00",
      "rejectedAt": "2020-04-19T08:00:09.436036+00:00",
      "createdBy": ActorType
    }
  }
}

offerGroupForQuoting

Type: OfferGroupType

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

Name Description

identifier (ID)

The identifier of the offer group to query.

Query

query OfferGroupForQuoting($identifier: ID) {
  offerGroupForQuoting(identifier: $identifier) {
    identifier
    offers {
      ...OfferTypeFragment
    }
    createdAt
    createdBy {
      ...ActorTypeFragment
    }
  }
}

Variables

{
  "identifier": "79584795"
}

Response

{
  "data": {
    "offerGroupForQuoting": {
      "identifier": "95774521",
      "offers": [OfferType],
      "createdAt": "1972-12-19T11:35:07.469258+00:00",
      "createdBy": ActorType
    }
  }
}

offering

Type: OfferingType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about a product offering.

The possible errors that can be raised are:

  • KT-CT-12001: Product catalogue offering with given identifier not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

identifier (String)

The identifier of the offering to query.

Query

query Offering($identifier: String) {
  offering(identifier: $identifier) {
    identifier
    internalName
    customerName
    customerDescription
    isSellable
    lifecycle {
      ...LifecycleTypeFragment
    }
    tags {
      ...TagTypeFragment
    }
    productComponents {
      ...ProductComponentTypeFragment
    }
    offeringComponents {
      ...OfferingComponentTypeFragment
    }
    termTemplateComponents {
      ...TermTemplateComponentTypeFragment
    }
    groups {
      ...GroupTypeFragment
    }
    isAmendable
    isExpired
    isActive
    isDraft
    isLatestVersion
    isFirstDraft
  }
}

Variables

{
  "identifier": "20685932"
}

Response

{
  "data": {
    "offering": {
      "identifier": "72625248",
      "internalName": "exactly-state-sea-animal-control",
      "customerName": "window-thought-cell-deep-us",
      "customerDescription": "road-get-other-job-money",
      "isSellable": true,
      "lifecycle": LifecycleType,
      "tags": [TagType],
      "productComponents": [ProductComponentType],
      "offeringComponents": [OfferingComponentType],
      "termTemplateComponents": [TermTemplateComponentType],
      "groups": [GroupType],
      "isAmendable": true,
      "isExpired": true,
      "isActive": true,
      "isDraft": true,
      "isLatestVersion": true,
      "isFirstDraft": true
    }
  }
}

opportunities

Type: OpportunitiesConnection

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch all opportunities for this Kraken, with optional filtering.

Arguments

Name Description

input (OpportunitiesQueryInput)

Input fields for retrieving opportunities.

before (String)

after (String)

first (Int)

last (Int)

Query

query Opportunities(
  $input: OpportunitiesQueryInput,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  opportunities(
    input: $input,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...OpportunitiesEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "input": OpportunitiesQueryInput,
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "opportunities": {
      "pageInfo": PageInfo,
      "edges": OpportunitiesEdge,
      "totalCount": 69,
      "edgeCount": 55
    }
  }
}

opportunityByNumber

Type: OpportunityOutput

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String)

Opportunity number identifier.

Query

query OpportunityByNumber($number: String) {
  opportunityByNumber(number: $number) {
    opportunityId
    leadNumber
    leadType
    name
    email
    phoneNumber
    number
    funnel {
      ...SalesFunnelFragment
    }
    stage
    extraDetails
    opportunityAddress {
      ...AddressOutputFragment
    }
    opportunityRichAddress {
      ...RichAddressTypeFragment
    }
    salesChannel
    assignedToTeam
    assignedToUser
    productOfferingId
    offerGroupId
    consents {
      ...ConsentOutputFragment
    }
  }
}

Variables

{
  "number": "purpose-with-tell-class-strong"
}

Response

{
  "data": {
    "opportunityByNumber": {
      "opportunityId": "49860782",
      "leadNumber": "many-decade-college-family-control",
      "leadType": "term-industry-general-cut-arrive",
      "name": "will-religious-discussion-can-hope",
      "email": "someone-address-charge-perhaps-bed",
      "phoneNumber": "sound-little-ago-lot-see",
      "number": "nothing-real-anything-feeling-when",
      "funnel": SalesFunnel,
      "stage": "human-sound-away-both-environmental",
      "extraDetails": {"key": "value"},
      "opportunityAddress": AddressOutput,
      "opportunityRichAddress": RichAddressType,
      "salesChannel": "power-carry-than-door-whole",
      "assignedToTeam": "bank-whose-at-very-current",
      "assignedToUser": "story-player-of-production-run",
      "productOfferingId": "59096361",
      "offerGroupId": "28300283",
      "consents": [ConsentOutput]
    }
  }
}

opportunityProductSummary

Type: OpportunityProductSummary

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8923: The opportunity does not have a linked offer group.
  • KT-CT-8922: The opportunity does not have an accepted offer.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String)

Opportunity number.

Query

query OpportunityProductSummary($number: String) {
  opportunityProductSummary(number: $number) {
    productOfferingIdentifier
    productIdentifier
    productCode
    productCharacteristics
    market
  }
}

Variables

{
  "number": "product-finally-individual-responsibility-trial"
}

Response

{
  "data": {
    "opportunityProductSummary": {
      "productOfferingIdentifier": "97432979",
      "productIdentifier": "76854977",
      "productCode": "individual-forward-write-whatever-baby",
      "productCharacteristics": {"key": "value"},
      "market": "fall-energy-economic-too-challenge"
    }
  }
}

opportunityValueByKey

Type: String

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-8903: Unable to update opportunity.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

opportunityId (ID)

The identifier of the opportunity to query.

key (String)

The key the a funnel-specific value you wish to obtain.

Query

query OpportunityValueByKey(
  $opportunityId: ID,
  $key: String
) {
  opportunityValueByKey(
    opportunityId: $opportunityId,
    key: $key
  )
}

Variables

{
  "opportunityId": "32427666",
  "key": "similar-often-quite-evening-final"
}

Response

{
  "data": {
    "opportunityValueByKey": "through-rock-quality-yes-challenge"
  }
}

orderDetails

Type: OrderDetailsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-13101: Order not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

identifier (String!)

Order identifier.

Query

query OrderDetails($identifier: String!) {
  orderDetails(identifier: $identifier) {
    order {
      ...OrderTypeFragment
    }
    status
    resources {
      ...OrderResourceFragment
    }
  }
}

Variables

{
  "identifier": "17684795"
}

Response

{
  "data": {
    "orderDetails": {
      "order": OrderType,
      "status": "PENDING",
      "resources": [OrderResource]
    }
  }
}

passwordValidatorHelpTexts

Type: [String]

URL: https://api.oefr-kraken.energy/v1/graphql/

The help text of all configured password validators as plain-text or html. Defaults to plain-text.

Arguments

Name Description

asHtml (Boolean)

Return the results as html instead of plain-text. Defaults to False.

Query

query PasswordValidatorHelpTexts($asHtml: Boolean) {
  passwordValidatorHelpTexts(asHtml: $asHtml)
}

Variables

{
  "asHtml": true
}

Response

{
  "data": {
    "passwordValidatorHelpTexts": ["prevent-trade-small-act-response"]
  }
}

paymentFingerprintChecks

Type: PaymentFingerPrintCheckType

URL: https://api.oefr-kraken.energy/v1/graphql/

Check if a given payment fingerprint already exists and/or is risk-listed.

Arguments

Name Description

fingerprint (String!)

Fingerprint.

Query

query PaymentFingerprintChecks($fingerprint: String!) {
  paymentFingerprintChecks(fingerprint: $fingerprint) {
    fingerprint
    isFound
    isRiskListed
  }
}

Variables

{
  "fingerprint": "medical-up-citizen-east-main"
}

Response

{
  "data": {
    "paymentFingerprintChecks": {
      "fingerprint": "cold-some-main-attack-security",
      "isFound": true,
      "isRiskListed": true
    }
  }
}

paymentRequests

Type: PaymentRequestsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get all payment requests for the given ledger.

Arguments

Name Description

ledgerNumber (String!)

Kraken ledger number.

Query

query PaymentRequests($ledgerNumber: String!) {
  paymentRequests(ledgerNumber: $ledgerNumber) {
    paymentRequest {
      ...PaymentRequestConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "ledgerNumber": "that-beyond-bring-process-fish"
}

Response

{
  "data": {
    "paymentRequests": {
      "paymentRequest": PaymentRequestConnectionTypeConnection
    }
  }
}

paymentSchedule

Type: PaymentSchedule

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the payment schedule for an agreement.

The possible errors that can be raised are:

  • KT-FR-4910: Unauthorized to access to this agreement.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

ID of the account.

agreementId (Int!)

ID of the agreement.

Query

query PaymentSchedule(
  $accountNumber: String!,
  $agreementId: Int!
) {
  paymentSchedule(
    accountNumber: $accountNumber,
    agreementId: $agreementId
  ) {
    temporaryUrl
  }
}

Variables

{
  "accountNumber": "A-EFF7E9C8",
  "agreementId": 17372119
}

Response

{
  "data": {
    "paymentSchedule": {
      "temporaryUrl": "federal-learn-commercial-bank-some"
    }
  }
}

Arguments

Name Description

accountNumber (String!)

ID of the account.

supplyPointId (ID)

The ID of the supply point.

propertyId (ID)

Filter payments and repayments related to this property.

supplyContractNumber (String)

Filter bills related to this supply contract.

fromDate (Date)

Optional date representing the beginning of the search results. This date value is inclusive.

toDate (Date)

Optional date representing the end of the search results. This date value is exclusive.

paymentStatus (AccountPaymentStatusOptions)

Filter on the payments status.

paymentReason (PaymentReasonOptions)

Filter for payments that were taken for a particular reason.

repaymentStatuses ([AccountRepaymentStatusOptions])

Only return repayments whose status matches one of these statuses.

before (String)

after (String)

first (Int)

last (Int)

Query

query PaymentsAndRepayments(
  $accountNumber: String!,
  $supplyPointId: ID,
  $propertyId: ID,
  $supplyContractNumber: String,
  $fromDate: Date,
  $toDate: Date,
  $paymentStatus: AccountPaymentStatusOptions,
  $paymentReason: PaymentReasonOptions,
  $repaymentStatuses: [AccountRepaymentStatusOptions],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  paymentsAndRepayments(
    accountNumber: $accountNumber,
    supplyPointId: $supplyPointId,
    propertyId: $propertyId,
    supplyContractNumber: $supplyContractNumber,
    fromDate: $fromDate,
    toDate: $toDate,
    paymentStatus: $paymentStatus,
    paymentReason: $paymentReason,
    repaymentStatuses: $repaymentStatuses,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...FraAccountPaymentConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-E18E771D",
  "supplyPointId": "62209543",
  "propertyId": "11808615",
  "supplyContractNumber": "billion-lawyer-assume-different-drug",
  "fromDate": "1993-10-19",
  "toDate": "2014-08-14",
  "paymentStatus": "SCHEDULED",
  "paymentReason": "BALANCE_THRESHOLD_CROSSED",
  "repaymentStatuses": "REQUESTED",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "paymentsAndRepayments": {
      "pageInfo": PageInfo,
      "edges": FraAccountPaymentConnectionTypeEdge,
      "totalCount": 19,
      "edgeCount": 36
    }
  }
}

paymentsAndRepaymentsForPrm

Type: FraAccountPaymentConnectionTypeConnection

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the payments and repayments for an account and for a specific PRM.

Deprecated

The 'paymentsAndRepaymentsForPrm' field is deprecated.

Replaced for a generic query to obtain payments and repayments. Please use 'paymentsAndRepayments' instead.

- Marked as deprecated on 2024-04-01.
- Scheduled for removal on or after 2024-12-01.

Arguments

Name Description

accountNumber (String!)

ID of the account.

prmId (String!)

ID of the PRM.

fromDate (Date)

Optional date representing the beginning of the search results. This date value is inclusive.

toDate (Date)

Optional date representing the end of the search results. This date value is exclusive.

paymentStatus (AccountPaymentStatusOptions)

Filter on the payments status.

paymentReason (PaymentReasonOptions)

Filter for payments that were taken for a particular reason.

repaymentStatuses ([AccountRepaymentStatusOptions])

Only return repayments whose status matches one of these statuses.

before (String)

after (String)

first (Int)

last (Int)

Query

query PaymentsAndRepaymentsForPrm(
  $accountNumber: String!,
  $prmId: String!,
  $fromDate: Date,
  $toDate: Date,
  $paymentStatus: AccountPaymentStatusOptions,
  $paymentReason: PaymentReasonOptions,
  $repaymentStatuses: [AccountRepaymentStatusOptions],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  paymentsAndRepaymentsForPrm(
    accountNumber: $accountNumber,
    prmId: $prmId,
    fromDate: $fromDate,
    toDate: $toDate,
    paymentStatus: $paymentStatus,
    paymentReason: $paymentReason,
    repaymentStatuses: $repaymentStatuses,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...FraAccountPaymentConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-76531AB4",
  "prmId": "73098633",
  "fromDate": "1982-07-07",
  "toDate": "2018-10-08",
  "paymentStatus": "SCHEDULED",
  "paymentReason": "BALANCE_THRESHOLD_CROSSED",
  "repaymentStatuses": "REQUESTED",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "paymentsAndRepaymentsForPrm": {
      "pageInfo": PageInfo,
      "edges": FraAccountPaymentConnectionTypeEdge,
      "totalCount": 58,
      "edgeCount": 44
    }
  }
}

plannedDispatches

Type: [UpsideDispatchType]

URL: https://api.oefr-kraken.energy/v1/graphql/

All planned device dispatches 24 hours ahead, (usually) in time order.

Deprecated

The 'plannedDispatches' field is deprecated.

Please use 'flexPlannedDispatches' instead.

- Marked as deprecated on 2025-05-27.
- Scheduled for removal on or after 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/604/

Arguments

Name Description

accountNumber (String!)

Query

query PlannedDispatches($accountNumber: String!) {
  plannedDispatches(accountNumber: $accountNumber) {
    start
    end
    startDt
    endDt
    deltaKwh
    delta
    meta {
      ...UpsideDispatchMetaTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-7525049F"
}

Response

{
  "data": {
    "plannedDispatches": [
      {
        "start": "1987-12-27T19:31:04.102358+00:00",
        "end": "1990-07-04T13:36:53.058665+00:00",
        "startDt": "situation-build-draw-purpose-also",
        "endDt": "thing-serve-fund-hear-positive",
        "deltaKwh": 53,
        "delta": "1.0",
        "meta": UpsideDispatchMetaType
      }
    ]
  }
}

pmaxAnalysis

Type: PMAXAnalysisType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get PMAX analysis by token.

The possible errors that can be raised are:

  • KT-FR-8910: PMAX Analysis not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

token (UUID!)

Unique identifier of the analysis.

Query

query PmaxAnalysis($token: UUID!) {
  pmaxAnalysis(token: $token) {
    token
    recommendedSubscribedMaxPower
    yearlyProfitAmountCents
    currentSubscribedMaxPower
    firstName
    lastName
    suggestedPowerAdjustment
    meterPoint {
      ...MeterPointInterfaceFragment
    }
    product {
      ...ProductFragment
    }
  }
}

Variables

{
  "token": "dbf8593d-a861-423c-bdbb-160bc846d17f"
}

Response

{
  "data": {
    "pmaxAnalysis": {
      "token": "b8cf9fda-f516-4728-b0ce-b331978160bf",
      "recommendedSubscribedMaxPower": 26,
      "yearlyProfitAmountCents": 566.65,
      "currentSubscribedMaxPower": 3,
      "firstName": "important-property-situation-push-final",
      "lastName": "form-because-sport-talk-contain",
      "suggestedPowerAdjustment": "NONE",
      "meterPoint": MeterPointInterface,
      "product": Product
    }
  }
}

portfolio

Type: PortfolioType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about a portfolio, using its portfolio number.

The possible errors that can be raised are:

  • KT-CT-9403: Received an invalid portfolioId.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

portfolioNumber (String!)

Portfolio number to be retrieved.

Query

query Portfolio($portfolioNumber: String!) {
  portfolio(portfolioNumber: $portfolioNumber) {
    id
    number
    createdAt
    updatedAt
    billingName
    collectiveBilling
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    leadAccountNumber
    brand
    name
    depth
    parent {
      ...PortfolioTypeFragment
    }
    ancestors {
      ...PortfolioConnectionTypeConnectionFragment
    }
    descendants {
      ...PortfolioConnectionTypeConnectionFragment
    }
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "portfolioNumber": "P-25535212"
}

Response

{
  "data": {
    "portfolio": {
      "id": "85248784",
      "number": "red-little-opportunity-strong-interest",
      "createdAt": "2013-06-08T12:43:40.110538+00:00",
      "updatedAt": "1992-12-28T17:03:24.619446+00:00",
      "billingName": "sport-response-out-factor-country",
      "collectiveBilling": true,
      "operationsTeam": OperationsTeamType,
      "leadAccountNumber": "A-6D8D20B0",
      "brand": "ever-market-public-state-none",
      "name": "me-size-much-wear-minute",
      "depth": 78,
      "parent": PortfolioType,
      "ancestors": PortfolioConnectionTypeConnection,
      "descendants": PortfolioConnectionTypeConnection,
      "accounts": AccountConnectionTypeConnection
    }
  }
}

portfolioByReference

Type: PortfolioType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get details about a portfolio, using its reference.

The possible errors that can be raised are:

  • KT-CT-9409: Invalid portfolio reference.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

portfolioReference (PortfolioReferenceInput!)

Portfolio reference namespace-value pair to filter by.

Query

query PortfolioByReference($portfolioReference: PortfolioReferenceInput!) {
  portfolioByReference(portfolioReference: $portfolioReference) {
    id
    number
    createdAt
    updatedAt
    billingName
    collectiveBilling
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    leadAccountNumber
    brand
    name
    depth
    parent {
      ...PortfolioTypeFragment
    }
    ancestors {
      ...PortfolioConnectionTypeConnectionFragment
    }
    descendants {
      ...PortfolioConnectionTypeConnectionFragment
    }
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "portfolioReference": PortfolioReferenceInput
}

Response

{
  "data": {
    "portfolioByReference": {
      "id": "83922151",
      "number": "soldier-market-knowledge-administration-a",
      "createdAt": "2012-03-01T17:59:10.183040+00:00",
      "updatedAt": "1993-05-26T21:37:48.712631+00:00",
      "billingName": "support-address-have-toward-financial",
      "collectiveBilling": true,
      "operationsTeam": OperationsTeamType,
      "leadAccountNumber": "A-4C3496DC",
      "brand": "herself-president-live-certainly-our",
      "name": "newspaper-word-near-mention-risk",
      "depth": 90,
      "parent": PortfolioType,
      "ancestors": PortfolioConnectionTypeConnection,
      "descendants": PortfolioConnectionTypeConnection,
      "accounts": AccountConnectionTypeConnection
    }
  }
}

possibleErrors

Type: PossibleErrorsOutputType

URL: https://api.oefr-kraken.energy/v1/graphql/

Possible errors of the requested query/mutation.

The possible errors that can be raised are:

  • KT-CT-1606: Query/Mutation not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (PossibleErrorsInputType!)

Query or Mutation for which to get the possible errors list.

Query

query PossibleErrors($input: PossibleErrorsInputType!) {
  possibleErrors(input: $input) {
    name
    type
    authErrors
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

Response

{
  "data": {
    "possibleErrors": {
      "name": "owner-rise-sell-month-across",
      "type": "query",
      "authErrors": true,
      "possibleErrors": [PossibleErrorType]
    }
  }
}

printBatch

Type: PrintBatchType!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get print batch details, including messages in the batch.

The possible errors that can be raised are:

  • KT-CT-9013: Invalid data.
  • KT-CT-9012: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

batchId (ID)

The print batch ID.

Query

query PrintBatch($batchId: ID) {
  printBatch(batchId: $batchId) {
    id
    status
    messages {
      ...PrintMessageTypeConnectionFragment
    }
  }
}

Variables

{
  "batchId": "32353885"
}

Response

{
  "data": {
    "printBatch": {
      "id": "69577519",
      "status": "OPEN",
      "messages": PrintMessageTypeConnection
    }
  }
}

proofOfResidence

Type: ProofOfResidence

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the proof of residence of an user.

The possible errors that can be raised are:

  • KT-FR-4910: Unauthorized to access to this agreement.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

ID of the account.

agreementId (Int!)

ID of the agreement.

Query

query ProofOfResidence(
  $accountNumber: String!,
  $agreementId: Int!
) {
  proofOfResidence(
    accountNumber: $accountNumber,
    agreementId: $agreementId
  ) {
    temporaryUrl
  }
}

Variables

{
  "accountNumber": "A-EA9E8BE5",
  "agreementId": 11144123
}

Response

{
  "data": {
    "proofOfResidence": {
      "temporaryUrl": "trouble-guy-claim-series-break"
    }
  }
}

propertiesSearch

Type: [PropertySearchResult!]!

URL: https://api.oefr-kraken.energy/v1/graphql/

Search for properties that are already in Kraken and match the search term.

Arguments

Name Description

searchTerm (String!)

The search term. It can be an address or a meter point identifier.

Query

query PropertiesSearch($searchTerm: String!) {
  propertiesSearch(searchTerm: $searchTerm) {
    score
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "searchTerm": "card-everything-body-training-cover"
}

Response

{
  "data": {
    "propertiesSearch": {
      "score": "1.0",
      "property": PropertyType
    }
  }
}

property

Type: PropertyType

URL: https://api.oefr-kraken.energy/v1/graphql/

A property with the given ID. Usually associated with supply points.

Arguments

Name Description

id (ID!)

The property ID.

Query

query Property($id: ID!) {
  property(id: $id) {
    id
    postcode
    address
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
    label
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    measurements {
      ...MeasurementConnectionFragment
    }
    smartDeviceNetworks {
      ...SmartMeterDeviceNetworkTypeFragment
    }
    isChangeOfTenancyOngoing
    isSmets2InstallationAllowed
    electricityMeterPoints {
      ...ElectricityMeterPointTypeFragment
    }
    gasMeterPoints {
      ...GasMeterPointTypeFragment
    }
    wanCoverage
    availableSmets2InstallationTimeslots {
      ...Smets2InstallationTimeslotTypeFragment
    }
  }
}

Variables

{
  "id": "35164142"
}

Response

{
  "data": {
    "property": {
      "id": "82634079",
      "postcode": "feel-her-I-within-billion",
      "address": "north-people-wish-real-fish",
      "richAddress": PropertyRichAddressType,
      "splitAddress": ["as-attention-type-represent-necessary"],
      "label": "general-eight-campaign-information-Democrat",
      "occupancyPeriods": [OccupancyPeriodType],
      "coordinates": CoordinatesType,
      "embeddedNetwork": EmbeddedNetworkType,
      "measurements": MeasurementConnection,
      "smartDeviceNetworks": [SmartMeterDeviceNetworkType],
      "isChangeOfTenancyOngoing": true,
      "isSmets2InstallationAllowed": true,
      "electricityMeterPoints": [ElectricityMeterPointType],
      "gasMeterPoints": [GasMeterPointType],
      "wanCoverage": "HIGH",
      "availableSmets2InstallationTimeslots": [Smets2InstallationTimeslotType]
    }
  }
}

propertySearch

Type: [PropertyType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Search for properties that are already in Kraken and match the search term.

Deprecated

The 'propertySearch' field is deprecated.

This query is being deprecated in favour of `propertiesSearch`. The latter returns not only the matched properties but the level of confidence in the results through the `score` field.

- Marked as deprecated on 2023-05-23.
- Scheduled for removal on or after 2024-01-01.

Arguments

Name Description

searchTerm (String!)

The search term. It can be an address or a meter point identifier.

Query

query PropertySearch($searchTerm: String!) {
  propertySearch(searchTerm: $searchTerm) {
    id
    postcode
    address
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
    label
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    measurements {
      ...MeasurementConnectionFragment
    }
    smartDeviceNetworks {
      ...SmartMeterDeviceNetworkTypeFragment
    }
    isChangeOfTenancyOngoing
    isSmets2InstallationAllowed
    electricityMeterPoints {
      ...ElectricityMeterPointTypeFragment
    }
    gasMeterPoints {
      ...GasMeterPointTypeFragment
    }
    wanCoverage
    availableSmets2InstallationTimeslots {
      ...Smets2InstallationTimeslotTypeFragment
    }
  }
}

Variables

{
  "searchTerm": "chance-west-PM-detail-soldier"
}

Response

{
  "data": {
    "propertySearch": [
      {
        "id": "28471257",
        "postcode": "decision-girl-beautiful-rise-different",
        "address": "than-door-down-evening-enjoy",
        "richAddress": PropertyRichAddressType,
        "splitAddress": ["clear-already-doctor-movie-wind"],
        "label": "executive-much-charge-teach-hope",
        "occupancyPeriods": [OccupancyPeriodType],
        "coordinates": CoordinatesType,
        "embeddedNetwork": EmbeddedNetworkType,
        "measurements": MeasurementConnection,
        "smartDeviceNetworks": [SmartMeterDeviceNetworkType],
        "isChangeOfTenancyOngoing": true,
        "isSmets2InstallationAllowed": true,
        "electricityMeterPoints": [ElectricityMeterPointType],
        "gasMeterPoints": [GasMeterPointType],
        "wanCoverage": "HIGH",
        "availableSmets2InstallationTimeslots": [Smets2InstallationTimeslotType]
      }
    ]
  }
}

providerAuthDetails

Type: ProviderAuthDetailsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Auth details (e.g. OAuth 2.0 URI) for the provider (if available).

Deprecated

The 'providerAuthDetails' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-10-30.
- Scheduled for removal on or after 2026-04-30.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/608/

Arguments

Name Description

provider (ProviderChoices!)

The provider to get the auth details for.

deviceType (KrakenFlexDeviceTypes!)

The device type to get the auth details for (as providers may support multiple).

clientType (ClientType)

The client type the request originated from. Used when oauth_uri is different between web and app.

accountNumber (String)

The account number that will be associated with the device. Required for some providers.

propertyId (Int)

The ID of the property the device belongs to.

Query

query ProviderAuthDetails(
  $provider: ProviderChoices!,
  $deviceType: KrakenFlexDeviceTypes!,
  $clientType: ClientType,
  $accountNumber: String,
  $propertyId: Int
) {
  providerAuthDetails(
    provider: $provider,
    deviceType: $deviceType,
    clientType: $clientType,
    accountNumber: $accountNumber,
    propertyId: $propertyId
  ) {
    oauthUri
  }
}

Variables

{
  "provider": "BYD",
  "deviceType": "BATTERIES",
  "clientType": "APP",
  "accountNumber": "A-0ED33CAB",
  "propertyId": 99333647
}

Response

{
  "data": {
    "providerAuthDetails": {
      "oauthUri": "economic-send-little-us-several"
    }
  }
}

providerVirtualKeyDetails

Type: ProviderVirtualKeyDetailsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Virtual key details (e.g. certificate public key) for the provider (if available).

Arguments

Name Description

provider (ProviderChoices!)

The provider to get the virtual key details for.

deviceType (KrakenFlexDeviceTypes!)

The device type to get the virtual key details for (as providers may support multiple).

Query

query ProviderVirtualKeyDetails(
  $provider: ProviderChoices!,
  $deviceType: KrakenFlexDeviceTypes!
) {
  providerVirtualKeyDetails(
    provider: $provider,
    deviceType: $deviceType
  ) {
    virtualKeyName
    virtualKeyUri
  }
}

Variables

{
  "provider": "BYD",
  "deviceType": "BATTERIES"
}

Response

{
  "data": {
    "providerVirtualKeyDetails": {
      "virtualKeyName": "Republican-blue-ten-factor-official",
      "virtualKeyUri": "avoid-education-site-charge-ability"
    }
  }
}

Arguments

Name Description

input (QueryComplexityInputType!)

Query and relevant variables required to calculate the complexity.

Query

query QueryComplexity($input: QueryComplexityInputType!) {
  queryComplexity(input: $input) {
    complexityValue
  }
}

Variables

Response

{
  "data": {
    "queryComplexity": {
      "complexityValue": 70
    }
  }
}

question

Type: String

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the customer feedback survey question.

The possible errors that can be raised are:

  • KT-CT-5513: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

formId (Int!)

Query

query Question($formId: Int!) {
  question(formId: $formId)
}

Variables

{
  "formId": 63229867
}

Response

{
  "data": {
    "question": "claim-bill-mean-choose-particularly"
  }
}

quoteRequest

Type: QuoteRequest

URL: https://api.oefr-kraken.energy/v1/graphql/

Get a quote request for a given code.

The possible errors that can be raised are:

  • KT-CT-4619: Quote with given code not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

code (UUID!)

The quote request code.

Query

query QuoteRequest($quoteCode: String!) {
  quoteRequest(quoteCode: $quoteCode) {
    electricitySupplyPoints {
      ...ElectricitySupplyPointFragment
    }
    gasSupplyPoints {
      ...GasSupplyPointFragment
    }
    createdAt
    termsAndConditions {
      ...TermsAndConditionsFragment
    }
    code
  }
}

Variables

{
  "quoteCode": "write-ball-surface-commercial-board"
}

Response

{
  "data": {
    "quoteRequest": {
      "electricitySupplyPoints": [ElectricitySupplyPoint],
      "gasSupplyPoints": [GasSupplyPoint],
      "createdAt": "2018-09-30T00:01:40.127942+00:00",
      "termsAndConditions": [TermsAndConditions],
      "code": "site-likely-dark-discussion-sense"
    }
  }
}

quotingParamDefinitionsForProductOffering

Type: QuotedOfferingParamsType

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-12403: Product offering not found.
  • KT-CT-12404: Product offering has expired.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

productOfferingIdentifier (ID)

The identifier of the product offering.

Query

query QuotingParamDefinitionsForProductOffering($productOfferingIdentifier: ID) {
  quotingParamDefinitionsForProductOffering(productOfferingIdentifier: $productOfferingIdentifier) {
    offeringIdentifier
    productComponents {
      ...QuotedProductComponentTypeFragment
    }
    offeringComponents {
      ...QuotedOfferingParamsTypeFragment
    }
  }
}

Variables

{
  "productOfferingIdentifier": "49201878"
}

Response

{
  "data": {
    "quotingParamDefinitionsForProductOffering": {
      "offeringIdentifier": "58422966",
      "productComponents": [QuotedProductComponentType],
      "offeringComponents": [QuotedOfferingParamsType]
    }
  }
}

rateLimitInfo

Type: CombinedRateLimitInformation

URL: https://api.oefr-kraken.energy/v1/graphql/

Combined information about points-allowance rate limiting and request-specific rate limiting.

Query

query RateLimitInfo {
  rateLimitInfo {
    pointsAllowanceRateLimit {
      ...PointsAllowanceRateLimitInformationFragment
    }
    fieldSpecificRateLimits {
      ...FieldSpecificRateLimitInformationConnectionTypeConnectionFragment
    }
  }
}

Response

{
  "data": {
    "rateLimitInfo": {
      "pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation,
      "fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection
    }
  }
}

registeredKrakenflexDevice

Type: KrakenFlexDeviceType

URL: https://api.oefr-kraken.energy/v1/graphql/

A device registered with KrakenFlex for a given account.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'registeredKrakenflexDevice' field is deprecated.

Please use 'devices' instead.

- Marked as deprecated on 2024-04-23.
- Scheduled for removal on or after 2025-12-10.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/434/

Arguments

Name Description

accountNumber (String!)

Query

query RegisteredKrakenflexDevice($accountNumber: String!) {
  registeredKrakenflexDevice(accountNumber: $accountNumber) {
    krakenflexDeviceId
    provider
    vehicleMake
    vehicleModel
    vehicleBatterySizeInKwh
    chargePointMake
    chargePointModel
    chargePointPowerInKw
    status
    suspended
    hasToken
    createdAt
    stateOfChargeLimit {
      ...StateOfChargeLimitFragment
    }
    testDispatchFailureReason
  }
}

Variables

{
  "accountNumber": "A-AF684E82"
}

Response

{
  "data": {
    "registeredKrakenflexDevice": {
      "krakenflexDeviceId": "10159975",
      "provider": "BYD",
      "vehicleMake": "finally-yes-build-door-mention",
      "vehicleModel": "involve-believe-discuss-live-quality",
      "vehicleBatterySizeInKwh": "1.0",
      "chargePointMake": "consider-song-set-prevent-poor",
      "chargePointModel": "against-near-bed-region-body",
      "chargePointPowerInKw": "1.0",
      "status": "threat-write-type-message-protect",
      "suspended": true,
      "hasToken": true,
      "createdAt": "2001-01-25T16:22:42.730913+00:00",
      "stateOfChargeLimit": StateOfChargeLimit,
      "testDispatchFailureReason": "NONE"
    }
  }
}

returnSchedule

Type: [DepositReturnScheduleOutput]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get deposit agreement related return schedules for a given account.

Arguments

Name Description

accountNumber (String!)

Query

query ReturnSchedule($accountNumber: String!) {
  returnSchedule(accountNumber: $accountNumber) {
    dueDate
    amount
    status
  }
}

Variables

{
  "accountNumber": "A-8A4E8B93"
}

Response

{
  "data": {
    "returnSchedule": [
      {
        "dueDate": "2007-04-05",
        "amount": 93,
        "status": "expect-economic-bit-for-those"
      }
    ]
  }
}

searchLead

Type: LeadIdType

URL: https://api.oefr-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-8920: Search filters are invalid.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

filters (SearchLeadFilters)

Filters to search for leads. All passed filters will be checked against the lead.

Query

query SearchLead($filters: SearchLeadFilters) {
  searchLead(filters: $filters) {
    leadId
    number
  }
}

Variables

{
  "filters": SearchLeadFilters
}

Response

{
  "data": {
    "searchLead": {
      "leadId": "65396030",
      "number": "front-increase-would-compare-development"
    }
  }
}

Arguments

Name Description

ids ([UUID])

A list of request IDs. If provided, only these requests will be returned.

createdAfter (DateTime)

Only requests created after this datetime will be included.

statuses ([RequestStatus])

Only requests with a status in this list will be included.

before (String)

after (String)

first (Int)

last (Int)

Query

query SiteworksRequests(
  $ids: [UUID],
  $createdAfter: DateTime,
  $statuses: [RequestStatus],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  siteworksRequests(
    ids: $ids,
    createdAfter: $createdAfter,
    statuses: $statuses,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CoreSiteworksRequestConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "ids": ["c658b41c-3c31-4efe-b0ac-a6cd9aaf4c27"],
  "createdAfter": "1985-07-13T20:18:06.451390+00:00",
  "statuses": "APPROVAL_PENDING",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "siteworksRequests": {
      "pageInfo": PageInfo,
      "edges": CoreSiteworksRequestConnectionTypeEdge,
      "totalCount": 38,
      "edgeCount": 77
    }
  }
}

Arguments

Name Description

smartFlexDeviceId (String)

The SmartFlex device ID to get the supply point details for.

Query

query SmartFlexDeviceSupplyPoint($smartFlexDeviceId: String) {
  smartFlexDeviceSupplyPoint(smartFlexDeviceId: $smartFlexDeviceId) {
    importSupplyPointId
    smartFlexDeviceId
  }
}

Variables

{
  "smartFlexDeviceId": "24629221"
}

Response

{
  "data": {
    "smartFlexDeviceSupplyPoint": {
      "importSupplyPointId": "65958650",
      "smartFlexDeviceId": "20127000"
    }
  }
}

smartFlexOnboardingWizards

Type: [SmartFlexOnboardingWizard!]

URL: https://api.oefr-kraken.energy/v1/graphql/

A list of wizards for onboarding devices for an account and property.

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

propertyId (Int)

Only list wizards for this property.

wizardId (ID)

To get a specific wizard by ID, if it exists.

includeCancelled (Boolean)

Include cancelled wizards.

includeCompleted (Boolean)

Include completed wizards.

isResumable (Boolean)

Filters for onboarding wizards that can be resumed. List limits to one resumable wizard.

Query

query SmartFlexOnboardingWizards(
  $accountNumber: String!,
  $propertyId: Int,
  $wizardId: ID,
  $includeCancelled: Boolean,
  $includeCompleted: Boolean,
  $isResumable: Boolean
) {
  smartFlexOnboardingWizards(
    accountNumber: $accountNumber,
    propertyId: $propertyId,
    wizardId: $wizardId,
    includeCancelled: $includeCancelled,
    includeCompleted: $includeCompleted,
    isResumable: $isResumable
  ) {
    id
    resumable {
      ...SmartFlexResumableFragment
    }
    deviceType
    displayName
    backendScreen
    currentStep {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
    completedSteps {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
  }
}

Variables

{
  "accountNumber": "A-CBA4253E",
  "propertyId": 18792949,
  "wizardId": "90220829",
  "includeCancelled": true,
  "includeCompleted": true,
  "isResumable": true
}

Response

{
  "data": {
    "smartFlexOnboardingWizards": [
      {
        "id": "68683314",
        "resumable": SmartFlexResumable,
        "deviceType": "BATTERIES",
        "displayName": "box-both-movement-take-best",
        "backendScreen": BackendScreenType,
        "currentStep": SmartFlexOnboardingStepInterface,
        "completedSteps": SmartFlexOnboardingStepInterface
      }
    ]
  }
}

Arguments

Name Description

accountNumber (String!)

The account number linked to the supply contracts.

supplyContractNumber (String)

Specific supply contract to display.

supplyPointId (ID)

Filter supply contracts related to this specific supply point.

propertyId (ID)

Filter supply contracts related to this property.

agreementId (ID)

Fetch supply contracts related to this specific agreement.

marketName (FRAMarketName)

Filter supply contracts by market name (FRA_ELECTRICITY or FRA_GAS).

before (String)

after (String)

first (Int)

last (Int)

Query

query SupplyContracts(
  $accountNumber: String!,
  $supplyContractNumber: String,
  $supplyPointId: ID,
  $propertyId: ID,
  $agreementId: ID,
  $marketName: FRAMarketName,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  supplyContracts(
    accountNumber: $accountNumber,
    supplyContractNumber: $supplyContractNumber,
    supplyPointId: $supplyPointId,
    propertyId: $propertyId,
    agreementId: $agreementId,
    marketName: $marketName,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SupplyContractConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-C0EA350A",
  "supplyContractNumber": "will-real-music-piece-shake",
  "supplyPointId": "90595911",
  "propertyId": "78481310",
  "agreementId": "63715329",
  "marketName": "FRA_ELECTRICITY",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "supplyContracts": {
      "pageInfo": PageInfo,
      "edges": SupplyContractConnectionTypeEdge,
      "totalCount": 91,
      "edgeCount": 23
    }
  }
}

supplyPoint

Type: SupplyPointType

URL: https://api.oefr-kraken.energy/v1/graphql/

Get a supply point by its market specific id.

Arguments

Name Description

externalIdentifier (String!)

The market specific supply point id.

marketName (String!)

The name of the market in which this supply point exists.

Query

query SupplyPoint(
  $externalIdentifier: String!,
  $marketName: String!
) {
  supplyPoint(
    externalIdentifier: $externalIdentifier,
    marketName: $marketName
  ) {
    id
    marketName
    externalIdentifier
    readings {
      ...ReadingsFragment
    }
    property {
      ...PropertyTypeFragment
    }
    devices {
      ...DevicesConnectionFragment
    }
    meterPoint
  }
}

Variables

{
  "externalIdentifier": "18088801",
  "marketName": "drop-source-third-decade-institution"
}

Response

{
  "data": {
    "supplyPoint": {
      "id": "64228383",
      "marketName": "future-agency-threat-art-success",
      "externalIdentifier": "39389903",
      "readings": Readings,
      "property": PropertyType,
      "devices": DevicesConnection,
      "meterPoint": MeterPointType
    }
  }
}

Arguments

Name Description

accountNumber (String)

Filter meter points by account.

portfolioNumber (String)

Filter meter points by portfolio.

before (String)

after (String)

first (Int)

last (Int)

Query

query SupplyPoints(
  $accountNumber: String,
  $portfolioNumber: String,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  supplyPoints(
    accountNumber: $accountNumber,
    portfolioNumber: $portfolioNumber,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SupplyPointConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-1ACF1C6D",
  "portfolioNumber": "P-1551A980",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "supplyPoints": {
      "pageInfo": PageInfo,
      "edges": SupplyPointConnectionTypeEdge,
      "totalCount": 96,
      "edgeCount": 19
    }
  }
}

Arguments

Name Description

marketName (String)

The market for which we want to list products.

productCode (String)

Filter products by product code.

before (String)

after (String)

first (Int)

last (Int)

Query

query SupplyProducts(
  $marketName: String,
  $productCode: String,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  supplyProducts(
    marketName: $marketName,
    productCode: $productCode,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ProductConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "marketName": "common-worry-order-out-arm",
  "productCode": "during-hit-all-film-interest",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "supplyProducts": {
      "pageInfo": PageInfo,
      "edges": ProductConnectionTypeEdge,
      "totalCount": 79,
      "edgeCount": 27
    }
  }
}

tariffGrid

Type: TariffGrid

URL: https://api.oefr-kraken.energy/v1/graphql/

Fetch the payment schedule for an agreement.

The possible errors that can be raised are:

  • KT-FR-4910: Unauthorized to access to this agreement.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

ID of the account.

agreementId (Int!)

ID of the agreement.

Query

query TariffGrid(
  $accountNumber: String!,
  $agreementId: Int!
) {
  tariffGrid(
    accountNumber: $accountNumber,
    agreementId: $agreementId
  ) {
    temporaryUrl
  }
}

Variables

{
  "accountNumber": "A-DEF6E48F",
  "agreementId": 65657442
}

Response

{
  "data": {
    "tariffGrid": {
      "temporaryUrl": "dinner-see-show-later-approach"
    }
  }
}

taskResult

Type: TaskResult

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the status of a background task.

The possible errors that can be raised are:

  • KT-CT-10401: Task not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

taskId (String!)

accountNumber (String!)

Query

query TaskResult(
  $taskId: String!,
  $accountNumber: String!
) {
  taskResult(
    taskId: $taskId,
    accountNumber: $accountNumber
  ) {
    status
    result
    error
  }
}

Variables

{
  "taskId": "44194348",
  "accountNumber": "A-A2F2AD5F"
}

Response

{
  "data": {
    "taskResult": {
      "status": "STARTED",
      "result": {"key": "value"},
      "error": "speak-prove-look-attention-order"
    }
  }
}

termsAndConditionsForProduct

Type: [TermsAndConditionsType]

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the active terms and conditions for a market supply product.

Arguments

Name Description

productCode (String!)

The product code of the market supply product.

Query

query TermsAndConditionsForProduct($productCode: String!) {
  termsAndConditionsForProduct(productCode: $productCode) {
    name
    pdfUrl
    brandCode
    markdown
    html
    version
    effectiveFrom
  }
}

Variables

{
  "productCode": "begin-practice-those-knowledge-another"
}

Response

{
  "data": {
    "termsAndConditionsForProduct": {
      "name": "set-road-market-popular-we",
      "pdfUrl": "strategy-soon-parent-account-article",
      "brandCode": "organization-wear-deal-less-race",
      "markdown": "debate-yeah-fall-cell-medical",
      "html": "Congress-peace-treatment-player-gas",
      "version": "since-message-build-take-both",
      "effectiveFrom": "2005-04-21T12:32:56.836458+00:00"
    }
  }
}

thirdPartyViewer

Type: ThirdPartyOrganizationType

URL: https://api.oefr-kraken.energy/v1/graphql/

The currently authenticated third party.

This field requires the Authorization header to be set.

Query

query ThirdPartyViewer {
  thirdPartyViewer {
    name
    permissions {
      ...ThirdPartyPermissionFragment
    }
  }
}

Response

{
  "data": {
    "thirdPartyViewer": {
      "name": "participant-police-yard-last-face",
      "permissions": [ThirdPartyPermission]
    }
  }
}

trigger

Type: Trigger!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the details of a published trigger with a given ID.

The possible errors that can be raised are:

  • KT-CT-9904: Trigger not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

triggerId (ID!)

The ID of the trigger.

Query

query Trigger($triggerId: ID!) {
  trigger(triggerId: $triggerId) {
    id
    triggerTypeCode
    createdAt
    messages {
      ...MessageConnectionFragment
    }
    processingStatus
  }
}

Variables

{
  "triggerId": "78996019"
}

Response

{
  "data": {
    "trigger": {
      "id": "14626403",
      "triggerTypeCode": "image-key-identify-fact-smile",
      "createdAt": "1971-02-20T18:40:16.154563+00:00",
      "messages": MessageConnection,
      "processingStatus": "UNPROCESSED"
    }
  }
}

ufcContractsCount

Type: Int

URL: https://api.oefr-kraken.energy/v1/graphql/

Returns the current number of UFC contracts.

Query

query UfcContractsCount {
  ufcContractsCount
}

Response

{
  "data": {
    "ufcContractsCount": 36
  }
}

userEmailCheckForCheckout

Type: Boolean

URL: https://api.oefr-kraken.energy/v1/graphql/

Check email address before checkout. Return true is the email address is free, false if it's attached to an active user account.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UserEmailCheckForCheckoutInputType!)

Query

query UserEmailCheckForCheckout($input: UserEmailCheckForCheckoutInputType!) {
  userEmailCheckForCheckout(input: $input)
}

Variables

Response

{
  "data": {
    "userEmailCheckForCheckout": true
  }
}

userVehicles

Type: [UserVehiclesType]

URL: https://api.oefr-kraken.energy/v1/graphql/

A list of vehicles available to the user.

Note: If the API returns an empty list, there might be a delay between the vehicle being registered in the provider's system, and data being fetched from the vehicle's manufacturer. In such cases, the query should be retried after a few seconds.

Deprecated

The 'userVehicles' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-10-30.
- Scheduled for removal on or after 2026-04-30.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/608/

Arguments

Name Description

accountNumber (String)

supportedProvider (ProviderChoices)

The provider used to authenticate the device (default Enode).

authentication (AuthenticationInput)

The authentication details required given the chosen provider.

Query

query UserVehicles(
  $accountNumber: String,
  $supportedProvider: ProviderChoices,
  $authentication: AuthenticationInput
) {
  userVehicles(
    accountNumber: $accountNumber,
    supportedProvider: $supportedProvider,
    authentication: $authentication
  ) {
    vehicleId
    information {
      ...VehicleInformationTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-C0EFF145",
  "supportedProvider": "BYD",
  "authentication": AuthenticationInput
}

Response

{
  "data": {
    "userVehicles": [
      {
        "vehicleId": "52383559",
        "information": VehicleInformationType
      }
    ]
  }
}

Arguments

Name Description

value (String!)

Referral claim code value.

Query

query ValidateReferralCode($value: String!) {
  validateReferralCode(value: $value) {
    id
    value
    referralScheme {
      ...ReferralSchemeTypeFragment
    }
    accountReferral {
      ...ReferralTypeFragment
    }
    isValid
    createdAt
  }
}

Variables

{
  "value": "your-church-hard-hope-responsibility"
}

Response

{
  "data": {
    "validateReferralCode": {
      "id": 66993890,
      "value": "often-sound-according-degree-recognize",
      "referralScheme": ReferralSchemeType,
      "accountReferral": ReferralType,
      "isValid": true,
      "createdAt": "2016-10-27T19:06:36.694384+00:00"
    }
  }
}

vehicleChargingPreferences

Type: VehicleChargingPreferencesType

URL: https://api.oefr-kraken.energy/v1/graphql/

Vehicle charging preference details.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4339: Your device charging preferences could not be fetched.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'vehicleChargingPreferences' field is deprecated.

Please use 'devices.preferences' instead.

- Marked as deprecated on 2024-04-23.
- Scheduled for removal on or after 2025-12-10.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/435/

Arguments

Name Description

accountNumber (String!)

Query

query VehicleChargingPreferences($accountNumber: String!) {
  vehicleChargingPreferences(accountNumber: $accountNumber) {
    weekdayTargetTime
    weekdayTargetSoc
    weekendTargetTime
    weekendTargetSoc
    minimumSocPercentage
    maximumSocPercentage
  }
}

Variables

{
  "accountNumber": "A-74022415"
}

Response

{
  "data": {
    "vehicleChargingPreferences": {
      "weekdayTargetTime": "glass-join-medical-night-first",
      "weekdayTargetSoc": 5,
      "weekendTargetTime": "style-certain-rock-democratic-its",
      "weekendTargetSoc": 18,
      "minimumSocPercentage": 44,
      "maximumSocPercentage": 9
    }
  }
}

verificationStatus

Type: EmailVerificationStatus

URL: https://api.oefr-kraken.energy/v1/graphql/

Check the verification status of a given email address.

Arguments

Name Description

email (String!)

The email address to be checked.

Query

query VerificationStatus($email: String!) {
  verificationStatus(email: $email) {
    email
    status
  }
}

Variables

{
  "email": "represent-themselves-center-theory-throw"
}

Response

{
  "data": {
    "verificationStatus": {
      "email": "month-heavy-provide-sister-need",
      "status": "NOT_SENT"
    }
  }
}

viewer

Type: AccountUserType

URL: https://api.oefr-kraken.energy/v1/graphql/

The currently authenticated user.

This field requires the Authorization header to be set.

Query

query Viewer {
  viewer {
    id
    number
    accounts {
      ...AccountInterfaceFragment
    }
    givenName
    familyName
    email
    mobile
    landline
    title
    pronouns
    isDeceased
    liveSecretKey
    createdAt
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    dateOfBirth
    label
    isActive
    details {
      ...AccountUserDetailTypeFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    displayName
    firstName
    lastName
    fullName
    preferredName
    portfolioId
    portfolioIds
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    landlinePhoneNumber
    alternativePhoneNumbers
    hasFamilyIssues
    isInHardship
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    holdMusicChoices {
      ...TrackOptionTypeFragment
    }
    isOptedInToWof
  }
}

Response

{
  "data": {
    "viewer": {
      "id": "32225032",
      "number": "office-author-less-interesting-imagine",
      "accounts": AccountInterface,
      "givenName": "James",
      "familyName": "Lewis",
      "email": "politics-traditional-event-only-us",
      "mobile": "service-wrong-stop-care-cell",
      "landline": "listen-then-something-often-Congress",
      "title": "movement-book-continue-stay-approach",
      "pronouns": "watch-alone-or-certainly-who",
      "isDeceased": true,
      "liveSecretKey": "southern-difficult-their-song-common",
      "createdAt": "2002-09-09T23:15:40.198511+00:00",
      "portfolios": PortfolioConnectionTypeConnection,
      "address": RichAddressType,
      "dateOfBirth": "1979-05-25",
      "label": "probably-medical-level-alone-apply",
      "isActive": true,
      "details": [AccountUserDetailType],
      "permissions": [AccountUserPermission],
      "displayName": "fast-move-federal-note-radio",
      "firstName": "boy-close-forward-guy-meet",
      "lastName": "a-past-heavy-late-remember",
      "fullName": "break-concern-growth-bar-bill",
      "preferredName": "clear-big-pick-forward-open",
      "portfolioId": "88671745",
      "portfolioIds": ["17942463"],
      "businesses": BusinessConnectionTypeConnection,
      "specialCircumstances": SpecialCircumstancesType,
      "preferences": AccountUserCommsPreferences,
      "landlinePhoneNumber": "no-able-sound-participant-physical",
      "alternativePhoneNumbers": ["next-pay-both-son-station"],
      "hasFamilyIssues": true,
      "isInHardship": true,
      "accountUserRoles": [AccountUserRoleType],
      "portfolioUserRoles": [PortfolioUserRoleType],
      "consents": ConsentType,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "holdMusicChoices": [TrackOptionType],
      "isOptedInToWof": true
    }
  }
}

voiceCampaign

Type: VoiceCampaignType!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the voice campaign for a given ID.

The possible errors that can be raised are:

  • KT-CT-11501: Voice campaign not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

campaignId (String!)

The campaign ID.

Query

query VoiceCampaign($campaignId: String!) {
  voiceCampaign(campaignId: $campaignId) {
    id
    name
    description
    customOutboundPhoneNumber
    tags {
      ...CallTagConnectionTypeConnectionFragment
    }
    status
    campaignType
    campaignItems {
      ...VoiceCampaignItemConnectionTypeConnectionFragment
    }
    preventDuplicateRecords
  }
}

Variables

{
  "campaignId": "19631957"
}

Response

{
  "data": {
    "voiceCampaign": {
      "id": "76810654",
      "name": "degree-wrong-girl-many-cost",
      "description": "understand-trial-bar-still-rather",
      "customOutboundPhoneNumber": "heart-area-your-here-chance",
      "tags": CallTagConnectionTypeConnection,
      "status": "ACTIVE",
      "campaignType": "PREVIEW",
      "campaignItems": VoiceCampaignItemConnectionTypeConnection,
      "preventDuplicateRecords": true
    }
  }
}

Arguments

Name Description

status (CampaignStatus)

Filter by campaign status.

campaignType (TypeOfVoiceCampaign)

Filter by campaign type.

name (String)

Filter by campaign name.

before (String)

after (String)

first (Int)

last (Int)

Query

query VoiceCampaigns(
  $status: CampaignStatus,
  $campaignType: TypeOfVoiceCampaign,
  $name: String,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  voiceCampaigns(
    status: $status,
    campaignType: $campaignType,
    name: $name,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...VoiceCampaignConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "status": "ACTIVE",
  "campaignType": "PREVIEW",
  "name": "pretty-seven-reveal-cause-what",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "voiceCampaigns": {
      "pageInfo": PageInfo,
      "edges": VoiceCampaignConnectionTypeEdge,
      "totalCount": 39,
      "edgeCount": 84
    }
  }
}

vouchersBalanceDetail

Type: VouchersBalanceDetail

URL: https://api.oefr-kraken.energy/v1/graphql/

Query the detail of vouchers balance for an account.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4178: No account found with given account number.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (ID!)

The account number.

Query

query VouchersBalanceDetail($accountNumber: ID!) {
  vouchersBalanceDetail(accountNumber: $accountNumber) {
    redeemableToday
    redeemableInFuture
  }
}

Variables

{
  "accountNumber": "A-D50063F1"
}

Response

{
  "data": {
    "vouchersBalanceDetail": {
      "redeemableToday": 33,
      "redeemableInFuture": 48
    }
  }
}

Arguments

Name Description

accountNumber (ID!)

The account number.

redeemableOnly (Boolean!)

Whether to only return vouchers that can be redeemable.

purchasedFromDate (Date)

An optional date to limit the response to vouchers that have been purchased from the particular date (inclusive) onwards.

purchasedBeforeDate (Date)

An optional date to limit the response to vouchers that have been purchased before the particular date (exclusive).

availableFromDate (Date)

An optional date to limit the response to vouchers that are available from the particular date (inclusive) onwards.

availableBeforeDate (Date)

An optional date to limit the response to vouchers that are available before the particular date (exclusive).

before (String)

after (String)

first (Int)

last (Int)

Query

query VouchersForAccount(
  $accountNumber: ID!,
  $redeemableOnly: Boolean!,
  $purchasedFromDate: Date,
  $purchasedBeforeDate: Date,
  $availableFromDate: Date,
  $availableBeforeDate: Date,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  vouchersForAccount(
    accountNumber: $accountNumber,
    redeemableOnly: $redeemableOnly,
    purchasedFromDate: $purchasedFromDate,
    purchasedBeforeDate: $purchasedBeforeDate,
    availableFromDate: $availableFromDate,
    availableBeforeDate: $availableBeforeDate,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...VoucherPurchaseConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "A-4BC9F668",
  "redeemableOnly": true,
  "purchasedFromDate": "1990-11-21",
  "purchasedBeforeDate": "2023-01-28",
  "availableFromDate": "1972-08-09",
  "availableBeforeDate": "2000-07-30",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "vouchersForAccount": {
      "pageInfo": PageInfo,
      "edges": VoucherPurchaseConnectionTypeEdge,
      "totalCount": 34,
      "edgeCount": 35
    }
  }
}

workSchedule

Type: WorkScheduleType!

URL: https://api.oefr-kraken.energy/v1/graphql/

Get the work schedule with the given identifier.

The possible errors that can be raised are:

  • KT-CT-11804: Work schedule not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

identifier (String!)

The identifier of the work schedule (also known as the 'slug').

Query

query WorkSchedule($identifier: String!) {
  workSchedule(identifier: $identifier) {
    identifier
    name
    isOpen
    isPublicHoliday
    openOrClosedReason
  }
}

Variables

{
  "identifier": "54695971"
}

Response

{
  "data": {
    "workSchedule": {
      "identifier": "97300835",
      "name": "wife-clearly-song-set-five",
      "isOpen": true,
      "isPublicHoliday": true,
      "openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
    }
  }
}

Authentication Server

authorizedApplications

Type: [AuthorizedApplication]

URL: https://auth.oefr-kraken.energy/graphql/

Get all the confidential-client applications the current user has authorized.

Deprecated

The 'authorizedApplications' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Query

query AuthorizedApplications {
  authorizedApplications {
    name
    clientId
  }
}

Response

{
  "data": {
    "authorizedApplications": [
      {
        "name": "director-shoulder-lay-offer-remember",
        "clientId": "59076399"
      }
    ]
  }
}

Query

query KrakenVersion {
  krakenVersion {
    number
    SHA
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "number": "life-rate-wife-east-yourself",
      "SHA": "church-again-million-language-rather"
    }
  }
}

mfaDevices

Type: [MfaDevice]

URL: https://auth.oefr-kraken.energy/graphql/

Get all MFA devices for the current user.

Deprecated

The 'mfaDevices' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Query

query MfaDevices {
  mfaDevices {
    deviceType
    isConfirmed
  }
}

Response

{
  "data": {
    "mfaDevices": [
      {
        "deviceType": "time-scientist-customer-article-drive",
        "isConfirmed": true
      }
    ]
  }
}