Mutations

acceptGoodsQuote

Type: AcceptGoodsQuote

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

Accept a goods quote.

Query Complexity: 1

Possible Errors:

• KT-CT-8201: Received an invalid quoteId.
• KT-CT-8223: Unauthorized.
• KT-CT-8224: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage goods purchases

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

{
  "input": AcceptGoodsQuoteInput
}

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

acceptOfferForQuoting

Type: AcceptOfferForQuoting

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

Accept a quoting offer in an offer group.

Query Complexity: 3

Possible Errors:

• KT-CT-12402: Unable to accept offer.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create quoting offer group

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

{
  "input": AcceptOfferForQuotingInput
}

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

actualizeContract

Type: ActualizeContractOutput!

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

Actualize a contract for an account or business.

Query Complexity: 1

Possible Errors:

• 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-10039: At least one of the affected fields must be provided.
• KT-CT-10041: Contract is already rescinded.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": ActualizeContractInput
}

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

addBusinessToSegment

Type: AddBusinessToSegmentMutation

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

Add a business to a segment.

Query Complexity: 1

Possible Errors:

• KT-CT-11107: Unauthorized.
• KT-CT-1111: Unauthorized.
• KT-CT-11111: Segment does not exist.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can query businesses AND Can update businesses

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

{
  "input": AddBusinessToSegmentInput
}

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

addCampaignToAccount

Type: AddCampaignToAccount

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

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-4123: Unauthorized.
• KT-CT-7427: No campaign found with given slug.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can add campaign to account

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

{
  "input": AddCampaignToAccountInput
}

{
  "data": {
    "addCampaignToAccount": {
      "campaignAdded": true
    }
  }
}

addChildToProperty

Type: AddChildToProperty

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

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-6622: Unauthorized.
• KT-CT-6634: Unable to add child to property.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage property hierarchies

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

{
  "input": AddChildToPropertyInput
}

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

addItemsToRiskList

Type: AddItemsToRiskList

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

Add items to the risk list.

Query Complexity: 1

Possible Errors:

• KT-CT-12105: Risk list item addition failed.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can edit risk list

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

{
  "input": RiskListItemInputType
}

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

addNoteToInkConversation

Type: AddNoteToInkConversation

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

Query Complexity: 1

Possible Errors:

• KT-CT-7612: The Ink conversation was not found.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can add note to conversation

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

{
  "input": AddNoteToInkConversationInput
}

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

addParentToProperty

Type: AddParentToProperty

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

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-6622: Unauthorized.
• KT-CT-6635: Unable to add parent to property.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage property hierarchies

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

{
  "input": AddParentToPropertyInput
}

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

addPortfolioReference

Type: AddPortfolioReference

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

Mutation to add a reference to an existing portfolio.

Query Complexity: 1

Possible Errors:

• KT-CT-9403: Received an invalid portfolioId.
• KT-CT-9408: Invalid portfolio number format.
• KT-CT-9409: Invalid portfolio reference.
• KT-CT-9410: Conflicting portfolio reference.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create portfolios

mutation AddPortfolioReference($input: AddPortfolioReferenceInput) {
  addPortfolioReference(input: $input) {
  }
}

{
  "input": AddPortfolioReferenceInput
}

{
  "data": {
    "addPortfolioReference": {

    }
  }
}

addProperty

Type: AddProperty

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

Add a property to an account.

Query Complexity: 1

Possible Errors:

• KT-CT-6623: Unauthorized.
• KT-CT-6629: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create property

Rate Limits

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

{
  "input": AddPropertyInput
}

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

addPropertyToHierarchy

Type: AddPropertyToHierarchy

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

Query Complexity: 1

Possible Errors:

• KT-CT-6622: Unauthorized.
• KT-CT-6633: Property is already in the hierarchy as a child.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage property hierarchies

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

{
  "input": AddPropertyToHierarchyInput
}

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

addSignupReferralOnAccount

Type: AddSignupReferralOnAccount

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

Add a one-way signup reward to a referral.

Query Complexity: 1

Possible Errors:

• KT-CT-6710: Unable to create referral.
• KT-CT-6712: Invalid reference.
• KT-CT-6713: Referring and referred account brands do not match.
• KT-CT-6723: Unauthorized.
• KT-CT-6728: This referral scheme's usage is at capacity.
• KT-CT-6729: This scheme cannot be applied to given account.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create referrals

