Mutations

In this section

About Mutations

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.

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

API Site

acceptGoodsQuote

Type: AcceptGoodsQuote

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

Accept a goods quote.

The possible errors that can be raised are:

Arguments

Name Description

input (AcceptGoodsQuoteInput!)

Input fields for accepting a quote.

Return fields

Name Description

Mutation

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

Variables

{
  "input": AcceptGoodsQuoteInput
}

Response

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

acceptOfferForQuoting

Type: AcceptOfferForQuoting

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

Accept a quoting offer in an offer group.

The possible errors that can be raised are:

Arguments

Name Description

input (AcceptOfferForQuotingInput!)

Input fields for accepting a quoting offer.

Return fields

Name Description

Mutation

mutation AcceptOfferForQuoting($input: AcceptOfferForQuotingInput!) {
  acceptOfferForQuoting(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    offer {
      ...OfferTypeFragment
    }
  }
}

Variables

{
  "input": AcceptOfferForQuotingInput
}

Response

{
  "data": {
    "acceptOfferForQuoting": {
      "possibleErrors": [PossibleErrorType],
      "offer": OfferType
    }
  }
}

activateTemplates

Type: ActivateTemplatesOutput!

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

Activate one or more draft templates.

The possible errors that can be raised are:

Arguments

Name Description

identifiers ([ID!]!)

The identifiers of the templates to activate.

Return fields

Name Description

Mutation

mutation ActivateTemplates($identifiers: [ID!]!) {
  activateTemplates(identifiers: $identifiers) {
    activatedIdentifiers
  }
}

Variables

{
  "identifiers": "88213247"
}

Response

{
  "data": {
    "activateTemplates": {
      "activatedIdentifiers": "model-hundred-newspaper-organization-team"
    }
  }
}

actualizeContract

Type: ActualizeContractOutput!

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

Actualize a contract for an account or business.

The possible errors that can be raised are:

Arguments

Name Description

input (ActualizeContractInput!)

Return fields

Name Description

Mutation

mutation ActualizeContract($input: ActualizeContractInput!) {
  actualizeContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": ActualizeContractInput
}

Response

{
  "data": {
    "actualizeContract": {
      "contract": Contract
    }
  }
}

addBusinessToSegment

Type: AddBusinessToSegmentMutation

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

Add a business to a segment.

The possible errors that can be raised are:

Arguments

Name Description

input (AddBusinessToSegmentInput!)

Input fields for adding a business to a segment.

Return fields

Name Description

Mutation

mutation AddBusinessToSegment($input: AddBusinessToSegmentInput!) {
  addBusinessToSegment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    businessSegmentPeriod {
      ...BusinessSegmentPeriodTypeFragment
    }
  }
}

Variables

{
  "input": AddBusinessToSegmentInput
}

Response

{
  "data": {
    "addBusinessToSegment": {
      "possibleErrors": [PossibleErrorType],
      "businessSegmentPeriod": BusinessSegmentPeriodType
    }
  }
}

addCampaignToAccount

Type: AddCampaignToAccount

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

The possible errors that can be raised are:

Arguments

Name Description

input (AddCampaignToAccountInput!)

Input variables needed for adding a campaign to an account.

Return fields

Name Description

Mutation

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

Variables

{
  "input": AddCampaignToAccountInput
}

Response

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

addItemsToRiskList

Type: AddItemsToRiskList

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

Add items to the risk list.

The possible errors that can be raised are:

Arguments

Name Description

input ([RiskListItemInputType]!)

A list of risk list items to add.

Return fields

Name Description

Mutation

mutation AddItemsToRiskList($input: [RiskListItemInputType]!) {
  addItemsToRiskList(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    riskIdentifiers {
      ...RiskListItemTypeFragment
    }
  }
}

Variables

{
  "input": RiskListItemInputType
}

Response

{
  "data": {
    "addItemsToRiskList": {
      "possibleErrors": [PossibleErrorType],
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

addNoteToInkConversation

Type: AddNoteToInkConversation

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

The possible errors that can be raised are:

Arguments

Name Description

input (AddNoteToInkConversationInput)

Return fields

Name Description

Mutation

mutation AddNoteToInkConversation($input: AddNoteToInkConversationInput) {
  addNoteToInkConversation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    note {
      ...InkNoteFragment
    }
  }
}

Variables

{
  "input": AddNoteToInkConversationInput
}

Response

{
  "data": {
    "addNoteToInkConversation": {
      "possibleErrors": [PossibleErrorType],
      "note": InkNote
    }
  }
}

addPortfolioReference

Type: AddPortfolioReference

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

Mutation to add a reference to an existing portfolio.

The possible errors that can be raised are:

Arguments

Name Description

input (AddPortfolioReferenceInput)

Input fields for adding a reference to a portfolio.

Return fields

Name Description

Mutation

mutation AddPortfolioReference($input: AddPortfolioReferenceInput) {
  addPortfolioReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": AddPortfolioReferenceInput
}

Response

{
  "data": {
    "addPortfolioReference": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

addProperty

Type: AddProperty

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

Add a property to an account.

The possible errors that can be raised are:

Arguments

Name Description

input (AddPropertyInput!)

Input fields for adding a property to an account.

Return fields

Name Description

Mutation

mutation AddProperty($input: AddPropertyInput!) {
  addProperty(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": AddPropertyInput
}

Response

{
  "data": {
    "addProperty": {
      "possibleErrors": [PossibleErrorType],
      "property": PropertyType
    }
  }
}

addSignupReferralOnAccount

Type: AddSignupReferralOnAccount

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

Add a one-way signup reward to a referral.

The possible errors that can be raised are:

Arguments

Name Description

input (AddSignupReferralOnAccountInput!)

Input fields for creating a signup reward for an organization.

Return fields

Name Description

Mutation

mutation AddSignupReferralOnAccount($input: AddSignupReferralOnAccountInput!) {
  addSignupReferralOnAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReferral {
      ...ReferralTypeFragment
    }
  }
}

Variables

{
  "input": AddSignupReferralOnAccountInput
}

Response

{
  "data": {
    "addSignupReferralOnAccount": {
      "possibleErrors": [PossibleErrorType],
      "accountReferral": ReferralType
    }
  }
}

addStorylineToInkConversation

Type: AddStorylineToInkConversation

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

The possible errors that can be raised are:

Arguments

Name Description

input (AddStorylineToInkConversationInput)

Return fields

Name Description

Mutation

mutation AddStorylineToInkConversation($input: AddStorylineToInkConversationInput) {
  addStorylineToInkConversation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    storyline {
      ...InkStorylineFragment
    }
  }
}

Variables

{
  "input": AddStorylineToInkConversationInput
}

Response

{
  "data": {
    "addStorylineToInkConversation": {
      "possibleErrors": [PossibleErrorType],
      "storyline": InkStoryline
    }
  }
}

addUserToPortfolio

Type: AddUserToPortfolio

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

Add an user to a portfolio with a specified role.

The possible errors that can be raised are:

Arguments

Name Description

input (AddUserToPortfolioInput!)

Input fields for adding a user to a portfolio.

Return fields

Name Description

Mutation

mutation AddUserToPortfolio($input: AddUserToPortfolioInput!) {
  addUserToPortfolio(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": AddUserToPortfolioInput
}

Response

{
  "data": {
    "addUserToPortfolio": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

allowRepaymentSubmission

Type: AllowRepaymentSubmission

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

Allow a repayment to be submitted.

The possible errors that can be raised are:

Arguments

Name Description

input (RepaymentInput!)

Input variable needed for allowing repayment submission.

Return fields

Name Description

Mutation

mutation AllowRepaymentSubmission($input: RepaymentInput!) {
  allowRepaymentSubmission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentId
    repaymentIntervention {
      ...RepaymentInterventionTypeFragment
    }
  }
}

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "allowRepaymentSubmission": {
      "possibleErrors": [PossibleErrorType],
      "repaymentId": "17692288",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

amendPayment

Type: AmendPayment

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

Amend an existing payment.

The possible errors that can be raised are:

Arguments

Name Description

input (AmendPaymentInput!)

Input fields for amending an existing payment.

Return fields

Name Description

Mutation

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

Variables

{
  "input": AmendPaymentInput
}

Response

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

approveRepayment

Type: ApproveRepayment

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

Approve a repayment.

The possible errors that can be raised are:

Arguments

Name Description

input (ApproveRepaymentInput!)

Input fields for approving a repayment.

Return fields

Name Description

Mutation

mutation ApproveRepayment($input: ApproveRepaymentInput!) {
  approveRepayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repayment {
      ...AccountRepaymentTypeFragment
    }
  }
}

Variables

{
  "input": ApproveRepaymentInput
}

Response

{
  "data": {
    "approveRepayment": {
      "possibleErrors": [PossibleErrorType],
      "repayment": AccountRepaymentType
    }
  }
}

assessCollectionProcessRecordForPause

Type: AssessCollectionProcessRecordForPause

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

Assess a collection process record for pause.

The possible errors that can be raised are:

Arguments

Name Description

input (AssessCollectionProcessRecordForPauseInputType!)

Details of collection process to run the pause assessment.

Return fields

Name Description

Mutation

mutation AssessCollectionProcessRecordForPause($input: AssessCollectionProcessRecordForPauseInputType!) {
  assessCollectionProcessRecordForPause(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessProcessed {
      ...AssessCollectionProcessRecordForPauseOutputTypeFragment
    }
  }
}

Variables

{
  "input": AssessCollectionProcessRecordForPauseInputType
}

Response

{
  "data": {
    "assessCollectionProcessRecordForPause": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessProcessed": AssessCollectionProcessRecordForPauseOutputType
    }
  }
}

assignInkBucket

Type: AssignInkBucket

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

The possible errors that can be raised are:

Arguments

Name Description

input (AssignInkBucketInput)

Return fields

Name Description

Mutation

mutation AssignInkBucket($input: AssignInkBucketInput) {
  assignInkBucket(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    conversation {
      ...InkConversationFragment
    }
    bucket {
      ...InkBucketFragment
    }
  }
}

Variables

{
  "input": AssignInkBucketInput
}

Response

{
  "data": {
    "assignInkBucket": {
      "possibleErrors": [PossibleErrorType],
      "conversation": InkConversation,
      "bucket": InkBucket
    }
  }
}

associateCallWithAccount

Type: AssociateCallWithAccount

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

The possible errors that can be raised are:

Arguments

Name Description

input (AssociateCallWithAccountInput!)

Return fields

Name Description

Mutation

mutation AssociateCallWithAccount($input: AssociateCallWithAccountInput!) {
  associateCallWithAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

Variables

{
  "input": AssociateCallWithAccountInput
}

Response

{
  "data": {
    "associateCallWithAccount": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

associateItemToCollectionProcess

Type: AssociateItemToCollectionProcess

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

Associate item to a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (AssociateItemToCollectionProcessInputType!)

Input variables needed for associating an item to collection process.

Return fields

Name Description

Mutation

mutation AssociateItemToCollectionProcess($input: AssociateItemToCollectionProcessInputType!) {
  associateItemToCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessAssociatedItem {
      ...AssociateItemToCollectionProcessOutputTypeFragment
    }
  }
}

Variables

{
  "input": AssociateItemToCollectionProcessInputType
}

Response

{
  "data": {
    "associateItemToCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessAssociatedItem": AssociateItemToCollectionProcessOutputType
    }
  }
}

awardLoyaltyPoints

Type: AwardLoyaltyPoints

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

Award the passed number of Loyalty Points to the account.

The possible errors that can be raised are:

Arguments

Name Description

input (AwardLoyaltyPointsInput!)

Input fields for awarding Loyalty Points.

Return fields

Name Description

Mutation

mutation AwardLoyaltyPoints($input: AwardLoyaltyPointsInput!) {
  awardLoyaltyPoints(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsAwarded
    ledgerEntry {
      ...LoyaltyPointLedgerEntryTypeFragment
    }
  }
}

Variables

{
  "input": AwardLoyaltyPointsInput
}

Response

{
  "data": {
    "awardLoyaltyPoints": {
      "possibleErrors": [PossibleErrorType],
      "pointsAwarded": 7,
      "ledgerEntry": LoyaltyPointLedgerEntryType
    }
  }
}

backendScreenEvent

Type: BackendScreenEvent

URL: https://api.oejp-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:

Arguments

Name Description

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

Name Description

Mutation

mutation BackendScreenEvent($input: BackendScreenEventInput!) {
  backendScreenEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    action
  }
}

Variables

{
  "input": BackendScreenEventInput
}

Response

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

blockRepaymentSubmission

Type: BlockRepaymentSubmission

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

Block a repayment from being submitted.

The possible errors that can be raised are:

Arguments

Name Description

input (RepaymentInput!)

Input variable needed for blocking repayment submission.

Return fields

Name Description

Mutation

mutation BlockRepaymentSubmission($input: RepaymentInput!) {
  blockRepaymentSubmission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentId
    repaymentIntervention {
      ...RepaymentInterventionTypeFragment
    }
  }
}

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "blockRepaymentSubmission": {
      "possibleErrors": [PossibleErrorType],
      "repaymentId": "86847638",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

cancelAmperageChangeRequest

Type: CancelAmperageChangeRequest

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

Cancel amperage change request.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelAmperageChangeRequestInput)

Input fields for cancelling an amperage change request.

Return fields

Name Description

Mutation

mutation CancelAmperageChangeRequest($input: CancelAmperageChangeRequestInput) {
  cancelAmperageChangeRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

Variables

{
  "input": CancelAmperageChangeRequestInput
}

Response

{
  "data": {
    "cancelAmperageChangeRequest": {
      "possibleErrors": [PossibleErrorType],
      "message": "Congress-could-speech-popular-analysis"
    }
  }
}

cancelEnrollment

Type: EnrollmentCancelled!

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

Cancel an enrollment for an account and a set of supply points.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelEnrollmentInput!)

Return fields

Name Description

Mutation

mutation CancelEnrollment($input: CancelEnrollmentInput!) {
  cancelEnrollment(input: $input) {
    message
    enrollmentProcess
  }
}

Variables

{
  "input": CancelEnrollmentInput
}

Response

{
  "data": {
    "cancelEnrollment": {
      "message": "compare-fish-design-really-better",
      "enrollmentProcess": EnrollmentProcess
    }
  }
}

cancelLeaveSupplier

Type: LeaveSupplierCancelled!

URL: https://api.oejp-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-1607: Value cannot be empty.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelLeaveSupplierInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": CancelLeaveSupplierInput
}

Response

{
  "data": {
    "cancelLeaveSupplier": {
      "message": "story-parent-situation-season-new"
    }
  }
}

cancelMoveOut

Type: CancelMoveOut

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

Cancel an ongoing move out.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelMoveOutInput!)

Return fields

Name Description

Mutation

mutation CancelMoveOut($input: CancelMoveOutInput!) {
  cancelMoveOut(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    spin
  }
}

Variables

{
  "input": CancelMoveOutInput
}

Response

{
  "data": {
    "cancelMoveOut": {
      "possibleErrors": [PossibleErrorType],
      "spin": "international-allow-take-pay-fight"
    }
  }
}

cancelOnSiteJobsAppointment

Type: CancelOnSiteJobsAppointment

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

Cancel an Appointment.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelOnSiteJobsAppointmentInputType!)

The input objects required to cancel an Appointment.

Return fields

Name Description

Mutation

mutation CancelOnSiteJobsAppointment($input: CancelOnSiteJobsAppointmentInputType!) {
  cancelOnSiteJobsAppointment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

Variables

{
  "input": CancelOnSiteJobsAppointmentInputType
}

Response

{
  "data": {
    "cancelOnSiteJobsAppointment": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

cancelPayment

Type: CancelPayment

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

Cancel an in-flight payment.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelPaymentInput!)

Input fields for cancelling a pending payment.

Return fields

Name Description

Mutation

mutation CancelPayment($input: CancelPaymentInput!) {
  cancelPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

Variables

{
  "input": CancelPaymentInput
}

Response

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

cancelRepaymentRequest

Type: CancelRepaymentRequest

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

Cancel a repayment or refund request.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelRepaymentRequestInputType!)

Input fields for cancelling a repayment request.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CancelRepaymentRequestInputType
}

Response

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

cancelSmartFlexOnboarding

Type: CancelSmartFlexOnboarding

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

Cancel onboarding of a device with SmartFlex.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelSmartFlexOnboardingInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": CancelSmartFlexOnboardingInput
}

Response

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

closeDcaProceeding

Type: CloseDCAProceeding

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

Close the DCA proceeding for an account.

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-11602: Could not find DCA with that name.
  • KT-CT-11603: Could not stop debt collection proceeding.
  • KT-CT-11604: Active debt collection proceeding does not exist for account.
  • KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CloseDCAProceedingInputType!)

Return fields

Name Description

Mutation

mutation CloseDcaProceeding($input: CloseDCAProceedingInputType!) {
  closeDcaProceeding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    dcaProceedingClosureStatus {
      ...DCAProceedingClosureStatusFragment
    }
  }
}

Variables

{
  "input": CloseDCAProceedingInputType
}

Response

{
  "data": {
    "closeDcaProceeding": {
      "possibleErrors": [PossibleErrorType],
      "dcaProceedingClosureStatus": DCAProceedingClosureStatus
    }
  }
}

closeInkLiveChat

Type: CloseInkLiveChatConversation

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

The possible errors that can be raised are:

Arguments

Name Description

input (CloseInkLiveChaConversationtInput)

Return fields

Name Description

Mutation

mutation CloseInkLiveChat($input: CloseInkLiveChaConversationtInput) {
  closeInkLiveChat(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    liveChatConversation {
      ...InkLiveChatConversationFragment
    }
  }
}

Variables

{
  "input": CloseInkLiveChaConversationtInput
}

Response

{
  "data": {
    "closeInkLiveChat": {
      "possibleErrors": [PossibleErrorType],
      "liveChatConversation": InkLiveChatConversation
    }
  }
}

closeOpenPrintBatch

Type: CloseOpenPrintBatch!

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

Close the Open Print Batch if any.

The possible errors that can be raised are:

Return fields

Name Description

Mutation

mutation CloseOpenPrintBatch {
  closeOpenPrintBatch {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    printBatch {
      ...PrintBatchTypeFragment
    }
  }
}

Response

{
  "data": {
    "closeOpenPrintBatch": {
      "possibleErrors": [PossibleErrorType],
      "printBatch": PrintBatchType
    }
  }
}

collectDeposit

Type: CollectDeposit

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

Collect deposit for the given account.

The possible errors that can be raised are:

Arguments

Name Description

input (CollectDepositInput!)

Return fields

Name Description

Mutation

mutation CollectDeposit($input: CollectDepositInput!) {
  collectDeposit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...CollectDepositOutputFragment
    }
  }
}

Variables

{
  "input": CollectDepositInput
}

Response

{
  "data": {
    "collectDeposit": {
      "possibleErrors": [PossibleErrorType],
      "payment": CollectDepositOutput
    }
  }
}

collectPayment

Type: CollectPayment

URL: https://api.oejp-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:

Arguments

Name Description

input (CollectPaymentInput!)

Input fields for collecting a payment.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CollectPaymentInput
}

Response

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

commenceDcaProceeding

Type: CommenceDCAProceeding

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

Add commencement to an account.

The possible errors that can be raised are:

  • KT-CT-11606: Debt Collection Agency cannot use campaign.
  • KT-CT-11601: Cannot start collection proceeding, proceeding for this account already exists.
  • KT-CT-11602: Could not find DCA with that name.
  • KT-CT-11607: Invalid ledger number for debt collection proceeding.
  • KT-CT-11608: Ledger does not belong to account.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CommenceDCAProceedingInputType!)

Return fields

Name Description

Mutation

mutation CommenceDcaProceeding($input: CommenceDCAProceedingInputType!) {
  commenceDcaProceeding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    dcaProceedingCommencementStatus {
      ...DCAProceedingCommencementStatusFragment
    }
  }
}

Variables

{
  "input": CommenceDCAProceedingInputType
}

Response

{
  "data": {
    "commenceDcaProceeding": {
      "possibleErrors": [PossibleErrorType],
      "dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
    }
  }
}

completeAuthFlowForSmartFlexOnboarding

Type: CompleteAuthFlowForSmartFlexOnboarding

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

Complete the authentication flow to proceed in the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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 (CompleteAuthFlowInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": CompleteAuthFlowInput
}

Response

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

completeStandalonePayment

Type: CompleteStandalonePayment

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

Complete a standalone payment.

The possible errors that can be raised are:

Arguments

Name Description

input (CompleteStandalonePaymentInput!)

Input fields for completing a standalone payment.

Return fields

Name Description

Mutation

mutation CompleteStandalonePayment($input: CompleteStandalonePaymentInput!) {
  completeStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...CompleteStandalonePaymentOutputFragment
    }
  }
}

Variables

{
  "input": CompleteStandalonePaymentInput
}

Response

{
  "data": {
    "completeStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": CompleteStandalonePaymentOutput
    }
  }
}

completeTeslaSetupVirtualKeyForSmartFlexOnboarding

Type: CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding

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

Complete the Tesla virtual key setup onboarding step.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

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

completeUserActionForSmartFlexOnboarding

Type: CompleteUserActionRequiredForSmartFlexOnboarding

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

Complete the user action required step to proceed in the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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

mutation CompleteUserActionForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  completeUserActionForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

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

completeUserInputRequiredForSmartFlexOnboarding

Type: CompleteUserInputRequiredForSmartFlexOnboarding

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

