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.

API Site

acceptGoodsQuote

Type:AcceptGoodsQuote

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

Accept a goods quote.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AcceptGoodsQuoteInput!)

Input fields for accepting a quote.

Return fields

NameDescription

goodsPurchase (GoodsPurchase)

Goods purchase created.

Mutation

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

Variables

{
  "input": AcceptGoodsQuoteInput
}

Response

{
  "data": {
    "acceptGoodsQuote": {
      "goodsPurchase": GoodsPurchase
    }
  }
}

acceptOfferForQuoting

Type:AcceptOfferForQuoting

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

Accept a quoting offer in an offer group.

The possible errors that can be raised are:

  • KT-CT-12402: Unable to accept offer.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AcceptOfferForQuotingInput!)

Input fields for accepting a quoting offer.

Return fields

NameDescription

offer (OfferType)

Accepted quoting offer.

Mutation

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

Variables

{
  "input": AcceptOfferForQuotingInput
}

Response

{
  "data": {
    "acceptOfferForQuoting": {
      "offer": OfferType
    }
  }
}

actualizeContract

Type:ActualizeContractOutput!

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

Actualize a contract for an account or business.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10007: Unable to terminate contract.
  • KT-CT-10008: The contract is currently undergoing an active journey.
  • KT-CT-10022: Contract already terminated.
  • KT-CT-10023: Contract is already revoked.
  • KT-CT-10024: Contract already expired.
  • KT-CT-10026: Contract actualization implies breach.
  • KT-CT-10041: Contract is already rescinded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ActualizeContractInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": ActualizeContractInput
}

Response

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

addBusinessToSegment

Type:AddBusinessToSegmentMutation

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

Add a business to a segment.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11107: Unauthorized.
  • KT-CT-11111: Segment does not exist.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddBusinessToSegmentInput!)

Input fields for adding a business to a segment.

Return fields

NameDescription

businessSegmentPeriod (BusinessSegmentPeriodType)

The business segment period that was created.

Mutation

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

Variables

{
  "input": AddBusinessToSegmentInput
}

Response

{
  "data": {
    "addBusinessToSegment": {
      "businessSegmentPeriod": BusinessSegmentPeriodType
    }
  }
}

addCampaignToAccount

Type:AddCampaignToAccount

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4123: Unauthorized.
  • KT-CT-7427: No campaign found with given slug.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddCampaignToAccountInput!)

Input variables needed for adding a campaign to an account.

Return fields

NameDescription

campaignAdded (Boolean)

Whether the campaign was successfully added.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": AddCampaignToAccountInput
}

Response

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

addChildToProperty

Type:AddChildToProperty

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

Add a child property to a parent property in a hierarchy.

If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-6622: Unauthorized.
  • KT-CT-6634: Unable to add child to property.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddChildToPropertyInput!)

Input fields for adding a child to a parent property.

Return fields

NameDescription

child (PropertyType)

The child property that was added to the parent.

Mutation

mutation AddChildToProperty($input: AddChildToPropertyInput!) {
  addChildToProperty(input: $input) {
    child {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": AddChildToPropertyInput
}

Response

{
  "data": {
    "addChildToProperty": {
      "child": PropertyType
    }
  }
}

addCustomEvent

Type:AddCustomEventMutation

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

Add a custom event for an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

accountNumber (String!)

category (String!)

content (String!)

subCategory (String)

Return fields

NameDescription

event (CustomEventType)

Resulting Kraken event

This field requires the Authorization header to be set.

Mutation

mutation AddCustomEvent(
  $accountNumber: String!,
  $category: String!,
  $content: String!,
  $subCategory: String
) {
  addCustomEvent(
    accountNumber: $accountNumber,
    category: $category,
    content: $content,
    subCategory: $subCategory
  ) {
    event {
      ...CustomEventTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "category": "abc123",
  "content": "abc123",
  "subCategory": "abc123"
}

Response

{
  "data": {
    "addCustomEvent": {
      "event": CustomEventType
    }
  }
}

addItemsToRiskList

Type:AddItemsToRiskList

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

Add new items to the risk list.

The possible errors that can be raised are:

  • KT-CT-12105: Risk list item addition failed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input ([RiskListItemInputType]!)

A list of risk list items to add.

Return fields

NameDescription

riskIdentifiers ([RiskListItemType])

List of successfully added risk identifiers.

Mutation

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

Variables

{
  "input": RiskListItemInputType
}

Response

{
  "data": {
    "addItemsToRiskList": {
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

addNoteToInkConversation

Type:AddNoteToInkConversation

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

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddNoteToInkConversationInput)

Input for adding a note to a conversation.

Return fields

NameDescription

note (InkNote)

The ink conversation note.

Mutation

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

Variables

{
  "input": AddNoteToInkConversationInput
}

Response

{
  "data": {
    "addNoteToInkConversation": {
      "note": InkNote
    }
  }
}

addParentToProperty

Type:AddParentToProperty

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

Add a parent property to a child property in a hierarchy.

If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-6622: Unauthorized.
  • KT-CT-6635: Unable to add parent to property.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddParentToPropertyInput!)

Input fields for adding a parent to a child property.

Return fields

NameDescription

parent (PropertyType)

The parent property that was added to the child.

Mutation

mutation AddParentToProperty($input: AddParentToPropertyInput!) {
  addParentToProperty(input: $input) {
    parent {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": AddParentToPropertyInput
}

Response

{
  "data": {
    "addParentToProperty": {
      "parent": PropertyType
    }
  }
}

addPartnerUserToTeam

Type:AddPartnerUserToTeam!

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

Add an existing partner user to a partner team.

The possible errors that can be raised are:

  • KT-CT-7725: Unauthorized.
  • KT-CT-7726: Unauthorized.
  • KT-CT-7729: The partner user and team must belong to the same organisation.
  • KT-CT-7730: The partner user is already a member of this team.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddPartnerUserToTeamInput!)

Input fields for adding a partner user to a team.

Return fields

NameDescription

Mutation

mutation AddPartnerUserToTeam($input: AddPartnerUserToTeamInput!) {
  addPartnerUserToTeam(input: $input) {
    partnerUser {
      ...PartnerUserTypeFragment
    }
  }
}

Variables

{
  "input": AddPartnerUserToTeamInput
}

Response

{
  "data": {
    "addPartnerUserToTeam": {
      "partnerUser": PartnerUserType
    }
  }
}

addPortfolioReference

Type:AddPortfolioReference

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

Add a reference to an existing portfolio.

The possible errors that can be raised are:

  • KT-CT-9403: Received an invalid portfolioId.
  • KT-CT-9410: Conflicting portfolio reference.
  • KT-CT-9408: Invalid portfolio number format.
  • KT-CT-9409: Invalid portfolio reference.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddPortfolioReferenceInput)

Input fields for adding a reference to a portfolio.

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": AddPortfolioReferenceInput
}

Response

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

addProperty

Type:AddProperty

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

Add a property to an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AddPropertyInput!)

Input fields for adding a property to an account.

Return fields

NameDescription

property (PropertyType)

The property that was added to the account.

Mutation

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

Variables

{
  "input": AddPropertyInput
}

Response

{
  "data": {
    "addProperty": {
      "property": PropertyType
    }
  }
}

addPropertyToHierarchy

Type:AddPropertyToHierarchy

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

Add a property to a hierarchy as a root node.

If the property is already a root node in the hierarchy, this operation is idempotent. If the property is already in the hierarchy as a child, an error will be raised.

The possible errors that can be raised are:

  • KT-CT-6622: Unauthorized.
  • KT-CT-6633: Property is already in the hierarchy as a child.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddPropertyToHierarchyInput!)

Input fields for adding a property to a hierarchy.

Return fields

NameDescription

property (PropertyType)

The property that was added to the hierarchy.

Mutation

mutation AddPropertyToHierarchy($input: AddPropertyToHierarchyInput!) {
  addPropertyToHierarchy(input: $input) {
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": AddPropertyToHierarchyInput
}

Response

{
  "data": {
    "addPropertyToHierarchy": {
      "property": PropertyType
    }
  }
}

addSignupReferralOnAccount

Type:AddSignupReferralOnAccount

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

Add a one-way signup reward to a referral.

The possible errors that can be raised are:

  • KT-CT-6723: Unauthorized.
  • KT-CT-6729: This scheme cannot be applied to given account.
  • KT-CT-6710: Unable to create referral.
  • KT-CT-6728: This referral scheme's usage is at capacity.
  • KT-CT-6712: Invalid reference.
  • KT-CT-6713: Referring and referred account brands do not match.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddSignupReferralOnAccountInput!)

Input fields for creating a signup reward for an organization.

Return fields

NameDescription

accountReferral (ReferralType)

The created account referral instance.

Mutation

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

Variables

{
  "input": AddSignupReferralOnAccountInput
}

Response

{
  "data": {
    "addSignupReferralOnAccount": {
      "accountReferral": ReferralType
    }
  }
}

addStorylineToInkConversation

Type:AddStorylineToInkConversation

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

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-7651: Only one storyline entry can be marked as the root cause.
  • KT-CT-7657: The provided analyzer result data is invalid.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddStorylineToInkConversationInput)

Input for adding a storyline to a conversation.

Return fields

NameDescription

storyline (InkStoryline)

The storyline that was added to the conversation.

Mutation

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

Variables

{
  "input": AddStorylineToInkConversationInput
}

Response

{
  "data": {
    "addStorylineToInkConversation": {
      "storyline": InkStoryline
    }
  }
}

addUserToPortfolio

Type:AddUserToPortfolio

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

Add an user to a portfolio with a specified role.

The possible errors that can be raised are:

  • KT-CT-5461: Invalid role code.
  • KT-CT-5462: Invalid user number format.
  • KT-CT-5463: Unauthorized.
  • KT-CT-9407: Unauthorized.
  • KT-CT-9408: Invalid portfolio number format.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AddUserToPortfolioInput!)

Input fields for adding a user to a portfolio.

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": AddUserToPortfolioInput
}

Response

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

allowRepaymentSubmission

Type:AllowRepaymentSubmission

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

Allow a repayment to be submitted.

The possible errors that can be raised are:

  • KT-CT-3944: Account repayment does not exist.
  • KT-CT-3945: Unable to allow a repayment to be submitted.
  • KT-CT-3950: The provided reason text is too long.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RepaymentInput!)

Input variable needed for allowing repayment submission.

Return fields

NameDescription

repaymentId (ID)

The repayment ID.

repaymentIntervention (RepaymentInterventionType)

Resulting Repayment Intervention details.

Mutation

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

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "allowRepaymentSubmission": {
      "repaymentId": "abc123",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

amendPayment

Type:AmendPayment

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

Amend an existing payment.

The possible errors that can be raised are:

  • KT-CT-3924: Unauthorized.
  • KT-CT-4123: Unauthorized.
  • KT-CT-3970: The account cannot amend payments.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AmendPaymentInput!)

Input fields for amending an existing payment.

Return fields

NameDescription

payment (AccountPaymentType)

Mutation

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

Variables

{
  "input": AmendPaymentInput
}

Response

{
  "data": {
    "amendPayment": {
      "payment": AccountPaymentType
    }
  }
}

approveRepayment

Type:ApproveRepayment

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

Approve a repayment.

The possible errors that can be raised are:

  • KT-CT-3934: Repayment request already approved.
  • KT-CT-3935: Repayment request cannot be paid.
  • KT-CT-3959: Unauthorized.
  • KT-CT-3973: Repayment request is not in a state to be approved.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ApproveRepaymentInput!)

Input fields for approving a repayment.

Return fields

NameDescription

repayment (AccountRepaymentType)

The approved repayment.

Mutation

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

Variables

{
  "input": ApproveRepaymentInput
}

Response

{
  "data": {
    "approveRepayment": {
      "repayment": AccountRepaymentType
    }
  }
}

assessCollectionProcessRecordForPause

Type:AssessCollectionProcessRecordForPause

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

Assess a collection process record for pause and pause or unpause it based on the assessment.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssessCollectionProcessRecordForPauseInputType!)

Details of collection process to run the pause assessment.

Return fields

NameDescription

collectionProcessProcessed (AssessCollectionProcessRecordForPauseOutputType)

Details of collection process after running the pause assessment.

Mutation

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

Variables

{
  "input": AssessCollectionProcessRecordForPauseInputType
}

Response

{
  "data": {
    "assessCollectionProcessRecordForPause": {
      "collectionProcessProcessed": AssessCollectionProcessRecordForPauseOutputType
    }
  }
}

assignInkBucket

Type:AssignInkBucket

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

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-7613: The Ink bucket was not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssignInkBucketInput)

Input for assigning an conversation to a Bucket.

Return fields

NameDescription

conversation (InkConversation!)

The conversation that will be assigned to the bucket.

bucket (InkBucket!)

The bucket that the conversation will be assigned to.

Mutation

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

Variables

{
  "input": AssignInkBucketInput
}

Response

{
  "data": {
    "assignInkBucket": {
      "conversation": InkConversation,
      "bucket": InkBucket
    }
  }
}

assignSupplyPointToEstimationGroup

Type:AssignSupplyPointToEstimationGroup

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13601: Estimation Group does not exist.
  • KT-CT-13602: Supply Point already has an Estimation Group.
  • KT-CT-13603: Supply Point does not exist.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssignSupplyPointToEstimationGroupInput!)

Input fields for assigning a supply point to an estimation group.

Return fields

NameDescription

supplyPointEstimationGroup (AssignedSupplyPointEstimationGroupType)

The created supply point estimation group mapping.

Mutation

mutation AssignSupplyPointToEstimationGroup($input: AssignSupplyPointToEstimationGroupInput!) {
  assignSupplyPointToEstimationGroup(input: $input) {
    supplyPointEstimationGroup {
      ...AssignedSupplyPointEstimationGroupTypeFragment
    }
  }
}

Variables

{
  "input": AssignSupplyPointToEstimationGroupInput
}

Response

{
  "data": {
    "assignSupplyPointToEstimationGroup": {
      "supplyPointEstimationGroup": AssignedSupplyPointEstimationGroupType
    }
  }
}

associateArchivedCallRecordingsWithCalls

Type:AssociateArchivedCallRecordingsWithCalls

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

The possible errors that can be raised are:

  • KT-CT-11818: Invalid archived call recordings input.
  • KT-CT-11820: Too many recordings to associate in a single request.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssociateArchivedCallRecordingsWithCallsInput!)

Input for associating archived call recordings with calls.

Return fields

NameDescription

summary (AssociateArchivedRecordingsSummaryType)

Summary counts of the processing results.

results ([AssociateArchivedRecordingResultType])

Per-recording processing results.

Mutation

mutation AssociateArchivedCallRecordingsWithCalls($input: AssociateArchivedCallRecordingsWithCallsInput!) {
  associateArchivedCallRecordingsWithCalls(input: $input) {
    summary {
      ...AssociateArchivedRecordingsSummaryTypeFragment
    }
    results {
      ...AssociateArchivedRecordingResultTypeFragment
    }
  }
}

Variables

{
  "input": AssociateArchivedCallRecordingsWithCallsInput
}

Response

{
  "data": {
    "associateArchivedCallRecordingsWithCalls": {
      "summary": AssociateArchivedRecordingsSummaryType,
      "results": [AssociateArchivedRecordingResultType]
    }
  }
}

associateCallWithAccount

Type:AssociateCallWithAccount

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

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-11802: Call not found.
  • KT-CT-11808: Unable to associate account to call.
  • KT-CT-11817: Invalid call ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssociateCallWithAccountInput!)

Return fields

NameDescription

call (InboundCallType)

The call.

Mutation

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

Variables

{
  "input": AssociateCallWithAccountInput
}

Response

{
  "data": {
    "associateCallWithAccount": {
      "call": InboundCallType
    }
  }
}

associateItemToCollectionProcess

Type:AssociateItemToCollectionProcess

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

Associate an item to a collection process record.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11205: Item already associated to collection process.
  • KT-CT-11216: Invalid extra_details for associated item type.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssociateItemToCollectionProcessInputType!)

Input variables needed for associating an item to collection process.

Return fields

NameDescription

collectionProcessAssociatedItem (AssociateItemToCollectionProcessOutputType)

Item associated to the collection process.

Mutation

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

Variables

{
  "input": AssociateItemToCollectionProcessInputType
}

Response

{
  "data": {
    "associateItemToCollectionProcess": {
      "collectionProcessAssociatedItem": AssociateItemToCollectionProcessOutputType
    }
  }
}

attachAgreementsToContracts

Type:AttachAgreementsToContractsOutput!

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

Attach a list of agreements to one or both contract types.

The possible errors that can be raised are:

  • KT-CT-1501: Agreement not found.
  • KT-CT-10003: Contract not found.
  • KT-CT-10042: One or more agreements are already attached to a different contract.
  • KT-CT-10043: At least one contract identifier must be provided.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AttachAgreementsToContractsInput!)

Input for attaching agreements to contracts.

Return fields

NameDescription

Mutation

mutation AttachAgreementsToContracts($input: AttachAgreementsToContractsInput!) {
  attachAgreementsToContracts(input: $input) {
    ok
  }
}

Variables

{
  "input": AttachAgreementsToContractsInput
}

Response

{
  "data": {
    "attachAgreementsToContracts": {
      "ok": true
    }
  }
}

awardLoyaltyPoints

Type:AwardLoyaltyPoints

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

Award the specified number of Loyalty Points to the account.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-9202: Loyalty Points adapter not configured.
  • KT-CT-9204: Negative or zero points set.
  • KT-CT-9208: Invalid posted at datetime.
  • KT-CT-9210: Unhandled Loyalty Points exception.
  • KT-CT-9211: Invalid reason for loyalty points award.
  • KT-CT-9212: Points exceed maximum limit.
  • KT-CT-9219: Loyalty points user not found.
  • KT-CT-9221: Idempotency key already used on ledger entry.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AwardLoyaltyPointsInput!)

Input fields for awarding Loyalty Points.

Return fields

NameDescription

pointsAwarded (Int)

The number of loyalty points that were awarded.

ledgerEntry (LoyaltyPointLedgerEntryType)

The ledger entry for the awarded loyalty points.

Mutation

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

Variables

{
  "input": AwardLoyaltyPointsInput
}

Response

{
  "data": {
    "awardLoyaltyPoints": {
      "pointsAwarded": 1,
      "ledgerEntry": LoyaltyPointLedgerEntryType
    }
  }
}

backendScreenEvent

Type:BackendScreenEvent

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

NameDescription

action (ActionType)

An action to perform.

Mutation

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

Variables

{
  "input": BackendScreenEventInput
}

Response

{
  "data": {
    "backendScreenEvent": {
      "action": DeeplinkActionType
    }
  }
}

blockRepaymentSubmission

Type:BlockRepaymentSubmission

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

Block a repayment from being submitted.

The possible errors that can be raised are:

  • KT-CT-3944: Account repayment does not exist.
  • KT-CT-3946: Unable to block a repayment from being submitted.
  • KT-CT-3950: The provided reason text is too long.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RepaymentInput!)

Input variable needed for blocking repayment submission.

Return fields

NameDescription

repaymentId (ID)

The repayment ID.

repaymentIntervention (RepaymentInterventionType)

Resulting Repayment Intervention details.

Mutation

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

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "blockRepaymentSubmission": {
      "repaymentId": "abc123",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

bulkAwardLoyaltyPoints

Type:BulkAwardLoyaltyPoints

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

Award Loyalty Points to multiple accounts in a single request.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-9202: Loyalty Points adapter not configured.
  • KT-CT-9212: Points exceed maximum limit.
  • KT-CT-9221: Idempotency key already used on ledger entry.
  • KT-CT-9224: Duplicate idempotency keys provided in requested awards.
  • KT-CT-9225: Bulk award batch size exceeds the maximum limit.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (BulkAwardLoyaltyPointsInput!)

Input fields for bulk awarding Loyalty Points.

Return fields

NameDescription

inserted ([BulkAwardLoyaltyPointsInsertedItemResult])

Successfully inserted loyalty point awards.

failed ([BulkAwardLoyaltyPointsFailedItemResult])

Failed loyalty point awards.

Mutation

mutation BulkAwardLoyaltyPoints($input: BulkAwardLoyaltyPointsInput!) {
  bulkAwardLoyaltyPoints(input: $input) {
    inserted {
      ...BulkAwardLoyaltyPointsInsertedItemResultFragment
    }
    failed {
      ...BulkAwardLoyaltyPointsFailedItemResultFragment
    }
  }
}

Variables

{
  "input": BulkAwardLoyaltyPointsInput
}

Response

{
  "data": {
    "bulkAwardLoyaltyPoints": {
      "inserted": [BulkAwardLoyaltyPointsInsertedItemResult],
      "failed": [BulkAwardLoyaltyPointsFailedItemResult]
    }
  }
}

cancelCentrepayDeduction

Type:CancelCentrepayDeduction

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

Initiate a request to cancel an existing Centrepay Deduction.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-AU-3923: Centrepay Deduction with provided ID does not exist.
  • KT-AU-3924: You do not have permission to administer this Centrepay Deduction.
  • KT-AU-3925: Cannot cancel this Centrepay Deduction.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CancelCentrepayDeductionInputType!)

Input data for cancelling a Centrepay Deduction.

Return fields

NameDescription

centrepayDeduction (CentrepayDeductionType!)

Details of Centrepay Deduction to be cancelled.

Mutation

mutation CancelCentrepayDeduction($input: CancelCentrepayDeductionInputType!) {
  cancelCentrepayDeduction(input: $input) {
    centrepayDeduction {
      ...CentrepayDeductionTypeFragment
    }
  }
}

Variables

{
  "input": CancelCentrepayDeductionInputType
}

Response

{
  "data": {
    "cancelCentrepayDeduction": {
      "centrepayDeduction": CentrepayDeductionType
    }
  }
}

cancelEnrollment

Type:EnrollmentCancelled!

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

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

The possible errors that can be raised are:

  • KT-CT-10312: Mutation not enabled in this environment.
  • KT-CT-10318: Enrollment process not found.
  • KT-CT-10319: Enrollment process failed to cancel.
  • KT-CT-10320: Enrollment process not cancellable.
  • KT-CT-10321: Enrollment cancellation workflow not defined.
  • KT-CT-10323: Enrollment process failed to cancel.
  • KT-CT-10338: Enrollment process cannot be cancelled.
  • KT-CT-10331: Missing required process number.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CancelEnrollmentInput!)

Return fields

NameDescription

Mutation

mutation CancelEnrollment($input: CancelEnrollmentInput!) {
  cancelEnrollment(input: $input) {
    message
    enrollmentProcess {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
  }
}

Variables

{
  "input": CancelEnrollmentInput
}

Response

{
  "data": {
    "cancelEnrollment": {
      "message": "abc123",
      "enrollmentProcess": JoinSupplierProcessType
    }
  }
}

cancelHouseMoveIn

Type:CancelHouseMoveIn

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

Mutation to cancel a triggered move in process for a given account

The possible errors that can be raised are:

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

Arguments

NameDescription

input (MoveInCancelInput!)

Return fields

NameDescription

account (AccountType)

error (CancelHouseMoveInErrorUnion)

Mutation

mutation CancelHouseMoveIn($input: MoveInCancelInput!) {
  cancelHouseMoveIn(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on HouseMoveInCancelExceptionErrorType {
        ...HouseMoveInCancelExceptionErrorTypeFragment
      }
      ... on UnableToCancelServiceOrderErrorType {
        ...UnableToCancelServiceOrderErrorTypeFragment
      }
      ... on InvalidWithdrawalRequestErrorType {
        ...InvalidWithdrawalRequestErrorTypeFragment
      }
      ... on UnableToWithdrawChangeRequestErrorType {
        ...UnableToWithdrawChangeRequestErrorTypeFragment
      }
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on PreconditionsNotMetErrorType {
        ...PreconditionsNotMetErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": MoveInCancelInput
}

Response

{
  "data": {
    "cancelHouseMoveIn": {
      "account": AccountType,
      "error": HouseMoveInCancelExceptionErrorType
    }
  }
}

cancelHouseMoveOut

Type:CancelHouseMoveOut

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

Mutation to cancel a triggered move out process for a given account

The possible errors that can be raised are:

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

Arguments

NameDescription

input (MoveOutCancelInput!)

Return fields

NameDescription

account (AccountType)

error (CancelHouseMoveErrorUnion)

Mutation

mutation CancelHouseMoveOut($input: MoveOutCancelInput!) {
  cancelHouseMoveOut(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on UnableToUndoMoveErrorType {
        ...UnableToUndoMoveErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": MoveOutCancelInput
}

Response

{
  "data": {
    "cancelHouseMoveOut": {
      "account": AccountType,
      "error": DoesNotExistErrorType
    }
  }
}

cancelLeaveSupplier

Type:LeaveSupplierCancelled!

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

NameDescription

input (CancelLeaveSupplierInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CancelLeaveSupplierInput
}

Response

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

cancelPayment

Type:CancelPayment

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

Cancel an in-flight payment.

The possible errors that can be raised are:

  • KT-CT-3924: Unauthorized.
  • KT-CT-3954: Payment cancellation failed.
  • KT-CT-3955: Payment cannot be cancelled.
  • KT-CT-3956: Temporary error occurred.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CancelPaymentInput!)

Input fields for cancelling a pending payment.

Return fields

NameDescription

payment (AccountPaymentType)

The cancelled payment.

Mutation

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

Variables

{
  "input": CancelPaymentInput
}

Response

{
  "data": {
    "cancelPayment": {
      "payment": AccountPaymentType
    }
  }
}

cancelRepaymentRequest

Type:CancelRepaymentRequest

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

Cancel a repayment or refund request.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CancelRepaymentRequestInputType!)

Input fields for cancelling a repayment request.

Return fields

NameDescription

repaymentRequest (CancelRepaymentRequestOutputType)

The cancelled repayment/refund request.

Mutation

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

Variables

{
  "input": CancelRepaymentRequestInputType
}

Response

{
  "data": {
    "cancelRepaymentRequest": {
      "repaymentRequest": CancelRepaymentRequestOutputType
    }
  }
}

changeCentrepayDeduction

Type:ChangeCentrepayDeduction

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

Initiate a request to change the details of an existing Centrepay Deduction.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-AU-3923: Centrepay Deduction with provided ID does not exist.
  • KT-AU-3924: You do not have permission to administer this Centrepay Deduction.
  • KT-AU-3928: Cannot Cannot change validFrom date of Deduction that is already active.
  • KT-AU-3920: Cannot provide both validTo and targetAmount values.
  • KT-AU-3927: No change data provided.
  • KT-AU-3926: Cannot change this Centrepay Deduction.
  • KT-AU-3930: Centrepay Deduction amount cannot be greater than Target Amount.
  • KT-AU-3916: Centrepay Deduction amount must be greater than $10.00.
  • KT-AU-3914: Centrepay Deduction valid_to date must be later than today.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ChangeCentrepayDeductionInputType!)

Input data for changing a Centrepay Deduction.

Return fields

NameDescription

centrepayDeduction (CentrepayDeductionType!)

Details of Centrepay Deduction to be changed.

Mutation

mutation ChangeCentrepayDeduction($input: ChangeCentrepayDeductionInputType!) {
  changeCentrepayDeduction(input: $input) {
    centrepayDeduction {
      ...CentrepayDeductionTypeFragment
    }
  }
}

Variables

{
  "input": ChangeCentrepayDeductionInputType
}

Response

{
  "data": {
    "changeCentrepayDeduction": {
      "centrepayDeduction": CentrepayDeductionType
    }
  }
}

closeDcaProceeding

Type:CloseDCAProceeding

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

NameDescription

input (CloseDCAProceedingInputType!)

Return fields

NameDescription

dcaProceedingClosureStatus (DCAProceedingClosureStatus)

Whether the closure could be applied.

Mutation

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

Variables

{
  "input": CloseDCAProceedingInputType
}

Response

{
  "data": {
    "closeDcaProceeding": {
      "dcaProceedingClosureStatus": DCAProceedingClosureStatus
    }
  }
}

closeInkConversation

Type:CloseInkConversation

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

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CloseInkConversationInput)

Input for closing an Ink conversation.

Return fields

NameDescription

conversation (InkConversation)

The conversation that was closed.

Mutation

mutation CloseInkConversation($input: CloseInkConversationInput) {
  closeInkConversation(input: $input) {
    conversation {
      ...InkConversationFragment
    }
  }
}

Variables

{
  "input": CloseInkConversationInput
}

Response

{
  "data": {
    "closeInkConversation": {
      "conversation": InkConversation
    }
  }
}

closeInkLiveChat

Type:CloseInkLiveChatConversation

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

The possible errors that can be raised are:

  • KT-CT-7616: Not yet implemented.
  • KT-CT-7643: The Live Chat was not found.
  • KT-CT-7644: Ink Live Chat conversation not found.
  • KT-CT-7652: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CloseInkLiveChaConversationtInput)

Input for closing a live-chat conversation.

Return fields

NameDescription

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

Mutation

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

Variables

{
  "input": CloseInkLiveChaConversationtInput
}

Response

{
  "data": {
    "closeInkLiveChat": {
      "liveChatConversation": InkLiveChatConversation
    }
  }
}

closeOpenPrintBatch

Type:CloseOpenPrintBatch!

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

Close the Open Print Batch if any.

The possible errors that can be raised are:

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

Return fields

NameDescription

Mutation

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

Response

{
  "data": {
    "closeOpenPrintBatch": {
      "printBatch": PrintBatchType
    }
  }
}

collectDeposit

Type:CollectDeposit

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

Collect deposit for the given account.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-CT-5711: No collection is required.
  • KT-CT-5712: Deposit agreement does not exist or has not been accepted.
  • KT-CT-5713: Payment instruction is not usable.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CollectDepositInput!)

Return fields

NameDescription

payment (CollectDepositOutput)

Mutation

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

Variables

{
  "input": CollectDepositInput
}

Response

{
  "data": {
    "collectDeposit": {
      "payment": CollectDepositOutput
    }
  }
}

collectPayment

Type:CollectPayment

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CollectPaymentInput!)

Input fields for collecting a payment.

Return fields

NameDescription

payment (AccountPaymentType)

Details about the collected payment. Note that we might not be able to collect the payment (e.g. if there is no usable payment instruction), in which case the status of the returned payment might be failed or cancelled.

Mutation

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

Variables

{
  "input": CollectPaymentInput
}

Response

{
  "data": {
    "collectPayment": {
      "payment": AccountPaymentType
    }
  }
}

commenceDcaProceeding

Type:CommenceDCAProceeding

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

NameDescription

input (CommenceDCAProceedingInputType!)

Return fields

NameDescription

dcaProceedingCommencementStatus (DCAProceedingCommencementStatus)

Whether the commencement could be applied.

Mutation

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

Variables

{
  "input": CommenceDCAProceedingInputType
}

Response

{
  "data": {
    "commenceDcaProceeding": {
      "dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
    }
  }
}

completeApproval

Type:CompleteApproval

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

Complete an approval by marking it as approved or rejected.

The possible errors that can be raised are:

  • KT-CT-14802: Invalid input for completing approval.
  • KT-CT-14801: Approval not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CompleteApprovalInputType!)

Input for completing the approval.

Return fields

NameDescription

completedApproval (CompletedApproval)

The result of completing the approval.

Mutation

mutation CompleteApproval($input: CompleteApprovalInputType!) {
  completeApproval(input: $input) {
    completedApproval {
      ...CompletedApprovalFragment
    }
  }
}

Variables

{
  "input": CompleteApprovalInputType
}

Response

{
  "data": {
    "completeApproval": {
      "completedApproval": CompletedApproval
    }
  }
}

completeReminder

Type:CompleteReminder

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

Complete a reminder.

The possible errors that can be raised are:

  • KT-CT-1406: Invalid data.
  • KT-CT-1407: Unable to complete reminder.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CompleteReminderInput!)

Input variables needed for completing a reminder.

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

mutation CompleteReminder($input: CompleteReminderInput!) {
  completeReminder(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": CompleteReminderInput
}

Response

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

completeStandalonePayment

Type:CompleteStandalonePayment

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

Complete an initiated standalone payment.

The possible errors that can be raised are:

  • KT-CT-3822: Unauthorized.
  • KT-CT-3823: Unauthorized.
  • KT-CT-3974: Unauthorized.
  • KT-CT-3975: Unable to complete standalone payment.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CompleteStandalonePaymentInput!)

Input fields for completing a standalone payment.

Return fields

NameDescription

payment (CompleteStandalonePaymentOutput)

The completed standalone payment.

Mutation

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

Variables

{
  "input": CompleteStandalonePaymentInput
}

Response

{
  "data": {
    "completeStandalonePayment": {
      "payment": CompleteStandalonePaymentOutput
    }
  }
}

confirmDoubleOptIn

Type:ConfirmDoubleOptIn

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

Confirm a double opt in

The possible errors that can be raised are:

  • KT-CT-9016: Consent management not enabled.
  • KT-CT-9020: Invalid consent expiring token.
  • KT-CT-9021: Consent expiring token not found.
  • KT-CT-9022: Consent for given token already accepted.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ConfirmDoubleOptInInput)

Return fields

NameDescription

consent (ConsentType)

The consent that was created or updated.

Mutation

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

Variables

{
  "input": ConfirmDoubleOptInInput
}

Response

{
  "data": {
    "confirmDoubleOptIn": {
      "consent": ConsentType
    }
  }
}

connectAiAgentToCall

Type:ConnectAiAgentToCall

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

The possible errors that can be raised are:

  • KT-CT-11802: Call not found.
  • KT-CT-11815: Unable to connect a call to an AI agent.
  • KT-CT-11817: Invalid call ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ConnectAiAgentToCallInput!)

Return fields

NameDescription

call (InboundCallType)

The call the AI agent was connected to.

Mutation

mutation ConnectAiAgentToCall($input: ConnectAiAgentToCallInput!) {
  connectAiAgentToCall(input: $input) {
    call {
      ...InboundCallTypeFragment
    }
  }
}

Variables

{
  "input": ConnectAiAgentToCallInput
}

Response

{
  "data": {
    "connectAiAgentToCall": {
      "call": InboundCallType
    }
  }
}

createAccountCharge

Type:CreateAccountCharge

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

Add charges to an account.

