Mutations

In this section

About Mutations
API Site
acceptGoodsQuote
acceptQuote
addCampaignToAccount
amendPayment
backendScreenEvent
cancelLeaveSupplier
cancelRepaymentRequest
cancelSmartFlexOnboarding
checkMeterPointsEligibility
checkoutQuote
collectPayment
completeAuthFlowForSmartFlexOnboarding
completeTeslaSetupVirtualKeyForSmartFlexOnboarding
createAccountPaymentSchedule
createAccountReference
createContributionAgreement
createCreditTransferPermission
createFormSubmission
createGoodsPurchase
createGoodsQuote
createGoodsQuoteWithoutAccount
createReferral
createSourceFundRequest
deauthenticateDevice
deleteBoostCharge
deletePushNotificationBinding
deviceRegistration
endContributionAgreement
forceReauthentication
getEmbeddedSecretForNewPaymentInstruction
getEmbeddedSecretForNewPaymentInstructionWithoutAccount
getHostedUrlForNewPaymentInstruction
initiateHostedStandalonePayment
initiateProductSwitch
initiateStandalonePayment
instigateLeaveSupplier
invalidatePaymentInstruction
invalidatePreSignedToken
joinSupplierAcceptTermsAndConditions
linkUserToLine
masqueradeAuthentication
obtainKrakenToken
ocppAuthentication
reauthenticateDevice
redeemLoyaltyPointsForAccountCredit
redeemReferralClaimCode
regenerateSecretKey
registerPushNotificationBinding
requestPasswordReset
requestPrintedBill
requestQuote
resetPassword
resetUserPassword
resumeControl
runMeterPointPmaxAnalysis
scheduleQuoteFollowUp
selectChargePointMakeForSmartFlexOnboarding
selectChargePointVariantForSmartFlexOnboarding
selectDeviceTypeForSmartFlexOnboarding
selectUserVehicleForSmartFlexOnboarding
selectVehicleMakeForSmartFlexOnboarding
selectVehicleVariantForSmartFlexOnboarding
selfReading
sendPmaxEmailSummary
setActivationProcessSwitchReadings
setDevicePreferences
setLoyaltyPointsUser
setUpDirectDebitInstruction
setVehicleChargePreferences
shareGoodsQuote
startSmartFlexOnboarding
startTestChargeForSmartFlexOnboarding
storePaymentInstruction
submitCustomerFeedback
submitRepaymentRequest
suspendControl
switchProduct
terminateCreditTransferPermission
transferLoyaltyPointsBetweenUsers
triggerBoostCharge
triggerTestCharge
unlinkUserFromLine
updateAccountBillingAddress
updateAccountBillingEmail
updateAccountConsents
updateAccountReference
updateAccountUserConsents
updateActivePurchase
updateAutoTopUpAmount
updateCommsDeliveryPreference
updateCommsPreferences
updateDeviceSmartControl
updateIndustryConsentData
updateMetadata
updatePassword
updateUser
updateUserDetails
verifyIdentity
Authentication Server
createMfaDevice
deleteMfaDevice
validateMfaDevice

Every GraphQL schema has a root type for both queries and mutations. The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

API Site

acceptGoodsQuote

Type:AcceptGoodsQuote

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

Accept a goods quote.

The possible errors that can be raised are:

KT-CT-8223: Unauthorized.
KT-CT-8201: Received an invalid quoteId.
KT-CT-8224: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AcceptGoodsQuoteInput!`)	Input fields for accepting a quote.

input (AcceptGoodsQuoteInput!)

Input fields for accepting a quote.

Return fields

Name	Description

mutation AcceptGoodsQuote($input: AcceptGoodsQuoteInput!) {
  acceptGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": AcceptGoodsQuoteInput
}

{
  "data": {
    "acceptGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

acceptQuote

Type:AcceptQuote

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

Accepts a quote.

The possible errors that can be raised are:

KT-CT-1132: Unauthorized.
KT-CT-3811: Invalid IBAN.
KT-FR-3814: Invalid payment day.
KT-CT-4121: Invalid phone number.
KT-CT-4122: Invalid email.
KT-CT-4137: Invalid Title.
KT-CT-4321: Serializer validation error.
KT-CT-4321: Serializer validation error.
KT-CT-4410: Invalid postcode.
KT-CT-5412: No account user exists with the given id.
KT-CT-6710: Unable to create referral.
KT-FR-4110: Age incorrect.
KT-FR-4113: Invalid name.
KT-FR-4114: Account not found.
KT-FR-4611: T&C not accepted or not acceptable.
KT-FR-4612: Unable to create agreement.
KT-FR-4616: Supply start date invalid.
KT-FR-4617: Incompatible subscription type.
KT-FR-4618: The quote request has already been accepted.
KT-FR-4622: Unexpected error while accepting a quote.
KT-FR-4623: Withdrawal period is mandatory for this sale.
KT-FR-4712: Invalid meter readings data.
KT-FR-4713: Invalid data. Reading date cannot be in the future.
KT-FR-7712: Invalid affiliate session.
KT-FR-7713: Authenticated organizations should not use affiliate sessions.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`AcceptQuoteInputType!`)	Input fields for accepting a quote on supply points.

input (AcceptQuoteInputType!)

Input fields for accepting a quote on supply points.

Return fields

Name	Description

mutation AcceptQuote($input: AcceptQuoteInputType!) {
  acceptQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountNumber
    supplyContracts {
      ...SupplyContractConnectionTypeConnectionFragment
    }
    preSignedKey
  }
}

{
  "input": AcceptQuoteInputType
}

{
  "data": {
    "acceptQuote": {
      "possibleErrors": [PossibleErrorType],
      "accountNumber": "abc123",
      "supplyContracts": SupplyContractConnectionTypeConnection,
      "preSignedKey": "abc123"
    }
  }
}

addCampaignToAccount

Type:AddCampaignToAccount

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

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddCampaignToAccountInput!`)	Input variables needed for adding a campaign to an account.

input (AddCampaignToAccountInput!)

Input variables needed for adding a campaign to an account.

Return fields

Name	Description

mutation AddCampaignToAccount($input: AddCampaignToAccountInput!) {
  addCampaignToAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignAdded
  }
}

{
  "input": AddCampaignToAccountInput
}

{
  "data": {
    "addCampaignToAccount": {
      "possibleErrors": [PossibleErrorType],
      "campaignAdded": true
    }
  }
}

amendPayment

Type:AmendPayment

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

Amend an existing payment.

The possible errors that can be raised are:

KT-CT-3924: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AmendPaymentInput!`)	Input fields for amending an existing payment.

input (AmendPaymentInput!)

Input fields for amending an existing payment.

Return fields

Name	Description

mutation AmendPayment($input: AmendPaymentInput!) {
  amendPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": AmendPaymentInput
}

{
  "data": {
    "amendPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

backendScreenEvent

Type:BackendScreenEvent

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

Look up an event to perform from its event_id, and return the next action to perform.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-8002: No event found.
KT-CT-8003: Event has no execute function.
KT-CT-8004: Error executing event in the backend.
KT-CT-8007: Incorrect or missing parameters for backend screen event.
KT-GB-9310: Account ineligible for joining Octoplus.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`BackendScreenEventInput!`)	Input fields for performing a backend action.

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

Name	Description

mutation BackendScreenEvent($input: BackendScreenEventInput!) {
  backendScreenEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    action {
      ... on DeeplinkActionType {
        ...DeeplinkActionTypeFragment
      }
      ... on LinkActionType {
        ...LinkActionTypeFragment
      }
      ... on BackendScreenEventActionType {
        ...BackendScreenEventActionTypeFragment
      }
      ... on CloseActionType {
        ...CloseActionTypeFragment
      }
      ... on ScreenActionType {
        ...ScreenActionTypeFragment
      }
    }
  }
}

{
  "input": BackendScreenEventInput
}

{
  "data": {
    "backendScreenEvent": {
      "possibleErrors": [PossibleErrorType],
      "action": DeeplinkActionType
    }
  }
}

cancelLeaveSupplier

Type:LeaveSupplierCancelled!

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

Cancel a leave supplier process.

The possible errors that can be raised are:

KT-CT-10304: Mutation not enabled in this environment.
KT-CT-10302: Invalid data.
KT-CT-10305: Failed to cancel leave supplier process - market actions are no longer cancellable.
KT-CT-10306: Failed to cancel leave supplier process - the cancellation workflow has not been configured.
KT-CT-10307: Failed to cancel leave supplier process - failed to cancel market actions.
KT-CT-10308: Failed to cancel leave supplier process.
KT-CT-10311: Failed to cancel leave supplier process. The process status is not in cancellable status.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CancelLeaveSupplierInput!`)

input (CancelLeaveSupplierInput!)

Return fields

Name	Description

mutation CancelLeaveSupplier($input: CancelLeaveSupplierInput!) {
  cancelLeaveSupplier(input: $input) {
    message
  }
}

{
  "input": CancelLeaveSupplierInput
}