Complete the user input required step to proceed in the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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 (UserInputRequiredInput!)

Return fields

Name Description

Mutation

mutation CompleteUserInputRequiredForSmartFlexOnboarding($input: UserInputRequiredInput!) {
  completeUserInputRequiredForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": UserInputRequiredInput
}

Response

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

confirmDoubleOptIn

Type: ConfirmDoubleOptIn

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

Confirm a double opt in

The possible errors that can be raised are:

Arguments

Name Description

input (ConfirmDoubleOptInInput)

Return fields

Name Description

Mutation

mutation ConfirmDoubleOptIn($input: ConfirmDoubleOptInInput) {
  confirmDoubleOptIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consent {
      ...ConsentTypeFragment
    }
  }
}

Variables

{
  "input": ConfirmDoubleOptInInput
}

Response

{
  "data": {
    "confirmDoubleOptIn": {
      "possibleErrors": [PossibleErrorType],
      "consent": ConsentType
    }
  }
}

createAccountCharge

Type: CreateAccountCharge

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

Add charge to an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAccountChargeInput!)

Input fields for creating an account charge.

Return fields

Name Description

Mutation

mutation CreateAccountCharge($input: CreateAccountChargeInput!) {
  createAccountCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountCharge {
      ...AccountChargeTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountChargeInput
}

Response

{
  "data": {
    "createAccountCharge": {
      "possibleErrors": [PossibleErrorType],
      "accountCharge": AccountChargeType
    }
  }
}

createAccountCredit

Type: CreateAccountCredit

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

Add credit to an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAccountCreditInput!)

Input fields for creating an account credit.

Return fields

Name Description

Mutation

mutation CreateAccountCredit($input: CreateAccountCreditInput!) {
  createAccountCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountCredit {
      ...AccountCreditTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountCreditInput
}

Response

{
  "data": {
    "createAccountCredit": {
      "possibleErrors": [PossibleErrorType],
      "accountCredit": AccountCreditType
    }
  }
}

createAccountNote

Type: CreateAccountNote

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

Add a note to an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAccountNoteInput!)

Input variables needed for adding a note to an account.

Return fields

Name Description

Mutation

mutation CreateAccountNote($input: CreateAccountNoteInput!) {
  createAccountNote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountNoteInput
}

Response

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

createAccountPaymentSchedule

Type: CreateAccountPaymentSchedule

URL: https://api.oejp-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:

Arguments

Name Description

input (CreateAccountPaymentScheduleInput!)

Input fields for updating a payment schedule.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateAccountPaymentScheduleInput
}

Response

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

createAccountReference

Type: CreateAccountReference

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

Create an account reference.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountReferenceInput
}

Response

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

createAccountReminder

Type: CreateAccountReminder

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

Create an account reminder.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAccountReminderInput!)

Input variables needed for creating an account reminder.

Return fields

Name Description

Mutation

mutation CreateAccountReminder($input: CreateAccountReminderInput!) {
  createAccountReminder(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReminder {
      ...AccountReminderFragment
    }
  }
}

Variables

{
  "input": CreateAccountReminderInput
}

Response

{
  "data": {
    "createAccountReminder": {
      "possibleErrors": [PossibleErrorType],
      "accountReminder": AccountReminder
    }
  }
}

Type: CreateAffiliateLink!

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

Create an affiliate link for a new sales agent.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAffiliateLinkInputType!)

Input fields for creating an affiliate link for an organisation.

Return fields

Name Description

Mutation

mutation CreateAffiliateLink($input: CreateAffiliateLinkInputType!) {
  createAffiliateLink(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateLink {
      ...AffiliateLinkTypeFragment
    }
  }
}

Variables

{
  "input": CreateAffiliateLinkInputType
}

Response

{
  "data": {
    "createAffiliateLink": {
      "possibleErrors": [PossibleErrorType],
      "affiliateLink": AffiliateLinkType
    }
  }
}

createAffiliateOrganisation

Type: CreateAffiliateOrganisation!

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

Create an affiliate organisation.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAffiliateOrganisationInputType!)

Input fields for creating an affiliate organisation.

Return fields

Name Description

Mutation

mutation CreateAffiliateOrganisation($input: CreateAffiliateOrganisationInputType!) {
  createAffiliateOrganisation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateOrganisation {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

Variables

{
  "input": CreateAffiliateOrganisationInputType
}

Response

{
  "data": {
    "createAffiliateOrganisation": {
      "possibleErrors": [PossibleErrorType],
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

Arguments

Name Description

input (CreateAffiliateSessionInputType!)

Input fields for creating a session for an affiliate link.

Return fields

Name Description

Mutation

mutation CreateAffiliateSession($input: CreateAffiliateSessionInputType!) {
  createAffiliateSession(input: $input) {
    affiliateSession {
      ...AffiliateSessionTypeFragment
    }
  }
}

Variables

{
  "input": CreateAffiliateSessionInputType
}

Response

{
  "data": {
    "createAffiliateSession": {
      "affiliateSession": AffiliateSessionType
    }
  }
}

createAgreement

Type: CreateAgreement

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

Create a new agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAgreementInput!)

Input fields for creating an agreement.

Return fields

Name Description

Mutation

mutation CreateAgreement($input: CreateAgreementInput!) {
  createAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

Variables

{
  "input": CreateAgreementInput
}

Response

{
  "data": {
    "createAgreement": {
      "possibleErrors": [PossibleErrorType],
      "agreement": CommonAgreementType
    }
  }
}

createAgreementRollover

Type: CreateAgreementRollover

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

Create an agreement rollover for a specific account and agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAgreementRolloverInput!)

Create an agreement rollover for a specific account and agreement.

Return fields

Name Description

Mutation

mutation CreateAgreementRollover($input: CreateAgreementRolloverInput!) {
  createAgreementRollover(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

Variables

{
  "input": CreateAgreementRolloverInput
}

Response

{
  "data": {
    "createAgreementRollover": {
      "possibleErrors": [PossibleErrorType],
      "agreementRollover": AgreementRolloverType
    }
  }
}

createApiCall

Type: CreateAPICall

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

Mutation to create a new APICall instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAPICallInput!)

Input fields for creating an API call.

Return fields

Name Description

Mutation

mutation CreateApiCall($input: CreateAPICallInput!) {
  createApiCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiCall {
      ...APICallTypeFragment
    }
  }
}

Variables

{
  "input": CreateAPICallInput
}

Response

{
  "data": {
    "createApiCall": {
      "possibleErrors": [PossibleErrorType],
      "apiCall": APICallType
    }
  }
}

createApiException

Type: CreateAPIException

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

Mutation to create a new APIException instance.

The possible errors that can be raised are:

  • KT-CT-7801: Received an invalid operationsTeamId.
  • KT-CT-7802: The external identifier already exists.
  • KT-CT-7805: Too many tags associated with this API Exception.
  • KT-CT-7806: Cannot create duplicate tags for the same API exception.
  • KT-CT-7811: Received an invalid assignedUserId.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAPIExceptionInput!)

Input fields for creating an API exception.

Return fields

Name Description

Mutation

mutation CreateApiException($input: CreateAPIExceptionInput!) {
  createApiException(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": CreateAPIExceptionInput
}

Response

{
  "data": {
    "createApiException": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

createApiExceptionEvent

Type: CreateAPIExceptionEvent

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

Mutation to create a new APIExceptionEvent instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAPIExceptionEventInput!)

Input fields for creating an API exception event.

Return fields

Name Description

Mutation

mutation CreateApiExceptionEvent($input: CreateAPIExceptionEventInput!) {
  createApiExceptionEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiExceptionEvent {
      ...APIExceptionEventTypeFragment
    }
  }
}

Variables

{
  "input": CreateAPIExceptionEventInput
}

Response

{
  "data": {
    "createApiExceptionEvent": {
      "possibleErrors": [PossibleErrorType],
      "apiExceptionEvent": APIExceptionEventType
    }
  }
}

createApiExceptionNote

Type: CreateAPIExceptionNote

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

Mutation to create a new APIExceptionNote instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

Name Description

Mutation

mutation CreateApiExceptionNote($input: CreateAPIExceptionNoteInput!) {
  createApiExceptionNote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": CreateAPIExceptionNoteInput
}

Response

{
  "data": {
    "createApiExceptionNote": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

createAudioRecording

Type: CreateAudioRecording!

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

Create an audio recording for an affiliate session.

The possible errors that can be raised are:

Arguments

Name Description

input (AudioRecordingInputType!)

Input fields required to create an audio recording.

Return fields

Name Description

Mutation

mutation CreateAudioRecording($input: AudioRecordingInputType!) {
  createAudioRecording(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    audioRecording {
      ...AudioRecordingTypeFragment
    }
  }
}

Variables

{
  "input": AudioRecordingInputType
}

Response

{
  "data": {
    "createAudioRecording": {
      "possibleErrors": [PossibleErrorType],
      "audioRecording": AudioRecordingType
    }
  }
}

createBankTransferPaymentMethod

Type: CreateBankTransferPaymentMethodResponse!

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

Creates a new bank transfer payment method for a business account.

Arguments

Name Description

input (CreateBankTransferPaymentMethodInput!)

Return fields

Name Description

Mutation

mutation CreateBankTransferPaymentMethod($input: CreateBankTransferPaymentMethodInput!) {
  createBankTransferPaymentMethod(input: $input)
}

Variables

{
  "input": CreateBankTransferPaymentMethodInput
}

Response

{
  "data": {
    "createBankTransferPaymentMethod": CreateBankTransferPaymentMethodResponse
  }
}

createBusiness

Type: CreateBusiness

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

Create a business.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateBusinessInput!)

Input for creating a business.

Return fields

Name Description

Mutation

mutation CreateBusiness($input: CreateBusinessInput!) {
  createBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    business {
      ...BusinessTypeFragment
    }
  }
}

Variables

{
  "input": CreateBusinessInput
}

Response

{
  "data": {
    "createBusiness": {
      "possibleErrors": [PossibleErrorType],
      "business": BusinessType
    }
  }
}

createCallMetadata

Type: CreateCallMetadata

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

The possible errors that can be raised are:

Arguments

Name Description

input (CallMetadataInput!)

Return fields

Name Description

Mutation

mutation CreateCallMetadata($input: CallMetadataInput!) {
  createCallMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...CallInterfaceFragment
    }
  }
}

Variables

{
  "input": CallMetadataInput
}

Response

{
  "data": {
    "createCallMetadata": {
      "possibleErrors": [PossibleErrorType],
      "call": CallInterface
    }
  }
}

createCampaignItems

Type: CreateCampaignItems

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateCampaignItemsInput!)

Return fields

Name Description

Mutation

mutation CreateCampaignItems($input: CreateCampaignItemsInput!) {
  createCampaignItems(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignItems {
      ...VoiceCampaignItemTypeFragment
    }
    batchIdentifier
  }
}

Variables

{
  "input": CreateCampaignItemsInput
}

Response

{
  "data": {
    "createCampaignItems": {
      "possibleErrors": [PossibleErrorType],
      "campaignItems": [VoiceCampaignItemType],
      "batchIdentifier": "23205585"
    }
  }
}

createCatalogInput

Type: CreateInputOutput!

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

Create a new catalog input.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateInputInput!)

Return fields

Name Description

Mutation

mutation CreateCatalogInput($input: CreateInputInput!) {
  createCatalogInput(input: $input) {
    input {
      ...InputTypeFragment
    }
  }
}

Variables

{
  "input": CreateInputInput
}

Response

{
  "data": {
    "createCatalogInput": {
      "input": InputType
    }
  }
}

createComplaint

Type: CreateComplaint

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

Create a complaint.

The possible errors that can be raised are:

Arguments

Name Description

complaint (CreateComplaintInputType!)

Return fields

Name Description

Mutation

mutation CreateComplaint($complaint: CreateComplaintInputType!) {
  createComplaint(complaint: $complaint) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    complaint {
      ...ComplaintTypeFragment
    }
  }
}

Variables

{
  "complaint": CreateComplaintInputType
}

Response

{
  "data": {
    "createComplaint": {
      "possibleErrors": [PossibleErrorType],
      "complaint": ComplaintType
    }
  }
}

createContract

Type: CreateContractOutput!

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

Create and actualize a new contract for an account or business.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateContractInput!)

Return fields

Name Description

Mutation

mutation CreateContract($input: CreateContractInput!) {
  createContract(input: $input) {
    identifier
  }
}

Variables

{
  "input": CreateContractInput
}

Response

{
  "data": {
    "createContract": {
      "identifier": "97774266"
    }
  }
}

createContributionAgreement

Type: CreateContributionAgreement

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

Create a contribution agreement for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateContributionAgreementInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateContributionAgreementInput
}

Response

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

createCreditTransferPermission

Type: CreateCreditTransferPermission

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

Create a credit transfer permission.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateCreditTransferPermissionInput!)

Input fields to create a credit transfer permission.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateCreditTransferPermissionInput
}

Response

{
  "data": {
    "createCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validFrom": "2004-05-19T11:16:45.363610+00:00"
    }
  }
}

createCustomerFeedback

Type: CreateCustomerFeedback

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

Create unsubmitted customer feedback object.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateCustomerFeedbackInputType!)

Return fields

Name Description

Mutation

mutation CreateCustomerFeedback($input: CreateCustomerFeedbackInputType!) {
  createCustomerFeedback(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    customerFeedback {
      ...CustomerFeedbackTypeFragment
    }
  }
}

Variables

{
  "input": CreateCustomerFeedbackInputType
}

Response

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

createDepositAgreement

Type: CreateDepositAgreement

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

Create a new deposit agreement for the account if it needs one.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateDepositAgreementInput!)

Return fields

Name Description

Mutation

mutation CreateDepositAgreement($input: CreateDepositAgreementInput!) {
  createDepositAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    depositAgreement {
      ...CreateDepositAgreementOutputFragment
    }
  }
}

Variables

{
  "input": CreateDepositAgreementInput
}

Response

{
  "data": {
    "createDepositAgreement": {
      "possibleErrors": [PossibleErrorType],
      "depositAgreement": CreateDepositAgreementOutput
    }
  }
}

createElectricityQuote

Type: CreateElectricityQuote

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

Create a quote.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateElectricityQuoteInput!)

Return fields

Name Description

Mutation

mutation CreateElectricityQuote($input: CreateElectricityQuoteInput!) {
  createElectricityQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteFragment
    }
  }
}

Variables

{
  "input": CreateElectricityQuoteInput
}

Response

{
  "data": {
    "createElectricityQuote": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": Quote
    }
  }
}

createExternalAccountEvent

Type: CreateExternalAccountEvent

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

Create an external account event.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateExternalAccountEventInput!)

Input fields for creating an external account event.

Return fields

Name Description

Mutation

mutation CreateExternalAccountEvent($input: CreateExternalAccountEventInput!) {
  createExternalAccountEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    event {
      ...ExternalAccountEventFragment
    }
  }
}

Variables

{
  "input": CreateExternalAccountEventInput
}

Response

{
  "data": {
    "createExternalAccountEvent": {
      "possibleErrors": [PossibleErrorType],
      "event": ExternalAccountEvent
    }
  }
}

createExternalAccountUserEvent

Type: CreateExternalAccountUserEvent

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

Create an external account user event.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateExternalAccountUserEventInput!)

Input fields for creating an external account event.

Return fields

Name Description

Mutation

mutation CreateExternalAccountUserEvent($input: CreateExternalAccountUserEventInput!) {
  createExternalAccountUserEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    event {
      ...ExternalAccountUserEventFragment
    }
  }
}

Variables

{
  "input": CreateExternalAccountUserEventInput
}

Response

{
  "data": {
    "createExternalAccountUserEvent": {
      "possibleErrors": [PossibleErrorType],
      "event": ExternalAccountUserEvent
    }
  }
}

createFormSubmission

Type: FormSubmissionOuput

URL: https://api.oejp-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

input (FormSubmissionInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": FormSubmissionInput
}

Response

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

createGoodsPurchase

Type: CreateGoodsPurchase

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

Create a goods purchase.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePurchaseInput!)

Input fields for creating a purchase without a quote.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreatePurchaseInput
}

Response

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

createGoodsQuote

Type: CreateGoodsQuote

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

Create a goods quote.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateGoodsQuoteInput!)

Input fields for creating a goods quote.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateGoodsQuoteInput
}

Response

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

createGoodsQuoteWithoutAccount

Type: CreateGoodsQuoteWithoutAccount

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

Create a goods quote without an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateGoodsQuoteWithoutAccountInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateGoodsQuoteWithoutAccountInput
}

Response

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

createInboundCall

Type: CreateInboundCall

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateInboundCallInput!)

Return fields

Name Description

Mutation

mutation CreateInboundCall($input: CreateInboundCallInput!) {
  createInboundCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

Variables

{
  "input": CreateInboundCallInput
}

Response

{
  "data": {
    "createInboundCall": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

createInkInboundMessage

Type: CreateInkInboundMessage

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

Register an Ink inbound message.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateInkInboundMessageInput)

Return fields

Name Description

Mutation

mutation CreateInkInboundMessage($input: CreateInkInboundMessageInput) {
  createInkInboundMessage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

Variables

{
  "input": CreateInkInboundMessageInput
}

Response

{
  "data": {
    "createInkInboundMessage": {
      "possibleErrors": [PossibleErrorType],
      "message": InkMessage
    }
  }
}

createInkLiveChatMessage

Type: CreateInkLiveChatMessage

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateInkLiveChatMessageInput)

Return fields

Name Description

Mutation

mutation CreateInkLiveChatMessage($input: CreateInkLiveChatMessageInput) {
  createInkLiveChatMessage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    liveChatConversation {
      ...InkLiveChatConversationFragment
    }
    messageRelayId
  }
}

Variables

{
  "input": CreateInkLiveChatMessageInput
}

Response

{
  "data": {
    "createInkLiveChatMessage": {
      "possibleErrors": [PossibleErrorType],
      "liveChatConversation": InkLiveChatConversation,
      "messageRelayId": "17362948"
    }
  }
}

Arguments

Name Description

input (CreateJPNFileAttachmentInput!)

Return fields

Name Description

Mutation

mutation CreateJpnFileAttachment($input: CreateJPNFileAttachmentInput!) {
  createJpnFileAttachment(input: $input) {
    postRequest {
      ...UploadPostRequestFragment
    }
    clientMutationId
  }
}

Variables

{
  "input": CreateJPNFileAttachmentInput
}

Response

{
  "data": {
    "createJpnFileAttachment": {
      "postRequest": UploadPostRequest,
      "clientMutationId": "67864013"
    }
  }
}

Arguments

Name Description

input (CreateKonbiniPaymentInput!)

Return fields

Name Description

Mutation

mutation CreateKonbiniPayment($input: CreateKonbiniPaymentInput!) {
  createKonbiniPayment(input: $input)
}

Variables

{
  "input": CreateKonbiniPaymentInput
}

Response

{
  "data": {
    "createKonbiniPayment": CreateKonbiniPaymentResponse
  }
}

Arguments

Name Description

input (CreateKonbiniPaymentMethodInput!)

Return fields

Name Description

Mutation

mutation CreateKonbiniPaymentMethod($input: CreateKonbiniPaymentMethodInput!) {
  createKonbiniPaymentMethod(input: $input)
}

Variables

{
  "input": CreateKonbiniPaymentMethodInput
}

Response

{
  "data": {
    "createKonbiniPaymentMethod": CreateKonbiniPaymentMethodResponse
  }
}

createLead

Type: CreateLead

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

Create a lead with the provided details.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateLeadInput!)

Input fields for creating a lead.

Return fields

Name Description

Mutation

mutation CreateLead($input: CreateLeadInput!) {
  createLead(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    leadNumber
  }
}

Variables

{
  "input": CreateLeadInput
}

Response

{
  "data": {
    "createLead": {
      "possibleErrors": [PossibleErrorType],
      "leadNumber": "until-woman-financial-pretty-most"
    }
  }
}

createLifelineAgencyQuote

Type: CreateLifelineAgencyQuote

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

Mutation to accept T&Cs for customers that are onboarded through Lifeline Agencies.

Arguments

Name Description

input (CreateLifelineAgencyQuoteInput!)

Return fields

Name Description

Mutation

mutation CreateLifelineAgencyQuote($input: CreateLifelineAgencyQuoteInput!) {
  createLifelineAgencyQuote(input: $input) {
    isCreated
  }
}

Variables

{
  "input": CreateLifelineAgencyQuoteInput
}

Response

{
  "data": {
    "createLifelineAgencyQuote": {
      "isCreated": true
    }
  }
}

createMetadata

Type: CreateMetadata

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

Create metadata on an object.

The possible errors that can be raised are:

Arguments

Name Description

input (MetadataInput!)

Input fields for creating metadata.

Return fields

Name Description

Mutation

mutation CreateMetadata($input: MetadataInput!) {
  createMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

Variables

{
  "input": MetadataInput
}

Response

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

createMfaDevice

Type: CreateMfaDevice

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

Create MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateMfaDeviceInputType!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateMfaDeviceInputType
}

Response

{
  "data": {
    "createMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceEmail": "point-item-already-peace-wind",
      "devicePhone": "themselves-must-account-boy-hold",
      "totpSecret": "worker-relate-fall-its-grow"
    }
  }
}

createNewAgreementFromProductSwitchProcess

Type: CreateNewAgreementFromProductSwitchProcess

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