The possible errors that can be raised are:

  • KT-CT-5211: The charge reason with the requested code is deprecated.
  • KT-CT-5212: The charge reason with the requested code does not exist.
  • KT-CT-5213: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAccountChargeInput!)

Input fields for creating an account charge.

Return fields

NameDescription

accountCharge (AccountChargeType)

Mutation

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

Variables

{
  "input": CreateAccountChargeInput
}

Response

{
  "data": {
    "createAccountCharge": {
      "accountCharge": AccountChargeType
    }
  }
}

createAccountNote

Type:CreateAccountNote

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

Add a note to an account, identified by account number or supply point.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-4180: Account note must be a valid string.
  • KT-AU-4110: Either accountNumber or both supplyPointIdentifier and marketName must be provided.
  • KT-AU-4111: No account found for the given supply point.
  • KT-CT-4196: Unpin at date provided is in the past.
  • KT-CT-4195: Unpin at date provided for an unpinned note.
  • KT-CT-4719: No supply point found for identifier provided.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAccountNoteInput!)

Input variables needed for adding a note to an account.

Return fields

NameDescription

account (AccountType)

Account, which has the added note.

note (AccountNoteType)

The created account note.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": CreateAccountNoteInput
}

Response

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

createAccountPaymentSchedule

Type:CreateAccountPaymentSchedule

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateAccountPaymentScheduleInput!)

Input fields for updating a payment schedule.

Return fields

NameDescription

schedule (PaymentScheduleType!)

New payment schedule.

Mutation

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

Variables

{
  "input": CreateAccountPaymentScheduleInput
}

Response

{
  "data": {
    "createAccountPaymentSchedule": {
      "schedule": PaymentScheduleType
    }
  }
}

createAccountReference

Type:CreateAccountReference

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

Create an account reference.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

NameDescription

accountReference (AccountReferenceType)

Mutation

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

Variables

{
  "input": AccountReferenceInput
}

Response

{
  "data": {
    "createAccountReference": {
      "accountReference": AccountReferenceType
    }
  }
}

createAccountReminder

Type:CreateAccountReminder

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

Create an account reminder.

The possible errors that can be raised are:

  • KT-CT-1401: Invalid data.
  • KT-CT-1402: Unable to create account reminder.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'createAccountReminder' field is deprecated.


This mutation rely on legacy reminder types.
Please use the createReminder mutation which uses the new registry based reminder types instead.


- Marked as deprecated on 2024-11-14.
- Scheduled for removal on or after 2025-04-16.

Arguments

NameDescription

input (CreateAccountReminderInput!)

Input variables needed for creating an account reminder.

Return fields

NameDescription

accountReminder (AccountReminder)

Account reminder.

Mutation

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

Variables

{
  "input": CreateAccountReminderInput
}

Response

{
  "data": {
    "createAccountReminder": {
      "accountReminder": AccountReminder
    }
  }
}

createAccountUser

Type:CreateAccountUser

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

Create a new account user.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateAccountUserInput!)

Return fields

NameDescription

accountUser (AccountUserType)

The account user.

Mutation

mutation CreateAccountUser($input: CreateAccountUserInput!) {
  createAccountUser(input: $input) {
    accountUser {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountUserInput
}

Response

{
  "data": {
    "createAccountUser": {
      "accountUser": AccountUserType
    }
  }
}

Type:CreateAffiliateLink!

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

Create an affiliate link for a new sales agent.

The possible errors that can be raised are:

  • KT-CT-7711: Invalid data.
  • KT-CT-7713: Invalid data.
  • KT-CT-7714: Invalid data.
  • KT-CT-7715: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAffiliateLinkInputType!)

Input fields for creating an affiliate link for an organisation.

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateAffiliateLinkInputType
}

Response

{
  "data": {
    "createAffiliateLink": {
      "affiliateLink": AffiliateLinkType
    }
  }
}

createAffiliateOrganisation

Type:CreateAffiliateOrganisation!

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

Create an affiliate organisation.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateAffiliateOrganisationInputType!)

Input fields for creating an affiliate organisation.

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateAffiliateOrganisationInputType
}

Response

{
  "data": {
    "createAffiliateOrganisation": {
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

createAffiliateSession

Type:CreateAffiliateSession!

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

Create a session for an affiliate link.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateAffiliateSessionInputType!)

Input fields for creating a session for an affiliate link.

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateAffiliateSessionInputType
}

Response

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

createAgreement

Type:CreateAgreement

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

Create a new agreement.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-4719: No supply point found for identifier provided.
  • KT-CT-4910: No product exists with the given input.
  • KT-CT-1503: Agreement validto date must be later than validfrom date.
  • KT-CT-1509: Unable to create agreement.
  • KT-CT-1511: Cannot create overlapping agreement.
  • KT-CT-1512: Account type does not support agreements.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAgreementInput!)

Input fields for creating an agreement.

Return fields

NameDescription

agreement (CommonAgreementType)

The created agreement.

Mutation

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

Variables

{
  "input": CreateAgreementInput
}

Response

{
  "data": {
    "createAgreement": {
      "agreement": CommonAgreementType
    }
  }
}

createAgreementRollover

Type:CreateAgreementRollover

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

Create an agreement rollover for a specific account and agreement.

The possible errors that can be raised are:

  • KT-CT-1501: Agreement not found.
  • KT-CT-4910: No product exists with the given input.
  • KT-CT-4924: Unauthorized.
  • KT-CT-13701: An active agreement rollover already exists for this agreement.
  • KT-CT-13702: Expected send date cannot be in the past.
  • KT-CT-13703: Rollover date cannot be in the past.
  • KT-CT-13704: Unable to create agreement rollover.
  • KT-CT-13708: Agreement rollover validation error.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAgreementRolloverInput!)

Create an agreement rollover for a specific account and agreement.

Return fields

NameDescription

agreementRollover (AgreementRolloverType)

The new agreement rollover.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": CreateAgreementRolloverInput
}

Response

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

createApiCall

Type:CreateAPICall

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

Mutation to create a new APICall instance.

The possible errors that can be raised are:

  • KT-CT-7803: Received an invalid apiExceptionId.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAPICallInput!)

Input fields for creating an API call.

Return fields

NameDescription

apiCall (APICallType)

The created APICall.

Mutation

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

Variables

{
  "input": CreateAPICallInput
}

Response

{
  "data": {
    "createApiCall": {
      "apiCall": APICallType
    }
  }
}

createApiException

Type:CreateAPIException

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

NameDescription

input (CreateAPIExceptionInput!)

Input fields for creating an API exception.

Return fields

NameDescription

apiException (APIExceptionType)

The created APIException.

Mutation

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

Variables

{
  "input": CreateAPIExceptionInput
}

Response

{
  "data": {
    "createApiException": {
      "apiException": APIExceptionType
    }
  }
}

createApiExceptionEvent

Type:CreateAPIExceptionEvent

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

Mutation to create a new APIExceptionEvent instance.

The possible errors that can be raised are:

  • KT-CT-7803: Received an invalid apiExceptionId.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAPIExceptionEventInput!)

Input fields for creating an API exception event.

Return fields

NameDescription

apiExceptionEvent (APIExceptionEventType)

The created APIExceptionEvent.

Mutation

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

Variables

{
  "input": CreateAPIExceptionEventInput
}

Response

{
  "data": {
    "createApiExceptionEvent": {
      "apiExceptionEvent": APIExceptionEventType
    }
  }
}

createApiExceptionNote

Type:CreateAPIExceptionNote

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

Mutation to create a new APIExceptionNote instance.

The possible errors that can be raised are:

  • KT-CT-7803: Received an invalid apiExceptionId.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

NameDescription

apiException (APIExceptionType)

The created APIExceptionNote.

Mutation

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

Variables

{
  "input": CreateAPIExceptionNoteInput
}

Response

{
  "data": {
    "createApiExceptionNote": {
      "apiException": APIExceptionType
    }
  }
}

createAudioRecording

Type:CreateAudioRecording!

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

Create an audio recording for an affiliate session.

The possible errors that can be raised are:

  • KT-CT-7720: Invalid S3 key format.
  • KT-CT-7721: Link not found.
  • KT-CT-7722: Invalid input for audio recording upload.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AudioRecordingInputType!)

Input fields required to create an audio recording.

Return fields

NameDescription

Mutation

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

Variables

{
  "input": AudioRecordingInputType
}

Response

{
  "data": {
    "createAudioRecording": {
      "audioRecording": AudioRecordingType
    }
  }
}

createBusiness

Type:CreateBusiness

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

Create a business.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateBusinessInput!)

Input for creating a business.

Return fields

NameDescription

business (BusinessType)

The created business.

Mutation

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

Variables

{
  "input": CreateBusinessInput
}

Response

{
  "data": {
    "createBusiness": {
      "business": BusinessType
    }
  }
}

createCallMetadata

Type:CreateCallMetadata

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

The possible errors that can be raised are:

  • KT-CT-11802: Call not found.
  • KT-CT-11806: Call metadata item key cannot be an empty string.
  • KT-CT-11807: A call metadata item with this key already exists for this call.
  • KT-CT-11817: Invalid call ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CallMetadataInput!)

Return fields

NameDescription

call (CallInterface)

The call metadata was attached to.

Mutation

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

Variables

{
  "input": CallMetadataInput
}

Response

{
  "data": {
    "createCallMetadata": {
      "call": CallInterface
    }
  }
}

createCampaignItems

Type:CreateCampaignItems

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

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-11501: Voice campaign not found.
  • KT-CT-11503: One or more campaign items are invalid and cannot be created.
  • KT-CT-11504: The batch of campaign items is too large.
  • KT-CT-11506: Invalid campaign ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateCampaignItemsInput!)

Return fields

NameDescription

campaignItems ([VoiceCampaignItemType])

batchIdentifier (String)

The identifier for this batch of items to assist in tracking and logging.

Mutation

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

Variables

{
  "input": CreateCampaignItemsInput
}

Response

{
  "data": {
    "createCampaignItems": {
      "campaignItems": [VoiceCampaignItemType],
      "batchIdentifier": "abc123"
    }
  }
}

createCentrepayDeduction

Type:CreateCentrepayDeduction

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

Initiate a request to create a new Centrepay Deduction for an account.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-CT-3923: Unauthorized.
  • KT-AU-3913: Centrepay Deduction valid_from date cannot be before today.
  • KT-AU-3914: Centrepay Deduction valid_to date must be later than today.
  • KT-AU-3915: Centrepay Deduction validto date must be later than validfrom date.
  • KT-AU-3916: Centrepay Deduction amount must be greater than $10.00.
  • KT-AU-3920: Cannot provide both validTo and targetAmount values.
  • KT-AU-3912: Cannot create a Centrepay Deduction with these details.
  • KT-AU-3930: Centrepay Deduction amount cannot be greater than Target Amount.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateCentrepayDeductionInputType!)

Input data for creating a new Centrepay Deduction.

Return fields

NameDescription

centrepayDeduction (CentrepayDeductionType!)

Details of resulting request to add a Centrepay Deduction.

Mutation

mutation CreateCentrepayDeduction($input: CreateCentrepayDeductionInputType!) {
  createCentrepayDeduction(input: $input) {
    centrepayDeduction {
      ...CentrepayDeductionTypeFragment
    }
  }
}

Variables

{
  "input": CreateCentrepayDeductionInputType
}

Response

{
  "data": {
    "createCentrepayDeduction": {
      "centrepayDeduction": CentrepayDeductionType
    }
  }
}

createCollectionProcessEvent

Type:CreateCollectionProcessEvent

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

Create a collection process event to track significant events such as reactivations and errors.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-1605: Invalid input.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateCollectionProcessEventInputType!)

Input variables needed for creating a collection process event.

Return fields

NameDescription

collectionProcessEvent (CollectionProcessEventOutputType)

The created collection process event.

Mutation

mutation CreateCollectionProcessEvent($input: CreateCollectionProcessEventInputType!) {
  createCollectionProcessEvent(input: $input) {
    collectionProcessEvent {
      ...CollectionProcessEventOutputTypeFragment
    }
  }
}

Variables

{
  "input": CreateCollectionProcessEventInputType
}

Response

{
  "data": {
    "createCollectionProcessEvent": {
      "collectionProcessEvent": CollectionProcessEventOutputType
    }
  }
}

createComplaint

Type:CreateComplaint

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

Create a complaint.

The possible errors that can be raised are:

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

Arguments

NameDescription

complaint (CreateComplaintInputType!)

Return fields

NameDescription

complaint (ComplaintType)

The complaint that has been created.

Mutation

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

Variables

{
  "complaint": CreateComplaintInputType
}

Response

{
  "data": {
    "createComplaint": {
      "complaint": ComplaintType
    }
  }
}

createConcession

Type:CreateConcession

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateConcessionInput!)

Return fields

NameDescription

concession (ConcessionType)

error (ConcessionCreationErrorUnion)

Mutation

mutation CreateConcession($input: CreateConcessionInput!) {
  createConcession(input: $input) {
    concession {
      ...ConcessionTypeFragment
    }
    error {
      ... on ConcessionAlreadyExistsErrorType {
        ...ConcessionAlreadyExistsErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": CreateConcessionInput
}

Response

{
  "data": {
    "createConcession": {
      "concession": ConcessionType,
      "error": ConcessionAlreadyExistsErrorType
    }
  }
}

createContract

Type:CreateContractOutput!

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

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

The possible errors that can be raised are:

  • KT-CT-10001: Party is already under contract.
  • KT-CT-10006: Account not found.
  • KT-CT-10021: Business not found.
  • KT-CT-10018: The provided contract subject is invalid.
  • KT-CT-10019: Contract creation implies breach.
  • KT-CT-10020: The provided contract party payload is invalid.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateContractInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateContractInput
}

Response

{
  "data": {
    "createContract": {
      "identifier": NonEmptyString,
      "wasCreated": true
    }
  }
}

createContributionAgreement

Type:CreateContributionAgreement

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

Create a contribution agreement for an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateContributionAgreementInput!)

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

Return fields

NameDescription

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

Mutation

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

Variables

{
  "input": CreateContributionAgreementInput
}

Response

{
  "data": {
    "createContributionAgreement": {
      "contributionAgreement": ContributionAgreementType
    }
  }
}

createCreditTransferPermission

Type:CreateCreditTransferPermission

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

Create a credit transfer permission.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateCreditTransferPermissionInput!)

Input fields to create a credit transfer permission.

Return fields

NameDescription

validFrom (DateTime)

Datetime when the credit transfer permission is valid.

Mutation

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

Variables

{
  "input": CreateCreditTransferPermissionInput
}

Response

{
  "data": {
    "createCreditTransferPermission": {
      "validFrom": "2020-01-01T00:00:00.000Z"
    }
  }
}

createCustomerFeedback

Type:CreateCustomerFeedback

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

Create unsubmitted customer feedback object.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateCustomerFeedbackInputType!)

Return fields

NameDescription

customerFeedback (CustomerFeedbackType)

The created customer feedback object.

Mutation

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

Variables

{
  "input": CreateCustomerFeedbackInputType
}

Response

{
  "data": {
    "createCustomerFeedback": {
      "customerFeedback": CustomerFeedbackType
    }
  }
}

createDepositAgreement

Type:CreateDepositAgreement

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateDepositAgreementInput!)

Return fields

NameDescription

depositAgreement (CreateDepositAgreementOutput)

Mutation

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

Variables

{
  "input": CreateDepositAgreementInput
}

Response

{
  "data": {
    "createDepositAgreement": {
      "depositAgreement": CreateDepositAgreementOutput
    }
  }
}

createDirectDebitInstruction

Type:CreateDirectDebitInstruction

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

Create new direct debit instruction

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-CT-3940: Invalid data.
  • KT-CT-3923: Unauthorized.
  • KT-CT-3979: Invalid ledger.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'createDirectDebitInstruction' field is deprecated.

Use `setUpDirectDebitInstruction` instead.

- Marked as deprecated on 2024-02-05.
- Scheduled for removal on or after 2024-08-01.

Arguments

NameDescription

input (CreateDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction.

Return fields

NameDescription

directDebitInstruction (DirectDebitInstructionType)

Mutation

mutation CreateDirectDebitInstruction($input: CreateDirectDebitInstructionInput!) {
  createDirectDebitInstruction(input: $input) {
    directDebitInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

Variables

{
  "input": CreateDirectDebitInstructionInput
}

Response

{
  "data": {
    "createDirectDebitInstruction": {
      "directDebitInstruction": DirectDebitInstructionType
    }
  }
}

createElectricityQuote

Type:CreateElectricityQuote

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

Mutation to create an electricity quote for a different nmi for a related account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateElectricityQuoteInput!)

Return fields

NameDescription

quote (QuoteType)

The quote created.

meterPoint (MeterPointType)

The meter point created (if the nmi is available).

Mutation

mutation CreateElectricityQuote($input: CreateElectricityQuoteInput!) {
  createElectricityQuote(input: $input) {
    quote {
      ...QuoteTypeFragment
    }
    meterPoint {
      ...MeterPointTypeFragment
    }
  }
}

Variables

{
  "input": CreateElectricityQuoteInput
}

Response

{
  "data": {
    "createElectricityQuote": {
      "quote": QuoteType,
      "meterPoint": MeterPointType
    }
  }
}

createElectricitySelfMeterReads

Type:CreateCustomerSelfMeterReads

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

Create electricity self meter reads.

The possible errors that can be raised are:

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

Arguments

NameDescription

readings ([CustomerSelfMeterReadInput]!)

shouldTriggerCustomerToBillReminder (Boolean)

Generate an account reminder for energy specialists to Trigger a billing action on the customers account.

Return fields

NameDescription

readings ([ElectricityAccumulationMeterReadingType])

Electricity readings generated from input.

error (ReadingValidationSaveErrorUnion)

Error types associated to handled errors during electricity reading generation.

Mutation

mutation CreateElectricitySelfMeterReads(
  $readings: [CustomerSelfMeterReadInput]!,
  $shouldTriggerCustomerToBillReminder: Boolean
) {
  createElectricitySelfMeterReads(
    readings: $readings,
    shouldTriggerCustomerToBillReminder: $shouldTriggerCustomerToBillReminder
  ) {
    readings {
      ...ElectricityAccumulationMeterReadingTypeFragment
    }
    error {
      ... on MultipleMeterpointsValidationErrorType {
        ...MultipleMeterpointsValidationErrorTypeFragment
      }
      ... on MissingReadingsValidationErrorType {
        ...MissingReadingsValidationErrorTypeFragment
      }
      ... on MissingAccountForRegisterValidationErrorType {
        ...MissingAccountForRegisterValidationErrorTypeFragment
      }
      ... on InvalidTimezoneReadAtDateValidationErrorType {
        ...InvalidTimezoneReadAtDateValidationErrorTypeFragment
      }
      ... on UnableToValidateReadingType {
        ...UnableToValidateReadingTypeFragment
      }
    }
  }
}

Variables

{
  "readings": CustomerSelfMeterReadInput,
  "shouldTriggerCustomerToBillReminder": true
}

Response

{
  "data": {
    "createElectricitySelfMeterReads": {
      "readings": [ElectricityAccumulationMeterReadingType],
      "error": MultipleMeterpointsValidationErrorType
    }
  }
}

createExternalAccountEvent

Type:CreateExternalAccountEvent

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

Create an external account event.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateExternalAccountEventInput!)

Input fields for creating an external account event.

Return fields

NameDescription

event (ExternalAccountEvent)

The new event data.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": CreateExternalAccountEventInput
}

Response

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

createExternalAccountUserEvent

Type:CreateExternalAccountUserEvent

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

Create an external account user event.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateExternalAccountUserEventInput!)

Input fields for creating an external account event.

Return fields

NameDescription

event (ExternalAccountUserEvent)

The new event data.

Mutation

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

Variables

{
  "input": CreateExternalAccountUserEventInput
}

Response

{
  "data": {
    "createExternalAccountUserEvent": {
      "event": ExternalAccountUserEvent
    }
  }
}

createExternalMessage

Type:CreateExternalMessage

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

Create an external message to record communications sent by external vendors. This allows you to import messages, such as emails, sent using other tools into Kraken.

The possible errors that can be raised are:

  • KT-CT-14201: Vendor is empty.
  • KT-CT-14202: Vendor message ID is empty.
  • KT-CT-14203: Account number is empty.
  • KT-CT-14204: Message already exists.
  • KT-CT-14205: Unable to create the external message.
  • KT-CT-14206: An email body is missing.
  • KT-CT-14207: To email is empty.
  • KT-CT-14208: To email is not a valid email address.
  • KT-CT-14209: From email is empty.
  • KT-CT-14210: From email is an invalid format.
  • KT-CT-14211: A reply to email address is empty.
  • KT-CT-14212: A reply to email address is not a valid email address.
  • KT-CT-14214: An account number was provided, but no corresponding account could be found.
  • KT-CT-14215: Sent at datetime is in the future.
  • KT-CT-14216: Sent at datetime is missing timezone.
  • KT-CT-14219: Exactly one of emailContent or smsContent must be provided.
  • KT-CT-14220: SMS body is empty.
  • KT-CT-14221: To phone number is empty.
  • KT-CT-14222: From phone number is empty.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateExternalMessageInput!)

Input variables needed for creating an external message.

Return fields

NameDescription

externalMessage (ExternalMessageType)

The external message that was created.

Mutation

mutation CreateExternalMessage($input: CreateExternalMessageInput!) {
  createExternalMessage(input: $input) {
    externalMessage {
      ...ExternalMessageTypeFragment
    }
  }
}

Variables

{
  "input": CreateExternalMessageInput
}

Response

{
  "data": {
    "createExternalMessage": {
      "externalMessage": ExternalMessageType
    }
  }
}

createExternalMessageEvent

Type:CreateExternalMessageEvent

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

Record a lifecycle event, such as a delivery confirmation, bounce, or link click, for a previously created external message.

The possible errors that can be raised are:

  • KT-CT-14217: Message not found.
  • KT-CT-14218: Invalid event data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateExternalMessageEventInput!)

The event to record against an external message.

Return fields

NameDescription

externalMessageEvent (ExternalMessageEventType)

The external message event that was created.

Mutation

mutation CreateExternalMessageEvent($input: CreateExternalMessageEventInput!) {
  createExternalMessageEvent(input: $input) {
    externalMessageEvent {
      ...ExternalMessageEventTypeFragment
    }
  }
}

Variables

{
  "input": CreateExternalMessageEventInput
}

Response

{
  "data": {
    "createExternalMessageEvent": {
      "externalMessageEvent": ExternalMessageEventType
    }
  }
}

createFamilyIssuesSuppressedCommAccountEvent

Type:CreateFamilyIssuesSuppressedCommAccountEvent

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

Creates an account event if the account has users with family issues and the trigger's audit trail confirms a life support comm was suppressed due to family issues. Returns the created event, or null if conditions were not met.

The possible errors that can be raised are:

  • KT-CT-9904: Trigger not found.
  • KT-CT-1605: Invalid input.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

accountNumber (String!)

The account number to create the event for.

triggerId (ID!)

The ID of the trigger whose comms were suppressed.

Return fields

NameDescription

event (CustomEventType)

The account event created if conditions were met, otherwise null.

Mutation

mutation CreateFamilyIssuesSuppressedCommAccountEvent(
  $accountNumber: String!,
  $triggerId: ID!
) {
  createFamilyIssuesSuppressedCommAccountEvent(
    accountNumber: $accountNumber,
    triggerId: $triggerId
  ) {
    event {
      ...CustomEventTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "triggerId": "abc123"
}

Response

{
  "data": {
    "createFamilyIssuesSuppressedCommAccountEvent": {
      "event": CustomEventType
    }
  }
}

createFixedPaymentSchedule

Type:CreateFixedPaymentSchedule

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

Create a fixed payment schedule for the authenticated user.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (FixedPaymentScheduleInput!)

Return fields

NameDescription

paymentSchedule (PaymentScheduleType)

The payment schedule created.

error (FixedPaymentScheduleErrorUnion)

Mutation

mutation CreateFixedPaymentSchedule($input: FixedPaymentScheduleInput!) {
  createFixedPaymentSchedule(input: $input) {
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
    error {
      ... on OutOfBoundsPaymentDayErrorType {
        ...OutOfBoundsPaymentDayErrorTypeFragment
      }
      ... on ScheduleOverlapErrorType {
        ...ScheduleOverlapErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": FixedPaymentScheduleInput
}

Response

{
  "data": {
    "createFixedPaymentSchedule": {
      "paymentSchedule": PaymentScheduleType,
      "error": OutOfBoundsPaymentDayErrorType
    }
  }
}

createFormSubmission

Type:FormSubmissionOuput

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (FormSubmissionInput!)

Return fields

NameDescription

id (Int)

content (JSONString)

errors ([SerializerFieldErrorsType])

Mutation

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

Variables

{
  "input": FormSubmissionInput
}

Response

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

createGasQuote

Type:CreateGasQuote

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

Mutation to create a gas quote for a property.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateGasQuoteInput!)

Return fields

NameDescription

quoteRequest (QuoteRequestType)

error (CreateGasQuoteErrorUnion)

Mutation

mutation CreateGasQuote($input: CreateGasQuoteInput!) {
  createGasQuote(input: $input) {
    quoteRequest {
      ...QuoteRequestTypeFragment
    }
    error {
      ... on NoSupplyPointsAssociatedWithMirnErrorType {
        ...NoSupplyPointsAssociatedWithMirnErrorTypeFragment
      }
      ... on TermsAndConditionsCanNotBeFoundErrorType {
        ...TermsAndConditionsCanNotBeFoundErrorTypeFragment
      }
      ... on NoSuitableProductsFoundErrorType {
        ...NoSuitableProductsFoundErrorTypeFragment
      }
      ... on UnsupportedMarketErrorType {
        ...UnsupportedMarketErrorTypeFragment
      }
      ... on SupplyPointOnEmbeddedProperty {
        ...SupplyPointOnEmbeddedPropertyFragment
      }
      ... on UnableToQuoteErrorType {
        ...UnableToQuoteErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": CreateGasQuoteInput
}

Response

{
  "data": {
    "createGasQuote": {
      "quoteRequest": QuoteRequestType,
      "error": NoSupplyPointsAssociatedWithMirnErrorType
    }
  }
}

createGasSelfMeterReads

Type:CreateGasSelfMeterReads

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

Create gas self meter reads.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateGasMeterReadsInput!)

Return fields

NameDescription

readings ([GasMeterReadingType])

Gas readings generated from input.

error (GasReadingValidationSaveErrorUnion)

Error types associated to handled errors during gas reading generation.

Mutation

mutation CreateGasSelfMeterReads($input: CreateGasMeterReadsInput!) {
  createGasSelfMeterReads(input: $input) {
    readings {
      ...GasMeterReadingTypeFragment
    }
    error {
      ... on ReadingCreationErrorType {
        ...ReadingCreationErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": CreateGasMeterReadsInput
}

Response

{
  "data": {
    "createGasSelfMeterReads": {
      "readings": [GasMeterReadingType],
      "error": ReadingCreationErrorType
    }
  }
}

createGasSupplyPoint

Type:CreateGasSupplyPoint

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

Create a new supply point along with a property and a gas meter point.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateGasSupplyPointInput!)

Return fields

NameDescription

gasSupplyPoint (GasSupplyPointType)

error (CreateGasSupplyPointErrorUnion)

Mutation

mutation CreateGasSupplyPoint($input: CreateGasSupplyPointInput!) {
  createGasSupplyPoint(input: $input) {
    gasSupplyPoint {
      ...GasSupplyPointTypeFragment
    }
    error {
      ... on MirnAlreadyExistsErrorType {
        ...MirnAlreadyExistsErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": CreateGasSupplyPointInput
}

Response

{
  "data": {
    "createGasSupplyPoint": {
      "gasSupplyPoint": GasSupplyPointType,
      "error": MirnAlreadyExistsErrorType
    }
  }
}

createGoodsPurchase

Type:CreateGoodsPurchase

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

Create a goods purchase.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreatePurchaseInput!)

Input fields for creating a purchase without a quote.

Return fields

NameDescription

goodsPurchase (GoodsPurchase)

Goods purchase created.

Mutation

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

Variables

{
  "input": CreatePurchaseInput
}

Response

{
  "data": {
    "createGoodsPurchase": {
      "goodsPurchase": GoodsPurchase
    }
  }
}

createGoodsQuote

Type:CreateGoodsQuote

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

Create a goods quote.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateGoodsQuoteInput!)

Input fields for creating a goods quote.

Return fields

NameDescription

goodsQuote (GoodsQuote)

Goods quote created for the customer.

Mutation

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

Variables

{
  "input": CreateGoodsQuoteInput
}

Response

{
  "data": {
    "createGoodsQuote": {
      "goodsQuote": GoodsQuote
    }
  }
}

createGoodsQuoteWithoutAccount

Type:CreateGoodsQuoteWithoutAccount

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

Create a goods quote without an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateGoodsQuoteWithoutAccountInput!)

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

Return fields

NameDescription

goodsQuote (GoodsQuote)

Goods quote created for the customer.

Mutation

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

Variables

{
  "input": CreateGoodsQuoteWithoutAccountInput
}

Response

{
  "data": {
    "createGoodsQuoteWithoutAccount": {
      "goodsQuote": GoodsQuote
    }
  }
}

createHardshipAgreement

Type:CreateHardshipAgreement

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

Create a new hardship agreement for an account.

The possible errors that can be raised are:

  • KT-CT-11612: Overlapping hardship agreement exists.
  • KT-CT-12901: Account not found.
  • KT-CT-10950: Invalid date range.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (CreateHardshipAgreementInput!)

Input fields for creating a new hardship agreement.

Return fields

NameDescription

newHardshipAgreement (HardshipAgreementType)

The created hardship agreement ID.

Mutation

mutation CreateHardshipAgreement($input: CreateHardshipAgreementInput!) {
  createHardshipAgreement(input: $input) {
    newHardshipAgreement {
      ...HardshipAgreementTypeFragment
    }
  }
}

Variables

{
  "input": CreateHardshipAgreementInput
}

Response

{
  "data": {
    "createHardshipAgreement": {
      "newHardshipAgreement": HardshipAgreementType
    }
  }
}

createInboundCall

Type:CreateInboundCall

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

The possible errors that can be raised are:

  • KT-CT-11805: Invalid input for creating an inbound call.
  • KT-CT-11810: Caller is blocked.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateInboundCallInput!)

Return fields

NameDescription

call (InboundCallType)

The call that was created.

Mutation

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

Variables

{
  "input": CreateInboundCallInput
}

Response

{
  "data": {
    "createInboundCall": {
      "call": InboundCallType
    }
  }
}

createInkInboundMessage

Type:CreateInkInboundMessage

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

Register an Ink inbound message.

The possible errors that can be raised are:

  • KT-CT-7622: Attachment bucket is invalid.
  • KT-CT-7623: Attachment path is invalid.
  • KT-CT-7621: Attachment not found.
  • KT-CT-7618: Unable to process message.
  • KT-CT-7625: Invalid email address.
  • KT-CT-7630: Message with this message ID has already been processed.
  • KT-CT-7632: The text content of the Ink Inbound Generic Message is too long.
  • KT-CT-7620: Channel not supported.
  • KT-CT-7627: The 'email' object is missing from the payload.
  • KT-CT-7628: The 'generic' object is missing from the payload.
  • KT-CT-7629: The 'post' object is missing from the payload.
  • KT-CT-7653: Account numbers on the message and message type must match if both are supplied.
  • KT-CT-7654: An account number was provided, but no corresponding account could be found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateInkInboundMessageInput)

Input for creating and ingesting an inbound message.

Return fields

NameDescription

message (InkMessage!)

The Ink message that was created.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

mutation CreateInkInboundMessage($input: CreateInkInboundMessageInput) {
  createInkInboundMessage(input: $input) {
    message {
      ... on InkEmail {
        ...InkEmailFragment
      }
      ... on InkSMS {
        ...InkSMSFragment
      }
      ... on InkLine {
        ...InkLineFragment
      }
      ... on InkWhatsApp {
        ...InkWhatsAppFragment
      }
      ... on InkTwilioWhatsApp {
        ...InkTwilioWhatsAppFragment
      }
      ... on InkPost {
        ...InkPostFragment
      }
      ... on InkGenericMessage {
        ...InkGenericMessageFragment
      }
      ... on InkLiveChatMessage {
        ...InkLiveChatMessageFragment
      }
    }
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": CreateInkInboundMessageInput
}

Response

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

createInkLiveChatMessage

Type:CreateInkLiveChatMessage

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

The possible errors that can be raised are:

  • KT-CT-7616: Not yet implemented.
  • KT-CT-1111: Unauthorized.
  • KT-CT-4123: Unauthorized.
  • KT-CT-7642: No account user was found for the given fromHandle.
  • KT-CT-7641: Live Chat message with this message ID has already been processed.
  • KT-CT-7645: The user is not authorized to access this Live Chat.
  • KT-CT-7622: Attachment bucket is invalid.
  • KT-CT-7623: Attachment path is invalid.
  • KT-CT-7621: Attachment not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateInkLiveChatMessageInput)

Input for creating a live chat message.

Return fields

NameDescription

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

messageRelayId (String!)

The ID of the Ink Live Chat message that was created.

Mutation

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

Variables

{
  "input": CreateInkLiveChatMessageInput
}

Response

{
  "data": {
    "createInkLiveChatMessage": {
      "liveChatConversation": InkLiveChatConversation,
      "messageRelayId": "abc123"
    }
  }
}

createInternalCompany

Type:CreateInternalCompany

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

Create a new internal company.

The possible errors that can be raised are:

  • KT-CT-14402: Duplicated internal company.
  • KT-CT-14403: Invalid address.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateInternalCompanyInput!)

The input required to create an internal company.

Return fields

NameDescription

internalCompany (CreateInternalCompanyResultType)

The result of the create internal company operation.

Mutation

mutation CreateInternalCompany($input: CreateInternalCompanyInput!) {
  createInternalCompany(input: $input) {
    internalCompany {
      ...CreateInternalCompanyResultTypeFragment
    }
  }
}

Variables

{
  "input": CreateInternalCompanyInput
}

Response

{
  "data": {
    "createInternalCompany": {
      "internalCompany": CreateInternalCompanyResultType
    }
  }
}

createLead

Type:CreateLead

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

Create a lead with the provided details.

The possible errors that can be raised are:

  • KT-CT-8912: Funnel not found.
  • KT-CT-8930: Unable to parse address.
  • KT-CT-8928: The funnel is not active and cannot be used to create this entity.
  • KT-CT-8902: Unable to create lead.
  • KT-CT-8919: Funnel initial stage not set.
  • KT-CT-8931: Extra detail value is invalid.
  • KT-CT-8939: Extra detail value is required.
  • KT-CT-9017: Consent type not found.
  • KT-CT-8932: Lead contact details missing account holder.
  • KT-CT-8934: Lead contact details missing account representative.
  • KT-CT-8940: Lead contact role already exists.
  • KT-CT-8941: Invalid language preference code.
  • KT-CT-8935: National ID bad input.
  • KT-CT-4121: Invalid phone number.
  • KT-CT-8956: Conflicting address inputs.
  • KT-CT-8958: A lead contact must have at least one role.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateLeadInput!)

Input fields for creating a lead.

Return fields

NameDescription

leadNumber (String)

The unique number of the lead.

Mutation

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

Variables

{
  "input": CreateLeadInput
}

Response

{
  "data": {
    "createLead": {
      "leadNumber": "abc123"
    }
  }
}

createMetadata

Type:CreateMetadata

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

Create metadata on an object.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-CT-4124: Unauthorized.
  • KT-CT-6622: Unauthorized.
  • KT-CT-6637: Unauthorized.
  • KT-CT-8411: Invalid data.
  • KT-CT-4323: Unauthorized.
  • KT-CT-8412: Invalid data.
  • KT-CT-8414: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (MetadataInput!)

Input fields for creating metadata.

Return fields

NameDescription

metadata (Metadata)

Mutation

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

Variables

{
  "input": MetadataInput
}

Response

{
  "data": {
    "createMetadata": {
      "metadata": Metadata
    }
  }
}

createMeterDataIssueFlow

Type:CreateMeterDataIssueFlow

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

Create a Meter Data Issue Flow for a given Issue ID and Flow ID.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13801: A meter data issue flow already exists for this issue and flow.
  • KT-CT-13802: Meter data issue not found.
  • KT-CT-13803: An active flow already exists for this issue.
  • KT-CT-13806: Invalid market name provided.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateMeterDataIssueFlowInputType!)

Input variables needed for creating a Meter Data Issue Flow.

Return fields

NameDescription

meterDataIssueFlowCreated (CreateMeterDataIssueFlowOutputType)

Whether the meter data issue flow was successfully created.

Mutation

mutation CreateMeterDataIssueFlow($input: CreateMeterDataIssueFlowInputType!) {
  createMeterDataIssueFlow(input: $input) {
    meterDataIssueFlowCreated {
      ...CreateMeterDataIssueFlowOutputTypeFragment
    }
  }
}

Variables

{
  "input": CreateMeterDataIssueFlowInputType
}

Response

{
  "data": {
    "createMeterDataIssueFlow": {
      "meterDataIssueFlowCreated": CreateMeterDataIssueFlowOutputType
    }
  }
}

createMfaDevice

Type:CreateMfaDevice

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

Create a multi-factor authentication (MFA) device for a user.

The possible errors that can be raised are:

  • KT-CT-1128: Unauthorized.
  • KT-CT-1151: MFA device not found.
  • KT-CT-1153: Unable to create MFA device.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateMfaDeviceInputType!)

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

Return fields

NameDescription

deviceEmail (String)

Email address to send the MFA code by default.

devicePhone (String)

Phone number to send the MFA code by default.

totpSecret (String)

Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually.

Mutation

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

Variables

{
  "input": CreateMfaDeviceInputType
}

Response

{
  "data": {
    "createMfaDevice": {
      "deviceEmail": "abc123",
      "devicePhone": "abc123",
      "totpSecret": "abc123"
    }
  }
}

createNewAgreementFromProductSwitchProcess

Type:CreateNewAgreementFromProductSwitchProcess

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

Create a new agreement from an existing product switch process.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4924: Unauthorized.
  • KT-CT-1509: Unable to create agreement.
  • KT-CT-1516: Requested product switch is not valid.
  • KT-CT-1507: Agreement product switch date is not within the acceptable range.
  • KT-CT-4626: No product selected for the given quote code.
  • KT-CT-1510: Product switch process not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateNewAgreementFromProductSwitchProcessInput!)

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

Return fields

NameDescription

agreement (CommonAgreementType)

The new agreement created.

Mutation

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

Variables

{
  "input": CreateNewAgreementFromProductSwitchProcessInput
}

Response

{
  "data": {
    "createNewAgreementFromProductSwitchProcess": {
      "agreement": CommonAgreementType
    }
  }
}

createOfferGroupForQuoting

Type:CreateOfferGroupForQuoting

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

Create a quoting offer group.

The possible errors that can be raised are:

  • KT-CT-12401: Unable to create offer group.
  • KT-CT-12405: Missing rates for quoting.
  • KT-CT-12406: Product not configured correctly for quoting.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateOfferGroupForQuotingInput!)

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