Rate Limits

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

{
  "input": AddSignupReferralOnAccountInput
}

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

addStorylineToInkConversation

Type: AddStorylineToInkConversation

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

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can add storyline to conversation

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

{
  "input": AddStorylineToInkConversationInput
}

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

addUserToPortfolio

Type: AddUserToPortfolio

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

Add an user to a portfolio with a specified role.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can allocate user roles

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

{
  "input": AddUserToPortfolioInput
}

{
  "data": {
    "addUserToPortfolio": {

    }
  }
}

allowRepaymentSubmission

Type: AllowRepaymentSubmission

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

Allow a repayment to be submitted.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create repayment interventions

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

{
  "input": RepaymentInput
}

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

amendPayment

Type: AmendPayment

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

Amend an existing payment.

Query Complexity: 1

Possible Errors:

• KT-CT-3924: Unauthorized.
• KT-CT-3970: The account cannot amend payments.
• KT-CT-4123: Unauthorized.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can amend payments

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

{
  "input": AmendPaymentInput
}

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

approveRepayment

Type: ApproveRepayment

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

Approve a repayment.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can approve repayments

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

{
  "input": ApproveRepaymentInput
}

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

assessCollectionProcessRecordForPause

Type: AssessCollectionProcessRecordForPause

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

Assess a collection process record for pause.

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-11201: No Collection Process Records associated with id.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can update collection process record to pause

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

{
  "input": AssessCollectionProcessRecordForPauseInputType
}

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

assignInkBucket

Type: AssignInkBucket

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

Query Complexity: 1

Possible Errors:

• KT-CT-7612: The Ink conversation was not found.
• KT-CT-7613: The Ink bucket was not found.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can assign ink bucket

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

{
  "input": AssignInkBucketInput
}

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

assignSupplyPointToEstimationGroup

Type: AssignSupplyPointToEstimationGroup

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

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage supply point estimation group

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

{
  "input": AssignSupplyPointToEstimationGroupInput
}

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

associateArchivedCallRecordingsWithCalls

Type: AssociateArchivedCallRecordingsWithCalls

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

Query Complexity: 6

Possible Errors:

• KT-CT-11818: Invalid archived call recordings input.
• KT-CT-11820: Too many recordings to associate in a single request.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can associate archived call recordings

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

{
  "input": AssociateArchivedCallRecordingsWithCallsInput
}

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

associateCallWithAccount

Type: AssociateCallWithAccount

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

Query Complexity: 1

Possible Errors:

• KT-CT-11802: Call not found.
• KT-CT-11808: Unable to associate account to call.
• KT-CT-11817: Invalid call ID.
• KT-CT-4178: No account found with given account number.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage calls

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

{
  "input": AssociateCallWithAccountInput
}

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

associateItemToCollectionProcess

Type: AssociateItemToCollectionProcess

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

Associate item to a collection process.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can associate item to collection process

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

{
  "input": AssociateItemToCollectionProcessInputType
}

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

attachAgreementsToContracts

Type: AttachAgreementsToContractsOutput!

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

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

Query Complexity: 1

Possible Errors:

• 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-1501: Agreement not found.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": AttachAgreementsToContractsInput
}

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

awardLoyaltyPoints

Type: AwardLoyaltyPoints

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

Award the passed number of Loyalty Points to the account.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can add loyalty points

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

{
  "input": AwardLoyaltyPointsInput
}

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

backendScreenEvent

Type: BackendScreenEvent

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

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

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": BackendScreenEventInput
}

{
  "data": {
    "backendScreenEvent": {
      "action": BackendScreenEventActionType
    }
  }
}

blockRepaymentSubmission

Type: BlockRepaymentSubmission

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

Block a repayment from being submitted.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create repayment interventions

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

{
  "input": RepaymentInput
}

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

bulkAwardLoyaltyPoints

Type: BulkAwardLoyaltyPoints

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

Award Loyalty Points to multiple accounts in a single request.

Query Complexity: 3

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can add loyalty points

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

{
  "input": BulkAwardLoyaltyPointsInput
}

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