Create a new agreement from an existing product switch process.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateNewAgreementFromProductSwitchProcessInput!)

Validate the product switch flow data and creates a ProcessSwitchProcess model.

Return fields

Name Description

Mutation

mutation CreateNewAgreementFromProductSwitchProcess($input: CreateNewAgreementFromProductSwitchProcessInput!) {
  createNewAgreementFromProductSwitchProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

Variables

{
  "input": CreateNewAgreementFromProductSwitchProcessInput
}

Response

{
  "data": {
    "createNewAgreementFromProductSwitchProcess": {
      "possibleErrors": [PossibleErrorType],
      "agreement": CommonAgreementType
    }
  }
}

createOfferGroupForQuoting

Type: CreateOfferGroupForQuoting

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

Create a quoting Offer Group.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOfferGroupForQuotingInput!)

Input fields for creating an offer group from a list of offers.

Return fields

Name Description

Mutation

mutation CreateOfferGroupForQuoting($input: CreateOfferGroupForQuotingInput!) {
  createOfferGroupForQuoting(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    offerGroup {
      ...CreateOfferGroupTypeFragment
    }
  }
}

Variables

{
  "input": CreateOfferGroupForQuotingInput
}

Response

{
  "data": {
    "createOfferGroupForQuoting": {
      "possibleErrors": [PossibleErrorType],
      "offerGroup": CreateOfferGroupType
    }
  }
}

createOnSiteJobsAppointment

Type: CreateOnSiteJobsAppointment

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

Create an Appointment.

The possible errors that can be raised are:

Arguments

Name Description

appointmentBookingSessionId (UUID!)

The appointment booking session ID to create an appointment.

slotId (UUID!)

The slot ID to book the appointment for.

Return fields

Name Description

Mutation

mutation CreateOnSiteJobsAppointment(
  $appointmentBookingSessionId: UUID!,
  $slotId: UUID!
) {
  createOnSiteJobsAppointment(
    appointmentBookingSessionId: $appointmentBookingSessionId,
    slotId: $slotId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

Variables

{
  "appointmentBookingSessionId": "3abf10f6-ae26-4989-a327-79a6e8828ab5",
  "slotId": "bcfca1fb-43f8-4b70-93ce-a5770e0384df"
}

Response

{
  "data": {
    "createOnSiteJobsAppointment": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsAppointmentWithoutBooking

Type: CreateOnSiteJobsAppointmentWithoutBooking

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

Create an Appointment on Kraken without making a booking via the booking vendor system. This is typically used by booking vendors to inform Kraken about appointments created on their system.

The possible errors that can be raised are:

  • KT-CT-13032: Request does not exist.
  • KT-CT-13035: Request is inactive.
  • KT-CT-13010: No booking adapter found for agent.
  • KT-CT-13034: Appointment already exists for this request.
  • KT-CT-13021: Invalid job type.
  • KT-CT-13018: Unable to record cancellation_category/cancellation_sub_category.
  • KT-CT-13039: Cancellation fields require CANCELLED status.
  • KT-CT-13027: Booking system error occurred.
  • KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
  • KT-CT-13051: Supply point not found when creating assets.
  • KT-CT-13052: Multiple supply points found when creating assets.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OnSiteJobsCreateAppointmentInput!)

The input objects required to create an Appointment on Kraken without making a booking.

Return fields

Name Description

Mutation

mutation CreateOnSiteJobsAppointmentWithoutBooking($input: OnSiteJobsCreateAppointmentInput!) {
  createOnSiteJobsAppointmentWithoutBooking(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

Variables

{
  "input": OnSiteJobsCreateAppointmentInput
}

Response

{
  "data": {
    "createOnSiteJobsAppointmentWithoutBooking": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsRequest

Type: CreateOnSiteJobsRequest

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

Create a Request.

The possible errors that can be raised are:

  • KT-CT-13002: Supply point not found.
  • KT-CT-13003: Supply points must belong to the same account.
  • KT-CT-13004: No account found for the given supply points.
  • KT-CT-13005: Supply points must belong to the same property.
  • KT-CT-13006: No properties found for the given supply points.
  • KT-CT-13028: Agent not found.
  • KT-CT-13010: No booking adapter found for agent.
  • KT-CT-13007: At least one of the request checks failed.
  • KT-CT-13008: At least one of the request checks has warnings.
  • KT-CT-13009: On site jobs Request already exists.
  • KT-CT-13010: No booking adapter found for agent.
  • KT-CT-13011: Appointment with the given external reference and agent already exists for a different request.
  • KT-CT-13012: Viewer is not allowed to create a request.
  • KT-CT-13013: Reporter post init error.
  • KT-CT-13014: Request reason is not supported.
  • KT-CT-13015: Request sub_reason is not supported.
  • KT-CT-13041: User is not allowed to override request/appointment checks.
  • KT-CT-13042: Multiple supply points not supported by this booking adapter.
  • KT-CT-13045: Failed to update appointment assets.
  • KT-CT-13047: Multiple supply points found.
  • KT-CT-13048: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_ids.
  • KT-CT-13049: Neither supply_point_identifier_to_market_name_mapping nor supply_point_internal_ids provided.
  • KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
  • KT-CT-13051: Supply point not found when creating assets.
  • KT-CT-13052: Multiple supply points found when creating assets.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOnSiteJobsRequestInputType!)

The input objects required to create a Request.

Return fields

Name Description

Mutation

mutation CreateOnSiteJobsRequest($input: CreateOnSiteJobsRequestInputType!) {
  createOnSiteJobsRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsRequest {
      ...OnSiteJobsRequestTypeFragment
    }
  }
}

Variables

{
  "input": CreateOnSiteJobsRequestInputType
}

Response

{
  "data": {
    "createOnSiteJobsRequest": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

createOpportunityAndLead

Type: CreateOpportunityAndLead

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

Create an opportunity and lead with the provided details.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOpportunityAndLeadInput!)

Input fields for creating an opportunity.

Return fields

Name Description

Mutation

mutation CreateOpportunityAndLead($input: CreateOpportunityAndLeadInput!) {
  createOpportunityAndLead(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
    dateOfCreation
    stage
    funnelCode
  }
}

Variables

{
  "input": CreateOpportunityAndLeadInput
}

Response

{
  "data": {
    "createOpportunityAndLead": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "room-table-civil-increase-kid",
      "dateOfCreation": "1979-06-30T22:06:11.563539+00:00",
      "stage": "gun-similar-enter-whose-who",
      "funnelCode": "government-great-process-close-office"
    }
  }
}

Arguments

Name Description

input (CreateOpportunityFileAttachmentInput!)

Input to create an Opportunity File Attachment.

Return fields

Name Description

Mutation

mutation CreateOpportunityFileAttachment($input: CreateOpportunityFileAttachmentInput!) {
  createOpportunityFileAttachment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    result
  }
}

Variables

{
  "input": CreateOpportunityFileAttachmentInput
}

Response

{
  "data": {
    "createOpportunityFileAttachment": {
      "possibleErrors": [PossibleErrorType],
      "result": "president-economy-even-without-man"
    }
  }
}

createOpportunityForLead

Type: CreateOpportunityForLead

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

Create an opportunity for a lead with the provided details.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOpportunityForLeadInput!)

Input fields for creating an opportunity for a lead.

Return fields

Name Description

Mutation

mutation CreateOpportunityForLead($input: CreateOpportunityForLeadInput!) {
  createOpportunityForLead(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
    dateOfCreation
  }
}

Variables

{
  "input": CreateOpportunityForLeadInput
}

Response

{
  "data": {
    "createOpportunityForLead": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "every-company-month-energy-each",
      "dateOfCreation": "2005-06-23T14:11:09.983562+00:00"
    }
  }
}

createOpportunitySolarPanelMarket

Type: CreateOpportunitySolarPanelsMarket

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

Mutation to create opportunity for solar panel.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOpportunitySolarPanelsMarketInput!)

Return fields

Name Description

Mutation

mutation CreateOpportunitySolarPanelMarket($input: CreateOpportunitySolarPanelsMarketInput!) {
  createOpportunitySolarPanelMarket(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    createdAt
    number
  }
}

Variables

{
  "input": CreateOpportunitySolarPanelsMarketInput
}

Response

{
  "data": {
    "createOpportunitySolarPanelMarket": {
      "possibleErrors": [PossibleErrorType],
      "createdAt": "2006-06-24T08:00:16.237443+00:00",
      "number": "candidate-take-others-Democrat-them"
    }
  }
}

createOrUpdateLoyaltyCard

Type: CreateOrUpdateLoyaltyCardMutation

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

Create or update a loyalty card for the given account user.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOrUpdateLoyaltyCardInput!)

Input fields for creating or updating a loyalty card.

Return fields

Name Description

Mutation

mutation CreateOrUpdateLoyaltyCard($input: CreateOrUpdateLoyaltyCardInput!) {
  createOrUpdateLoyaltyCard(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    loyaltyCard {
      ...LoyaltyCardTypeFragment
    }
  }
}

Variables

{
  "input": CreateOrUpdateLoyaltyCardInput
}

Response

{
  "data": {
    "createOrUpdateLoyaltyCard": {
      "possibleErrors": [PossibleErrorType],
      "loyaltyCard": LoyaltyCardType
    }
  }
}

createPaymentActionIntent

Type: CreatePaymentActionIntent

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

Create a new payment action intent.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePaymentActionIntentInput!)

Input fields for creating a payment action intent.

Return fields

Name Description

Mutation

mutation CreatePaymentActionIntent($input: CreatePaymentActionIntentInput!) {
  createPaymentActionIntent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
  }
}

Variables

{
  "input": CreatePaymentActionIntentInput
}

Response

{
  "data": {
    "createPaymentActionIntent": {
      "possibleErrors": [PossibleErrorType],
      "token": "14128955"
    }
  }
}

createPaymentMethod

Type: CreatePaymentMethod

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

Creates a new payment method in Kraken as well as a new customer in GMO.

Arguments

Name Description

input (CreatePaymentMethodInput)

Return fields

Name Description

Mutation

mutation CreatePaymentMethod($input: CreatePaymentMethodInput) {
  createPaymentMethod(input: $input) {
    reference
  }
}

Variables

{
  "input": CreatePaymentMethodInput
}

Response

{
  "data": {
    "createPaymentMethod": {
      "reference": "finally-improve-family-size-current"
    }
  }
}

Arguments

Name Description

input (PaymentScheduleInput!)

Return fields

Name Description

Mutation

mutation CreatePaymentSchedule($input: PaymentScheduleInput!) {
  createPaymentSchedule(input: $input)
}

Variables

{
  "input": PaymentScheduleInput
}

Response

{
  "data": {
    "createPaymentSchedule": CreatePaymentScheduleResponse
  }
}

createPortfolio

Type: CreatePortfolio

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

Mutation to create a new Portfolio instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePortfolioInput)

Input fields for creating a portfolio.

Return fields

Name Description

Mutation

mutation CreatePortfolio($input: CreatePortfolioInput) {
  createPortfolio(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
  }
}

Variables

{
  "input": CreatePortfolioInput
}

Response

{
  "data": {
    "createPortfolio": {
      "possibleErrors": [PossibleErrorType],
      "portfolio": PortfolioType
    }
  }
}

createPortfolioUserRole

Type: CreatePortfolioUserRole

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

Mutation to create a new portfolio user role. This will effectively link the user to the portfolio giving them all the permissions enabled for the specific role.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePortfolioUserRoleInput)

Input fields for connecting a user to a portfolio.

Return fields

Name Description

Mutation

mutation CreatePortfolioUserRole($input: CreatePortfolioUserRoleInput) {
  createPortfolioUserRole(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    portfolioUserRole {
      ...PortfolioUserRoleTypeFragment
    }
  }
}

Variables

{
  "input": CreatePortfolioUserRoleInput
}

Response

{
  "data": {
    "createPortfolioUserRole": {
      "possibleErrors": [PossibleErrorType],
      "portfolioUserRole": PortfolioUserRoleType
    }
  }
}

createPostEvents

Type: CreatePostEvents

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

Create post delivery events from external vendors.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePostEventsInput!)

Batch of post events to create.

Return fields

Name Description

Mutation

mutation CreatePostEvents($input: CreatePostEventsInput!) {
  createPostEvents(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    createdEventsCount
  }
}

Variables

{
  "input": CreatePostEventsInput
}

Response

{
  "data": {
    "createPostEvents": {
      "possibleErrors": [PossibleErrorType],
      "createdEventsCount": 57
    }
  }
}

createProduct

Type: CreateProductOutput!

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

Create a new product.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateProductInput!)

Return fields

Name Description

Mutation

mutation CreateProduct($input: CreateProductInput!) {
  createProduct(input: $input) {
    product {
      ...SupplyProductTypeFragment
    }
  }
}

Variables

{
  "input": CreateProductInput
}

Response

{
  "data": {
    "createProduct": {
      "product": SupplyProductType
    }
  }
}

createQuoteForAccount

Type: CreateQuoteForAccount

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

Create a quote for switching product.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateQuoteForAccountInput!)

Return fields

Name Description

Mutation

mutation CreateQuoteForAccount($input: CreateQuoteForAccountInput!) {
  createQuoteForAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...MarketSupplyQuoteRequestTypeFragment
    }
  }
}

Variables

{
  "input": CreateQuoteForAccountInput
}

Response

{
  "data": {
    "createQuoteForAccount": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": MarketSupplyQuoteRequestType
    }
  }
}

createReferral

Type: CreateReferral

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

Create an account referral using an email address, personal link or code.This is for customers to refer other customers so it only works with friend referrals and not partner referrals.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateReferralInput!)

Input fields for creating a referral.

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateReferralInput
}

Response

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

createReminder

Type: CreateReminder

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

Create an account reminder.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateReminderInput!)

Input variables needed for creating an account reminder.

Return fields

Name Description

Mutation

mutation CreateReminder($input: CreateReminderInput!) {
  createReminder(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    reminder {
      ...ReminderFragment
    }
  }
}

Variables

{
  "input": CreateReminderInput
}

Response

{
  "data": {
    "createReminder": {
      "possibleErrors": [PossibleErrorType],
      "reminder": Reminder
    }
  }
}

createScheduledTransactions

Type: CreateScheduledTransactions

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

Create scheduled transactions.

The possible errors that can be raised are:

Arguments

Name Description

input ([CreateScheduledTransactionsInput]!)

Input fields to create scheduled transactions.

Return fields

Name Description

Mutation

mutation CreateScheduledTransactions($input: [CreateScheduledTransactionsInput]!) {
  createScheduledTransactions(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    scheduledTransactions {
      ...ScheduledTransactionTypeFragment
    }
  }
}

Variables

{
  "input": CreateScheduledTransactionsInput
}

Response

{
  "data": {
    "createScheduledTransactions": {
      "possibleErrors": [PossibleErrorType],
      "scheduledTransactions": [ScheduledTransactionType]
    }
  }
}

Arguments

Name Description

input (CreateShellAccountInput!)

Return fields

Name Description

Mutation

mutation CreateShellAccount($input: CreateShellAccountInput!) {
  createShellAccount(input: $input) {
    portfolioNumber
    givenName
    familyName
    billingName
    email
    mobile
    landline
    brand
    dateOfBirth
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingPostcode
    billingRichAddress
    billingPeriodLength
    billingPeriodMultiplier
    billingPeriodDay
    billingPeriodMonth
    isBusinessAccount
    companyName
    companyNumber
    businessType
    password
    passwordUpdateToken
    urn
    errors {
      ...ErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
    clientMutationId
  }
}

Variables

{
  "input": CreateShellAccountInput
}

Response

{
  "data": {
    "createShellAccount": {
      "portfolioNumber": "P-7C130CC5",
      "givenName": "Amy",
      "familyName": "White",
      "billingName": "machine-near-court-continue-nothing",
      "email": "fly-measure-season-seat-cultural",
      "mobile": "subject-station-the-difference-position",
      "landline": "drug-responsibility-occur-travel-pattern",
      "brand": "interest-successful-not-her-professor",
      "dateOfBirth": "2010-05-23",
      "billingAddressLine1": "set-type-compare-himself-choice",
      "billingAddressLine2": "turn-boy-more-my-professional",
      "billingAddressLine3": "coach-discuss-at-food-arrive",
      "billingAddressLine4": "by-century-talk-shoulder-however",
      "billingAddressLine5": "hot-usually-year-this-clearly",
      "billingPostcode": "crime-north-environment-herself-amount",
      "billingRichAddress": "loss-whom-ball-serve-those",
      "billingPeriodLength": "tend-deep-per-ability-security",
      "billingPeriodMultiplier": 31,
      "billingPeriodDay": 20,
      "billingPeriodMonth": 92,
      "isBusinessAccount": true,
      "companyName": "tax-pull-of-popular-maybe",
      "companyNumber": "course-head-per-admit-sister",
      "businessType": "short-then-say-fast-federal",
      "password": "wife-list-grow-development-throughout",
      "passwordUpdateToken": "tend-particular-who-his-official",
      "urn": "city-their-toward-world-effect",
      "errors": [ErrorType],
      "account": AccountInterface,
      "clientMutationId": "91169003"
    }
  }
}

createTemplate

Type: CreateTemplateOutput!

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

Create a new template.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateTemplateInput!)

Return fields

Name Description

Mutation

mutation CreateTemplate($input: CreateTemplateInput!) {
  createTemplate(input: $input) {
    template {
      ...TemplateTypeFragment
    }
  }
}

Variables

{
  "input": CreateTemplateInput
}

Response

{
  "data": {
    "createTemplate": {
      "template": TemplateType
    }
  }
}

createTimeSeriesPrices

Type: CreateTimeSeriesPrices!

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

Create time series based prices.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateTimeSeriesPricesInput!)

The time series input for price creation.

Return fields

Name Description

Mutation

mutation CreateTimeSeriesPrices($input: CreateTimeSeriesPricesInput!) {
  createTimeSeriesPrices(input: $input) {
    code
    productCode
    name
    description
    unit
    periodSize
    meta
    variants {
      ...VariantProfileFragment
    }
  }
}

Variables

{
  "input": CreateTimeSeriesPricesInput
}

Response

{
  "data": {
    "createTimeSeriesPrices": {
      "code": "performance-most-window-ago-quality",
      "productCode": "certainly-church-police-another-teacher",
      "name": "dream-culture-all-during-director",
      "description": "certainly-arm-near-itself-alone",
      "unit": "travel-section-determine-number-wind",
      "periodSize": "real-exactly-up-hard-factor",
      "meta": {"key": "value"},
      "variants": VariantProfile
    }
  }
}

deauthenticateDevice

Type: DeauthenticateDevice

URL: https://api.oejp-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-4352: This device cannot currently be de-authenticated.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DeAuthenticationInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": DeAuthenticationInput
}

Response

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

deauthenticateFlexDevice

Type: DeauthenticateFlexDevice

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

De-authenticate a device by device id.

The possible errors that can be raised are:

  • KT-CT-4350: Unable to de-authenticate device.
  • KT-CT-4352: This device cannot currently be de-authenticated.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DeauthenticateFlexDeviceInput)

Return fields

Name Description

Mutation

mutation DeauthenticateFlexDevice($input: DeauthenticateFlexDeviceInput) {
  deauthenticateFlexDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...DeviceDetailsTypeFragment
    }
  }
}

Variables

{
  "input": DeauthenticateFlexDeviceInput
}

Response

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

deductLoyaltyPoints

Type: DeductLoyaltyPoints

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

Deduct the passed number of Loyalty Points from the account.

The possible errors that can be raised are:

Arguments

Name Description

input (DeductLoyaltyPointsInput!)

Input fields for deducting Loyalty Points.

Return fields

Name Description

Mutation

mutation DeductLoyaltyPoints($input: DeductLoyaltyPointsInput!) {
  deductLoyaltyPoints(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsDeducted
    ledgerEntry {
      ...LoyaltyPointLedgerEntryTypeFragment
    }
  }
}

Variables

{
  "input": DeductLoyaltyPointsInput
}

Response

{
  "data": {
    "deductLoyaltyPoints": {
      "possibleErrors": [PossibleErrorType],
      "pointsDeducted": 80,
      "ledgerEntry": LoyaltyPointLedgerEntryType
    }
  }
}

deleteAccountReference

Type: DeleteAccountReference

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

Delete an account reference.

The possible errors that can be raised are:

Arguments

Name Description

input (DeleteAccountReferenceInput!)

Input fields for removing an account reference.

Return fields

Name Description

Mutation

mutation DeleteAccountReference($input: DeleteAccountReferenceInput!) {
  deleteAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...DeleteAccountReferenceTypeFragment
    }
  }
}

Variables

{
  "input": DeleteAccountReferenceInput
}

Response

{
  "data": {
    "deleteAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": DeleteAccountReferenceType
    }
  }
}

deleteBoostCharge

Type: DeleteBoostCharge

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

Stop any active boost charging.

The possible errors that can be raised are:

Arguments

Name Description

input (DeleteBoostChargeInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": DeleteBoostChargeInput
}

Response

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

deleteCatalogInput

Type: DeleteInputOutput!

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

Delete a catalog input.

The possible errors that can be raised are:

Arguments

Name Description

identifier (ID!)

The identifier of the input to delete.

Return fields

Name Description

Mutation

mutation DeleteCatalogInput($identifier: ID!) {
  deleteCatalogInput(identifier: $identifier) {
    deletedIdentifier
  }
}