Return fields

NameDescription

offerGroup (CreateOfferGroupType)

Quoting Offer Group.

Mutation

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

Variables

{
  "input": CreateOfferGroupForQuotingInput
}

Response

{
  "data": {
    "createOfferGroupForQuoting": {
      "offerGroup": CreateOfferGroupType
    }
  }
}

createOnSiteJobsRequest

Type:CreateOnSiteJobsRequest

URL:https://api.redenergy-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-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-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 supplypointidentifiertomarketnamemapping and supplypointinternal_ids.
  • KT-CT-13049: Neither supplypointidentifiertomarketnamemapping nor supplypointinternal_ids provided.
  • KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_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-13063: Failed to derive property for the given supply points.
  • KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
  • KT-CT-13066: Request reason is deprecated.
  • KT-CT-13067: Provided sub-reason for request is invalid.
  • KT-CT-13068: Property required for this request.
  • KT-CT-13069: Account required for this request.
  • KT-CT-13070: Provided status for request is invalid.
  • KT-CT-13071: Provided reason for request is invalid.
  • KT-CT-13078: Account users cannot set external references on requests.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateOnSiteJobsRequestInputType!)

The input objects required to create a Request.

Return fields

NameDescription

onSiteJobsRequest (OnSiteJobsRequestType)

The created request.

Mutation

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

Variables

{
  "input": CreateOnSiteJobsRequestInputType
}

Response

{
  "data": {
    "createOnSiteJobsRequest": {
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

createOpportunityAndLead

Type:CreateOpportunityAndLead

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

Create an opportunity and lead with the provided details.

The possible errors that can be raised are:

  • KT-CT-8912: Funnel not found.
  • KT-CT-8919: Funnel initial stage not set.
  • KT-CT-8930: Unable to parse address.
  • KT-CT-8907: Lead not found.
  • KT-CT-8901: Unable to create lead.
  • KT-CT-8902: Unable to create lead.
  • KT-CT-8935: National ID bad input.
  • KT-CT-4121: Invalid phone number.
  • KT-CT-8931: Extra detail value is invalid.
  • KT-CT-9017: Consent type not found.
  • KT-CT-8913: Organisation is not valid to be assigned.
  • KT-CT-8936: Only one address is required to create an opportunity.
  • KT-CT-8937: One or more Supply Points cannot be validated.
  • KT-CT-8946: A team must also be provided when assigning a user.
  • KT-CT-8947: The team you specified was not found.
  • KT-CT-8948: The user you specified was not found.
  • KT-CT-8949: The selected team does not belong to the specified partner.
  • KT-CT-8950: The selected user does not belong to the specified partner.
  • KT-CT-8951: The selected user is not a member of the specified team.
  • KT-CT-8956: Conflicting address inputs.
  • KT-CT-8958: A lead contact must have at least one role.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateOpportunityAndLeadInput!)

Input fields for creating an opportunity.

Return fields

NameDescription

opportunityNumber (String)

The unique number of the opportunity.

dateOfCreation (DateTime)

The date the opportunity was created.

stage (String)

The stage of the opportunity.

funnelCode (String)

The code of the funnel.

Mutation

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

Variables

{
  "input": CreateOpportunityAndLeadInput
}

Response

{
  "data": {
    "createOpportunityAndLead": {
      "opportunityNumber": "abc123",
      "dateOfCreation": "2020-01-01T00:00:00.000Z",
      "stage": "abc123",
      "funnelCode": "abc123"
    }
  }
}

createOpportunityFileAttachment

Type:CreateOpportunityFileAttachment

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

Creates an Opportunity File Attachment.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateOpportunityFileAttachmentInput!)

Input to create an Opportunity File Attachment.

Return fields

NameDescription

result (String)

Whether the operation was successful.

Mutation

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

Variables

{
  "input": CreateOpportunityFileAttachmentInput
}

Response

{
  "data": {
    "createOpportunityFileAttachment": {
      "result": "abc123"
    }
  }
}

createOpportunityForLead

Type:CreateOpportunityForLead

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

Create an opportunity for a lead with the provided details.

The possible errors that can be raised are:

  • KT-CT-8912: Funnel not found.
  • KT-CT-8919: Funnel initial stage not set.
  • KT-CT-8907: Lead not found.
  • KT-CT-8913: Organisation is not valid to be assigned.
  • KT-CT-8924: Unable to create opportunity.
  • KT-CT-8925: Unable to create opportunity.
  • KT-CT-8926: Unable to create opportunity.
  • KT-CT-8928: The funnel is not active and cannot be used to create this entity.
  • KT-CT-8930: Unable to parse address.
  • KT-CT-8936: Only one address is required to create an opportunity.
  • KT-CT-8931: Extra detail value is invalid.
  • KT-CT-8937: One or more Supply Points cannot be validated.
  • KT-CT-8946: A team must also be provided when assigning a user.
  • KT-CT-8947: The team you specified was not found.
  • KT-CT-8948: The user you specified was not found.
  • KT-CT-8949: The selected team does not belong to the specified partner.
  • KT-CT-8950: The selected user does not belong to the specified partner.
  • KT-CT-8951: The selected user is not a member of the specified team.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateOpportunityForLeadInput!)

Input fields for creating an opportunity for a lead.

Return fields

NameDescription

opportunityNumber (String)

The unique number of the opportunity.

dateOfCreation (DateTime)

The date the opportunity was created.

Mutation

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

Variables

{
  "input": CreateOpportunityForLeadInput
}

Response

{
  "data": {
    "createOpportunityForLead": {
      "opportunityNumber": "abc123",
      "dateOfCreation": "2020-01-01T00:00:00.000Z"
    }
  }
}

createOrUpdateLoyaltyCard

Type:CreateOrUpdateLoyaltyCardMutation

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

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

The possible errors that can be raised are:

  • KT-CT-5412: No account user exists with the given id.
  • KT-CT-8610: Invalid data.
  • KT-CT-8611: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateOrUpdateLoyaltyCardInput!)

Input fields for creating or updating a loyalty card.

Return fields

NameDescription

loyaltyCard (LoyaltyCardType)

Created or updated loyalty card.

Mutation

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

Variables

{
  "input": CreateOrUpdateLoyaltyCardInput
}

Response

{
  "data": {
    "createOrUpdateLoyaltyCard": {
      "loyaltyCard": LoyaltyCardType
    }
  }
}

createOrUpdateTimeSeriesEntries

Type:CreateOrUpdateTimeSeriesEntries!

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

Create or update time series entries.

The possible errors that can be raised are:

  • KT-CT-12014: Time series not found.
  • KT-CT-12015: Characteristics mismatch.
  • KT-CT-12016: Conflicting time series entries.
  • KT-CT-12017: Invalid time series entries period.
  • KT-CT-12038: Invalid time series entries granularity.
  • KT-CT-12040: Time series entries in use.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateOrUpdateTimeSeriesEntriesInput!)

The time series input for time series entry creation or update.

Return fields

NameDescription

Mutation

mutation CreateOrUpdateTimeSeriesEntries($input: CreateOrUpdateTimeSeriesEntriesInput!) {
  createOrUpdateTimeSeriesEntries(input: $input) {
    code
    productCode
    name
    description
    unit
    periodSize
    meta
    variants {
      ...VariantProfileFragment
    }
  }
}

Variables

{
  "input": CreateOrUpdateTimeSeriesEntriesInput
}

Response

{
  "data": {
    "createOrUpdateTimeSeriesEntries": {
      "code": "abc123",
      "productCode": "abc123",
      "name": "abc123",
      "description": "abc123",
      "unit": "abc123",
      "periodSize": "abc123",
      "meta": {"key": "value"},
      "variants": VariantProfile
    }
  }
}

createPartnerUser

Type:CreatePartnerUser!

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

Create a partner user and assign them to a partner team.

The possible errors that can be raised are:

  • KT-CT-7725: Unauthorized.
  • KT-CT-7726: Unauthorized.
  • KT-CT-7727: Invalid email address.
  • KT-CT-7728: Unable to create partner user.
  • KT-CT-13501: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreatePartnerUserInput!)

Input fields for creating a partner user and assigning them to a team.

Return fields

NameDescription

Mutation

mutation CreatePartnerUser($input: CreatePartnerUserInput!) {
  createPartnerUser(input: $input) {
    partnerUser {
      ...PartnerUserTypeFragment
    }
  }
}

Variables

{
  "input": CreatePartnerUserInput
}

Response

{
  "data": {
    "createPartnerUser": {
      "partnerUser": PartnerUserType
    }
  }
}

createPaymentActionIntent

Type:CreatePaymentActionIntent

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

Create a new payment action intent.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-3822: Unauthorized.
  • KT-CT-3980: Invalid ledger identifier.
  • KT-CT-3981: Unauthorized.
  • KT-CT-3982: Unauthorized.
  • KT-CT-3995: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreatePaymentActionIntentInput!)

Input fields for creating a payment action intent.

Return fields

NameDescription

token (ID!)

The action intent token.

Mutation

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

Variables

{
  "input": CreatePaymentActionIntentInput
}

Response

{
  "data": {
    "createPaymentActionIntent": {
      "token": "abc123"
    }
  }
}

createPaymentExtension

Type:CreatePaymentExtension

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

Creates payment extension according to the received options.

Taken action would be one of the following:

  • if payment instruction is NOT supplied and the account is on a manual payment, sets up one or two payment promise(s)
  • if payment instruction is NOT supplied and the account is on an scheduled payment (direct debit/card), creates payment holiday
  • if payment instruction is supplied, sets up payment schedules for one or two instalment(s)

A payment promise applies to an account that does not have automatic payments. It records that a customer has told us they'll pay an amount by an agreed-upon date.

Payment Holiday means that when a customer is on a scheduled payment, the payments will not come out from customer's bank account for the period indicated.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (CreatePaymentExtensionInput!)

Input fields for creating a payment extension for the account.

Return fields

NameDescription

paymentExtension (PaymentExtensionUnionType)

Mutation

mutation CreatePaymentExtension($input: CreatePaymentExtensionInput!) {
  createPaymentExtension(input: $input) {
    paymentExtension {
      ... on PaymentPromiseType {
        ...PaymentPromiseTypeFragment
      }
      ... on PaymentScheduleType {
        ...PaymentScheduleTypeFragment
      }
      ... on AccountPaymentType {
        ...AccountPaymentTypeFragment
      }
    }
  }
}

Variables

{
  "input": CreatePaymentExtensionInput
}

Response

{
  "data": {
    "createPaymentExtension": {
      "paymentExtension": PaymentPromiseType
    }
  }
}

createPaymentMethodActionIntent

Type:CreatePaymentMethodActionIntent

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

Create a new payment method action intent.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-3822: Unauthorized.
  • KT-CT-3971: Instruction owners are not valid.
  • KT-CT-3980: Invalid ledger identifier.
  • KT-CT-3981: Unauthorized.
  • KT-CT-3982: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreatePaymentMethodActionIntentInput!)

Input fields for creating a payment method action intent.

Return fields

NameDescription

token (ID!)

The action intent token.

Mutation

mutation CreatePaymentMethodActionIntent($input: CreatePaymentMethodActionIntentInput!) {
  createPaymentMethodActionIntent(input: $input) {
    token
  }
}

Variables

{
  "input": CreatePaymentMethodActionIntentInput
}

Response

{
  "data": {
    "createPaymentMethodActionIntent": {
      "token": "abc123"
    }
  }
}

createPaymentSchedule

Type:CreatePaymentSchedule

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

Creates a new payment schedule

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (PaymentScheduleInput!)

Return fields

NameDescription

paymentSchedule (PaymentScheduleType)

The payment schedule created.

Mutation

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

Variables

{
  "input": PaymentScheduleInput
}

Response

{
  "data": {
    "createPaymentSchedule": {
      "paymentSchedule": PaymentScheduleType
    }
  }
}

createPortfolio

Type:CreatePortfolio

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

Create a new portfolio.

The possible errors that can be raised are:

  • KT-CT-9402: Received an invalid brandCode.
  • KT-CT-9401: Received an invalid operationsTeamId.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreatePortfolioInput)

Input fields for creating a portfolio.

Return fields

NameDescription

portfolio (PortfolioType)

The created portfolio.

Mutation

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

Variables

{
  "input": CreatePortfolioInput
}

Response

{
  "data": {
    "createPortfolio": {
      "portfolio": PortfolioType
    }
  }
}

createPortfolioUserRole

Type:CreatePortfolioUserRole

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

  • KT-CT-9403: Received an invalid portfolioId.
  • KT-CT-9404: Received an invalid accountUserId.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreatePortfolioUserRoleInput)

Input fields for connecting a user to a portfolio.

Return fields

NameDescription

portfolioUserRole (PortfolioUserRoleType)

The created role for a user in association with a portfolio.

Mutation

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

Variables

{
  "input": CreatePortfolioUserRoleInput
}

Response

{
  "data": {
    "createPortfolioUserRole": {
      "portfolioUserRole": PortfolioUserRoleType
    }
  }
}

createPostEvents

Type:CreatePostEvents

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

Create post delivery events from external vendors.

The possible errors that can be raised are:

  • KT-CT-9907: Post events batch size exceeded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreatePostEventsInput!)

Batch of post events to create.

Return fields

NameDescription

createdEventsCount (Int)

Number of events successfully created.

Mutation

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

Variables

{
  "input": CreatePostEventsInput
}

Response

{
  "data": {
    "createPostEvents": {
      "createdEventsCount": 1
    }
  }
}

createPrimaryResidence

Type:CreatePrimaryResidence

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

Create a new primary residence for the given user and property.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreatePrimaryResidenceInput!)

Input fields for creating a new primary residence.

Return fields

NameDescription

primaryResidence (PrimaryResidenceType)

error (CreatePrimaryResidenceErrorUnion)

Mutation

mutation CreatePrimaryResidence($input: CreatePrimaryResidenceInput!) {
  createPrimaryResidence(input: $input) {
    primaryResidence {
      ...PrimaryResidenceTypeFragment
    }
    error {
      ... on AccountUserCanNotFoundErrorType {
        ...AccountUserCanNotFoundErrorTypeFragment
      }
      ... on PropertyCanNotFoundErrorType {
        ...PropertyCanNotFoundErrorTypeFragment
      }
      ... on FailedPrimaryResidenceValidationErrorType {
        ...FailedPrimaryResidenceValidationErrorTypeFragment
      }
      ... on InvalidPrimaryResidenceEndDateErrorType {
        ...InvalidPrimaryResidenceEndDateErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": CreatePrimaryResidenceInput
}

Response

{
  "data": {
    "createPrimaryResidence": {
      "primaryResidence": PrimaryResidenceType,
      "error": AccountUserCanNotFoundErrorType
    }
  }
}

createProduct

Type:CreateProductOutput!

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

Create a new product.

The possible errors that can be raised are:

  • KT-CT-12003: Specified product brand does not exist.
  • KT-CT-12004: Invalid product tag type.
  • KT-CT-12005: A selection of a terms and conditions type does not exist.
  • KT-CT-12006: Provided product characteristic overrides are not in the correct format.
  • KT-CT-12007: Unable to create product.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateProductInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateProductInput
}

Response

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

createProfileEventAndPublish

Type:CreateProfileEventAndPublish

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

Mutation to publish an event for an account or account user

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateUserProfileEventAndPublishInput!)

Return fields

NameDescription

syncEvent (SyncEventType)

error (CreateUserProfileEventAndPublishErrorUnion)

Mutation

mutation CreateProfileEventAndPublish($input: CreateUserProfileEventAndPublishInput!) {
  createProfileEventAndPublish(input: $input) {
    syncEvent {
      ...SyncEventTypeFragment
    }
    error {
      ... on CreateUserProfileEventAndPublishAccountNumberNotProvidedError {
        ...CreateUserProfileEventAndPublishAccountNumberNotProvidedErrorFragment
      }
      ... on CreateUserProfileEventAndPublishUserIdNotProvidedError {
        ...CreateUserProfileEventAndPublishUserIdNotProvidedErrorFragment
      }
      ... on CreateUserProfileEventAndPublishFinalBillNotFoundError {
        ...CreateUserProfileEventAndPublishFinalBillNotFoundErrorFragment
      }
      ... on CreateUserProfileEventAndPublishOtherValidationError {
        ...CreateUserProfileEventAndPublishOtherValidationErrorFragment
      }
      ... on CreateUserProfileEventAndPublishClientError {
        ...CreateUserProfileEventAndPublishClientErrorFragment
      }
      ... on AccountNotFound {
        ...AccountNotFoundFragment
      }
      ... on UserNotFound {
        ...UserNotFoundFragment
      }
      ... on InvalidUserID {
        ...InvalidUserIDFragment
      }
    }
  }
}

Variables

{
  "input": CreateUserProfileEventAndPublishInput
}

Response

{
  "data": {
    "createProfileEventAndPublish": {
      "syncEvent": SyncEventType,
      "error": CreateUserProfileEventAndPublishAccountNumberNotProvidedError
    }
  }
}

createQuoteForAccount

Type:CreateQuoteForAccount

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

Create a quote for switching product.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.
  • KT-CT-4616: Unable to create a quote.
  • KT-CT-4631: Unable to quote for the chosen market.
  • KT-CT-4645: No supply point found belonging to the account for the provided identifier.
  • KT-CT-4924: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (CreateQuoteForAccountInput!)

Return fields

NameDescription

quoteRequest (MarketSupplyQuoteRequestType)

Returns a quote request.

Mutation

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

Variables

{
  "input": CreateQuoteForAccountInput
}

Response

{
  "data": {
    "createQuoteForAccount": {
      "quoteRequest": MarketSupplyQuoteRequestType
    }
  }
}

createQuoteForProperty

Type:CreateQuoteForProperty

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

Mutation to create a quote for a property.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateQuoteForPropertyInput!)

Return fields

NameDescription

error (CreateQuoteForPropertyErrorUnion)

The error preventing a quote from being produced.

quoteRequest (QuoteRequestType)

The QuoteRequest type field.

Mutation

mutation CreateQuoteForProperty($input: CreateQuoteForPropertyInput!) {
  createQuoteForProperty(input: $input) {
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on InvalidSupplyPointDateErrorType {
        ...InvalidSupplyPointDateErrorTypeFragment
      }
      ... on NoSupplyPointsAssociatedWithPropertyErrorType {
        ...NoSupplyPointsAssociatedWithPropertyErrorTypeFragment
      }
      ... on OnlyMoveInAllowedWithSupply {
        ...OnlyMoveInAllowedWithSupplyFragment
      }
      ... on NoSuitableProductsFoundErrorType {
        ...NoSuitableProductsFoundErrorTypeFragment
      }
      ... on UnsupportedMarketErrorType {
        ...UnsupportedMarketErrorTypeFragment
      }
      ... on UnableToQuoteErrorType {
        ...UnableToQuoteErrorTypeFragment
      }
    }
    quoteRequest {
      ...QuoteRequestTypeFragment
    }
  }
}

Variables

{
  "input": CreateQuoteForPropertyInput
}

Response

{
  "data": {
    "createQuoteForProperty": {
      "error": DoesNotExistErrorType,
      "quoteRequest": QuoteRequestType
    }
  }
}

createReferral

Type:CreateReferral

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

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

Arguments

NameDescription

input (CreateReferralInput!)

Input fields for creating a referral.

Return fields

NameDescription

referredAccountRewardAmount (Int)

The reward amount to be issued to the referred account, in smallest currency subunits.

Mutation

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

Variables

{
  "input": CreateReferralInput
}

Response

{
  "data": {
    "createReferral": {
      "referredAccountRewardAmount": 1
    }
  }
}

createRegisterNtcOverride

Type:CreateRegisterNTCOverride

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

Creates network tariff code override for the register under Meter point.

The possible errors that can be raised are:

  • KT-AU-5613: Cannot find meter point with the provided ID.
  • KT-AU-5611: Cannot find register with the provided ID.
  • KT-AU-5612: Error in creating the override.
  • KT-AU-5617: Override period falls outside the register's active period.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateRegisterNTCOverrideInputType)

Return fields

NameDescription

meterPoint (MeterPointType)

The target meter point.

Mutation

mutation CreateRegisterNtcOverride($input: CreateRegisterNTCOverrideInputType) {
  createRegisterNtcOverride(input: $input) {
    meterPoint {
      ...MeterPointTypeFragment
    }
  }
}

Variables

{
  "input": CreateRegisterNTCOverrideInputType
}

Response

{
  "data": {
    "createRegisterNtcOverride": {
      "meterPoint": MeterPointType
    }
  }
}

createReminder

Type:CreateReminder

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

Create an account reminder.

The possible errors that can be raised are:

  • KT-CT-1401: Invalid data.
  • KT-CT-1402: Unable to create account reminder.
  • KT-CT-1403: Missing user or team assignee.
  • KT-CT-1404: This reminder type is deprecated.
  • KT-CT-1405: Both user and team assignee provided.
  • KT-CT-1408: Missing account id.
  • KT-CT-1409: Missing business id.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateReminderInput!)

Input variables needed for creating an account reminder.

Return fields

NameDescription

reminder (Reminder)

Account reminder.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": CreateReminderInput
}

Response

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

createScheduledTransactions

Type:CreateScheduledTransactions

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

Create scheduled transactions.

The possible errors that can be raised are:

  • KT-CT-3821: Received neither ledger ID nor ledger number.
  • KT-CT-3830: Invalid action.
  • KT-CT-3831: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input ([CreateScheduledTransactionsInput]!)

Input fields to create scheduled transactions.

Return fields

NameDescription

scheduledTransactions ([ScheduledTransactionType])

Mutation

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

Variables

{
  "input": CreateScheduledTransactionsInput
}

Response

{
  "data": {
    "createScheduledTransactions": {
      "scheduledTransactions": [ScheduledTransactionType]
    }
  }
}

createShellAccount

Type:CreateShellAccountPayload

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

Create a shell account (a billable account with no property/energy supply).

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateShellAccountInput!)

Return fields

NameDescription

portfolioNumber (String)

givenName (String!)

familyName (String!)

billingName (String)

email (String!)

mobile (String)

landline (String)

brand (String)

dateOfBirth (Date)

billingAddressLine1 (String)

billingAddressLine2 (String)

billingAddressLine3 (String)

billingAddressLine4 (String)

billingAddressLine5 (String)

billingPostcode (String)

billingRichAddress (String)

This must be a string-ified version of the JSON representation of RichAddressInput type.

billingPeriodLength (String)

For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY.

billingPeriodMultiplier (Int)

For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing.

billingPeriodDay (Int)

Day to fixed bill on if billingperiodlength set.

billingPeriodMonth (Int)

Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1.

isBusinessAccount (Boolean)

companyName (String)

companyNumber (String)

businessType (String)

taxNumber (String)

password (String)

passwordUpdateToken (String)

urn (String)

errors ([ErrorType])

account (AccountInterface)

clientMutationId (String)

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
    taxNumber
    password
    passwordUpdateToken
    urn
    errors {
      ...ErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
    clientMutationId
  }
}

Variables

{
  "input": CreateShellAccountInput
}

Response

{
  "data": {
    "createShellAccount": {
      "portfolioNumber": "abc123",
      "givenName": "abc123",
      "familyName": "abc123",
      "billingName": "abc123",
      "email": "abc123",
      "mobile": "abc123",
      "landline": "abc123",
      "brand": "abc123",
      "dateOfBirth": "2020-01-01",
      "billingAddressLine1": "abc123",
      "billingAddressLine2": "abc123",
      "billingAddressLine3": "abc123",
      "billingAddressLine4": "abc123",
      "billingAddressLine5": "abc123",
      "billingPostcode": "abc123",
      "billingRichAddress": "abc123",
      "billingPeriodLength": "abc123",
      "billingPeriodMultiplier": 1,
      "billingPeriodDay": 1,
      "billingPeriodMonth": 1,
      "isBusinessAccount": true,
      "companyName": "abc123",
      "companyNumber": "abc123",
      "businessType": "abc123",
      "taxNumber": "abc123",
      "password": "abc123",
      "passwordUpdateToken": "abc123",
      "urn": "abc123",
      "errors": [ErrorType],
      "account": AccountInterface,
      "clientMutationId": "abc123"
    }
  }
}

createTimeSeriesPrices

Type:CreateTimeSeriesPrices!

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

Create time series prices.

The possible errors that can be raised are:

  • KT-CT-12014: Time series not found.
  • KT-CT-12015: Characteristics mismatch.
  • KT-CT-12016: Conflicting time series entries.
  • KT-CT-12017: Invalid time series entries period.
  • KT-CT-12038: Invalid time series entries granularity.
  • KT-CT-12040: Time series entries in use.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'createTimeSeriesPrices' field is deprecated.


Please use the 'createOrUpdateTimeSeriesEntries' mutation instead.


- Marked as deprecated on 2025-02-03.
- Scheduled for removal on or after 2025-03-01.

Arguments

NameDescription

input (CreateTimeSeriesPricesInput!)

The time series input for price creation.

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateTimeSeriesPricesInput
}

Response

{
  "data": {
    "createTimeSeriesPrices": {
      "code": "abc123",
      "productCode": "abc123",
      "name": "abc123",
      "description": "abc123",
      "unit": "abc123",
      "periodSize": "abc123",
      "meta": {"key": "value"},
      "variants": VariantProfile
    }
  }
}

createUserAlternativeNumber

Type:CreateUserAlternativeNumber

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

Create a new alternative phone number for the user.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountUserAlternativeNumberInputType!)

Return fields

NameDescription

alternativePhoneNumbers ([String])

List of alternative phone numbers for the account user.

error (AlternativeNumberErrorUnion)

Potential error message for the mutation.

Mutation