{
  "data": {
    "cancelLeaveSupplier": {
      "message": "abc123"
    }
  }
}

cancelRepaymentRequest

Type:CancelRepaymentRequest

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

Cancel a repayment or refund request.

The possible errors that can be raised are:

KT-CT-4231: Unauthorized.
KT-CT-3930: The repayment or refund request does not exist.
KT-CT-3931: This repayment or refund request cannot be cancelled.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`CancelRepaymentRequestInputType!`)	Input fields for cancelling a repayment request.

input (CancelRepaymentRequestInputType!)

Input fields for cancelling a repayment request.

Return fields

Name	Description

mutation CancelRepaymentRequest($input: CancelRepaymentRequestInputType!) {
  cancelRepaymentRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentRequest {
      ...CancelRepaymentRequestOutputTypeFragment
    }
  }
}

{
  "input": CancelRepaymentRequestInputType
}

{
  "data": {
    "cancelRepaymentRequest": {
      "possibleErrors": [PossibleErrorType],
      "repaymentRequest": CancelRepaymentRequestOutputType
    }
  }
}

cancelSmartFlexOnboarding

Type:CancelSmartFlexOnboarding

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

Cancel onboarding of a device with SmartFlex.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CancelSmartFlexOnboardingInput!`)

input (CancelSmartFlexOnboardingInput!)

Return fields

Name	Description

mutation CancelSmartFlexOnboarding($input: CancelSmartFlexOnboardingInput!) {
  cancelSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CancelSmartFlexOnboardingInput
}

{
  "data": {
    "cancelSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

checkMeterPointsEligibility

Type:CheckMeterPointsEligibility

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

Check whether meter points are eligible to be supplied by us.

The possible errors that can be raised are:

KT-FR-4521: Unable to send request without customer's consent to send data to the DSO.
KT-FR-4522: Invalid Electricity Meter Point.
KT-FR-4520: Invalid Gas Meter Point.
KT-FR-4523: Invalid market name.
KT-FR-4527: Supply point from the same property contain different addresses.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`CheckMeterPointsEligibilityInputType!`)	Input fields for for checking the eligibility of meter points.

input (CheckMeterPointsEligibilityInputType!)

Input fields for for checking the eligibility of meter points.

Return fields

Name	Description

mutation CheckMeterPointsEligibility($input: CheckMeterPointsEligibilityInputType!) {
  checkMeterPointsEligibility(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    eligibilityResults {
      ...SupplyPointEligibilityResultConnectionTypeConnectionFragment
    }
  }
}

{
  "input": CheckMeterPointsEligibilityInputType
}

{
  "data": {
    "checkMeterPointsEligibility": {
      "possibleErrors": [PossibleErrorType],
      "eligibilityResults": SupplyPointEligibilityResultConnectionTypeConnection
    }
  }
}

checkoutQuote

Type:CheckoutQuote

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

Checkout a quote.

The possible errors that can be raised are:

KT-FR-3910: Unable to create payment instruction.
KT-FR-4628: Either consentData or consentDataPerSupplyPointId is required for check-out.
KT-FR-6912: The activation process provided does not exists.
KT-FR-6913: The activation process is not in a checkoutable status.
KT-FR-6914: The activation process does not belong to the logged user account.
KT-FR-6915: Some supply points are missing industry consents for activation.
KT-FR-6917: Invalid data.
KT-FR-6918: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CheckoutQuoteInputType!`)	Input fields for checkout a quote already accepted.

input (CheckoutQuoteInputType!)

Input fields for checkout a quote already accepted.

Return fields

Name	Description

mutation CheckoutQuote($input: CheckoutQuoteInputType!) {
  checkoutQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    firstPaymentDate
    firstPaymentAmount
    agreements {
      ...AgreementConnectionTypeConnectionFragment
    }
    userId
    token
    accountNumber
  }
}

{
  "input": CheckoutQuoteInputType
}

{
  "data": {
    "checkoutQuote": {
      "possibleErrors": [PossibleErrorType],
      "firstPaymentDate": "2020-01-01",
      "firstPaymentAmount": 1,
      "agreements": AgreementConnectionTypeConnection,
      "userId": "abc123",
      "token": "abc123",
      "accountNumber": "abc123"
    }
  }
}

collectPayment

Type:CollectPayment

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

Attempt to collect a one-off payment. If an instruction type is provided and there is an existing payment instruction, the payment can be collected immediately. A request to collect a payment at a future date can also be made, in which case the instruction input type is not necessary, but an instruction must exist at the specified collection date for the payment to be collected successfully.

The possible errors that can be raised are:

KT-CT-3932: Invalid data.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CollectPaymentInput!`)	Input fields for collecting a payment.

input (CollectPaymentInput!)

Input fields for collecting a payment.

Return fields

Name	Description

mutation CollectPayment($input: CollectPaymentInput!) {
  collectPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": CollectPaymentInput
}

{
  "data": {
    "collectPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

completeAuthFlowForSmartFlexOnboarding

Type:CompleteAuthFlowForSmartFlexOnboarding

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

Complete the authentication flow to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CompleteAuthFlowInput!`)

input (CompleteAuthFlowInput!)

Return fields

Name	Description

mutation CompleteAuthFlowForSmartFlexOnboarding($input: CompleteAuthFlowInput!) {
  completeAuthFlowForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteAuthFlowInput
}

{
  "data": {
    "completeAuthFlowForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeTeslaSetupVirtualKeyForSmartFlexOnboarding

Type:CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding

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

Complete the Tesla virtual key setup onboarding step.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CompleteSmartFlexOnboardingStepInput!`)

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

Name	Description

mutation CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  completeTeslaSetupVirtualKeyForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "completeTeslaSetupVirtualKeyForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

createAccountPaymentSchedule

Type:CreateAccountPaymentSchedule

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

Replace an existing payment schedule with a new one that updates either the payment amount or payment day.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3815: No active payment schedule found for this account.
KT-CT-3822: Unauthorized.
KT-CT-3923: Unauthorized.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3947: An unexpected error occurred.
KT-CT-3960: Invalid value for payment day.
KT-CT-3961: Cannot update plan-associated payment schedule.
KT-CT-3962: No new value provided to update payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateAccountPaymentScheduleInput!`)	Input fields for updating a payment schedule.

input (CreateAccountPaymentScheduleInput!)

Input fields for updating a payment schedule.

Return fields

Name	Description

mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
  createAccountPaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": CreateAccountPaymentScheduleInput
}

{
  "data": {
    "createAccountPaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

createAccountReference

Type:CreateAccountReference

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

Create an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8311: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AccountReferenceInput!`)	Input fields for creating an account reference.

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

Name	Description

mutation CreateAccountReference($input: AccountReferenceInput!) {
  createAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

{
  "input": AccountReferenceInput
}

{
  "data": {
    "createAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": AccountReferenceType
    }
  }
}

createContributionAgreement

Type:CreateContributionAgreement

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

Create a contribution agreement for an account.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-9601: Invalid data.
KT-CT-9602: Unable to create contribution agreement.
KT-CT-9605: Contribution amount cannot be 0 or negative.
KT-CT-9606: Scheme is not accepting contributions at this time.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateContributionAgreementInput!`)	Input variables needed for creating a contribution agreement on an account.

input (CreateContributionAgreementInput!)

Input variables needed for creating a contribution agreement on an account.

Return fields

Name	Description

mutation CreateContributionAgreement($input: CreateContributionAgreementInput!) {
  createContributionAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    contributionAgreement {
      ...ContributionAgreementTypeFragment
    }
  }
}

{
  "input": CreateContributionAgreementInput
}

{
  "data": {
    "createContributionAgreement": {
      "possibleErrors": [PossibleErrorType],
      "contributionAgreement": ContributionAgreementType
    }
  }
}

createCreditTransferPermission

Type:CreateCreditTransferPermission

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

Create a credit transfer permission.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3827: The ledger is not valid.
KT-CT-3828: At least one of the provided ledgers must be a credit storage ledger.
KT-CT-3829: The credit transfer permission already exists.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateCreditTransferPermissionInput!`)	Input fields to create a credit transfer permission.

input (CreateCreditTransferPermissionInput!)

Input fields to create a credit transfer permission.

Return fields

Name	Description

mutation CreateCreditTransferPermission($input: CreateCreditTransferPermissionInput!) {
  createCreditTransferPermission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    validFrom
  }
}

{
  "input": CreateCreditTransferPermissionInput
}

{
  "data": {
    "createCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validFrom": "2020-01-01T00:00:00.000Z"
    }
  }
}

createFormSubmission

Type:FormSubmissionOuput

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

Create a "form submission" entity. This is only meant to be used as a quick way of putting together a form and submit data for it, in the form of JSON - it is not expected that all form submissions will come through this path.

This field requires the Authorization header to be set.

Arguments

Name Description

Name	Description
`input` (`FormSubmissionInput!`)

input (FormSubmissionInput!)

Return fields

Name	Description

mutation CreateFormSubmission($input: FormSubmissionInput!) {
  createFormSubmission(input: $input) {
    id
    content
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
  }
}

{
  "input": FormSubmissionInput
}

{
  "data": {
    "createFormSubmission": {
      "id": 1,
      "content": {"key": "value"},
      "errors": [SerializerFieldErrorsType]
    }
  }
}

createGoodsPurchase

Type:CreateGoodsPurchase

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

Create a goods purchase.

The possible errors that can be raised are:

KT-CT-8206: Invalid data.
KT-CT-1131: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreatePurchaseInput!`)	Input fields for creating a purchase without a quote.