Variables

{
  "identifier": "48036007"
}

Response

{
  "data": {
    "deleteCatalogInput": {
      "deletedIdentifier": "36021985"
    }
  }
}

deleteMfaDevice

Type: DeleteMfaDevice

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

Delete MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": DeleteMfaDeviceInputType
}

Response

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

deletePushNotificationBinding

Type: DeletePushNotificationBinding

URL: https://api.oejp-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

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

Variables

{
  "input": DeletePushNotificationBindingInput
}

Response

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

deleteTemplate

Type: DeleteTemplateOutput!

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

Delete a draft template.

The possible errors that can be raised are:

Arguments

Name Description

identifier (ID!)

The identifier of the template to delete.

Return fields

Name Description

Mutation

mutation DeleteTemplate($identifier: ID!) {
  deleteTemplate(identifier: $identifier) {
    deletedIdentifier
  }
}

Variables

{
  "identifier": "24383251"
}

Response

{
  "data": {
    "deleteTemplate": {
      "deletedIdentifier": "10905387"
    }
  }
}

deviceRegistration

Type: DeviceRegistration

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

Register a device (EV, battery or heat pump) for smart control.

The possible errors that can be raised are:

Arguments

Name Description

input (DeviceRegistrationInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": DeviceRegistrationInput
}

Response

{
  "data": {
    "deviceRegistration": {
      "possibleErrors": [PossibleErrorType],
      "registeredDeviceIds": ["create-house-audience-reflect-space"]
    }
  }
}

emailQuote

Type: EmailQuote

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

Email quote

The possible errors that can be raised are:

Arguments

Name Description

input (EmailQuoteInput!)

Return fields

Name Description

Mutation

mutation EmailQuote($input: EmailQuoteInput!) {
  emailQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    sent
  }
}

Variables

{
  "input": EmailQuoteInput
}

Response

{
  "data": {
    "emailQuote": {
      "possibleErrors": [PossibleErrorType],
      "sent": true
    }
  }
}

endContributionAgreement

Type: EndContributionAgreement

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

End a contribution agreement for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (EndContributionAgreementInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": EndContributionAgreementInput
}

Response

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

enqueueInboundCall

Type: EnqueueInboundCall

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

The possible errors that can be raised are:

Arguments

Name Description

input (EnqueueInboundCallInput!)

Return fields

Name Description

Mutation

mutation EnqueueInboundCall($input: EnqueueInboundCallInput!) {
  enqueueInboundCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

Variables

{
  "input": EnqueueInboundCallInput
}

Response

{
  "data": {
    "enqueueInboundCall": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

enrollAccountInLoyaltyProgram

Type: EnrollAccountInLoyaltyProgram

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

Enroll users account in Loyalty program.

The possible errors that can be raised are:

Arguments

Name Description

input (EnrollAccountInLoyaltyProgramInput!)

The account number to enroll in the loyalty program.

Return fields

Name Description

Mutation

mutation EnrollAccountInLoyaltyProgram($input: EnrollAccountInLoyaltyProgramInput!) {
  enrollAccountInLoyaltyProgram(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    outcome {
      ...EnrollAccountInLoyaltyProgramOutcomeFragment
    }
  }
}

Variables

{
  "input": EnrollAccountInLoyaltyProgramInput
}

Response

{
  "data": {
    "enrollAccountInLoyaltyProgram": {
      "possibleErrors": [PossibleErrorType],
      "outcome": EnrollAccountInLoyaltyProgramOutcome
    }
  }
}

enrollment

Type: EnrollmentInitiated!

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

Initiate an enrollment for an account and a set of supply points.

The possible errors that can be raised are:

Arguments

Name Description

input (EnrollmentInput!)

The Enrollment Input data for the Join Supplier.

Return fields

Name Description

Mutation

mutation Enrollment($input: EnrollmentInput!) {
  enrollment(input: $input) {
    enrollmentProcesses
    message
  }
}

Variables

{
  "input": EnrollmentInput
}

Response

{
  "data": {
    "enrollment": {
      "enrollmentProcesses": EnrollmentProcess,
      "message": "just-rich-hotel-challenge-concern"
    }
  }
}

estimateUsage

Type: EstimateUsage

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

Returns an estimation of average monthly electricity usage in kWh

Arguments

Name Description

input (EstimateUsageInputType!)

Return fields

Name Description

Mutation

mutation EstimateUsage($input: EstimateUsageInputType!) {
  estimateUsage(input: $input) {
    usageEstimate
  }
}

Variables

{
  "input": EstimateUsageInputType
}

Response

{
  "data": {
    "estimateUsage": {
      "usageEstimate": 14
    }
  }
}

expireTemplates

Type: ExpireTemplatesOutput!

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

Expire one or more active templates.

The possible errors that can be raised are:

Arguments

Name Description

identifiers ([ID!]!)

The identifiers of the templates to expire.

Return fields

Name Description

Mutation

mutation ExpireTemplates($identifiers: [ID!]!) {
  expireTemplates(identifiers: $identifiers) {
    expiredIdentifiers
  }
}

Variables

{
  "identifiers": "94245483"
}

Response

{
  "data": {
    "expireTemplates": {
      "expiredIdentifiers": "that-candidate-clear-player-growth"
    }
  }
}

fetchElectricityGenerationPointDetails

Type: FetchElectricityGenerationPointDetails

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

Poll OCCTO using the Generation Point Identification Number.

The possible errors that can be raised are:

  • KT-JP-4602: Quoted electricity supply points cannot be found.
  • KT-JP-4606: GPIN does not exist on OCCTO.
  • KT-JP-4603: OCCTO could not process the request.
  • KT-JP-4607: An unexpected error occurred when trying to fetch GPIN details.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FetchElectricityGenerationPointDetailsInput!)

Return fields

Name Description

Mutation

mutation FetchElectricityGenerationPointDetails($input: FetchElectricityGenerationPointDetailsInput!) {
  fetchElectricityGenerationPointDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteFragment
    }
    quotedSupplyPoint {
      ...QuotedElectricityGenerationPointFragment
    }
  }
}

Variables

{
  "input": FetchElectricityGenerationPointDetailsInput
}

Response

{
  "data": {
    "fetchElectricityGenerationPointDetails": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": Quote,
      "quotedSupplyPoint": QuotedElectricityGenerationPoint
    }
  }
}

fetchElectricitySupplyPointDetails

Type: FetchElectricitySupplyPointDetails

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

Poll OCCTO using the Supply Point Identification Number.

The possible errors that can be raised are:

  • KT-JP-4602: Quoted electricity supply points cannot be found.
  • KT-JP-4604: SPIN does not exist on OCCTO.
  • KT-JP-4603: OCCTO could not process the request.
  • KT-JP-4605: An unexpected error occurred when trying to fetch SPIN details.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FetchElectricitySupplyPointDetailsInput!)

Return fields

Name Description

Mutation

mutation FetchElectricitySupplyPointDetails($input: FetchElectricitySupplyPointDetailsInput!) {
  fetchElectricitySupplyPointDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteFragment
    }
    quotedSupplyPoint {
      ...QuotedElectricitySupplyPointFragment
    }
  }
}

Variables

{
  "input": FetchElectricitySupplyPointDetailsInput
}

Response

{
  "data": {
    "fetchElectricitySupplyPointDetails": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": Quote,
      "quotedSupplyPoint": QuotedElectricitySupplyPoint
    }
  }
}

fetchGeneratePaymentFingerprint

Type: FetchGeneratePaymentFingerprint

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

Fetch or generate payment fingerprint from vendor.

The possible errors that can be raised are:

Arguments

Name Description

input (FetchGeneratePaymentFingerprintInput!)

Return fields

Name Description

Mutation

mutation FetchGeneratePaymentFingerprint($input: FetchGeneratePaymentFingerprintInput!) {
  fetchGeneratePaymentFingerprint(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    fingerprint
    vendor
  }
}

Variables

{
  "input": FetchGeneratePaymentFingerprintInput
}

Response

{
  "data": {
    "fetchGeneratePaymentFingerprint": {
      "possibleErrors": [PossibleErrorType],
      "fingerprint": "west-yes-hour-between-would",
      "vendor": "language-early-painting-cold-very"
    }
  }
}

fetchPreSignedLinkForOpportunityAttachment

Type: FetchPreSignedLinkForOpportunityAttachment

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

Fetch a pre-signed link for an opportunity file attachment.

The possible errors that can be raised are:

Arguments

Name Description

input (FetchPreSignedLinkForOpportunityAttachmentInput!)

Input fields for fetching a pre-signed link for an opportunity file attachment.

Return fields

Name Description

Mutation

mutation FetchPreSignedLinkForOpportunityAttachment($input: FetchPreSignedLinkForOpportunityAttachmentInput!) {
  fetchPreSignedLinkForOpportunityAttachment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityFileAttachment {
      ...OpportunityFileAttachmentFragment
    }
  }
}

Variables

{
  "input": FetchPreSignedLinkForOpportunityAttachmentInput
}

Response

{
  "data": {
    "fetchPreSignedLinkForOpportunityAttachment": {
      "possibleErrors": [PossibleErrorType],
      "opportunityFileAttachment": OpportunityFileAttachment
    }
  }
}

forceReauthentication

Type: ForceReauthentication

URL: https://api.oejp-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

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

Variables

{
  "input": ForceReauthenticationInput
}

Response

{
  "data": {
    "forceReauthentication": {
      "tokensInvalidated": true,
      "effectiveAt": "2000-04-20T20:23:14.824225+00:00"
    }
  }
}

Arguments

Name Description

input (GenerateAffiliatesAudioRecordingPreSignedUrlInput!)

Input fields for creating a pre-signed URL for uploading an audio file to S3.

Return fields

Name Description

Mutation

mutation GenerateAffiliatesAudioRecordingPreSignedUrl($input: GenerateAffiliatesAudioRecordingPreSignedUrlInput!) {
  generateAffiliatesAudioRecordingPreSignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliatesAudioRecordingPreSignedUrl {
      ...AffiliateAudioRecordingPresignedPostTypeFragment
    }
  }
}

Variables

{
  "input": GenerateAffiliatesAudioRecordingPreSignedUrlInput
}

Response

{
  "data": {
    "generateAffiliatesAudioRecordingPreSignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "affiliatesAudioRecordingPreSignedUrl": AffiliateAudioRecordingPresignedPostType
    }
  }
}

generateCreditCardToken

Type: GenerateCreditCardToken

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

Generate a token for storing credit card details.

Return fields

Name Description

Mutation

mutation GenerateCreditCardToken {
  generateCreditCardToken {
    creditCardToken
  }
}

Response

{
  "data": {
    "generateCreditCardToken": {
      "creditCardToken": "else-environment-kid-visit-course"
    }
  }
}

generateInkPresignedUrl

Type: GenerateInkPresignedUrl

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

The possible errors that can be raised are:

Arguments

Name Description

input (GenerateInkPresignedUrlInput)

Return fields

Name Description

Mutation

mutation GenerateInkPresignedUrl($input: GenerateInkPresignedUrlInput) {
  generateInkPresignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    uploadUrl
    key
    fields
  }
}

Variables

{
  "input": GenerateInkPresignedUrlInput
}

Response

{
  "data": {
    "generateInkPresignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "uploadUrl": "certain-can-number-bring-off",
      "key": "perform-several-staff-difference-style",
      "fields": {"key": "value"}
    }
  }
}

Arguments

Name Description

input (GenerateLeadsFileAttachmentPreSignedUrlInput!)

Input fields for creating a pre-signed URL for uploading a lead file attachment file to S3.

Return fields

Name Description

Mutation

mutation GenerateLeadsFileAttachmentPreSignedUrl($input: GenerateLeadsFileAttachmentPreSignedUrlInput!) {
  generateLeadsFileAttachmentPreSignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    leadsFileAttachmentPreSignedUrl {
      ...LeadsFileAttachmentPresignedPostTypeFragment
    }
  }
}

Variables

{
  "input": GenerateLeadsFileAttachmentPreSignedUrlInput
}

Response

{
  "data": {
    "generateLeadsFileAttachmentPreSignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "leadsFileAttachmentPreSignedUrl": LeadsFileAttachmentPresignedPostType
    }
  }
}

generatePreSignedToken

Type: GeneratePreSignedToken

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

Generate a pre-signed token with a set expiry time.

The possible errors that can be raised are:

Arguments

Name Description

email (String!)

numberOfDaysAllowed (Int!)

The number of days that the token will be available for authentication (From now on).

scope (PreSignedTokenScope!)

Define (and limit) the scope of the token.

Return fields

Name Description

Mutation

mutation GeneratePreSignedToken(
  $email: String!,
  $numberOfDaysAllowed: Int!,
  $scope: PreSignedTokenScope!
) {
  generatePreSignedToken(
    email: $email,
    numberOfDaysAllowed: $numberOfDaysAllowed,
    scope: $scope
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
    tokenExpiryDatetime
    scope
  }
}

Variables

{
  "email": "item-century-so-yes-others",
  "numberOfDaysAllowed": 25,
  "scope": "SUBMIT_METER_READINGS"
}

Response

{
  "data": {
    "generatePreSignedToken": {
      "possibleErrors": [PossibleErrorType],
      "token": "hundred-military-all-moment-baby",
      "tokenExpiryDatetime": "2004-11-24T00:26:29.526852+00:00",
      "scope": "SUBMIT_METER_READINGS"
    }
  }
}

getEmbeddedSecretForNewPaymentInstruction

Type: GetEmbeddedSecretForNewPaymentInstruction

URL: https://api.oejp-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:

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

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

Variables

{
  "input": GetEmbeddedSecretForNewPaymentInstructionInput
}

Response

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "western-child-anything-choose-cell"
    }
  }
}

getEmbeddedSecretForNewPaymentInstructionWithoutAccount

Type: GetEmbeddedSecretForNewPaymentInstructionWithoutAccount

URL: https://api.oejp-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

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

Variables

{
  "input": GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
}

Response

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "his-task-total-avoid-least"
    }
  }
}

getHostedUrlForNewPaymentInstruction

Type: GetHostedUrlForNewPaymentInstruction

URL: https://api.oejp-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:

Arguments

Name Description

input (GetHostedUrlForNewPaymentInstructionInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": GetHostedUrlForNewPaymentInstructionInput
}

Response

{
  "data": {
    "getHostedUrlForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "url": "wait-trade-change-television-note"
    }
  }
}

grantUserAccessToBusiness

Type: GrantUserAccessToBusiness

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

Grant user access to the business using the provided role.

The possible errors that can be raised are:

Arguments

Name Description

input (GrantUserAccessToBusinessInput!)

Return fields

Name Description

Mutation

mutation GrantUserAccessToBusiness($input: GrantUserAccessToBusinessInput!) {
  grantUserAccessToBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": GrantUserAccessToBusinessInput
}

Response

{
  "data": {
    "grantUserAccessToBusiness": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

initializeAccount

Type: InitializeAccountResult!

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

Initialize account for sign up. Returns the existing account if matching datafound for the provided input, otherwise creates a new account.

The possible errors that can be raised are:

Arguments

Name Description

input (BaseInitializeAccountInput!)

Return fields

Name Description

Mutation

mutation InitializeAccount($input: BaseInitializeAccountInput!) {
  initializeAccount(input: $input) {
    isNewAccount
    accountNumber
  }
}

Variables

{
  "input": BaseInitializeAccountInput
}

Response

{
  "data": {
    "initializeAccount": {
      "isNewAccount": true,
      "accountNumber": "A-4B54C4BC"
    }
  }
}

initializeUser

Type: InitializeUserResult!

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

Initialize user for sign up. Returns an existing user if matching datafound for the provided input, otherwise creates a new one.

The possible errors that can be raised are:

Arguments

Name Description

input (BaseInitializeUserInput!)

Return fields

Name Description

Mutation

mutation InitializeUser($input: BaseInitializeUserInput!) {
  initializeUser(input: $input) {
    isNewUser
    userNumber
  }
}

Variables

{
  "input": BaseInitializeUserInput
}

Response

{
  "data": {
    "initializeUser": {
      "isNewUser": true,
      "userNumber": "shake-including-against-simply-resource"
    }
  }
}

initiateAmperageChange

Type: InitiateAmperageChangeResponse!

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

Initiate amperage change procedure.

The possible errors that can be raised are:

Arguments

Name Description

input (InitiateAmperageChangeInput!)

Return fields

Name Description

Mutation

mutation InitiateAmperageChange($input: InitiateAmperageChangeInput!) {
  initiateAmperageChange(input: $input)
}

Variables

{
  "input": InitiateAmperageChangeInput
}

Response

{
  "data": {
    "initiateAmperageChange": InitiateAmperageChangeResponse
  }
}

initiateHostedStandalonePayment

Type: InitiateHostedStandalonePayment

URL: https://api.oejp-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:

Arguments

Name Description

input (InitiateHostedStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

Mutation

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

Variables

{
  "input": InitiateHostedStandalonePaymentInput
}

Response

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

initiateMoveIn

Type: InitiateMoveInResponse!

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

Initiate move in procedure.

The possible errors that can be raised are:

  • KT-JP-3903: Unable to create payment customer.
  • KT-JP-4103: Please set a password for the user before creating a new one using the same information.
  • KT-JP-4105: Unable to reactivate account.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateMoveInInput!)

Return fields

Name Description

Mutation

mutation InitiateMoveIn($input: InitiateMoveInInput!) {
  initiateMoveIn(input: $input)
}

Variables

{
  "input": InitiateMoveInInput
}

Response

{
  "data": {
    "initiateMoveIn": InitiateMoveInResponse
  }
}

initiateMoveOut

Type: InitiateMoveOutResponse!

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

Initiate move out procedure.

The possible errors that can be raised are:

  • KT-JP-4103: Please set a password for the user before creating a new one using the same information.
  • KT-JP-4551: Move out can't be processed.
  • KT-JP-6601: Active move-in request already exists.
  • KT-JP-6602: Active Export move-out request already exists.
  • KT-JP-1501: Active agreement not found.
  • KT-JP-7801: Unknown error occurred.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateMoveOutInput!)

Return fields

Name Description

Mutation

mutation InitiateMoveOut($input: InitiateMoveOutInput!) {
  initiateMoveOut(input: $input)
}

Variables

{
  "input": InitiateMoveOutInput
}

Response

{
  "data": {
    "initiateMoveOut": InitiateMoveOutResponse
  }
}

initiateMoveOutAndMoveIn

Type: InitiateMoveOutAndMoveInResponse!

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

Initiate a synchronous move-out and move-in.

The possible errors that can be raised are:

  • KT-JP-3903: Unable to create payment customer.
  • KT-JP-4101: Unauthorized.
  • KT-JP-4103: Please set a password for the user before creating a new one using the same information.
  • KT-JP-4105: Unable to reactivate account.
  • KT-JP-6601: Active move-in request already exists.
  • KT-JP-1501: Active agreement not found.
  • KT-JP-7801: Unknown error occurred.
  • KT-CT-4411: Address in db is structured, cannot accept unstructured address fields.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (InitiateMoveOutAndMoveInInput!)

Return fields

Name Description

Mutation

mutation InitiateMoveOutAndMoveIn($input: InitiateMoveOutAndMoveInInput!) {
  initiateMoveOutAndMoveIn(input: $input)
}

Variables

{
  "input": InitiateMoveOutAndMoveInInput
}

Response

{
  "data": {
    "initiateMoveOutAndMoveIn": InitiateMoveOutAndMoveInResponse
  }
}

initiateProductSwitch

Type: InitiateProductSwitch

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

Do a product switch for a user.

The possible errors that can be raised are:

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

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

Variables

{
  "input": InitiateProductSwitchInput
}

Response

{
  "data": {
    "initiateProductSwitch": {
      "possibleErrors": [PossibleErrorType],
      "productCode": "Democrat-perhaps-crime-already-film",
      "switchDate": "2012-05-15"
    }
  }
}

initiateStandalonePayment

Type: InitiateStandalonePayment

URL: https://api.oejp-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:

Arguments

Name Description

input (InitiateStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

Mutation

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

Variables

{
  "input": InitiateStandalonePaymentInput
}

Response

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

initiateSwitchIn

Type: InitiateSwitchIn

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

Create an account and initiate a switch-in for the account.

The possible errors that can be raised are:

  • KT-JP-3902: Payment instruction creation using the same card number on the same day is not allowed.
  • KT-JP-3903: Unable to create payment customer.
  • KT-JP-3904: Unable to change card with token.
  • KT-JP-4103: Please set a password for the user before creating a new one using the same information.
  • KT-JP-4104: Unable to create account for user.
  • KT-JP-4105: Unable to reactivate account.
  • KT-JP-4106: Unable to create account due to schedule conflict.
  • KT-JP-4504: Please fill in correct SPIN which is registered in OCCTO.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateSwitchInInput)

Return fields

Name Description

Mutation

mutation InitiateSwitchIn($input: InitiateSwitchInInput) {
  initiateSwitchIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountNumber
    token
    userId
    hasUsablePassword
    hashedAccountApplicationId
  }
}

Variables

{
  "input": InitiateSwitchInInput
}

Response

{
  "data": {
    "initiateSwitchIn": {
      "possibleErrors": [PossibleErrorType],
      "accountNumber": "A-0B9FDAEC",
      "token": "car-threat-nor-attention-front",
      "userId": "69848039",
      "hasUsablePassword": true,
      "hashedAccountApplicationId": "43646891"
    }
  }
}

instigateContractTermination