mutation CreateUserAlternativeNumber($input: AccountUserAlternativeNumberInputType!) {
  createUserAlternativeNumber(input: $input) {
    alternativePhoneNumbers
    error {
      ... on AlternativeNumberValidationErrorType {
        ...AlternativeNumberValidationErrorTypeFragment
      }
      ... on AlternativeNumberDoesNotExistErrorType {
        ...AlternativeNumberDoesNotExistErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": AccountUserAlternativeNumberInputType
}

Response

{
  "data": {
    "createUserAlternativeNumber": {
      "alternativePhoneNumbers": ["abc123"],
      "error": AlternativeNumberValidationErrorType
    }
  }
}

deductLoyaltyPoints

Type:DeductLoyaltyPoints

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

Deduct the specified number of Loyalty Points from the account.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-5420: Unauthorized.
  • KT-CT-9211: Invalid reason for loyalty points award.
  • KT-CT-9219: Loyalty points user not found.
  • KT-CT-9204: Negative or zero points set.
  • KT-CT-9205: Insufficient Loyalty Points.
  • KT-CT-9208: Invalid posted at datetime.
  • KT-CT-9221: Idempotency key already used on ledger entry.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (DeductLoyaltyPointsInput!)

Input fields for deducting Loyalty Points.

Return fields

NameDescription

pointsDeducted (Int)

The number of loyalty points that were deducted.

ledgerEntry (LoyaltyPointLedgerEntryType)

The ledger entry for the deducted loyalty points.

Mutation

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

Variables

{
  "input": DeductLoyaltyPointsInput
}

Response

{
  "data": {
    "deductLoyaltyPoints": {
      "pointsDeducted": 1,
      "ledgerEntry": LoyaltyPointLedgerEntryType
    }
  }
}

deleteAccountReference

Type:DeleteAccountReference

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

Delete a reference for a particular account and namespace.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (DeleteAccountReferenceInput!)

Input fields for removing an account reference.

Return fields

NameDescription

accountReference (DeleteAccountReferenceType)

Mutation

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

Variables

{
  "input": DeleteAccountReferenceInput
}

Response

{
  "data": {
    "deleteAccountReference": {
      "accountReference": DeleteAccountReferenceType
    }
  }
}

deleteMfaDevice

Type:DeleteMfaDevice

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

Delete a multi-factor authentication (MFA) device for the authenticated user.

The possible errors that can be raised are:

  • KT-CT-1150: MFA device not found.
  • KT-CT-1154: Unable to delete MFA device.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (DeleteMfaDeviceInputType!)

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

Return fields

NameDescription

deviceDeleted (Boolean)

Flag to indicate if the MFA device has been successfully deleted.

Mutation

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

Variables

{
  "input": DeleteMfaDeviceInputType
}

Response

{
  "data": {
    "deleteMfaDevice": {
      "deviceDeleted": true
    }
  }
}

deletePaymentSchedule

Type:DeletePaymentSchedule

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

Delete payment schedule for an account.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (DeletePaymentScheduleInput!)

Return fields

NameDescription

account (AccountType)

Account related to payment schedule.

error (DeletePaymentScheduleErrorUnion)

Handled errors related to payment schedule deletion.

Mutation

mutation DeletePaymentSchedule($input: DeletePaymentScheduleInput!) {
  deletePaymentSchedule(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on UnableToDeleteScheduleType {
        ...UnableToDeleteScheduleTypeFragment
      }
    }
  }
}

Variables

{
  "input": DeletePaymentScheduleInput
}

Response

{
  "data": {
    "deletePaymentSchedule": {
      "account": AccountType,
      "error": DoesNotExistErrorType
    }
  }
}

deletePropertyDescendants

Type:DeletePropertyDescendants

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

Delete all descendants of a property in a hierarchy.

This permanently deletes all descendant nodes (children, grandchildren, etc.) but keeps the property node itself in the hierarchy. This operation is idempotent - if the property is not in the hierarchy or has no descendants, it will succeed without error.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (DeletePropertyDescendantsInput!)

Input fields for deleting descendants from a property.

Return fields

NameDescription

property (PropertyType)

The property whose descendants were deleted.

Mutation

mutation DeletePropertyDescendants($input: DeletePropertyDescendantsInput!) {
  deletePropertyDescendants(input: $input) {
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": DeletePropertyDescendantsInput
}

Response

{
  "data": {
    "deletePropertyDescendants": {
      "property": PropertyType
    }
  }
}

deletePushNotificationBinding

Type:DeletePushNotificationBinding

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

NameDescription

input (DeletePushNotificationBindingInput!)

Input fields for deleting a push notification binding.

Return fields

NameDescription

status (DeletePushNotificationBindingOutput)

Mutation

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

Variables

{
  "input": DeletePushNotificationBindingInput
}

Response

{
  "data": {
    "deletePushNotificationBinding": {
      "status": "SUCCESSFUL"
    }
  }
}

deleteUserAlternativeNumber

Type:DeleteUserAlternativeNumber

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

Delete an existing alternative phone number for the user.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountUserAlternativeNumberInputType!)

Return fields

NameDescription

alternativePhoneNumbers ([String])

List of alternative phone numbers for the account user.

error (AlternativeNumberErrorUnion)

Potential error message for the mutation.

Mutation

mutation DeleteUserAlternativeNumber($input: AccountUserAlternativeNumberInputType!) {
  deleteUserAlternativeNumber(input: $input) {
    alternativePhoneNumbers
    error {
      ... on AlternativeNumberValidationErrorType {
        ...AlternativeNumberValidationErrorTypeFragment
      }
      ... on AlternativeNumberDoesNotExistErrorType {
        ...AlternativeNumberDoesNotExistErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": AccountUserAlternativeNumberInputType
}

Response

{
  "data": {
    "deleteUserAlternativeNumber": {
      "alternativePhoneNumbers": ["abc123"],
      "error": AlternativeNumberValidationErrorType
    }
  }
}

detachAgreementsFromContracts

Type:DetachAgreementsFromContractsOutput!

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

Detach a list of agreements from all contracts they are linked to.

The possible errors that can be raised are:

  • KT-CT-1501: Agreement not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (DetachAgreementsFromContractsInput!)

Input for detaching agreements from contracts.

Return fields

NameDescription

Mutation

mutation DetachAgreementsFromContracts($input: DetachAgreementsFromContractsInput!) {
  detachAgreementsFromContracts(input: $input) {
    ok
  }
}

Variables

{
  "input": DetachAgreementsFromContractsInput
}

Response

{
  "data": {
    "detachAgreementsFromContracts": {
      "ok": true
    }
  }
}

detachSupplyPointFromEstimationGroup

Type:DetachSupplyPointFromEstimationGroup

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13603: Supply Point does not exist.
  • KT-CT-13604: Supply point has no estimation group assigned.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (DetachSupplyPointFromEstimationGroupInput!)

Input fields for detaching a supply point from an estimation group.

Return fields

NameDescription

supplyPoint (DeletedSupplyPointEstimationGroupType)

The deleted supply point.

Mutation

mutation DetachSupplyPointFromEstimationGroup($input: DetachSupplyPointFromEstimationGroupInput!) {
  detachSupplyPointFromEstimationGroup(input: $input) {
    supplyPoint {
      ...DeletedSupplyPointEstimationGroupTypeFragment
    }
  }
}

Variables

{
  "input": DetachSupplyPointFromEstimationGroupInput
}

Response

{
  "data": {
    "detachSupplyPointFromEstimationGroup": {
      "supplyPoint": DeletedSupplyPointEstimationGroupType
    }
  }
}

endContributionAgreement

Type:EndContributionAgreement

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

End a contribution agreement for an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (EndContributionAgreementInput!)

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

Return fields

NameDescription

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

Mutation

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

Variables

{
  "input": EndContributionAgreementInput
}

Response

{
  "data": {
    "endContributionAgreement": {
      "contributionAgreement": ContributionAgreementType
    }
  }
}

endMeterDataIssueFlow

Type:EndMeterDataIssueFlow

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

End a Meter Data Issue Flow by updating its status.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13804: Meter data issue flow not found.
  • KT-CT-13807: Invalid flow end status.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (EndMeterDataIssueFlowInputType!)

Input variables needed for ending a Meter Data Issue Flow.

Return fields

NameDescription

meterDataIssueFlowEnded (EndMeterDataIssueFlowOutputType)

Whether the meter data issue flow was successfully ended.

Mutation

mutation EndMeterDataIssueFlow($input: EndMeterDataIssueFlowInputType!) {
  endMeterDataIssueFlow(input: $input) {
    meterDataIssueFlowEnded {
      ...EndMeterDataIssueFlowOutputTypeFragment
    }
  }
}

Variables

{
  "input": EndMeterDataIssueFlowInputType
}

Response

{
  "data": {
    "endMeterDataIssueFlow": {
      "meterDataIssueFlowEnded": EndMeterDataIssueFlowOutputType
    }
  }
}

enqueueInboundCall

Type:EnqueueInboundCall

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

The possible errors that can be raised are:

  • KT-CT-11802: Call not found.
  • KT-CT-11803: Unable to enqueue the call.
  • KT-CT-11817: Invalid call ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (EnqueueInboundCallInput!)

Return fields

NameDescription

call (InboundCallType)

The call that was enqueued.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": EnqueueInboundCallInput
}

Response

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

enrollAccountInLoyaltyProgram

Type:EnrollAccountInLoyaltyProgram

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

Enroll an account into the loyalty program.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-9213: ineligible loyalty points enrollment.
  • KT-CT-9210: Unhandled Loyalty Points exception.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (EnrollAccountInLoyaltyProgramInput!)

The account number to enroll in the loyalty program.

Return fields

NameDescription

outcome (EnrollAccountInLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

Mutation

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

Variables

{
  "input": EnrollAccountInLoyaltyProgramInput
}

Response

{
  "data": {
    "enrollAccountInLoyaltyProgram": {
      "outcome": EnrollAccountInLoyaltyProgramOutcome
    }
  }
}

enrollment

Type:EnrollmentInitiated!

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

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

The possible errors that can be raised are:

  • KT-CT-1602: Serializer validation error.
  • KT-CT-4410: Invalid postcode.
  • KT-CT-4412: The supplied address is not valid.
  • KT-CT-4501: Unauthorized.
  • KT-CT-7719: Session not found.
  • KT-CT-10312: Mutation not enabled in this environment.
  • KT-CT-10313: Failed to enroll account.
  • KT-CT-10314: This supply point is already on supply.
  • KT-CT-10315: Unable to begin enrollment journey due to invalid data.
  • KT-CT-6622: Unauthorized.
  • KT-CT-10340: House move enrollment is not enabled.
  • KT-CT-10302: Invalid data.
  • KT-CT-10356: A join supplier process is already linked to the house move.
  • KT-CT-10357: The house move enrollment has multiple supply points for a single market.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (EnrollmentInput!)

The Enrollment Input data for the Join Supplier.

Return fields

NameDescription

Mutation

mutation Enrollment($input: EnrollmentInput!) {
  enrollment(input: $input) {
    enrollmentProcesses {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
    message
  }
}

Variables

{
  "input": EnrollmentInput
}

Response

{
  "data": {
    "enrollment": {
      "enrollmentProcesses": JoinSupplierProcessType,
      "message": "abc123"
    }
  }
}

escalateInkConversation

Type:EscalateInkConversation

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-7659: The Ink conversation could not be escalated.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (EscalateInkConversationInput)

Input for escalating an Ink conversation to the team leader.

Return fields

NameDescription

conversationRelayId (ID!)

The ID of the conversation that was escalated.

Mutation

mutation EscalateInkConversation($input: EscalateInkConversationInput) {
  escalateInkConversation(input: $input) {
    conversationRelayId
  }
}

Variables

{
  "input": EscalateInkConversationInput
}

Response

{
  "data": {
    "escalateInkConversation": {
      "conversationRelayId": "abc123"
    }
  }
}

extendAgreementPeriod

Type:ExtendAgreementPeriod

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

Extend 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-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-1514: Extension validto date must be later than the current validto date.
  • KT-CT-1515: Agreement must have an end date to be extensible.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ExtendAgreementPeriodInput!)

Input for extending the agreement period.

Return fields

NameDescription

agreement (CommonAgreementType)

Agreement that we are going to extend.

Mutation

mutation ExtendAgreementPeriod($input: ExtendAgreementPeriodInput!) {
  extendAgreementPeriod(input: $input) {
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

Variables

{
  "input": ExtendAgreementPeriodInput
}

Response

{
  "data": {
    "extendAgreementPeriod": {
      "agreement": CommonAgreementType
    }
  }
}

fetchGeneratePaymentFingerprint

Type:FetchGeneratePaymentFingerprint

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

Fetch or generate payment fingerprint from vendor.

The possible errors that can be raised are:

  • KT-CT-12101: Payment instruction not found.
  • KT-CT-12102: Payment vendor not supported.
  • KT-CT-12103: Missing payment metadata from vendor.
  • KT-CT-12104: Unable to fetch or generate payment fingerprint.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (FetchGeneratePaymentFingerprintInput!)

Return fields

NameDescription

fingerprint (String)

Fetched or generated fingerprint from vendor.

vendor (String)

Vendor name.

Mutation

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

Variables

{
  "input": FetchGeneratePaymentFingerprintInput
}

Response

{
  "data": {
    "fetchGeneratePaymentFingerprint": {
      "fingerprint": "abc123",
      "vendor": "abc123"
    }
  }
}

fetchPreSignedLinkForOpportunityAttachment

Type:FetchPreSignedLinkForOpportunityAttachment

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

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

The possible errors that can be raised are:

  • KT-CT-8933: Opportunity file attachment not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (FetchPreSignedLinkForOpportunityAttachmentInput!)

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

Return fields

NameDescription

opportunityFileAttachment (OpportunityFileAttachment)

The opportunity file attachment with pre-signed URL.

Mutation

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

Variables

{
  "input": FetchPreSignedLinkForOpportunityAttachmentInput
}

Response

{
  "data": {
    "fetchPreSignedLinkForOpportunityAttachment": {
      "opportunityFileAttachment": OpportunityFileAttachment
    }
  }
}

forceReauthentication

Type:ForceReauthentication

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ForceReauthenticationInput!)

Input object argument to the force-reauthentication mutation.

Return fields

NameDescription

tokensInvalidated (Boolean!)

Reports whether the mutation applied successfully. Should always be 'true'.

effectiveAt (DateTime!)

The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid.

Mutation

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

Variables

{
  "input": ForceReauthenticationInput
}

Response

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

generateAffiliatesAudioRecordingPreSignedUrl

Type:GenerateAffiliatesAudioRecordingPreSignedUrl!

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

Generate a pre-signed URL for uploading an audio file for use with affiliates.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (GenerateAffiliatesAudioRecordingPreSignedUrlInput!)

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

Return fields

NameDescription

Mutation

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

Variables

{
  "input": GenerateAffiliatesAudioRecordingPreSignedUrlInput
}

Response

{
  "data": {
    "generateAffiliatesAudioRecordingPreSignedUrl": {
      "affiliatesAudioRecordingPreSignedUrl": AffiliateAudioRecordingPresignedPostType
    }
  }
}

generateInkPresignedUrl

Type:GenerateInkPresignedUrl

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

The possible errors that can be raised are:

  • KT-CT-7620: Channel not supported.
  • KT-CT-7618: Unable to process message.
  • KT-CT-7624: Error when generating the presigned URL.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (GenerateInkPresignedUrlInput)

Input for generating a presigned URL.

Return fields

NameDescription

uploadUrl (String!)

A presigned URL for the user to upload to the quarantine bucket.

key (String!)

The key for the item.

fields (JSONString!)

Presigned post fields required to upload the file.

Mutation

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

Variables

{
  "input": GenerateInkPresignedUrlInput
}

Response

{
  "data": {
    "generateInkPresignedUrl": {
      "uploadUrl": "abc123",
      "key": "abc123",
      "fields": {"key": "value"}
    }
  }
}

generateLeadsFileAttachmentDownloadPreSignedUrl

Type:GenerateLeadsFileAttachmentDownloadPreSignedUrl

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

Generate a pre-signed URL for downloading a leads attachment file.

The possible errors that can be raised are:

  • KT-CT-8933: Opportunity file attachment not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (GenerateLeadsFileAttachmentDownloadPreSignedUrlInput!)

Input fields for creating a pre-signed URL for downloading a lead file attachment from S3.

Return fields

NameDescription

leadsFileAttachmentDownloadPreSignedUrl (LeadsFileAttachmentDownloadPresignedUrlType)

Pre-signed S3 URL for downloading the leads file attachment.

Mutation

mutation GenerateLeadsFileAttachmentDownloadPreSignedUrl($input: GenerateLeadsFileAttachmentDownloadPreSignedUrlInput!) {
  generateLeadsFileAttachmentDownloadPreSignedUrl(input: $input) {
    leadsFileAttachmentDownloadPreSignedUrl {
      ...LeadsFileAttachmentDownloadPresignedUrlTypeFragment
    }
  }
}

Variables

{
  "input": GenerateLeadsFileAttachmentDownloadPreSignedUrlInput
}

Response

{
  "data": {
    "generateLeadsFileAttachmentDownloadPreSignedUrl": {
      "leadsFileAttachmentDownloadPreSignedUrl": LeadsFileAttachmentDownloadPresignedUrlType
    }
  }
}

generateLeadsFileAttachmentPreSignedUrl

Type:GenerateLeadsFileAttachmentsPreSignedUrl

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

Generate a pre-signed URL for uploading a leads attachment file.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (GenerateLeadsFileAttachmentPreSignedUrlInput!)

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

Return fields

NameDescription

leadsFileAttachmentPreSignedUrl (LeadsFileAttachmentPresignedPostType)

Input fields required to generate a presigned S3 post for leads file attachment.

Mutation

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

Variables

{
  "input": GenerateLeadsFileAttachmentPreSignedUrlInput
}

Response

{
  "data": {
    "generateLeadsFileAttachmentPreSignedUrl": {
      "leadsFileAttachmentPreSignedUrl": LeadsFileAttachmentPresignedPostType
    }
  }
}

generatePreSignedToken

Type:GeneratePreSignedToken

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

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

The possible errors that can be raised are:

  • KT-CT-1128: Unauthorized.
  • KT-CT-1120: The Kraken Token has expired.
  • KT-CT-1131: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

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

NameDescription

token (String)

tokenExpiryDatetime (DateTime)

scope (PreSignedTokenScope)

Mutation

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

Variables

{
  "email": "abc123",
  "numberOfDaysAllowed": 1,
  "scope": "SUBMIT_METER_READINGS"
}

Response

{
  "data": {
    "generatePreSignedToken": {
      "token": "abc123",
      "tokenExpiryDatetime": "2020-01-01T00:00:00.000Z",
      "scope": "SUBMIT_METER_READINGS"
    }
  }
}

getEmbeddedSecretForNewPaymentInstruction

Type:GetEmbeddedSecretForNewPaymentInstruction

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (GetEmbeddedSecretForNewPaymentInstructionInput!)

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

Return fields

NameDescription

secretKey (String)

Mutation

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

Variables

{
  "input": GetEmbeddedSecretForNewPaymentInstructionInput
}

Response

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstruction": {
      "secretKey": "abc123"
    }
  }
}

getEmbeddedSecretForNewPaymentInstructionWithoutAccount

Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount

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

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

This mutation is specifically for saving payment methods for future use, without immediately creating a payment instruction tied to a specific ledger or account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!)

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

Return fields

NameDescription

secretKey (String)

The client secret needed to create a new stored payment instruction.

Mutation

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

Variables

{
  "input": GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
}

Response

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
      "secretKey": "abc123"
    }
  }
}

getHostedUrlForNewPaymentInstruction

Type:GetHostedUrlForNewPaymentInstruction

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (GetHostedUrlForNewPaymentInstructionInput!)

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

Return fields

NameDescription

url (String)

URL at which payment instruction can be set up.

Mutation

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

Variables

{
  "input": GetHostedUrlForNewPaymentInstructionInput
}

Response

{
  "data": {
    "getHostedUrlForNewPaymentInstruction": {
      "url": "abc123"
    }
  }
}

getOrCreateAgreement

Type:GetOrCreateAgreement

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

Get an existing agreement or create a new one if it doesn't exist.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-4719: No supply point found for identifier provided.
  • KT-CT-4910: No product exists with the given input.
  • KT-CT-1503: Agreement validto date must be later than validfrom date.
  • KT-CT-1509: Unable to create agreement.
  • KT-CT-1511: Cannot create overlapping agreement.
  • KT-CT-1512: Account type does not support agreements.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAgreementInput!)

Input fields for getting or creating an agreement.

Return fields

NameDescription

created (Boolean)

Indicates whether a new agreement was created (true) or an existing agreement was returned (false).

agreement (CommonAgreementType)

The agreement that was retrieved or created.

Mutation

mutation GetOrCreateAgreement($input: CreateAgreementInput!) {
  getOrCreateAgreement(input: $input) {
    created
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

Variables

{
  "input": CreateAgreementInput
}

Response

{
  "data": {
    "getOrCreateAgreement": {
      "created": true,
      "agreement": CommonAgreementType
    }
  }
}

grantUserAccessToBusiness

Type:GrantUserAccessToBusiness

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

Grant user access to the business using the provided role.

The possible errors that can be raised are:

  • KT-CT-5463: Unauthorized.
  • KT-CT-11107: Unauthorized.
  • KT-CT-13501: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (GrantUserAccessToBusinessInput!)

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": GrantUserAccessToBusinessInput
}

Response

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

hasFamilyIssues

Type:HasFamilyIssues

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

Flag a user for Family Domestic Violence (FDV) / family issues. Note: The family issues flag can only be enabled (not disabled) through this mutation.

The possible errors that can be raised are:

  • KT-AU-5418: Invalid input for family issues mutation.
  • KT-AU-5416: Family issues flag cannot be removed through this mutation.
  • KT-AU-5417: Account not found for user.
  • KT-AU-5419: Cannot set delivery preference 'EMAIL' for user without an email specified.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (HasFamilyIssuesInputType!)

Input variables for adding family issues details to an account.

Return fields

NameDescription

accountUser (AccountUserType)

The updated account user.

Mutation

mutation HasFamilyIssues($input: HasFamilyIssuesInputType!) {
  hasFamilyIssues(input: $input) {
    accountUser {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": HasFamilyIssuesInputType
}

Response

{
  "data": {
    "hasFamilyIssues": {
      "accountUser": AccountUserType
    }
  }
}

importTrancheRate

Type:ImportTrancheRate!

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

Import a tranche rate for a given contract and market.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-15111: Tranche target not found.
  • KT-CT-15112: A tranche rate already exists for this target and calculation period.
  • KT-CT-15113: Invalid tranche rate input.
  • KT-CT-15114: The provided calculation period does not line up with the calculation period frequency for this tranche target.
  • KT-CT-15115: Contract not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ImportTrancheRateInput!)

Input fields for importing a tranche rate.

Return fields

NameDescription

Mutation

mutation ImportTrancheRate($input: ImportTrancheRateInput!) {
  importTrancheRate(input: $input) {
    rateIdentifier
  }
}

Variables

{
  "input": ImportTrancheRateInput
}

Response

{
  "data": {
    "importTrancheRate": {
      "rateIdentifier": "abc123"
    }
  }
}

initializeAccount

Type:InitializeAccountResult!

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

  • KT-CT-10324: Mutation not enabled in this environment.
  • KT-CT-10325: Input data has invalid format.
  • KT-CT-10326: An error occurred when trying to initialize the account.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (BaseInitializeAccountInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": BaseInitializeAccountInput
}

Response

{
  "data": {
    "initializeAccount": {
      "isNewAccount": true,
      "accountNumber": "abc123"
    }
  }
}

initializeUser

Type:InitializeUserResult!

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

  • KT-CT-10327: Mutation not enabled in this environment.
  • KT-CT-10328: Input data has invalid format.
  • KT-CT-10329: An error occurred when trying to initialize the user.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (BaseInitializeUserInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": BaseInitializeUserInput
}

Response

{
  "data": {
    "initializeUser": {
      "isNewUser": true,
      "userNumber": "abc123"
    }
  }
}

initiateHostedStandalonePayment

Type:InitiateHostedStandalonePayment

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InitiateHostedStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

NameDescription

payment (InitiateHostedStandalonePaymentOutput)

The details required to refer to and complete a hosted payment.

Mutation

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

Variables

{
  "input": InitiateHostedStandalonePaymentInput
}

Response

{
  "data": {
    "initiateHostedStandalonePayment": {
      "payment": InitiateHostedStandalonePaymentOutput
    }
  }
}

initiateProductSwitch

Type:InitiateProductSwitch

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

Do a product switch for a user.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4619: Quote with given code not found.
  • KT-CT-4624: Unable to accept the given product code.
  • KT-CT-4924: Unauthorized.
  • KT-CT-4626: No product selected for the given quote code.
  • KT-CT-4719: No supply point found for identifier provided.
  • KT-CT-1509: Unable to create agreement.
  • KT-CT-1507: Agreement product switch date is not within the acceptable range.
  • KT-CT-1516: Requested product switch is not valid.
  • KT-CT-4640: Unable to get market or client params from quoted product.
  • KT-CT-4627: No products are available for this quote.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (InitiateProductSwitchInput!)

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

Return fields

NameDescription

productCode (String!)

The selected product for a specific product switch.

switchDate (Date!)

The date at which the product switch becomes effective.

Mutation

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

Variables

{
  "input": InitiateProductSwitchInput
}

Response

{
  "data": {
    "initiateProductSwitch": {
      "productCode": "abc123",
      "switchDate": "2020-01-01"
    }
  }
}

initiateStandalonePayment

Type:InitiateStandalonePayment

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InitiateStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

NameDescription

payment (InitiateStandalonePaymentOutput)

Mutation

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

Variables

{
  "input": InitiateStandalonePaymentInput
}

Response

{
  "data": {
    "initiateStandalonePayment": {
      "payment": InitiateStandalonePaymentOutput
    }
  }
}

instigateLeaveSupplier

Type:LeaveSupplierInstigated!

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

Instigate a leave supplier process or update an existing process.

The possible errors that can be raised are:

  • KT-CT-10304: Mutation not enabled in this environment.
  • KT-CT-4501: Unauthorized.
  • KT-CT-10301: Unable to instigate leave supplier process.
  • KT-CT-10330: Unsupported leave supplier type.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (LeaveSupplierInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": LeaveSupplierInput
}

Response

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

invalidatePaymentInstruction

Type:InvalidatePaymentInstruction

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

Invalidate an existing instruction.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InvalidatePaymentInstructionInput!)

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

Return fields

NameDescription

instruction (InvalidatePaymentInstructionOutput)

Mutation

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

Variables

{
  "input": InvalidatePaymentInstructionInput
}

Response

{
  "data": {
    "invalidatePaymentInstruction": {
      "instruction": InvalidatePaymentInstructionOutput
    }
  }
}

invalidatePreSignedToken

Type:InvalidatePreSignedToken

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

Invalidate a previously issued expiring/pre-signed token.

To invalidate tokens issued to a particular user, use InvalidatePreSignedTokensForUser mutation.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InvalidatePreSignedTokenInput!)

Return fields

NameDescription

token (PreSignedToken)

Mutation

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

Variables

{
  "input": InvalidatePreSignedTokenInput
}

Response

{
  "data": {
    "invalidatePreSignedToken": {
      "token": PreSignedToken
    }
  }
}

invalidatePreSignedTokensForUser

Type:InvalidatePreSignedTokensForUser

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

Invalidate pre-signed tokens previously issued to a particular user.

This mutation can invalidate all pre-signed tokens issued to a customer, or only tokens of a given scope.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InvalidatePreSignedTokensForUserInput!)

Return fields

NameDescription

tokens ([PreSignedToken])

Mutation

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

Variables

{
  "input": InvalidatePreSignedTokensForUserInput
}

Response

{
  "data": {
    "invalidatePreSignedTokensForUser": {
      "tokens": [PreSignedToken]
    }
  }
}

invalidateRefreshToken

Type:InvalidateRefreshToken

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

Invalidate a previously issued refresh token.

To invalidate tokens issued to a particular user, use InvalidateRefreshTokensForUser.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InvalidateRefreshTokenInput!)

Return fields

NameDescription

token (RefreshToken)

Mutation

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

Variables

{
  "input": InvalidateRefreshTokenInput
}

Response

{
  "data": {
    "invalidateRefreshToken": {
      "token": RefreshToken
    }
  }
}

invalidateRefreshTokensForUser

Type:InvalidateRefreshTokensForUser

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

Invalidate all refresh tokens previously issued to a particular user.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (InvalidateRefreshTokensForUserInput!)

Return fields

NameDescription

tokens ([RefreshToken])

Mutation

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

Variables

{
  "input": InvalidateRefreshTokensForUserInput
}

Response

{
  "data": {
    "invalidateRefreshTokensForUser": {
      "tokens": [RefreshToken]
    }
  }
}

joinSupplierAcceptTermsAndConditions

Type:JoinSupplierAcceptTermsAndConditions

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

Accept terms and conditions for a join supplier process.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (JoinSupplierAcceptTermsAndConditionsInput!)

Return fields

NameDescription

success (Boolean)

Indicator that the mutation has completed successfully.

Mutation

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

Variables

{
  "input": JoinSupplierAcceptTermsAndConditionsInput
}

Response

{
  "data": {
    "joinSupplierAcceptTermsAndConditions": {
      "success": true
    }
  }
}

legacyProcessOrder

Type:LegacyProcessOrderOutput!

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

Process an Order (legacy)

The possible errors that can be raised are:

  • KT-CT-1605: Invalid input.
  • KT-CT-7701: The affiliate organisation was not found.
  • KT-CT-8906: Opportunity not found.
  • KT-CT-12701: Invalid sales channel code.
  • KT-CT-13102: Invalid order data.
  • KT-CT-13103: Unprocessable order.
  • KT-CT-13104: Conflicting order.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (LegacyProcessOrderInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": LegacyProcessOrderInput
}

Response

{
  "data": {
    "legacyProcessOrder": {
      "status": "PENDING",
      "identifier": NonEmptyString,
      "resources": [LegacyOrderResource]
    }
  }
}

linkAccountToBusiness

Type:LinkAccountToBusiness

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

Link an account to a business.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11104: Business role already allocated.
  • KT-CT-11105: Business role already allocated.
  • KT-CT-11106: Unauthorized.
  • KT-CT-11107: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (LinkAccountToBusinessInput!)

Input fields for linking an account to a business.

Return fields

NameDescription

business (BusinessType)

The business the account was linked to.

Mutation

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

Variables

{
  "input": LinkAccountToBusinessInput
}

Response

{
  "data": {
    "linkAccountToBusiness": {
      "business": BusinessType
    }
  }
}

linkUserToLine

Type:LinkUserToLineResponse!

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

Link an AccountUser to a LINE account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (LinkUserToLineInput!)

Input fields to link an account user with LINE.

Return fields

NameDescription

Mutation

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

Variables

{
  "input": LinkUserToLineInput
}

Response

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

makePaymentWithSavedCard

Type:MakePaymentWithSavedCard

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

Make a payment with a saved credit card instruction.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Deprecated

The 'makePaymentWithSavedCard' field is deprecated.

This mutation only applies to clients using the legacy finanicals system. Use `collectPayment` instead.

- Marked as deprecated on 2025-05-26.
- Scheduled for removal on or after 2026-07-26.

Arguments

NameDescription

input (MakePaymentWithSavedCardInput!)

Input fields for making a payment with a saved card.

Return fields

NameDescription

accountPayment (AccountPaymentType)

Mutation

mutation MakePaymentWithSavedCard($input: MakePaymentWithSavedCardInput!) {
  makePaymentWithSavedCard(input: $input) {
    accountPayment {
      ...AccountPaymentTypeFragment
    }
  }
}

Variables

{
  "input": MakePaymentWithSavedCardInput
}

Response

{
  "data": {
    "makePaymentWithSavedCard": {
      "accountPayment": AccountPaymentType
    }
  }
}

manualReviewMeterDataIssue

Type:ManualReviewMeterDataIssue

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

Mark a Meter Data Issue as manually reviewed by setting its status to IN_REVIEW.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13802: Meter data issue not found.
  • KT-CT-13806: Invalid market name provided.
  • KT-CT-13808: No active flow exists for this issue.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ManualReviewMeterDataIssueInputType!)

Input variables needed for marking a Meter Data Issue as manually reviewed.

Return fields

NameDescription

meterDataIssueManualReviewed (ManualReviewMeterDataIssueOutputType)

The manually reviewed meter data issue.

Mutation

mutation ManualReviewMeterDataIssue($input: ManualReviewMeterDataIssueInputType!) {
  manualReviewMeterDataIssue(input: $input) {
    meterDataIssueManualReviewed {
      ...ManualReviewMeterDataIssueOutputTypeFragment
    }
  }
}

Variables

{
  "input": ManualReviewMeterDataIssueInputType
}

Response

{
  "data": {
    "manualReviewMeterDataIssue": {
      "meterDataIssueManualReviewed": ManualReviewMeterDataIssueOutputType
    }
  }
}

markPrintBatchAsProcessed

Type:MarkPrintBatchAsProcessed!

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

Mark a closed print batch as processed.

The possible errors that can be raised are:

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

Arguments

NameDescription

printBatchId (ID!)

Return fields

NameDescription

Mutation

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

Variables

{
  "printBatchId": "abc123"
}

Response

{
  "data": {
    "markPrintBatchAsProcessed": {
      "printBatch": PrintBatchType
    }
  }
}

masqueradeAuthentication

Type:MasqueradeAuthentication

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

The possible errors that can be raised are:

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

Arguments

NameDescription

masqueradeToken (String!)

The masquerade token issued by the support site.

userId (String!)

The ID of the AccountUser to masquerade as.

Return fields

NameDescription

token (String)

A Kraken Token that can be used to authenticate to the API, masquerading as the desired user.

errors ([ErrorType])

A list of any errors that occurred while running this mutation.

Mutation

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

Variables

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

Response

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

moveToBucket

Type:MoveToBucket

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

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (MoveToBucketInput)

Input for moving a conversation to a bucket.

Return fields

NameDescription

conversation (InkConversation!)

The conversation that was moved to the bucket.

Mutation

mutation MoveToBucket($input: MoveToBucketInput) {
  moveToBucket(input: $input) {
    conversation {
      ...InkConversationFragment
    }
  }
}

Variables

{
  "input": MoveToBucketInput
}

Response

{
  "data": {
    "moveToBucket": {
      "conversation": InkConversation
    }
  }
}

nextOperationsTeamRoundRobin

Type:NextOperationsTeamRoundRobin

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

The possible errors that can be raised are:

  • KT-CT-10820: Operations team group not found.
  • KT-CT-10821: No active teams in operations team group.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

teamGroupName (String!)

The name of the operations team group to select from.

Return fields

NameDescription

team (Team!)

The next operations team assigned in round-robin sequence.

location (TeamLocation!)

Location routing information for the selected team.

teamGroups ([TeamGroup]!)

All operations team groups that the selected team belongs to.

allInferredRoutingAttributes ([String]!)

All inferred routing attributes for team, location, and team groups (e.g., ['OPERATIONSGROUP.TEAM.TeamA', 'OPERATIONSGROUP.LOCATION.London', 'OPERATIONSGROUP.GROUP_B']). Recommended for IVR usage.

Mutation

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

Variables

{
  "teamGroupName": "abc123"
}

Response

{
  "data": {
    "nextOperationsTeamRoundRobin": {
      "team": Team,
      "location": TeamLocation,
      "teamGroups": TeamGroup,
      "allInferredRoutingAttributes": "abc123"
    }
  }
}

obtainKrakenToken

Type:ObtainKrakenJSONWebToken

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

Create a Kraken Token (JWT) for authentication.

Provide the required input fields to obtain the token.

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ObtainJSONWebTokenInput!)

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

Return fields

NameDescription

token (String!)

The Kraken Token. Can be used in the Authorization header for subsequent calls to the API to access protected resources.

payload (GenericScalar!)

The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the token field.

refreshToken (String)

A token that can be used in a subsequent call to obtainKrakenToken to get a new Kraken Token with the same access conditions after the previous one has expired.

refreshExpiresIn (Int)

A Unix timestamp representing the point in time at which the refresh token will expire.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": ObtainJSONWebTokenInput
}

Response

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

obtainLongLivedRefreshToken

Type:ObtainLongLivedRefreshToken

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

Obtain a long-lived refresh token.

This mutation is limited to authorized third-party organizations only. Account users can only generate short-lived refresh tokens, obtainable from the 'refreshToken' field in the 'obtainKrakenToken' mutation.

The possible errors that can be raised are:

  • KT-CT-1120: The Kraken Token has expired.
  • KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
  • KT-CT-1132: Unauthorized.
  • KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ObtainLongLivedRefreshTokenInput!)

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

Return fields

NameDescription

refreshToken (String)

refreshExpiresIn (Int!)

Mutation

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

Variables

{
  "input": ObtainLongLivedRefreshTokenInput
}

Response

{
  "data": {
    "obtainLongLivedRefreshToken": {
      "refreshToken": "abc123",
      "refreshExpiresIn": 1
    }
  }
}

pauseCollectionProcess

Type:PauseCollectionProcess

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

Manually pause a collection process.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11214: Invalid pause length for collection process.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PauseCollectionProcessInput!)

Details for pausing a collection process.

Return fields

NameDescription

collectionProcessPaused (PauseCollectionProcessOutput)

Collection process pause output.

Mutation

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

Variables

{
  "input": PauseCollectionProcessInput
}

Response

{
  "data": {
    "pauseCollectionProcess": {
      "collectionProcessPaused": PauseCollectionProcessOutput
    }
  }
}

pauseDunning