cancelEnrollment

Type: EnrollmentCancelled!

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

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

Query Complexity: 1

Possible Errors:

• 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-10331: Missing required process number.
• KT-CT-10338: Enrollment process cannot be cancelled.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": CancelEnrollmentInput
}

{
  "data": {
    "cancelEnrollment": {
      "enrollmentProcess": JoinSupplierProcessType,
      "message": "she-person-themselves-explain-teacher"
    }
  }
}

cancelLeaveSupplier

Type: LeaveSupplierCancelled!

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

Cancel a leave supplier process.

Query Complexity: 1

Possible Errors:

• KT-CT-10302: Invalid data.
• KT-CT-10304: Mutation not enabled in this environment.
• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": CancelLeaveSupplierInput
}

{
  "data": {
    "cancelLeaveSupplier": {
      "message": "magazine-very-clear-will-manage"
    }
  }
}

cancelPayment

Type: CancelPayment

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

Cancel an in-flight payment.

Query Complexity: 1

Possible Errors:

• KT-CT-3924: Unauthorized.
• KT-CT-3954: Payment cancellation failed.
• KT-CT-3955: Payment cannot be cancelled.
• KT-CT-3956: Temporary error occurred.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can cancel payments

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

{
  "input": CancelPaymentInput
}

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

cancelRepaymentRequest

Type: CancelRepaymentRequest

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

Cancel a repayment or refund request.

Query Complexity: 1

Possible Errors:

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

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": CancelRepaymentRequestInputType
}

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

cancelSmartFlexOnboarding

Type: CancelSmartFlexOnboarding

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

Cancel onboarding of a device with SmartFlex.

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-4371: Onboarding wizard ID is invalid.
• KT-CT-4372: Simultaneous attempts to update onboarding process.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can register smartflex devices

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

{
  "input": CancelSmartFlexOnboardingInput
}