Type: ContractTerminationInstigated!

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

Instigate a contract termination journey.

The possible errors that can be raised are:

Arguments

Name Description

input (BaseInstigateContractTerminationInput!)

Return fields

Name Description

Mutation

mutation InstigateContractTermination($input: BaseInstigateContractTerminationInput!) {
  instigateContractTermination(input: $input) {
    message
  }
}

Variables

{
  "input": BaseInstigateContractTerminationInput
}

Response

{
  "data": {
    "instigateContractTermination": {
      "message": "which-in-sister-education-hospital"
    }
  }
}

instigateContractVariation

Type: InstigateContractVariationOutput!

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

Instigate a contract variation journey.

The possible errors that can be raised are:

Arguments

Name Description

input (InstigateContractVariationInput!)

Return fields

Name Description

Mutation

mutation InstigateContractVariation($input: InstigateContractVariationInput!) {
  instigateContractVariation(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": InstigateContractVariationInput
}

Response

{
  "data": {
    "instigateContractVariation": {
      "contract": Contract
    }
  }
}

instigateLeaveSupplier

Type: LeaveSupplierInstigated!

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

Instigate a leave supplier process or update an existing process.

The possible errors that can be raised are:

Arguments

Name Description

input (LeaveSupplierInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": LeaveSupplierInput
}

Response

{
  "data": {
    "instigateLeaveSupplier": {
      "number": "42026806",
      "leaveSupplierProcessId": "16300386",
      "message": "feel-national-reach-company-leader"
    }
  }
}

invalidatePaymentInstruction

Type: InvalidatePaymentInstruction

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

Invalidate an existing instruction.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidatePaymentInstructionInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": InvalidatePaymentInstructionInput
}

Response

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

invalidatePreSignedToken

Type: InvalidatePreSignedToken

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

Invalidate a previously-issued pre-signed token.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidatePreSignedTokenInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": InvalidatePreSignedTokenInput
}

Response

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

invalidatePreSignedTokensForUser

Type: InvalidatePreSignedTokensForUser

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

Invalidate pre-signed tokens issued to a particular user.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidatePreSignedTokensForUserInput!)

Return fields

Name Description

Mutation

mutation InvalidatePreSignedTokensForUser($input: InvalidatePreSignedTokensForUserInput!) {
  invalidatePreSignedTokensForUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    tokens {
      ...PreSignedTokenFragment
    }
  }
}

Variables

{
  "input": InvalidatePreSignedTokensForUserInput
}

Response

{
  "data": {
    "invalidatePreSignedTokensForUser": {
      "possibleErrors": [PossibleErrorType],
      "tokens": [PreSignedToken]
    }
  }
}

invalidateRefreshToken

Type: InvalidateRefreshToken

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

Invalidate a previously-issued refresh token.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidateRefreshTokenInput!)

Return fields

Name Description

Mutation

mutation InvalidateRefreshToken($input: InvalidateRefreshTokenInput!) {
  invalidateRefreshToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...RefreshTokenFragment
    }
  }
}

Variables

{
  "input": InvalidateRefreshTokenInput
}

Response

{
  "data": {
    "invalidateRefreshToken": {
      "possibleErrors": [PossibleErrorType],
      "token": RefreshToken
    }
  }
}

invalidateRefreshTokensForUser

Type: InvalidateRefreshTokensForUser

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

Invalidate refresh tokens issued to a particular user.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidateRefreshTokensForUserInput!)

Return fields

Name Description

Mutation

mutation InvalidateRefreshTokensForUser($input: InvalidateRefreshTokensForUserInput!) {
  invalidateRefreshTokensForUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    tokens {
      ...RefreshTokenFragment
    }
  }
}

Variables

{
  "input": InvalidateRefreshTokensForUserInput
}

Response

{
  "data": {
    "invalidateRefreshTokensForUser": {
      "possibleErrors": [PossibleErrorType],
      "tokens": [RefreshToken]
    }
  }
}

joinSupplierAcceptTermsAndConditions

Type: JoinSupplierAcceptTermsAndConditions

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

Accept terms and conditions for a join supplier process.

The possible errors that can be raised are:

Arguments

Name Description

input (JoinSupplierAcceptTermsAndConditionsInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": JoinSupplierAcceptTermsAndConditionsInput
}

Response

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

legacyProcessOrder

Type: ProcessOrderOutput!

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

Process an Order (legacy)

The possible errors that can be raised are:

Arguments

Name Description

input (LegacyProcessOrderInput!)

Return fields

Name Description

Mutation

mutation LegacyProcessOrder($input: LegacyProcessOrderInput!) {
  legacyProcessOrder(input: $input) {
    status
    identifier
    resources {
      ...OrderResourceFragment
    }
  }
}

Variables

{
  "input": LegacyProcessOrderInput
}

Response

{
  "data": {
    "legacyProcessOrder": {
      "status": "PENDING",
      "identifier": "68098238",
      "resources": [OrderResource]
    }
  }
}

linkAccountToBusiness

Type: LinkAccountToBusiness

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

Link an account to a business.

The possible errors that can be raised are:

Arguments

Name Description

input (LinkAccountToBusinessInput!)

Input fields for linking an account to a business.

Return fields

Name Description

Mutation

mutation LinkAccountToBusiness($input: LinkAccountToBusinessInput!) {
  linkAccountToBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    business {
      ...BusinessTypeFragment
    }
  }
}

Variables

{
  "input": LinkAccountToBusinessInput
}

Response

{
  "data": {
    "linkAccountToBusiness": {
      "possibleErrors": [PossibleErrorType],
      "business": BusinessType
    }
  }
}

linkUserToLine

Type: LinkUserToLineResponse!

URL: https://api.oejp-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

mutation LinkUserToLine($input: LinkUserToLineInput!) {
  linkUserToLine(input: $input)
}

Variables

{
  "input": LinkUserToLineInput
}

Response

{
  "data": {
    "linkUserToLine": LinkUserToLineResponse
  }
}

markPrintBatchAsProcessed

Type: MarkPrintBatchAsProcessed!

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

Mark the print batch as processed.

The possible errors that can be raised are:

Arguments

Name Description

printBatchId (ID!)

Return fields

Name Description

Mutation

mutation MarkPrintBatchAsProcessed($printBatchId: ID!) {
  markPrintBatchAsProcessed(printBatchId: $printBatchId) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    printBatch {
      ...PrintBatchTypeFragment
    }
  }
}

Variables

{
  "printBatchId": "11831833"
}

Response

{
  "data": {
    "markPrintBatchAsProcessed": {
      "possibleErrors": [PossibleErrorType],
      "printBatch": PrintBatchType
    }
  }
}

masqueradeAuthentication

Type: MasqueradeAuthentication

URL: https://api.oejp-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

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

Variables

{
  "masqueradeToken": "learn-of-hit-group-thus",
  "userId": "24280620"
}

Response

{
  "data": {
    "masqueradeAuthentication": {
      "token": "glass-executive-instead-eye-quality",
      "errors": [ErrorType]
    }
  }
}

Arguments

Name Description

teamGroupName (String!)

The name of the operations team group to select from.

Return fields

Name Description

Mutation

mutation NextOperationsTeamRoundRobin($teamGroupName: String!) {
  nextOperationsTeamRoundRobin(teamGroupName: $teamGroupName) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    team {
      ...TeamFragment
    }
    location {
      ...TeamLocationFragment
    }
    teamGroups {
      ...TeamGroupFragment
    }
    allInferredRoutingAttributes
  }
}

Variables

{
  "teamGroupName": "institution-American-three-together-main"
}

Response

{
  "data": {
    "nextOperationsTeamRoundRobin": {
      "possibleErrors": [PossibleErrorType],
      "team": Team,
      "location": TeamLocation,
      "teamGroups": TeamGroup,
      "allInferredRoutingAttributes": "dark-cold-development-teacher-hold"
    }
  }
}

obtainKrakenToken

Type: ObtainKrakenJSONWebToken

URL: https://api.oejp-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:

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

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

Variables

{
  "input": ObtainJSONWebTokenInput
}

Response

{
  "data": {
    "obtainKrakenToken": {
      "possibleErrors": [PossibleErrorType],
      "token": "similar-newspaper-party-test-first",
      "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "refreshToken": "popular-compare-world-among-sound",
      "refreshExpiresIn": 3
    }
  }
}

obtainLongLivedRefreshToken

Type: ObtainLongLivedRefreshToken

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

For authorized third-party organizations only.

The possible errors that can be raised are:

Arguments

Name Description

input (ObtainLongLivedRefreshTokenInput!)

Input fields for obtaining a long-lived refresh token to extend the expiry claim of a Kraken token.

Return fields

Name Description

Mutation

mutation ObtainLongLivedRefreshToken($input: ObtainLongLivedRefreshTokenInput!) {
  obtainLongLivedRefreshToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    refreshToken
    refreshExpiresIn
  }
}

Variables

{
  "input": ObtainLongLivedRefreshTokenInput
}

Response

{
  "data": {
    "obtainLongLivedRefreshToken": {
      "possibleErrors": [PossibleErrorType],
      "refreshToken": "out-deep-single-benefit-rise",
      "refreshExpiresIn": 75
    }
  }
}

ocppAuthentication

Type: OCPPAuthentication

URL: https://api.oejp-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

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

Variables

{
  "input": OCPPAuthenticationInput
}

Response

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

pauseCollectionProcess

Type: PauseCollectionProcess

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

Pause a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (PauseCollectionProcessInput!)

Details for pausing a collection process.

Return fields

Name Description

Mutation

mutation PauseCollectionProcess($input: PauseCollectionProcessInput!) {
  pauseCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessPaused {
      ...PauseCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": PauseCollectionProcessInput
}

Response

{
  "data": {
    "pauseCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessPaused": PauseCollectionProcessOutput
    }
  }
}

pauseDunning

Type: PauseDunning

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

Pause the dunning process for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (PauseDunningInputType!)

Input variables needed for pausing a dunning process for an account.

Return fields

Name Description

Mutation

mutation PauseDunning($input: PauseDunningInputType!) {
  pauseDunning(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pauseCreated
  }
}

Variables

{
  "input": PauseDunningInputType
}

Response

{
  "data": {
    "pauseDunning": {
      "possibleErrors": [PossibleErrorType],
      "pauseCreated": true
    }
  }
}

payoutReferralForAccount

Type: PayoutReferralForAccount

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

Pay out a referral reward for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (PayoutReferralForAccountInput!)

Input fields for paying out a referral for an account.

Return fields

Name Description

Mutation

mutation PayoutReferralForAccount($input: PayoutReferralForAccountInput!) {
  payoutReferralForAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payoutResult {
      ...PayoutReferralForAccountResultTypeFragment
    }
  }
}

Variables

{
  "input": PayoutReferralForAccountInput
}

Response

{
  "data": {
    "payoutReferralForAccount": {
      "possibleErrors": [PossibleErrorType],
      "payoutResult": PayoutReferralForAccountResultType
    }
  }
}

postCredit

Type: PostCredit

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

Post credit to a ledger.

The possible errors that can be raised are:

  • KT-CT-5316: Invalid data.
  • KT-CT-5311: The credit reason with the requested code is deprecated.
  • KT-CT-5312: The credit reason with the requested code does not exist.
  • KT-CT-5313: An error occurred whilst posting the credit.
  • 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

input (PostCreditInput!)

Input fields for posting a credit.

Return fields

Name Description

Mutation

mutation PostCredit($input: PostCreditInput!) {
  postCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    credit {
      ...CreditFragment
    }
  }
}

Variables

{
  "input": PostCreditInput
}

Response

{
  "data": {
    "postCredit": {
      "possibleErrors": [PossibleErrorType],
      "credit": Credit
    }
  }
}

prepareAccount

Type: PrepareAccountResult!

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

Prepare account for sign up. Returns the existing account and/or user if matching datafound for the provided input, otherwise creates a new account and account user.

The possible errors that can be raised are:

Arguments

Name Description

input (PrepareAccountInput!)

Return fields

Name Description

Mutation

mutation PrepareAccount($input: PrepareAccountInput!) {
  prepareAccount(input: $input) {
    isNewAccount
    accountNumber
    isNewUser
    userId
    userNumber
  }
}

Variables

{
  "input": PrepareAccountInput
}

Response

{
  "data": {
    "prepareAccount": {
      "isNewAccount": true,
      "accountNumber": "A-C62F417D",
      "isNewUser": true,
      "userId": "23611152",
      "userNumber": "total-social-no-party-development"
    }
  }
}

publishTransactionalMessagingExternalTrigger

Type: PublishTransactionalMessagingExternalTrigger

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

Publish an externally defined transactional messaging trigger.

The possible errors that can be raised are:

Arguments

Name Description

input (PublishTransactionalMessagingExternalTriggerInput!)

Input fields to publish an external transactional messaging trigger.

Return fields

Name Description

Mutation

mutation PublishTransactionalMessagingExternalTrigger($input: PublishTransactionalMessagingExternalTriggerInput!) {
  publishTransactionalMessagingExternalTrigger(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    trigger {
      ...TriggerFragment
    }
  }
}

Variables

{
  "input": PublishTransactionalMessagingExternalTriggerInput
}

Response

{
  "data": {
    "publishTransactionalMessagingExternalTrigger": {
      "possibleErrors": [PossibleErrorType],
      "trigger": Trigger
    }
  }
}

publishTransactionalMessagingTrigger

Type: PublishTransactionalMessagingTrigger

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

Publish a trigger within the transactional messaging service.

The possible errors that can be raised are:

Arguments

Name Description

input (PublishTransactionalMessagingTriggerInput!)

Input fields to publish a transactional messaging trigger.

Return fields

Name Description

Mutation

mutation PublishTransactionalMessagingTrigger($input: PublishTransactionalMessagingTriggerInput!) {
  publishTransactionalMessagingTrigger(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    trigger {
      ...TriggerFragment
    }
  }
}

Variables

{
  "input": PublishTransactionalMessagingTriggerInput
}

Response

{
  "data": {
    "publishTransactionalMessagingTrigger": {
      "possibleErrors": [PossibleErrorType],
      "trigger": Trigger
    }
  }
}

Arguments

Name Description

input (PurchaseVoucherInput!)

Return fields

Name Description

Mutation

mutation PurchaseVoucher($input: PurchaseVoucherInput!) {
  purchaseVoucher(input: $input) {
    voucherPurchase {
      ...VoucherPurchaseTypeFragment
    }
  }
}

Variables

{
  "input": PurchaseVoucherInput
}

Response

{
  "data": {
    "purchaseVoucher": {
      "voucherPurchase": VoucherPurchaseType
    }
  }
}

reactivateCollectionProcessRecord

Type: ReactivateCollectionProcessRecord

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

Reactivate a Collection Process Record that was previously activated.

The possible errors that can be raised are:

Arguments

Name Description

input (ReactivateCollectionProcessRecordInputType!)

Input variables needed for reactivating a collection process record.

Return fields

Name Description

Mutation

mutation ReactivateCollectionProcessRecord($input: ReactivateCollectionProcessRecordInputType!) {
  reactivateCollectionProcessRecord(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessReactivated {
      ...ReactivateCollectionProcessRecordOutputTypeFragment
    }
  }
}

Variables

{
  "input": ReactivateCollectionProcessRecordInputType
}

Response

{
  "data": {
    "reactivateCollectionProcessRecord": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessReactivated": ReactivateCollectionProcessRecordOutputType
    }
  }
}

recordDepositAgreementAccepted

Type: RecordDepositAgreementAccepted

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

Record the customer's acceptance of a deposit agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (DepositAgreementInput!)

Return fields

Name Description

Mutation

mutation RecordDepositAgreementAccepted($input: DepositAgreementInput!) {
  recordDepositAgreementAccepted(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    isRecorded
  }
}

Variables

{
  "input": DepositAgreementInput
}

Response

{
  "data": {
    "recordDepositAgreementAccepted": {
      "possibleErrors": [PossibleErrorType],
      "isRecorded": true
    }
  }
}

redeemLoyaltyPointsForAccountCredit

Type: RedeemLoyaltyPointsForAccountCredit

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

Redeem the passed number of Loyalty Points as account credit.

The possible errors that can be raised are:

Arguments

Name Description

input (RedeemLoyaltyPointsInput!)

Input fields for redeeming Loyalty Points.

Return fields

Name Description

Mutation

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

Variables

{
  "input": RedeemLoyaltyPointsInput
}

Response

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

redeemReferralClaimCode

Type: RedeemReferralClaimCode

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

Redeem the referral claim code from certain referral scheme.

The possible errors that can be raised are:

Arguments

Name Description

input (RedeemReferralClaimCodeInput!)

Input fields for redeeming referral code.

Return fields

Name Description

Mutation

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

Variables

{
  "input": RedeemReferralClaimCodeInput
}

Response

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

refundPayment

Type: RefundPayment

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

Refund a cleared payment.

The possible errors that can be raised are:

Arguments

Name Description

input (RefundPaymentInput!)

Input fields for refunding a payment.

Return fields

Name Description

Mutation

mutation RefundPayment($input: RefundPaymentInput!) {
  refundPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repayment {
      ...AccountRepaymentTypeFragment
    }
  }
}

Variables

{
  "input": RefundPaymentInput
}

Response

{
  "data": {
    "refundPayment": {
      "possibleErrors": [PossibleErrorType],
      "repayment": AccountRepaymentType
    }
  }
}

regenerateSecretKey

Type: RegenerateSecretKey

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

Regenerate the live secret key for the authenticated user.

Return fields

Name Description

Mutation

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

Response

{
  "data": {
    "regenerateSecretKey": {
      "key": "trip-mouth-understand-relate-send",
      "viewer": AccountUserType
    }
  }
}

Arguments

Name Description

input (RegisterDemandResponseCampaignParticipantInput)

Input fields for registering an account for a Demand Response campaign.

Return fields

Name Description

Mutation

mutation RegisterDemandResponseCampaignParticipant($input: RegisterDemandResponseCampaignParticipantInput) {
  registerDemandResponseCampaignParticipant(input: $input)
}

Variables

{
  "input": RegisterDemandResponseCampaignParticipantInput
}

Response

{
  "data": {
    "registerDemandResponseCampaignParticipant": RegisterDemandResponseCampaignParticipantResponse
  }
}

registerLeadFlowStatusEvent

Type: RegisterLeadFlowStatusEvent

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

Register a flow status event for a lead.

The possible errors that can be raised are:

Arguments

Name Description

input (RegisterLeadFlowStatusEventInput!)

Input fields for registering a flow status event for a Lead.

Return fields

Name Description

Mutation

mutation RegisterLeadFlowStatusEvent($input: RegisterLeadFlowStatusEventInput!) {
  registerLeadFlowStatusEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": RegisterLeadFlowStatusEventInput
}

Response