input (CreatePurchaseInput!)

Input fields for creating a purchase without a quote.

Return fields

Name	Description

mutation CreateGoodsPurchase($input: CreatePurchaseInput!) {
  createGoodsPurchase(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": CreatePurchaseInput
}

{
  "data": {
    "createGoodsPurchase": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

createGoodsQuote

Type:CreateGoodsQuote

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

Create a goods quote.

The possible errors that can be raised are:

KT-CT-8202: Invalid data.
KT-CT-8205: Unable to create quote.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateGoodsQuoteInput!`)	Input fields for creating a goods quote.

input (CreateGoodsQuoteInput!)

Input fields for creating a goods quote.

Return fields

Name	Description

mutation CreateGoodsQuote($input: CreateGoodsQuoteInput!) {
  createGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsQuote {
      ...GoodsQuoteFragment
    }
  }
}

{
  "input": CreateGoodsQuoteInput
}

{
  "data": {
    "createGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "goodsQuote": GoodsQuote
    }
  }
}

createGoodsQuoteWithoutAccount

Type:CreateGoodsQuoteWithoutAccount

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

Create a goods quote without an account.

The possible errors that can be raised are:

KT-CT-8202: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateGoodsQuoteWithoutAccountInput!`)	Input fields for creating a goods quote without an existing account.

input (CreateGoodsQuoteWithoutAccountInput!)

Input fields for creating a goods quote without an existing account.

Return fields

Name	Description

mutation CreateGoodsQuoteWithoutAccount($input: CreateGoodsQuoteWithoutAccountInput!) {
  createGoodsQuoteWithoutAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsQuote {
      ...GoodsQuoteFragment
    }
  }
}

{
  "input": CreateGoodsQuoteWithoutAccountInput
}

{
  "data": {
    "createGoodsQuoteWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "goodsQuote": GoodsQuote
    }
  }
}

createReferral

Type:CreateReferral

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