Type:PauseDunning

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

Pause the dunning process for an account.

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-11301: Account not in a dunning process for the given path name.
  • KT-CT-11302: No active dunning process found.
  • KT-CT-11303: Multiple active dunning processes found.
  • KT-CT-11304: Dunning pause process failed verifying the dates.
  • KT-CT-11305: Pausing the dunning process failed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PauseDunningInputType!)

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

Return fields

NameDescription

pauseCreated (Boolean)

Whether the pause has been successfully created.

Mutation

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

Variables

{
  "input": PauseDunningInputType
}

Response

{
  "data": {
    "pauseDunning": {
      "pauseCreated": true
    }
  }
}

payoutReferralForAccount

Type:PayoutReferralForAccount

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

Pay out a referral reward for an account.

The possible errors that can be raised are:

  • KT-CT-6712: Invalid reference.
  • KT-CT-6723: Unauthorized.
  • KT-CT-6730: Referral cannot be paid out.
  • KT-CT-6731: The account is unrelated to the referral.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PayoutReferralForAccountInput!)

Input fields for paying out a referral for an account.

Return fields

NameDescription

payoutResult (PayoutReferralForAccountResultType)

The result of the payout.

Mutation

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

Variables

{
  "input": PayoutReferralForAccountInput
}

Response

{
  "data": {
    "payoutReferralForAccount": {
      "payoutResult": PayoutReferralForAccountResultType
    }
  }
}

postCredit

Type:PostCredit

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

NameDescription

input (PostCreditInput!)

Input fields for posting a credit.

Return fields

NameDescription

credit (Credit)

Posted account credit.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": PostCreditInput
}

Response

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

prepareAccount

Type:PrepareAccountResult!

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

  • KT-CT-10303: Mutation not enabled in this environment.
  • KT-CT-10316: Input data has invalid format.
  • KT-CT-10322: A user with this email address already exists.
  • KT-CT-10317: An error occured when trying to prepare the account.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PrepareAccountInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": PrepareAccountInput
}

Response

{
  "data": {
    "prepareAccount": {
      "isNewAccount": true,
      "accountNumber": "abc123",
      "isNewUser": true,
      "userId": "abc123",
      "userNumber": "abc123"
    }
  }
}

previewAndCreatePaymentPlan

Type:PreviewAndCreatePaymentPlan

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

Preview a new payment plan, or create it if requested.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-CT-3923: Unauthorized.
  • KT-AU-3917: Unable to preview payment plan.
  • KT-AU-3919: Unable to create payment plan.
  • KT-AU-3918: Unable to create payment plan.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PaymentPlanInput!)

Input fields for creating a payment plan.

Return fields

NameDescription

paymentPlanPreview ([PaymentPlanPreviewPaymentType])

Preview payments for a new payment plan.

createdPaymentPlan (PaymentPlanType)

Data for newly created payment plan of one was created.

Mutation

mutation PreviewAndCreatePaymentPlan($input: PaymentPlanInput!) {
  previewAndCreatePaymentPlan(input: $input) {
    paymentPlanPreview {
      ...PaymentPlanPreviewPaymentTypeFragment
    }
    createdPaymentPlan {
      ...PaymentPlanTypeFragment
    }
  }
}

Variables

{
  "input": PaymentPlanInput
}

Response

{
  "data": {
    "previewAndCreatePaymentPlan": {
      "paymentPlanPreview": [PaymentPlanPreviewPaymentType],
      "createdPaymentPlan": PaymentPlanType
    }
  }
}

processHouseMove

Type:ProcessHouseMove

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

Mutation to process a house move that supports multiple markets.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ProcessHouseMoveInput!)

Return fields

NameDescription

account (AccountType)

The account created or associated with the move in.

error (ProcessHouseMoveErrorUnion)

Error type for the house move in process.

Mutation

mutation ProcessHouseMove($input: ProcessHouseMoveInput!) {
  processHouseMove(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on MoveInFailedToCompleteErrorType {
        ...MoveInFailedToCompleteErrorTypeFragment
      }
      ... on HouseMoveOutHasBeenPerformedErrorType {
        ...HouseMoveOutHasBeenPerformedErrorTypeFragment
      }
      ... on MarketMismatchErrorType {
        ...MarketMismatchErrorTypeFragment
      }
      ... on HouseMoveProblemsErrorType {
        ...HouseMoveProblemsErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
      ... on BillingFrequencyNotValidType {
        ...BillingFrequencyNotValidTypeFragment
      }
      ... on PaymentTermsInvalidErrorType {
        ...PaymentTermsInvalidErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": ProcessHouseMoveInput
}

Response

{
  "data": {
    "processHouseMove": {
      "account": AccountType,
      "error": DoesNotExistErrorType
    }
  }
}

processHouseMoveInElectricity

Type:ProcessHouseMoveInElectricity

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

Process a house move in for a related account, triggering a move in process for a defined user. Allows configuration of the user's: - Move in details - Billing preferences

Depending on the related user's state in kraken, this mutation will either return or create an account within kraken.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ProcessHouseMoveInElectricityInput!)

Return fields

NameDescription

account (AccountType)

error (ProcessHouseMoveInElectricityErrorUnion)

Error type for the move in process.

Mutation

mutation ProcessHouseMoveInElectricity($input: ProcessHouseMoveInElectricityInput!) {
  processHouseMoveInElectricity(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on AddOnInvalidErrorType {
        ...AddOnInvalidErrorTypeFragment
      }
      ... on MoveInDetailsInValidErrorType {
        ...MoveInDetailsInValidErrorTypeFragment
      }
      ... on MoveInAdressDetailIsMissingErrorType {
        ...MoveInAdressDetailIsMissingErrorTypeFragment
      }
      ... on MoveInDetailsHaveTooManyHazardsErrorType {
        ...MoveInDetailsHaveTooManyHazardsErrorTypeFragment
      }
      ... on MoveInFailedToCompleteErrorType {
        ...MoveInFailedToCompleteErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
      ... on HouseMoveProblemsErrorType {
        ...HouseMoveProblemsErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": ProcessHouseMoveInElectricityInput
}

Response

{
  "data": {
    "processHouseMoveInElectricity": {
      "account": AccountType,
      "error": DoesNotExistErrorType
    }
  }
}

processHouseMoveInGas

Type:ProcessHouseMoveInGas

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

Process a gas house move in for a related account, triggering a gas move in process for a defined user. Allows configuration of the user's: - Move in details - Billing preferences - Life support status - business_details Depending on the related user's state in kraken, this mutation will either return or create an account within kraken.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ProcessHouseMoveInGasInput!)

Return fields

NameDescription

account (AccountType)

error (ProcessHouseMoveInGasErrorUnion)

Error type for the gas move in process.

Mutation

mutation ProcessHouseMoveInGas($input: ProcessHouseMoveInGasInput!) {
  processHouseMoveInGas(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
      ... on GasHouseMoveInFailedErrorType {
        ...GasHouseMoveInFailedErrorTypeFragment
      }
      ... on HouseMoveProblemsErrorType {
        ...HouseMoveProblemsErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": ProcessHouseMoveInGasInput
}

Response

{
  "data": {
    "processHouseMoveInGas": {
      "account": AccountType,
      "error": DoesNotExistErrorType
    }
  }
}

propertyMoveOut

Type:PropertyMoveOut

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

Trigger the Leave Property lifecycle journey for a property in the CES embedded electricity market. Initially supports CES market supply points and is designed to expand to support all markets in the future.

The possible errors that can be raised are:

  • KT-CT-6622: Unauthorized.
  • KT-CT-6623: Unauthorized.
  • KT-AU-6610: Move out process validation failed.
  • KT-AU-6611: Unable to move out of property.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PropertyMoveOutInput!)

Return fields

NameDescription

workflow (WorkflowType!)

Information on the workflow which is processing the move out.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

mutation PropertyMoveOut($input: PropertyMoveOutInput!) {
  propertyMoveOut(input: $input) {
    workflow {
      ...WorkflowTypeFragment
    }
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": PropertyMoveOutInput
}

Response

{
  "data": {
    "propertyMoveOut": {
      "workflow": WorkflowType,
      "possibleErrors": [PossibleErrorType]
    }
  }
}

publishMeterDataIssueEmail

Type:PublishMeterDataIssueEmail

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

Publish the transactional messaging trigger to send an email to the meter data issue's MDP.

The possible errors that can be raised are:

  • KT-CT-13802: Meter data issue not found.
  • KT-AU-13820: No operational contact found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PublishMeterDataIssueEmailInput!)

Input data for publishing a meter data issue email.

Return fields

NameDescription

result (PublishMeterDataIssueEmailOutputType)

The result of publishing a meter data issue email.

Mutation

mutation PublishMeterDataIssueEmail($input: PublishMeterDataIssueEmailInput!) {
  publishMeterDataIssueEmail(input: $input) {
    result {
      ...PublishMeterDataIssueEmailOutputTypeFragment
    }
  }
}

Variables

{
  "input": PublishMeterDataIssueEmailInput
}

Response

{
  "data": {
    "publishMeterDataIssueEmail": {
      "result": PublishMeterDataIssueEmailOutputType
    }
  }
}

publishTransactionalMessagingExternalTrigger

Type:PublishTransactionalMessagingExternalTrigger

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

Publish an externally defined transactional messaging trigger.

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-5421: Account user not found.
  • KT-CT-9901: Invalid trigger type code.
  • KT-CT-9905: Top-level context fields are missing.
  • KT-CT-9906: Template variables do not match the defined schema.
  • KT-CT-9908: Invalid recipient information.
  • KT-CT-9909: Invalid recipient information.
  • KT-CT-9910: Invalid input field combination.
  • KT-CT-9912: Required context entity not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PublishTransactionalMessagingExternalTriggerInput!)

Input fields to publish an external transactional messaging trigger.

Return fields

NameDescription

trigger (Trigger)

The trigger that has been published.

Mutation

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

Variables

{
  "input": PublishTransactionalMessagingExternalTriggerInput
}

Response

{
  "data": {
    "publishTransactionalMessagingExternalTrigger": {
      "trigger": Trigger
    }
  }
}

publishTransactionalMessagingTrigger

Type:PublishTransactionalMessagingTrigger

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

Publish a trigger within the transactional messaging service.

The possible errors that can be raised are:

  • KT-CT-9901: Invalid trigger type code.
  • KT-CT-9902: Invalid trigger type params.
  • KT-CT-9903: Trigger type cannot be published externally.
  • KT-CT-9912: Required context entity not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (PublishTransactionalMessagingTriggerInput!)

Input fields to publish a transactional messaging trigger.

Return fields

NameDescription

trigger (Trigger)

The trigger that has been published.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": PublishTransactionalMessagingTriggerInput
}

Response

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

purchaseVoucher

Type:PurchaseVoucher

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

Purchase a voucher.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4178: No account found with given account number.
  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-13201: Invalid voucher type.
  • KT-CT-3924: Unauthorized.
  • KT-CT-13204: A voucher purchase with this idempotency key already exists.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

idempotencyKey (String)

Optional idempotency key to prevent duplicate purchases on retry. If provided and already used, the mutation returns an error instead of creating a duplicate purchase.

input (PurchaseVoucherInput!)

Return fields

NameDescription

voucherPurchase (VoucherPurchaseType)

The voucher purchase created from the mutation.

Mutation

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

Variables

{
  "idempotencyKey": "abc123",
  "input": PurchaseVoucherInput
}

Response

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

purchaseVouchers

Type:PurchaseVouchers

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

Purchase multiple vouchers.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4178: No account found with given account number.
  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-13201: Invalid voucher type.
  • KT-CT-3924: Unauthorized.
  • KT-CT-13202: Exactly one of chargeAmountInCents or chargeAmountInCentsWithTax expected.
  • KT-CT-13203: Multiple account numbers found in voucher batch.
  • KT-CT-13204: A voucher purchase with this idempotency key already exists.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

idempotencyKey (String)

Optional idempotency key to prevent the entire batch from being processed more than once on retry. If provided and already used, the mutation returns an error instead of creating duplicate purchases.

input ([PurchaseVoucherInput]!)

The list of vouchers to purchase.

Return fields

NameDescription

voucherPurchases ([VoucherPurchaseType])

The voucher purchases created from the mutation.

Mutation

mutation PurchaseVouchers(
  $idempotencyKey: String,
  $input: [PurchaseVoucherInput]!
) {
  purchaseVouchers(
    idempotencyKey: $idempotencyKey,
    input: $input
  ) {
    voucherPurchases {
      ...VoucherPurchaseTypeFragment
    }
  }
}

Variables

{
  "idempotencyKey": "abc123",
  "input": PurchaseVoucherInput
}

Response

{
  "data": {
    "purchaseVouchers": {
      "voucherPurchases": [VoucherPurchaseType]
    }
  }
}

quarantineElectricitySelfMeterRead

Type:QuarantineElectricitySelfMeterRead

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

Quarantine electricity self meter read.

The possible errors that can be raised are:

  • KT-AU-5611: Cannot find register with the provided ID.
  • KT-AU-6411: Cannot find reading with the provided ID.
  • KT-AU-6412: Missing quarantine reading reason.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (QuarantineElectricityReadingInputType!)

Return fields

NameDescription

reading (ElectricityAccumulationMeterReadingType)

The reading, which is quarantined.

Mutation

mutation QuarantineElectricitySelfMeterRead($input: QuarantineElectricityReadingInputType!) {
  quarantineElectricitySelfMeterRead(input: $input) {
    reading {
      ...ElectricityAccumulationMeterReadingTypeFragment
    }
  }
}

Variables

{
  "input": QuarantineElectricityReadingInputType
}

Response

{
  "data": {
    "quarantineElectricitySelfMeterRead": {
      "reading": ElectricityAccumulationMeterReadingType
    }
  }
}

reactivateCollectionProcessRecord

Type:ReactivateCollectionProcessRecord

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

Reactivate a Collection Process Record that was previously activated.

Unlike UpdateCollectionProcessRecordToActive, this mutation does not require or update the externalreference field. Use this when reactivating a collection process that already has an externalreference set from its initial activation.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11217: Invalid collection process record status for reactivation.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ReactivateCollectionProcessRecordInputType!)

Input variables needed for reactivating a collection process record.

Return fields

NameDescription

collectionProcessReactivated (ReactivateCollectionProcessRecordOutputType)

The reactivated collection process record.

Mutation

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

Variables

{
  "input": ReactivateCollectionProcessRecordInputType
}

Response

{
  "data": {
    "reactivateCollectionProcessRecord": {
      "collectionProcessReactivated": ReactivateCollectionProcessRecordOutputType
    }
  }
}

recordActivatedPaymentMethod

Type:RecordActivatedPaymentMethod

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

Record an activated payment method.

The possible errors that can be raised are:

  • KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
  • KT-CT-3822: Unauthorized.
  • KT-CT-3987: Invalid payment method type code.
  • KT-CT-3991: Received no financial account details.
  • KT-CT-3992: Received multiple financial account details.
  • KT-CT-3993: The type of financial account details does not match the provided payment method type.
  • KT-CT-3994: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RecordActivatedPaymentMethodInput!)

Details about the activated payment method.

Return fields

NameDescription

paymentMethod (PaymentMethodType)

The stored payment method.

Mutation

mutation RecordActivatedPaymentMethod($input: RecordActivatedPaymentMethodInput!) {
  recordActivatedPaymentMethod(input: $input) {
    paymentMethod {
      ...PaymentMethodTypeFragment
    }
  }
}

Variables

{
  "input": RecordActivatedPaymentMethodInput
}

Response

{
  "data": {
    "recordActivatedPaymentMethod": {
      "paymentMethod": PaymentMethodType
    }
  }
}

recordChargedBackPayment

Type:RecordChargedBackPayment

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

Record one or more charged back payments.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
  • KT-CT-3985: Received both token and options for action intent.
  • KT-CT-3986: Received neither token nor options for action intent.
  • KT-CT-3987: Invalid payment method type code.
  • KT-CT-3988: Number of items in list exceeds maximum value.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RecordChargedBackPaymentInput!)

Details about the charged back payments.

Return fields

NameDescription

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

Mutation

mutation RecordChargedBackPayment($input: RecordChargedBackPaymentInput!) {
  recordChargedBackPayment(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordChargedBackPaymentInput
}

Response

{
  "data": {
    "recordChargedBackPayment": {
      "noticeBatchIdentifier": "abc123"
    }
  }
}

recordDepositAgreementAccepted

Type:RecordDepositAgreementAccepted

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

Record the customer's acceptance of a deposit agreement.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (DepositAgreementInput!)

Return fields

NameDescription

isRecorded (Boolean)

Mutation

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

Variables

{
  "input": DepositAgreementInput
}

Response

{
  "data": {
    "recordDepositAgreementAccepted": {
      "isRecorded": true
    }
  }
}

recordFailedPayment

Type:RecordFailedPayment

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

Record one or more failed payments.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
  • KT-CT-3985: Received both token and options for action intent.
  • KT-CT-3986: Received neither token nor options for action intent.
  • KT-CT-3987: Invalid payment method type code.
  • KT-CT-3988: Number of items in list exceeds maximum value.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RecordFailedPaymentInput!)

Details about the failed payments.

Return fields

NameDescription

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

Mutation

mutation RecordFailedPayment($input: RecordFailedPaymentInput!) {
  recordFailedPayment(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordFailedPaymentInput
}

Response

{
  "data": {
    "recordFailedPayment": {
      "noticeBatchIdentifier": "abc123"
    }
  }
}

recordInvalidatedPaymentMethod

Type:RecordInvalidatedPaymentMethod

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

Record an invalidated payment method.

The possible errors that can be raised are:

  • KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
  • KT-CT-3996: Unauthorized.
  • KT-CT-3997: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RecordInvalidatedPaymentMethodInput!)

Details about the invalidated payment method.

Return fields

NameDescription

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

Mutation

mutation RecordInvalidatedPaymentMethod($input: RecordInvalidatedPaymentMethodInput!) {
  recordInvalidatedPaymentMethod(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordInvalidatedPaymentMethodInput
}

Response

{
  "data": {
    "recordInvalidatedPaymentMethod": {
      "noticeBatchIdentifier": "abc123"
    }
  }
}

recordPendingPayment

Type:RecordPendingPayment

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

Record one or more pending payments.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
  • KT-CT-3985: Received both token and options for action intent.
  • KT-CT-3986: Received neither token nor options for action intent.
  • KT-CT-3987: Invalid payment method type code.
  • KT-CT-3988: Number of items in list exceeds maximum value.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RecordPendingPaymentInput!)

Details about the pending payments.

Return fields

NameDescription

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

Mutation

mutation RecordPendingPayment($input: RecordPendingPaymentInput!) {
  recordPendingPayment(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordPendingPaymentInput
}

Response

{
  "data": {
    "recordPendingPayment": {
      "noticeBatchIdentifier": "abc123"
    }
  }
}

recordSuccessfulPayment

Type:RecordSuccessfulPayment

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

Record one or more successful payments.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
  • KT-CT-3985: Received both token and options for action intent.
  • KT-CT-3986: Received neither token nor options for action intent.
  • KT-CT-3987: Invalid payment method type code.
  • KT-CT-3988: Number of items in list exceeds maximum value.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RecordSuccessfulPaymentInput!)

Details about the successful payments.

Return fields

NameDescription

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

Mutation

mutation RecordSuccessfulPayment($input: RecordSuccessfulPaymentInput!) {
  recordSuccessfulPayment(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordSuccessfulPaymentInput
}

Response

{
  "data": {
    "recordSuccessfulPayment": {
      "noticeBatchIdentifier": "abc123"
    }
  }
}

redeemLoyaltyPointsForAccountCredit

Type:RedeemLoyaltyPointsForAccountCredit

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

Redeem the specified number of Loyalty Points as account credit.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RedeemLoyaltyPointsInput!)

Input fields for redeeming Loyalty Points.

Return fields

NameDescription

pointsRedeemed (Int)

The number of loyalty points that were redeemed.

Mutation

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

Variables

{
  "input": RedeemLoyaltyPointsInput
}

Response

{
  "data": {
    "redeemLoyaltyPointsForAccountCredit": {
      "pointsRedeemed": 1
    }
  }
}

redeemReferralClaimCode

Type:RedeemReferralClaimCode

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

Redeem the referral claim code from certain referral scheme.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RedeemReferralClaimCodeInput!)

Input fields for redeeming referral code.

Return fields

NameDescription

success (Boolean!)

Whether or not the request was successful.

Mutation

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

Variables

{
  "input": RedeemReferralClaimCodeInput
}

Response

{
  "data": {
    "redeemReferralClaimCode": {
      "success": true
    }
  }
}

refundPayment

Type:RefundPayment

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

Refund a cleared payment.

The possible errors that can be raised are:

  • KT-CT-3924: Unauthorized.
  • KT-CT-3928: Idempotency key used for another repayment request.
  • KT-CT-3929: The payment is not in a refundable state.
  • KT-CT-3933: Refund amount greater than payment amount.
  • KT-CT-3937: Payment not eligible for refund.
  • KT-CT-3938: Partial refund not allowed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RefundPaymentInput!)

Input fields for refunding a payment.

Return fields

NameDescription

repayment (AccountRepaymentType)

The repayment for the requested refund.

Mutation

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

Variables

{
  "input": RefundPaymentInput
}

Response

{
  "data": {
    "refundPayment": {
      "repayment": AccountRepaymentType
    }
  }
}

refundVoucher

Type:RefundVoucher

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

Refund a voucher purchase.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13205: Voucher purchase not found.
  • KT-CT-13206: Voucher has already been redeemed and cannot be refunded.
  • KT-CT-13207: Voucher has already been refunded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RefundVoucherInput!)

The input for the refund voucher mutation.

Return fields

NameDescription

voucherPurchase (VoucherPurchaseType)

The voucher purchase that was refunded.

Mutation

mutation RefundVoucher($input: RefundVoucherInput!) {
  refundVoucher(input: $input) {
    voucherPurchase {
      ...VoucherPurchaseTypeFragment
    }
  }
}

Variables

{
  "input": RefundVoucherInput
}

Response

{
  "data": {
    "refundVoucher": {
      "voucherPurchase": VoucherPurchaseType
    }
  }
}

regenerateSecretKey

Type:RegenerateSecretKey

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

Regenerate the live secret key for the authenticated user.

The possible errors that can be raised are:

  • KT-CT-11100: API key authentication unavailable.
  • KT-CT-1113: Disabled GraphQL field requested.

Return fields

NameDescription

key (String!)

The generated key value, which is only ever available once (here).

viewer (AccountUserType)

The currently authenticated user.

Mutation

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

Response

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

registerCustomerAsset

Type:RegisterCustomerAsset

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

Register a new customer asset for an account

The possible errors that can be raised are:

  • KT-CT-1128: Unauthorized.
  • KT-CT-14602: Customer asset already exists.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RegisterCustomerAssetInput!)

Input fields for registering a device.

Return fields

NameDescription

customerAsset (CustomerAssetType)

The registered customer asset.

Mutation

mutation RegisterCustomerAsset($input: RegisterCustomerAssetInput!) {
  registerCustomerAsset(input: $input) {
    customerAsset {
      ...CustomerAssetTypeFragment
    }
  }
}

Variables

{
  "input": RegisterCustomerAssetInput
}

Response

{
  "data": {
    "registerCustomerAsset": {
      "customerAsset": CustomerAssetType
    }
  }
}

registerLeadFlowStatusEvent

Type:RegisterLeadFlowStatusEvent

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

Register a flow status event for a lead.

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RegisterLeadFlowStatusEventInput!)

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

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": RegisterLeadFlowStatusEventInput
}

Response

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

registerOpportunityFlowStatusEvent

Type:RegisterOpportunityFlowStatusEvent

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

Register a flow status event for an opportunity.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RegisterOpportunityFlowStatusEventInput!)

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

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": RegisterOpportunityFlowStatusEventInput
}

Response

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

registerPushNotificationBinding

Type:RegisterPushNotificationBinding

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RegisterPushNotificationBindingInput!)

Input fields for creating an push notification binding.

Return fields

NameDescription

pushNotificationBinding (PushNotificationBindingType)

Mutation

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

Variables

{
  "input": RegisterPushNotificationBindingInput
}

Response

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

removeBankDetailsForLead

Type:RemoveBankDetailsForLead

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

Soft delete the payment method reference for a lead.

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-8955: Payment method reference does not match.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RemoveBankDetailsForLeadInput!)

Input for removing payment details from a lead.

Return fields

NameDescription

leadNumber (String)

The unique number of the lead.

Mutation

mutation RemoveBankDetailsForLead($input: RemoveBankDetailsForLeadInput!) {
  removeBankDetailsForLead(input: $input) {
    leadNumber
  }
}

Variables

{
  "input": RemoveBankDetailsForLeadInput
}

Response

{
  "data": {
    "removeBankDetailsForLead": {
      "leadNumber": "abc123"
    }
  }
}

removeCampaignFromAccount

Type:RemoveCampaignFromAccount

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

The possible errors that can be raised are:

  • KT-CT-7424: Failed to remove campaign from account.
  • KT-CT-7426: The account is not part of the given campaign.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RemoveCampaignFromAccountInput!)

Input variables needed for removing a campaign from an account.

Return fields

NameDescription

campaignRemoved (Boolean)

Whether the campaign was successfully removed from the account.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": RemoveCampaignFromAccountInput
}

Response

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

removeCampaignItems

Type:RemoveCampaignItems

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

The possible errors that can be raised are:

  • KT-CT-11501: Voice campaign not found.
  • KT-CT-11502: Cannot remove items from multiple campaigns at once.
  • KT-CT-11505: Voice campaign item not found.
  • KT-CT-11506: Invalid campaign ID.
  • KT-CT-11507: Invalid campaign item ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RemoveCampaignItemsInput!)

Return fields

NameDescription

campaignItems ([VoiceCampaignItemType])

Mutation

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

Variables

{
  "input": RemoveCampaignItemsInput
}

Response

{
  "data": {
    "removeCampaignItems": {
      "campaignItems": [VoiceCampaignItemType]
    }
  }
}

removeConcession

Type:RemoveConcession

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

Mutation to remove a concession for a user account

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RemoveConcessionInput!)

Return fields

NameDescription

concession (ConcessionType)

Mutation

mutation RemoveConcession($input: RemoveConcessionInput!) {
  removeConcession(input: $input) {
    concession {
      ...ConcessionTypeFragment
    }
  }
}

Variables

{
  "input": RemoveConcessionInput
}

Response

{
  "data": {
    "removeConcession": {
      "concession": ConcessionType
    }
  }
}

removeItemsFromRiskList

Type:RemoveItemsFromRiskList

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

Remove existing items from the risk list.

The possible errors that can be raised are:

  • KT-CT-12106: Risk list item removal failed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input ([RiskListItemInputType]!)

A list of risk list items to remove.

Return fields

NameDescription

riskIdentifiers ([RiskListItemType])

List of successfully removed risk identifiers.

Mutation

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

Variables

{
  "input": RiskListItemInputType
}

Response