{
  "data": {
    "registerLeadFlowStatusEvent": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

registerOpportunityFlowStatusEvent

Type: RegisterOpportunityFlowStatusEvent

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

Register a flow status event for an opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (RegisterOpportunityFlowStatusEventInput!)

Input fields for registering a flow status event for a opportunity.

Return fields

Name Description

Mutation

mutation RegisterOpportunityFlowStatusEvent($input: RegisterOpportunityFlowStatusEventInput!) {
  registerOpportunityFlowStatusEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": RegisterOpportunityFlowStatusEventInput
}

Response

{
  "data": {
    "registerOpportunityFlowStatusEvent": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

registerPushNotificationBinding

Type: RegisterPushNotificationBinding

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

Register a device token to be used for push notifications for an app.

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

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

Variables

{
  "input": RegisterPushNotificationBindingInput
}

Response

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

removeCampaignFromAccount

Type: RemoveCampaignFromAccount

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

The possible errors that can be raised are:

Arguments

Name Description

input (RemoveCampaignFromAccountInput!)

Input variables needed for removing a campaign from an account.

Return fields

Name Description

Mutation

mutation RemoveCampaignFromAccount($input: RemoveCampaignFromAccountInput!) {
  removeCampaignFromAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignRemoved
  }
}

Variables

{
  "input": RemoveCampaignFromAccountInput
}

Response

{
  "data": {
    "removeCampaignFromAccount": {
      "possibleErrors": [PossibleErrorType],
      "campaignRemoved": true
    }
  }
}

removeCampaignItems

Type: RemoveCampaignItems

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

The possible errors that can be raised are:

Arguments

Name Description

input (RemoveCampaignItemsInput!)

Return fields

Name Description

Mutation

mutation RemoveCampaignItems($input: RemoveCampaignItemsInput!) {
  removeCampaignItems(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignItems {
      ...VoiceCampaignItemTypeFragment
    }
  }
}

Variables

{
  "input": RemoveCampaignItemsInput
}

Response

{
  "data": {
    "removeCampaignItems": {
      "possibleErrors": [PossibleErrorType],
      "campaignItems": [VoiceCampaignItemType]
    }
  }
}

removeItemsFromRiskList

Type: RemoveItemsFromRiskList

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

Remove items from the risk list.

The possible errors that can be raised are:

Arguments

Name Description

input ([RiskListItemInputType]!)

A list of risk list items to remove.

Return fields

Name Description

Mutation

mutation RemoveItemsFromRiskList($input: [RiskListItemInputType]!) {
  removeItemsFromRiskList(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    riskIdentifiers {
      ...RiskListItemTypeFragment
    }
  }
}

Variables

{
  "input": RiskListItemInputType
}

Response

{
  "data": {
    "removeItemsFromRiskList": {
      "possibleErrors": [PossibleErrorType],
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

requestAmperageChange

Type: RequestAmperageChange

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

Request amperage change as an organization.

The possible errors that can be raised are:

Arguments

Name Description

input (RequestAmperageChangeInput)

Input fields for requesting an amperage change.

Return fields

Name Description

Mutation

mutation RequestAmperageChange($input: RequestAmperageChangeInput) {
  requestAmperageChange(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

Variables

{
  "input": RequestAmperageChangeInput
}

Response

{
  "data": {
    "requestAmperageChange": {
      "possibleErrors": [PossibleErrorType],
      "message": "team-region-around-professional-arm"
    }
  }
}

requestDoubleOptIn

Type: RequestDoubleOptIn

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

Request a double opt in

The possible errors that can be raised are:

Arguments

Name Description

input (DoubleOptInInput)

Return fields

Name Description

Mutation

mutation RequestDoubleOptIn($input: DoubleOptInInput) {
  requestDoubleOptIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consent {
      ...ConsentTypeFragment
    }
  }
}

Variables

{
  "input": DoubleOptInInput
}

Response

{
  "data": {
    "requestDoubleOptIn": {
      "possibleErrors": [PossibleErrorType],
      "consent": ConsentType
    }
  }
}

requestPasswordReset

Type: RequestPasswordResetOutputType

URL: https://api.oejp-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:

Arguments

Name Description

input (RequestPasswordResetInput!)

Input fields for requesting a password reset email.

Return fields

Name Description

Mutation

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

Variables

{
  "input": RequestPasswordResetInput
}

Response

{
  "data": {
    "requestPasswordReset": {
      "email": "trip-address-machine-finish-step",
      "userNumber": "television-common-form-during-all"
    }
  }
}

requestPrintedBill

Type: RequestPrintedBill

URL: https://api.oejp-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:

Arguments

Name Description

input (RequestPrintedBillInput!)

Input fields to request a printed bill.

Return fields

Name Description

Mutation

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

Variables

{
  "input": RequestPrintedBillInput
}

Response

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

resetPassword

Type: ResetPasswordMutationPayload

URL: https://api.oejp-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

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

Variables

{
  "input": ResetPasswordMutationInput
}

Response

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

resetUserPassword

Type: ResetUserPasswordOutput

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

Reset the password of an account user.

Raises KT-CT-5450 if password validation fails. Inspect the validationErrors extension to get the exact validation error:

json { "data": {"resetUserPassword": null}, "errors": [ { "message": "Password is invalid.", "path": ["resetUserPassword"], "extensions": { "errorType": "VALIDATION", "errorCode": "KT-CT-5450", "errorDescription": "Given password fails password policy requirements.", "validationErrors": [ { "code": "password_too_short", "message": "This password is too short. It must contain at least 7 characters.", "inputPath": ["input", "password"] }, { "code": "password_too_common", "message": "This password is too common.", "inputPath": ["input", "password"] } ] } } ] }

The validation error's code can be any of - password_too_short - password_too_common - password_reused - password_matches_current - password_has_too_few_numeric_characters - password_has_too_few_special_characters - password_has_too_few_lowercase_characters - password_has_too_few_uppercase_characters - password_contains_account_number - password_contains_part_of_email_address

The possible errors that can be raised are:

Arguments

Name Description

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

Name Description

Mutation

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

Variables

{
  "input": ResetUserPasswordInput
}

Response

{
  "data": {
    "resetUserPassword": {
      "userId": "21393588",
      "passwordUpdated": true,
      "failureReasons": ["agent-wrong-pull-land-perhaps"],
      "failureCodes": ["fire-focus-capital-south-west"]
    }
  }
}

resumeCollectionProcess

Type: ResumeCollectionProcess

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

Resume a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (ResumeCollectionProcessInput!)

Details for resuming a collection process.

Return fields

Name Description

Mutation

mutation ResumeCollectionProcess($input: ResumeCollectionProcessInput!) {
  resumeCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessResumed {
      ...ResumeCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": ResumeCollectionProcessInput
}

Response

{
  "data": {
    "resumeCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessResumed": ResumeCollectionProcessOutput
    }
  }
}

resumeControl

Type: ResumeDeviceControl

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

Resume control of the device.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountNumberInput
}

Response

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

Arguments

Name Description

input (RevertProductSwitchInput)

Return fields

Name Description

Mutation

mutation RevertProductSwitch($input: RevertProductSwitchInput) {
  revertProductSwitch(input: $input) {
    agreement {
      ...AgreementFragment
    }
  }
}

Variables

{
  "input": RevertProductSwitchInput
}

Response

{
  "data": {
    "revertProductSwitch": {
      "agreement": Agreement
    }
  }
}

revokeAgreement

Type: RevokeAgreement

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

Revoke an agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeAgreementInput!)

Input fields for revoking an agreement.

Return fields

Name Description

Mutation

mutation RevokeAgreement($input: RevokeAgreementInput!) {
  revokeAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": RevokeAgreementInput
}

Response

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

revokeContract

Type: RevokeContractOutput!

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

Revoke an existing contract.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeContractInput!)

Return fields

Name Description

Mutation

mutation RevokeContract($input: RevokeContractInput!) {
  revokeContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": RevokeContractInput
}

Response

{
  "data": {
    "revokeContract": {
      "contract": Contract
    }
  }
}

revokeUserAccessFromBusiness

Type: RevokeUserAccessFromBusiness

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

Revoke the selected role from the user for the business.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeUserAccessFromBusinessInput!)

Return fields

Name Description

Mutation

mutation RevokeUserAccessFromBusiness($input: RevokeUserAccessFromBusinessInput!) {
  revokeUserAccessFromBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": RevokeUserAccessFromBusinessInput
}

Response

{
  "data": {
    "revokeUserAccessFromBusiness": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

runAgreementRollover

Type: RunAgreementRollover

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

Run an agreement rollover.

The possible errors that can be raised are:

Arguments

Name Description

input (RunAgreementRolloverInput!)

Input for running an agreement rollover.

Return fields

Name Description

Mutation

mutation RunAgreementRollover($input: RunAgreementRolloverInput!) {
  runAgreementRollover(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

Variables

{
  "input": RunAgreementRolloverInput
}

Response

{
  "data": {
    "runAgreementRollover": {
      "possibleErrors": [PossibleErrorType],
      "agreementRollover": AgreementRolloverType
    }
  }
}

scheduleQuoteFollowUp

Type: ScheduleQuoteFollowUp

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

Schedule a quote follow-up to the provided recipient.

The possible errors that can be raised are:

Arguments

Name Description

input (QuoteShareInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": QuoteShareInput
}

Response

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

selectChargePointMakeForSmartFlexOnboarding

Type: SelectChargePointMakeForSmartFlexOnboarding

URL: https://api.oejp-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-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": SelectChargePointMakeInput
}

Response

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

selectChargePointVariantForSmartFlexOnboarding

Type: SelectChargePointVariantForSmartFlexOnboarding

URL: https://api.oejp-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-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": SelectChargePointVariantInput
}

Response

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

selectDeviceTypeForSmartFlexOnboarding

Type: SelectDeviceTypeForSmartFlexOnboarding

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

Select the device type to proceed in the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": SelectDeviceTypeInput
}

Response

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

selectFromListForSmartFlexOnboarding

Type: SelectFromListForSmartFlexOnboarding

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

Select from a list of options presented.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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 (SelectFromListInput!)

Return fields

Name Description

Mutation

mutation SelectFromListForSmartFlexOnboarding($input: SelectFromListInput!) {
  selectFromListForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectFromListInput
}

Response

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

selectHeatPumpMakeForSmartFlexOnboarding

Type: SelectHeatPumpMakeForSmartFlexOnboarding

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

Select the heat pump make to proceed in the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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 (SelectHeatPumpMakeInput!)

Return fields

Name Description

Mutation

mutation SelectHeatPumpMakeForSmartFlexOnboarding($input: SelectHeatPumpMakeInput!) {
  selectHeatPumpMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectHeatPumpMakeInput
}

Response

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

selectProducts

Type: SelectProducts

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

Mark quoted products on a quote request as selected.

The possible errors that can be raised are:

  • KT-CT-4619: Quote with given code not found.
  • KT-CT-4634: Quoted product with given id not found.
  • KT-CT-4626: No product selected for the given quote code.
  • KT-CT-4635: Missing a quoted product for at least one quoted supply point on the quote request.
  • KT-CT-4636: Quoted product not linked to a product.
  • KT-CT-4646: Attempted to select multiple products for the same quoted supply point.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectProductsInput!)

Return fields

Name Description

Mutation

mutation SelectProducts($input: SelectProductsInput!) {
  selectProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

Variables

{
  "input": SelectProductsInput
}

Response

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

selectUserVehicleForSmartFlexOnboarding

Type: SelectUserVehicleForSmartFlexOnboarding

URL: https://api.oejp-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-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": SelectUserVehicleInput
}

Response

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

selectVehicleMakeForSmartFlexOnboarding

Type: SelectVehicleMakeForSmartFlexOnboarding

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

Select the vehicle make to proceed in the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": SelectVehicleMakeInput
}

Response

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

selectVehicleOrChargePointForSmartFlexOnboarding

Type: CompleteSelectVehicleOrChargePointForSmartFlexOnboarding

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

Select the vehicle or charge point for the onboarding journey.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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 (SelectVehicleOrChargePointInput!)

Return fields

Name Description

Mutation

mutation SelectVehicleOrChargePointForSmartFlexOnboarding($input: SelectVehicleOrChargePointInput!) {
  selectVehicleOrChargePointForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectVehicleOrChargePointInput
}

Response

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

selectVehicleVariantForSmartFlexOnboarding

Type: SelectVehicleVariantForSmartFlexOnboarding

URL: https://api.oejp-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-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": SelectVehicleVariantInput
}

Response

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

selfServeSwitchInCorrection

Type: SwitchInCorrectionResponse!

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

Self-serve switch-in correction.

The possible errors that can be raised are:

Arguments

Name Description

input (SelfServeSwitchInCorrectionInput!)

Return fields

Name Description

Mutation

mutation SelfServeSwitchInCorrection($input: SelfServeSwitchInCorrectionInput!) {
  selfServeSwitchInCorrection(input: $input)
}

Variables

{
  "input": SelfServeSwitchInCorrectionInput
}

Response

{
  "data": {
    "selfServeSwitchInCorrection": SwitchInCorrectionResponse
  }
}

sendFamilySwitchInOffer

Type: SendFamilySwitchInOffer

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

Mutation to send family switch in offer to the customer.

The possible errors that can be raised are:

Arguments

Name Description

input (SendFamilySwitchInOfferInput!)

Return fields

Name Description

Mutation

mutation SendFamilySwitchInOffer($input: SendFamilySwitchInOfferInput!) {
  sendFamilySwitchInOffer(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    hasSent
  }
}

Variables

{
  "input": SendFamilySwitchInOfferInput
}

Response

{
  "data": {
    "sendFamilySwitchInOffer": {
      "possibleErrors": [PossibleErrorType],
      "hasSent": true
    }
  }
}

sendQuoteSummary

Type: SendQuoteSummary

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

Send a quote summary to the provided recipient.

The possible errors that can be raised are:

Arguments

Name Description

input (QuoteShareInput!)

Return fields

Name Description

Mutation

mutation SendQuoteSummary($input: QuoteShareInput!) {
  sendQuoteSummary(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

Variables

{
  "input": QuoteShareInput
}

Response

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

sendVerificationEmail

Type: SendVerificationEmail

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

Verify user's email address.

The possible errors that can be raised are:

Arguments

Name Description

input (SendVerificationEmailInput!)

Return fields

Name Description

Mutation

mutation SendVerificationEmail($input: SendVerificationEmailInput!) {
  sendVerificationEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    verificationStatus
  }
}

Variables

{
  "input": SendVerificationEmailInput
}

Response

{
  "data": {
    "sendVerificationEmail": {
      "possibleErrors": [PossibleErrorType],
      "verificationStatus": true
    }
  }
}

setClimateControlState

Type: SetClimateControlState

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

Turn a hot water device on or off.

The possible errors that can be raised are:

Arguments

Name Description

input (ClimateControlStateInput)

Return fields

Name Description

Mutation

mutation SetClimateControlState($input: ClimateControlStateInput) {
  setClimateControlState(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

Variables

{
  "input": ClimateControlStateInput
}

Response

{
  "data": {
    "setClimateControlState": {
      "possibleErrors": [PossibleErrorType],
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setDevicePreferences

Type: SmartFlexDeviceInterface

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

Set the user preferences for a device.

The possible errors that can be raised are:

Arguments

Name Description

input (SmartFlexDevicePreferencesInput!)

The device preference details to be updated.

Return fields

Name Description

Mutation

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

Variables

{
  "input": SmartFlexDevicePreferencesInput
}

Response

{
  "data": {
    "setDevicePreferences": {
      "id": "91012108",
      "name": "hospital-between-job-site-state",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "87656617",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "61578294",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

setHotWaterState

Type: SetHotWaterState

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

Turn a hot water device on or off.

The possible errors that can be raised are:

Arguments

Name Description

input (HotWaterStateInput)

Return fields

Name Description

Mutation

mutation SetHotWaterState($input: HotWaterStateInput) {
  setHotWaterState(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

Variables

{
  "input": HotWaterStateInput
}

Response

{
  "data": {
    "setHotWaterState": {
      "possibleErrors": [PossibleErrorType],
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setLoyaltyPointsUser

Type: SetLoyaltyPointsUser

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

Set the Loyalty Point user for the account.

The possible errors that can be raised are:

Arguments

Name Description

input (SetLoyaltyPointsUserInput!)

Input fields for saving the Loyalty Points user.

Return fields

Name Description

Mutation

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

Variables

{
  "input": SetLoyaltyPointsUserInput
}

Response

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

setOpportunityOutcome

Type: SetOpportunityOutcome

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

Update the opportunity outcome to mark the opportunity as won or lost.

The possible errors that can be raised are:

Arguments

Name Description

input (SetOpportunityOutcomeInput!)

Input fields for setting the outcome of a opportunity.

Return fields

Name Description

Mutation

mutation SetOpportunityOutcome($input: SetOpportunityOutcomeInput!) {
  setOpportunityOutcome(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

Variables

{
  "input": SetOpportunityOutcomeInput
}

Response

{
  "data": {
    "setOpportunityOutcome": {
      "possibleErrors": [PossibleErrorType],
      "message": "property-society-candidate-pattern-give"
    }
  }
}

setPaymentPreference

Type: SetPaymentPreference

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

Set a preference to collect payments from a specific payment method.

The possible errors that can be raised are:

Arguments

Name Description

input (SetPaymentPreferenceInput!)

Return fields

Name Description

Mutation

mutation SetPaymentPreference($input: SetPaymentPreferenceInput!) {
  setPaymentPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": SetPaymentPreferenceInput
}

Response

{
  "data": {
    "setPaymentPreference": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

setRoomTemperature

Type: SetRoomTemperature

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

Turn a hot water device on or off.

The possible errors that can be raised are:

Arguments

Name Description

input (RoomTemperatureInput)

Return fields

Name Description

Mutation

mutation SetRoomTemperature($input: RoomTemperatureInput) {
  setRoomTemperature(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

Variables

{
  "input": RoomTemperatureInput
}

Response

{
  "data": {
    "setRoomTemperature": {
      "possibleErrors": [PossibleErrorType],
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setUpDirectDebitInstruction

Type: SetUpDirectDebitInstruction

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

Set up a new direct debit instruction.

The possible errors that can be raised are:

Arguments

Name Description

input (SetUpDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

Mutation

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

Variables

{
  "input": SetUpDirectDebitInstructionInput
}

Response

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

setUpDirectDebitInstructionForBusiness

Type: SetUpDirectDebitInstructionForBusiness

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

Set up a new direct debit instruction for a business.

The possible errors that can be raised are:

Arguments

Name Description

input (SetUpDirectDebitInstructionForBusinessInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

Mutation

mutation SetUpDirectDebitInstructionForBusiness($input: SetUpDirectDebitInstructionForBusinessInput!) {
  setUpDirectDebitInstructionForBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

Variables

{
  "input": SetUpDirectDebitInstructionForBusinessInput
}

Response

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

setUpDirectDebitInstructionFromStoredDetails

Type: SetUpDirectDebitInstructionFromStoredDetails

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

Set up a new direct debit instruction from stored details.

The possible errors that can be raised are:

Arguments

Name Description

input (SetUpDirectDebitInstructionFromStoredDetailsInput!)

Input fields for creating a new direct debit instruction from stored details.

Return fields

Name Description

Mutation

mutation SetUpDirectDebitInstructionFromStoredDetails($input: SetUpDirectDebitInstructionFromStoredDetailsInput!) {
  setUpDirectDebitInstructionFromStoredDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

Variables

{
  "input": SetUpDirectDebitInstructionFromStoredDetailsInput
}

Response

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

setVehicleChargePreferences

Type: SetVehicleChargingPreferences

URL: https://api.oejp-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

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

Variables

{
  "input": VehicleChargingPreferencesInput
}

Response

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

shareGoodsQuote

Type: ShareGoodsQuote

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

Share a goods quote.

The possible errors that can be raised are:

Arguments

Name Description

input (ShareGoodsQuoteInput!)

Input fields for sharing a quote.

Return fields

Name Description

Mutation

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

Variables

{
  "input": ShareGoodsQuoteInput
}

Response

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

startCollectionProcess

Type: StartCollectionProcess

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

Start a collection process.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11208: Invalid billing document identifier for collection process.
  • KT-CT-11209: Collection process configuration does not have published version.
  • KT-CT-11210: Active collection process for entity already exists.
  • KT-CT-11211: Too many active collection processes for config.
  • KT-CT-11212: Invalid collection process config code.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartCollectionProcessInput!)

Details to start collection process for.

Return fields

Name Description

Mutation

mutation StartCollectionProcess($input: StartCollectionProcessInput!) {
  startCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessStarted {
      ...StartCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": StartCollectionProcessInput
}

Response

{
  "data": {
    "startCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessStarted": StartCollectionProcessOutput
    }
  }
}

startCustomerVerification

Type: StartCustomerVerification

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

Start the customer verification using the provided verification method.

The possible errors that can be raised are:

Arguments

Name Description

input (StartCustomerVerificationInput!)

Return fields

Name Description

Mutation

mutation StartCustomerVerification($input: StartCustomerVerificationInput!) {
  startCustomerVerification(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    verificationProcess {
      ...VerificationProcessFragment
    }
  }
}

Variables

{
  "input": StartCustomerVerificationInput
}

Response

{
  "data": {
    "startCustomerVerification": {
      "possibleErrors": [PossibleErrorType],
      "verificationProcess": VerificationProcess
    }
  }
}

startOnSiteJobsAppointmentBookingSession

Type: StartOnSiteJobsAppointmentBookingSession

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

Start the appointment booking process for an on-site jobs request.

The possible errors that can be raised are:

Arguments

Name Description

appointmentBookingDetails (OnSiteJobsAppointmentBookingDetailsInput!)

The appointment booking details.

overrideAppointmentCheckWarnings (Boolean)

Whether to override appointment booking check warnings. Defaults to False.

requestId (UUID!)

The ID of the request to book an appointment for.

Return fields

Name Description

Mutation

mutation StartOnSiteJobsAppointmentBookingSession(
  $appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
  $overrideAppointmentCheckWarnings: Boolean,
  $requestId: UUID!
) {
  startOnSiteJobsAppointmentBookingSession(
    appointmentBookingDetails: $appointmentBookingDetails,
    overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
    requestId: $requestId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    appointmentBookingSessionId
  }
}

Variables

{
  "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
  "overrideAppointmentCheckWarnings": true,
  "requestId": "a7716cd5-ca67-492e-93af-cb2a668eaf1b"
}

Response

{
  "data": {
    "startOnSiteJobsAppointmentBookingSession": {
      "possibleErrors": [PossibleErrorType],
      "appointmentBookingSessionId": "bff8f23d-dc27-4437-b5ee-c1c9b866d024"
    }
  }
}

startReAuthentication

Type: StartReAuthentication

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

Create a wizard for re-authenticating a device with SmartFlex.

The possible errors that can be raised are:

Arguments

Name Description

input (StartReAuthenticationInput!)

Return fields

Name Description

Mutation

mutation StartReAuthentication($input: StartReAuthenticationInput!) {
  startReAuthentication(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": StartReAuthenticationInput
}

Response

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

startSmartFlexOnboarding

Type: StartSmartFlexOnboarding

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

Create a wizard for onboarding a device with SmartFlex.

The possible errors that can be raised are:

Arguments

Name Description

input (StartSmartFlexOnboardingInput!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": StartSmartFlexOnboardingInput
}

Response

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

startTestChargeForSmartFlexOnboarding

Type: StartTestChargeForSmartFlexOnboarding

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

Attempt to start a test charge.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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 again 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

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

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

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

stopAutomatedPayments

Type: StopAutomatedPayments

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

Set a preference to not collect automated payments.

The possible errors that can be raised are:

Arguments

Name Description

input (StopAutomatedPaymentsInput!)

Return fields

Name Description

Mutation

mutation StopAutomatedPayments($input: StopAutomatedPaymentsInput!) {
  stopAutomatedPayments(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": StopAutomatedPaymentsInput
}

Response

{
  "data": {
    "stopAutomatedPayments": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

Arguments

Name Description

input (NewBankAccountDetailsInput)

Return fields

Name Description

Mutation

mutation StoreBankAccountDetails($input: NewBankAccountDetailsInput) {
  storeBankAccountDetails(input: $input) {
    financialInstitutionRedirectUrl
    token
  }
}

Variables

{
  "input": NewBankAccountDetailsInput
}

Response

{
  "data": {
    "storeBankAccountDetails": {
      "financialInstitutionRedirectUrl": "always-store-course-form-media",
      "token": "court-possible-interest-for-nothing"
    }
  }
}

storeDirectDebitPaymentMethodDetails

Type: StoreDirectDebitPaymentMethodDetails

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

Store bank details with the vendor.

The possible errors that can be raised are:

Arguments

Name Description

input (StoreDirectDebitPaymentMethodDetailsInput!)

Store bank details with the vendor.

Return fields

Name Description

Mutation

mutation StoreDirectDebitPaymentMethodDetails($input: StoreDirectDebitPaymentMethodDetailsInput!) {
  storeDirectDebitPaymentMethodDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    storedPaymentMethodDetailsReference
  }
}

Variables

{
  "input": StoreDirectDebitPaymentMethodDetailsInput
}

Response

{
  "data": {
    "storeDirectDebitPaymentMethodDetails": {
      "possibleErrors": [PossibleErrorType],
      "storedPaymentMethodDetailsReference": "finish-offer-part-gun-book"
    }
  }
}

storePaymentInstruction

Type: StorePaymentInstruction

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

Store a new payment instruction created through the embedded process.

The possible errors that can be raised are:

Arguments

Name Description

input (StorePaymentInstructionInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": StorePaymentInstructionInput
}

Response

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

Arguments

Name Description

input (NewRefundBankAccountDetailsInput)

Return fields

Name Description

Mutation

mutation StoreRefundBankAccount($input: NewRefundBankAccountDetailsInput) {
  storeRefundBankAccount(input: $input)
}

Variables

{
  "input": NewRefundBankAccountDetailsInput
}

Response

{
  "data": {
    "storeRefundBankAccount": StoreRefundBankAccountResponse
  }
}

submitCustomerFeedback

Type: SubmitCustomerFeedback

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

Submit customer feedback.

The possible errors that can be raised are:

Arguments

Name Description

input (CustomerFeedbackInputType!)

Return fields

Name Description

Mutation

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

Variables

{
  "input": CustomerFeedbackInputType
}

Response

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

submitRepaymentRequest

Type: SubmitRepaymentRequest

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

Submit a repayment request.

The possible errors that can be raised are:

Arguments

Name Description

input (RequestRepaymentInputType!)

Input fields for requesting a repayment.

Return fields

Name Description

Mutation

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

Variables

{
  "input": RequestRepaymentInputType
}

Response

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

Arguments

Name Description

input (SuggestFixedPaymentAmountInput!)

Return fields

Name Description

Mutation

mutation SuggestFixedPaymentAmount($input: SuggestFixedPaymentAmountInput!) {
  suggestFixedPaymentAmount(input: $input)
}

Variables

{
  "input": SuggestFixedPaymentAmountInput
}

Response

{
  "data": {
    "suggestFixedPaymentAmount": SuggestFixedPaymentAmountResponse
  }
}

suspendControl

Type: SuspendDeviceControl

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

Suspend control of the device.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountNumberInput
}

Response

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

switchAccountToVariablePaymentSchedule

Type: SwitchAccountToVariablePaymentSchedule

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

Switch account to variable payment schedule. Current schedule type will be preserved.

The possible errors that can be raised are:

Arguments

Name Description

input (SwitchAccountToVariablePaymentScheduleInput!)

Input fields for switching to a variable payment schedule.

Return fields

Name Description

Mutation

mutation SwitchAccountToVariablePaymentSchedule($input: SwitchAccountToVariablePaymentScheduleInput!) {
  switchAccountToVariablePaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": SwitchAccountToVariablePaymentScheduleInput
}

Response

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

switchToProductOnNextReadingDate

Type: SwitchToProductOnNextReadingDate

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

Switch to the given product code on the next reading date.

The possible errors that can be raised are:

Arguments

Name Description

input (SwitchToProductInput)

Return fields

Name Description

Mutation

mutation SwitchToProductOnNextReadingDate($input: SwitchToProductInput) {
  switchToProductOnNextReadingDate(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...AgreementFragment
    }
  }
}

Variables

{
  "input": SwitchToProductInput
}

Response

{
  "data": {
    "switchToProductOnNextReadingDate": {
      "possibleErrors": [PossibleErrorType],
      "agreement": Agreement
    }
  }
}

Arguments

Name Description

input (SwitchToProductWithFixedFuelCostAdjustmentInput)

Return fields

Name Description

Mutation

mutation SwitchToProductWithFixedFuelCostAdjustment($input: SwitchToProductWithFixedFuelCostAdjustmentInput) {
  switchToProductWithFixedFuelCostAdjustment(input: $input)
}

Variables

{
  "input": SwitchToProductWithFixedFuelCostAdjustmentInput
}

Response

{
  "data": {
    "switchToProductWithFixedFuelCostAdjustment": SwitchToProductWithFixedFuelCostAdjustmentResponse
  }
}

terminateContract

Type: TerminateContractOutput!

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

Terminate an existing contract.

The possible errors that can be raised are:

Arguments

Name Description

input (TerminateContractInput!)

Return fields

Name Description

Mutation

mutation TerminateContract($input: TerminateContractInput!) {
  terminateContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": TerminateContractInput
}

Response

{
  "data": {
    "terminateContract": {
      "contract": Contract
    }
  }
}

terminateCreditTransferPermission

Type: TerminateCreditTransferPermission

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

Terminate credit transfer permission.

The possible errors that can be raised are:

Arguments

Name Description

input (TerminateCreditTransferPermissionInput!)

Input fields for terminating a credit transfer permission.

Return fields

Name Description

Mutation

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

Variables

{
  "input": TerminateCreditTransferPermissionInput
}

Response

{
  "data": {
    "terminateCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validTo": "2009-03-20T19:55:44.216326+00:00"
    }
  }
}

thirdPartyCompleteDeviceRegistration

Type: ThirdPartyCompleteDeviceRegistration

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

Completes the registration of a device if the contract is eligible and the device registration valid.

The possible errors that can be raised are:

Arguments

Name Description

input (CompleteDeviceRegistrationInput)

Return fields

Name Description

Mutation

mutation ThirdPartyCompleteDeviceRegistration($input: CompleteDeviceRegistrationInput) {
  thirdPartyCompleteDeviceRegistration(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success {
      ...ThirdPartyCompleteDeviceRegistrationTypeFragment
    }
  }
}

Variables

{
  "input": CompleteDeviceRegistrationInput
}

Response

{
  "data": {
    "thirdPartyCompleteDeviceRegistration": {
      "possibleErrors": [PossibleErrorType],
      "success": ThirdPartyCompleteDeviceRegistrationType
    }
  }
}

transferLeadOpportunities

Type: TransferLeadOpportunities

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

Transfer opportunities across leads.

The possible errors that can be raised are:

Arguments

Name Description

input (TransferLeadOpportunitiesInput!)

Input for transfer opportunities across leads.

Return fields

Name Description

Mutation

mutation TransferLeadOpportunities($input: TransferLeadOpportunitiesInput!) {
  transferLeadOpportunities(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunitiesTransferred
  }
}

Variables

{
  "input": TransferLeadOpportunitiesInput
}

Response

{
  "data": {
    "transferLeadOpportunities": {
      "possibleErrors": [PossibleErrorType],
      "opportunitiesTransferred": 27
    }
  }
}

transferLedgerBalance

Type: TransferLedgerBalance

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

Transfer value from a source ledger to a destination ledger. This decreases the balance of the source ledger by the given amount and increases the balance of the destination ledger by the same amount. If the amount is negative, the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases).

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (TransferLedgerBalanceInputType!)

Input fields for processing an account balance transfer.

Return fields

Name Description

Mutation

mutation TransferLedgerBalance($input: TransferLedgerBalanceInputType!) {
  transferLedgerBalance(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    balanceTransfer {
      ...AccountBalanceTransferTypeFragment
    }
  }
}

Variables

{
  "input": TransferLedgerBalanceInputType
}

Response

{
  "data": {
    "transferLedgerBalance": {
      "possibleErrors": [PossibleErrorType],
      "balanceTransfer": AccountBalanceTransferType
    }
  }
}

transferLoyaltyPointsBetweenUsers

Type: TransferLoyaltyPointsBetweenUsers

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

Transfer Loyalty Point from one account user to another.

The possible errors that can be raised are:

Arguments

Name Description

input (TransferLoyaltyPointsBetweenUsersInput!)

Input fields for transferring Loyalty Points.

Return fields

Name Description

Mutation

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

Variables

{
  "input": TransferLoyaltyPointsBetweenUsersInput
}

Response

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

triggerBoostCharge

Type: PerformBoostCharge

URL: https://api.oejp-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)
  • BC_DEVICE_FULLY_CHARGED (device is already fully charged)

The possible errors that can be raised are:

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountNumberInput
}

Response

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

triggerPostUploadOperationsJpn

Type: TriggerPostUploadOperationsJPN!

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

Send file to virus scanner on upload.

The possible errors that can be raised are:

Arguments

Name Description

s3Key (String!)

Return fields

Name Description

Mutation

mutation TriggerPostUploadOperationsJpn($s3Key: String!) {
  triggerPostUploadOperationsJpn(s3Key: $s3Key) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    operationsTriggered
  }
}

Variables

{
  "s3Key": "describe-series-movement-professional-television"
}

Response

{
  "data": {
    "triggerPostUploadOperationsJpn": {
      "possibleErrors": [PossibleErrorType],
      "operationsTriggered": true
    }
  }
}

triggerTestCharge

Type: PerformTestCharge

URL: https://api.oejp-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:

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountNumberInput
}

Response

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

unenrollAccountFromLoyaltyProgram

Type: UnenrollAccountFromLoyaltyProgram

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

Unenroll users account from Loyalty program.

The possible errors that can be raised are:

Arguments

Name Description

input (UnenrollAccountFromLoyaltyProgramInput!)

The account number to unenroll from the loyalty program.

Return fields

Name Description

Mutation

mutation UnenrollAccountFromLoyaltyProgram($input: UnenrollAccountFromLoyaltyProgramInput!) {
  unenrollAccountFromLoyaltyProgram(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    outcome {
      ...UnenrollAccountFromLoyaltyProgramOutcomeFragment
    }
  }
}

Variables

{
  "input": UnenrollAccountFromLoyaltyProgramInput
}

Response

{
  "data": {
    "unenrollAccountFromLoyaltyProgram": {
      "possibleErrors": [PossibleErrorType],
      "outcome": UnenrollAccountFromLoyaltyProgramOutcome
    }
  }
}

Return fields

Name Description

Mutation

mutation UnlinkUserFromLine {
  unlinkUserFromLine
}

Response

{
  "data": {
    "unlinkUserFromLine": UnlinkUserFromLineResponse
  }
}

updateAccountBillingAddress

Type: UpdateAccountBillingAddress

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

Update the account billing address.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountBillingAddressInput!)

Input variables needed for updating an account billing address.

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountBillingAddressInput
}

Response

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

updateAccountBillingEmail

Type: UpdateAccountBillingEmail

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

Update account billing email.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAccountBillingEmailInput!)

Input fields for updating billing email for an account.

Return fields

Name Description

Mutation

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

Variables

{
  "input": UpdateAccountBillingEmailInput
}

Response

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

Arguments

Name Description

input (UpdateAccountConsentDataInput)

Input fields for updating user consent data.

Return fields

Name Description

Mutation

mutation UpdateAccountConsentData($input: UpdateAccountConsentDataInput) {
  updateAccountConsentData(input: $input) {
    consentData
  }
}

Variables

{
  "input": UpdateAccountConsentDataInput
}

Response

{
  "data": {
    "updateAccountConsentData": {
      "consentData": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
    }
  }
}

updateAccountConsents

Type: UpdateAccountConsents

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

Update the consents of an account

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

The account number to update consents for.

consents ([ConsentInput]!)

Consents to update for account.

Return fields

Name Description

Mutation

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

Variables

{
  "accountNumber": "A-D43F6D62",
  "consents": ConsentInput
}

Response

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

updateAccountReference

Type: UpdateAccountReference

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

Update an account reference.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

Name Description

Mutation

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

Variables

{
  "input": AccountReferenceInput
}

Response

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

updateAccountReferralStatus

Type: UpdateAccountReferralStatus

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

Update the status of an account referral.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAccountReferralStatusInput!)

Input fields for updating the status of an account referral.

Return fields

Name Description

Mutation

mutation UpdateAccountReferralStatus($input: UpdateAccountReferralStatusInput!) {
  updateAccountReferralStatus(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReferral {
      ...ReferralTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAccountReferralStatusInput
}

Response

{
  "data": {
    "updateAccountReferralStatus": {
      "possibleErrors": [PossibleErrorType],
      "accountReferral": ReferralType
    }
  }
}

updateAccountUser

Type: UpdateAccountUser

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

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.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAccountUserInput)

Input fields for updating user.

Return fields

Name Description

Mutation

mutation UpdateAccountUser($input: UpdateAccountUserInput) {
  updateAccountUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    viewer {
      ...AccountUserFragment
    }
  }
}

Variables

{
  "input": UpdateAccountUserInput
}

Response

{
  "data": {
    "updateAccountUser": {
      "possibleErrors": [PossibleErrorType],
      "viewer": AccountUser
    }
  }
}

updateAccountUserByUserId

Type: UpdateAccountUserByUserId

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

Update the account user details of the user with the given user id. This mutation does not have the one-field-per-day limitation, like the updateAccountUser does, and it requires a special permission to be used.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAccountUserInput)

Input fields for updating user.

Return fields

Name Description

Mutation

mutation UpdateAccountUserByUserId($input: UpdateAccountUserInput) {
  updateAccountUserByUserId(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    user {
      ...AccountUserFragment
    }
  }
}

Variables

{
  "input": UpdateAccountUserInput
}

Response

{
  "data": {
    "updateAccountUserByUserId": {
      "possibleErrors": [PossibleErrorType],
      "user": AccountUser
    }
  }
}

updateAccountUserConsents

Type: UpdateAccountUserConsents

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

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

The possible errors that can be raised are:

Arguments

Name Description

consents ([ConsentTypeInput])

Consents to update for account user.

userNumber (String)

User number of the account user to update consents for. Only needed if the viewer is an organization.

Return fields

Name Description

Mutation

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

Variables

{
  "consents": ConsentTypeInput,
  "userNumber": "energy-unit-particular-employee-another"
}

Response

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

updateActivePurchase

Type: UpdateActivePurchase

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

Update an active purchase.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdatePurchaseInput!)

Input fields for updating an active purchase.

Return fields

Name Description

Mutation

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

Variables

{
  "input": UpdatePurchaseInput
}

Response

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

Type: UpdateAffiliateLink!

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

Update an existing affiliate link.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAffiliateLinkInputType!)

Input fields for Updating an existing affiliate link.

Return fields

Name Description

Mutation

mutation UpdateAffiliateLink($input: UpdateAffiliateLinkInputType!) {
  updateAffiliateLink(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateLink {
      ...AffiliateLinkTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAffiliateLinkInputType
}

Response

{
  "data": {
    "updateAffiliateLink": {
      "possibleErrors": [PossibleErrorType],
      "affiliateLink": AffiliateLinkType
    }
  }
}

updateAffiliateOrganisation

Type: UpdateAffiliateOrganisation!

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

Update an existing affiliate organisation.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAffiliateOrganisationInputType!)

Input fields for Updating an existing affiliate organisation.

Return fields

Name Description

Mutation

mutation UpdateAffiliateOrganisation($input: UpdateAffiliateOrganisationInputType!) {
  updateAffiliateOrganisation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateOrganisation {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAffiliateOrganisationInputType
}

Response

{
  "data": {
    "updateAffiliateOrganisation": {
      "possibleErrors": [PossibleErrorType],
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

updateAgreementPeriod

Type: UpdateAgreementPeriod

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

Update the period of an agreement.

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-1501: Agreement not found.
  • KT-CT-1503: Agreement valid_to date must be later than valid_from date.
  • KT-CT-1504: Account does not match with the agreement.
  • KT-CT-1505: Unable to edit agreement.
  • KT-CT-1506: Agreement period is not within the supply and property period.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAgreementPeriodInput!)

Input for updating the agreement period.

Return fields

Name Description

Mutation

mutation UpdateAgreementPeriod($input: UpdateAgreementPeriodInput!) {
  updateAgreementPeriod(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementPeriodInput
}

Response

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

updateAmperageChangeRequest

Type: UpdateAmperageChangeRequest

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

Update an amperage change request as an organization.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAmperageChangeRequestInput)

Input fields for requesting an update to an amperage change.

Return fields

Name Description

Mutation

mutation UpdateAmperageChangeRequest($input: UpdateAmperageChangeRequestInput) {
  updateAmperageChangeRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

Variables

{
  "input": UpdateAmperageChangeRequestInput
}

Response

{
  "data": {
    "updateAmperageChangeRequest": {
      "possibleErrors": [PossibleErrorType],
      "message": "yard-already-government-system-college"
    }
  }
}

updateApiException

Type: UpdateAPIException

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

Mutation to update an existing APIException instance.

The possible errors that can be raised are:

  • KT-CT-7804: No fields present in the input for updating the APIException.
  • KT-CT-7803: Received an invalid apiExceptionId.
  • KT-CT-7809: Update results in no changes to API Exception.
  • KT-CT-7805: Too many tags associated with this API Exception.
  • KT-CT-7806: Cannot create duplicate tags for the same API exception.
  • KT-CT-7801: Received an invalid operationsTeamId.
  • KT-CT-7811: Received an invalid assignedUserId.
  • KT-CT-7812: Support user is inactive.
  • KT-CT-7814: Received an invalid accountNumber.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAPIExceptionInput!)

Input fields for updating an API exception.

Return fields

Name Description

Mutation

mutation UpdateApiException($input: UpdateAPIExceptionInput!) {
  updateApiException(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAPIExceptionInput
}

Response

{
  "data": {
    "updateApiException": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

updateApiExceptionNote

Type: UpdateAPIExceptionNote

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

Mutation to update an existing APIExceptionNote instance.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

Name Description

Mutation

mutation UpdateApiExceptionNote($input: UpdateAPIExceptionNoteInput!) {
  updateApiExceptionNote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAPIExceptionNoteInput
}

Response

{
  "data": {
    "updateApiExceptionNote": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

updateAutoTopUpAmount

Type: UpdateAutoTopUpAmount

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

Change the auto top up amount for the payment schedule.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAutoTopUpAmountInput!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": UpdateAutoTopUpAmountInput
}

Response

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

Arguments

Name Description

input (UpdateBankAccountDetailsInput)

Return fields

Name Description

Mutation

mutation UpdateBankAccountDetails($input: UpdateBankAccountDetailsInput) {
  updateBankAccountDetails(input: $input) {
    financialInstitutionRedirectUrl
    token
  }
}

Variables

{
  "input": UpdateBankAccountDetailsInput
}

Response

{
  "data": {
    "updateBankAccountDetails": {
      "financialInstitutionRedirectUrl": "region-condition-send-read-stock",
      "token": "me-him-history-as-from"
    }
  }
}

updateBoostCharge

Type: SmartFlexDeviceInterface

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

Update the boost charge for a specific device.

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)
  • BC_DEVICE_FULLY_CHARGED (device is already fully charged)

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateBoostChargeInput)

Return fields

Name Description

Mutation

mutation UpdateBoostCharge($input: UpdateBoostChargeInput) {
  updateBoostCharge(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateBoostChargeInput
}

Response

{
  "data": {
    "updateBoostCharge": {
      "id": "48130541",
      "name": "reach-inside-allow-force-help",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "49415899",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "21614374",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateCatalogInput

Type: UpdateInputOutput!

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

Update a catalog input.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateInputInput!)

Return fields

Name Description

Mutation

mutation UpdateCatalogInput($input: UpdateInputInput!) {
  updateCatalogInput(input: $input) {
    input {
      ...InputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateInputInput
}

Response

{
  "data": {
    "updateCatalogInput": {
      "input": InputType
    }
  }
}

updateCollectionProcessRecordToActive

Type: UpdateCollectionProcessRecordToActive

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

Update the Collection Process Record from raised status to active.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateCollectionProcessRecordToActiveInputType!)

Input variables needed for making a collection process record active.

Return fields

Name Description

Mutation

mutation UpdateCollectionProcessRecordToActive($input: UpdateCollectionProcessRecordToActiveInputType!) {
  updateCollectionProcessRecordToActive(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessActivated {
      ...UpdateCollectionProcessRecordToActiveOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordToActiveInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordToActive": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
    }
  }
}

updateCollectionProcessRecordToComplete

Type: UpdateCollectionProcessRecordToComplete

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

Update the Collection Process Record from raised status to complete.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateCollectionProcessRecordToCompleteInputType!)

Input variables needed for making a collection process record complete.

Return fields

Name Description

Mutation

mutation UpdateCollectionProcessRecordToComplete($input: UpdateCollectionProcessRecordToCompleteInputType!) {
  updateCollectionProcessRecordToComplete(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessComplete {
      ...UpdateCollectionProcessRecordToCompleteOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordToCompleteInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordToComplete": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
    }
  }
}

updateCommsDeliveryPreference

Type: UpdateCommsDeliveryPreference

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

Update account communication delivery preference.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account.

Return fields

Name Description

Mutation

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

Variables

{
  "input": UpdateCommsDeliveryPreferenceInput
}

Response

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

updateCommsPreferences

Type: UpdateAccountUserCommsPreferencesMutationPayload

URL: https://api.oejp-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

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

Variables

{
  "input": UpdateAccountUserCommsPreferencesMutationInput
}

Response

{
  "data": {
    "updateCommsPreferences": {
      "isOptedInToClientMessages": true,
      "isOptedInToOfferMessages": true,
      "isOptedInToRecommendedMessages": true,
      "isOptedInToUpdateMessages": true,
      "isOptedInToThirdPartyMessages": true,
      "isOptedInMeterReadingConfirmations": true,
      "isOptedInToSmsMessages": true,
      "isUsingInvertedEmailColours": true,
      "fontSizeMultiplier": 832.11,
      "emailFormat": "star-anyone-teacher-foreign-central",
      "preferredHoldMusic": "plan-act-machine-man-executive",
      "errors": [ErrorType],
      "commsPreferences": AccountUserCommsPreferences,
      "clientMutationId": "86458693"
    }
  }
}

updateCreditCardDetails

Type: UpdateCreditCardDetails

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

Updates credit card details for an account.

The possible errors that can be raised are:

  • KT-JP-3902: Payment instruction creation using the same card number on the same day is not allowed.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdateCreditCardDetailsInput)

Return fields

Name Description

Mutation

mutation UpdateCreditCardDetails($input: UpdateCreditCardDetailsInput) {
  updateCreditCardDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    cardNumber
  }
}

Variables

{
  "input": UpdateCreditCardDetailsInput
}

Response

{
  "data": {
    "updateCreditCardDetails": {
      "possibleErrors": [PossibleErrorType],
      "cardNumber": "light-should-report-next-either"
    }
  }
}

updateDcaProceeding

Type: UpdateDCAProceeding

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

Update the status of a DCA proceeding.

The possible errors that can be raised are:

  • KT-CT-11610: unable to edit the debt collection proceeding.
  • KT-CT-11604: Active debt collection proceeding does not exist for account.
  • KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateDCAProceedingInputType!)

Return fields

Name Description

Mutation

mutation UpdateDcaProceeding($input: UpdateDCAProceedingInputType!) {
  updateDcaProceeding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    dcaProceedingUpdateStatus {
      ...DCAProceedingUpdateStatusFragment
    }
  }
}

Variables

{
  "input": UpdateDCAProceedingInputType
}

Response

{
  "data": {
    "updateDcaProceeding": {
      "possibleErrors": [PossibleErrorType],
      "dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
    }
  }
}

Arguments

Name Description

input (UpdateDemandResponseCampaignParticipantCommsPreferencesInput)

Input fields for updating a participant's comms preferences.

Return fields

Name Description

Mutation

mutation UpdateDemandResponseCampaignParticipantCommsPreferences($input: UpdateDemandResponseCampaignParticipantCommsPreferencesInput) {
  updateDemandResponseCampaignParticipantCommsPreferences(input: $input)
}

Variables

{
  "input": UpdateDemandResponseCampaignParticipantCommsPreferencesInput
}

Response

{
  "data": {
    "updateDemandResponseCampaignParticipantCommsPreferences": DemandResponseCampaignParticipantCommsPreferencesResponse
  }
}

Arguments

Name Description

input (UpdateDemandResponseCampaignParticipantTipInput)

Input fields for updating a participant's value for a tip.

Return fields

Name Description

Mutation

mutation UpdateDemandResponseCampaignParticipantTip($input: UpdateDemandResponseCampaignParticipantTipInput) {
  updateDemandResponseCampaignParticipantTip(input: $input)
}

Variables

{
  "input": UpdateDemandResponseCampaignParticipantTipInput
}

Response

{
  "data": {
    "updateDemandResponseCampaignParticipantTip": UpdateDemandResponseCampaignParticipantTipResponse
  }
}

updateDeviceGridExport

Type: SmartFlexDeviceInterface

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

Update the grid export preference for a device.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4386: An error occurred while trying to update your device's grid export status.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdateDeviceGridExportInput)

Return fields

Name Description

Mutation

mutation UpdateDeviceGridExport($input: UpdateDeviceGridExportInput) {
  updateDeviceGridExport(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateDeviceGridExportInput
}

Response

{
  "data": {
    "updateDeviceGridExport": {
      "id": "53613694",
      "name": "start-smile-center-base-consumer",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "75933842",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "55402354",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateDeviceSmartControl

Type: SmartFlexDeviceInterface

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

Suspends or resumes the smart control of a specific device. For some devices, this will also adjust smart control of related devices. e.g. suspending one zone in a multi-zone heat pump system will suspend all zones in that system.

The possible errors that can be raised are:

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

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

Variables

{
  "input": SmartControlInput
}

Response

{
  "data": {
    "updateDeviceSmartControl": {
      "id": "34957153",
      "name": "just-avoid-product-child-study",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "68121503",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "35467895",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateDocumentAccessibilityPreference

Type: UpdateDocumentAccessibilityPreference!

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

Update the document accessibility preference for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateDocumentAccessibilityPreferenceInput!)

Input fields for updating document accessibility preference for an account.

Return fields

Name Description

Mutation

mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
  updateDocumentAccessibilityPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": UpdateDocumentAccessibilityPreferenceInput
}

Response

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

updateLeadAssignment

Type: UpdateLeadAssignment

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

Update assignment fields for a Lead.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateLeadAssignmentInput!)

Fields for updating a lead assignment.

Return fields

Name Description

Mutation

mutation UpdateLeadAssignment($input: UpdateLeadAssignmentInput!) {
  updateLeadAssignment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadAssignmentInput
}

Response

{
  "data": {
    "updateLeadAssignment": {
      "possibleErrors": [PossibleErrorType],
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadDetails

Type: UpdateLeadDetails

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

Update the details of a lead.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateLeadDetailsInput!)

Fields for updating a lead's details.

Return fields

Name Description

Mutation

mutation UpdateLeadDetails($input: UpdateLeadDetailsInput!) {
  updateLeadDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadDetailsInput
}

Response

{
  "data": {
    "updateLeadDetails": {
      "possibleErrors": [PossibleErrorType],
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadStage

Type: UpdateLeadStage

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

Update the stage of a lead.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateLeadStageInput!)

Fields for updating a lead's stage.

Return fields

Name Description

Mutation

mutation UpdateLeadStage($input: UpdateLeadStageInput!) {
  updateLeadStage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadStageInput
}

Response

{
  "data": {
    "updateLeadStage": {
      "possibleErrors": [PossibleErrorType],
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeaveSupplier

Type: LeaveSupplierUpdated!

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

Update an existing 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-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-1607: Value cannot be empty.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateLeaveSupplierInput!)

Return fields

Name Description

Mutation

mutation UpdateLeaveSupplier($input: UpdateLeaveSupplierInput!) {
  updateLeaveSupplier(input: $input) {
    message
  }
}

Variables

{
  "input": UpdateLeaveSupplierInput
}

Response

{
  "data": {
    "updateLeaveSupplier": {
      "message": "issue-but-bag-size-from"
    }
  }
}

updateMessageTags

Type: UpdateMessageTags

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

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateMessageTagsInput)

Return fields

Name Description

Mutation

mutation UpdateMessageTags($input: UpdateMessageTagsInput) {
  updateMessageTags(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    tags {
      ...InkTagFragment
    }
  }
}

Variables

{
  "input": UpdateMessageTagsInput
}

Response

{
  "data": {
    "updateMessageTags": {
      "possibleErrors": [PossibleErrorType],
      "tags": InkTag
    }
  }
}

updateMetadata

Type: UpdateMetadata

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

Update metadata on an object.

The possible errors that can be raised are:

Arguments

Name Description

input (MetadataInput!)

Input fields for updating metadata.

Return fields

Name Description

Mutation

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

Variables

{
  "input": MetadataInput
}

Response

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

updateMoveInDate

Type: UpdateMoveInDate

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

Update a supply point's move-in date.

Arguments

Name Description

input (UpdateMoveInDateInput)

Input fields for updating move-in date.

Return fields

Name Description

Mutation

mutation UpdateMoveInDate($input: UpdateMoveInDateInput) {
  updateMoveInDate(input: $input) {
    spin
    newMoveInDate
  }
}

Variables

{
  "input": UpdateMoveInDateInput
}

Response

{
  "data": {
    "updateMoveInDate": {
      "spin": "partner-party-physical-then-quickly",
      "newMoveInDate": "1997-09-19"
    }
  }
}

updateMoveOutDate

Type: UpdateMoveOutDate

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

Update a supply point's move-out date.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateMoveOutDateInput)

Input fields for updating move-out date.

Return fields

Name Description

Mutation

mutation UpdateMoveOutDate($input: UpdateMoveOutDateInput) {
  updateMoveOutDate(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    spin
    newMoveOutDate
    taskId
  }
}

Variables

{
  "input": UpdateMoveOutDateInput
}

Response

{
  "data": {
    "updateMoveOutDate": {
      "possibleErrors": [PossibleErrorType],
      "spin": "physical-must-dream-will-drive",
      "newMoveOutDate": "1976-01-20",
      "taskId": "53626461"
    }
  }
}

updateNotesOnOpportunity

Type: UpdateNotesOnOpportunity

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

Update the notes of an opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateNotesOnOpportunityInput!)

Input to update the note on an opportunity.

Return fields

Name Description

Mutation

mutation UpdateNotesOnOpportunity($input: UpdateNotesOnOpportunityInput!) {
  updateNotesOnOpportunity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
  }
}

Variables

{
  "input": UpdateNotesOnOpportunityInput
}

Response

{
  "data": {
    "updateNotesOnOpportunity": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "high-impact-exist-vote-great"
    }
  }
}

updateOfferGroupOnOpportunity

Type: UpdateOfferGroupOnOpportunity

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

Update the offer group of an opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateOfferGroupOnOpportunityInput!)

Input to update the offer group on an opportunity.

Return fields

Name Description

Mutation

mutation UpdateOfferGroupOnOpportunity($input: UpdateOfferGroupOnOpportunityInput!) {
  updateOfferGroupOnOpportunity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
  }
}

Variables

{
  "input": UpdateOfferGroupOnOpportunityInput
}

Response

{
  "data": {
    "updateOfferGroupOnOpportunity": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "trouble-game-just-list-rich"
    }
  }
}

updateOnSiteJobsAppointment

Type: UpdateOnSiteJobsAppointment

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

Update an Appointment.

The possible errors that can be raised are:

  • KT-CT-13001: Appointment does not exist.
  • KT-CT-13043: Cannot update appointment as it has terminal status.
  • KT-CT-13044: Failed to update appointment slot.
  • KT-CT-13018: Unable to record cancellation_category/cancellation_sub_category.
  • KT-CT-13039: Cancellation fields require CANCELLED status.
  • KT-CT-13045: Failed to update appointment assets.
  • KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
  • KT-CT-13051: Supply point not found when creating assets.
  • KT-CT-13052: Multiple supply points found when creating assets.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OnSiteJobsUpdateAppointmentInput!)

The appointment and its details to update.

Return fields

Name Description

Mutation

mutation UpdateOnSiteJobsAppointment($input: OnSiteJobsUpdateAppointmentInput!) {
  updateOnSiteJobsAppointment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

Variables

{
  "input": OnSiteJobsUpdateAppointmentInput
}

Response

{
  "data": {
    "updateOnSiteJobsAppointment": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

updateOnSiteJobsRequest

Type: UpdateOnSiteJobsRequest

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

Update an On Site Jobs Request.

The possible errors that can be raised are:

Arguments

Name Description

input (OnSiteJobsUpdateRequestInput!)

The input objects required to update a Request.

Return fields

Name Description

Mutation

mutation UpdateOnSiteJobsRequest($input: OnSiteJobsUpdateRequestInput!) {
  updateOnSiteJobsRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsRequest {
      ...OnSiteJobsRequestTypeFragment
    }
  }
}

Variables

{
  "input": OnSiteJobsUpdateRequestInput
}

Response

{
  "data": {
    "updateOnSiteJobsRequest": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

updateOpportunityAssignment

Type: UpdateOpportunityAssignment

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

Update assignment fields for an Opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateOpportunityAssignmentInput!)

Input fields for creating an opportunity.

Return fields

Name Description

Mutation

mutation UpdateOpportunityAssignment($input: UpdateOpportunityAssignmentInput!) {
  updateOpportunityAssignment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedOpportunityData
  }
}

Variables

{
  "input": UpdateOpportunityAssignmentInput
}

Response

{
  "data": {
    "updateOpportunityAssignment": {
      "possibleErrors": [PossibleErrorType],
      "updatedOpportunityData": {"key": "value"}
    }
  }
}

updateOpportunityExtraDetails

Type: UpdateOpportunityExtraDetails

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

Update the extra details of a opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateExtraDetailsInput!)

Input fields for updating the extra details of a opportunity.

Return fields

Name Description

Mutation

mutation UpdateOpportunityExtraDetails($input: UpdateExtraDetailsInput!) {
  updateOpportunityExtraDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    extraDetails
  }
}

Variables

{
  "input": UpdateExtraDetailsInput
}

Response

{
  "data": {
    "updateOpportunityExtraDetails": {
      "possibleErrors": [PossibleErrorType],
      "extraDetails": {"key": "value"}
    }
  }
}

updateOpportunityStage

Type: UpdateOpportunityStage

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

Update the stage of a opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateOpportunityStageInput!)

Input fields for updating the state of a opportunity.

Return fields

Name Description

Mutation

mutation UpdateOpportunityStage($input: UpdateOpportunityStageInput!) {
  updateOpportunityStage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

Variables

{
  "input": UpdateOpportunityStageInput
}

Response

{
  "data": {
    "updateOpportunityStage": {
      "possibleErrors": [PossibleErrorType],
      "message": "science-trip-ahead-try-first"
    }
  }
}

updatePassword

Type: UpdatePassword

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

Update password of the authenticated user

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdatePasswordInput)

Return fields

Name Description

Mutation

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

Variables

{
  "input": UpdatePasswordInput
}

Response

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

updateProductPrices

Type: UpdateProductPricesOutput!

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

Update the prices of a product.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateProductPricesInput!)

Return fields

Name Description

Mutation

mutation UpdateProductPrices($input: UpdateProductPricesInput!) {
  updateProductPrices(input: $input) {
    prices {
      ...RateGroupPricesFragment
    }
  }
}

Variables

{
  "input": UpdateProductPricesInput
}

Response

{
  "data": {
    "updateProductPrices": {
      "prices": RateGroupPrices
    }
  }
}

updateSiteworksRequest

Type: UpdateSiteworksRequest

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

Update a Request.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateSiteworksRequestInputType!)

The input objects required to update a Request.

Return fields

Name Description

Mutation

mutation UpdateSiteworksRequest($input: UpdateSiteworksRequestInputType!) {
  updateSiteworksRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    siteworksRequest {
      ...CoreSiteworksRequestTypeFragment
    }
  }
}

Variables

{
  "input": UpdateSiteworksRequestInputType
}

Response

{
  "data": {
    "updateSiteworksRequest": {
      "possibleErrors": [PossibleErrorType],
      "siteworksRequest": CoreSiteworksRequestType
    }
  }
}

updateTemplate

Type: UpdateTemplateOutput!

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

Update an existing template.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateTemplateInput!)

Return fields

Name Description

Mutation

mutation UpdateTemplate($input: UpdateTemplateInput!) {
  updateTemplate(input: $input) {
    template {
      ...TemplateTypeFragment
    }
  }
}

Variables

{
  "input": UpdateTemplateInput
}

Response

{
  "data": {
    "updateTemplate": {
      "template": TemplateType
    }
  }
}

updateUser

Type: UpdateUserMutation

URL: https://api.oejp-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:

Arguments

Name Description

input (UpdateUserInput!)

Input fields for updating user.

Return fields

Name Description

Mutation

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

Variables

{
  "input": UpdateUserInput
}

Response

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

updateUserDetails

Type: UpdateAccountUserMutationPayload

URL: https://api.oejp-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

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

Variables

{
  "input": UpdateAccountUserMutationInput
}

Response

{
  "data": {
    "updateUserDetails": {
      "givenName": "Scott",
      "familyName": "Graham",
      "pronouns": "be-operation-father-factor-at",
      "mobile": "pull-bill-quickly-rise-most",
      "email": "several-similar-simply-consumer-talk",
      "dateOfBirth": "2023-04-17",
      "landline": "mission-admit-smile-with-nothing",
      "errors": [ErrorType],
      "clientMutationId": "79837419"
    }
  }
}

Arguments

Name Description

input (ValidateEmailInput!)

Return fields

Name Description

Mutation

mutation ValidateEmail($input: ValidateEmailInput!) {
  validateEmail(input: $input) {
    isValid
  }
}

Variables

{
  "input": ValidateEmailInput
}

Response

{
  "data": {
    "validateEmail": {
      "isValid": true
    }
  }
}

validateMfaDevice

Type: ValidateMfaDevice

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

Validate MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": ValidateMfaDeviceInputType
}

Response

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

Arguments

Name Description

input (ValidatePhoneNumberInput!)

Return fields

Name Description

Mutation

mutation ValidatePhone($input: ValidatePhoneNumberInput!) {
  validatePhone(input: $input) {
    isValid
  }
}

Variables

{
  "input": ValidatePhoneNumberInput
}

Response

{
  "data": {
    "validatePhone": {
      "isValid": true
    }
  }
}

varyContractTerms

Type: VaryContractTermsOutput!

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

Vary the terms of a contract.

The possible errors that can be raised are:

Arguments

Name Description

input (VaryContractTermsInput!)

Return fields

Name Description

Mutation

mutation VaryContractTerms($input: VaryContractTermsInput!) {
  varyContractTerms(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": VaryContractTermsInput
}

Response

{
  "data": {
    "varyContractTerms": {
      "contract": Contract
    }
  }
}

verifyCustomer

Type: VerifyCustomer

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

Verify a customer using the provided verification code and type.

The possible errors that can be raised are:

Arguments

Name Description

input (VerifyCustomerInput!)

Return fields

Name Description

Mutation

mutation VerifyCustomer($input: VerifyCustomerInput!) {
  verifyCustomer(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    user {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": VerifyCustomerInput
}

Response

{
  "data": {
    "verifyCustomer": {
      "possibleErrors": [PossibleErrorType],
      "user": AccountUserType
    }
  }
}

verifyEmail

Type: VerifyEmail

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

Verify user's email address.

The possible errors that can be raised are:

Arguments

Name Description

input (VerifyEmailInput!)

Return fields

Name Description

Mutation

mutation VerifyEmail($input: VerifyEmailInput!) {
  verifyEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    isVerified
  }
}

Variables

{
  "input": VerifyEmailInput
}

Response

{
  "data": {
    "verifyEmail": {
      "possibleErrors": [PossibleErrorType],
      "isVerified": true
    }
  }
}

verifyIdentity

Type: VerifyIdentity

URL: https://api.oejp-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:

Arguments

Name Description

input (VerifyIdentityInput!)

Details about the user to be verified.

Return fields

Name Description

Mutation

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

Variables

{
  "input": VerifyIdentityInput
}

Response

{
  "data": {
    "verifyIdentity": {
      "possibleErrors": [PossibleErrorType],
      "token": "law-enough-free-bit-information"
    }
  }
}

withdrawAccount

Type: WithdrawAccount

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

Withdraw an account.

The possible errors that can be raised are:

Arguments

Name Description

input (WithdrawAccountInput)

Input fields for updating user consent data.

Return fields

Name Description

Mutation

mutation WithdrawAccount($input: WithdrawAccountInput) {
  withdrawAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountNumber
  }
}

Variables

{
  "input": WithdrawAccountInput
}

Response

{
  "data": {
    "withdrawAccount": {
      "possibleErrors": [PossibleErrorType],
      "accountNumber": "A-0F80F64F"
    }
  }
}

withdrawDunning

Type: WithdrawDunning

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

Withdraw a dunning process for an account

The possible errors that can be raised are:

Arguments

Name Description

input (WithdrawDunningInputType!)

Input variables needed for withdrawing a dunning process for an account.

Return fields

Name Description

Mutation

mutation WithdrawDunning($input: WithdrawDunningInputType!) {
  withdrawDunning(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    withdrawSuccessful
  }
}

Variables

{
  "input": WithdrawDunningInputType
}

Response

{
  "data": {
    "withdrawDunning": {
      "possibleErrors": [PossibleErrorType],
      "withdrawSuccessful": true
    }
  }
}

Authentication Server

createMfaDevice

Type: CreateMfaDevice

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

Create MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateMfaDeviceInputType!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": CreateMfaDeviceInputType
}

Response

{
  "data": {
    "createMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceEmail": "point-item-already-peace-wind",
      "devicePhone": "themselves-must-account-boy-hold",
      "totpSecret": "worker-relate-fall-its-grow"
    }
  }
}

deleteMfaDevice

Type: DeleteMfaDevice

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

Delete MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": DeleteMfaDeviceInputType
}

Response

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

validateMfaDevice

Type: ValidateMfaDevice

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

Validate MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

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

Return fields

Name Description

Mutation

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

Variables

{
  "input": ValidateMfaDeviceInputType
}

Response

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