{
  "data": {
    "cancelSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

checkCreditRisk

Type: CheckCreditRisk

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

Check the credit risk for an account.

Query Complexity: 1

Possible Errors:

• KT-CT-3921: Account not found.
• KT-CT-5518: Account user not found.
• KT-CT-5523: Invalid account or account user.
• KT-ES-10701: Default property not found.
• KT-ES-10702: Credit check only available for domestic accounts.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can run credit check

mutation CheckCreditRisk($input: CheckCreditRiskInput!) {
  checkCreditRisk(input: $input) {
    passedCreditCheck
  }
}

{
  "input": CheckCreditRiskInput
}

{
  "data": {
    "checkCreditRisk": {
      "passedCreditCheck": true
    }
  }
}

closeDcaProceeding

Type: CloseDCAProceeding

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

Close the DCA proceeding for an account.

Query Complexity: 1

Possible Errors:

• 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-4178: No account found with given account number.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can update dca proceedings

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

{
  "input": CloseDCAProceedingInputType
}

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

closeInkConversation

Type: CloseInkConversation

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

Query Complexity: 1

Possible Errors:

• KT-CT-7612: The Ink conversation was not found.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can update ink conversation status

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

{
  "input": CloseInkConversationInput
}

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

closeInkLiveChat

Type: CloseInkLiveChatConversation

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

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage ink live chat

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

{
  "input": CloseInkLiveChaConversationtInput
}

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

closeOpenPrintBatch

Type: CloseOpenPrintBatch!

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

Close the Open Print Batch if any.

Query Complexity: 1

Possible Errors:

• KT-CT-9010: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

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

collectDeposit

Type: CollectDeposit

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

Collect deposit for the given account.

Query Complexity: 6

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can perform payments operations AND Can use deposit system

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

{
  "input": CollectDepositInput
}

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

collectPayment

Type: CollectPayment

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

Query Complexity: 1

Possible Errors:

• KT-CT-3820: Received both ledger ID and number.
• KT-CT-3821: Received neither ledger ID nor ledger number.
• KT-CT-3932: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can collect payments

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

{
  "input": CollectPaymentInput
}

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

commenceDcaProceeding

Type: CommenceDCAProceeding

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

Add commencement to an account.

Query Complexity: 1

Possible Errors:

• 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-11606: Debt Collection Agency cannot use campaign.
• KT-CT-11607: Invalid ledger number for debt collection proceeding.
• KT-CT-11608: Ledger does not belong to account.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can update dca proceedings

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

{
  "input": CommenceDCAProceedingInputType
}

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

completeApproval

Type: CompleteApproval

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

Complete an approval by marking it as approved or rejected.

Query Complexity: 1

Possible Errors:

• KT-CT-14801: Approval not found.
• KT-CT-14802: Invalid input for completing approval.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can complete approvals

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

{
  "input": CompleteApprovalInputType
}

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

completeAuthFlowForSmartFlexOnboarding

Type: CompleteAuthFlowForSmartFlexOnboarding

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

Complete the authentication flow to proceed in the onboarding journey.

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-4371: Onboarding wizard ID is invalid.
• KT-CT-4372: Simultaneous attempts to update onboarding process.
• KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
• KT-CT-4376: Unable to complete onboarding step. Please try again later.
• KT-CT-4377: Invalid onboarding step ID.
• KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
• KT-CT-4379: Vehicle is not ready for a test charge.
• KT-CT-4391: This onboarding wizard has been cancelled.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can register smartflex devices

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

{
  "input": CompleteAuthFlowInput
}

{
  "data": {
    "completeAuthFlowForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeReminder

Type: CompleteReminder

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

Complete a reminder.

Query Complexity: 1

Possible Errors:

• KT-CT-1406: Invalid data.
• KT-CT-1407: Unable to complete reminder.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can update reminders

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

{
  "input": CompleteReminderInput
}

{
  "data": {
    "completeReminder": {

    }
  }
}

completeStandalonePayment

Type: CompleteStandalonePayment

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

Complete a standalone payment.

Query Complexity: 1

Possible Errors:

• KT-CT-3822: Unauthorized.
• KT-CT-3823: Unauthorized.
• KT-CT-3974: Unauthorized.
• KT-CT-3975: Unable to complete standalone payment.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can initiate standalone payments

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

{
  "input": CompleteStandalonePaymentInput
}

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

completeTeslaSetupVirtualKeyForSmartFlexOnboarding

Type: CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding

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

Complete the Tesla virtual key setup onboarding step.

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-4371: Onboarding wizard ID is invalid.
• KT-CT-4372: Simultaneous attempts to update onboarding process.
• KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
• KT-CT-4376: Unable to complete onboarding step. Please try again later.
• KT-CT-4377: Invalid onboarding step ID.
• KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
• KT-CT-4379: Vehicle is not ready for a test charge.
• KT-CT-4391: This onboarding wizard has been cancelled.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can register smartflex devices

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

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "completeTeslaSetupVirtualKeyForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeUserActionForSmartFlexOnboarding

Type: CompleteUserActionRequiredForSmartFlexOnboarding

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

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

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-4371: Onboarding wizard ID is invalid.
• KT-CT-4372: Simultaneous attempts to update onboarding process.
• KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
• KT-CT-4376: Unable to complete onboarding step. Please try again later.
• KT-CT-4377: Invalid onboarding step ID.
• KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
• KT-CT-4379: Vehicle is not ready for a test charge.
• KT-CT-4391: This onboarding wizard has been cancelled.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can register smartflex devices

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

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "completeUserActionForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeUserInputRequiredForSmartFlexOnboarding

Type: CompleteUserInputRequiredForSmartFlexOnboarding

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

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

Query Complexity: 1

Possible Errors:

• KT-CT-1111: Unauthorized.
• KT-CT-4371: Onboarding wizard ID is invalid.
• KT-CT-4372: Simultaneous attempts to update onboarding process.
• KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
• KT-CT-4376: Unable to complete onboarding step. Please try again later.
• KT-CT-4377: Invalid onboarding step ID.
• KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
• KT-CT-4379: Vehicle is not ready for a test charge.
• KT-CT-4391: This onboarding wizard has been cancelled.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can register smartflex devices

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

{
  "input": UserInputRequiredInput
}

{
  "data": {
    "completeUserInputRequiredForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

confirmDoubleOptIn

Type: ConfirmDoubleOptIn

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

Confirm a double opt in

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can edit customer marketing preference

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

{
  "input": ConfirmDoubleOptInInput
}

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

connectAiAgentToCall

Type: ConnectAiAgentToCall

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

Query Complexity: 1

Possible Errors:

• KT-CT-11802: Call not found.
• KT-CT-11815: Unable to connect a call to an AI agent.
• KT-CT-11817: Invalid call ID.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can manage calls

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

{
  "input": ConnectAiAgentToCallInput
}

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

createAccountCharge

Type: CreateAccountCharge

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

Add charge to an account.

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can add charges to accounts AND Can perform payments operations

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

{
  "input": CreateAccountChargeInput
}

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

createAccountFileAttachment

Type: CreateAccountFileAttachmentPayload!

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

Query Complexity: 1

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

mutation CreateAccountFileAttachment($input: CreateAccountFileAttachmentInput!) {
  createAccountFileAttachment(input: $input) {
    clientMutationId
    postRequest {
      ...UploadPostRequestFragment
    }
  }
}

{
  "input": CreateAccountFileAttachmentInput
}

{
  "data": {
    "createAccountFileAttachment": {
      "clientMutationId": "16099802",
      "postRequest": UploadPostRequest
    }
  }
}

createAccountNote

Type: CreateAccountNote

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

Add a note to an account.

Query Complexity: 1

Possible Errors:

• KT-CT-4123: Unauthorized.
• KT-CT-4180: Account note must be a valid string.
• KT-CT-4195: Unpin at date provided for an unpinned note.
• KT-CT-4196: Unpin at date provided is in the past.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create account notes

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

{
  "input": CreateAccountNoteInput
}

{
  "data": {
    "createAccountNote": {
      "account": AccountType
    }
  }
}

createAccountPaymentSchedule

Type: CreateAccountPaymentSchedule

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

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

Query Complexity: 1

Possible Errors:

• 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.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can manage payment schedules

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

{
  "input": CreateAccountPaymentScheduleInput
}

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

createAccountReference

Type: CreateAccountReference

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

Create an account reference.

Query Complexity: 1

Possible Errors:

• KT-CT-4123: Unauthorized.
• KT-CT-8310: Invalid data.
• KT-CT-8311: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can create account reference

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

{
  "input": AccountReferenceInput
}

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

createAccountReminder

Type: CreateAccountReminder

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

Create an account reminder.

Query Complexity: 1

Possible Errors:

• KT-CT-1401: Invalid data.
• KT-CT-1402: Unable to create account reminder.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create account reminders

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

{
  "input": CreateAccountReminderInput
}

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

createAffiliateLink

Type: CreateAffiliateLink!

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

Create an affiliate link for a new sales agent.

Query Complexity: 1

Possible Errors:

• KT-CT-7711: Invalid data.
• KT-CT-7713: Invalid data.
• KT-CT-7714: Invalid data.
• KT-CT-7715: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": CreateAffiliateLinkInputType
}

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

createAffiliateOrganisation

Type: CreateAffiliateOrganisation!

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

Create an affiliate organisation.

Query Complexity: 1

Possible Errors:

• KT-CT-7716: Invalid data.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": CreateAffiliateOrganisationInputType
}

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

createAffiliateSession

Type: CreateAffiliateSession!

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

Create a session for an affiliate link.

Query Complexity: 1

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

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

{
  "input": CreateAffiliateSessionInputType
}

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

createAgreement

Type: CreateAgreement

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

Create a new agreement.

Query Complexity: 1

Possible Errors:

• KT-CT-1503: Agreement valid_to date must be later than valid_from 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-4123: Unauthorized.
• KT-CT-4719: No supply point found for identifier provided.
• KT-CT-4910: No product exists with the given input.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create agreements AND Can query agreements

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

{
  "input": CreateAgreementInput
}

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

createAgreementRollover

Type: CreateAgreementRollover

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

Create an agreement rollover for a specific account and agreement.

Query Complexity: 1

Possible Errors:

• 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-1501: Agreement not found.
• KT-CT-4910: No product exists with the given input.
• KT-CT-4924: Unauthorized.

Allowed Viewers:

Viewer type	Allowed?
Customer
Third party

Required Permissions:

Can create agreement rollovers AND Can query agreement rollovers

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

{
  "input": CreateAgreementRolloverInput
}