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.essentialenergy-kraken.systems/v1/graphql/
Accept a goods quote.
The possible errors that can be raised are:
- KT-CT-8223: Unauthorized.
- KT-CT-8201: Received an invalid quoteId.
- KT-CT-8224: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for accepting a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase created. |
Mutation
mutation AcceptGoodsQuote($input: AcceptGoodsQuoteInput!) {
acceptGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": AcceptGoodsQuoteInput
}Response
{
"data": {
"acceptGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}acceptOfferForQuoting
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for accepting a quoting offer. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Accepted quoting offer. |
Mutation
mutation AcceptOfferForQuoting($input: AcceptOfferForQuotingInput!) {
acceptOfferForQuoting(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
offer {
...OfferTypeFragment
}
}
}Variables
{
"input": AcceptOfferForQuotingInput
}Response
{
"data": {
"acceptOfferForQuoting": {
"possibleErrors": [PossibleErrorType],
"offer": OfferType
}
}
}addCampaignToAccount
Type:AddCampaignToAccount
URL:https://api.essentialenergy-kraken.systems/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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for adding a campaign to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the campaign was successfully added. |
Mutation
mutation AddCampaignToAccount($input: AddCampaignToAccountInput!) {
addCampaignToAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
campaignAdded
}
}Variables
{
"input": AddCampaignToAccountInput
}Response
{
"data": {
"addCampaignToAccount": {
"possibleErrors": [PossibleErrorType],
"campaignAdded": true
}
}
}addCustomEvent
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Add a custom event for an account.
Arguments
| Name | Description |
|---|---|
| |
| |
| |
|
Return fields
| Name | Description |
|---|---|
| Resulting Kraken event This field requires the |
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
}
}
}addProperty
Type:AddProperty
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for adding a property to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The property that was added to the account. |
Mutation
mutation AddProperty($input: AddPropertyInput!) {
addProperty(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
property {
...PropertyTypeFragment
}
}
}Variables
{
"input": AddPropertyInput
}Response
{
"data": {
"addProperty": {
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}
}
}amendPayment
Type:AmendPayment
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for amending an existing payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation AmendPayment($input: AmendPaymentInput!) {
amendPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": AmendPaymentInput
}Response
{
"data": {
"amendPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}backendScreenEvent
Type:BackendScreenEvent
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Look up an event to perform from its event_id, and return the next action to perform.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-8002: No event found.
- KT-CT-8003: Event has no execute function.
- KT-CT-8004: Error executing event in the backend.
- KT-CT-8007: Incorrect or missing parameters for backend screen event.
- KT-GB-9310: Account ineligible for joining Octoplus.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for performing a backend action. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An action to perform. |
Mutation
mutation BackendScreenEvent($input: BackendScreenEventInput!) {
backendScreenEvent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
action {
... on DeeplinkActionType {
...DeeplinkActionTypeFragment
}
... on LinkActionType {
...LinkActionTypeFragment
}
... on BackendScreenEventActionType {
...BackendScreenEventActionTypeFragment
}
... on CloseActionType {
...CloseActionTypeFragment
}
... on ScreenActionType {
...ScreenActionTypeFragment
}
... on ShowInputFieldErrorsActionType {
...ShowInputFieldErrorsActionTypeFragment
}
}
}
}Variables
{
"input": BackendScreenEventInput
}Response
{
"data": {
"backendScreenEvent": {
"possibleErrors": [PossibleErrorType],
"action": DeeplinkActionType
}
}
}cancelCentrepayDeduction
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input data for cancelling a Centrepay Deduction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of Centrepay Deduction to be cancelled. |
Mutation
mutation CancelCentrepayDeduction($input: CancelCentrepayDeductionInputType!) {
cancelCentrepayDeduction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
centrepayDeduction {
...CentrepayDeductionTypeFragment
}
}
}Variables
{
"input": CancelCentrepayDeductionInputType
}Response
{
"data": {
"cancelCentrepayDeduction": {
"possibleErrors": [PossibleErrorType],
"centrepayDeduction": CentrepayDeductionType
}
}
}cancelEnrollment
Type:EnrollmentCancelled!
URL:https://api.essentialenergy-kraken.systems/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.
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
}
}
}cancelRepaymentRequest
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Cancel a repayment or refund request.
The possible errors that can be raised are:
- KT-CT-4231: Unauthorized.
- KT-CT-3930: The repayment or refund request does not exist.
- KT-CT-3931: This repayment or refund request cannot be cancelled.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for cancelling a repayment request. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The cancelled repayment/refund request. |
Mutation
mutation CancelRepaymentRequest($input: CancelRepaymentRequestInputType!) {
cancelRepaymentRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentRequest {
...CancelRepaymentRequestOutputTypeFragment
}
}
}Variables
{
"input": CancelRepaymentRequestInputType
}Response
{
"data": {
"cancelRepaymentRequest": {
"possibleErrors": [PossibleErrorType],
"repaymentRequest": CancelRepaymentRequestOutputType
}
}
}changeCentrepayDeduction
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Initiate a request to change the details of a 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
| Name | Description |
|---|---|
Input data for changing a Centrepay Deduction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of Centrepay Deduction to be changed. |
Mutation
mutation ChangeCentrepayDeduction($input: ChangeCentrepayDeductionInputType!) {
changeCentrepayDeduction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
centrepayDeduction {
...CentrepayDeductionTypeFragment
}
}
}Variables
{
"input": ChangeCentrepayDeductionInputType
}Response
{
"data": {
"changeCentrepayDeduction": {
"possibleErrors": [PossibleErrorType],
"centrepayDeduction": CentrepayDeductionType
}
}
}closeInkLiveChat
Type:CloseInkLiveChatConversation
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The live chat conversation. |
Mutation
mutation CloseInkLiveChat($input: CloseInkLiveChaConversationtInput) {
closeInkLiveChat(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
liveChatConversation {
...InkLiveChatConversationFragment
}
}
}Variables
{
"input": CloseInkLiveChaConversationtInput
}Response
{
"data": {
"closeInkLiveChat": {
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation
}
}
}collectPayment
Type:CollectPayment
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Attempt to collect a one-off payment. If an instruction type is provided and there is an existing payment instruction, the payment can be collected immediately. A request to collect a payment at a future date can also be made, in which case the instruction input type is not necessary, but an instruction must exist at the specified collection date for the payment to be collected successfully.
The possible errors that can be raised are:
- KT-CT-3932: Invalid data.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for collecting a payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| 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) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": CollectPaymentInput
}Response
{
"data": {
"collectPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}completeStandalonePayment
Type:CompleteStandalonePayment
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Complete a 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
| Name | Description |
|---|---|
| Input fields for completing a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The completed standalone payment. |
Mutation
mutation CompleteStandalonePayment($input: CompleteStandalonePaymentInput!) {
completeStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...CompleteStandalonePaymentOutputFragment
}
}
}Variables
{
"input": CompleteStandalonePaymentInput
}Response
{
"data": {
"completeStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": CompleteStandalonePaymentOutput
}
}
}confirmDoubleOptIn
Type:ConfirmDoubleOptIn
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The consent that was created or updated. |
Mutation
mutation ConfirmDoubleOptIn($input: ConfirmDoubleOptInInput) {
confirmDoubleOptIn(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
consent {
...ConsentTypeFragment
}
}
}Variables
{
"input": ConfirmDoubleOptInInput
}Response
{
"data": {
"confirmDoubleOptIn": {
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
}
}createAccountPaymentSchedule
Type:CreateAccountPaymentSchedule
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Replace an existing payment schedule with a new one that updates either the payment amount or payment day.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3822: Unauthorized.
- KT-CT-3923: Unauthorized.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3960: Invalid value for payment day.
- KT-CT-3961: Cannot update plan-associated payment schedule.
- KT-CT-3962: No new value provided to update payment schedule.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating a payment schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| New payment schedule. |
Mutation
mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
createAccountPaymentSchedule(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": CreateAccountPaymentScheduleInput
}Response
{
"data": {
"createAccountPaymentSchedule": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}createAccountReference
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create an account reference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateAccountReference($input: AccountReferenceInput!) {
createAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...AccountReferenceTypeFragment
}
}
}Variables
{
"input": AccountReferenceInput
}Response
{
"data": {
"createAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
}
}createCentrepayDeduction
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input data for creating a new Centrepay Deduction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Details of resulting request to add a Centrepay Deduction. |
Mutation
mutation CreateCentrepayDeduction($input: CreateCentrepayDeductionInputType!) {
createCentrepayDeduction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
centrepayDeduction {
...CentrepayDeductionTypeFragment
}
}
}Variables
{
"input": CreateCentrepayDeductionInputType
}Response
{
"data": {
"createCentrepayDeduction": {
"possibleErrors": [PossibleErrorType],
"centrepayDeduction": CentrepayDeductionType
}
}
}createComplaint
Type:CreateComplaint
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The complaint that has been created. |
Mutation
mutation CreateComplaint($complaint: CreateComplaintInputType!) {
createComplaint(complaint: $complaint) {
possibleErrors {
...PossibleErrorTypeFragment
}
complaint {
...ComplaintTypeFragment
}
}
}Variables
{
"complaint": CreateComplaintInputType
}Response
{
"data": {
"createComplaint": {
"possibleErrors": [PossibleErrorType],
"complaint": ComplaintType
}
}
}Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
|
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
}
}
}createContributionAgreement
Type:CreateContributionAgreement
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a contribution agreement for an account.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-9601: Invalid data.
- KT-CT-9602: Unable to create contribution agreement.
- KT-CT-9605: Contribution amount cannot be 0 or negative.
- KT-CT-9606: Scheme is not accepting contributions at this time.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input variables needed for creating a contribution agreement on an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created contribution agreement. |
Mutation
mutation CreateContributionAgreement($input: CreateContributionAgreementInput!) {
createContributionAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
contributionAgreement {
...ContributionAgreementTypeFragment
}
}
}Variables
{
"input": CreateContributionAgreementInput
}Response
{
"data": {
"createContributionAgreement": {
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
}
}createCreditCardInstruction
Type:CreateCreditCardInstruction
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a new credit card instruction
This field requires the Authorization header to be set.
Deprecated
The 'createCreditCardInstruction' field is deprecated.
Use `storePaymentInstruction` instead.
- Marked as deprecated on 2024-02-05.
- Scheduled for removal on or after 2024-08-01.
Arguments
| Name | Description |
|---|---|
Input fields for creating a credit card instruction. |
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation CreateCreditCardInstruction($input: CreateCreditCardInstructionInput!) {
createCreditCardInstruction(input: $input) {
creditCardInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": CreateCreditCardInstructionInput
}Response
{
"data": {
"createCreditCardInstruction": {
"creditCardInstruction": DirectDebitInstructionType
}
}
}createCreditTransferPermission
Type:CreateCreditTransferPermission
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3827: The ledger is not valid.
- KT-CT-3828: At least one of the provided ledgers must be a credit storage ledger.
- KT-CT-3829: The credit transfer permission already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields to create a credit transfer permission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Datetime when the credit transfer permission is valid. |
Mutation
mutation CreateCreditTransferPermission($input: CreateCreditTransferPermissionInput!) {
createCreditTransferPermission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
validFrom
}
}Variables
{
"input": CreateCreditTransferPermissionInput
}Response
{
"data": {
"createCreditTransferPermission": {
"possibleErrors": [PossibleErrorType],
"validFrom": "2020-01-01T00:00:00.000Z"
}
}
}createCustomerFeedback
URL:https://api.essentialenergy-kraken.systems/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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created customer feedback object. |
Mutation
mutation CreateCustomerFeedback($input: CreateCustomerFeedbackInputType!) {
createCustomerFeedback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerFeedback {
...CustomerFeedbackTypeFragment
}
}
}Variables
{
"input": CreateCustomerFeedbackInputType
}Response
{
"data": {
"createCustomerFeedback": {
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
}
}createDirectDebitInstruction
Type:CreateDirectDebitInstruction
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateDirectDebitInstruction($input: CreateDirectDebitInstructionInput!) {
createDirectDebitInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
directDebitInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": CreateDirectDebitInstructionInput
}Response
{
"data": {
"createDirectDebitInstruction": {
"possibleErrors": [PossibleErrorType],
"directDebitInstruction": DirectDebitInstructionType
}
}
}createElectricitySelfMeterReads
Type:CreateCustomerSelfMeterReads
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create electricity self meter reads.
Arguments
| Name | Description |
|---|---|
| |
| Generate an account reminder for energy specialists to Trigger a billing action on the customers account. |
Return fields
| Name | Description |
|---|---|
| Electricity readings generated from input. |
| 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
}
}
}createFixedPaymentSchedule
Type:CreateFixedPaymentSchedule
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Creates a fixed payment schedule
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| The payment schedule created. |
|
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.essentialenergy-kraken.systems/v1/graphql/
Create a "form submission" entity. This is only meant to be used as a quick way of putting together a form and submit data for it, in the form of JSON - it is not expected that all form submissions will come through this path.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
|
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]
}
}
}createGasSelfMeterReads
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create gas self meter reads.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Gas readings generated from input. |
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
}
}
}createGoodsPurchase
Type:CreateGoodsPurchase
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a goods purchase.
The possible errors that can be raised are:
- KT-CT-8206: Invalid data.
- KT-CT-1131: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a purchase without a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase created. |
Mutation
mutation CreateGoodsPurchase($input: CreatePurchaseInput!) {
createGoodsPurchase(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": CreatePurchaseInput
}Response
{
"data": {
"createGoodsPurchase": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}createGoodsQuote
Type:CreateGoodsQuote
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a goods quote.
The possible errors that can be raised are:
- KT-CT-8202: Invalid data.
- KT-CT-8205: Unable to create quote.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a goods quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote created for the customer. |
Mutation
mutation CreateGoodsQuote($input: CreateGoodsQuoteInput!) {
createGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsQuote {
...GoodsQuoteFragment
}
}
}Variables
{
"input": CreateGoodsQuoteInput
}Response
{
"data": {
"createGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
}
}createGoodsQuoteWithoutAccount
Type:CreateGoodsQuoteWithoutAccount
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a goods quote without an account.
The possible errors that can be raised are:
- KT-CT-8202: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for creating a goods quote without an existing account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote created for the customer. |
Mutation
mutation CreateGoodsQuoteWithoutAccount($input: CreateGoodsQuoteWithoutAccountInput!) {
createGoodsQuoteWithoutAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsQuote {
...GoodsQuoteFragment
}
}
}Variables
{
"input": CreateGoodsQuoteWithoutAccountInput
}Response
{
"data": {
"createGoodsQuoteWithoutAccount": {
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
}
}createHardshipAgreement
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for creating a new hardship agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created hardship agreement ID. |
Mutation
mutation CreateHardshipAgreement($input: CreateHardshipAgreementInput!) {
createHardshipAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
newHardshipAgreement {
...HardshipAgreementTypeFragment
}
}
}Variables
{
"input": CreateHardshipAgreementInput
}Response
{
"data": {
"createHardshipAgreement": {
"possibleErrors": [PossibleErrorType],
"newHardshipAgreement": HardshipAgreementType
}
}
}createInkLiveChatMessage
URL:https://api.essentialenergy-kraken.systems/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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The live chat conversation. |
| The ID of the Ink Live Chat message that was created. |
Mutation
mutation CreateInkLiveChatMessage($input: CreateInkLiveChatMessageInput) {
createInkLiveChatMessage(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
liveChatConversation {
...InkLiveChatConversationFragment
}
messageRelayId
}
}Variables
{
"input": CreateInkLiveChatMessageInput
}Response
{
"data": {
"createInkLiveChatMessage": {
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation,
"messageRelayId": "abc123"
}
}
}createMfaDevice
Type:CreateMfaDevice
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create MFA Device for 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
| Name | Description |
|---|---|
| Input fields for creating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Email address to send the MFA code by default. |
| Phone number to send the MFA code by default. |
| Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Mutation
mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
createMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceEmail
devicePhone
totpSecret
}
}Variables
{
"input": CreateMfaDeviceInputType
}Response
{
"data": {
"createMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}
}
}createNewAgreementFromProductSwitchProcess
Type:CreateNewAgreementFromProductSwitchProcess
URL:https://api.essentialenergy-kraken.systems/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-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-1510: Product switch process not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Validate the product switch flow data and creates a ProcessSwitchProcess model. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new agreement created. |
Mutation
mutation CreateNewAgreementFromProductSwitchProcess($input: CreateNewAgreementFromProductSwitchProcessInput!) {
createNewAgreementFromProductSwitchProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreement {
...CommonAgreementTypeFragment
}
}
}Variables
{
"input": CreateNewAgreementFromProductSwitchProcessInput
}Response
{
"data": {
"createNewAgreementFromProductSwitchProcess": {
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}
}
}createOfferGroupForQuoting
Type:CreateOfferGroupForQuoting
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for creating an offer group from a list of offers. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Quoting Offer Group. |
Mutation
mutation CreateOfferGroupForQuoting($input: CreateOfferGroupForQuotingInput!) {
createOfferGroupForQuoting(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
offerGroup {
...CreateOfferGroupTypeFragment
}
}
}Variables
{
"input": CreateOfferGroupForQuotingInput
}Response
{
"data": {
"createOfferGroupForQuoting": {
"possibleErrors": [PossibleErrorType],
"offerGroup": CreateOfferGroupType
}
}
}createPaymentActionIntent
Type:CreatePaymentActionIntent
URL:https://api.essentialenergy-kraken.systems/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-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a payment action intent. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The action intent token. |
Mutation
mutation CreatePaymentActionIntent($input: CreatePaymentActionIntentInput!) {
createPaymentActionIntent(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
}
}Variables
{
"input": CreatePaymentActionIntentInput
}Response
{
"data": {
"createPaymentActionIntent": {
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
}
}createPaymentExtension
URL:https://api.essentialenergy-kraken.systems/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.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a payment extension for the account. |
Return fields
| Name | Description |
|---|---|
|
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
}
}
}createPaymentSchedule
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Creates a new payment schedule
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| The payment schedule created. |
Mutation
mutation CreatePaymentSchedule($input: PaymentScheduleInput!) {
createPaymentSchedule(input: $input) {
paymentSchedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": PaymentScheduleInput
}Response
{
"data": {
"createPaymentSchedule": {
"paymentSchedule": PaymentScheduleType
}
}
}createPrimaryResidence
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a new primary residence for the given user and property.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a new primary residence. |
Return fields
| Name | Description |
|---|---|
| |
|
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
}
}
}createProfileEventAndPublish
Type:CreateProfileEventAndPublish
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Mutation to publish an event for an account or account user
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
}
}
}createReferral
Type:CreateReferral
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for creating a referral. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The reward amount to be issued to the referred account, in smallest currency subunits. |
Mutation
mutation CreateReferral($input: CreateReferralInput!) {
createReferral(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
referredAccountRewardAmount
}
}Variables
{
"input": CreateReferralInput
}Response
{
"data": {
"createReferral": {
"possibleErrors": [PossibleErrorType],
"referredAccountRewardAmount": 1
}
}
}createUserAlternativeNumber
Type:CreateUserAlternativeNumber
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a new alternative phone number for the user.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| List of alternative phone numbers for the account user. |
| 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
}
}
}deleteMfaDevice
Type:DeleteMfaDevice
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Delete MFA Device for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1154: Unable to delete MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for deleting an existing multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the MFA device has been successfully deleted. |
Mutation
mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
deleteMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceDeleted
}
}Variables
{
"input": DeleteMfaDeviceInputType
}Response
{
"data": {
"deleteMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}
}
}deletePaymentSchedule
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Delete payment schedule for an account.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Account related to payment schedule. |
| 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
}
}
}deletePropertyHazardByExternalIdentifier
Type:Boolean
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Delete a property hazard by its external identifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| The external identifier of the hazard to delete. |
Return fields
| Name | Description |
|---|
Mutation
mutation DeletePropertyHazardByExternalIdentifier($externalIdentifier: ID!) {
deletePropertyHazardByExternalIdentifier(externalIdentifier: $externalIdentifier)
}Variables
{
"externalIdentifier": "abc123"
}Response
{
"data": {
"deletePropertyHazardByExternalIdentifier": true
}
}deletePropertyHazardTypeByExternalIdentifier
Type:Boolean
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Delete a property hazard type by its external identifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| The external identifier of the hazard type to delete. |
Return fields
| Name | Description |
|---|
Mutation
mutation DeletePropertyHazardTypeByExternalIdentifier($externalIdentifier: ID!) {
deletePropertyHazardTypeByExternalIdentifier(externalIdentifier: $externalIdentifier)
}Variables
{
"externalIdentifier": "abc123"
}Response
{
"data": {
"deletePropertyHazardTypeByExternalIdentifier": true
}
}deletePushNotificationBinding
Type:DeletePushNotificationBinding
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Delete a device token used for push notifications.
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-5411: Invalid token or no push notification binding found for the given account user.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for deleting a push notification binding. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation DeletePushNotificationBinding($input: DeletePushNotificationBindingInput!) {
deletePushNotificationBinding(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
status
}
}Variables
{
"input": DeletePushNotificationBindingInput
}Response
{
"data": {
"deletePushNotificationBinding": {
"possibleErrors": [PossibleErrorType],
"status": "SUCCESSFUL"
}
}
}deleteUserAlternativeNumber
Type:DeleteUserAlternativeNumber
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Delete an existing alternative phone number for the user.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| List of alternative phone numbers for the account user. |
| 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
}
}
}endContributionAgreement
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
End a contribution agreement for an account.
The possible errors that can be raised are:
- KT-CT-9603: Unable to find contribution agreement.
- KT-CT-4123: Unauthorized.
- KT-CT-9604: Unable to end contribution agreement.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for ending a contribution agreement on an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created contribution agreement. |
Mutation
mutation EndContributionAgreement($input: EndContributionAgreementInput!) {
endContributionAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
contributionAgreement {
...ContributionAgreementTypeFragment
}
}
}Variables
{
"input": EndContributionAgreementInput
}Response
{
"data": {
"endContributionAgreement": {
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
}
}enrollAccountInLoyaltyProgram
Type:EnrollAccountInLoyaltyProgram
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Enroll users account in 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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
The account number to enroll in the loyalty program. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Outcome of the loyalty points campaign enrollment. |
Mutation
mutation EnrollAccountInLoyaltyProgram($input: EnrollAccountInLoyaltyProgramInput!) {
enrollAccountInLoyaltyProgram(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
outcome {
...EnrollAccountInLoyaltyProgramOutcomeFragment
}
}
}Variables
{
"input": EnrollAccountInLoyaltyProgramInput
}Response
{
"data": {
"enrollAccountInLoyaltyProgram": {
"possibleErrors": [PossibleErrorType],
"outcome": EnrollAccountInLoyaltyProgramOutcome
}
}
}forceReauthentication
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Force users of Kraken Tokens and refresh tokens issued to the viewer to reauthenticate.
Calling this mutation will cause all Kraken Tokens and refresh tokens issued to the authenticated viewer before the mutation was called to become invalid.
Arguments
| Name | Description |
|---|---|
| Input object argument to the force-reauthentication mutation. |
Return fields
| Name | Description |
|---|---|
| Reports whether the mutation applied successfully. Should always be 'true'. |
| 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"
}
}
}getEmbeddedSecretForNewPaymentInstruction
Type:GetEmbeddedSecretForNewPaymentInstruction
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Get the client secret needed to create a new payment instruction using an embedded form.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for getting the client secret for an embedded new card payment method form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation GetEmbeddedSecretForNewPaymentInstruction($input: GetEmbeddedSecretForNewPaymentInstructionInput!) {
getEmbeddedSecretForNewPaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
secretKey
}
}Variables
{
"input": GetEmbeddedSecretForNewPaymentInstructionInput
}Response
{
"data": {
"getEmbeddedSecretForNewPaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
}
}getEmbeddedSecretForNewPaymentInstructionWithoutAccount
Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Get the client secret needed to create a new payment instruction using an embedded form without tying it to a customer.
Arguments
| Name | Description |
|---|---|
| Input fields for getting the client secret for an embedded new card payment method form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The client secret needed to create a new stored payment instruction. |
Mutation
mutation GetEmbeddedSecretForNewPaymentInstructionWithoutAccount($input: GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!) {
getEmbeddedSecretForNewPaymentInstructionWithoutAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
secretKey
}
}Variables
Response
{
"data": {
"getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
}
}getHostedUrlForNewPaymentInstruction
Type:GetHostedUrlForNewPaymentInstruction
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input fields for getting the external URL for setting up a payment instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| URL at which payment instruction can be set up. |
Mutation
mutation GetHostedUrlForNewPaymentInstruction($input: GetHostedUrlForNewPaymentInstructionInput!) {
getHostedUrlForNewPaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
url
}
}Variables
{
"input": GetHostedUrlForNewPaymentInstructionInput
}Response
{
"data": {
"getHostedUrlForNewPaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"url": "abc123"
}
}
}hasFamilyIssues
Type:HasFamilyIssues
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input variables for adding family issues details to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated account user. |
Mutation
mutation HasFamilyIssues($input: HasFamilyIssuesInputType!) {
hasFamilyIssues(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountUser {
...AccountUserTypeFragment
}
}
}Variables
{
"input": HasFamilyIssuesInputType
}Response
{
"data": {
"hasFamilyIssues": {
"possibleErrors": [PossibleErrorType],
"accountUser": AccountUserType
}
}
}initiateHostedStandalonePayment
Type:InitiateHostedStandalonePayment
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Initiate a standalone payment and return the url where the customer can complete it.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-3957: No collection method provided.
- KT-CT-3958: Provide either ledger ID or ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for initiating a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The details required to refer to and complete a hosted payment. |
Mutation
mutation InitiateHostedStandalonePayment($input: InitiateHostedStandalonePaymentInput!) {
initiateHostedStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...InitiateHostedStandalonePaymentOutputFragment
}
}
}Variables
{
"input": InitiateHostedStandalonePaymentInput
}Response
{
"data": {
"initiateHostedStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": InitiateHostedStandalonePaymentOutput
}
}
}initiateProductSwitch
URL:https://api.essentialenergy-kraken.systems/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-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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Instigate a product switch for a specific supply point given a valid product and account number. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The selected product for a specific product switch. |
| The date at which the product switch becomes effective. |
Mutation
mutation InitiateProductSwitch($input: InitiateProductSwitchInput!) {
initiateProductSwitch(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
productCode
switchDate
}
}Variables
{
"input": InitiateProductSwitchInput
}Response
{
"data": {
"initiateProductSwitch": {
"possibleErrors": [PossibleErrorType],
"productCode": "abc123",
"switchDate": "2020-01-01"
}
}
}initiateStandalonePayment
Type:InitiateStandalonePayment
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Initiate a standalone payment and return the client secret required to complete it.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for initiating a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InitiateStandalonePayment($input: InitiateStandalonePaymentInput!) {
initiateStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...InitiateStandalonePaymentOutputFragment
}
}
}Variables
{
"input": InitiateStandalonePaymentInput
}Response
{
"data": {
"initiateStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": InitiateStandalonePaymentOutput
}
}
}invalidatePaymentInstruction
Type:InvalidatePaymentInstruction
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Invalidate an existing instruction.
The possible errors that can be raised are:
- KT-CT-3926: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for invalidating a payment instruction from an embedded form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePaymentInstruction($input: InvalidatePaymentInstructionInput!) {
invalidatePaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
instruction {
...InvalidatePaymentInstructionOutputFragment
}
}
}Variables
{
"input": InvalidatePaymentInstructionInput
}Response
{
"data": {
"invalidatePaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"instruction": InvalidatePaymentInstructionOutput
}
}
}invalidatePreSignedToken
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Invalidate a previously-issued pre-signed token.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePreSignedToken($input: InvalidatePreSignedTokenInput!) {
invalidatePreSignedToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token {
...PreSignedTokenFragment
}
}
}Variables
{
"input": InvalidatePreSignedTokenInput
}Response
{
"data": {
"invalidatePreSignedToken": {
"possibleErrors": [PossibleErrorType],
"token": PreSignedToken
}
}
}joinSupplierAcceptTermsAndConditions
Type:JoinSupplierAcceptTermsAndConditions
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Accept terms and conditions for a join supplier process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Indicator that the mutation has completed successfully. |
Mutation
mutation JoinSupplierAcceptTermsAndConditions($input: JoinSupplierAcceptTermsAndConditionsInput!) {
joinSupplierAcceptTermsAndConditions(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": JoinSupplierAcceptTermsAndConditionsInput
}Response
{
"data": {
"joinSupplierAcceptTermsAndConditions": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}linkUserToLine
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Link an account user and line user together.
Arguments
| Name | Description |
|---|---|
| Input fields to link an account user with LINE. |
Return fields
| Name | Description |
|---|
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
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Make a payment with a saved credit card instruction.
This field requires the Authorization header to be set.
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-05-26.
Arguments
| Name | Description |
|---|---|
| Input fields for making a payment with a saved card. |
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation MakePaymentWithSavedCard($input: MakePaymentWithSavedCardInput!) {
makePaymentWithSavedCard(input: $input) {
accountPayment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": MakePaymentWithSavedCardInput
}Response
{
"data": {
"makePaymentWithSavedCard": {
"accountPayment": AccountPaymentType
}
}
}masqueradeAuthentication
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Provide a temporary token to get an auth token. This is intended to allow support users to view customer data through the brand interface.
Arguments
| Name | Description |
|---|---|
| The masquerade token issued by the support site. |
| The ID of the AccountUser to masquerade as. |
Return fields
| Name | Description |
|---|---|
| A Kraken Token that can be used to authenticate to the API, masquerading as the desired user. |
| 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]
}
}
}obtainKrakenToken
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create a Kraken Token (JWT) for authentication.
Provide the required input fields to obtain the token.
The token should be used as the Authorization header for any authenticated requests.
The possible errors that can be raised are:
- KT-CT-1135: Invalid data.
- KT-CT-1134: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields that can be used to obtain a Json Web Token (JWT) for authentication to the API. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Kraken Token. Can be used in the |
| The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the |
| A token that can be used in a subsequent call to |
| A Unix timestamp representing the point in time at which the refresh token will expire. |
Mutation
mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
obtainKrakenToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
payload
refreshToken
refreshExpiresIn
}
}Variables
{
"input": ObtainJSONWebTokenInput
}Response
{
"data": {
"obtainKrakenToken": {
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1
}
}
}previewAndCreatePaymentPlan
Type:PreviewAndCreatePaymentPlan
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Generates a preview for a new payment plan and creates that plan 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
| Name | Description |
|---|---|
| Input fields for creating a payment plan. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Preview payments for a new payment plan. |
| Data for newly created payment plan of one was created. |
Mutation
mutation PreviewAndCreatePaymentPlan($input: PaymentPlanInput!) {
previewAndCreatePaymentPlan(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentPlanPreview {
...PaymentPlanPreviewPaymentTypeFragment
}
createdPaymentPlan {
...PaymentPlanTypeFragment
}
}
}Variables
{
"input": PaymentPlanInput
}Response
{
"data": {
"previewAndCreatePaymentPlan": {
"possibleErrors": [PossibleErrorType],
"paymentPlanPreview": [PaymentPlanPreviewPaymentType],
"createdPaymentPlan": PaymentPlanType
}
}
}propertyMoveOut
Type:PropertyMoveOut
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Mutation to leave a property that supports CES embedded electricity market.
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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Information on the workflow which is processing the move out. |
Mutation
mutation PropertyMoveOut($input: PropertyMoveOutInput!) {
propertyMoveOut(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
workflow {
...WorkflowTypeFragment
}
}
}Variables
{
"input": PropertyMoveOutInput
}Response
{
"data": {
"propertyMoveOut": {
"possibleErrors": [PossibleErrorType],
"workflow": WorkflowType
}
}
}redeemLoyaltyPointsForAccountCredit
Type:RedeemLoyaltyPointsForAccountCredit
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Redeem the passed number of Loyalty Points as account credit.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9201: No Loyalty Point ledger found for the user.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9203: No ledger entries for the ledger.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9206: Indivisible points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for redeeming Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were redeemed. |
Mutation
mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
redeemLoyaltyPointsForAccountCredit(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsRedeemed
}
}Variables
{
"input": RedeemLoyaltyPointsInput
}Response
{
"data": {
"redeemLoyaltyPointsForAccountCredit": {
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 1
}
}
}redeemReferralClaimCode
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Redeem the referral claim code from certain referral scheme.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6724: Referral claim code not found.
- KT-CT-6725: Referral claim code redeeming error.
- KT-CT-6726: Referral claim code has already been redeemed.
- KT-CT-6727: Referral claim code is not available.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for redeeming referral code. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether or not the request was successful. |
Mutation
mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
redeemReferralClaimCode(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": RedeemReferralClaimCodeInput
}Response
{
"data": {
"redeemReferralClaimCode": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}regenerateSecretKey
Type:RegenerateSecretKey
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Regenerate the live secret key for the authenticated user.
Return fields
| Name | Description |
|---|---|
| The generated key value, which is only ever available once (here). |
| The currently authenticated user. |
Mutation
mutation RegenerateSecretKey {
regenerateSecretKey {
key
viewer {
...AccountUserTypeFragment
}
}
}Response
{
"data": {
"regenerateSecretKey": {
"key": "abc123",
"viewer": AccountUserType
}
}
}registerPushNotificationBinding
Type:RegisterPushNotificationBinding
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Register a device token to be used for push notifications for an app.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
Input fields for creating an push notification binding. |
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
registerPushNotificationBinding(input: $input) {
pushNotificationBinding {
...PushNotificationBindingTypeFragment
}
}
}Variables
{
"input": RegisterPushNotificationBindingInput
}Response
{
"data": {
"registerPushNotificationBinding": {
"pushNotificationBinding": PushNotificationBindingType
}
}
}removeConcession
Type:RemoveConcession
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Mutation to remove a concession for a user account
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation RemoveConcession($input: RemoveConcessionInput!) {
removeConcession(input: $input) {
concession {
...ConcessionTypeFragment
}
}
}Variables
{
"input": RemoveConcessionInput
}Response
{
"data": {
"removeConcession": {
"concession": ConcessionType
}
}
}replaceLatestPaymentSchedule
Type:ReplaceLatestPaymentSchedule
URL:https://api.essentialenergy-kraken.systems/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.
Arguments
| Name | Description |
|---|---|
Input fields for replacing the active payment schedule. |
Return fields
| Name | Description |
|---|---|
| The payment schedule that was replaced. |
| 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
}
}
}requestCadReport
Type:RequestCADReport
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The account. |
| Whether the email with the data was sent. |
Mutation
mutation RequestCadReport($input: RequestCADReportInputType!) {
requestCadReport(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
successful
}
}Variables
{
"input": RequestCADReportInputType
}Response
{
"data": {
"requestCadReport": {
"possibleErrors": [PossibleErrorType],
"account": AccountType,
"successful": true
}
}
}requestDoubleOptIn
Type:RequestDoubleOptIn
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Request a double opt in
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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The consent that was created or updated. |
Mutation
mutation RequestDoubleOptIn($input: DoubleOptInInput) {
requestDoubleOptIn(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
consent {
...ConsentTypeFragment
}
}
}Variables
{
"input": DoubleOptInInput
}Response
{
"data": {
"requestDoubleOptIn": {
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
}
}requestPasswordReset
Type:RequestPasswordResetOutputType
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for requesting a password reset email. |
Return fields
| Name | Description |
|---|---|
| The email that requested a password reset email. |
| 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.essentialenergy-kraken.systems/v1/graphql/
Request an issued bill to be printed and (re)posted to billing address of the account.
The possible errors that can be raised are:
- KT-CT-3824: Unauthorized.
- KT-CT-9705: The billing document has not been issued.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields to request a printed bill. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the request was successful. |
Mutation
mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
requestPrintedBill(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": RequestPrintedBillInput
}Response
{
"data": {
"requestPrintedBill": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}reschedulePayment
Type:ReschedulePayment
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Reschedule an existing payment by a certain number of days
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
| Input fields for rescheduling a payment. |
Return fields
| Name | Description |
|---|---|
| |
|
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
}
}
}resetPassword
Type:ResetPasswordMutationPayload
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Reset the password of an account user indicated by the userId to the value supplied.
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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
|
Mutation
mutation ResetPassword($input: ResetPasswordMutationInput!) {
resetPassword(input: $input) {
errors {
...SerializerFieldErrorsTypeFragment
}
clientMutationId
}
}Variables
{
"input": ResetPasswordMutationInput
}Response
{
"data": {
"resetPassword": {
"errors": [SerializerFieldErrorsType],
"clientMutationId": "abc123"
}
}
}resetUserPassword
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for resetting an account user's password. |
Return fields
| Name | Description |
|---|---|
| The ID of the user whose password was changed. |
| True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
| A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
| A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
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"]
}
}
}scheduleQuoteFollowUp
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Schedule a quote follow-up to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4632: Invalid recipient information.
- KT-CT-4633: Mutation not enabled in this environment.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the message was scheduled successfully. |
Mutation
mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
scheduleQuoteFollowUp(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": QuoteShareInput
}Response
{
"data": {
"scheduleQuoteFollowUp": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}setLoyaltyPointsUser
Type:SetLoyaltyPointsUser
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Set the Loyalty Point user for the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9214: Couldn't assign user loyalty points role.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for saving the Loyalty Points user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| ID of the new Loyalty Points user. |
Mutation
mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
setLoyaltyPointsUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
newLoyaltyPointsUserId
}
}Variables
{
"input": SetLoyaltyPointsUserInput
}Response
{
"data": {
"setLoyaltyPointsUser": {
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "abc123"
}
}
}setUpDirectDebitInstruction
Type:SetUpDirectDebitInstruction
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
setUpDirectDebitInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionInput
}Response
{
"data": {
"setUpDirectDebitInstruction": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}setUpDirectDebitInstructionForBusiness
Type:SetUpDirectDebitInstructionForBusiness
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created direct debit instruction. |
Mutation
mutation SetUpDirectDebitInstructionForBusiness($input: SetUpDirectDebitInstructionForBusinessInput!) {
setUpDirectDebitInstructionForBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionForBusinessInput
}Response
{
"data": {
"setUpDirectDebitInstructionForBusiness": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}setUpDirectDebitInstructionFromStoredDetails
Type:SetUpDirectDebitInstructionFromStoredDetails
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Input fields for creating a new direct debit instruction from stored details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The payment instruction that was created from stored details. |
Mutation
mutation SetUpDirectDebitInstructionFromStoredDetails($input: SetUpDirectDebitInstructionFromStoredDetailsInput!) {
setUpDirectDebitInstructionFromStoredDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionFromStoredDetailsInput
}Response
{
"data": {
"setUpDirectDebitInstructionFromStoredDetails": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}shareGoodsQuote
Type:ShareGoodsQuote
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Share a goods quote.
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-8203: Received an invalid quote code.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for sharing a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote shared. |
Mutation
mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
shareGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
share {
...GoodsQuoteShareFragment
}
}
}Variables
{
"input": ShareGoodsQuoteInput
}Response
{
"data": {
"shareGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}
}
}startCustomerVerification
Type:StartCustomerVerification
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly created verification process. |
Mutation
mutation StartCustomerVerification($input: StartCustomerVerificationInput!) {
startCustomerVerification(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
verificationProcess {
...VerificationProcessFragment
}
}
}Variables
{
"input": StartCustomerVerificationInput
}Response
{
"data": {
"startCustomerVerification": {
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}
}
}storeDirectDebitPaymentMethodDetails
Type:StoreDirectDebitPaymentMethodDetails
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Store bank details with the vendor. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation StoreDirectDebitPaymentMethodDetails($input: StoreDirectDebitPaymentMethodDetailsInput!) {
storeDirectDebitPaymentMethodDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
storedPaymentMethodDetailsReference
}
}Variables
{
"input": StoreDirectDebitPaymentMethodDetailsInput
}Response
{
"data": {
"storeDirectDebitPaymentMethodDetails": {
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "abc123"
}
}
}storePaymentInstruction
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for storing a new payment instruction created through the embedded process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The stored payment instruction. |
Mutation
mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
storePaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...PaymentInstructionTypeFragment
}
}
}Variables
{
"input": StorePaymentInstructionInput
}Response
{
"data": {
"storePaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}
}
}submitCustomerFeedback
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Submit customer feedback.
The possible errors that can be raised are:
- KT-CT-5514: Unable to submit feedback.
- KT-CT-5511: The feedback_id should be provided for feedback source.
- KT-CT-5512: The feedback doesn't match the account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
submitCustomerFeedback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerFeedback {
...CustomerFeedbackTypeFragment
}
}
}Variables
{
"input": CustomerFeedbackInputType
}Response
{
"data": {
"submitCustomerFeedback": {
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
}
}submitMeterReadings
Type:SubmitMeterReadings
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Submit meter readings for one or more meters.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-6422: Reading will be held.
- KT-CT-6425: Unable to create the meter reading.
- KT-CT-6434: Meter reading could not be updated. Input not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for submitting meter readings. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The submitted readings. |
Mutation
mutation SubmitMeterReadings($input: SubmitMeterReadingsInputType!) {
submitMeterReadings(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
readings {
...ReadingTypeFragment
}
}
}Variables
{
"input": SubmitMeterReadingsInputType
}Response
{
"data": {
"submitMeterReadings": {
"possibleErrors": [PossibleErrorType],
"readings": [ReadingType]
}
}
}submitRepaymentRequest
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for requesting a repayment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly created repayment request. |
Mutation
mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
submitRepaymentRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentRequest {
...RequestRepaymentOutputTypeFragment
}
}
}Variables
{
"input": RequestRepaymentInputType
}Response
{
"data": {
"submitRepaymentRequest": {
"possibleErrors": [PossibleErrorType],
"repaymentRequest": RequestRepaymentOutputType
}
}
}terminateCreditTransferPermission
Type:TerminateCreditTransferPermission
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Terminate credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3825: Credit transfer permission not found.
- KT-CT-3827: The ledger is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for terminating a credit transfer permission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Datetime when the credit transfer permission ends. |
Mutation
mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
terminateCreditTransferPermission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
validTo
}
}Variables
{
"input": TerminateCreditTransferPermissionInput
}Response
{
"data": {
"terminateCreditTransferPermission": {
"possibleErrors": [PossibleErrorType],
"validTo": "2020-01-01T00:00:00.000Z"
}
}
}transferLoyaltyPointsBetweenUsers
Type:TransferLoyaltyPointsBetweenUsers
URL:https://api.essentialenergy-kraken.systems/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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for transferring Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were transferred. |
Mutation
mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
transferLoyaltyPointsBetweenUsers(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsTransferred
}
}Variables
{
"input": TransferLoyaltyPointsBetweenUsersInput
}Response
{
"data": {
"transferLoyaltyPointsBetweenUsers": {
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 1
}
}
}triggerElectricityHouseMoveOut
Type:TriggerElectricityHouseMoveOut
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Mutation to trigger an electricity house move out process for a related account.
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
| Name | Description |
|---|---|
The input required to trigger the electricity house move out process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The workflow information which can be used to track the async processing progress. |
The error encountered when trying to trigger the electricity house move out process, if any. |
Mutation
mutation TriggerElectricityHouseMoveOut($input: TriggerElectricityHouseMoveOutInput!) {
triggerElectricityHouseMoveOut(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
workflow {
...WorkflowTypeFragment
}
error {
... on UnableToDeterminePhoneContactDetailsErrorType {
...UnableToDeterminePhoneContactDetailsErrorTypeFragment
}
... on CouldNotStartWorkflowErrorType {
...CouldNotStartWorkflowErrorTypeFragment
}
... on ValidationErrorType {
...ValidationErrorTypeFragment
}
... on DoesNotExistErrorType {
...DoesNotExistErrorTypeFragment
}
... on MultipleObjectsReturnedErrorType {
...MultipleObjectsReturnedErrorTypeFragment
}
}
}
}Variables
{
"input": TriggerElectricityHouseMoveOutInput
}Response
{
"data": {
"triggerElectricityHouseMoveOut": {
"possibleErrors": [PossibleErrorType],
"workflow": WorkflowType,
"error": UnableToDeterminePhoneContactDetailsErrorType
}
}
}triggerGasHouseMoveOut
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Mutation to trigger a gas house move out process for a related account.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| The workflow information which can be used to track the async processing progress. |
|
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
}
}
}unlinkUserFromLine
Type:UnlinkUserFromLineResponse!
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Unlink an account user and line together.
Return fields
| Name | Description |
|---|
Mutation
mutation UnlinkUserFromLine {
unlinkUserFromLine {
... on LineUnlinkedResponse {
...LineUnlinkedResponseFragment
}
... on LinkTokenNotFound {
...LinkTokenNotFoundFragment
}
... on LineCommonError {
...LineCommonErrorFragment
}
}
}Response
{
"data": {
"unlinkUserFromLine": LineUnlinkedResponse
}
}updateAccountAddress
Type:UpdateAccountAddressMutation
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update address in legacy format for a single account.
Arguments
| Name | Description |
|---|---|
| The list of account numbers on which the address is to be updated. |
| New billing address for user accounts. |
| The user for whom to perform the update. This is only needed when using an Organisation role. |
Return fields
| Name | Description |
|---|---|
| The currently authenticated user. This field requires the |
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.essentialenergy-kraken.systems/v1/graphql/
Update the account billing address.
The possible errors that can be raised are:
- KT-CT-4145: Invalid address.
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input variables needed for updating an account billing address. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated account. |
Mutation
mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
updateAccountBillingAddress(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": AccountBillingAddressInput
}Response
{
"data": {
"updateAccountBillingAddress": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}updateAccountBillingEmail
Type:UpdateAccountBillingEmail
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update account billing email.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating billing email for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account that was changed. |
Mutation
mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
updateAccountBillingEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
}
}Variables
{
"input": UpdateAccountBillingEmailInput
}Response
{
"data": {
"updateAccountBillingEmail": {
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
}
}updateAccountConsents
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update the consents of an account
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9018: Account not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| The account number to update consents for. |
| Consents to update for account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Consents linked to this account. |
Mutation
mutation UpdateAccountConsents(
$accountNumber: String!,
$consents: [ConsentInput]!
) {
updateAccountConsents(
accountNumber: $accountNumber,
consents: $consents
) {
possibleErrors {
...PossibleErrorTypeFragment
}
consents {
...ConsentTypeFragment
}
}
}Variables
{
"accountNumber": "abc123",
"consents": ConsentInput
}Response
{
"data": {
"updateAccountConsents": {
"possibleErrors": [PossibleErrorType],
"consents": ConsentType
}
}
}updateAccountElectricityProduct
Type:UpdateAccountElectricityProduct
URL:https://api.essentialenergy-kraken.systems/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.
Arguments
| Name | Description |
|---|---|
Input fields for switching account electricity product. |
Return fields
| Name | Description |
|---|---|
| |
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 AccountDoesNotHaveEmailErrorType {
...AccountDoesNotHaveEmailErrorTypeFragment
}
... on InvalidAddonErrorType {
...InvalidAddonErrorTypeFragment
}
}
}
}Variables
{
"input": UpdateAccountElectricityProductInput
}Response
{
"data": {
"updateAccountElectricityProduct": {
"account": AccountType,
"error": UnsupportedBrandErrorType
}
}
}updateAccountGasProduct
URL:https://api.essentialenergy-kraken.systems/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.
Arguments
| Name | Description |
|---|---|
| Input fields for switching account gas product. |
Return fields
| Name | Description |
|---|---|
| |
|
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 InvalidAddonErrorType {
...InvalidAddonErrorTypeFragment
}
... on CanNotCreateAgreementErrorType {
...CanNotCreateAgreementErrorTypeFragment
}
}
}
}Variables
{
"input": UpdateAccountGasProductInput
}Response
{
"data": {
"updateAccountGasProduct": {
"account": AccountType,
"error": UnsupportedBrandErrorType
}
}
}updateAccountReference
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update an account reference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateAccountReference($input: AccountReferenceInput!) {
updateAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...AccountReferenceTypeFragment
}
}
}Variables
{
"input": AccountReferenceInput
}Response
{
"data": {
"updateAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
}
}updateAccountRichAddress
Type:UpdateAccountRichAddressMutation
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update address for a single 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
| Name | Description |
|---|---|
| The list of account numbers on which the address is to be updated. |
| New billing address for user accounts. |
| The user for whom to perform the update. This is only needed when using an Organisation role. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. This field requires the |
Mutation
mutation UpdateAccountRichAddress(
$accounts: [String],
$address: RichAddressInput!,
$userId: String
) {
updateAccountRichAddress(
accounts: $accounts,
address: $address,
userId: $userId
) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"accounts": ["abc123"],
"address": RichAddressInput,
"userId": "abc123"
}Response
{
"data": {
"updateAccountRichAddress": {
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
}
}updateAccountUserConsents
Type:UpdateAccountUserConsents
URL:https://api.essentialenergy-kraken.systems/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-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Consents to update for account user. |
| User number of the account user to update consents for. Only needed if the viewer is an organization. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| All the consents for an account user. |
Mutation
mutation UpdateAccountUserConsents(
$consents: [ConsentTypeInput],
$userNumber: String
) {
updateAccountUserConsents(
consents: $consents,
userNumber: $userNumber
) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountUserConsents {
...AccountUserConsentsFragment
}
}
}Variables
{
"consents": ConsentTypeInput,
"userNumber": "abc123"
}Response
{
"data": {
"updateAccountUserConsents": {
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}
}
}updateActivePurchase
Type:UpdateActivePurchase
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update an active purchase.
The possible errors that can be raised are:
- KT-CT-8225: Received an invalid purchaseId.
- KT-CT-8226: The provided purchase is not active.
- KT-CT-8206: Invalid data.
- KT-CT-8227: Available grants could not be applied.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating an active purchase. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase updated. |
Mutation
mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
updateActivePurchase(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": UpdatePurchaseInput
}Response
{
"data": {
"updateActivePurchase": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}updateAutoTopUpAmount
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for updating the auto-top-up amount for a schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new schedule created. |
Mutation
mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
updateAutoTopUpAmount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": UpdateAutoTopUpAmountInput
}Response
{
"data": {
"updateAutoTopUpAmount": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}updateCommsDeliveryPreference
Type:UpdateCommsDeliveryPreference
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update account communication delivery preference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4136: Cannot set comms preference to email when account has no email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Input fields for updating comms delivery preferences for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
updateCommsDeliveryPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
}
}Variables
{
"input": UpdateCommsDeliveryPreferenceInput
}Response
{
"data": {
"updateCommsDeliveryPreference": {
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
}
}updateCommsPreferences
Type:UpdateAccountUserCommsPreferencesMutationPayload
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update the comms preferences of the account user (the authenticated user).
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Mutation
mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
updateCommsPreferences(input: $input) {
isOptedInToClientMessages
isOptedInToOfferMessages
isOptedInToRecommendedMessages
isOptedInToUpdateMessages
isOptedInToThirdPartyMessages
isOptedInMeterReadingConfirmations
isOptedInToSmsMessages
isUsingInvertedEmailColours
fontSizeMultiplier
emailFormat
preferredHoldMusic
errors {
...ErrorTypeFragment
}
commsPreferences {
...AccountUserCommsPreferencesFragment
}
clientMutationId
}
}Variables
{
"input": UpdateAccountUserCommsPreferencesMutationInput
}Response
{
"data": {
"updateCommsPreferences": {
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"errors": [ErrorType],
"commsPreferences": AccountUserCommsPreferences,
"clientMutationId": "abc123"
}
}
}Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation UpdateConcession($input: UpdateConcessionInput!) {
updateConcession(input: $input) {
concession {
...ConcessionTypeFragment
}
}
}Variables
{
"input": UpdateConcessionInput
}Response
{
"data": {
"updateConcession": {
"concession": ConcessionType
}
}
}updateDocumentAccessibilityPreference
Type:UpdateDocumentAccessibilityPreference!
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update the document accessibility preference for an 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
| Name | Description |
|---|---|
Input fields for updating document accessibility preference for an account. |
Return fields
| Name | Description |
|---|
Mutation
mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
updateDocumentAccessibilityPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountTypeFragment
}
}
}Variables
{
"input": UpdateDocumentAccessibilityPreferenceInput
}Response
{
"data": {
"updateDocumentAccessibilityPreference": {
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
}
}updateElecMeterPointAccessDetails
Type:UpdateElecMeterPointAccessDetails
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The target meter point. |
Mutation
mutation UpdateElecMeterPointAccessDetails($input: UpdateElecMeterPointAccessDetailsInputType) {
updateElecMeterPointAccessDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
meterPoint {
...MeterPointTypeFragment
}
}
}Variables
{
"input": UpdateElecMeterPointAccessDetailsInputType
}Response
{
"data": {
"updateElecMeterPointAccessDetails": {
"possibleErrors": [PossibleErrorType],
"meterPoint": MeterPointType
}
}
}updateExportPaymentMethod
Type:UpdateExportPaymentMethod
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update the method of payment for a solar export repayment.
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
| Name | Description |
|---|---|
| Input fields for updating the method of payment for a solar export repayment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Updated export repayment details. |
Mutation
mutation UpdateExportPaymentMethod($input: UpdateExportPaymentMethodInput!) {
updateExportPaymentMethod(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
exportRepaymentDetails {
...ExportRepaymentDetailsTypeFragment
}
}
}Variables
{
"input": UpdateExportPaymentMethodInput
}Response
{
"data": {
"updateExportPaymentMethod": {
"possibleErrors": [PossibleErrorType],
"exportRepaymentDetails": ExportRepaymentDetailsType
}
}
}updateHardshipAgreement
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for updating an existing hardship agreement. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated hardship agreement. |
Mutation
mutation UpdateHardshipAgreement($input: UpdateHardshipAgreementInput!) {
updateHardshipAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
updatedHardshipAgreement {
...HardshipAgreementTypeFragment
}
}
}Variables
{
"input": UpdateHardshipAgreementInput
}Response
{
"data": {
"updateHardshipAgreement": {
"possibleErrors": [PossibleErrorType],
"updatedHardshipAgreement": HardshipAgreementType
}
}
}updateMetadata
Type:UpdateMetadata
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update metadata on an object.
The possible errors that can be raised are:
- KT-CT-4323: 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
| Name | Description |
|---|---|
| Input fields for updating metadata. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateMetadata($input: MetadataInput!) {
updateMetadata(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
metadata {
...MetadataFragment
}
}
}Variables
{
"input": MetadataInput
}Response
{
"data": {
"updateMetadata": {
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}
}
}updatePassword
Type:UpdatePassword
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. This field requires the |
Mutation
mutation UpdatePassword($input: UpdatePasswordInput) {
updatePassword(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"input": UpdatePasswordInput
}Response
{
"data": {
"updatePassword": {
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
}
}updatePaymentSchedule
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update a payment schedule for an account.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Updated payment schedule. |
| 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
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update an existing primary residence for the given user and property.
Arguments
| Name | Description |
|---|---|
| Input fields for updating a primary residence. |
Return fields
| Name | Description |
|---|---|
| The updated primary residence. |
| 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.essentialenergy-kraken.systems/v1/graphql/
Mutation to trigger an update the date of house move in or out
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
}
}
}updateUser
Type:UpdateUserMutation
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| Input fields for updating user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"input": UpdateUserInput
}Response
{
"data": {
"updateUser": {
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
}
}updateUserAddress
Type:UpdateUserAddressMutation
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Update address in legacy format for all accounts for this user.
Arguments
| Name | Description |
|---|---|
| New billing address for user accounts. |
Return fields
| Name | Description |
|---|---|
| The currently authenticated user. This field requires the |
Mutation
mutation UpdateUserAddress($address: UpdateAddressInput!) {
updateUserAddress(address: $address) {
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"address": UpdateAddressInput
}Response
{
"data": {
"updateUserAddress": {
"viewer": AccountUserType
}
}
}updateUserDetails
Type:UpdateAccountUserMutationPayload
URL:https://api.essentialenergy-kraken.systems/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.
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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
Mutation
mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
updateUserDetails(input: $input) {
givenName
familyName
pronouns
mobile
email
dateOfBirth
landline
errors {
...ErrorTypeFragment
}
clientMutationId
}
}Variables
{
"input": UpdateAccountUserMutationInput
}Response
{
"data": {
"updateUserDetails": {
"givenName": "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.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
| New billing address for user accounts. |
| The user id to change data for. Only required when the mutation is called by an organisation. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. This field requires the |
Mutation
mutation UpdateUserRichAddress(
$address: RichAddressInput!,
$userId: ID
) {
updateUserRichAddress(
address: $address,
userId: $userId
) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...AccountUserTypeFragment
}
}
}Variables
{
"address": RichAddressInput,
"userId": "abc123"
}Response
{
"data": {
"updateUserRichAddress": {
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
}
}upsertPropertyHazardByExternalIdentifier
Type:UpsertPropertyHazardByExternalIdentifier
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create or update a property hazard by its external identifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-12609: Property Hazard Type not found.
- KT-CT-12612: Property not found.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
Input variables needed for upserting a property hazard. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The upserted property hazard. |
Mutation
mutation UpsertPropertyHazardByExternalIdentifier($input: UpsertPropertyHazardByExternalIdentifierInputType!) {
upsertPropertyHazardByExternalIdentifier(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
propertyHazard {
...UpsertPropertyHazardByExternalIdentifierOutputTypeFragment
}
}
}Variables
{
"input": UpsertPropertyHazardByExternalIdentifierInputType
}Response
{
"data": {
"upsertPropertyHazardByExternalIdentifier": {
"possibleErrors": [PossibleErrorType],
"propertyHazard": UpsertPropertyHazardByExternalIdentifierOutputType
}
}
}upsertPropertyHazardByExternalIdentifierAndNmi
Type:UpsertPropertyHazardByExternalIdentifierAndNmi
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create or update a property hazard by its external identifier.
This API exists for backwards compatibility, but shouldn't be used in favour of UpsertPropertyHazardByExternalIdentifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-12608: Supply point not found.
- KT-CT-12609: Property Hazard Type not found.
- KT-CT-12610: Supply point has no associated property.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input variables needed for upserting a property hazard. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The upserted property hazard. |
Mutation
mutation UpsertPropertyHazardByExternalIdentifierAndNmi($input: UpsertPropertyHazardByExternalIdentifierAndNmiInputType!) {
upsertPropertyHazardByExternalIdentifierAndNmi(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
propertyHazard {
...UpsertPropertyHazardByExternalIdentifierOutputTypeFragment
}
}
}Variables
Response
{
"data": {
"upsertPropertyHazardByExternalIdentifierAndNmi": {
"possibleErrors": [PossibleErrorType],
"propertyHazard": UpsertPropertyHazardByExternalIdentifierOutputType
}
}
}upsertPropertyHazardTypeByExternalIdentifier
Type:UpsertPropertyHazardTypeByExternalIdentifier
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Create or update a property hazard type by its external identifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-12611: Property Hazard Type code already exists.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input variables needed for upserting a property hazard type. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The upserted property hazard type. |
Mutation
mutation UpsertPropertyHazardTypeByExternalIdentifier($input: UpsertPropertyHazardTypeByExternalIdentifierInputType!) {
upsertPropertyHazardTypeByExternalIdentifier(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
propertyHazardType {
...PropertyHazardTypeOutputTypeFragment
}
}
}Variables
Response
{
"data": {
"upsertPropertyHazardTypeByExternalIdentifier": {
"possibleErrors": [PossibleErrorType],
"propertyHazardType": PropertyHazardTypeOutputType
}
}
}Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
|
Mutation
mutation ValidateConcession($input: ValidateConcessionInput!) {
validateConcession(input: $input) {
concession {
...ConcessionTypeFragment
}
}
}Variables
{
"input": ValidateConcessionInput
}Response
{
"data": {
"validateConcession": {
"concession": ConcessionType
}
}
}validateMfaDevice
Type:ValidateMfaDevice
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Validate MFA Device for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1151: MFA device not found.
- KT-CT-1152: Invalid MFA token.
- KT-CT-1155: Enabled backup device is needed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for validating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the device has been verified, so it can be used for MFA. |
Mutation
mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
validateMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceIsValid
}
}Variables
{
"input": ValidateMfaDeviceInputType
}Response
{
"data": {
"validateMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}
}
}verifyCustomer
Type:VerifyCustomer
URL:https://api.essentialenergy-kraken.systems/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
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. |
Mutation
mutation VerifyCustomer($input: VerifyCustomerInput!) {
verifyCustomer(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
user {
...AccountUserTypeFragment
}
}
}Variables
{
"input": VerifyCustomerInput
}Response
{
"data": {
"verifyCustomer": {
"possibleErrors": [PossibleErrorType],
"user": AccountUserType
}
}
}verifyIdentity
Type:VerifyIdentity
URL:https://api.essentialenergy-kraken.systems/v1/graphql/
Provide identifying information about an account and user to get a scoped token that will permit access to associate an email address with the account's user.
The possible errors that can be raised are:
- KT-CT-1145: Account/user details do not match.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Details about the user to be verified. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An expiring token that can be used to request to update the user's email address. |
Mutation
mutation VerifyIdentity($input: VerifyIdentityInput!) {
verifyIdentity(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
}
}Variables
{
"input": VerifyIdentityInput
}Response
{
"data": {
"verifyIdentity": {
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
}
}