{
  "data": {
    "removeItemsFromRiskList": {
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

removePartnerUserFromTeam

Type:RemovePartnerUserFromTeam!

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

Remove an existing partner user from a partner team.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RemovePartnerUserFromTeamInput!)

Input fields for removing a partner user from a team.

Return fields

NameDescription

Mutation

mutation RemovePartnerUserFromTeam($input: RemovePartnerUserFromTeamInput!) {
  removePartnerUserFromTeam(input: $input) {
    partnerUser {
      ...PartnerUserTypeFragment
    }
  }
}

Variables

{
  "input": RemovePartnerUserFromTeamInput
}

Response

{
  "data": {
    "removePartnerUserFromTeam": {
      "partnerUser": PartnerUserType
    }
  }
}

removePropertyFromHierarchy

Type:RemovePropertyFromHierarchy

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

Remove a property from a hierarchy.

This operation is idempotent - if the property is not in the hierarchy, it will succeed without error. When a property is removed, its descendants are reparented to the removed property's parent. If removing a root node, its children become new root nodes.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RemovePropertyFromHierarchyInput!)

Input fields for removing a property from a hierarchy.

Return fields

NameDescription

property (PropertyType)

The property that was removed from the hierarchy.

Mutation

mutation RemovePropertyFromHierarchy($input: RemovePropertyFromHierarchyInput!) {
  removePropertyFromHierarchy(input: $input) {
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": RemovePropertyFromHierarchyInput
}

Response

{
  "data": {
    "removePropertyFromHierarchy": {
      "property": PropertyType
    }
  }
}

replaceLatestPaymentSchedule

Type:ReplaceLatestPaymentSchedule

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

Replaces the active payment schedule with a new payment schedule. Requires the new schedule type to be passed in, as well as whether the schedule should be fixed.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ReplaceLatestPaymentScheduleInput!)

Input fields for replacing the active payment schedule.

Return fields

NameDescription

replacedSchedule (PaymentScheduleType)

The payment schedule that was replaced.

newSchedule (PaymentScheduleType)

The new payment schedule that has replaced the specified one.

Mutation

mutation ReplaceLatestPaymentSchedule($input: ReplaceLatestPaymentScheduleInput!) {
  replaceLatestPaymentSchedule(input: $input) {
    replacedSchedule {
      ...PaymentScheduleTypeFragment
    }
    newSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": ReplaceLatestPaymentScheduleInput
}

Response

{
  "data": {
    "replaceLatestPaymentSchedule": {
      "replacedSchedule": PaymentScheduleType,
      "newSchedule": PaymentScheduleType
    }
  }
}

replacePartnerReferences

Type:ReplacePartnerReferences!

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

Replace the references for a partner organisation.

The possible errors that can be raised are:

  • KT-CT-7701: The affiliate organisation was not found.
  • KT-CT-7732: The supplied reference namespace is not configured for this client.
  • KT-CT-7733: Another partner organisation already has a reference with this value in this namespace.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ReplacePartnerReferencesInputType!)

Input fields for setting partner references.

Return fields

NameDescription

Mutation

mutation ReplacePartnerReferences($input: ReplacePartnerReferencesInputType!) {
  replacePartnerReferences(input: $input) {
    partner {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

Variables

{
  "input": ReplacePartnerReferencesInputType
}

Response

{
  "data": {
    "replacePartnerReferences": {
      "partner": AffiliateOrganisationType
    }
  }
}

requestCadReport

Type:RequestCADReport

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

Request a customer access data (CAD) report.

The possible errors that can be raised are:

  • KT-AU-3811: Missing or invalid mutation inputs.
  • KT-CT-3823: Unauthorized.
  • KT-CT-6420: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RequestCADReportInputType!)

Return fields

NameDescription

account (AccountType)

The account.

successful (Boolean)

Whether the email with the data was sent.

Mutation

mutation RequestCadReport($input: RequestCADReportInputType!) {
  requestCadReport(input: $input) {
    account {
      ...AccountTypeFragment
    }
    successful
  }
}

Variables

{
  "input": RequestCADReportInputType
}

Response

{
  "data": {
    "requestCadReport": {
      "account": AccountType,
      "successful": true
    }
  }
}

requestDoubleOptIn

Type:RequestDoubleOptIn

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

Request a double opt in for a consent.

This mutation will create a consent with a value of PENDING and publish a double opt-in requested transactional messaging trigger.

The possible errors that can be raised are:

  • KT-CT-9019: Invalid input.
  • KT-CT-9018: Account not found.
  • KT-CT-1111: Unauthorized.
  • KT-CT-9016: Consent management not enabled.
  • KT-CT-9017: Consent type not found.
  • KT-CT-9023: Consent already accepted.
  • KT-CT-1199: Too many requests.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (DoubleOptInInput)

Return fields

NameDescription

consent (ConsentType)

The consent that was created or updated.

Mutation

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

Variables

{
  "input": DoubleOptInInput
}

Response

{
  "data": {
    "requestDoubleOptIn": {
      "consent": ConsentType
    }
  }
}

requestMirnDiscovery

Type:RequestMIRNDiscovery

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

Taking a MIRN identifier trigger an async request to resolve its origin

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RequestMIRNDiscoveryInput!)

Return fields

NameDescription

discoveryRequest (MDHXProcessDiscoveryType)

error (MIRNDiscoveryErrorUnion)

Mutation

mutation RequestMirnDiscovery($input: RequestMIRNDiscoveryInput!) {
  requestMirnDiscovery(input: $input) {
    discoveryRequest {
      ...MDHXProcessDiscoveryTypeFragment
    }
    error {
      ... on MIRNDiscoveryRequestAlreadyTriggeredErrorType {
        ...MIRNDiscoveryRequestAlreadyTriggeredErrorTypeFragment
      }
      ... on UnableToPerformDiscoveryErrorType {
        ...UnableToPerformDiscoveryErrorTypeFragment
      }
      ... on InvalidDiscoveryRequestErrorType {
        ...InvalidDiscoveryRequestErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": RequestMIRNDiscoveryInput
}

Response

{
  "data": {
    "requestMirnDiscovery": {
      "discoveryRequest": MDHXProcessDiscoveryType,
      "error": MIRNDiscoveryRequestAlreadyTriggeredErrorType
    }
  }
}

requestPasswordReset

Type:RequestPasswordResetOutputType

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

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

The possible errors that can be raised are:

  • KT-CT-11331: Invalid input data.
  • KT-CT-11332: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (RequestPasswordResetInput!)

Input fields for requesting a password reset email.

Return fields

NameDescription

email (String)

The email that requested a password reset email.

userNumber (String)

The number of the user that requested a password reset email.

Mutation

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

Variables

{
  "input": RequestPasswordResetInput
}

Response

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

requestPrintedBill

Type:RequestPrintedBill

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (RequestPrintedBillInput!)

Input fields to request a printed bill.

Return fields

NameDescription

success (Boolean)

Whether the request was successful.

Mutation

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

Variables

{
  "input": RequestPrintedBillInput
}

Response

{
  "data": {
    "requestPrintedBill": {
      "success": true
    }
  }
}

reschedulePayment

Type:ReschedulePayment

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

Reschedule an existing payment by a certain number of days

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ReschedulePaymentInput!)

Input fields for rescheduling a payment.

Return fields

NameDescription

newAccountPayment (AccountPaymentType)

error (ReschedulePaymentErrorUnion)

Mutation

mutation ReschedulePayment($input: ReschedulePaymentInput!) {
  reschedulePayment(input: $input) {
    newAccountPayment {
      ...AccountPaymentTypeFragment
    }
    error {
      ... on ExceededMaxSchedulableWorkingDaysErrorType {
        ...ExceededMaxSchedulableWorkingDaysErrorTypeFragment
      }
      ... on MissingPaymentDetailsErrorType {
        ...MissingPaymentDetailsErrorTypeFragment
      }
      ... on InvalidVendorForRescheduleErrorType {
        ...InvalidVendorForRescheduleErrorTypeFragment
      }
      ... on InvalidStatusForRescheduleErrorType {
        ...InvalidStatusForRescheduleErrorTypeFragment
      }
      ... on CannotRescheduleForFixedPaymentCustomerErrorType {
        ...CannotRescheduleForFixedPaymentCustomerErrorTypeFragment
      }
      ... on CannotRescheduleForReRepresentedPaymentsErrorType {
        ...CannotRescheduleForReRepresentedPaymentsErrorTypeFragment
      }
      ... on CannotRescheduleWithMissingAccountStatementErrorType {
        ...CannotRescheduleWithMissingAccountStatementErrorTypeFragment
      }
      ... on CannotRescheduleWithMoreThenOneRescheduledPaymentErrorType {
        ...CannotRescheduleWithMoreThenOneRescheduledPaymentErrorTypeFragment
      }
      ... on InvalidTransactionErrorType {
        ...InvalidTransactionErrorTypeFragment
      }
      ... on NoRelatedPaymentSchedulesOnPaymentDateErrorType {
        ...NoRelatedPaymentSchedulesOnPaymentDateErrorTypeFragment
      }
      ... on UnableToMatchPaymentDateToLedgerSchedulesErrorType {
        ...UnableToMatchPaymentDateToLedgerSchedulesErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": ReschedulePaymentInput
}

Response

{
  "data": {
    "reschedulePayment": {
      "newAccountPayment": AccountPaymentType,
      "error": ExceededMaxSchedulableWorkingDaysErrorType
    }
  }
}

rescindContract

Type:RescindContractOutput!

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

Rescind an existing contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10040: Unable to rescind contract.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RescindContractInput!)

Return fields

NameDescription

Mutation

mutation RescindContract($input: RescindContractInput!) {
  rescindContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": RescindContractInput
}

Response

{
  "data": {
    "rescindContract": {
      "contract": Contract
    }
  }
}

resetPassword

Type:ResetPasswordMutationPayload

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

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

The possible errors that can be raised are:

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

Deprecated

The 'resetPassword' field is deprecated.

Please use `resetUserPassword` instead.

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

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

Arguments

NameDescription

input (ResetPasswordMutationInput!)

Input for resetting a password.

Return fields

NameDescription

errors ([SerializerFieldErrorsType])

clientMutationId (String)

A unique identifier for the client performing the mutation.

Mutation

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

Variables

{
  "input": ResetPasswordMutationInput
}

Response

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

resetUserPassword

Type:ResetUserPasswordOutput

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

  • KT-CT-4125: Unauthorized.
  • KT-CT-1132: Unauthorized.
  • KT-CT-5450: Password is invalid.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

NameDescription

userId (ID!)

The ID of the user whose password was changed.

passwordUpdated (Boolean)

True if the password update was successful, false otherwise.

Deprecated

The 'passwordUpdated' field is deprecated.

Please handle the KT-CT-5450 error instead.

Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields.

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

failureReasons ([String])

A list of messages of which password validations the new password failed against if applicable.

Deprecated

The 'failureReasons' field is deprecated.

Please handle the KT-CT-5450 error and inspect the `validationErrors[].message` extension instead.

Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields.

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

failureCodes ([String])

A list of codes of which password validation the new password failed against if applicable. One 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

Deprecated

The 'failureCodes' field is deprecated.

Please handle the KT-CT-5450 error and inspect the `validationErrors[].code` extension instead.

Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields.

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

Mutation

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

Variables

{
  "input": ResetUserPasswordInput
}

Response

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

resolveMeterDataIssue

Type:ResolveMeterDataIssue

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

Resolve a Meter Data Issue by setting its status to RESOLVED.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-13802: Meter data issue not found.
  • KT-CT-13805: Meter data issue is already resolved.
  • KT-CT-13806: Invalid market name provided.
  • KT-CT-13808: No active flow exists for this issue.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ResolveMeterDataIssueInputType!)

Input variables needed for resolving a Meter Data Issue.

Return fields

NameDescription

meterDataIssueResolved (ResolveMeterDataIssueOutputType)

The resolved meter data issue.

Mutation

mutation ResolveMeterDataIssue($input: ResolveMeterDataIssueInputType!) {
  resolveMeterDataIssue(input: $input) {
    meterDataIssueResolved {
      ...ResolveMeterDataIssueOutputTypeFragment
    }
  }
}

Variables

{
  "input": ResolveMeterDataIssueInputType
}

Response

{
  "data": {
    "resolveMeterDataIssue": {
      "meterDataIssueResolved": ResolveMeterDataIssueOutputType
    }
  }
}

resumeCollectionProcess

Type:ResumeCollectionProcess

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

Manually resume a collection process.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11215: Unable to resume, collection process is not paused.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ResumeCollectionProcessInput!)

Details for resuming a collection process.

Return fields

NameDescription

collectionProcessResumed (ResumeCollectionProcessOutput)

Collection process resume output.

Mutation

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

Variables

{
  "input": ResumeCollectionProcessInput
}

Response

{
  "data": {
    "resumeCollectionProcess": {
      "collectionProcessResumed": ResumeCollectionProcessOutput
    }
  }
}

retireCustomerAsset

Type:RetireCustomerAsset

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

Retire a customer asset for an account

The possible errors that can be raised are:

  • KT-CT-14603: Unable to retire customer asset.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RetireCustomerAssetInput!)

Input fields for retiring a customer asset.

Return fields

NameDescription

customerAsset (CustomerAssetType)

The retired customer asset.

Mutation

mutation RetireCustomerAsset($input: RetireCustomerAssetInput!) {
  retireCustomerAsset(input: $input) {
    customerAsset {
      ...CustomerAssetTypeFragment
    }
  }
}

Variables

{
  "input": RetireCustomerAssetInput
}

Response

{
  "data": {
    "retireCustomerAsset": {
      "customerAsset": CustomerAssetType
    }
  }
}

reverseEnrollment

Type:EnrollmentReversed!

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

Reverse an enrollment (Join Supplier process).

The possible errors that can be raised are:

  • KT-CT-10312: Mutation not enabled in this environment.
  • KT-CT-10318: Enrollment process not found.
  • KT-CT-10349: Enrollment process is not reversible.
  • KT-CT-10350: Enrollment process can still be cancelled.
  • KT-CT-10351: Enrollment process being cancelled cannot be reversed.
  • KT-CT-10352: Market actions cannot be reversed for this enrollment process.
  • KT-CT-10353: Failed to reverse enrollment process.
  • KT-CT-10354: Enrollment reversal cut-off has passed.
  • KT-CT-10355: Enrollment reversal is not allowed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ReverseEnrollmentInput!)

The input required to reverse an enrollment.

Return fields

NameDescription

Mutation

mutation ReverseEnrollment($input: ReverseEnrollmentInput!) {
  reverseEnrollment(input: $input) {
    message
    enrollmentProcess {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
  }
}

Variables

{
  "input": ReverseEnrollmentInput
}

Response

{
  "data": {
    "reverseEnrollment": {
      "message": "abc123",
      "enrollmentProcess": JoinSupplierProcessType
    }
  }
}

reverseLeaveSupplier

Type:LeaveSupplierReversed!

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

Reverse 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-10341: Leave supplier process is not reversible.
  • KT-CT-10342: Leave supplier process can still be cancelled.
  • KT-CT-10343: Leave supplier process being cancelled cannot be reversed.
  • KT-CT-10344: Leave supplier reversal cut-off has passed.
  • KT-CT-10345: Occupier leave with real join cannot be reversed.
  • KT-CT-10346: Market action reversal is not supported for this leave supplier process.
  • KT-CT-10347: Failed to reverse leave supplier process.
  • KT-CT-10348: Leave supplier reversal is missing required dependencies.
  • 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

NameDescription

input (ReverseLeaveSupplierInput!)

Return fields

NameDescription

Mutation

mutation ReverseLeaveSupplier($input: ReverseLeaveSupplierInput!) {
  reverseLeaveSupplier(input: $input) {
    message
  }
}

Variables

{
  "input": ReverseLeaveSupplierInput
}

Response

{
  "data": {
    "reverseLeaveSupplier": {
      "message": "abc123"
    }
  }
}

revokeAgreement

Type:RevokeAgreement

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

Revoke an agreement.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-1501: Agreement not found.
  • KT-CT-1502: Billed agreements cannot be revoked.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RevokeAgreementInput!)

Input fields for revoking an agreement.

Return fields

NameDescription

account (AccountType)

Account responsible for the revoked agreement.

Mutation

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

Variables

{
  "input": RevokeAgreementInput
}

Response

{
  "data": {
    "revokeAgreement": {
      "account": AccountType
    }
  }
}

revokeContract

Type:RevokeContractOutput!

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

Revoke an existing contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10022: Contract already terminated.
  • KT-CT-10023: Contract is already revoked.
  • KT-CT-10024: Contract already expired.
  • KT-CT-10032: Contract has already started.
  • KT-CT-10041: Contract is already rescinded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RevokeContractInput!)

Return fields

NameDescription

Mutation

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

Variables

{
  "input": RevokeContractInput
}

Response

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

revokePartnerUserAccess

Type:RevokePartnerUserAccess!

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

Permanently revoke a partner user access.

The possible errors that can be raised are:

  • KT-CT-7701: The affiliate organisation was not found.
  • KT-CT-7725: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RevokePartnerUserAccessInput!)

Input fields for deleting a partner user.

Return fields

NameDescription

Mutation

mutation RevokePartnerUserAccess($input: RevokePartnerUserAccessInput!) {
  revokePartnerUserAccess(input: $input) {
    partnerUser {
      ...RevokePartnerUserAccessTypeFragment
    }
  }
}

Variables

{
  "input": RevokePartnerUserAccessInput
}

Response

{
  "data": {
    "revokePartnerUserAccess": {
      "partnerUser": RevokePartnerUserAccessType
    }
  }
}

revokeUserAccessFromBusiness

Type:RevokeUserAccessFromBusiness

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

Revoke the selected role from the user for the business.

The possible errors that can be raised are:

  • KT-CT-5463: Unauthorized.
  • KT-CT-11107: Unauthorized.
  • KT-CT-13501: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RevokeUserAccessFromBusinessInput!)

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": RevokeUserAccessFromBusinessInput
}

Response

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

runAgreementRollover

Type:RunAgreementRollover

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

Run an agreement rollover.

The possible errors that can be raised are:

  • KT-CT-13705: Agreement rollover not found.
  • KT-CT-13706: Agreement rollover has an invalid status for this operation.
  • KT-CT-13709: Agreement rollover workflow has an invalid status for this operation.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RunAgreementRolloverInput!)

Input for running an agreement rollover.

Return fields

NameDescription

agreementRollover (AgreementRolloverType)

The executed agreement rollover.

Mutation

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

Variables

{
  "input": RunAgreementRolloverInput
}

Response

{
  "data": {
    "runAgreementRollover": {
      "agreementRollover": AgreementRolloverType
    }
  }
}

scheduleQuoteFollowUp

Type:ScheduleQuoteFollowUp

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

Schedule a quote follow-up to the provided recipient.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (QuoteShareInput!)

Return fields

NameDescription

success (Boolean!)

Whether the message was scheduled successfully.

Mutation

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

Variables

{
  "input": QuoteShareInput
}

Response

{
  "data": {
    "scheduleQuoteFollowUp": {
      "success": true
    }
  }
}

selectProducts

Type:SelectProducts

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

Mark chosen quoted products for quoted supply points 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

NameDescription

input (SelectProductsInput!)

Return fields

NameDescription

success (Boolean!)

Whether we successfully marked the chosen quoted products as selected.

Mutation

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

Variables

{
  "input": SelectProductsInput
}

Response

{
  "data": {
    "selectProducts": {
      "success": true
    }
  }
}

sendAgreementRescissionConfirmation

Type:SendAgreementRescissionConfirmation

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

Publish a transactional message confirming an agreement rescission.

The possible errors that can be raised are:

  • KT-CT-14101: Agreement rescission not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendAgreementRescissionMessageInput!)

Input fields for sending a message.

Return fields

NameDescription

agreementRescission (AgreementRescissionType)

The agreement rescission for which we are sending a message.

Mutation

mutation SendAgreementRescissionConfirmation($input: SendAgreementRescissionMessageInput!) {
  sendAgreementRescissionConfirmation(input: $input) {
    agreementRescission {
      ...AgreementRescissionTypeFragment
    }
  }
}

Variables

{
  "input": SendAgreementRescissionMessageInput
}

Response

{
  "data": {
    "sendAgreementRescissionConfirmation": {
      "agreementRescission": AgreementRescissionType
    }
  }
}

sendCdrNotificationComms

Type:SendCDRNotification

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

Send a CDR notification to a named recipient for a given account.

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CDRNotificationInput!)

Input fields for sending CDR notification.

Return fields

NameDescription

messages ([MessageType])

The list of Messages created and sent.

Mutation

mutation SendCdrNotificationComms($input: CDRNotificationInput!) {
  sendCdrNotificationComms(input: $input) {
    messages {
      ...MessageTypeFragment
    }
  }
}

Variables

{
  "input": CDRNotificationInput
}

Response

{
  "data": {
    "sendCdrNotificationComms": {
      "messages": [MessageType]
    }
  }
}

sendChangeNmiDetailsRequest

Type:SendChangeNMIDetailsRequest

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

Send a Change NMI Details request to create a pending data update.

The possible errors that can be raised are:

  • KT-CT-13802: Meter data issue not found.
  • KT-AU-13822: Change NMI details request precondition not met.
  • KT-AU-13823: Redundant NMI status update.
  • KT-AU-13824: Unable to verify NMI status against SDR.
  • KT-AU-13825: Change NMI details request blocked because the connection point has safety de-energisation enabled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendChangeNMIDetailsRequestInputType!)

Input data for sending a Change NMI Details request.

Return fields

NameDescription

result (SendChangeNMIDetailsRequestOutputType)

The result of sending the Change NMI Details request.

Mutation

mutation SendChangeNmiDetailsRequest($input: SendChangeNMIDetailsRequestInputType!) {
  sendChangeNmiDetailsRequest(input: $input) {
    result {
      ...SendChangeNMIDetailsRequestOutputTypeFragment
    }
  }
}

Variables

{
  "input": SendChangeNMIDetailsRequestInputType
}

Response

{
  "data": {
    "sendChangeNmiDetailsRequest": {
      "result": SendChangeNMIDetailsRequestOutputType
    }
  }
}

sendCustomerDetailsRequest

Type:SendCustomerDetailsRequest

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

Trigger a CustomerDetailsRequest to be sent to industry.

The possible errors that can be raised are:

  • KT-AU-5613: Cannot find meter point with the provided ID.
  • KT-AU-12604: Could not create Customer Details Request for NMI.
  • KT-AU-12605: There was no repsonse to your request.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendCustomerDetailsRequestInputType!)

Return fields

NameDescription

transaction (ChromaTransactionType)

The transaction returned from the market gateway.

Mutation

mutation SendCustomerDetailsRequest($input: SendCustomerDetailsRequestInputType!) {
  sendCustomerDetailsRequest(input: $input) {
    transaction {
      ...ChromaTransactionTypeFragment
    }
  }
}

Variables

{
  "input": SendCustomerDetailsRequestInputType
}

Response

{
  "data": {
    "sendCustomerDetailsRequest": {
      "transaction": ChromaTransactionType
    }
  }
}

sendInkOutboundMessage

Type:SendInkOutboundMessage

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

Send an Ink outbound message.

The possible errors that can be raised are:

  • KT-CT-7625: Invalid email address.
  • KT-CT-7650: Cannot send messages to internal handles.
  • KT-CT-7670: Invalid mutation input.
  • KT-CT-7671: Could not send message.
  • KT-CT-7672: Invalid outbound handle.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendInkOutboundMessageInput)

Input for sending an Ink outbound message.

Return fields

NameDescription

message (InkMessage!)

The Ink message that was enqueued for sending.

Mutation

mutation SendInkOutboundMessage($input: SendInkOutboundMessageInput) {
  sendInkOutboundMessage(input: $input) {
    message {
      ... on InkEmail {
        ...InkEmailFragment
      }
      ... on InkSMS {
        ...InkSMSFragment
      }
      ... on InkLine {
        ...InkLineFragment
      }
      ... on InkWhatsApp {
        ...InkWhatsAppFragment
      }
      ... on InkTwilioWhatsApp {
        ...InkTwilioWhatsAppFragment
      }
      ... on InkPost {
        ...InkPostFragment
      }
      ... on InkGenericMessage {
        ...InkGenericMessageFragment
      }
      ... on InkLiveChatMessage {
        ...InkLiveChatMessageFragment
      }
    }
  }
}

Variables

{
  "input": SendInkOutboundMessageInput
}

Response

{
  "data": {
    "sendInkOutboundMessage": {
      "message": InkEmail
    }
  }
}

sendOfferQuoteSummary

Type:SendOfferQuoteSummary

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

Send an offer quote summary to all active account users.

The possible errors that can be raised are:

  • KT-CT-4619: Quote with given code not found.
  • KT-CT-4178: No account found with given account number.
  • KT-CT-12407: The offer group does not contain an accepted offer.
  • KT-CT-5518: Account user not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (OfferQuoteSummaryInput!)

Return fields

NameDescription

success (Boolean!)

Whether the triggering of the offer quote summary was successful.

Mutation

mutation SendOfferQuoteSummary($input: OfferQuoteSummaryInput!) {
  sendOfferQuoteSummary(input: $input) {
    success
  }
}

Variables

{
  "input": OfferQuoteSummaryInput
}

Response

{
  "data": {
    "sendOfferQuoteSummary": {
      "success": true
    }
  }
}

sendQuoteSummary

Type:SendQuoteSummary

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

Send a quote summary to the provided recipient.

The possible errors that can be raised are:

  • KT-CT-4619: Quote with given code not found.
  • KT-CT-4178: No account found with given account number.
  • KT-CT-4632: Invalid recipient information.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (QuoteShareInput!)

Return fields

NameDescription

success (Boolean!)

Whether the triggering of the quote summary was successful.

Mutation

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

Variables

{
  "input": QuoteShareInput
}

Response

{
  "data": {
    "sendQuoteSummary": {
      "success": true
    }
  }
}

sendSiteAccessNotification

Type:SendSiteAccessNotification

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

Trigger a SiteAccessNotification to be sent to industry.

The possible errors that can be raised are:

  • KT-AU-5613: Cannot find meter point with the provided ID.
  • KT-CT-4502: Market message already sent.
  • KT-CT-4503: Market message failed validation.
  • KT-AU-4511: Error communicating with Chroma.
  • KT-AU-4512: Chroma request validation error.
  • KT-AU-4513: Chroma response validation error.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendSiteAccessNotificationInput!)

Return fields

NameDescription

transaction (ChromaTransactionType)

The transaction returned from Chroma.

Mutation

mutation SendSiteAccessNotification($input: SendSiteAccessNotificationInput!) {
  sendSiteAccessNotification(input: $input) {
    transaction {
      ...ChromaTransactionTypeFragment
    }
  }
}

Variables

{
  "input": SendSiteAccessNotificationInput
}

Response

{
  "data": {
    "sendSiteAccessNotification": {
      "transaction": ChromaTransactionType
    }
  }
}

sendTrustpilotReviewInvitation

Type:SendTrustpilotReviewInvitation

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

Send a Trustpilot review invitation email to an account user.

The possible errors that can be raised are:

  • KT-CT-1128: Unauthorized.
  • KT-CT-5523: Invalid account or account user.
  • KT-CT-5524: Account user does not have an email address.
  • KT-CT-5525: Unable to send the Trustpilot review invitation.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendTrustpilotReviewInvitationInput!)

Input variables needed to send a Trustpilot review invitation.

Return fields

NameDescription

sendAt (DateTime)

The datetime at which Trustpilot will send the review invitation.

Mutation

mutation SendTrustpilotReviewInvitation($input: SendTrustpilotReviewInvitationInput!) {
  sendTrustpilotReviewInvitation(input: $input) {
    sendAt
  }
}

Variables

{
  "input": SendTrustpilotReviewInvitationInput
}

Response

{
  "data": {
    "sendTrustpilotReviewInvitation": {
      "sendAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

sendVerificationEmail

Type:SendVerificationEmail

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

Verify user's email address.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (SendVerificationEmailInput!)

Return fields

NameDescription

verificationStatus (Boolean)

If the verification email was sent.

Mutation

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

Variables

{
  "input": SendVerificationEmailInput
}

Response

{
  "data": {
    "sendVerificationEmail": {
      "verificationStatus": true
    }
  }
}

setLastConsumerChangeDateRecordToBeExpired

Type:SetLastConsumerChangeDateRecordToBeExpired

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

Expire a Last Consumer Change Date record for a given NMI and date

The possible errors that can be raised are:

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

Arguments

NameDescription

input (SetLastConsumerChangeDateRecordToBeExpiredInput!)

Return fields

NameDescription

lastConsumerChangeDateId (String)

The ID of the LastConsumerChangeDate record that was updated.

Mutation

mutation SetLastConsumerChangeDateRecordToBeExpired($input: SetLastConsumerChangeDateRecordToBeExpiredInput!) {
  setLastConsumerChangeDateRecordToBeExpired(input: $input) {
    lastConsumerChangeDateId
  }
}

Variables

{
  "input": SetLastConsumerChangeDateRecordToBeExpiredInput
}

Response

{
  "data": {
    "setLastConsumerChangeDateRecordToBeExpired": {
      "lastConsumerChangeDateId": "abc123"
    }
  }
}

setLoyaltyPointsUser

Type:SetLoyaltyPointsUser

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

Set the Loyalty Points user for the account.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-9210: Unhandled Loyalty Points exception.
  • KT-CT-9214: Couldn't assign user loyalty points role.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetLoyaltyPointsUserInput!)

Input fields for saving the Loyalty Points user.

Return fields

NameDescription

newLoyaltyPointsUserId (String)

ID of the new Loyalty Points user.

Mutation

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

Variables

{
  "input": SetLoyaltyPointsUserInput
}

Response

{
  "data": {
    "setLoyaltyPointsUser": {
      "newLoyaltyPointsUserId": "abc123"
    }
  }
}

setOpportunityOutcome

Type:SetOpportunityOutcome

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

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

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetOpportunityOutcomeInput!)

Input fields for setting the outcome of a opportunity.

Return fields

NameDescription

message (String)

Success message for now.

Mutation

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

Variables

{
  "input": SetOpportunityOutcomeInput
}

Response

{
  "data": {
    "setOpportunityOutcome": {
      "message": "abc123"
    }
  }
}

setPaymentPreference

Type:SetPaymentPreference

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

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-3822: Unauthorized.
  • KT-CT-3967: Payment method is not valid.
  • KT-CT-3968: Preference cannot be set this soon.
  • KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetPaymentPreferenceInput!)

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": SetPaymentPreferenceInput
}

Response

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

setQuoteConfigurationRatesRequestErrors

Type:SetQuoteConfigurationRatesRequestErrorsOutput

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

Set errors on a quote configuration rates request.

The possible errors that can be raised are:

  • KT-CT-12425: Cannot update rates request.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetQuoteConfigurationRatesRequestErrorsInput!)

Input for setting rates request errors.

Return fields

NameDescription

quoteConfiguration (QuoteConfigurationType!)

The quote configuration associated with the updated rates request.

Mutation

mutation SetQuoteConfigurationRatesRequestErrors($input: SetQuoteConfigurationRatesRequestErrorsInput!) {
  setQuoteConfigurationRatesRequestErrors(input: $input) {
    quoteConfiguration {
      ...QuoteConfigurationTypeFragment
    }
  }
}

Variables

{
  "input": SetQuoteConfigurationRatesRequestErrorsInput
}

Response

{
  "data": {
    "setQuoteConfigurationRatesRequestErrors": {
      "quoteConfiguration": QuoteConfigurationType
    }
  }
}

setUpDirectDebitInstruction

Type:SetUpDirectDebitInstruction

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

Set up a new direct debit instruction.

The possible errors that can be raised are:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-3821: Received neither ledger ID nor ledger number.
  • KT-CT-3940: Invalid data.
  • KT-CT-5415: Account user not found.
  • KT-CT-11103: Business not found.
  • KT-CT-3971: Instruction owners are not valid.
  • KT-CT-3979: Invalid ledger.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetUpDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction.

Return fields

NameDescription

paymentInstruction (DirectDebitInstructionType)

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": SetUpDirectDebitInstructionInput
}

Response

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

setUpDirectDebitInstructionForBusiness

Type:SetUpDirectDebitInstructionForBusiness

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

Set up a new direct debit instruction for a business.

The possible errors that can be raised are:

  • KT-CT-3940: Invalid data.
  • KT-CT-3956: Temporary error occurred.
  • KT-CT-11107: Unauthorized.
  • KT-CT-3948: Could not set up direct debit instruction.
  • KT-CT-3971: Instruction owners are not valid.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetUpDirectDebitInstructionForBusinessInput!)

Input fields for creating a new direct debit instruction.

Return fields

NameDescription

paymentInstruction (DirectDebitInstructionType)

The created direct debit instruction.

Mutation

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

Variables

{
  "input": SetUpDirectDebitInstructionForBusinessInput
}

Response

{
  "data": {
    "setUpDirectDebitInstructionForBusiness": {
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setUpDirectDebitInstructionFromStoredDetails

Type:SetUpDirectDebitInstructionFromStoredDetails

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

Set up a new direct debit instruction from stored details.

The possible errors that can be raised are:

  • KT-CT-3956: Temporary error occurred.
  • KT-CT-3948: Could not set up direct debit instruction.
  • KT-CT-3971: Instruction owners are not valid.
  • KT-CT-5415: Account user not found.
  • KT-CT-11103: Business not found.
  • KT-CT-4123: Unauthorized.
  • KT-CT-3822: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SetUpDirectDebitInstructionFromStoredDetailsInput!)

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

Return fields

NameDescription

paymentInstruction (DirectDebitInstructionType)

The payment instruction that was created from stored details.

Mutation

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

Variables

{
  "input": SetUpDirectDebitInstructionFromStoredDetailsInput
}

Response

{
  "data": {
    "setUpDirectDebitInstructionFromStoredDetails": {
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

shareGoodsQuote

Type:ShareGoodsQuote

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

Share a goods quote.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ShareGoodsQuoteInput!)

Input fields for sharing a quote.

Return fields

NameDescription

share (GoodsQuoteShare)

Goods quote shared.

Mutation

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

Variables

{
  "input": ShareGoodsQuoteInput
}

Response

{
  "data": {
    "shareGoodsQuote": {
      "share": GoodsQuoteShare
    }
  }
}

startCollectionProcess

Type:StartCollectionProcess

URL:https://api.redenergy-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-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StartCollectionProcessInput!)

Details to start collection process for.

Return fields

NameDescription

collectionProcessStarted (StartCollectionProcessOutput)

Details of collection process that has been started.

Mutation

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

Variables

{
  "input": StartCollectionProcessInput
}

Response

{
  "data": {
    "startCollectionProcess": {
      "collectionProcessStarted": StartCollectionProcessOutput
    }
  }
}

startCustomerVerification

Type:StartCustomerVerification

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

Start the customer verification using the provided verification method.

The possible errors that can be raised are:

  • KT-CT-1701: Brand does not exist.
  • KT-CT-4194: Verification type not supported yet.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StartCustomerVerificationInput!)

Return fields

NameDescription

verificationProcess (VerificationProcess)

The newly created verification process.

Mutation

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

Variables

{
  "input": StartCustomerVerificationInput
}

Response

{
  "data": {
    "startCustomerVerification": {
      "verificationProcess": VerificationProcess
    }
  }
}

startGroupedCollectionProcess

Type:StartGroupedCollectionProcess

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

Start a collection process grouped with a previously existing one. Use this when a new collection process (e.g. disconnection) must be linked to an earlier one (e.g. comms) for end-to-end traceability. Callers who do not need grouping should use startCollectionProcess instead.

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-11308: Previous collection process not found.
  • KT-CT-11309: Previous collection process does not belong to the same entity.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StartGroupedCollectionProcessInput!)

Details to start a grouped collection process.

Return fields

NameDescription

collectionProcessStarted (StartGroupedCollectionProcessOutput)

Details of the collection process that has been started.

Mutation

mutation StartGroupedCollectionProcess($input: StartGroupedCollectionProcessInput!) {
  startGroupedCollectionProcess(input: $input) {
    collectionProcessStarted {
      ...StartGroupedCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": StartGroupedCollectionProcessInput
}

Response

{
  "data": {
    "startGroupedCollectionProcess": {
      "collectionProcessStarted": StartGroupedCollectionProcessOutput
    }
  }
}

startMirnIdentification

Type:StartMirnIdentification

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

Trigger an asynchronous MIRN discovery process based on (partial) address details.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (StartMirnIdentificationInput!)

Return fields

NameDescription

identification (IdentificationType)

Mirn Identification reference.

error (StartMirnIdentificationErrorUnion)

Any error that occurs during the fulfilment of this mutation.

Mutation

mutation StartMirnIdentification($input: StartMirnIdentificationInput!) {
  startMirnIdentification(input: $input) {
    identification {
      ...IdentificationTypeFragment
    }
    error {
      ... on InvalidContactDetails {
        ...InvalidContactDetailsFragment
      }
    }
  }
}

Variables

{
  "input": StartMirnIdentificationInput
}

Response

{
  "data": {
    "startMirnIdentification": {
      "identification": IdentificationType,
      "error": InvalidContactDetails
    }
  }
}

stopAutomatedPayments

Type:StopAutomatedPayments

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

Set a preference to stop collecting automated payments.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-3822: Unauthorized.
  • KT-CT-3968: Preference cannot be set this soon.
  • KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StopAutomatedPaymentsInput!)

Return fields

NameDescription

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": StopAutomatedPaymentsInput
}

Response

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

storeBankDetailsForLead

Type:StoreBankDetailsForLead

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

Store bank details for a lead and return the mandate UUID.

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-3940: Invalid data.
  • KT-CT-3956: Temporary error occurred.
  • KT-CT-8954: Unable to store payment method reference on lead.
  • KT-CT-8959: Unable to set payment details for lead.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StoreBankDetailsForLeadInput!)

Input for adding payment details to a lead.

Return fields

NameDescription

paymentMethodReference (String)

Reference of the mandate generated for the lead.

Mutation

mutation StoreBankDetailsForLead($input: StoreBankDetailsForLeadInput!) {
  storeBankDetailsForLead(input: $input) {
    paymentMethodReference
  }
}

Variables

{
  "input": StoreBankDetailsForLeadInput
}

Response

{
  "data": {
    "storeBankDetailsForLead": {
      "paymentMethodReference": "abc123"
    }
  }
}

storeDirectDebitPaymentMethodDetails

Type:StoreDirectDebitPaymentMethodDetails

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

Store bank details with the vendor.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (StoreDirectDebitPaymentMethodDetailsInput!)

Store bank details with the vendor.

Return fields

NameDescription

storedPaymentMethodDetailsReference (String)

Mutation

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

Variables

{
  "input": StoreDirectDebitPaymentMethodDetailsInput
}

Response

{
  "data": {
    "storeDirectDebitPaymentMethodDetails": {
      "storedPaymentMethodDetailsReference": "abc123"
    }
  }
}

storePaymentInstruction

Type:StorePaymentInstruction

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

Store a new payment instruction created through the embedded process.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (StorePaymentInstructionInput!)

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

Return fields

NameDescription

paymentInstruction (PaymentInstructionType)

The stored payment instruction.

Mutation

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

Variables

{
  "input": StorePaymentInstructionInput
}

Response

{
  "data": {
    "storePaymentInstruction": {
      "paymentInstruction": PaymentInstructionType
    }
  }
}

submitAllowedRepayment

Type:SubmitAllowedRepayment

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

Submit a repayment.

The possible errors that can be raised are:

  • KT-CT-3944: Account repayment does not exist.
  • KT-CT-3945: Unable to allow a repayment to be submitted.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RepaymentInput!)

Input variable needed for submitting an allowed repayment.

Return fields

NameDescription

repaymentId (ID)

The repayment ID.

repaymentStatus (RepaymentRequestStatus)

The current status of the repayment request.

Mutation

mutation SubmitAllowedRepayment($input: RepaymentInput!) {
  submitAllowedRepayment(input: $input) {
    repaymentId
    repaymentStatus
  }
}

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "submitAllowedRepayment": {
      "repaymentId": "abc123",
      "repaymentStatus": "REQUESTED"
    }
  }
}

submitCustomerFeedback

Type:SubmitCustomerFeedback

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

Submit customer feedback.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CustomerFeedbackInputType!)

Return fields

NameDescription

customerFeedback (CustomerFeedbackType)

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": CustomerFeedbackInputType
}

Response

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

submitRepaymentRequest

Type:SubmitRepaymentRequest

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

Submit a repayment request.

The possible errors that can be raised are:

  • KT-CT-1132: Unauthorized.
  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-3821: Received neither ledger ID nor ledger number.
  • KT-CT-3823: Unauthorized.
  • KT-CT-3926: Unauthorized.
  • KT-CT-3927: Invalid Amount.
  • KT-CT-3928: Idempotency key used for another repayment request.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RequestRepaymentInputType!)

Input fields for requesting a repayment.

Return fields

NameDescription

repaymentRequest (RequestRepaymentOutputType)

The newly created repayment request.

Mutation

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

Variables

{
  "input": RequestRepaymentInputType
}

Response

{
  "data": {
    "submitRepaymentRequest": {
      "repaymentRequest": RequestRepaymentOutputType
    }
  }
}

switchAccountToVariablePaymentSchedule

Type:SwitchAccountToVariablePaymentSchedule

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

Switch account to variable payment schedule. Current schedule type will be preserved.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-3921: Account not found.
  • KT-CT-3922: Ledger not found for the account.
  • KT-CT-3947: An unexpected error occurred.
  • KT-CT-3984: Could not delete conflicting future payment schedule.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SwitchAccountToVariablePaymentScheduleInput!)

Input fields for switching to a variable payment schedule.

Return fields

NameDescription

schedule (PaymentScheduleType!)

New payment schedule.

Mutation

mutation SwitchAccountToVariablePaymentSchedule($input: SwitchAccountToVariablePaymentScheduleInput!) {
  switchAccountToVariablePaymentSchedule(input: $input) {
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": SwitchAccountToVariablePaymentScheduleInput
}

Response

{
  "data": {
    "switchAccountToVariablePaymentSchedule": {
      "schedule": PaymentScheduleType
    }
  }
}

terminateAgreement

Type:TerminateAgreement

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

Terminate an agreement.

The possible errors that can be raised are:

  • KT-CT-1501: Agreement not found.
  • KT-CT-1513: Unable to terminate agreement.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TerminateAgreementInput!)

Input for terminating an agreement.

Return fields

NameDescription

agreement (CommonAgreementType)

The created agreement.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

mutation TerminateAgreement($input: TerminateAgreementInput!) {
  terminateAgreement(input: $input) {
    agreement {
      ...CommonAgreementTypeFragment
    }
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": TerminateAgreementInput
}

Response

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

terminateContract

Type:TerminateContractOutput!

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

Terminate an existing contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10007: Unable to terminate contract.
  • KT-CT-10008: The contract is currently undergoing an active journey.
  • KT-CT-10013: Requested termination date is invalid.
  • KT-CT-10044: Termination date must be after the contract start date.
  • KT-CT-10022: Contract already terminated.
  • KT-CT-10023: Contract is already revoked.
  • KT-CT-10024: Contract already expired.
  • KT-CT-10025: Contract has not started yet.
  • KT-CT-10037: Contract notes feature is disabled.
  • KT-CT-10038: Contract note reason not found.
  • KT-CT-10041: Contract is already rescinded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TerminateContractInput!)

Return fields

NameDescription

Mutation

mutation TerminateContract($input: TerminateContractInput!) {
  terminateContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": TerminateContractInput
}

Response

{
  "data": {
    "terminateContract": {
      "contract": Contract
    }
  }
}

terminateCreditTransferPermission

Type:TerminateCreditTransferPermission

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

Terminate a credit transfer permission.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (TerminateCreditTransferPermissionInput!)

Input fields for terminating a credit transfer permission.

Return fields

NameDescription

validTo (DateTime)

Datetime when the credit transfer permission ends.

Mutation

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

Variables

{
  "input": TerminateCreditTransferPermissionInput
}

Response

{
  "data": {
    "terminateCreditTransferPermission": {
      "validTo": "2020-01-01T00:00:00.000Z"
    }
  }
}

transferLeadOpportunities

Type:TransferLeadOpportunities

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

Transfer opportunities across leads.

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TransferLeadOpportunitiesInput!)

Input for transfer opportunities across leads.

Return fields

NameDescription

opportunitiesTransferred (Int)

Number of opportunities transferred.

Mutation

mutation TransferLeadOpportunities($input: TransferLeadOpportunitiesInput!) {
  transferLeadOpportunities(input: $input) {
    opportunitiesTransferred
  }
}

Variables

{
  "input": TransferLeadOpportunitiesInput
}

Response

{
  "data": {
    "transferLeadOpportunities": {
      "opportunitiesTransferred": 1
    }
  }
}

transferLedgerBalance

Type:TransferLedgerBalance

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

  • KT-CT-3822: Unauthorized.
  • KT-CT-3823: Unauthorized.
  • KT-CT-9701: Balance transfer to same account is not allowed.
  • KT-CT-9702: Balance transfer is not support for debit account with Zero balance.
  • KT-CT-9703: Balance transfer is not supported for debit account.
  • KT-CT-9704: Balance transfer amount should be non-zero.
  • 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

NameDescription

input (TransferLedgerBalanceInputType!)

Input fields for processing an account balance transfer.

Return fields

NameDescription

balanceTransfer (AccountBalanceTransferType)

Balance transfer details.

Mutation

mutation TransferLedgerBalance($input: TransferLedgerBalanceInputType!) {
  transferLedgerBalance(input: $input) {
    balanceTransfer {
      ...AccountBalanceTransferTypeFragment
    }
  }
}

Variables

{
  "input": TransferLedgerBalanceInputType
}

Response

{
  "data": {
    "transferLedgerBalance": {
      "balanceTransfer": AccountBalanceTransferType
    }
  }
}

transferLoyaltyPointsBetweenUsers

Type:TransferLoyaltyPointsBetweenUsers

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

Transfer Loyalty Point from one account user to another.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (TransferLoyaltyPointsBetweenUsersInput!)

Input fields for transferring Loyalty Points.

Return fields

NameDescription

pointsTransferred (Int)

The number of loyalty points that were transferred.

Mutation

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

Variables

{
  "input": TransferLoyaltyPointsBetweenUsersInput
}

Response

{
  "data": {
    "transferLoyaltyPointsBetweenUsers": {
      "pointsTransferred": 1
    }
  }
}

triggerC4Request

Type:TriggerC4Request

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

Trigger a C4 request to be sent to the market gateway.

The possible errors that can be raised are:

  • KT-CT-13802: Meter data issue not found.
  • KT-AU-5613: Cannot find meter point with the provided ID.
  • KT-AU-13814: Invalid C4 request parameters.
  • KT-AU-13815: Unable to send C4 request.
  • KT-AU-13816: C4 request already in progress.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TriggerC4RequestInputType!)

Input data for triggering a C4 request.

Return fields

NameDescription

result (TriggerC4RequestOutputType)

The result of triggering the C4 request.

Mutation

mutation TriggerC4Request($input: TriggerC4RequestInputType!) {
  triggerC4Request(input: $input) {
    result {
      ...TriggerC4RequestOutputTypeFragment
    }
  }
}

Variables

{
  "input": TriggerC4RequestInputType
}

Response

{
  "data": {
    "triggerC4Request": {
      "result": TriggerC4RequestOutputType
    }
  }
}

triggerCollectionProcessMessage

Type:TriggerCollectionProcessMessage

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

Trigger a collection process message with safety checks.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TriggerCollectionProcessMessageInput!)

Input for sending a collection process communication.

Return fields

NameDescription

triggerResult (TriggerCollectionProcessMessageOutput)

Details of the triggered communication.

Mutation

mutation TriggerCollectionProcessMessage($input: TriggerCollectionProcessMessageInput!) {
  triggerCollectionProcessMessage(input: $input) {
    triggerResult {
      ...TriggerCollectionProcessMessageOutputFragment
    }
  }
}

Variables

{
  "input": TriggerCollectionProcessMessageInput
}

Response

{
  "data": {
    "triggerCollectionProcessMessage": {
      "triggerResult": TriggerCollectionProcessMessageOutput
    }
  }
}

triggerElectricityHouseMoveOut

Type:TriggerElectricityHouseMoveOut

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

Trigger the electricity house move out process for a related account asynchronously. This creates a workflow instance with step instances executed as tasks; use the workflow ID in the response to track progress.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (TriggerElectricityHouseMoveOutInput!)

The input required to trigger the electricity house move out process.

Return fields

NameDescription

workflow (WorkflowType)

The workflow information which can be used to track the async processing progress.

error (TriggerElectricityHouseMoveErrorUnion)

The error encountered when trying to trigger the electricity house move out process, if any.

Mutation

mutation TriggerElectricityHouseMoveOut($input: TriggerElectricityHouseMoveOutInput!) {
  triggerElectricityHouseMoveOut(input: $input) {
    workflow {
      ...WorkflowTypeFragment
    }
    error {
      ... on UnableToDeterminePhoneContactDetailsErrorType {
        ...UnableToDeterminePhoneContactDetailsErrorTypeFragment
      }
      ... on CouldNotStartWorkflowErrorType {
        ...CouldNotStartWorkflowErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": TriggerElectricityHouseMoveOutInput
}

Response

{
  "data": {
    "triggerElectricityHouseMoveOut": {
      "workflow": WorkflowType,
      "error": UnableToDeterminePhoneContactDetailsErrorType
    }
  }
}

triggerGasHouseMoveOut

Type:TriggerGasHouseMoveOut

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

Trigger the gas house move out process for a related account, asynchronously.

It won't return the occupier account immediately, instead, it will create a workflow instance linking to a few step instances. The steps will be executed as tasks and clients can use the workflow id in the response to track the progress.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (TriggerGasHouseMoveOutInput!)

Return fields

NameDescription

workflow (WorkflowType)

The workflow information which can be used to track the async processing progress.

error (TriggerGasHouseMoveErrorUnion)

Mutation

mutation TriggerGasHouseMoveOut($input: TriggerGasHouseMoveOutInput!) {
  triggerGasHouseMoveOut(input: $input) {
    workflow {
      ...WorkflowTypeFragment
    }
    error {
      ... on CouldNotStartWorkflowErrorType {
        ...CouldNotStartWorkflowErrorTypeFragment
      }
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on ValidationErrorType {
        ...ValidationErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": TriggerGasHouseMoveOutInput
}

Response

{
  "data": {
    "triggerGasHouseMoveOut": {
      "workflow": WorkflowType,
      "error": CouldNotStartWorkflowErrorType
    }
  }
}

triggerPmdRequest

Type:TriggerPmdRequest

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

Trigger a PMD (Provide Meter Data) request to be sent to the market gateway.

The possible errors that can be raised are:

  • KT-CT-13802: Meter data issue not found.
  • KT-AU-13821: PMD request precondition not met.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TriggerPmdRequestInputType!)

Input data for triggering a PMD request.

Return fields

NameDescription

result (TriggerPmdRequestOutputType)

The result of triggering the PMD request.

Mutation

mutation TriggerPmdRequest($input: TriggerPmdRequestInputType!) {
  triggerPmdRequest(input: $input) {
    result {
      ...TriggerPmdRequestOutputTypeFragment
    }
  }
}

Variables

{
  "input": TriggerPmdRequestInputType
}

Response

{
  "data": {
    "triggerPmdRequest": {
      "result": TriggerPmdRequestOutputType
    }
  }
}

triggerStandalonePaymentRequest

Type:TriggerStandalonePaymentRequest

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

Trigger standalone payment request.

The possible errors that can be raised are:

  • KT-CT-3998: Unauthorized.
  • KT-CT-3999: Multiple recipient input.
  • KT-CT-39100: Unable to find manual standalone method configuration to use.
  • KT-CT-5463: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TriggerStandalonePaymentRequestInput!)

Input fields for triggering standalone payment request.

Return fields

NameDescription

paymentNotification (PaymentNotification)

Payment notification trigerred for standalone payment request.

Mutation

mutation TriggerStandalonePaymentRequest($input: TriggerStandalonePaymentRequestInput!) {
  triggerStandalonePaymentRequest(input: $input) {
    paymentNotification {
      ...PaymentNotificationFragment
    }
  }
}

Variables

{
  "input": TriggerStandalonePaymentRequestInput
}

Response

{
  "data": {
    "triggerStandalonePaymentRequest": {
      "paymentNotification": PaymentNotification
    }
  }
}

triggerVmdRequest

Type:TriggerVmdRequest

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

Trigger a VMD (Verify Meter Data) request to be sent to the market gateway.

The possible errors that can be raised are:

  • KT-CT-13802: Meter data issue not found.
  • KT-AU-13817: Invalid VMD request parameters.
  • KT-AU-13818: Unable to send VMD request.
  • KT-AU-13819: VMD request precondition not met.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (TriggerVmdRequestInputType!)

Input data for triggering a VMD request.

Return fields

NameDescription

result (TriggerVmdRequestOutputType)

The result of triggering the VMD request.

Mutation

mutation TriggerVmdRequest($input: TriggerVmdRequestInputType!) {
  triggerVmdRequest(input: $input) {
    result {
      ...TriggerVmdRequestOutputTypeFragment
    }
  }
}

Variables

{
  "input": TriggerVmdRequestInputType
}

Response

{
  "data": {
    "triggerVmdRequest": {
      "result": TriggerVmdRequestOutputType
    }
  }
}

unenrollAccountFromLoyaltyProgram

Type:UnenrollAccountFromLoyaltyProgram

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

Unenroll an account from the loyalty program.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-9220: Ineligible loyalty points unenrollment.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UnenrollAccountFromLoyaltyProgramInput!)

The account number to unenroll from the loyalty program.

Return fields

NameDescription

outcome (UnenrollAccountFromLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

Mutation

mutation UnenrollAccountFromLoyaltyProgram($input: UnenrollAccountFromLoyaltyProgramInput!) {
  unenrollAccountFromLoyaltyProgram(input: $input) {
    outcome {
      ...UnenrollAccountFromLoyaltyProgramOutcomeFragment
    }
  }
}

Variables

{
  "input": UnenrollAccountFromLoyaltyProgramInput
}

Response

{
  "data": {
    "unenrollAccountFromLoyaltyProgram": {
      "outcome": UnenrollAccountFromLoyaltyProgramOutcome
    }
  }
}

unlinkUserFromLine

Type:UnlinkUserFromLineResponse!

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

Unlink an AccountUser from a LINE account.

The possible errors that can be raised are:

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

Return fields

NameDescription

Mutation

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

Response

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

updateAccountAddress

Type:UpdateAccountAddressMutation

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

Update address in legacy format for the specified account.

The possible errors that can be raised are:

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

Arguments

NameDescription

accounts ([String])

The list of account numbers on which the address is to be updated.

address (UpdateAddressInput!)

New billing address for user accounts.

userId (String)

The user for whom to perform the update. This is only needed when using an Organisation role.

Return fields

NameDescription

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

Mutation

mutation UpdateAccountAddress(
  $accounts: [String],
  $address: UpdateAddressInput!,
  $userId: String
) {
  updateAccountAddress(
    accounts: $accounts,
    address: $address,
    userId: $userId
  ) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "accounts": ["abc123"],
  "address": UpdateAddressInput,
  "userId": "abc123"
}

Response

{
  "data": {
    "updateAccountAddress": {
      "viewer": AccountUserType
    }
  }
}

updateAccountBillingAddress

Type:UpdateAccountBillingAddress

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

Update the account billing address.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountBillingAddressInput!)

Input variables needed for updating an account billing address.

Return fields

NameDescription

account (AccountType)

The updated account.

Mutation

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

Variables

{
  "input": AccountBillingAddressInput
}

Response

{
  "data": {
    "updateAccountBillingAddress": {
      "account": AccountType
    }
  }
}

updateAccountBillingEmail

Type:UpdateAccountBillingEmail

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

Update the billing email for the given account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAccountBillingEmailInput!)

Input fields for updating billing email for an account.

Return fields

NameDescription

account (AccountInterface)

Account that was changed.

Mutation

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

Variables

{
  "input": UpdateAccountBillingEmailInput
}

Response

{
  "data": {
    "updateAccountBillingEmail": {
      "account": AccountInterface
    }
  }
}

updateAccountBillingName

Type:UpdateAccountBillingName

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

Update the billing name and billing sub name for the input account number. Fields that are omitted, null, or empty are left unchanged; this mutation cannot clear a name.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAccountBillingNameInput!)

Input fields for updating the billing name for an account.

Return fields

NameDescription

account (AccountInterface)

Account that was changed.

Mutation

mutation UpdateAccountBillingName($input: UpdateAccountBillingNameInput!) {
  updateAccountBillingName(input: $input) {
    account {
      ...AccountInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateAccountBillingNameInput
}

Response

{
  "data": {
    "updateAccountBillingName": {
      "account": AccountInterface
    }
  }
}

updateAccountConsents

Type:UpdateAccountConsents

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

Update the consents for an account using the consent management system.

The possible errors that can be raised are:

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

Arguments

NameDescription

accountNumber (String!)

The account number to update consents for.

consents ([ConsentInput]!)

Consents to update for account.

Return fields

NameDescription

consents ([ConsentType!]!)

Consents linked to this account.

Mutation

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

Variables

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

Response

{
  "data": {
    "updateAccountConsents": {
      "consents": ConsentType
    }
  }
}

updateAccountElectricityProduct

Type:UpdateAccountElectricityProduct

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

This mutation is used for processing an electricity product switch. This is when an existing user opts in for a different product during the tenure of their agreement.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAccountElectricityProductInput!)

Input fields for switching account electricity product.

Return fields

NameDescription

account (AccountType)

error (ElectricityProductSwitchingErrorUnion)

Mutation

mutation UpdateAccountElectricityProduct($input: UpdateAccountElectricityProductInput!) {
  updateAccountElectricityProduct(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on UnsupportedBrandErrorType {
        ...UnsupportedBrandErrorTypeFragment
      }
      ... on MeterPointIdentifierInvalidErrorType {
        ...MeterPointIdentifierInvalidErrorTypeFragment
      }
      ... on AsOfDateInvalidErrorType {
        ...AsOfDateInvalidErrorTypeFragment
      }
      ... on AccountUserIsNotEligibleErrorType {
        ...AccountUserIsNotEligibleErrorTypeFragment
      }
      ... on ProductCodeNotFoundErrorType {
        ...ProductCodeNotFoundErrorTypeFragment
      }
      ... on FailedToRetrieveQuoteErrorType {
        ...FailedToRetrieveQuoteErrorTypeFragment
      }
      ... on NoMatchingPropertyFromNMIErrorType {
        ...NoMatchingPropertyFromNMIErrorTypeFragment
      }
      ... on NoMatchingAccountFoundErrorType {
        ...NoMatchingAccountFoundErrorTypeFragment
      }
      ... on CanNotCreateAgreementErrorType {
        ...CanNotCreateAgreementErrorTypeFragment
      }
      ... on FailedToSwitchProductForAccountErrorType {
        ...FailedToSwitchProductForAccountErrorTypeFragment
      }
      ... on CannotProductSwitchOnUnrelatedAccountError {
        ...CannotProductSwitchOnUnrelatedAccountErrorFragment
      }
      ... on CannotProductSwitchWithoutLoyaltyCardError {
        ...CannotProductSwitchWithoutLoyaltyCardErrorFragment
      }
      ... on InvalidLoyaltyCardNumberError {
        ...InvalidLoyaltyCardNumberErrorFragment
      }
      ... on AccountCannotSelectProductErrorType {
        ...AccountCannotSelectProductErrorTypeFragment
      }
      ... on AccountDoesNotHaveEmailErrorType {
        ...AccountDoesNotHaveEmailErrorTypeFragment
      }
      ... on InvalidAddonErrorType {
        ...InvalidAddonErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": UpdateAccountElectricityProductInput
}

Response

{
  "data": {
    "updateAccountElectricityProduct": {
      "account": AccountType,
      "error": UnsupportedBrandErrorType
    }
  }
}

updateAccountGasProduct

Type:UpdateAccountGasProduct

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

This mutation is used for processing a gas product switch. This is when an existing user opts in for a different product during the tenure of their agreement.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAccountGasProductInput!)

Input fields for switching account gas product.

Return fields

NameDescription

account (AccountType)

error (GasProductSwitchingErrorUnion)

Mutation

mutation UpdateAccountGasProduct($input: UpdateAccountGasProductInput!) {
  updateAccountGasProduct(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on UnsupportedBrandErrorType {
        ...UnsupportedBrandErrorTypeFragment
      }
      ... on UserNotFound {
        ...UserNotFoundFragment
      }
      ... on PropertyNotFound {
        ...PropertyNotFoundFragment
      }
      ... on MissingActiveAgreement {
        ...MissingActiveAgreementFragment
      }
      ... on AsOfDateInvalidErrorType {
        ...AsOfDateInvalidErrorTypeFragment
      }
      ... on AccountUserIsNotEligibleErrorType {
        ...AccountUserIsNotEligibleErrorTypeFragment
      }
      ... on NoMatchingAccountFoundErrorType {
        ...NoMatchingAccountFoundErrorTypeFragment
      }
      ... on MissingActiveGasSupplyPoint {
        ...MissingActiveGasSupplyPointFragment
      }
      ... on WrongMarket {
        ...WrongMarketFragment
      }
      ... on QuotingNoSupplyPointsFoundOnProperty {
        ...QuotingNoSupplyPointsFoundOnPropertyFragment
      }
      ... on QuotingTermsAndConditionsCanNotBeFound {
        ...QuotingTermsAndConditionsCanNotBeFoundFragment
      }
      ... on QuotingNoSuitableProductsFound {
        ...QuotingNoSuitableProductsFoundFragment
      }
      ... on QuotingUnsupportedMarket {
        ...QuotingUnsupportedMarketFragment
      }
      ... on QuotingEmbeddedProperty {
        ...QuotingEmbeddedPropertyFragment
      }
      ... on ProductCodeNotInQuote {
        ...ProductCodeNotInQuoteFragment
      }
      ... on CannotProductSwitchOnUnrelatedAccountError {
        ...CannotProductSwitchOnUnrelatedAccountErrorFragment
      }
      ... on CannotProductSwitchWithoutLoyaltyCardError {
        ...CannotProductSwitchWithoutLoyaltyCardErrorFragment
      }
      ... on InvalidLoyaltyCardNumberError {
        ...InvalidLoyaltyCardNumberErrorFragment
      }
      ... on AccountCannotSelectProductErrorType {
        ...AccountCannotSelectProductErrorTypeFragment
      }
      ... on InvalidAddonErrorType {
        ...InvalidAddonErrorTypeFragment
      }
      ... on CanNotCreateAgreementErrorType {
        ...CanNotCreateAgreementErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": UpdateAccountGasProductInput
}

Response

{
  "data": {
    "updateAccountGasProduct": {
      "account": AccountType,
      "error": UnsupportedBrandErrorType
    }
  }
}

updateAccountReference

Type:UpdateAccountReference

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

Update a reference for a particular account and namespace.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

NameDescription

accountReference (AccountReferenceType)

Mutation

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

Variables

{
  "input": AccountReferenceInput
}

Response

{
  "data": {
    "updateAccountReference": {
      "accountReference": AccountReferenceType
    }
  }
}

updateAccountReferralStatus

Type:UpdateAccountReferralStatus

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

Update the status of an AccountReferral.

Status transitions can only move forward: - Pending → Paid (allowed) - Pending → Cancelled (allowed) - Paid → any (not allowed) - Cancelled → any (not allowed)

The possible errors that can be raised are:

  • KT-CT-6712: Invalid reference.
  • KT-CT-6732: Invalid referral status transition.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateAccountReferralStatusInput!)

Input fields for updating the status of an account referral.

Return fields

NameDescription

accountReferral (ReferralType)

The updated account referral instance.

Mutation

mutation UpdateAccountReferralStatus($input: UpdateAccountReferralStatusInput!) {
  updateAccountReferralStatus(input: $input) {
    accountReferral {
      ...ReferralTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAccountReferralStatusInput
}

Response

{
  "data": {
    "updateAccountReferralStatus": {
      "accountReferral": ReferralType
    }
  }
}

updateAccountRichAddress

Type:UpdateAccountRichAddressMutation

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

Update address for the specified account.

The possible errors that can be raised are:

  • KT-CT-4412: The supplied address is not valid.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

accounts ([String])

The list of account numbers on which the address is to be updated.

address (RichAddressInput!)

New billing address for user accounts.

userId (String)

The user for whom to perform the update. This is only needed when using an Organisation role.

Return fields

NameDescription

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

Mutation

mutation UpdateAccountRichAddress(
  $accounts: [String],
  $address: RichAddressInput!,
  $userId: String
) {
  updateAccountRichAddress(
    accounts: $accounts,
    address: $address,
    userId: $userId
  ) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "accounts": ["abc123"],
  "address": RichAddressInput,
  "userId": "abc123"
}

Response

{
  "data": {
    "updateAccountRichAddress": {
      "viewer": AccountUserType
    }
  }
}

updateAccountUserConsents

Type:UpdateAccountUserConsents

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

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

The possible errors that can be raised are:

  • KT-CT-9014: Duplicate consent.
  • KT-CT-9016: Consent management not enabled.
  • KT-CT-9017: Consent type not found.
  • KT-CT-1111: Unauthorized.
  • KT-CT-5421: Account user not found.
  • KT-CT-5422: Invalid data.
  • KT-CT-1605: Invalid input.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

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

NameDescription

accountUserConsents (AccountUserConsents)

All the consents for an account user.

Mutation

mutation UpdateAccountUserConsents(
  $consents: [ConsentTypeInput],
  $userNumber: String
) {
  updateAccountUserConsents(
    consents: $consents,
    userNumber: $userNumber
  ) {
    accountUserConsents {
      ...AccountUserConsentsFragment
    }
  }
}

Variables

{
  "consents": ConsentTypeInput,
  "userNumber": "abc123"
}

Response

{
  "data": {
    "updateAccountUserConsents": {
      "accountUserConsents": AccountUserConsents
    }
  }
}

updateActivePurchase

Type:UpdateActivePurchase

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

Update an active purchase.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdatePurchaseInput!)

Input fields for updating an active purchase.

Return fields

NameDescription

goodsPurchase (GoodsPurchase)

Goods purchase updated.

Mutation

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

Variables

{
  "input": UpdatePurchaseInput
}

Response

{
  "data": {
    "updateActivePurchase": {
      "goodsPurchase": GoodsPurchase
    }
  }
}

Type:UpdateAffiliateLink!

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

Update an affiliate link of an existing sales agent.

The possible errors that can be raised are:

  • KT-CT-7711: Invalid data.
  • KT-CT-7713: Invalid data.
  • KT-CT-7714: Invalid data.
  • KT-CT-7715: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateAffiliateLinkInputType!)

Input fields for Updating an existing affiliate link.

Return fields

NameDescription

Mutation

mutation UpdateAffiliateLink($input: UpdateAffiliateLinkInputType!) {
  updateAffiliateLink(input: $input) {
    affiliateLink {
      ...AffiliateLinkTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAffiliateLinkInputType
}

Response

{
  "data": {
    "updateAffiliateLink": {
      "affiliateLink": AffiliateLinkType
    }
  }
}

updateAffiliateOrganisation

Type:UpdateAffiliateOrganisation!

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

Update an existing affiliate organisation.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAffiliateOrganisationInputType!)

Input fields for Updating an existing affiliate organisation.

Return fields

NameDescription

Mutation

mutation UpdateAffiliateOrganisation($input: UpdateAffiliateOrganisationInputType!) {
  updateAffiliateOrganisation(input: $input) {
    affiliateOrganisation {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAffiliateOrganisationInputType
}

Response

{
  "data": {
    "updateAffiliateOrganisation": {
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

updateAgentAuxiliaryStatus

Type:UpdateAgentAuxiliaryStatus

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

The possible errors that can be raised are:

  • KT-CT-7813: Support user not found with that username.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateAgentAuxiliaryStatusInput!)

The input data for this mutation.

Return fields

NameDescription

success (Boolean)

Whether the auxiliary status was successfully updated.

Mutation

mutation UpdateAgentAuxiliaryStatus($input: UpdateAgentAuxiliaryStatusInput!) {
  updateAgentAuxiliaryStatus(input: $input) {
    success
  }
}

Variables

{
  "input": UpdateAgentAuxiliaryStatusInput
}

Response

{
  "data": {
    "updateAgentAuxiliaryStatus": {
      "success": true
    }
  }
}

updateAgreementPeriod

Type:UpdateAgreementPeriod

URL:https://api.redenergy-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 validto date must be later than validfrom 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

NameDescription

input (UpdateAgreementPeriodInput!)

Input for updating the agreement period.

Return fields

NameDescription

account (AccountType)

Account responsible for the update agreement.

Mutation

mutation UpdateAgreementPeriod($input: UpdateAgreementPeriodInput!) {
  updateAgreementPeriod(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementPeriodInput
}

Response

{
  "data": {
    "updateAgreementPeriod": {
      "account": AccountType
    }
  }
}

updateAgreementRescission

Type:UpdateAgreementRescission

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

Update an agreement rescission.

This mutation allows updating the status and tracking information for an agreement rescission process. Updates are not allowed if the rescission has already been completed.

The possible errors that can be raised are:

  • KT-CT-14101: Agreement rescission not found.
  • KT-CT-14102: Cannot update completed agreement rescission.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateAgreementRescissionInput!)

Input fields for updating an agreement rescission.

Return fields

NameDescription

agreementRescission (AgreementRescissionType)

The updated agreement rescission instance.

Mutation

mutation UpdateAgreementRescission($input: UpdateAgreementRescissionInput!) {
  updateAgreementRescission(input: $input) {
    agreementRescission {
      ...AgreementRescissionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementRescissionInput
}

Response

{
  "data": {
    "updateAgreementRescission": {
      "agreementRescission": AgreementRescissionType
    }
  }
}

updateAgreementRollover

Type:UpdateAgreementRollover

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

Update an agreement rollover.

The possible errors that can be raised are:

  • KT-CT-4910: No product exists with the given input.
  • KT-CT-13705: Agreement rollover not found.
  • KT-CT-13706: Agreement rollover has an invalid status for this operation.
  • KT-CT-13707: Agreement rollover has an invalid type for this operation.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateAgreementRolloverInput!)

Input for updating an agreement rollover.

Return fields

NameDescription

agreementRollover (AgreementRolloverType)

The update agreement rollover.

Mutation

mutation UpdateAgreementRollover($input: UpdateAgreementRolloverInput!) {
  updateAgreementRollover(input: $input) {
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementRolloverInput
}

Response

{
  "data": {
    "updateAgreementRollover": {
      "agreementRollover": AgreementRolloverType
    }
  }
}

updateApiException

Type:UpdateAPIException

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

NameDescription

input (UpdateAPIExceptionInput!)

Input fields for updating an API exception.

Return fields

NameDescription

apiException (APIExceptionType)

The updated APIException.

Mutation

mutation UpdateApiException($input: UpdateAPIExceptionInput!) {
  updateApiException(input: $input) {
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAPIExceptionInput
}

Response

{
  "data": {
    "updateApiException": {
      "apiException": APIExceptionType
    }
  }
}

updateApiExceptionNote

Type:UpdateAPIExceptionNote

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

Mutation to update an existing APIExceptionNote instance.

The possible errors that can be raised are:

  • KT-CT-7807: Received an invalid apiExceptionNoteId.
  • KT-CT-7808: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

NameDescription

apiException (APIExceptionType)

The updates APIExceptionNote.

Mutation

mutation UpdateApiExceptionNote($input: UpdateAPIExceptionNoteInput!) {
  updateApiExceptionNote(input: $input) {
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAPIExceptionNoteInput
}

Response

{
  "data": {
    "updateApiExceptionNote": {
      "apiException": APIExceptionType
    }
  }
}

updateAutoTopUpAmount

Type:UpdateAutoTopUpAmount

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

Change the auto top up amount for the payment schedule.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAutoTopUpAmountInput!)

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

Return fields

NameDescription

schedule (PaymentScheduleType)

The new schedule created.

Mutation

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

Variables

{
  "input": UpdateAutoTopUpAmountInput
}

Response

{
  "data": {
    "updateAutoTopUpAmount": {
      "schedule": PaymentScheduleType
    }
  }
}

updateCampaignAccountExpiryDate

Type:UpdateCampaignAccountExpiryDate

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4123: Unauthorized.
  • KT-CT-7428: Failed to update campaign account.
  • KT-CT-7429: No active campaign account found for the given account and campaign.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateCampaignAccountExpiryDateInput!)

Input variables needed for updating a campaign account expiry date.

Return fields

NameDescription

campaignAccount (AccountCampaignType)

The campaign account with the updated expiry date.

Mutation

mutation UpdateCampaignAccountExpiryDate($input: UpdateCampaignAccountExpiryDateInput!) {
  updateCampaignAccountExpiryDate(input: $input) {
    campaignAccount {
      ...AccountCampaignTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCampaignAccountExpiryDateInput
}

Response

{
  "data": {
    "updateCampaignAccountExpiryDate": {
      "campaignAccount": AccountCampaignType
    }
  }
}

updateCollectionProcessRecordLatestStep

Type:UpdateCollectionProcessRecordLatestStep

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

Update the latest step of a Collection Process Record.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateCollectionProcessRecordLatestStepInputType!)

Input variables needed for updating the latest step.

Return fields

NameDescription

updatedCollectionProcessRecord (UpdateCollectionProcessRecordLatestStepOutputType)

The updated collection process record.

Mutation

mutation UpdateCollectionProcessRecordLatestStep($input: UpdateCollectionProcessRecordLatestStepInputType!) {
  updateCollectionProcessRecordLatestStep(input: $input) {
    updatedCollectionProcessRecord {
      ...UpdateCollectionProcessRecordLatestStepOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordLatestStepInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordLatestStep": {
      "updatedCollectionProcessRecord": UpdateCollectionProcessRecordLatestStepOutputType
    }
  }
}

updateCollectionProcessRecordToActive

Type:UpdateCollectionProcessRecordToActive

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

Update the Collection Process Record from raised status to active.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11202: No External reference provided.
  • KT-CT-11207: Unsupported external source for collection process.
  • KT-CT-11218: External reference cannot be updated once it has been set.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateCollectionProcessRecordToActiveInputType!)

Input variables needed for making a collection process record active.

Return fields

NameDescription

collectionProcessActivated (UpdateCollectionProcessRecordToActiveOutputType)

Whether the collection process was successfully updated.

Mutation

mutation UpdateCollectionProcessRecordToActive($input: UpdateCollectionProcessRecordToActiveInputType!) {
  updateCollectionProcessRecordToActive(input: $input) {
    collectionProcessActivated {
      ...UpdateCollectionProcessRecordToActiveOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordToActiveInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordToActive": {
      "collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
    }
  }
}

updateCollectionProcessRecordToComplete

Type:UpdateCollectionProcessRecordToComplete

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

Update the Collection Process Record from raised status to complete.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11203: No Completion reason provided.
  • KT-CT-11204: No Completion details provided.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateCollectionProcessRecordToCompleteInputType!)

Input variables needed for making a collection process record complete.

Return fields

NameDescription

collectionProcessComplete (UpdateCollectionProcessRecordToCompleteOutputType)

Whether the collection process was successfully updated.

Mutation

mutation UpdateCollectionProcessRecordToComplete($input: UpdateCollectionProcessRecordToCompleteInputType!) {
  updateCollectionProcessRecordToComplete(input: $input) {
    collectionProcessComplete {
      ...UpdateCollectionProcessRecordToCompleteOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordToCompleteInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordToComplete": {
      "collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
    }
  }
}

updateCommsDeliveryPreference

Type:UpdateCommsDeliveryPreference

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

Update the comms delivery preference for the given account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account.

Return fields

NameDescription

account (AccountInterface)

Mutation

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

Variables

{
  "input": UpdateCommsDeliveryPreferenceInput
}

Response

{
  "data": {
    "updateCommsDeliveryPreference": {
      "account": AccountInterface
    }
  }
}

updateCommsPreferences

Type:UpdateAccountUserCommsPreferencesMutationPayload

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAccountUserCommsPreferencesMutationInput!)

Return fields

NameDescription

isOptedInToClientMessages (Boolean)

isOptedInToOfferMessages (Boolean)

isOptedInToRecommendedMessages (Boolean)

isOptedInToUpdateMessages (Boolean)

isOptedInToThirdPartyMessages (Boolean)

isOptedInMeterReadingConfirmations (Boolean)

isOptedInToSmsMessages (Boolean)

isUsingInvertedEmailColours (Boolean)

fontSizeMultiplier (Float)

emailFormat (String)

preferredHoldMusic (String)

errors ([ErrorType])

commsPreferences (AccountUserCommsPreferences)

clientMutationId (String)

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": 1.0,
      "emailFormat": "abc123",
      "preferredHoldMusic": "abc123",
      "errors": [ErrorType],
      "commsPreferences": AccountUserCommsPreferences,
      "clientMutationId": "abc123"
    }
  }
}

updateConcession

Type:UpdateConcession

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateConcessionInput!)

Return fields

NameDescription

concession (ConcessionType)

Mutation

mutation UpdateConcession($input: UpdateConcessionInput!) {
  updateConcession(input: $input) {
    concession {
      ...ConcessionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateConcessionInput
}

Response

{
  "data": {
    "updateConcession": {
      "concession": ConcessionType
    }
  }
}

updateDcaProceeding

Type:UpdateDCAProceeding

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

NameDescription

input (UpdateDCAProceedingInputType!)

Return fields

NameDescription

dcaProceedingUpdateStatus (DCAProceedingUpdateStatus)

Whether the update has been applied.

Mutation

mutation UpdateDcaProceeding($input: UpdateDCAProceedingInputType!) {
  updateDcaProceeding(input: $input) {
    dcaProceedingUpdateStatus {
      ...DCAProceedingUpdateStatusFragment
    }
  }
}

Variables

{
  "input": UpdateDCAProceedingInputType
}

Response

{
  "data": {
    "updateDcaProceeding": {
      "dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
    }
  }
}

updateDocumentAccessibilityPreference

Type:UpdateDocumentAccessibilityPreference!

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

Update the document accessibility preference for the given account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateDocumentAccessibilityPreferenceInput!)

Input fields for updating document accessibility preference for an account.

Return fields

NameDescription

Mutation

mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
  updateDocumentAccessibilityPreference(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": UpdateDocumentAccessibilityPreferenceInput
}

Response

{
  "data": {
    "updateDocumentAccessibilityPreference": {
      "account": AccountType
    }
  }
}

updateElecMeterPointAccessDetails

Type:UpdateElecMeterPointAccessDetails

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

Mutation to update a meter point's access details.

The possible errors that can be raised are:

  • KT-CT-6420: Unauthorized.
  • KT-CT-4011: No meter points found with the given ID.
  • KT-AU-7810: Missing mutation inputs.
  • KT-AU-5610: Max number of meter point hazards exceeded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateElecMeterPointAccessDetailsInputType)

Return fields

NameDescription

meterPoint (MeterPointType)

The target meter point.

Mutation

mutation UpdateElecMeterPointAccessDetails($input: UpdateElecMeterPointAccessDetailsInputType) {
  updateElecMeterPointAccessDetails(input: $input) {
    meterPoint {
      ...MeterPointTypeFragment
    }
  }
}

Variables

{
  "input": UpdateElecMeterPointAccessDetailsInputType
}

Response

{
  "data": {
    "updateElecMeterPointAccessDetails": {
      "meterPoint": MeterPointType
    }
  }
}

updateExportPaymentMethod

Type:UpdateExportPaymentMethod

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

Update the method of payment for a solar export repayment. Allows customers to add or change their payment method for receiving solar export repayments.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateExportPaymentMethodInput!)

Input fields for updating the method of payment for a solar export repayment.

Return fields

NameDescription

exportRepaymentDetails (ExportRepaymentDetailsType)

Updated export repayment details.

Mutation

mutation UpdateExportPaymentMethod($input: UpdateExportPaymentMethodInput!) {
  updateExportPaymentMethod(input: $input) {
    exportRepaymentDetails {
      ...ExportRepaymentDetailsTypeFragment
    }
  }
}

Variables

{
  "input": UpdateExportPaymentMethodInput
}

Response

{
  "data": {
    "updateExportPaymentMethod": {
      "exportRepaymentDetails": ExportRepaymentDetailsType
    }
  }
}

updateHardshipAgreement

Type:UpdateHardshipAgreement

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

Update an existing hardship agreement for an account.

The possible errors that can be raised are:

  • KT-CT-11611: Hardship agreement not found.
  • KT-CT-11612: Overlapping hardship agreement exists.
  • KT-CT-10950: Invalid date range.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (UpdateHardshipAgreementInput!)

Input fields for updating an existing hardship agreement.

Return fields

NameDescription

updatedHardshipAgreement (HardshipAgreementType)

The updated hardship agreement.

Mutation

mutation UpdateHardshipAgreement($input: UpdateHardshipAgreementInput!) {
  updateHardshipAgreement(input: $input) {
    updatedHardshipAgreement {
      ...HardshipAgreementTypeFragment
    }
  }
}

Variables

{
  "input": UpdateHardshipAgreementInput
}

Response

{
  "data": {
    "updateHardshipAgreement": {
      "updatedHardshipAgreement": HardshipAgreementType
    }
  }
}

updateLeadDetails

Type:UpdateLeadDetails

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

Update the details of a lead.

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-8912: Funnel not found.
  • KT-CT-8913: Organisation is not valid to be assigned.
  • KT-CT-8931: Extra detail value is invalid.
  • KT-CT-8935: National ID bad input.
  • KT-CT-8956: Conflicting address inputs.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateLeadDetailsInput!)

Fields for updating a lead's details.

Return fields

NameDescription

updatedLeadData (JSONString)

Arguments passed.

Mutation

mutation UpdateLeadDetails($input: UpdateLeadDetailsInput!) {
  updateLeadDetails(input: $input) {
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadDetailsInput
}

Response

{
  "data": {
    "updateLeadDetails": {
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadStage

Type:UpdateLeadStage

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

Update the stage of a lead.

The possible errors that can be raised are:

  • KT-CT-8907: Lead not found.
  • KT-CT-8914: Stage not found.
  • KT-CT-8915: Stages are not in the same funnel.
  • KT-CT-8916: Current stage mismatch.
  • KT-CT-8917: Stage transition not allowed.
  • KT-CT-8918: Stage precondition not met.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateLeadStageInput!)

Fields for updating a lead's stage.

Return fields

NameDescription

updatedLeadData (JSONString)

Arguments passed.

Mutation

mutation UpdateLeadStage($input: UpdateLeadStageInput!) {
  updateLeadStage(input: $input) {
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadStageInput
}

Response

{
  "data": {
    "updateLeadStage": {
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeaveSupplier

Type:LeaveSupplierUpdated!

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

NameDescription

input (UpdateLeaveSupplierInput!)

Return fields

NameDescription

Mutation

mutation UpdateLeaveSupplier($input: UpdateLeaveSupplierInput!) {
  updateLeaveSupplier(input: $input) {
    message
  }
}

Variables

{
  "input": UpdateLeaveSupplierInput
}

Response

{
  "data": {
    "updateLeaveSupplier": {
      "message": "abc123"
    }
  }
}

updateMessageTags

Type:UpdateMessageTags

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

The possible errors that can be raised are:

  • KT-CT-7611: The message was not found.
  • KT-CT-7614: The Ink tag was not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateMessageTagsInput)

Input for updating the tags of a message.

Return fields

NameDescription

tags ([InkTag!]!)

Confirmed tags.

Mutation

mutation UpdateMessageTags($input: UpdateMessageTagsInput) {
  updateMessageTags(input: $input) {
    tags {
      ...InkTagFragment
    }
  }
}

Variables

{
  "input": UpdateMessageTagsInput
}

Response

{
  "data": {
    "updateMessageTags": {
      "tags": InkTag
    }
  }
}

updateMetadata

Type:UpdateMetadata

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

Update existing metadata on an object.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-CT-4124: Unauthorized.
  • KT-CT-6622: Unauthorized.
  • KT-CT-6637: Unauthorized.
  • KT-CT-8411: Invalid data.
  • KT-CT-4123: Unauthorized.
  • KT-CT-8413: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (MetadataInput!)

Input fields for updating metadata.

Return fields

NameDescription

metadata (Metadata)

Mutation

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

Variables

{
  "input": MetadataInput
}

Response

{
  "data": {
    "updateMetadata": {
      "metadata": Metadata
    }
  }
}

updateNotesOnOpportunity

Type:UpdateNotesOnOpportunity

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

Update the notes of an opportunity.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateNotesOnOpportunityInput!)

Input to update the note on an opportunity.

Return fields

NameDescription

opportunityNumber (String)

The number of the opportunity.

Mutation

mutation UpdateNotesOnOpportunity($input: UpdateNotesOnOpportunityInput!) {
  updateNotesOnOpportunity(input: $input) {
    opportunityNumber
  }
}

Variables

{
  "input": UpdateNotesOnOpportunityInput
}

Response

{
  "data": {
    "updateNotesOnOpportunity": {
      "opportunityNumber": "abc123"
    }
  }
}

updateOfferGroupOnOpportunity

Type:UpdateOfferGroupOnOpportunity

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

Update the offer group of an opportunity.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateOfferGroupOnOpportunityInput!)

Input to update the offer group on an opportunity.

Return fields

NameDescription

opportunityNumber (String)

The number of the opportunity.

Mutation

mutation UpdateOfferGroupOnOpportunity($input: UpdateOfferGroupOnOpportunityInput!) {
  updateOfferGroupOnOpportunity(input: $input) {
    opportunityNumber
  }
}

Variables

{
  "input": UpdateOfferGroupOnOpportunityInput
}

Response

{
  "data": {
    "updateOfferGroupOnOpportunity": {
      "opportunityNumber": "abc123"
    }
  }
}

updateOnSiteJobsRequest

Type:UpdateOnSiteJobsRequest

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

Update an On Site Jobs Request.

The possible errors that can be raised are:

  • KT-CT-13032: Request does not exist.
  • KT-CT-13035: Request is inactive.
  • KT-CT-13038: Invalid request status.
  • KT-CT-13045: Failed to update appointment assets.
  • KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_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

NameDescription

input (OnSiteJobsUpdateRequestInput!)

The input objects required to update a Request.

Return fields

NameDescription

onSiteJobsRequest (OnSiteJobsRequestType)

The updated request.

Mutation

mutation UpdateOnSiteJobsRequest($input: OnSiteJobsUpdateRequestInput!) {
  updateOnSiteJobsRequest(input: $input) {
    onSiteJobsRequest {
      ...OnSiteJobsRequestTypeFragment
    }
  }
}

Variables

{
  "input": OnSiteJobsUpdateRequestInput
}

Response

{
  "data": {
    "updateOnSiteJobsRequest": {
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

updateOpportunityAssignment

Type:UpdateOpportunityAssignment

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

Update assignment fields for an Opportunity.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8903: Unable to update opportunity.
  • KT-CT-8913: Organisation is not valid to be assigned.
  • KT-CT-8946: A team must also be provided when assigning a user.
  • KT-CT-8947: The team you specified was not found.
  • KT-CT-8948: The user you specified was not found.
  • KT-CT-8949: The selected team does not belong to the specified partner.
  • KT-CT-8950: The selected user does not belong to the specified partner.
  • KT-CT-8951: The selected user is not a member of the specified team.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateOpportunityAssignmentInput!)

Input fields for creating an opportunity.

Return fields

NameDescription

updatedOpportunityData (JSONString)

Arguments passed.

Mutation

mutation UpdateOpportunityAssignment($input: UpdateOpportunityAssignmentInput!) {
  updateOpportunityAssignment(input: $input) {
    updatedOpportunityData
  }
}

Variables

{
  "input": UpdateOpportunityAssignmentInput
}

Response

{
  "data": {
    "updateOpportunityAssignment": {
      "updatedOpportunityData": {"key": "value"}
    }
  }
}

updateOpportunityDetails

Type:UpdateOpportunityDetails

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

Update the details of an opportunity.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8930: Unable to parse address.
  • KT-CT-8931: Extra detail value is invalid.
  • KT-CT-8912: Funnel not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateOpportunityDetailsInput!)

Input fields for updating the address of a opportunity.

Return fields

NameDescription

updatedData (JSONString)

Arguments updated.

Mutation

mutation UpdateOpportunityDetails($input: UpdateOpportunityDetailsInput!) {
  updateOpportunityDetails(input: $input) {
    updatedData
  }
}

Variables

{
  "input": UpdateOpportunityDetailsInput
}

Response

{
  "data": {
    "updateOpportunityDetails": {
      "updatedData": {"key": "value"}
    }
  }
}

updateOpportunityExtraDetails

Type:UpdateOpportunityExtraDetails

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

Update the extra details of a opportunity.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8926: Unable to create opportunity.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateExtraDetailsInput!)

Input fields for updating the extra details of a opportunity.

Return fields

NameDescription

extraDetails (JSONString)

The opportunity's extra details to be added or updated.

Mutation

mutation UpdateOpportunityExtraDetails($input: UpdateExtraDetailsInput!) {
  updateOpportunityExtraDetails(input: $input) {
    extraDetails
  }
}

Variables

{
  "input": UpdateExtraDetailsInput
}

Response

{
  "data": {
    "updateOpportunityExtraDetails": {
      "extraDetails": {"key": "value"}
    }
  }
}

updateOpportunityStage

Type:UpdateOpportunityStage

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

Update the stage of a opportunity.

The possible errors that can be raised are:

  • KT-CT-8903: Unable to update opportunity.
  • KT-CT-8910: Received opportunity current stage is not valid.
  • KT-CT-8914: Stage not found.
  • KT-CT-8915: Stages are not in the same funnel.
  • KT-CT-8916: Current stage mismatch.
  • KT-CT-8917: Stage transition not allowed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateOpportunityStageInput!)

Input fields for updating the state of a opportunity.

Return fields

NameDescription

message (String)

Placeholder success message for now.

Mutation

mutation UpdateOpportunityStage($input: UpdateOpportunityStageInput!) {
  updateOpportunityStage(input: $input) {
    message
  }
}

Variables

{
  "input": UpdateOpportunityStageInput
}

Response

{
  "data": {
    "updateOpportunityStage": {
      "message": "abc123"
    }
  }
}

updateOptionsLanguagePreference

Type:UpdateOptionsLanguagePreference

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

Update the language preference for an account. Determines the language in which communications about the account are sent. It does not affect the language seen in the UI.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (OptionsLanguagePreferenceInput!)

Variables needed to update the language preference for an account.

Return fields

NameDescription

optionsLanguagePreference (OptionsLanguagePreferenceChoices)

The selected language preference.

Mutation

mutation UpdateOptionsLanguagePreference($input: OptionsLanguagePreferenceInput!) {
  updateOptionsLanguagePreference(input: $input) {
    optionsLanguagePreference
  }
}

Variables

{
  "input": OptionsLanguagePreferenceInput
}

Response

{
  "data": {
    "updateOptionsLanguagePreference": {
      "optionsLanguagePreference": "ENGLISH"
    }
  }
}

updatePassword

Type:UpdatePassword

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

  • KT-CT-5460: Old password is invalid.
  • KT-CT-5450: Password is invalid.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (UpdatePasswordInput)

Return fields

NameDescription

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

Mutation

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

Variables

{
  "input": UpdatePasswordInput
}

Response

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

updatePaymentSchedule

Type:UpdatePaymentSchedule

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

Update a payment schedule for an account.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdatePaymentScheduleInput!)

Return fields

NameDescription

schedule (PaymentScheduleType)

Updated payment schedule.

error (UpdatePaymentScheduleErrorUnion)

Handled errors related to payment schedule updates.

Mutation

mutation UpdatePaymentSchedule($input: UpdatePaymentScheduleInput!) {
  updatePaymentSchedule(input: $input) {
    schedule {
      ...PaymentScheduleTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on UnableToUpdateScheduleType {
        ...UnableToUpdateScheduleTypeFragment
      }
    }
  }
}

Variables

{
  "input": UpdatePaymentScheduleInput
}

Response

{
  "data": {
    "updatePaymentSchedule": {
      "schedule": PaymentScheduleType,
      "error": DoesNotExistErrorType
    }
  }
}

updatePrimaryResidence

Type:UpdatePrimaryResidence

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

Update an existing primary residence for the given user and property.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdatePrimaryResidenceInput!)

Input fields for updating a primary residence.

Return fields

NameDescription

primaryResidence (PrimaryResidenceType)

The updated primary residence.

error (UpdatePrimaryResidenceErrorUnion)

The error type and message.

Mutation

mutation UpdatePrimaryResidence($input: UpdatePrimaryResidenceInput!) {
  updatePrimaryResidence(input: $input) {
    primaryResidence {
      ...PrimaryResidenceTypeFragment
    }
    error {
      ... on AccountUserCanNotFoundErrorType {
        ...AccountUserCanNotFoundErrorTypeFragment
      }
      ... on PropertyCanNotFoundErrorType {
        ...PropertyCanNotFoundErrorTypeFragment
      }
      ... on FailedPrimaryResidenceValidationErrorType {
        ...FailedPrimaryResidenceValidationErrorTypeFragment
      }
      ... on InvalidPrimaryResidenceEndDateErrorType {
        ...InvalidPrimaryResidenceEndDateErrorTypeFragment
      }
      ... on InvalidPrimaryResidenceFromDateErrorType {
        ...InvalidPrimaryResidenceFromDateErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": UpdatePrimaryResidenceInput
}

Response

{
  "data": {
    "updatePrimaryResidence": {
      "primaryResidence": PrimaryResidenceType,
      "error": AccountUserCanNotFoundErrorType
    }
  }
}

updateProcessedHouseMoveDate

Type:UpdateProcessedHouseMoveDate

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

Mutation to trigger an update the date of house move in or out

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateProcessedHouseMoveDateInput!)

Return fields

NameDescription

account (AccountType)

error (UpdateProcessedHouseMoveDateErrorUnion)

Mutation

mutation UpdateProcessedHouseMoveDate($input: UpdateProcessedHouseMoveDateInput!) {
  updateProcessedHouseMoveDate(input: $input) {
    account {
      ...AccountTypeFragment
    }
    error {
      ... on DoesNotExistErrorType {
        ...DoesNotExistErrorTypeFragment
      }
      ... on MultipleObjectsReturnedErrorType {
        ...MultipleObjectsReturnedErrorTypeFragment
      }
      ... on ExistingBillingOverMoveInAdjustmentErrorType {
        ...ExistingBillingOverMoveInAdjustmentErrorTypeFragment
      }
      ... on UnableToAdjustMoveDateErrorType {
        ...UnableToAdjustMoveDateErrorTypeFragment
      }
    }
  }
}

Variables

{
  "input": UpdateProcessedHouseMoveDateInput
}

Response

{
  "data": {
    "updateProcessedHouseMoveDate": {
      "account": AccountType,
      "error": DoesNotExistErrorType
    }
  }
}

updateProductPrices

Type:UpdateProductPricesOutput!

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

Update the prices of a product.

The possible errors that can be raised are:

  • KT-CT-12008: Unable to find the product.
  • KT-CT-12009: Specified product does not have a specification.
  • KT-CT-12010: Unable to find the product's specification.
  • KT-CT-12011: The list of provided prices contains validation errors.
  • KT-CT-12012: Product prices start date is in the past.
  • KT-CT-12013: Product prices would overwrite existing prices.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateProductPricesInput!)

Return fields

NameDescription

Mutation

mutation UpdateProductPrices($input: UpdateProductPricesInput!) {
  updateProductPrices(input: $input) {
    prices {
      ...RateGroupPricesFragment
    }
  }
}

Variables

{
  "input": UpdateProductPricesInput
}

Response

{
  "data": {
    "updateProductPrices": {
      "prices": RateGroupPrices
    }
  }
}

updatePropertyAddress

Type:UpdatePropertyAddress

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

Update the address of an existing property.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdatePropertyAddressInput!)

Input fields for updating the address of a property.

Return fields

NameDescription

property (PropertyType)

The property whose address was updated.

Mutation

mutation UpdatePropertyAddress($input: UpdatePropertyAddressInput!) {
  updatePropertyAddress(input: $input) {
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": UpdatePropertyAddressInput
}

Response

{
  "data": {
    "updatePropertyAddress": {
      "property": PropertyType
    }
  }
}

updateQuoteConfiguration

Type:UpdateQuoteConfigurationOutput

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

Update a quote configuration's terms, expiry date, and extra details.

The possible errors that can be raised are:

  • KT-CT-12408: Quote configuration not found.
  • KT-CT-12409: Term not found in quote configuration.
  • KT-CT-12410: Invalid extra detail field type.
  • KT-CT-12411: Extra detail not found in quote configuration.
  • KT-CT-12412: Duplicate term identifiers provided.
  • KT-CT-12413: Duplicate extra detail field codes provided.
  • KT-CT-12414: Unsupported term type.
  • KT-CT-12415: Schedule missing required identifier.
  • KT-CT-12416: Item missing required identifier.
  • KT-CT-12417: Schedule not found in term.
  • KT-CT-12418: Item not found in schedule.
  • KT-CT-12419: One or more terms not found.
  • KT-CT-12420: One or more extra details not found.
  • KT-CT-12421: No extra detail fields provided for update.
  • KT-CT-12423: Forecast consumption entry not found.
  • KT-CT-12424: Quote configuration cannot be edited in its current status.
  • KT-CT-12425: Cannot update rates request.
  • KT-CT-12426: Extra detail field code or type is not allowed for this client.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateQuoteConfigurationInput!)

Input for updating a quote configuration.

Return fields

NameDescription

quoteConfiguration (QuoteConfigurationType!)

The updated quote configuration.

Mutation

mutation UpdateQuoteConfiguration($input: UpdateQuoteConfigurationInput!) {
  updateQuoteConfiguration(input: $input) {
    quoteConfiguration {
      ...QuoteConfigurationTypeFragment
    }
  }
}

Variables

{
  "input": UpdateQuoteConfigurationInput
}

Response

{
  "data": {
    "updateQuoteConfiguration": {
      "quoteConfiguration": QuoteConfigurationType
    }
  }
}

updateRegisterNtcOverride

Type:UpdateRegisterNTCOverride

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

Updates network tariff code override for the register under Meter point.

The possible errors that can be raised are:

  • KT-AU-5611: Cannot find register with the provided ID.
  • KT-AU-5612: Error in creating the override.
  • KT-AU-5613: Cannot find meter point with the provided ID.
  • KT-AU-5614: Cannot find register network tariff code override with the provided ID.
  • KT-AU-5617: Override period falls outside the register's active period.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateRegisterNTCOverrideInputType)

Return fields

NameDescription

meterPoint (MeterPointType)

The target meter point.

Mutation

mutation UpdateRegisterNtcOverride($input: UpdateRegisterNTCOverrideInputType) {
  updateRegisterNtcOverride(input: $input) {
    meterPoint {
      ...MeterPointTypeFragment
    }
  }
}

Variables

{
  "input": UpdateRegisterNTCOverrideInputType
}

Response

{
  "data": {
    "updateRegisterNtcOverride": {
      "meterPoint": MeterPointType
    }
  }
}

updateSiteworksRequest

Type:UpdateSiteworksRequest

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

Update a Request.

The possible errors that can be raised are:

  • KT-CT-4231: Unauthorized.
  • KT-CT-4232: Status passed is not valid.
  • KT-CT-4233: Request does not exist.
  • KT-CT-4234: Terminated Request cannot be updated.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'updateSiteworksRequest' field is deprecated.

Please use updateOnSiteJobsRequest instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.

Arguments

NameDescription

input (UpdateSiteworksRequestInputType!)

The input objects required to update a Request.

Return fields

NameDescription

siteworksRequest (CoreSiteworksRequestType)

The siteworks request after the update.

Mutation

mutation UpdateSiteworksRequest($input: UpdateSiteworksRequestInputType!) {
  updateSiteworksRequest(input: $input) {
    siteworksRequest {
      ...CoreSiteworksRequestTypeFragment
    }
  }
}

Variables

{
  "input": UpdateSiteworksRequestInputType
}

Response

{
  "data": {
    "updateSiteworksRequest": {
      "siteworksRequest": CoreSiteworksRequestType
    }
  }
}

updateUser

Type:UpdateUserMutation

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

Update the account user details of the authenticated user.

firstName and givenName fields are blocked and can't be updated via this mutation. There is no limit in the number of fields and number of times they can be updated per day.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateUserInput!)

Input fields for updating user.

Return fields

NameDescription

viewer (AccountUserType)

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

Mutation

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

Variables

{
  "input": UpdateUserInput
}

Response

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

updateUserAddress

Type:UpdateUserAddressMutation

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

Update address in legacy format for all accounts for this user.

The possible errors that can be raised are:

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

Arguments

NameDescription

address (UpdateAddressInput!)

New billing address for user accounts.

Return fields

NameDescription

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

Mutation

mutation UpdateUserAddress($address: UpdateAddressInput!) {
  updateUserAddress(address: $address) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "address": UpdateAddressInput
}

Response

{
  "data": {
    "updateUserAddress": {
      "viewer": AccountUserType
    }
  }
}

updateUserDetails

Type:UpdateAccountUserMutationPayload

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

The possible errors that can be raised are:

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

Deprecated

The 'updateUserDetails' field is deprecated.


Please use the 'updateUser' mutation instead.


- Marked as deprecated on 2020-10-02.
- Scheduled for removal on or after 2023-04-06.

Arguments

NameDescription

input (UpdateAccountUserMutationInput!)

Return fields

NameDescription

givenName (String)

familyName (String)

pronouns (String)

mobile (String)

email (String)

dateOfBirth (Date)

landline (String)

errors ([ErrorType])

clientMutationId (String)

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": "abc123",
      "familyName": "abc123",
      "pronouns": "abc123",
      "mobile": "abc123",
      "email": "abc123",
      "dateOfBirth": "2020-01-01",
      "landline": "abc123",
      "errors": [ErrorType],
      "clientMutationId": "abc123"
    }
  }
}

updateUserRichAddress

Type:UpdateUserRichAddressMutation

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

Update address for all accounts for this user.

The possible errors that can be raised are:

  • KT-CT-4412: The supplied address is not valid.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

address (RichAddressInput!)

New billing address for user accounts.

userId (ID)

The user id to change data for. Only required when the mutation is called by an organisation.

Return fields

NameDescription

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

Mutation

mutation UpdateUserRichAddress(
  $address: RichAddressInput!,
  $userId: ID
) {
  updateUserRichAddress(
    address: $address,
    userId: $userId
  ) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "address": RichAddressInput,
  "userId": "abc123"
}

Response

{
  "data": {
    "updateUserRichAddress": {
      "viewer": AccountUserType
    }
  }
}

validateAddress

Type:ValidateAddress

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

Validate an address without persisting it. Accepts address form values (matching the structure from the addressFields query), runs validation, and returns the full descriptor with cleaned/normalised values and per-field errors so the client can compare submitted vs. normalised data.

The possible errors that can be raised are:

  • KT-CT-4413: The supplied address field descriptor identifier is not recognised.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (ValidateAddressInput!)

The address field values to validate.

Return fields

NameDescription

isValid (Boolean!)

Whether the address passed all validation checks.

cleanedDescriptor (AddressFieldDescriptorType)

The address field descriptor with cleaned/normalised values and per-field validation errors populated. Each field's errors list is empty when valid. Returned on both success and failure.

Mutation

mutation ValidateAddress($input: ValidateAddressInput!) {
  validateAddress(input: $input) {
    isValid
    cleanedDescriptor {
      ...AddressFieldDescriptorTypeFragment
    }
  }
}

Variables

{
  "input": ValidateAddressInput
}

Response

{
  "data": {
    "validateAddress": {
      "isValid": true,
      "cleanedDescriptor": AddressFieldDescriptorType
    }
  }
}

validateConcession

Type:ValidateConcession

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

The possible errors that can be raised are:

  • KT-AU-8812: User has no active concession.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ValidateConcessionInput!)

Return fields

NameDescription

concession (ConcessionType)

Mutation

mutation ValidateConcession($input: ValidateConcessionInput!) {
  validateConcession(input: $input) {
    concession {
      ...ConcessionTypeFragment
    }
  }
}

Variables

{
  "input": ValidateConcessionInput
}

Response

{
  "data": {
    "validateConcession": {
      "concession": ConcessionType
    }
  }
}

validateEmail

Type:ValidateEmail

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

Validate whether a user's email address is valid via the Kickbox API.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ValidateEmailInput!)

Return fields

NameDescription

isValid (Boolean)

Whether the email is valid or not.

Mutation

mutation ValidateEmail($input: ValidateEmailInput!) {
  validateEmail(input: $input) {
    isValid
  }
}

Variables

{
  "input": ValidateEmailInput
}

Response

{
  "data": {
    "validateEmail": {
      "isValid": true
    }
  }
}

validateMfaDevice

Type:ValidateMfaDevice

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

Validate a multi-factor authentication (MFA) device for a user.

The possible errors that can be raised are:

  • KT-CT-1150: MFA device not found.
  • KT-CT-1151: MFA device not found.
  • KT-CT-1152: Invalid MFA token.
  • KT-CT-1155: Enabled backup device is needed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ValidateMfaDeviceInputType!)

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

Return fields

NameDescription

deviceIsValid (Boolean)

Flag to indicate if the device has been verified, so it can be used for MFA.

Mutation

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

Variables

{
  "input": ValidateMfaDeviceInputType
}

Response

{
  "data": {
    "validateMfaDevice": {
      "deviceIsValid": true
    }
  }
}

validatePhone

Type:ValidatePhone

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

Validate whether a user's phone number is valid.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ValidatePhoneNumberInput!)

Return fields

NameDescription

isValid (Boolean)

Whether the phone number is valid or not.

Mutation

mutation ValidatePhone($input: ValidatePhoneNumberInput!) {
  validatePhone(input: $input) {
    isValid
  }
}

Variables

{
  "input": ValidatePhoneNumberInput
}

Response

{
  "data": {
    "validatePhone": {
      "isValid": true
    }
  }
}

varyContractTerms

Type:VaryContractTermsOutput!

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

Vary the terms of a contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10008: The contract is currently undergoing an active journey.
  • KT-CT-10011: Unable to vary contract terms.
  • KT-CT-10033: Unable to save term.
  • KT-CT-10012: Contract variation implies breach.
  • KT-CT-10034: Unknown contract journey type.
  • KT-CT-10035: Cannot process a non-active contract journey.
  • KT-CT-10036: The contract journey manager is not found.
  • KT-CT-10037: Contract notes feature is disabled.
  • KT-CT-10038: Contract note reason not found.
  • KT-CT-10041: Contract is already rescinded.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (VaryContractTermsInput!)

Return fields

NameDescription

Mutation

mutation VaryContractTerms($input: VaryContractTermsInput!) {
  varyContractTerms(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": VaryContractTermsInput
}

Response

{
  "data": {
    "varyContractTerms": {
      "contract": Contract
    }
  }
}

verifyCustomer

Type:VerifyCustomer

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

Verify a customer using the provided verification code and type.

The possible errors that can be raised are:

  • KT-CT-4191: Error while verifying the customer.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (VerifyCustomerInput!)

Return fields

NameDescription

user (AccountUserType)

The currently authenticated user.

Mutation

mutation VerifyCustomer($input: VerifyCustomerInput!) {
  verifyCustomer(input: $input) {
    user {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": VerifyCustomerInput
}

Response

{
  "data": {
    "verifyCustomer": {
      "user": AccountUserType
    }
  }
}

verifyEmail

Type:VerifyEmail

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

Verify user's email address.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (VerifyEmailInput!)

Return fields

NameDescription

isVerified (Boolean)

Whether the email is verified.

Mutation

mutation VerifyEmail($input: VerifyEmailInput!) {
  verifyEmail(input: $input) {
    isVerified
  }
}

Variables

{
  "input": VerifyEmailInput
}

Response

{
  "data": {
    "verifyEmail": {
      "isVerified": true
    }
  }
}

verifyIdentity

Type:VerifyIdentity

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

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (VerifyIdentityInput!)

Details about the user to be verified.

Return fields

NameDescription

token (String!)

An expiring token that can be used to request to update the user's email address.

Mutation

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

Variables

{
  "input": VerifyIdentityInput
}

Response

{
  "data": {
    "verifyIdentity": {
      "token": "abc123"
    }
  }
}

withdrawDunning

Type:WithdrawDunning

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

Withdraw a dunning process for an account

The possible errors that can be raised are:

  • KT-CT-4178: No account found with given account number.
  • KT-CT-11301: Account not in a dunning process for the given path name.
  • KT-CT-11302: No active dunning process found.
  • KT-CT-11303: Multiple active dunning processes found.
  • KT-CT-11306: Withdrawing the dunning process failed.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (WithdrawDunningInputType!)

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

Return fields

NameDescription

withdrawSuccessful (Boolean)

Whether the dunning process was withdrawn successfully.

Mutation

mutation WithdrawDunning($input: WithdrawDunningInputType!) {
  withdrawDunning(input: $input) {
    withdrawSuccessful
  }
}

Variables

{
  "input": WithdrawDunningInputType
}

Response

{
  "data": {
    "withdrawDunning": {
      "withdrawSuccessful": true
    }
  }
}