Create a referral using an email address, personal link or code.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6710: Unable to create referral.
KT-CT-6711: Accounts may not self-refer.
KT-CT-6713: Referring and referred account brands do not match.
KT-CT-6712: Invalid reference.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateReferralInput!`)	Input fields for creating a referral.

input (CreateReferralInput!)

Input fields for creating a referral.

Return fields

Name	Description

mutation CreateReferral($input: CreateReferralInput!) {
  createReferral(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    referredAccountRewardAmount
  }
}

{
  "input": CreateReferralInput
}

{
  "data": {
    "createReferral": {
      "possibleErrors": [PossibleErrorType],
      "referredAccountRewardAmount": 1
    }
  }
}

createSourceFundRequest

Type:CreateSourceFundRequest

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

Create a source fund request for a given agreement.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3823: Unauthorized.
KT-FR-3913: The source fund request hasn't been allowed.
KT-FR-3911: There was a problem while creating the source fund request.
KT-FR-3912: Invalid input provided for source fund request creation.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`CreateSourceFundRequestInput!`)	Input fields for creating a source fund request for a given agreement.

input (CreateSourceFundRequestInput!)

Input fields for creating a source fund request for a given agreement.

Return fields

Name	Description

mutation CreateSourceFundRequest($input: CreateSourceFundRequestInput!) {
  createSourceFundRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    sourceFundRequest {
      ...SourceFundRequestFragment
    }
  }
}

{
  "input": CreateSourceFundRequestInput
}

{
  "data": {
    "createSourceFundRequest": {
      "possibleErrors": [PossibleErrorType],
      "sourceFundRequest": SourceFundRequest
    }
  }
}

deauthenticateDevice

Type:DeauthenticateDevice

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

De-authenticate a device.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4350: Unable to de-authenticate device.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`DeAuthenticationInput`)

input (DeAuthenticationInput)

Return fields

Name	Description

mutation DeauthenticateDevice($input: DeAuthenticationInput) {
  deauthenticateDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...DeviceDetailsTypeFragment
    }
  }
}

{
  "input": DeAuthenticationInput
}

{
  "data": {
    "deauthenticateDevice": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": DeviceDetailsType
    }
  }
}

deleteBoostCharge

Type:DeleteBoostCharge

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

Stop any active boost charging.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4354: Unable to cancel boost charge.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`DeleteBoostChargeInput`)

input (DeleteBoostChargeInput)

Return fields

Name	Description

mutation DeleteBoostCharge($input: DeleteBoostChargeInput) {
  deleteBoostCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": DeleteBoostChargeInput
}

{
  "data": {
    "deleteBoostCharge": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

deletePushNotificationBinding

Type:DeletePushNotificationBinding

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

Delete a device token used for push notifications.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-5411: Invalid token or no push notification binding found for the given account user.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DeletePushNotificationBindingInput!)

Input fields for deleting a push notification binding.

Return fields

Name	Description

mutation DeletePushNotificationBinding($input: DeletePushNotificationBindingInput!) {
  deletePushNotificationBinding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    status
  }
}

{
  "input": DeletePushNotificationBindingInput
}

{
  "data": {
    "deletePushNotificationBinding": {
      "possibleErrors": [PossibleErrorType],
      "status": "SUCCESSFUL"
    }
  }
}

deviceRegistration

Type:DeviceRegistration

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

The possible errors that can be raised are:

KT-CT-4324: Device already registered error.
KT-CT-4321: Serializer validation error.
KT-CT-4312: Unable to register device.
KT-CT-4363: No capable devices found.
KT-CT-4364: Multiple devices found.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DeviceRegistrationInput)

Return fields

Name	Description

mutation DeviceRegistration($input: DeviceRegistrationInput) {
  deviceRegistration(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    registeredDeviceIds
  }
}

{
  "input": DeviceRegistrationInput
}

{
  "data": {
    "deviceRegistration": {
      "possibleErrors": [PossibleErrorType],
      "registeredDeviceIds": ["abc123"]
    }
  }
}

endContributionAgreement

Type:EndContributionAgreement

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

End a contribution agreement for an account.

The possible errors that can be raised are:

KT-CT-9603: Unable to find contribution agreement.
KT-CT-4123: Unauthorized.
KT-CT-9604: Unable to end contribution agreement.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (EndContributionAgreementInput!)

Input variables needed for ending a contribution agreement on an account.

Return fields

Name	Description

mutation EndContributionAgreement($input: EndContributionAgreementInput!) {
  endContributionAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    contributionAgreement {
      ...ContributionAgreementTypeFragment
    }
  }
}

{
  "input": EndContributionAgreementInput
}

{
  "data": {
    "endContributionAgreement": {
      "possibleErrors": [PossibleErrorType],
      "contributionAgreement": ContributionAgreementType
    }
  }
}

forceReauthentication

Type:ForceReauthentication

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

Force users of Kraken Tokens and refresh tokens issued to the viewer to reauthenticate.

Calling this mutation will cause all Kraken Tokens and refresh tokens issued to the authenticated viewer before the mutation was called to become invalid.

Arguments

Name Description

input (ForceReauthenticationInput!)

Input object argument to the force-reauthentication mutation.

Return fields

Name	Description

mutation ForceReauthentication($input: ForceReauthenticationInput!) {
  forceReauthentication(input: $input) {
    tokensInvalidated
    effectiveAt
  }
}

{
  "input": ForceReauthenticationInput
}

{
  "data": {
    "forceReauthentication": {
      "tokensInvalidated": true,
      "effectiveAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

getEmbeddedSecretForNewPaymentInstruction

Type:GetEmbeddedSecretForNewPaymentInstruction

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

Get the client secret needed to create a new payment instruction using an embedded form.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3820: Received both ledger ID and number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GetEmbeddedSecretForNewPaymentInstructionInput!)

Input fields for getting the client secret for an embedded new card payment method form.

Return fields

Name	Description

mutation GetEmbeddedSecretForNewPaymentInstruction($input: GetEmbeddedSecretForNewPaymentInstructionInput!) {
  getEmbeddedSecretForNewPaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    secretKey
  }
}

{
  "input": GetEmbeddedSecretForNewPaymentInstructionInput
}

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "abc123"
    }
  }
}

getEmbeddedSecretForNewPaymentInstructionWithoutAccount

Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount

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

Get the client secret needed to create a new payment instruction using an embedded form without tying it to a customer.

Arguments

Name Description

input (GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!)

Input fields for getting the client secret for an embedded new card payment method form.

Return fields

Name	Description

mutation GetEmbeddedSecretForNewPaymentInstructionWithoutAccount($input: GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!) {
  getEmbeddedSecretForNewPaymentInstructionWithoutAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    secretKey
  }
}

{
  "input": GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
}

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "abc123"
    }
  }
}

getHostedUrlForNewPaymentInstruction

Type:GetHostedUrlForNewPaymentInstruction

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

Get the external URL where the user can set up a payment instruction.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GetHostedUrlForNewPaymentInstructionInput!)

Input fields for getting the external URL for setting up a payment instruction.

Return fields

Name	Description

mutation GetHostedUrlForNewPaymentInstruction($input: GetHostedUrlForNewPaymentInstructionInput!) {
  getHostedUrlForNewPaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    url
  }
}

{
  "input": GetHostedUrlForNewPaymentInstructionInput
}

{
  "data": {
    "getHostedUrlForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "url": "abc123"
    }
  }
}

initiateHostedStandalonePayment

Type:InitiateHostedStandalonePayment

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

Initiate a standalone payment and return the url where the customer can complete it.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3943: Invalid ledger.
KT-CT-3957: No collection method provided.
KT-CT-3958: Provide either ledger ID or ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateHostedStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name	Description

mutation InitiateHostedStandalonePayment($input: InitiateHostedStandalonePaymentInput!) {
  initiateHostedStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...InitiateHostedStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateHostedStandalonePaymentInput
}

{
  "data": {
    "initiateHostedStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": InitiateHostedStandalonePaymentOutput
    }
  }
}

initiateProductSwitch

Type:InitiateProductSwitch

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

Do a product switch for a user.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4619: Quote with given code not found.
KT-CT-4624: Unable to accept the given product code.
KT-CT-4626: No product selected for the given quote code.
KT-CT-4719: No supply point found for identifier provided.
KT-CT-4922: Unauthorized.
KT-CT-1507: Agreement product switch date is not within the acceptable range.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateProductSwitchInput!)

Instigate a product switch for a specific supply point given a valid product and account number.

Return fields

Name	Description

mutation InitiateProductSwitch($input: InitiateProductSwitchInput!) {
  initiateProductSwitch(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    productCode
    switchDate
  }
}

{
  "input": InitiateProductSwitchInput
}

{
  "data": {
    "initiateProductSwitch": {
      "possibleErrors": [PossibleErrorType],
      "productCode": "abc123",
      "switchDate": "2020-01-01"
    }
  }
}

initiateStandalonePayment

Type:InitiateStandalonePayment

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

Initiate a standalone payment and return the client secret required to complete it.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3943: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name	Description

mutation InitiateStandalonePayment($input: InitiateStandalonePaymentInput!) {
  initiateStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...InitiateStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateStandalonePaymentInput
}

{
  "data": {
    "initiateStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": InitiateStandalonePaymentOutput
    }
  }
}

instigateLeaveSupplier

Type:LeaveSupplierInstigated!

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

Instigate a leave supplier process or update an existing process.

The possible errors that can be raised are:

KT-CT-10304: Mutation not enabled in this environment.
KT-CT-4501: Unauthorized.
KT-CT-1602: Serializer validation error.
KT-JP-8801: Supply point not found.
KT-CT-10301: Unable to instigate leave supplier process.
KT-CT-10309: Failed to update leave supplier process - the service is not enabled.
KT-CT-10310: Failed to update leave supplier process. The process status is not in updatable status.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (LeaveSupplierInput!)

Return fields

Name	Description

mutation InstigateLeaveSupplier($input: LeaveSupplierInput!) {
  instigateLeaveSupplier(input: $input) {
    leaveSupplierProcessId
    message
  }
}

{
  "input": LeaveSupplierInput
}

{
  "data": {
    "instigateLeaveSupplier": {
      "leaveSupplierProcessId": "abc123",
      "message": "abc123"
    }
  }
}

invalidatePaymentInstruction

Type:InvalidatePaymentInstruction

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

Invalidate an existing instruction.

The possible errors that can be raised are:

KT-CT-3926: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InvalidatePaymentInstructionInput!)

Input fields for invalidating a payment instruction from an embedded form.

Return fields

Name	Description

mutation InvalidatePaymentInstruction($input: InvalidatePaymentInstructionInput!) {
  invalidatePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    instruction {
      ...InvalidatePaymentInstructionOutputFragment
    }
  }
}

{
  "input": InvalidatePaymentInstructionInput
}

{
  "data": {
    "invalidatePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "instruction": InvalidatePaymentInstructionOutput
    }
  }
}

invalidatePreSignedToken

Type:InvalidatePreSignedToken

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

Invalidate a previously-issued pre-signed token.

The possible errors that can be raised are:

KT-CT-1129: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (InvalidatePreSignedTokenInput!)

Return fields

Name	Description

mutation InvalidatePreSignedToken($input: InvalidatePreSignedTokenInput!) {
  invalidatePreSignedToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...PreSignedTokenFragment
    }
  }
}

{
  "input": InvalidatePreSignedTokenInput
}

{
  "data": {
    "invalidatePreSignedToken": {
      "possibleErrors": [PossibleErrorType],
      "token": PreSignedToken
    }
  }
}

joinSupplierAcceptTermsAndConditions

Type:JoinSupplierAcceptTermsAndConditions

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

Accept terms and conditions for a join supplier process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4501: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (JoinSupplierAcceptTermsAndConditionsInput!)

Return fields

Name	Description

mutation JoinSupplierAcceptTermsAndConditions($input: JoinSupplierAcceptTermsAndConditionsInput!) {
  joinSupplierAcceptTermsAndConditions(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": JoinSupplierAcceptTermsAndConditionsInput
}

{
  "data": {
    "joinSupplierAcceptTermsAndConditions": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

linkUserToLine

Type:LinkUserToLineResponse!

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

Link an account user and line user together.

Arguments

Name Description

input (LinkUserToLineInput!)

Input fields to link an account user with LINE.

Return fields

Name	Description

mutation LinkUserToLine($input: LinkUserToLineInput!) {
  linkUserToLine(input: $input) {
    ... on LineLinkRedirectResponse {
      ...LineLinkRedirectResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
    ... on AlreadyLinkedError {
      ...AlreadyLinkedErrorFragment
    }
  }
}

{
  "input": LinkUserToLineInput
}

{
  "data": {
    "linkUserToLine": LineLinkRedirectResponse
  }
}

masqueradeAuthentication

Type:MasqueradeAuthentication

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

Provide a temporary token to get an auth token. This is intended to allow support users to view customer data through the brand interface.

Arguments

Name Description

masqueradeToken (String!)

The masquerade token issued by the support site.

userId (String!)

The ID of the AccountUser to masquerade as.

Return fields

Name	Description

mutation MasqueradeAuthentication(
  $masqueradeToken: String!,
  $userId: String!
) {
  masqueradeAuthentication(
    masqueradeToken: $masqueradeToken,
    userId: $userId
  ) {
    token
    errors {
      ...ErrorTypeFragment
    }
  }
}

{
  "masqueradeToken": "abc123",
  "userId": "abc123"
}

{
  "data": {
    "masqueradeAuthentication": {
      "token": "abc123",
      "errors": [ErrorType]
    }
  }
}

obtainKrakenToken

Type:ObtainKrakenJSONWebToken

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

Create a Kraken Token (JWT) for authentication.

Provide the required input fields to obtain the token.

The token should be used as the Authorization header for any authenticated requests.

The possible errors that can be raised are:

KT-CT-1135: Invalid data.
KT-CT-1134: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ObtainJSONWebTokenInput!)

Input fields that can be used to obtain a Json Web Token (JWT) for authentication to the API.

Return fields

Name	Description

mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
  obtainKrakenToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
    payload
    refreshToken
    refreshExpiresIn
  }
}

{
  "input": ObtainJSONWebTokenInput
}

{
  "data": {
    "obtainKrakenToken": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123",
      "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "refreshToken": "abc123",
      "refreshExpiresIn": 1
    }
  }
}

ocppAuthentication

Type:OCPPAuthentication

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

Trigger OCPP authentication.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4310: Unable to register OCPP authentication details.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (OCPPAuthenticationInput)

Return fields

Name	Description

mutation OcppAuthentication($input: OCPPAuthenticationInput) {
  ocppAuthentication(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": OCPPAuthenticationInput
}

{
  "data": {
    "ocppAuthentication": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

reauthenticateDevice

Type:ReauthenticateDevice

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

Reauthenticate an already registered device.

The possible errors that can be raised are:

KT-CT-4313: Could not find KrakenFlex device.
KT-CT-4314: Unable to get provider details.
KT-CT-4315: Unable to re-authenticate device.
KT-CT-4363: No capable devices found.
KT-CT-4364: Multiple devices found.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ReauthenticateDeviceInput)

Return fields

Name	Description

mutation ReauthenticateDevice($input: ReauthenticateDeviceInput) {
  reauthenticateDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": ReauthenticateDeviceInput
}

{
  "data": {
    "reauthenticateDevice": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

redeemLoyaltyPointsForAccountCredit

Type:RedeemLoyaltyPointsForAccountCredit

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

Redeem the passed number of Loyalty Points as account credit.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9201: No Loyalty Point ledger found for the user.
KT-CT-9202: Loyalty Points adapter not configured.
KT-CT-9203: No ledger entries for the ledger.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9206: Indivisible points.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9209: Negative Loyalty Points balance.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RedeemLoyaltyPointsInput!)

Input fields for redeeming Loyalty Points.

Return fields

Name	Description

mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
  redeemLoyaltyPointsForAccountCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsRedeemed
  }
}

{
  "input": RedeemLoyaltyPointsInput
}

{
  "data": {
    "redeemLoyaltyPointsForAccountCredit": {
      "possibleErrors": [PossibleErrorType],
      "pointsRedeemed": 1
    }
  }
}

redeemReferralClaimCode

Type:RedeemReferralClaimCode

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

Redeem the referral claim code from certain referral scheme.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6724: Referral claim code not found.
KT-CT-6725: Referral claim code redeeming error.
KT-CT-6726: Referral claim code has already been redeemed.
KT-CT-6727: Referral claim code is not available.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RedeemReferralClaimCodeInput!)

Input fields for redeeming referral code.

Return fields

Name	Description

mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
  redeemReferralClaimCode(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": RedeemReferralClaimCodeInput
}

{
  "data": {
    "redeemReferralClaimCode": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

regenerateSecretKey

Type:RegenerateSecretKey

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

Regenerate the live secret key for the authenticated user.

Return fields

Name	Description

mutation RegenerateSecretKey {
  regenerateSecretKey {
    key
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "data": {
    "regenerateSecretKey": {
      "key": "abc123",
      "viewer": AccountUserType
    }
  }
}

registerPushNotificationBinding

Type:RegisterPushNotificationBinding

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

This field requires the Authorization header to be set.

Arguments

Name Description

input (RegisterPushNotificationBindingInput!)

Input fields for creating an push notification binding.

Return fields

Name	Description

mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
  registerPushNotificationBinding(input: $input) {
    pushNotificationBinding {
      ...PushNotificationBindingTypeFragment
    }
  }
}

{
  "input": RegisterPushNotificationBindingInput
}

{
  "data": {
    "registerPushNotificationBinding": {
      "pushNotificationBinding": PushNotificationBindingType
    }
  }
}

requestPasswordReset

Type:RequestPasswordResetOutputType

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

Provide the email address of an account user to send them an email with instructions on how to reset their password.

The possible errors that can be raised are:

KT-CT-1133: Unable to request password reset email.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RequestPasswordResetInput!)

Input fields for requesting a password reset email.

Return fields

Name	Description

mutation RequestPasswordReset($input: RequestPasswordResetInput!) {
  requestPasswordReset(input: $input) {
    email
  }
}

{
  "input": RequestPasswordResetInput
}

{
  "data": {
    "requestPasswordReset": {
      "email": "abc123"
    }
  }
}

requestPrintedBill

Type:RequestPrintedBill

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

Request an issued bill to be printed and (re)posted to billing address of the account.

The possible errors that can be raised are:

KT-CT-3824: Unauthorized.
KT-CT-9705: The billing document has not been issued.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestPrintedBillInput!)

Input fields to request a printed bill.

Return fields

Name	Description

mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
  requestPrintedBill(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": RequestPrintedBillInput
}

{
  "data": {
    "requestPrintedBill": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

requestQuote

Type:RequestQuote

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

Request a quote for a list of supply points.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4719: No supply point found for identifier provided.
KT-FR-4525: Provider calendar is missing for one of the electricity supply points.
KT-FR-4613: Unable to request quote.
KT-FR-4615: Unable to request quote.
KT-FR-4619: Unexpected error while generating quote.
KT-FR-4624: Unknown Agreement.
KT-FR-4629: Could not find any supply points to quote.
KT-FR-4634: Unable to change the subscribed max power.
KT-FR-4635: Subscribed max power should be between 1 and 36.
KT-FR-7712: Invalid affiliate session.
KT-FR-7713: Authenticated organizations should not use affiliate sessions.
KT-FR-4626: Audio recording not found.
KT-FR-7711: Missing affiliate session.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RequestQuoteInput!)

Input fields required for requesting a quote.

Return fields

Name	Description

mutation RequestQuote($input: RequestQuoteInput!) {
  requestQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequestCode
    quotedSupplyPoints {
      ...QuotedSupplyPointResultConnectionTypeConnectionFragment
    }
  }
}

{
  "input": RequestQuoteInput
}

{
  "data": {
    "requestQuote": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequestCode": "500c164d-38c7-4f74-9ac6-be210197e9e4",
      "quotedSupplyPoints": QuotedSupplyPointResultConnectionTypeConnection
    }
  }
}

resetPassword

Type:ResetPasswordMutationPayload

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

Reset the password of an account user indicated by the userId to the value supplied.

Arguments

Name Description

input (ResetPasswordMutationInput!)

Return fields

Name	Description

mutation ResetPassword($input: ResetPasswordMutationInput!) {
  resetPassword(input: $input) {
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
    clientMutationId
  }
}

{
  "input": ResetPasswordMutationInput
}

{
  "data": {
    "resetPassword": {
      "errors": [SerializerFieldErrorsType],
      "clientMutationId": "abc123"
    }
  }
}

resetUserPassword

Type:ResetUserPasswordOutput

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

Reset the password of an account user.

The possible errors that can be raised are:

KT-CT-4125: Unauthorized.
KT-CT-1132: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

Name	Description

mutation ResetUserPassword($input: ResetUserPasswordInput!) {
  resetUserPassword(input: $input) {
    passwordUpdated
    failureReasons
    failureCodes
  }
}

{
  "input": ResetUserPasswordInput
}

{
  "data": {
    "resetUserPassword": {
      "passwordUpdated": true,
      "failureReasons": ["abc123"],
      "failureCodes": ["abc123"]
    }
  }
}

resumeControl

Type:ResumeDeviceControl

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

Resume control of the device.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4359: Unable to resume device control.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name	Description

mutation ResumeControl($input: AccountNumberInput) {
  resumeControl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "resumeControl": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

runMeterPointPmaxAnalysis

Type:RunMeterPointPMAXAnalysis

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

Check whether meter points are eligible to be supplied by us.

The possible errors that can be raised are:

KT-FR-8914: Industry consent missing.
KT-FR-8912: PMAX can't be computed for this supply point.
KT-FR-4510: Invalid PRM.
KT-FR-4113: Invalid name.
KT-FR-4913: Unknown product.
KT-FR-4535: Segment invalid.
KT-FR-4533: Non communicating PRM.
KT-FR-4534: Sensitive PRM.
KT-FR-4536: PRM customer non PART.
KT-FR-4537: PRM not powered.
KT-FR-4538: PRM not single-phased.
KT-FR-8919: Power history missing.
KT-FR-8913: PMAX Analysis failed.
KT-FR-8920: Data API error.
KT-FR-8921: Recent power decrease.
KT-FR-8922: Recent power increase.
KT-FR-8923: Insufficient fresh data.
KT-FR-8924: Insufficient winter data.
KT-FR-8925: Too many zeros.
KT-FR-8926: Timeout reached.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RunMeterPointPMAXAnalysisInput!)

Input fields for for checking the eligibility of meter points.

Return fields

Name	Description

mutation RunMeterPointPmaxAnalysis($input: RunMeterPointPMAXAnalysisInput!) {
  runMeterPointPmaxAnalysis(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pmaxAnalysis {
      ...PMAXAnalysisTypeFragment
    }
  }
}

{
  "input": RunMeterPointPMAXAnalysisInput
}

{
  "data": {
    "runMeterPointPmaxAnalysis": {
      "possibleErrors": [PossibleErrorType],
      "pmaxAnalysis": PMAXAnalysisType
    }
  }
}

scheduleQuoteFollowUp

Type:ScheduleQuoteFollowUp

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

Schedule a quote follow-up to the provided recipient.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4632: Invalid recipient information.
KT-CT-4633: Mutation not enabled in this environment.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (QuoteShareInput!)

Return fields

Name	Description

mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
  scheduleQuoteFollowUp(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": QuoteShareInput
}

{
  "data": {
    "scheduleQuoteFollowUp": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

selectChargePointMakeForSmartFlexOnboarding

Type:SelectChargePointMakeForSmartFlexOnboarding

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

Select the charge point make to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectChargePointMakeInput!)

Return fields

Name	Description

mutation SelectChargePointMakeForSmartFlexOnboarding($input: SelectChargePointMakeInput!) {
  selectChargePointMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectChargePointMakeInput
}

{
  "data": {
    "selectChargePointMakeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectChargePointVariantForSmartFlexOnboarding

Type:SelectChargePointVariantForSmartFlexOnboarding

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

Select the charge point model variant to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectChargePointVariantInput!)

Return fields

Name	Description

mutation SelectChargePointVariantForSmartFlexOnboarding($input: SelectChargePointVariantInput!) {
  selectChargePointVariantForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectChargePointVariantInput
}

{
  "data": {
    "selectChargePointVariantForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectDeviceTypeForSmartFlexOnboarding

Type:SelectDeviceTypeForSmartFlexOnboarding

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

Select the device type to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectDeviceTypeInput!)

Return fields

Name	Description

mutation SelectDeviceTypeForSmartFlexOnboarding($input: SelectDeviceTypeInput!) {
  selectDeviceTypeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectDeviceTypeInput
}

{
  "data": {
    "selectDeviceTypeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectUserVehicleForSmartFlexOnboarding

Type:SelectUserVehicleForSmartFlexOnboarding

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

Select the user's vehicle to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectUserVehicleInput!)

Return fields

Name	Description

mutation SelectUserVehicleForSmartFlexOnboarding($input: SelectUserVehicleInput!) {
  selectUserVehicleForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectUserVehicleInput
}

{
  "data": {
    "selectUserVehicleForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleMakeForSmartFlexOnboarding

Type:SelectVehicleMakeForSmartFlexOnboarding

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

Select the vehicle make to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectVehicleMakeInput!)

Return fields

Name	Description

mutation SelectVehicleMakeForSmartFlexOnboarding($input: SelectVehicleMakeInput!) {
  selectVehicleMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectVehicleMakeInput
}

{
  "data": {
    "selectVehicleMakeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleVariantForSmartFlexOnboarding

Type:SelectVehicleVariantForSmartFlexOnboarding

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

Select the vehicle model variant to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectVehicleVariantInput!)

Return fields

Name	Description

mutation SelectVehicleVariantForSmartFlexOnboarding($input: SelectVehicleVariantInput!) {
  selectVehicleVariantForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectVehicleVariantInput
}

{
  "data": {
    "selectVehicleVariantForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selfReading

Type:SelfReading

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

Gather customer's self readings data and call Enedis TIA webservice.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-FR-4510: Invalid PRM.
KT-FR-4513: A technical error has occurred.
KT-FR-4514: The requested date is not allowed.
KT-FR-4515: The provided readings are inconsistent.
KT-FR-4516: The PRM is being modified by another user.
KT-FR-4517: Unknown error.
KT-FR-4518: Readings were already provided today.
KT-FR-4624: Unknown Agreement.
KT-FR-4712: Invalid meter readings data.
KT-FR-4713: Invalid data. Reading date cannot be in the future.
KT-FR-4912: No active agreement found.
KT-FR-4539: Smart meter is not supported.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelfReadingInputType!)

Input fields for adding self reading indexes.

Return fields

Name	Description

mutation SelfReading($input: SelfReadingInputType!) {
  selfReading(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementId
    meterPointId
    readingDate
    marketName
  }
}

{
  "input": SelfReadingInputType
}

{
  "data": {
    "selfReading": {
      "possibleErrors": [PossibleErrorType],
      "agreementId": 1,
      "meterPointId": "abc123",
      "readingDate": "2020-01-01",
      "marketName": "abc123"
    }
  }
}

sendPmaxEmailSummary

Type:SendPMAXSummaryEmail

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

Send the PMAX summary email to the customer.

The possible errors that can be raised are:

KT-FR-8911: PMAX Analysis already sended.
KT-FR-8910: PMAX Analysis not found.
KT-FR-8915: Email consent missing.
KT-CT-4122: Invalid email.
KT-FR-8917: Failed to send email.
KT-FR-8918: Can't send email for this analysis.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (PMAXEmailSummaryInput!)

Input fields for for checking the eligibility of meter points.

Return fields

Name	Description

mutation SendPmaxEmailSummary($input: PMAXEmailSummaryInput!) {
  sendPmaxEmailSummary(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pmaxAnalysis {
      ...PMAXAnalysisTypeFragment
    }
  }
}

{
  "input": PMAXEmailSummaryInput
}

{
  "data": {
    "sendPmaxEmailSummary": {
      "possibleErrors": [PossibleErrorType],
      "pmaxAnalysis": PMAXAnalysisType
    }
  }
}

setActivationProcessSwitchReadings

Type:SetActivationProcessSwitchReadings

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

Update an activation process' switch readings.

The possible errors that can be raised are:

KT-FR-4712: Invalid meter readings data.
KT-FR-4713: Invalid data. Reading date cannot be in the future.
KT-FR-4912: No active agreement found.
KT-FR-6912: The activation process provided does not exists.
KT-FR-6913: The activation process is not in a checkoutable status.
KT-FR-6914: The activation process does not belong to the logged user account.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SetActivationProcessSwitchReadingsInputType!)

Input fields to update the switch readings of an activation process.

Return fields

Name	Description

mutation SetActivationProcessSwitchReadings($input: SetActivationProcessSwitchReadingsInputType!) {
  setActivationProcessSwitchReadings(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    activationProcessId
  }
}

{
  "input": SetActivationProcessSwitchReadingsInputType
}

{
  "data": {
    "setActivationProcessSwitchReadings": {
      "possibleErrors": [PossibleErrorType],
      "activationProcessId": "abc123"
    }
  }
}

setDevicePreferences

Type:SmartFlexDeviceInterface

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

Set the user preferences for a device.

The possible errors that can be raised are:

KT-CT-4314: Unable to get provider details.
KT-CT-4321: Serializer validation error.
KT-CT-4374: An error occurred while trying to set your device preferences.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SmartFlexDevicePreferencesInput!)

The device preference details to be updated.

Return fields

Name	Description

mutation SetDevicePreferences($input: SmartFlexDevicePreferencesInput!) {
  setDevicePreferences(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
  }
}

{
  "input": SmartFlexDevicePreferencesInput
}

{
  "data": {
    "setDevicePreferences": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "DAIKIN",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface
    }
  }
}

setLoyaltyPointsUser

Type:SetLoyaltyPointsUser

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

Set the Loyalty Point user for the account.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SetLoyaltyPointsUserInput!)

Input fields for saving the Loyalty Points user.

Return fields

Name	Description

mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
  setLoyaltyPointsUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    newLoyaltyPointsUserId
  }
}

{
  "input": SetLoyaltyPointsUserInput
}

{
  "data": {
    "setLoyaltyPointsUser": {
      "possibleErrors": [PossibleErrorType],
      "newLoyaltyPointsUserId": "abc123"
    }
  }
}

setUpDirectDebitInstruction

Type:SetUpDirectDebitInstruction

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

Set up a new direct debit instruction.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3940: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetUpDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction

Return fields

Name	Description

mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
  setUpDirectDebitInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

{
  "input": SetUpDirectDebitInstructionInput
}

{
  "data": {
    "setUpDirectDebitInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setVehicleChargePreferences

Type:SetVehicleChargingPreferences

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

Set charging preferences for your electric vehicle.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4321: Serializer validation error.
KT-CT-4353: An error occurred while trying to update your charging preferences.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (VehicleChargingPreferencesInput)

Return fields

Name	Description

mutation SetVehicleChargePreferences($input: VehicleChargingPreferencesInput) {
  setVehicleChargePreferences(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": VehicleChargingPreferencesInput
}

{
  "data": {
    "setVehicleChargePreferences": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

shareGoodsQuote

Type:ShareGoodsQuote

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

Share a goods quote.

The possible errors that can be raised are:

KT-CT-4122: Invalid email.
KT-CT-8203: Received an invalid quote code.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ShareGoodsQuoteInput!)

Input fields for sharing a quote.

Return fields

Name	Description

mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
  shareGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    share {
      ...GoodsQuoteShareFragment
    }
  }
}

{
  "input": ShareGoodsQuoteInput
}

{
  "data": {
    "shareGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "share": GoodsQuoteShare
    }
  }
}

startSmartFlexOnboarding

Type:StartSmartFlexOnboarding

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

Create a wizard for onboarding a device with SmartFlex.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartSmartFlexOnboardingInput!)

Return fields

Name	Description

mutation StartSmartFlexOnboarding($input: StartSmartFlexOnboardingInput!) {
  startSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": StartSmartFlexOnboardingInput
}

{
  "data": {
    "startSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

startTestChargeForSmartFlexOnboarding

Type:StartTestChargeForSmartFlexOnboarding

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

Attempt to start a test charge.

The possible errors that can be raised are:

KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try agan later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

Name	Description

mutation StartTestChargeForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  startTestChargeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "startTestChargeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

storePaymentInstruction

Type:StorePaymentInstruction

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

Store a new payment instruction created through the embedded process.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StorePaymentInstructionInput!)

Input fields for storing a new payment instruction created through the embedded process.

Return fields

Name	Description

mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
  storePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...PaymentInstructionTypeFragment
    }
  }
}

{
  "input": StorePaymentInstructionInput
}

{
  "data": {
    "storePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": PaymentInstructionType
    }
  }
}

submitCustomerFeedback

Type:SubmitCustomerFeedback

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

Submit customer feedback.

The possible errors that can be raised are:

KT-CT-5514: Unable to submit feedback.
KT-CT-5511: The feedback_id should be provided for feedback source.
KT-CT-5512: The feedback doesn't match the account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CustomerFeedbackInputType!)

Return fields

Name	Description

mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
  submitCustomerFeedback(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    customerFeedback {
      ...CustomerFeedbackTypeFragment
    }
  }
}

{
  "input": CustomerFeedbackInputType
}

{
  "data": {
    "submitCustomerFeedback": {
      "possibleErrors": [PossibleErrorType],
      "customerFeedback": CustomerFeedbackType
    }
  }
}

submitRepaymentRequest

Type:SubmitRepaymentRequest

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

Submit a repayment request.

The possible errors that can be raised are:

KT-CT-1132: Unauthorized.
KT-CT-3927: Invalid Amount.
KT-CT-3928: Idempotency key used for another repayment request.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestRepaymentInputType!)

Input fields for requesting a repayment.

Return fields

Name	Description

mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
  submitRepaymentRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentRequest {
      ...RequestRepaymentOutputTypeFragment
    }
  }
}

{
  "input": RequestRepaymentInputType
}

{
  "data": {
    "submitRepaymentRequest": {
      "possibleErrors": [PossibleErrorType],
      "repaymentRequest": RequestRepaymentOutputType
    }
  }
}

suspendControl

Type:SuspendDeviceControl

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

Suspend control of the device.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4358: Unable to suspend device control.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name	Description

mutation SuspendControl($input: AccountNumberInput) {
  suspendControl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "suspendControl": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

switchProduct

Type:SwitchProduct

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

Changes an agreement's product.

The possible errors that can be raised are:

KT-FR-4114: Account not found.
KT-FR-4115: QuotedProduct not found.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SwitchProductInputType!)

Input fields for accepting a product switching request.

Return fields

Name	Description

mutation SwitchProduct($input: SwitchProductInputType!) {
  switchProduct(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    newAgreement {
      ...AgreementTypeFragment
    }
  }
}

{
  "input": SwitchProductInputType
}

{
  "data": {
    "switchProduct": {
      "possibleErrors": [PossibleErrorType],
      "newAgreement": AgreementType
    }
  }
}

terminateCreditTransferPermission

Type:TerminateCreditTransferPermission

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

Terminate credit transfer permission.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3825: Credit transfer permission not found.
KT-CT-3827: The ledger is not valid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TerminateCreditTransferPermissionInput!)

Input fields for terminating a credit transfer permission.

Return fields

Name	Description

mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
  terminateCreditTransferPermission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    validTo
  }
}

{
  "input": TerminateCreditTransferPermissionInput
}

{
  "data": {
    "terminateCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validTo": "2020-01-01T00:00:00.000Z"
    }
  }
}

transferLoyaltyPointsBetweenUsers

Type:TransferLoyaltyPointsBetweenUsers

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

Transfer Loyalty Point from one account user to another.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9209: Negative Loyalty Points balance.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (TransferLoyaltyPointsBetweenUsersInput!)

Input fields for transferring Loyalty Points.

Return fields

Name	Description

mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
  transferLoyaltyPointsBetweenUsers(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsTransferred
  }
}

{
  "input": TransferLoyaltyPointsBetweenUsersInput
}

{
  "data": {
    "transferLoyaltyPointsBetweenUsers": {
      "possibleErrors": [PossibleErrorType],
      "pointsTransferred": 1
    }
  }
}

triggerBoostCharge

Type:PerformBoostCharge

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

Initiate a boost charge for an electric vehicle (EV).

This will start charging the EV and will not stop until the battery reaches 100% charged.

If it is not possible to initiate a boost charge, a KT-CT-4357 error will be returned. It may have a boostChargeRefusalReasons extension which lists the reasons why the boost charge was refused. Possible reasons include:

BC_DEVICE_NOT_YET_LIVE (device is not yet live)
BC_DEVICE_RETIRED (device is retired)
BC_DEVICE_SUSPENDED (device is suspended)
BC_DEVICE_DISCONNECTED (device is disconnected)
BC_DEVICE_NOT_AT_HOME (device is not at home)
BC_BOOST_CHARGE_IN_PROGRESS (boost charge already in progress)

The possible errors that can be raised are:

KT-CT-4356: A boost charge cannot currently be performed.
KT-CT-4357: Unable to trigger boost charge.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name	Description

mutation TriggerBoostCharge($input: AccountNumberInput) {
  triggerBoostCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "triggerBoostCharge": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

triggerTestCharge

Type:PerformTestCharge

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

Initiate a test charge of an electric vehicle (EV).

This is to ensure that the EV or EVSE (charge point) can be controlled remotely and successfully charged for a short period.

If it is not possible to initiate a test charge, a KT-CT-4355 error will be returned. It may have a testChargeRefusalReasons extension which lists the reasons why the test charge was refused. Possible reasons include:

TC_DEVICE_LIVE (device is already live)
TC_DEVICE_ONBOARDING_IN_PROGRESS (test dispatch already in progress)
TC_DEVICE_RETIRED (device is retired)
TC_DEVICE_SUSPENDED (device is suspended)
TC_DEVICE_DISCONNECTED (device is disconnected)
TC_DEVICE_ALREADY_CHARGING (device is already charging)
TC_DEVICE_AWAY_FROM_HOME (device is away from home)
TC_DEVICE_NO_LOCATION_CONFIGURED (device has no location configured)
TC_DEVICE_LOCATION_UNABLE_TO_IDENTIFY (unable to identify device location)
TC_DEVICE_LOCATION_MISSING (device location is missing)

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4355: Unable to trigger charge.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name	Description

mutation TriggerTestCharge($input: AccountNumberInput) {
  triggerTestCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "triggerTestCharge": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

unlinkUserFromLine

Type:UnlinkUserFromLineResponse!

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

Unlink an account user and line together.

Return fields

Name	Description

mutation UnlinkUserFromLine {
  unlinkUserFromLine {
    ... on LineUnlinkedResponse {
      ...LineUnlinkedResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
    ... on LineCommonError {
      ...LineCommonErrorFragment
    }
  }
}

{
  "data": {
    "unlinkUserFromLine": LineUnlinkedResponse
  }
}

updateAccountBillingAddress

Type:UpdateAccountBillingAddress

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

Update the account billing address.

The possible errors that can be raised are:

KT-CT-4145: Invalid address.
KT-CT-7123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountBillingAddressInput!)

Input variables needed for updating an account billing address.

Return fields

Name	Description

mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
  updateAccountBillingAddress(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": AccountBillingAddressInput
}

{
  "data": {
    "updateAccountBillingAddress": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

updateAccountBillingEmail

Type:UpdateAccountBillingEmail

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

Update account billing email.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4122: Invalid email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAccountBillingEmailInput!)

Input fields for updating billing email for an account.

Return fields

Name	Description

mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
  updateAccountBillingEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": UpdateAccountBillingEmailInput
}

{
  "data": {
    "updateAccountBillingEmail": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface
    }
  }
}

updateAccountConsents

Type:UpdateAccountConsents

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

Update the consents of an account

The possible errors that can be raised are:

KT-CT-9014: Duplicate consent.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-9018: Account not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

accountNumber (String!)

The account number to update consents for.

consents ([ConsentInput]!)

Consents to update for account.

Return fields

Name	Description

mutation UpdateAccountConsents(
  $accountNumber: String!,
  $consents: [ConsentInput]!
) {
  updateAccountConsents(
    accountNumber: $accountNumber,
    consents: $consents
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consents {
      ...ConsentTypeFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "consents": ConsentInput
}

{
  "data": {
    "updateAccountConsents": {
      "possibleErrors": [PossibleErrorType],
      "consents": ConsentType
    }
  }
}

updateAccountReference

Type:UpdateAccountReference

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

Update an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8311: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

Name	Description

mutation UpdateAccountReference($input: AccountReferenceInput!) {
  updateAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

{
  "input": AccountReferenceInput
}

{
  "data": {
    "updateAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": AccountReferenceType
    }
  }
}

updateAccountUserConsents

Type:UpdateAccountUserConsents

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

Update the consents of an account user (the authenticated user)

The possible errors that can be raised are:

KT-CT-9014: Duplicate consent.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

consents ([ConsentTypeInput])

Consents to update for account user.

Return fields

Name	Description

mutation UpdateAccountUserConsents($consents: [ConsentTypeInput]) {
  updateAccountUserConsents(consents: $consents) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountUserConsents {
      ...AccountUserConsentsFragment
    }
  }
}

{
  "consents": ConsentTypeInput
}

{
  "data": {
    "updateAccountUserConsents": {
      "possibleErrors": [PossibleErrorType],
      "accountUserConsents": AccountUserConsents
    }
  }
}

updateActivePurchase

Type:UpdateActivePurchase

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

Update an active purchase.

The possible errors that can be raised are:

KT-CT-8225: Received an invalid purchaseId.
KT-CT-8226: The provided purchase is not active.
KT-CT-8206: Invalid data.
KT-CT-8227: Available grants could not be applied.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdatePurchaseInput!)

Input fields for updating an active purchase.

Return fields

Name	Description

mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
  updateActivePurchase(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": UpdatePurchaseInput
}

{
  "data": {
    "updateActivePurchase": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

updateAutoTopUpAmount

Type:UpdateAutoTopUpAmount

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

Change the auto top up amount for the payment schedule.

The possible errors that can be raised are:

KT-CT-3815: No active payment schedule found for this account.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3947: An unexpected error occurred.
KT-CT-3953: The payment schedule is not a balance triggered schedule.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAutoTopUpAmountInput!)

Input fields for updating the auto-top-up amount for a schedule.

Return fields

Name	Description

mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
  updateAutoTopUpAmount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": UpdateAutoTopUpAmountInput
}

{
  "data": {
    "updateAutoTopUpAmount": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

updateCommsDeliveryPreference

Type:UpdateCommsDeliveryPreference

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

Update account communication delivery preference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4136: Cannot set comms preference to email when account has no email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account

Return fields

Name	Description

mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
  updateCommsDeliveryPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": UpdateCommsDeliveryPreferenceInput
}

{
  "data": {
    "updateCommsDeliveryPreference": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface
    }
  }
}

updateCommsPreferences

Type:UpdateAccountUserCommsPreferencesMutationPayload

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

Update the comms preferences of the account user (the authenticated user).

Arguments

Name Description

input (UpdateAccountUserCommsPreferencesMutationInput!)

Return fields

Name	Description

mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
  updateCommsPreferences(input: $input) {
    isOptedInToClientMessages
    isOptedInToOfferMessages
    isOptedInToRecommendedMessages
    isOptedInToUpdateMessages
    isOptedInToThirdPartyMessages
    isOptedInMeterReadingConfirmations
    isOptedInToSmsMessages
    isUsingInvertedEmailColours
    fontSizeMultiplier
    emailFormat
    preferredHoldMusic
    errors {
      ...ErrorTypeFragment
    }
    commsPreferences {
      ...AccountUserCommsPreferencesFragment
    }
    clientMutationId
  }
}

{
  "input": UpdateAccountUserCommsPreferencesMutationInput
}

{
  "data": {
    "updateCommsPreferences": {
      "isOptedInToClientMessages": true,
      "isOptedInToOfferMessages": true,
      "isOptedInToRecommendedMessages": true,
      "isOptedInToUpdateMessages": true,
      "isOptedInToThirdPartyMessages": true,
      "isOptedInMeterReadingConfirmations": true,
      "isOptedInToSmsMessages": true,
      "isUsingInvertedEmailColours": true,
      "fontSizeMultiplier": 1.0,
      "emailFormat": "abc123",
      "preferredHoldMusic": "abc123",
      "errors": [ErrorType],
      "commsPreferences": AccountUserCommsPreferences,
      "clientMutationId": "abc123"
    }
  }
}

updateDeviceSmartControl

Type:SmartFlexDeviceInterface

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

Suspends or resumes the smart control of a specific device.

The possible errors that can be raised are:

KT-CT-4358: Unable to suspend device control.
KT-CT-4359: Unable to resume device control.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SmartControlInput!)

The input to action the desired device control, i.e. suspend or unsuspend a device.

Return fields

Name	Description

mutation UpdateDeviceSmartControl($input: SmartControlInput!) {
  updateDeviceSmartControl(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
  }
}

{
  "input": SmartControlInput
}

{
  "data": {
    "updateDeviceSmartControl": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "DAIKIN",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface
    }
  }
}

updateIndustryConsentData

Type:UpdateIndustryConsentData

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

Update the industry consent data.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-4719: No supply point found for identifier provided.
KT-FR-4524: Invalid input provided to update industry consent data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (IndustryConsentDataPerSupplyPointInput)

Input fields for updating industry consent data.

Return fields

Name	Description

mutation UpdateIndustryConsentData($input: IndustryConsentDataPerSupplyPointInput) {
  updateIndustryConsentData(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consentData {
      ...IndustryConsentDataFragment
    }
  }
}

{
  "input": IndustryConsentDataPerSupplyPointInput
}

{
  "data": {
    "updateIndustryConsentData": {
      "possibleErrors": [PossibleErrorType],
      "consentData": IndustryConsentData
    }
  }
}

updateMetadata

Type:UpdateMetadata

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

Update metadata on an object.

The possible errors that can be raised are:

KT-CT-8413: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (MetadataInput!)

Input fields for updating metadata.

Return fields

Name	Description

mutation UpdateMetadata($input: MetadataInput!) {
  updateMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

{
  "input": MetadataInput
}

{
  "data": {
    "updateMetadata": {
      "possibleErrors": [PossibleErrorType],
      "metadata": Metadata
    }
  }
}

updatePassword

Type:UpdatePassword

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

Update password of the authenticated user

This field requires the Authorization header to be set.

Arguments

Name Description

input (UpdatePasswordInput)

Return fields

Name	Description

mutation UpdatePassword($input: UpdatePasswordInput) {
  updatePassword(input: $input) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdatePasswordInput
}

{
  "data": {
    "updatePassword": {
      "viewer": AccountUserType
    }
  }
}

updateUser

Type:UpdateUserMutation

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

Update the account user details of the authenticated user.

Only one name field can be updated per day, other fields can be updated freely. This prevents users from switching accounts to someone else (usually when moving homes). All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-5413: Invalid data.
KT-CT-5414: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateUserInput!)

Input fields for updating user.

Return fields

Name	Description

mutation UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdateUserInput
}

{
  "data": {
    "updateUser": {
      "possibleErrors": [PossibleErrorType],
      "viewer": AccountUserType
    }
  }
}

updateUserDetails

Type:UpdateAccountUserMutationPayload

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

DEPRECATED: Please use updateUser instead

Update the account user details of the authenticated user. Only one field can be updated per day. This prevents users from switching accounts to someone else (usually when moving homes) All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.

Arguments

Name Description

input (UpdateAccountUserMutationInput!)

Return fields

Name	Description

mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
  updateUserDetails(input: $input) {
    givenName
    familyName
    pronouns
    mobile
    email
    dateOfBirth
    landline
    errors {
      ...ErrorTypeFragment
    }
    clientMutationId
  }
}

{
  "input": UpdateAccountUserMutationInput
}

{
  "data": {
    "updateUserDetails": {
      "givenName": "abc123",
      "familyName": "abc123",
      "pronouns": "abc123",
      "mobile": "abc123",
      "email": "abc123",
      "dateOfBirth": "2020-01-01",
      "landline": "abc123",
      "errors": [ErrorType],
      "clientMutationId": "abc123"
    }
  }
}

verifyIdentity

Type:VerifyIdentity

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

Provide identifying information about an account and user to get a scoped token that will permit access to associate an email address with the account’s user.

The possible errors that can be raised are:

KT-CT-1145: Account/user details do not match.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (VerifyIdentityInput!)

Details about the user to be verified.

Return fields

Name	Description

mutation VerifyIdentity($input: VerifyIdentityInput!) {
  verifyIdentity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
  }
}

{
  "input": VerifyIdentityInput
}

{
  "data": {
    "verifyIdentity": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123"
    }
  }
}

Authentication Server

createMfaDevice

Type:CreateMfaDevice

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

Create MFA Device for user.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-1153: Unable to create MFA device.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (CreateMfaDeviceInputType!)

Input fields for creating a new multi-factor authentication device for the logged user.

Return fields

Name	Description

mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
  createMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceEmail
    devicePhone
    totpSecret
  }
}

{
  "input": CreateMfaDeviceInputType
}

{
  "data": {
    "createMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceEmail": "abc123",
      "devicePhone": "abc123",
      "totpSecret": "abc123"
    }
  }
}

deleteMfaDevice

Type:DeleteMfaDevice

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

Delete MFA Device for user.

The possible errors that can be raised are:

KT-CT-1150: MFA device not found.
KT-CT-1154: Unable to delete MFA device.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

Input fields for deleting an existing multi-factor authentication device for the logged user.

Return fields

Name	Description

mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
  deleteMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceDeleted
  }
}

{
  "input": DeleteMfaDeviceInputType
}

{
  "data": {
    "deleteMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceDeleted": true
    }
  }
}

validateMfaDevice

Type:ValidateMfaDevice

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

Validate MFA Device for user.

The possible errors that can be raised are:

KT-CT-1150: MFA device not found.
KT-CT-1151: MFA device not found.
KT-CT-1152: Invalid MFA token.
KT-CT-1155: Enabled backup device is needed.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

Input fields for validating a new multi-factor authentication device for the logged user.

Return fields

Name	Description

mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
  validateMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceIsValid
  }
}

{
  "input": ValidateMfaDeviceInputType
}

{
  "data": {
    "validateMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceIsValid": true
    }
  }
}

Mutations

API Site

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation