Objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
API Site
Fields
Name | Description |
---|---|
|
The API type effected by this brownout. |
|
For GraphQL APIs this will be a field identifier in the format |
|
The iso formatted datetime at which this brownout will end. |
|
The iso formatted datetime at which this brownout will take effect. |
|
The current status of this brownout. |
Example
{
"disablesRequestsTo": NonEmptyString,
"status": "SCHEDULED",
"apiType": "GRAPHQL",
"startsAt": NonEmptyString,
"endsAt": NonEmptyString
}
APIBrownoutConnection
Paginator of API brownouts.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": APIBrownoutEdge,
"totalCount": 1,
"edgeCount": 1
}
APIBrownoutEdge
A Relay edge containing a APIBrownout
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": APIBrownout,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Storage for the API client to submit any contextual information. |
|
The request's correlation id. |
|
|
|
|
|
Input data for the API call if any. |
|
Free field for the API caller to categorise their own operation name. This field can be used to filter entries on the UI. |
|
The response from the API call if any. |
Example
{
"id": "abc123",
"correlationId": "abc123",
"operationName": "abc123",
"inputData": {"key": "value"},
"response": {"key": "value"},
"context": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z"
}
APIExceptionConnectionTypeConnection
Paginator of API exceptions.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": APIExceptionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
APIExceptionConnectionTypeEdge
A Relay edge containing a APIExceptionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": APIExceptionType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The category of the event. |
|
A JSON context to be provided with the event, if any. |
|
|
|
A description of the event. |
|
The type of the event. |
|
Example
{
"id": "abc123",
"eventType": "abc123",
"category": "abc123",
"description": "abc123",
"context": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The content of the API Exception note. |
|
Timestamp of when the API Exception note was created. |
|
The ID of the API Exception note. |
Example
{
"id": "abc123",
"body": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The account number provided to the exception. |
|
The API calls associated with this exception if any. |
|
The user assigned to handle this exception if any. |
|
Category associated with this exception. |
|
Free field for the API caller to categorise a channel. This could be (but not limited to) the client's team that calleded the API, the name of the 'flow' the call belongs to, etc. |
|
Storage for the API client to submit any contextual information. |
|
|
|
The customer contact provided to the exception. |
|
The events associated with this exception if any. |
|
External identifier submitted by the API client to track this exception on their end. |
|
|
|
The key date associated with the exception, if available. |
|
Notes associated with this exception if any. |
|
The operations team assigned to this exception if any. |
|
The current priority for the API exception. |
|
The current resolution status for the API exception. |
|
The current resolution type for the API exception. |
|
The supply point identifier provided to the exception. |
|
Tags associated with this exception if any. |
|
The user id provided to the exception. |
Example
{
"id": "abc123",
"externalIdentifier": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"channel": "abc123",
"category": "UNKNOWN",
"accountNumber": "abc123",
"userId": 1,
"customerContact": "abc123",
"supplyPointIdentifier": "abc123",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"apiCalls": [APICallType],
"events": [APIExceptionEventType],
"tags": "MOVE_IN",
"notes": [APIExceptionNoteType],
"operationsTeam": OperationsTeamType,
"context": {"key": "value"},
"keyDate": "2020-01-01",
"assignedUser": AssignedUserType
}
AcceptGoodsQuote
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.
Fields
Name | Description |
---|---|
|
Goods purchase created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
AcceptOfferForQuoting
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.
Fields
Name | Description |
---|---|
|
Accepted quoting offer. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"offer": OfferType
}
AcceptQuote
Accepts a quote and creates objects like account, agreements and activation processes. Initializes switch-in workflows for each activation process.
The possible errors that can be raised are:
- KT-CT-1132: Unauthorized.
- KT-CT-3811: Invalid IBAN.
- KT-FR-3814: Invalid payment day.
- KT-CT-4121: Invalid phone number.
- KT-CT-4122: Invalid email.
- KT-CT-4137: Invalid Title.
- KT-CT-4321: Serializer validation error.
- KT-CT-4321: Serializer validation error.
- KT-CT-4410: Invalid postcode.
- KT-CT-5412: No account user exists with the given id.
- KT-CT-6710: Unable to create referral.
- KT-FR-4110: Age incorrect.
- KT-FR-4113: Invalid name.
- KT-FR-4114: Account not found.
- KT-FR-4611: T&C not accepted or not acceptable.
- KT-FR-4612: Unable to create agreement.
- KT-FR-4616: Supply start date invalid.
- KT-FR-4617: Incompatible subscription type.
- KT-FR-4618: The quote request has already been accepted.
- KT-FR-4622: Unexpected error while accepting a quote.
- KT-FR-4623: Withdrawal period is mandatory for this sale.
- KT-FR-4712: Invalid meter readings data.
- KT-FR-4713: Invalid data. Reading date cannot be in the future.
- KT-FR-7712: Invalid affiliate session.
- KT-FR-7713: Authenticated organizations should not use affiliate sessions.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
The created account number. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The authentication token allowing the quote to be checked out. |
|
Newly created supply contracts. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123",
"supplyContracts": SupplyContractConnectionTypeConnection,
"preSignedKey": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountApplicationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountApplicationConnectionTypeEdge
A Relay edge containing a AccountApplicationConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountApplicationType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Last day of the cooling off period. Barring changes or objections, the account will be gained on the next business day after this date. This value will only be returned for current applications. |
|
Date at which this account decided to switch to us. |
|
Whether this account application represents a migration into the current system or a regular gain. |
|
The source system for a migrated account. This could be the previous supplier or the previous account management system. |
|
Preferred supply start date. If null, it means ASAP. |
|
|
|
The sales subchannel used when signing up. This could for example be a price comparison site. |
|
Example
{
"status": "CURRENT",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"dateOfSale": "2020-01-01",
"coolingOffEndDate": "2020-01-01",
"isMigrated": true,
"migrationSource": "abc123",
"preferredSsd": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
Debit details. |
|
Credit details. |
|
Balance transfer ID. |
|
The reason for the balance transfer. |
Example
{
"id": "abc123",
"accountCharge": AccountChargeType,
"accountCredit": AccountCreditType,
"reason": "abc123"
}
AccountCampaignConnectionTypeConnection
Paginator of Account Campaigns
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountCampaignConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountCampaignConnectionTypeEdge
A Relay edge containing a AccountCampaignConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountCampaignType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The date on which the associated campaign itself concludes. |
|
The date on which the account's participation in the campaign ends. |
|
The name of the campaign. |
|
The slug of the campaign. |
|
The date that the account's link to the campaign started. |
Example
{
"campaignExpiryDate": "2020-01-01",
"name": "abc123",
"slug": "abc123",
"expiryDate": "2020-01-01",
"startDate": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
A JSON object containing unstructured data about the account charge. |
|
The date and time the metadata was last updated. |
Example
{
"data": {"key": "value"},
"updatedAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The climate change levy amount of the charge. |
|
The display note for the charge. |
|
The gross amount of the charge. |
|
The ID of the account charge. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The net amount of the charge. |
|
The note for the charge. |
|
The reason for the charge. |
|
The sales tax amount of the charge. |
Example
{
"id": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"reason": "abc123",
"note": "abc123",
"displayNote": "abc123",
"metadata": AccountChargeMetadataType
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountConnectionTypeEdge
A Relay edge containing a AccountConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"data": {"key": "value"},
"updatedAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"note": "abc123",
"reason": "abc123",
"metadata": AccountCreditMetadataType
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountEventConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountEventConnectionTypeEdge
A Relay edge containing a AccountEventConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountEvent,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
The ID of the object |
|
Is the file ready for use / downloadable? |
|
Is the file uploaded to S3? |
|
Example
{
"id": "abc123",
"filename": "abc123",
"category": "abc123",
"isUploaded": true,
"isReady": true,
"fetchUrl": "abc123",
"sizeInBytes": 1
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountFileAttachmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountFileAttachmentConnectionTypeEdge
A Relay edge containing a AccountFileAttachmentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountFileAttachment,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Whether account is eligible to register devices with Intelligent Octopus or not. |
Example
{
"isEligibleForIo": true
}
Fields
Name | Description |
---|---|
|
The number of loyalty points the account (or user with the given id) has. |
|
The net monetary value of the loyalty points in the currency's sub-units. |
Example
{
"loyaltyPoints": 1,
"totalMonetaryAmount": 1
}
Example
{
"body": "abc123",
"isPinned": true,
"createdAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountPaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountPaymentConnectionTypeEdge
A Relay edge containing a AccountPaymentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountPaymentType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Amount of payment in pence |
|
|
|
The date this payment is scheduled to be debited |
|
The payment instruction that was used to make this payment. |
|
|
|
The current status of the payment. |
|
Surcharge amount generated by this payment. |
|
The transaction type of the payment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"reference": "abc123",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"paymentInstruction": PaymentInstructionType,
"surchargeAmount": 1
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
{
"namespace": "abc123",
"value": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"account": AccountType
}
Fields
Name | Description |
---|---|
|
Reminder content. |
|
When the reminder is due. |
|
The reminder type. |
Example
{
"reminderType": "AD_HOC",
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountReminderConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountReminderConnectionTypeEdge
A Relay edge containing a AccountReminderConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Reminder,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountRepaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountRepaymentConnectionTypeEdge
A Relay edge containing a AccountRepaymentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountRepaymentType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Amount of payment in pence |
|
|
|
The date this payment is scheduled to be debited |
|
The current status of the repayment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"status": "REQUESTED"
}
AccountSearchItemType
A single accout search hit
Fields
Name | Description |
---|---|
|
The account found. |
|
How well the account matched the search terms. |
Example
{
"account": AccountType,
"score": "1.0"
}
Fields
Name | Description |
---|---|
|
The type of account. |
|
List of active hardship agreements for the user when isinhardship is True. |
|
The referral schemes currently active for this account. |
|
The billing address of this account, stored in the new libaddressinput-based format. Note that |
|
Additional data for french agreements. |
|
Fetch annual statements for the account. |
|
Applications by this account to become our customer. More recent applications will be listed first. |
|
Assistance agreements for account. |
|
The current account balance. |
|
Fetch a specific issued bill (invoice/statement) for the account. |
|
The billing address of the account. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The billing email of the account. |
|
The billing name of the account. |
|
Information about the account's billing cycle. |
|
The billing sub name of the account. |
|
Fetch issued bills (invoices/statements) for the account. |
|
The brand of the account. |
|
Business info related to a business account. |
|
The company type of a business account. Deprecated The 'businessType' field is deprecated. |
|
The campaigns associated with an account. |
|
Data about whether or not an account can modify their payments. |
|
Whether the account can request a credit refund. |
|
The method the account has specified they prefer we contact them. |
|
Deprecated The 'communicationDeliveryPreference' field is deprecated. |
|
The consent data for the account. Deprecated The 'consentData' field is deprecated. |
|
Consents linked to this account. |
|
Contribution agreements for account. |
|
The datetime that the account was originally created. |
|
Credit storage info of the account. |
|
Debt collection proceedings for account. |
|
The direct debit instructions of the account |
|
The document accessibility preference of the account. |
|
Energy cheque certificates linked to the account. |
|
Energy cheques linked to the account. |
|
The account events that were recorded for the account. |
|
Files attached to this account. |
|
The ledger pot for the account. |
|
|
|
True if there is an active Hardship Agreement for this account. False otherwise. |
|
Ledgers provide the foundation of bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular customer account. |
|
Retrieve all market supply agreements under this account. Note that when |
|
The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount. |
|
Metadata associated with the account. |
|
The next payment or repayment for the account. |
|
Notes for the account. |
|
A code that uniquely identifies the account. |
|
The current account overdue balance. |
|
Files attached to this account. |
|
Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports |
|
A list displaying the payment forecast for an account. The list starts from today's date (inclusive). Deprecated The 'paymentForecast' field is deprecated. |
|
The payment instructions of the account. |
|
The payment plans that have been created for this account. |
|
The schedules that describe how we would expect to take payments for an account on a given month. |
|
The payments made into an account from a payment instruction. |
|
The portfolio this account is linked to. |
|
The language that the account preferred for communications. |
|
Properties linked to the account now and in the future. |
|
|
|
Account references linked to this account. |
|
The referrals created by this account. |
|
Number of referrals created by this account. |
|
The reminders associated with an account. |
|
The repayments that have been requested for this account. |
|
Details about the eligibility status for requesting a refund. |
|
The rewards applied to this account. |
|
List of billing address lines. |
|
The current status of the account. |
|
Supply contracts linked to the account. |
|
Fetch transactions that have taken place on the account. |
|
Unique reference number from a 3rd party enrolment. |
|
Example
{
"id": "abc123",
"number": "abc123",
"users": AccountUserType,
"brand": "abc123",
"status": "PENDING",
"balance": 1,
"overdueBalance": 1,
"urn": "abc123",
"billingName": "abc123",
"billingSubName": "abc123",
"billingEmail": "abc123",
"billingAddress": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingAddressPostcode": "abc123",
"billingCountryCode": "abc123",
"billingDeliveryPointIdentifier": "abc123",
"splitBillingAddress": ["abc123"],
"address": RichAddressType,
"portfolio": PortfolioType,
"ledgers": [LedgerType],
"metadata": [Metadata],
"canRequestRefund": true,
"requestRefundEligibility": RequestRefundEligibilityType,
"payments": AccountPaymentConnectionTypeConnection,
"repayments": AccountRepaymentConnectionTypeConnection,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"paymentSchedules": PaymentScheduleConnectionTypeConnection,
"paymentForecast": [PaymentForecastType],
"paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
"referrals": ReferralConnectionTypeConnection,
"referralsCreated": 1,
"rewards": [RewardType],
"activeReferralSchemes": ReferralSchemeTypes,
"transactions": TransactionConnectionTypeConnection,
"provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
"annualStatements": AnnualStatementConnectionTypeConnection,
"bills": BillConnectionTypeConnection,
"billingOptions": BillingOptionsType,
"bill": BillInterface,
"directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
"paymentMethods": PaymentInstructionConnectionTypeConnection,
"events": AccountEventConnectionTypeConnection,
"applications": AccountApplicationConnectionTypeConnection,
"accountType": "BUSINESS",
"businessType": "SOLE_TRADER",
"business": BusinessType,
"commsDeliveryPreference": "EMAIL",
"communicationDeliveryPreference": "abc123",
"documentAccessibility": "LARGE_PRINT",
"references": [AccountReferenceType],
"fileAttachments": [AccountFileAttachment],
"paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
"maximumRefund": MaximumRefundType,
"campaigns": [AccountCampaignType],
"isInHardship": true,
"activeHardshipAgreements": [HardshipAgreementType],
"notes": [AccountNoteType],
"contributionAgreements": [ContributionAgreementType],
"assistanceAgreements": [AssistanceAgreementType],
"debtCollectionProceedings": [DebtCollectionProceedingType],
"createdAt": "2020-01-01T00:00:00.000Z",
"preferredLanguageForComms": "abc123",
"consents": ConsentType,
"reminders": AccountReminderConnectionTypeConnection,
"properties": [PropertyType],
"marketSupplyAgreements": AgreementConnection,
"canModifyPayments": CanModifyPaymentsType,
"consentData": FraConsentData,
"energyCheques": [EnergyCheque],
"energyChequeCertificates": [EnergyChequeCertificate],
"nextPaymentOrRepayment": FraPaymentsInterface,
"creditStorage": CreditStorage,
"supplyContracts": SupplyContractConnectionTypeConnection,
"agreements": AgreementConnectionTypeConnection,
"fraPotLedger": SupplementaryLedgerType
}
AccountUserCommsPreferences
Information about the preferences set up for a user.
Fields
Name | Description |
---|---|
|
What format the user would like to receive their emails in. |
|
This setting allows the user to adjust the default font size of the communications sent to them. |
|
Whether the user has opted in to receive meter reading confirmation emails. |
|
Whether a user has opted in to receive messages from the client or client group. For example, for Octopus Energy this describes whether a user is opted in to offers from Octopus Investments. |
|
Whether a user has opted in to receive messages offering discounts or other services not directly related to the services the client provides. |
|
Whether a user has opted in to receive messages we recommend they read, but are not vital to the utilities the client provides. For example, these could be reminders that the client will take a payment. |
|
Whether the user has opted in to receive SMS messages. |
|
Whether a user has opted in to receive messages from the client's preferred third parties. |
|
Whether a user has opted in to receive messages updating them on client activities. |
|
Whether a user has opted to have inverted colours in their emails. This is currently only relevant to the Octopus Energy brand, whose emails have a dark background by default. |
|
Song which will be used as hold music for the user. |
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"emailFormat": "TEXT",
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountUserConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AccountUserConnectionTypeEdge
A Relay edge containing a AccountUserConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AccountUserType,
"cursor": "abc123"
}
AccountUserConsents
Information about the consents for an account user.
Fields
Name | Description |
---|---|
|
Consents linked to this user. |
Example
{
"consents": ConsentType
}
Fields
Name | Description |
---|---|
|
Whether the value is sensitive and encrypted. |
|
The namespace for the property. |
|
The property value. |
Example
{
"namespace": "abc123",
"value": "abc123",
"isSensitive": true
}
AccountUserPermission
Holds information about a specific permission.
Fields
Name | Description |
---|---|
|
The short name of the permission |
Example
{
"permission": "abc123"
}
AccountUserRoleType
The role a user has in association with one account.
Fields
Name | Description |
---|---|
|
|
|
|
|
The account role. |
|
Example
{
"id": "abc123",
"user": AccountUserType,
"account": AccountType,
"role": RoleString
}
AccountUserType
User objects are the core of the authentication system. They typically represent a customer who manages a portfolio of one or more accounts.
Fields
Name | Description |
---|---|
|
List of roles a user has for each account they're linked to. |
|
List of accounts that the user is linked to either via portfolio role or account role. |
|
List of alternative phone numbers for the account user. |
|
Consents linked to this user. |
|
AccountUser's date of birth. |
|
List of details linked to this user. |
|
We recommend you use fullName instead of this field. Deprecated The 'displayName' field is deprecated. |
|
|
|
|
|
We recommend you use preferredName or fullName instead of this field. Deprecated The 'firstName' field is deprecated. |
|
The user's full name. |
|
|
|
Whether there are family issues. |
|
|
|
Designates whether this user is deceased. |
|
True if user is linked to an account with an active hardship agreement. |
|
|
|
The user's landline phone number. Deprecated The 'landlinePhoneNumber' field is deprecated. |
|
We recommend you use preferredName or fullName instead of this field. Deprecated The 'lastName' field is deprecated. |
|
The user's secret key to access the Developer API. |
|
|
|
A code that uniquely identifies the account user. |
|
List payment instructions linked to this user. |
|
Holds information about the permissions of the current viewer. |
|
We recommend you use portfolioIds instead of this field. Deprecated The 'portfolioId' field is deprecated. |
|
List of portfolio ids that the user is linked to via their portfolio roles. |
|
List of roles a user has for each portfolio they're linked to. |
|
List of portfolios that the user is linked to via their portfolio roles. |
|
|
|
The user's preferred name. |
|
The user's pronouns e.g. 'she/her', 'he/him', 'they/them'. |
|
|
|
Example
{
"id": "abc123",
"number": "abc123",
"accounts": AccountInterface,
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"title": "abc123",
"pronouns": "abc123",
"isDeceased": true,
"liveSecretKey": "abc123",
"permissions": [AccountUserPermission],
"displayName": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "abc123",
"preferredName": "abc123",
"portfolioId": "abc123",
"portfolioIds": ["abc123"],
"portfolios": PortfolioConnectionTypeConnection,
"specialCircumstances": SpecialCircumstancesType,
"preferences": AccountUserCommsPreferences,
"dateOfBirth": "2020-01-01",
"landlinePhoneNumber": "abc123",
"alternativePhoneNumbers": ["abc123"],
"hasFamilyIssues": true,
"isInHardship": true,
"accountUserRoles": [AccountUserRoleType],
"portfolioUserRoles": [PortfolioUserRoleType],
"details": [AccountUserDetailType],
"consents": ConsentType,
"paymentMethods": PaymentInstructionConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ActivationProcessesConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ActivationProcessesConnectionTypeEdge
A Relay edge containing a ActivationProcessesConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ActivationProcessInterface,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Username of the Actor. |
Example
{
"username": "abc123"
}
AddBusinessToSegmentMutation
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-11111: Segment does not exist.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The business segment period that was created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"businessSegmentPeriod": BusinessSegmentPeriodType
}
AddCampaignToAccount
The possible errors that can be raised are:
- 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.
Fields
Name | Description |
---|---|
|
Whether the campaign was successfully added. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignAdded": true
}
AddItemsToRiskList
Add new items to risk list.
The possible errors that can be raised are:
- KT-CT-12105: Risk list item addition failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
List of successfully added risk identifiers. |
Example
{
"possibleErrors": [PossibleErrorType],
"riskIdentifiers": [RiskListItemType]
}
Example
{
"note": InkNote,
"clientMutationId": "abc123"
}
AddSignupReferralOnAccount
Create a referral scheme reward for an organization. This allows businesses to issue rewards based on a referral scheme.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6729: This scheme cannot be applied to given account.
- KT-CT-6710: Unable to create referral.
- KT-CT-6728: This referral scheme's usage is at capacity.
- KT-CT-6712: Invalid reference.
- KT-CT-6713: Referring and referred account brands do not match.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created account referral instance. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReferral": ReferralType
}
AddUserToPortfolio
The possible errors that can be raised are:
- KT-CT-5461: Invalid role code.
- KT-CT-5462: Invalid user number format.
- KT-CT-5463: Unauthorized.
- KT-CT-9407: Unauthorized.
- KT-CT-9408: Invalid portfolio number format.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}
Fields
Name | Description |
---|---|
|
The batiment for the address. |
|
The city code for the address. |
|
The city label for the address. |
|
The details for the address. |
|
The locality for the address. |
|
The street number for the address. |
|
The post code for the address. |
|
The full address string. |
|
The full address string splited on two lines. |
Example
{
"addrBat": "abc123",
"addrCityCode": "abc123",
"addrCityLabel": "abc123",
"addrDetails": "abc123",
"addrLocality": "abc123",
"addrNumStreet": "abc123",
"addrPostCode": "abc123",
"fullAddress": "abc123",
"splitFullAddress": ["abc123"]
}
AffiliateAcceptQuote
Accepts a quote.
The possible errors that can be raised are:
- KT-FR-4511: No provider calendar for PRM.
- KT-FR-4610: Unknown PRM.
- KT-FR-4612: Unable to create agreement.
- KT-FR-4613: Unable to request quote.
- KT-FR-4614: Unknown quote request.
- KT-FR-4617: Incompatible subscription type.
- KT-FR-4618: The quote request has already been accepted.
- KT-FR-4622: Unexpected error while accepting a quote.
- KT-FR-4712: Invalid meter readings data.
- KT-FR-4713: Invalid data. Reading date cannot be in the future.
- KT-FR-4913: Unknown product.
- KT-CT-3811: Invalid IBAN.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created or updated account number. Deprecated The 'accountNumber' field is deprecated. |
|
The created contract number. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123",
"contractNumber": "abc123"
}
AffiliateAudioRecordingPresignedPostType
Metadata returned when generating a pre-signed post URL for an affiliate.
Fields
Name | Description |
---|---|
|
The S3 bucket. |
|
The fields to be included in the pre-signed post. |
|
The S3 bucket key. |
|
The pre-signed S3 URL. |
Example
{
"key": "abc123",
"bucket": "abc123",
"fields": {"key": "value"},
"preSignedUrl": "abc123"
}
AffiliateEligibility
Check the PRM eligibility after calling Enedis (french DSO) consulterPoint WS.
Fields
Name | Description |
---|---|
|
Eventual eligibility/technical errors. |
|
True if eligible. |
|
Subscribed max power (in kVA). |
|
The provider calendar id of the PRM. |
|
The type of subscription required to activate this PRM. |
|
The customer's supply point id. |
|
Tariff option. Deprecated The 'tariffOption' field is deprecated. |
Example
{
"supplyPointId": "abc123",
"isEligible": true,
"subscriptionType": "CDF",
"tariffOption": "BASE",
"providerCalendarId": "BASE",
"meterPower": 1,
"errors": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}
AffiliateLinkType
Affiliate link for the organization.
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Affiliate Organisation. |
|
|
|
Example
{
"id": "abc123",
"organisation": AffiliateOrganisationType,
"subdomain": "abc123",
"trainingStatus": "NOT_APPLICABLE",
"isBusiness": true,
"contactName": "abc123",
"contactEmail": "abc123",
"landingUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API. |
|
Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API. |
|
Allow registration requests with customers without an email address. |
|
Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user. |
|
Allow performing tariff renewals via API. |
|
Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor'). |
|
The primary contact email for the organisation. |
|
Default Account Type. |
|
|
|
Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
|
|
|
Sales Channel. Deprecated The 'salesChannel' field is deprecated. |
|
Sales Channel Code. |
|
Allow this partner to skip validation that ensures all meter points belong to the same address. |
Example
{
"id": "abc123",
"name": "abc123",
"contactEmail": "abc123",
"salesChannel": "DIRECT",
"canRenewTariffs": true,
"defaultAccountType": "BUSINESS",
"allowAlternativePaymentMethods": true,
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"canUseIvrSupportApi": true,
"skipMeterPointAddressValidation": true,
"salesChannelCode": "abc123",
"isFieldSalesOnlyProduct": true
}
Fields
Name | Description |
---|---|
|
Annual amount (in euros). |
|
Monthly amount (in euros). |
|
The related product to this quoted product. |
Example
{
"annualAmount": FinancialAmount,
"monthlyAmount": FinancialAmount,
"product": AffiliateProduct
}
AffiliateRequestQuote
Requests a quote on a given PRM.
The possible errors that can be raised are:
- KT-FR-4511: No provider calendar for PRM.
- KT-FR-4512: The chosen calendar is different from the one provided by ENEDIS.
- KT-FR-4610: Unknown PRM.
- KT-FR-4615: Unable to request quote.
- KT-FR-4613: Unable to request quote.
- KT-FR-4619: Unexpected error while generating quote.
- KT-FR-4621: Annual consumption invalid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Quote identifier. |
|
A list of quoted products. |
Example
{
"possibleErrors": [PossibleErrorType],
"quoteCode": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"quotedProducts": [AffiliateQuotedProduct]
}
AffiliateSessionType
A tracked session for the affiliate link.
Fields
Name | Description |
---|---|
|
|
|
|
|
Affiliate Link. |
|
|
|
Example
{
"id": "abc123",
"ipAddress": "abc123",
"userAgent": "abc123",
"queryParams": {"key": "value"},
"link": AffiliateLinkType
}
Fields
Name | Description |
---|---|
|
URL to the PDF of the agreement certificate. The possible errors that can be raised are:
|
Example
{
"temporaryUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AgreementEdge,
"totalCount": 1,
"edgeCount": 1
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AgreementConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AgreementConnectionTypeEdge
A Relay edge containing a AgreementConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AgreementType,
"cursor": "abc123"
}
AgreementEdge
A Relay edge containing a Agreement
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": CommonAgreementType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The addresses fields. |
|
The effective date for the PRM history. |
|
The PRM id. |
|
The meter is communicating. |
|
Last available readings (HP/HC or BASE). |
|
The kind of the meter. |
|
The off-peak timeframe(s) of the day. |
|
The calendar ID used by the provider. |
|
The service level of the meter. |
|
The subscribed maximum power. |
Example
{
"effectiveFrom": "2020-01-01",
"providerCalendarId": "abc123",
"offPeakLabel": "abc123",
"subscribedMaxPower": "1.0",
"id": "abc123",
"address": AddressType,
"lastReadings": [ElectricityReading],
"isCommunicating": true,
"meterKind": "abc123",
"serviceLevel": 1
}
Fields
Name | Description |
---|---|
|
All-day energy consumption (in kWh) accumulated over a year. |
Example
{
"allDay": 1
}
Fields
Name | Description |
---|---|
|
The amount of the transaction that has been allocated to the billing document. A positive amount indicates money received from the customer (payments, credits). A negative amount indicates money paid to the customer (repayments). |
|
Reason for the allocation intention. |
|
The amount of the transaction. A positive amount indicates money received from the customer (payments, credits). A negative amount indicates money paid to the customer (repayments). |
|
ID of the allocated transaction. |
|
The type of the transaction. |
Example
{
"transactionId": 1,
"transactionType": "CREDIT",
"transactionAmount": 1,
"allocationAmount": 1,
"allocationReason": "abc123"
}
AllocationType
Represents an allocation of a fulfilment to an obligation.
Fields
Name | Description |
---|---|
|
The amount of the allocation (in minor currency units), unsigned. |
|
The fulfilment that is allocated. |
Example
{
"amount": 1,
"fulfilment": FulfilmentType
}
AllowRepaymentSubmission
Allow a repayment to be submitted.
The possible errors that can be raised are:
- KT-CT-3944: Account repayment does not exist.
- KT-CT-3945: Unable to allow a repayment to be submitted.
- KT-CT-3950: The provided reason text is too long.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The repayment ID. |
|
Resulting Repayment Intervention details. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentId": "abc123",
"repaymentIntervention": RepaymentInterventionType
}
AlreadyLinkedError
Returned when an account already has a LINE account linked to it.
Fields
Name | Description |
---|---|
|
The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}
AmendPayment
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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
AnimationType
A media element containing an animation, such as a Lottie.
Fields
Name | Description |
---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
The horizontal alignment of the media. |
|
Unique identifier of the object. |
|
The resource URL of the media. |
|
The name of the object's type. |
|
The measurement of the element. |
Example
{
"width": ItemSizeType,
"mediaUrl": "abc123",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AnnualStatementConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AnnualStatementConnectionTypeEdge
A Relay edge containing a AnnualStatementConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AnnualStatementType,
"cursor": "abc123"
}
AnnualStatementType
Annual statements that are sent to the account. They summarize important information about usage and tariffs.
Example
{
"periodStartsAt": "2020-01-01T00:00:00.000Z",
"periodEndsAt": "2020-01-01T00:00:00.000Z",
"id": "abc123",
"pdfUrl": "abc123"
}
AnnulmentBillingDocumentType
An annulment is a billing document that annuls another billing document.
Fields
Name | Description |
---|---|
|
ID of the billing document annulled by this annulment. |
|
First time the annulment was issued. |
|
|
|
URL to the PDF of the annulment. |
Example
{
"id": 1,
"annulledBillingDocumentId": 1,
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AppSessionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
AppSessionConnectionTypeEdge
A Relay edge containing a AppSessionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AppSessionType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
Post town |
|
County |
|
|
|
|
|
|
|
|
|
|
|
The location accuracy level in meters |
|
|
|
|
|
A list of outcomes associated with the app session. |
|
|
|
|
|
|
|
|
|
|
|
Example
{
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"link": AffiliateLinkType,
"isArchived": true,
"postcode": "abc123",
"account": AccountType,
"locationAt": "2020-01-01T00:00:00.000Z",
"locationHorizontalAccuracy": 1,
"locationLatitude": "1.0",
"locationLongitude": "1.0",
"salesMode": "DOOR",
"type": AppSessionType,
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"outcomes": [OutcomeType]
}
ApproveRepayment
The possible errors that can be raised are:
- KT-CT-3934: Repayment request already approved.
- KT-CT-3935: Repayment request cannot be paid.
- KT-CT-3959: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The approved repayment. |
Example
{
"possibleErrors": [PossibleErrorType],
"repayment": AccountRepaymentType
}
AssessCollectionProcessRecordForPause
Assess the Collection Process for pause and pause or unpause it based on the assessment.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Details of collection process after running the pause assessment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessProcessed": AssessCollectionProcessRecordForPauseOutputType
}
AssessCollectionProcessRecordForPauseOutputType
Output for assessing a Collection process for pause.
Fields
Name | Description |
---|---|
|
The pause status of the collection process. |
|
The number of the collection process record. |
Example
{
"number": "abc123",
"isPaused": true
}
Fields
Name | Description |
---|---|
|
The bucket that the conversation will be assigned to. |
|
|
|
The conversation that will be assigned to the bucket. |
Example
{
"conversation": InkConversation,
"bucket": InkBucket,
"clientMutationId": "abc123"
}
Fields
Name | Description |
---|---|
|
The ID of the assigned user. |
|
The username of the assigned user. |
Example
{
"id": "abc123",
"username": "abc123"
}
AssistanceAgreementType
A single Assistance Agreement.
Fields
Name | Description |
---|---|
|
The start datetime of the agreement. |
|
The end datetime of the agreement, if any. |
|
The type of assistance provided by the agreement. |
Example
{
"assistanceType": "abc123",
"activeFrom": "2020-01-01",
"activeTo": "2020-01-01"
}
AssociateCallWithAccount
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-11808: Unable to associate account to call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The call. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
AssociateItemToCollectionProcess
Associate an item to collection process record
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11205: Item already associated to collection process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Item associated to the collection process. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessAssociatedItem": AssociateItemToCollectionProcessOutputType
}
Fields
Name | Description |
---|---|
|
Associated item identifier. |
|
The number of the collection process record. |
Example
{
"number": "abc123",
"itemId": "abc123"
}
AttachmentType
Represents a file to attach to a communication
Fields
Name | Description |
---|---|
|
|
|
|
|
Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"temporaryUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
The app session associated with this audio recording. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"appSession": AppSessionType,
"contentType": "abc123",
"duration": 1.0,
"fileSize": 1,
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"s3Bucket": "abc123",
"s3Key": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}
AuthFlow
A step where the user must complete an auth flow.
Fields
Name | Description |
---|---|
|
The URL to redirect the user to for authorization. |
|
A unique identifier for this onboarding step. |
|
The URI where the auth flow is going to redirect back to at the end. |
Example
{
"id": "abc123",
"redirectUri": "abc123",
"authorizationUri": "abc123"
}
AwardLoyaltyPoints
Award Loyalty Points.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9212: Points exceed maximum limit.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The ledger entry for the awarded loyalty points |
|
The number of loyalty points that were awarded. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsAwarded": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}
BackendScreenEvent
Returns an Action to perform, e.g. a screen to load.
BackendScreenEvents are specific types of Action which trigger a mutation in the Kraken backend. They return an action (any type), such as a ScreenActionType (which is then used to load the next screen). Any action registered in the registry should really be an "event" with some side-effect in the backend.
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.
Fields
Name | Description |
---|---|
|
An action to perform. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"action": ActionType
}
BackendScreenEventActionType
An action which triggers some event in the Kraken backend.
Fields
Name | Description |
---|---|
|
The ID of the event to trigger. |
|
Unique identifier of the object. |
|
List of key-value pairs to pass as parameters to the event. |
|
The name of the action object's type. |
|
The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"eventId": "abc123",
"params": BackendScreenParam
}
BackendScreenParam
A key-value pair (both Strings) which is passed as a parameter to a screen.
Example
{
"key": "abc123",
"value": "abc123"
}
BillCharge
A charge to the customer from the energy retailer.
Fields
Name | Description |
---|---|
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The date time when the transaction is created. |
|
The unique identifier for the transaction. |
|
Returns the note field value for the transaction, which contains additional info. |
|
The date the transaction was posted. |
|
Returns the reason. |
|
A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}
BillConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
BillConnectionTypeEdge
A Relay edge containing a BillConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": BillInterface,
"cursor": "abc123"
}
BillCredit
A credit to the customer from the energy retailer.
Fields
Name | Description |
---|---|
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The date time when the transaction is created. |
|
The unique identifier for the transaction. |
|
Returns the note field value for the transaction, which contains additional info. |
|
The date the transaction was posted. |
|
Returns the reason. |
|
A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}
BillPayment
A payment from the customer to the energy supplier.
Fields
Name | Description |
---|---|
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The date time when the transaction is created. |
|
The unique identifier for the transaction. |
|
Returns the note field value for the transaction, which contains additional info. |
|
The date the transaction was posted. |
|
Returns the reason. |
|
A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}
BillRefund
A refund to the customer from the energy supplier.
Fields
Name | Description |
---|---|
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The date time when the transaction is created. |
|
The unique identifier for the transaction. |
|
Returns the note field value for the transaction, which contains additional info. |
|
The date the transaction was posted. |
|
Returns the reason. |
|
A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}
BillRepresentationConnectionTypeConnection
A connection that can provide links to the representations of a bill.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillRepresentationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
BillRepresentationConnectionTypeEdge
A Relay edge containing a BillRepresentationConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": BillRepresentationType,
"cursor": "abc123"
}
BillRepresentationType
representations are associated with a bill files and can be used to provide additional information to the customer.
Fields
Name | Description |
---|---|
|
The type of representation. |
|
The name of the file. |
|
The |
|
The expiry datetime field of the temporary URL. |
|
The version of the representation. |
Example
{
"code": "abc123",
"version": 1,
"temporaryUrl": "abc123",
"temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
"filename": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillTransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
BillTransactionConnectionTypeEdge
A Relay edge containing a BillTransactionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": BillTransactionType,
"cursor": "abc123"
}
BillingAttachmentConnectionTypeConnection
A connection that can provide links to the attachments of the bill.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillingAttachmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
BillingAttachmentConnectionTypeEdge
A Relay edge containing a BillingAttachmentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": BillingAttachmentType,
"cursor": "abc123"
}
BillingAttachmentType
Attachments are associated with a bill files and can be used to provide additional information to the customer.
Fields
Name | Description |
---|---|
|
The name of the file. |
|
The |
|
The expiry datetime field of the temporary URL. |
Example
{
"temporaryUrl": "abc123",
"temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
"filename": "abc123"
}
BillingDocumentIssuanceFrequencyType
Represents billing document issuance frequency to be applied during a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}
Fields
Name | Description |
---|---|
|
Allocation intentions for the billing document. |
|
Allocations for the billing document. |
|
The date when the payment is due for the billing document. |
|
The expected amount for the billing document (in minor currency units). |
|
The amount that remains to be paid for the billing document (in minor currency units). |
Example
{
"dueDate": "2020-01-01",
"expectedAmount": 1,
"remainingAmount": 1,
"allocationIntentions": AllocationIntentionType,
"allocations": AllocationType
}
BillingOptionsType
Information about an account's billing schedule.
Fields
Name | Description |
---|---|
|
The date on which the current billing cycle will end. Null if the account is on flexible billing. |
|
The date on which the current billing cycle started. |
|
If true, this account is billed on specific day of a regular cycle. If false, the billing schedule is flexible, depending on when meter readings are submitted. |
|
The next date on which this account will next be billed. This is the same as the start date for their next bill cycle. Null if the account is on flexible billing. |
|
|
|
|
|
The day of the month on which the account's billing period should start. |
Example
{
"periodStartDay": 1,
"periodLength": "MONTHLY",
"periodLengthMultiplier": 1,
"isFixed": true,
"currentBillingPeriodStartDate": "2020-01-01",
"currentBillingPeriodEndDate": "2020-01-01",
"nextBillingDate": "2020-01-01"
}
BlockRepaymentSubmission
Block a repayment from being submitted.
The possible errors that can be raised are:
- KT-CT-3944: Account repayment does not exist.
- KT-CT-3946: Unable to block a repayment from being submitted.
- KT-CT-3950: The provided reason text is too long.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The repayment ID. |
|
Resulting Repayment Intervention details. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentId": "abc123",
"repaymentIntervention": RepaymentInterventionType
}
Fields
Name | Description |
---|---|
|
Is field disabled. Deprecated The 'energyLandscape' field is deprecated. |
|
Display text for the field. |
|
Should the field be hidden. |
|
Is required. |
Example
{
"required": true,
"helpText": "abc123",
"disabled": true,
"hidden": true
}
Fields
Name | Description |
---|---|
|
The key of the business detail. |
|
The value of the business detail. |
Example
{
"key": "abc123",
"value": "abc123"
}
Fields
Name | Description |
---|---|
|
The end date and time of the segment period |
|
The ID of the business segment period |
|
The segment associated with this period |
|
The start date and time of the segment period |
Example
{
"id": "abc123",
"segment": SegmentType,
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The billing address of the business. |
|
The company type of a business account. |
|
The details of the business. |
|
The business ID. |
|
The legal address of the business. |
|
Account number linked to this business. The possible errors that can be raised are:
Deprecated The 'linkedAccountNumber' field is deprecated. |
|
Account numbers linked to this business. |
|
The business' name |
|
The business' number |
|
List payment instructions owned by this business. |
|
The segment this business is assigned to |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"businessType": "SOLE_TRADER",
"details": [BusinessDetailType],
"billingAddress": RichAddressType,
"legalAddress": RichAddressType,
"linkedAccountNumber": "abc123",
"linkedAccountNumbers": "abc123",
"segmentName": "abc123",
"paymentMethods": PaymentInstructionConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
The key of the call metadata item. |
|
The value of the call metadata item. |
Example
{
"key": "abc123",
"value": "abc123"
}
CallTagConnectionTypeConnection
Paginator of Call Tags
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CallTagConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
CallTagConnectionTypeEdge
A Relay edge containing a CallTagConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": CallTagType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
ID of the call tag. |
|
Whether the tag can currently be used to tag calls. |
|
Name of the tag that will be used to identify it. |
Example
{
"id": "abc123",
"name": "abc123",
"isActive": true
}
Fields
Name | Description |
---|---|
|
Whether or not the account can amend payments. |
|
Whether or not the account can cancel payments. |
Example
{
"canAmendPayments": true,
"canCancelPayments": true
}
CancelPayment
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-3954: Payment cancellation failed.
- KT-CT-3955: Payment cannot be cancelled.
- KT-CT-3956: Temporary error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The cancelled payment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
CancelRepaymentRequest
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The cancelled repayment/refund request. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentRequest": CancelRepaymentRequestOutputType
}
CancelRepaymentRequestOutputType
Output from cancelling a repayment or refund request.
Fields
Name | Description |
---|---|
|
The ID of the cancelled request. |
|
The current status of the cancelled request. |
Example
{
"requestId": "abc123",
"status": "REQUESTED"
}
CancelSmartFlexOnboarding
Cancel onboarding of a device with SmartFlex.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
CardComponentType
A card containing a list of items
Fields
Name | Description |
---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
Unique identifier of the object. |
|
The list of components. |
|
The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"items": CardItemType
}
Fields
Name | Description |
---|---|
|
The list of cards. |
|
Unique identifier of the object. |
|
The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"cards": CardComponentType
}
CharacteristicOverrideConfigurationType
Represents a characteristic override configuration term in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}
Charge
A charge to the customer.
Fields
Name | Description |
---|---|
|
Unique identifier of the account the transaction belongs to. |
|
Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
|
The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
|
If this charge is for consumption of a good or service, this field will contain details of how much was consumed. Omitted in cases where the charge is not for consumption, or where consumption information is not available (e.g. for some older records). |
|
The date time when the transaction is created. |
|
Returns True if the transaction is linked with a statement. |
|
|
|
Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
|
Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
|
Deprecated. Deprecated The 'isCredit' field is deprecated. |
|
Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
|
Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
|
|
|
Returns the note field value for the transaction, which contains additional info. |
|
|
|
Returns the reason. |
|
Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
|
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123",
"consumption": Consumption
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"make": "abc123",
"models": [ChargePointModelsType]
}
Example
{
"model": "abc123",
"powerInKw": ["abc123"]
}
Fields
Name | Description |
---|---|
|
Supply amperage. Used in markets where customers are more familiar with amps than power output. |
|
Shows the availability status of an integration. |
|
|
|
|
|
|
|
Example
{
"variantId": 1,
"model": "abc123",
"powerInKw": "1.0",
"amperage": 1,
"isIntegrationLive": true,
"integrationStatus": "INTERNAL_TESTING"
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"make": "abc123",
"models": [ChargePointVariantModelType]
}
Fields
Name | Description |
---|---|
|
The charge reason code. |
|
The charge reason display text. |
|
The group the charge reason belongs to (if applicable). |
|
Whether the charge reason is deprecated. |
|
Whether the charge reason is hidden. |
|
Whether the charge reason is sales tax exempt. |
Example
{
"code": "abc123",
"display": "abc123",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "abc123"
}
ChargesBreakdownConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ChargesBreakdownConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ChargesBreakdownConnectionTypeEdge
A Relay edge containing a ChargesBreakdownConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ChargesBreakdownType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Charge in minor currency. |
|
The end date of the period the charge is for (exclusive). |
|
The start date of the period the charge is for (inclusive). |
Example
{
"periodStart": "2020-01-01",
"periodEnd": "2020-01-01",
"charge": 1
}
CheckMeterPointsEligibility
Check whether meter points are eligible to be supplied by us.
The possible errors that can be raised are:
- KT-FR-4521: Unable to send request without customer's consent to send data to the DSO.
- KT-FR-4522: Invalid Electricity Meter Point.
- KT-FR-4520: Invalid Gas Meter Point.
- KT-FR-4523: Invalid market name.
- KT-FR-4527: Supply point from the same property contain different addresses.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Data related to the supply point. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"eligibilityResults": SupplyPointEligibilityResultConnectionTypeConnection
}
CheckoutQuote
Checkout a quote (update T&C, create mandate & trigger activation process).
The possible errors that can be raised are:
- KT-FR-3910: Unable to create payment instruction.
- KT-FR-4628: Either consentData or consentDataPerSupplyPointId is required for check-out.
- KT-FR-4636: Enter one of the fields: consents or preferences.
- KT-FR-6912: The activation process provided does not exists.
- KT-FR-6913: The activation process is not in a checkoutable status.
- KT-FR-6914: The activation process does not belong to the logged user account.
- KT-FR-6915: Some supply points are missing industry consents for activation.
- KT-FR-6917: Invalid data.
- KT-FR-6918: Unauthorized.
- KT-CT-9016: Consent management not enabled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created account number. |
|
Checked out agreements. |
|
First payment amount (in cents). Deprecated The 'firstPaymentAmount' field is deprecated. |
|
First payment date. Deprecated The 'firstPaymentDate' field is deprecated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The token to reset a password. |
|
The user id in b64. |
Example
{
"possibleErrors": [PossibleErrorType],
"firstPaymentDate": "2020-01-01",
"firstPaymentAmount": 1,
"agreements": AgreementConnectionTypeConnection,
"userId": "abc123",
"token": "abc123",
"accountNumber": "abc123"
}
Fields
Name | Description |
---|---|
|
The choices available for this field. |
|
Is field disabled. Deprecated The 'energyLandscape' field is deprecated. |
|
Display text for the field. |
|
Should the field be hidden. |
|
Is required. |
Example
{
"required": true,
"helpText": "abc123",
"disabled": true,
"hidden": true,
"choices": EnergyLandscapeChoiceType
}
CloseActionType
Closes the screen.
Fields
Name | Description |
---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
Unique identifier of the object. |
|
The name of the action object's type. |
|
The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"accessibilityHidden": true,
"accessibilityLabel": "abc123"
}
CloseDCAProceeding
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11602: Could not find DCA with that name.
- KT-CT-11603: Could not stop debt collection proceeding.
- KT-CT-11604: Active debt collection proceeding does not exist for account.
- KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the closure could be applied. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"dcaProceedingClosureStatus": DCAProceedingClosureStatus
}
Fields
Name | Description |
---|---|
|
|
|
The live chat. |
Example
{
"liveChat": InkLiveChat,
"clientMutationId": "abc123"
}
CloseOpenPrintBatch
Close the Open Print Batch if any.
The possible errors that can be raised are:
- KT-CT-9010: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"printBatch": PrintBatchType
}
CollectDeposit
Collect deposit for the given account.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-5711: No collection is required.
- KT-CT-5712: Deposit agreement does not exist or has not been accepted.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": CollectDepositOutput
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"status": "APPROVED",
"paymentDate": "2020-01-01"
}
CollectPayment
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.
Fields
Name | Description |
---|---|
|
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. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
CollectionProcessDetailsType
Collection process details type
Fields
Name | Description |
---|---|
|
Items associated to the collection process. |
|
The collection process record number. |
|
What kind of completion happened. |
|
The completion status of the collection process. |
|
The pause status of the collection process. |
|
Total number of days collection process were on pause. |
Example
{
"collectionProcessRecordNumber": "abc123",
"isPaused": true,
"isComplete": true,
"completionType": "abc123",
"associatedItems": [CollectionProcessRecordAssociatedItemType],
"pausedDays": 1
}
CollectionProcessRecordAssociatedItemType
Item associated to collection process
Fields
Name | Description |
---|---|
|
Additional details of the item. |
|
Unique reference of item. |
|
Type of item. |
|
Datetime of when action that resulted in item happened. |
Example
{
"itemType": "abc123",
"itemReference": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"extraDetails": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
|
|
The type of the bill. |
|
Constituents of the bill. |
|
The date of the bill is covered from. |
|
The ID of the bill. |
|
The date the bill was sent to the customer. |
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the bill is covered to. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"constituents": ConstituentConnection
}
Fields
Name | Description |
---|---|
|
Information about the current state of the rate limiting for rate limited fields at the time of the request. |
|
Information about points-allowance rate limit for viewer. |
Example
{
"pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation,
"fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection
}
CommenceDCAProceeding
The possible errors that can be raised are:
- KT-CT-11606: Debt Collection Agency cannot use campaign.
- KT-CT-11601: Cannot start collection proceeding, proceeding for this account already exists.
- KT-CT-11602: Could not find DCA with that name.
- KT-CT-11607: Invalid ledger number for debt collection proceeding.
- KT-CT-11608: Ledger does not belong to account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the commencement could be applied. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
}
Fields
Name | Description |
---|---|
|
|
|
The datetime the agreement was entered. |
|
The datetime the agreement was terminated. |
|
|
|
Whether the agreement is currently active. |
|
Whether the agreement is revoked. |
|
The product associated with the agreement. |
|
The agreement's supply point |
|
|
|
|
|
Example
{
"id": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"agreedAt": "2020-01-01T00:00:00.000Z",
"terminatedAt": "2020-01-01T00:00:00.000Z",
"supplyPoint": SupplyPointType,
"product": SupplyProductType,
"isActive": true,
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true
}
ComplaintContactConnectionTypeConnection
Paginator of Complaint contact type.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ComplaintContactConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ComplaintContactConnectionTypeEdge
A Relay edge containing a ComplaintContactConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ComplaintContactType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Description of action taken. |
|
Created at for contact. |
|
Complaint email. |
|
Complaint landline. |
|
Complaint phone. |
|
Complainant name. |
|
Complaint preferred method. |
|
Status of complaint. |
|
Complaint summary. |
Example
{
"name": "abc123",
"actionTaken": "abc123",
"status": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"mobile": "abc123",
"email": "abc123",
"landline": "abc123",
"preferredCommunicationMethod": "abc123",
"summary": "abc123"
}
Fields
Name | Description |
---|---|
|
Complaint Assignee. |
|
Complaint contacts. |
|
Complaint creation date. |
|
|
|
Complaint resolution date. |
|
Complaint subtype. |
|
Complaint type. |
Example
{
"id": "abc123",
"contacts": ComplaintContactConnectionTypeConnection,
"type": "abc123",
"subtype": "abc123",
"creationDate": "2020-01-01",
"resolutionDate": "2020-01-01",
"assigneeId": "abc123"
}
CompleteAuthFlowForSmartFlexOnboarding
Complete the auth flow step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding
Complete the Tesla setup virtual key onboarding step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
CompleteUserActionRequiredForSmartFlexOnboarding
Complete the UserActionRequired step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
ComponentListType
A list of components which comprise a screen.
This is a legacy type; GenericBackendScreen should be preferred. This is because API clients
should not need to explicitly query for screen attributes like items
- these fields are
embedded in the screenData field.
Fields
Name | Description |
---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
Unique identifier of the object. |
|
The list of components. Deprecated The 'items' field is deprecated. |
|
The name of the screen. |
|
The refresh / polling frequency in milliseconds. |
|
Serialized JSON representation of the screen. |
|
The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123",
"items": ItemType
}
ComputeEnergyLandscape
Compute the energy landscape for a prm and/or a pce.
The possible errors that can be raised are:
- KT-CT-4719: No supply point found for identifier provided.
- KT-FR-4915: The version is not supported or improperly configured.
- KT-FR-4916: The PRM and/or the PCE is needed to store the result.
- KT-FR-4917: A parameter is missing to compute the EAC. Please check the structure of the form.
- KT-FR-4918: The file containing the EAC has an error.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Energy landscape ID if stored, None otherwise. |
|
Potential eligibility/technical errors. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"energyLandscapeResult": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"energyLandscapeId": 1
}
ConfirmDoubleOptIn
Confirm a requested consent.
This mutation will update the value of the consent associated with the provided token to ACCEPTED.
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.
Fields
Name | Description |
---|---|
|
The consent that was created or updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
ConsentType
A consent given by a signing identity for a consent type.
Fields
Name | Description |
---|---|
|
Unique code given to this consent type. |
|
id of the consent. |
|
The type of the consent. |
|
Value of the consent. |
Example
{
"id": 1,
"code": "abc123",
"value": "ACCEPTED",
"type": ConsentTypeType
}
ConsentTypeType
A type of consent that a signing identity can accept or reject to.
Fields
Name | Description |
---|---|
|
Unique code given to this consent type. |
|
Default value of the consent type. |
|
Description of the consent type. |
|
Name of the consent type. |
Example
{
"code": "abc123",
"description": "abc123",
"name": "abc123",
"defaultValue": "ACCEPTED"
}
ConstituentConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConstituentEdge,
"totalCount": 1,
"edgeCount": 1
}
ConstituentEdge
A Relay edge containing a Constituent
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ConstituentInterface,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"quantity": "1.0",
"unit": "kWh",
"usageCost": 1,
"supplyCharge": 1
}
ConsumptionBreakdownConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConsumptionBreakdownConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ConsumptionBreakdownConnectionTypeEdge
A Relay edge containing a ConsumptionBreakdownConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ConsumptionBreakdownType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Charges grouped per displayed period. |
|
Name of the market the charges are for. |
Example
{
"marketName": "abc123",
"charges": ChargesBreakdownConnectionTypeConnection
}
ConsumptionForecastConnectionTypeConnection
Pagination for consumption forecast data.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConsumptionForecastConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ConsumptionForecastConnectionTypeEdge
A Relay edge containing a ConsumptionForecastConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
The item at the end of the edge |
Example
{
"node": ConsumptionForecastForDateTimeType,
"cursor": "abc123"
}
ConsumptionForecastForDateTimeType
Forecasted consumption items for specific date time.
Fields
Name | Description |
---|---|
|
List of consumption forecast items. |
|
Date time of consumption forecast. |
Example
{
"startAt": "2020-01-01T00:00:00.000Z",
"forecastItem": ConsumptionForecastItemType
}
ConsumptionForecastItemType
Consumption forecast value for a specific label.
Fields
Name | Description |
---|---|
|
Label of consumption forecast. |
|
Unit of the value. |
|
Value of forecast consumption. |
Example
{
"label": "abc123",
"value": "1.0",
"unit": "abc123"
}
Contract
A legally binding relationship agreed with a subject (e.g. an account).
Fields
Name | Description |
---|---|
|
Date when the contract was cancelled, null if not cancelled. |
|
Unique identifier for the contract. |
|
The current version information for this contract. |
|
The party (Account or Business) that entered into this contract |
|
Date when the contract was signed. |
|
The status of the contract. |
|
The accounts impacted by this contract |
|
The terms of the contract. |
|
Title of the contract. |
|
Date from which the contract is valid. |
|
Date until which the contract is valid, null if the contract is rolling. |
Example
{
"identifier": NonEmptyString,
"title": "abc123",
"party": ContractParty,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"signedAt": "2020-01-01T00:00:00.000Z",
"cancelledAt": "2020-01-01T00:00:00.000Z",
"lifecycle": ContractVersion,
"terms": TermInterface
}
ContractMetaDataType
Represents additional metadata for a contract term.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The additional metadata of the contract. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"metadata": {"key": "value"}
}
ContractTerminationInstigated
Contract termination was successfully instigated.
Fields
Name | Description |
---|---|
|
The message to display to the user on termination instigation. |
Example
{
"message": "abc123"
}
ContractVersion
Represents a version of a contract with its effective date.
Fields
Name | Description |
---|---|
|
The date from which this version of the contract becomes effective. |
|
The reference number for this contract version. |
Example
{
"versionReference": 1,
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}
ContributionAgreementType
A single Contribution Agreement.
Fields
Name | Description |
---|---|
|
The start datetime of the agreement. |
|
The end datetime of the agreement, if any. |
|
The amount contributed per interval. Note, this is in the smallest domination that the currecy support. e.g. Pence, Cents, Yen, etc. |
|
The scheme to which the agreement contributes. |
|
|
|
The frequency of contributions. |
|
The periods over which contributions have been made. |
Example
{
"id": "abc123",
"contributionScheme": ContributionSchemeType,
"interval": "MONTHLY",
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z",
"amount": 1,
"periods": ContributionPeriodConnection
}
ContributionPeriodConnection
Pagination for contribution periods.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ContributionPeriodEdge,
"totalCount": 1,
"edgeCount": 1
}
ContributionPeriodEdge
A Relay edge containing a ContributionPeriod
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ContributionPeriodType,
"cursor": "abc123"
}
ContributionPeriodType
A single Contribution Period.
Fields
Name | Description |
---|---|
|
|
|
When the contribution was fulfilled |
|
|
|
The datetime the marks the beginning of the period. |
|
The datetime the marks the end of the period. |
Example
{
"id": "abc123",
"agreement": ContributionAgreementType,
"fulfilledAt": "2020-01-01T00:00:00.000Z",
"periodFrom": "2020-01-01T00:00:00.000Z",
"periodTo": "2020-01-01T00:00:00.000Z"
}
ContributionSchemeType
A single Contribution Scheme.
Fields
Name | Description |
---|---|
|
Is this scheme currently accepting contributions? |
|
|
|
|
|
|
|
Are contributions to this scheme taxable? |
Example
{
"id": "abc123",
"code": "abc123",
"displayName": "abc123",
"taxable": true,
"acceptingContributions": true
}
Example
{
"latitude": 1.0,
"longitude": 1.0
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CoreSiteworksRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
CoreSiteworksRequestConnectionTypeEdge
A Relay edge containing a CoreSiteworksRequestConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": CoreSiteworksRequestType,
"cursor": "abc123"
}
CoreSiteworksRequestType
A Siteworks Request
Fields
Name | Description |
---|---|
|
List of appointments linked to this request. |
|
|
|
|
|
|
|
List of supply points on request. |
|
|
|
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "abc123",
"reason": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"lastStatusUpdateAt": "2020-01-01T00:00:00.000Z",
"appointments": [OnSiteJobsAppointmentType],
"marketSupplyPoints": SupplyPointConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
Consumption in kWh. |
|
Cost in pence (excl. tax). |
|
Cost in pence (incl. tax). |
Example
{
"costOfChargeId": "abc123",
"krakenflexDeviceId": "abc123",
"reportDate": "2020-01-01",
"isSmartCharge": true,
"totalConsumption": 1.0,
"totalCostExclTax": 1.0,
"totalCostInclTax": 1.0
}
CreateAPICall
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created APICall. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiCall": APICallType
}
CreateAPIException
The possible errors that can be raised are:
- KT-CT-7801: Received an invalid operationsTeamId.
- KT-CT-7802: The external identifier already exists.
- KT-CT-7805: Too many tags associated with this API Exception.
- KT-CT-7806: Cannot create duplicate tags for the same API exception.
- KT-CT-7811: Received an invalid assignedUserId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created APIException. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
CreateAPIExceptionEvent
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created APIExceptionEvent. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiExceptionEvent": APIExceptionEventType
}
CreateAPIExceptionNote
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created APIExceptionNote. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
CreateAccountCharge
Add charges to an account.
The possible errors that can be raised are:
- KT-CT-5211: The charge reason with the requested code is deprecated.
- KT-CT-5212: The charge reason with the requested code does not exist.
- KT-CT-5213: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountCharge": AccountChargeType
}
CreateAccountCredit
Add credits to an account.
The possible errors that can be raised are:
- KT-CT-5315: Invalid data.
- KT-CT-5314: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountCredit": AccountCreditType
}
CreateAccountNote
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4180: Account note must be a valid string.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Account, which has the added note. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
CreateAccountPaymentSchedule
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
New payment schedule. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
CreateAccountReference
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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
CreateAccountReminder
The possible errors that can be raised are:
- KT-CT-1401: Invalid data.
- KT-CT-1402: Unable to create account reminder.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Account reminder. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReminder": AccountReminder
}
CreateAffiliateLink
Create an affiliate link for a new sales agent.
The possible errors that can be raised are:
- KT-CT-7711: Invalid data.
- KT-CT-7713: Invalid data.
- KT-CT-7714: Invalid data.
- KT-CT-7715: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created affiliate link. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateLink": AffiliateLinkType
}
CreateAffiliateOrganisation
Create an affiliate organisation.
The possible errors that can be raised are:
- KT-CT-7716: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created affiliate organisation. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateOrganisation": AffiliateOrganisationType
}
CreateAffiliateSession
Create a session for an affiliate link.
Fields
Name | Description |
---|---|
|
The created affiliate session |
Example
{
"affiliateSession": AffiliateSessionType
}
CreateAudioRecording
The possible errors that can be raised are:
- KT-CT-7720: Invalid S3 key format.
- KT-CT-7721: Link not found.
- KT-CT-7722: Invalid input for audio recording upload.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created audio recording. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"audioRecording": AudioRecordingType
}
CreateBusiness
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11108: Invalid data.
- KT-CT-11109: Invalid data.
- KT-CT-11110: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created business. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"business": BusinessType
}
CreateCallMetadata
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11806: Call metadata item key cannot be an empty string.
- KT-CT-11807: A call metadata item with this key already exists for this call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The call metadata was attached to. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"call": CallInterface
}
CreateCampaignItems
The possible errors that can be raised are:
- KT-CT-11501: Voice campaign not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-11503: One or more campaign items are invalid and cannot be created.
- KT-CT-11504: The batch of campaign items is too large.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The identifier for this batch of items to assist in tracking and logging. |
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignItems": [VoiceCampaignItemType],
"batchIdentifier": "abc123"
}
CreateComplaint
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.
Fields
Name | Description |
---|---|
|
The complaint that has been created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"complaint": ComplaintType
}
CreateContributionAgreement
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.
Fields
Name | Description |
---|---|
|
The created contribution agreement. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
CreateCreditTransferPermission
Mutation to 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.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"validFrom": "2020-01-01T00:00:00.000Z"
}
CreateCustomerFeedback
The possible errors that can be raised are:
- KT-CT-5516: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created customer feedback object. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
CreateDepositAgreement
Create a new deposit agreement for the account if it needs one.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"depositAgreement": CreateDepositAgreementOutput
}
Example
{
"depositRequired": true,
"depositAmount": 1
}
CreateExternalAccountEvent
Create an external account event.
The possible errors that can be raised are:
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The new event data. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"event": ExternalAccountEvent
}
CreateExternalAccountUserEvent
Create an external account user event.
The possible errors that can be raised are:
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The new event data. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"event": ExternalAccountUserEvent
}
CreateGoodsPurchase
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.
Fields
Name | Description |
---|---|
|
Goods purchase created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
CreateGoodsQuote
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.
Fields
Name | Description |
---|---|
|
Goods quote created for the customer. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
CreateGoodsQuoteWithoutAccount
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.
Fields
Name | Description |
---|---|
|
Goods quote created for the customer. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
CreateInboundCall
The possible errors that can be raised are:
- KT-CT-11805: Invalid input for creating an inbound call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The call that was created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
CreateInkInboundMessagePayload
Register an Ink inbound message.
Fields
Name | Description |
---|---|
|
|
|
The Ink message that was created. |
Example
{
"message": InkMessage,
"clientMutationId": "abc123"
}
CreateMetadata
Create metadata on an object.
The possible errors that can be raised are:
- KT-CT-8412: Invalid data.
- KT-CT-8414: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}
CreateOfferGroupForQuoting
Create a quoting offer group.
The possible errors that can be raised are:
- KT-CT-12401: Unable to create offer group.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Quoting offer group. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"offerGroup": OfferGroupType
}
CreateOpportunity
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-8911: Unable to create opportunity.
- KT-CT-8907: Lead not found.
- KT-CT-8901: Unable to create lead.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The date the opportunity was created. |
|
The code of the funnel. |
|
The unique number of the opportunity. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The stage of the opportunity. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z",
"stage": "abc123",
"funnelCode": "abc123"
}
CreateOrUpdateLoyaltyCardMutation
Create a Loyalty Card for the given account user.
The possible errors that can be raised are:
- KT-CT-5412: No account user exists with the given id.
- KT-CT-8610: Invalid data.
- KT-CT-8611: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Created or updated loyalty card. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"loyaltyCard": LoyaltyCardType
}
CreatePortfolio
Create a new portfolio.
The possible errors that can be raised are:
- KT-CT-9402: Received an invalid brandCode.
- KT-CT-9401: Received an invalid operationsTeamId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created portfolio. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"portfolio": PortfolioType
}
CreatePortfolioUserRole
The possible errors that can be raised are:
- KT-CT-9403: Received an invalid portfolioId.
- KT-CT-9404: Received an invalid accountUserId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The created role for a user in association with a portfolio. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"portfolioUserRole": PortfolioUserRoleType
}
CreatePostEvents
Create post delivery events from external vendors.
The possible errors that can be raised are:
- KT-CT-9907: Post events batch size exceeded.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Number of events successfully created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"createdEventsCount": 1
}
CreateProductOutput
Output type for creating a product.
Fields
Name | Description |
---|---|
|
The created product. |
Example
{
"product": SupplyProductType
}
CreateQuoteForAccount
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
- KT-CT-4616: Unable to create a quote.
- KT-CT-4631: Unable to quote for the chosen market.
- KT-CT-4645: No supply point found belonging to the account for the provided identifier.
- KT-CT-4924: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Returns a quote request. |
Example
{
"possibleErrors": [PossibleErrorType],
"quoteRequest": MarketSupplyQuoteRequestType
}
CreateReferral
Use a referral code to create a referral and trigger a referral reward. This is for customers to refer other customers so it only works with friend referrals and not partner referrals. This will try to find a user with given referral code as their personal referral code. If found, it will create an AccountReferral instance for the given account number.
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.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"referredAccountRewardAmount": 1
}
CreateReminder
The possible errors that can be raised are:
- KT-CT-1401: Invalid data.
- KT-CT-1402: Unable to create account reminder.
- KT-CT-1403: Missing user or team assignee.
- KT-CT-1404: This reminder type is deprecated.
- KT-CT-1405: Both user and team assignee provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Account reminder. |
Example
{
"possibleErrors": [PossibleErrorType],
"reminder": Reminder
}
CreateScheduledTransactions
Mutation to create scheduled transactions.
The possible errors that can be raised are:
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3830: Invalid action.
- KT-CT-3831: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"scheduledTransactions": [ScheduledTransactionType]
}
CreateShellAccountPayload
Create a shell account (a billable account with no property/energy supply).
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Day to fixed bill on if billingperiodlength set. |
|
For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY. |
|
Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1. |
|
For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"portfolioNumber": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"billingName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"brand": "abc123",
"dateOfBirth": "2020-01-01",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingPostcode": "abc123",
"billingRichAddress": "abc123",
"billingPeriodLength": "abc123",
"billingPeriodMultiplier": 1,
"billingPeriodDay": 1,
"billingPeriodMonth": 1,
"isBusinessAccount": true,
"companyName": "abc123",
"companyNumber": "abc123",
"businessType": "abc123",
"password": "abc123",
"passwordUpdateToken": "abc123",
"urn": "abc123",
"errors": [ErrorType],
"account": AccountInterface,
"clientMutationId": "abc123"
}
CreateSourceFundRequest
Create a source fund request for a given agreement and target ledger.
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-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-FR-3911: There was a problem while creating the source fund request.
- KT-FR-3912: Invalid input provided for source fund request creation.
- KT-FR-3913: The source fund request hasn't been allowed.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Source fund request for a given agreement and target ledger. |
Example
{
"possibleErrors": [PossibleErrorType],
"sourceFundRequest": SourceFundRequest
}
Credit
A credit to the customer from the energy retailer.
Fields
Name | Description |
---|---|
|
Unique identifier of the account the transaction belongs to. |
|
Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
|
The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
|
The date time when the transaction is created. |
|
Returns True if the transaction is linked with a statement. |
|
|
|
Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
|
Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
|
Deprecated. Deprecated The 'isCredit' field is deprecated. |
|
Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
|
Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
|
|
|
Returns the note field value for the transaction, which contains additional info. |
|
|
|
Returns the reason. |
|
Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
|
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123"
}
Fields
Name | Description |
---|---|
|
The credit reason code. |
|
The credit reason display text. |
|
The group the credit reason belongs to (if applicable). |
|
Whether the credit reason is deprecated. |
|
Whether the credit reason is hidden. |
|
Whether the credit reason is sales tax exempt. |
Example
{
"code": "abc123",
"display": "abc123",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "abc123"
}
Fields
Name | Description |
---|---|
|
The credit storage balance minus any pending source fund requests (in cents). |
|
The credit storage ledger for the account. |
|
Fund sourcing requests that will be used to reduce next payment. |
|
Eligibility to create a fund source request for each charging ledger. |
|
Fund sourcing request that has been or will be used to reduce next payment. The possible errors that can be raised are:
|
Example
{
"balanceForecast": 1,
"ledger": SupplementaryLedgerType,
"pendingRequestsForPaymentReduction": SourceFundRequestConnectionTypeConnection,
"upcomingPaymentReductionRequest": SourceFundRequest,
"sourceFundRequestEligibilities": SourceFundRequestEligibilityConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
The number of the account linked to this permission. |
|
The number of the ledger linked to this permission. |
|
The datetime from which the permission is valid. |
|
The datetime to which the permission is valid. |
Example
{
"ledgerNumber": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The number of the account linked to this permission. |
|
The number of the ledger linked to this permission. |
|
The datetime from which the permission is valid. |
|
The datetime to which the permission is valid. |
Example
{
"ledgerNumber": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Permissions for credit transfers when the ledger is the target. |
|
Permissions for credit transfers when the ledger is the source. |
Example
{
"fromSourceLedgers": [CreditTransferPermissionFromSourceLedgerType],
"toTargetLedgers": [CreditTransferPermissionToTargetLedgerType]
}
CustomerFeedbackFormConnectionTypeConnection
Paginator of Customer Feedback Form.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CustomerFeedbackFormConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
CustomerFeedbackFormConnectionTypeEdge
A Relay edge containing a CustomerFeedbackFormConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": CustomerFeedbackFormType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The unique identifier for the customer feedback form. |
|
The name of the customer feedback form. |
Example
{
"id": "abc123",
"name": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
The value attached to the source |
|
The datetime the feedback was submitted |
Example
{
"id": "abc123",
"rawScore": 1,
"submittedAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The account number. |
|
The ledger identifier. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123"
}
Fields
Name | Description |
---|---|
|
The account number. |
|
The agency. |
|
The campaign. |
|
Whether the commencement could be applied. |
|
The ledger identifier. |
Example
{
"commencementStatus": true,
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"agency": "abc123",
"campaign": "abc123"
}
Fields
Name | Description |
---|---|
|
The account number. |
|
Whether the update has been applied. |
Example
{
"commencementStatus": true,
"accountNumber": "abc123"
}
Dashboard
A list of components which comprise a dashboard screen.
Fields
Name | Description |
---|---|
|
The list of sections for a dashboard. |
|
Unique identifier of the object. |
|
The serialised dashboard items. |
|
The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"dashboardItems": SectionType,
"serialisedDashboardItems": "abc123"
}
Fields
Name | Description |
---|---|
|
The cursor of the last item. |
|
Whether there are more items when paginating forwards. |
|
Whether there are previous items when paginating backwards. |
|
The cursor of the first item. |
Example
{
"startCursor": "2020-01-01T00:00:00.000Z",
"endCursor": "2020-01-01T00:00:00.000Z",
"hasPreviousPage": true,
"hasNextPage": true
}
DeauthenticateDevice
De-authenticate a registered device.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4350: Unable to de-authenticate device.
- KT-CT-4352: This device cannot currently be de-authenticated.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": DeviceDetailsType
}
DeauthenticateFlexDevice
De-authenticate a registered device by device id.
The possible errors that can be raised are:
- KT-CT-4350: Unable to de-authenticate device.
- KT-CT-4352: This device cannot currently be de-authenticated.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": DeviceDetailsType
}
Example
{
"name": "abc123",
"code": "abc123",
"isActive": true
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
Example
{
"code": "abc123",
"displayName": "abc123",
"deprecatedAt": "2020-01-01T00:00:00.000Z",
"requiresFieldVisit": true
}
Fields
Name | Description |
---|---|
|
The agency responsible for the collection proceedings. |
|
|
|
The campaign type of the collection proceedings. Deprecated The 'campaign' field is deprecated. |
|
The campaign type of the collection proceedings. |
|
|
|
|
|
Example
{
"agency": DebtCollectionAgencyType,
"campaign": "RECOUVREMENT_POST_RESILIATION_SP",
"amount": 1,
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"stopReason": "BANKRUPT",
"collectionCampaign": DebtCollectionCampaignType
}
DeductLoyaltyPoints
Deduct a set amount of loyalty points from an account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-5420: Unauthorized.
- KT-CT-9211: Invalid reason for loyalty points award.
- KT-CT-9219: Loyalty points user not found.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The ledger entry for the deducted loyalty points |
|
The number of loyalty points that were deducted. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsDeducted": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}
DeeplinkActionType
An action which navigates to the URL of another backend screen.
Fields
Name | Description |
---|---|
|
Unique identifier of the object. |
|
The name of the action object's type. |
|
The name of the object's type. |
|
The URL to navigate to. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"url": "abc123"
}
DelayerDaysType
Represents delayer days for active payment in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}
DeleteAccountReference
Delete a reference for a particular account and namespace.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8312: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": DeleteAccountReferenceType
}
Fields
Name | Description |
---|---|
|
The namespace associated with the removed AccountReference. |
Example
{
"namespace": "abc123"
}
DeleteBoostCharge
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4354: Unable to cancel boost charge.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
DeletePushNotificationBinding
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"status": "SUCCESSFUL"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
Example
{
"depositKey": "abc123",
"depositAmount": 1,
"acceptedAt": "2020-01-01T00:00:00.000Z",
"fulfilledAt": "2020-01-01T00:00:00.000Z"
}
DeviceChargingSessionConnection
Paginator for device charging session.
Fields
Name | Description |
---|---|
|
Contains the nodes in this connection. |
|
Information to aid in DateTime pagination. |
Example
{
"pageInfo": DateTimePageInfo,
"edges": DeviceChargingSessionEdge
}
DeviceChargingSessionEdge
A Relay edge containing a DeviceChargingSession
and its cursor.
Fields
Name | Description |
---|---|
|
The cursor of the item. |
|
The item at the end of the edge |
Example
{
"node": DeviceChargingSession,
"cursor": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The type of device. |
|
|
|
The third party that provides control over this device. |
Example
{
"krakenflexDeviceId": "abc123",
"provider": "BYD",
"deviceType": "BATTERIES"
}
DeviceRegistration
Register a device for smart controlling.
Where device refers to batteries, electric vehicles, heat pumps or thermostats.
The possible errors that can be raised are:
- KT-CT-4324: Device already registered error.
- KT-CT-4321: Serializer validation error.
- KT-CT-4312: Unable to register device.
- KT-CT-4363: No capable devices found.
- KT-CT-4364: Multiple devices found.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Device ID(s) of the registered device(s). |
Example
{
"possibleErrors": [PossibleErrorType],
"registeredDeviceIds": ["abc123"]
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": DirectDebitInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
DirectDebitInstructionConnectionTypeEdge
A Relay edge containing a DirectDebitInstructionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": DirectDebitInstructionType,
"cursor": "abc123"
}
DirectDebitInstructionType
Direct Debit Instructions
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The last four digits of the account number. Deprecated The 'lastFourDigitsOfAccountNumber' field is deprecated. |
|
A masked reference to a recurring payment method. |
|
A masked version of the IBAN. |
|
The owners of the financial account this instruction represents. |
|
|
|
Example
{
"id": "abc123",
"status": "abc123",
"sortCode": "abc123",
"iban": "abc123",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"lastFourDigitsOfAccountNumber": "abc123",
"maskedAccountIdentifier": "abc123",
"maskedIban": "abc123",
"owners": [PaymentInstructionOwnerType]
}
Fields
Name | Description |
---|---|
|
The discount as a decimal between 0 and 1. |
|
This type will return additional market specific information. For example, some markets support wind direction, fan speed, wind speed, etc. while others do not. |
|
Timestamp for the discount. |
Example
{
"startAt": "2020-01-01T00:00:00.000Z",
"discount": "1.0",
"metaData": FanClubMetadataOutput
}
Fields
Name | Description |
---|---|
|
The start time that the ensemble forecast simulation. |
|
Discount forecast data-points. |
Example
{
"baseTime": "2020-01-01T00:00:00.000Z",
"data": ForecastData
}
Fields
Name | Description |
---|---|
|
This field is replacing |
|
|
|
|
|
Shows the availability status of an integration. |
|
|
|
|
|
|
|
|
|
Example
{
"vehicleId": 1,
"model": "abc123",
"year": 1,
"availableFrom": 1,
"availableTo": 1,
"batterySize": "1.0",
"supportedProviders": ["abc123"],
"isIntegrationLive": true,
"integrationStatus": "INTERNAL_TESTING"
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"make": "abc123",
"models": [ElectricVehicleModelType]
}
Fields
Name | Description |
---|---|
|
The agreement created for the activation process. |
|
The annual consumption linked to this activation process. |
|
The addresses fields. |
|
|
|
ID of the activation process. |
|
If an IBAN for activation is already stored on the activation process. |
|
The type of journey the client is in, either commissioning or change of supplier. |
|
|
|
The provider calendar. |
|
The quoted product of the activation process. |
|
Requested supply start date. |
|
Status of the activation process. |
|
The stored IBAN for the activation process. |
|
|
|
|
|
The supply point linked to the agreement of the activation process. |
|
The email of the identified user. |
|
The family name of the identified user. |
|
The given name of the identified user. |
|
The mobile of the identified user. |
|
Example
{
"id": "abc123",
"agreement": AgreementType,
"caseId": "abc123",
"requestedSupplyStartDate": "2020-01-01",
"withdrawalPeriodEndsAt": "2020-01-01T00:00:00.000Z",
"prm": ElectricityMeterPoint,
"subscriptionType": "CDF",
"subscribedMaxPower": "1.0",
"status": "NEW",
"journeyType": "COMMISSIONING",
"billingAddress": AddressType,
"quotedProduct": QuotedProduct,
"userGivenName": "abc123",
"userFamilyName": "abc123",
"userEmail": "abc123",
"userMobile": "abc123",
"isIbanStoredForSetupOfInstruction": true,
"storedIban": "abc123",
"supplyPoint": SupplyPointType,
"providerCalendarId": "abc123",
"annualConsumption": ElectricityAnnualConsumption
}
ElectricityConsumption
Electricity consumption during a period.
Fields
Name | Description |
---|---|
|
Consumptions grouped by category (BASE, HPHC...). |
|
End of the period (exclusive). |
|
Start of the period (inclusive). |
|
Total consumption over the period. |
Example
{
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"total": "1.0",
"consumptions": [ElectricityConsumptionByCategory]
}
ElectricityConsumptionByCategory
Consumption during a period and for a defined calendar and subscribed maximum power.
Fields
Name | Description |
---|---|
|
Calendar used during the period. |
|
Item grouped for this period. |
|
End of the period (exclusive). |
|
Start of the period (inclusive). |
|
Subscribed maximum power during the period. |
|
Total consumption over the period. |
Example
{
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"total": "1.0",
"calendar": "abc123",
"subscribedMaxPower": "1.0",
"consumptions": [ElectricityConsumptionItem]
}
ElectricityConsumptionConnection
Pagination for energy consumption readings.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ElectricityConsumptionEdge,
"totalCount": 1,
"edgeCount": 1
}
ElectricityConsumptionEdge
A Relay edge containing a ElectricityConsumption
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ElectricityConsumption,
"cursor": "abc123"
}
ElectricityConsumptionForecastType
Electricity consumption forecast.
Fields
Name | Description |
---|---|
|
Estimated annual consumption. |
|
Typical electricity consumption depending on the housing surface and/or heating type. |
Example
{
"macroForecast": MacroElectricityConsumptionForecastType,
"annualConsumption": ElectricityAnnualConsumption
}
ElectricityConsumptionItem
Base consumption item
Fields
Name | Description |
---|---|
|
Calendar for this consumption. |
|
Currency used in the net_amount field. |
|
Amount without taxes. |
|
Value of the consumption. |
Example
{
"value": "1.0",
"netAmount": "1.0",
"calendarClass": "abc123",
"currency": "abc123"
}
Fields
Name | Description |
---|---|
|
Price currency. |
|
Time slot where the energy is being used. |
|
Maximum subscribed max power (in kVA) up to which the rate applies. |
|
Minimum subscribed max power (in kVA) for which the rate applies. |
|
Price per unit (without taxes). |
|
Price per unit (with taxes). |
|
Provider calendar for which the rate applies. |
|
Unit type. |
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "abc123",
"pricePerUnit": "1.0",
"pricePerUnitWithTaxes": "1.0",
"minSubscribedMaxPower": 1,
"maxSubscribedMaxPower": 1,
"providerCalendar": "ALL_DAY",
"energyUseTimeSlot": "ALL_DAY"
}
Fields
Name | Description |
---|---|
|
End date (exclusive) of the record. |
|
Start date (inclusive) of the record. |
|
List of measures for the specified period. |
|
Reference to PRM. |
Example
{
"prmRef": "abc123",
"periodStartDate": "2020-01-01",
"periodEndDate": "2020-01-01",
"physicalMeasures": [ElectricityPhysicalMeasure]
}
Fields
Name | Description |
---|---|
|
The identifier of the device associated to this reading. |
|
The identifier of the market supply point associated to this reading. |
|
Reading direction is based on the utility generated or consumed by the customer. |
|
The frequency of the reading. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The identifier of the register associated to this reading. |
Example
{
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}
Fields
Name | Description |
---|---|
|
Calendar temp class (BASE or HP/HC). |
|
Calendar temp class (BASE/HP/HC). |
|
Calendar type (DISTRIBUTOR/PROVIDER). |
|
Amount of consumption during record period. |
|
End date (exclusive) of the record. |
|
Start date (inclusive) of the record. |
|
Reference to PRM. |
|
Record index reliability (REAL/ESTIMATED/CORRECTED). |
|
Raw processed status. |
Example
{
"consumption": 1,
"periodStartAt": "2020-01-01T00:00:00.000Z",
"periodEndAt": "2020-01-01T00:00:00.000Z",
"prmRef": "abc123",
"statusRaw": "abc123",
"calendarType": "abc123",
"calendarRef": "abc123",
"calendarTempClass": "abc123",
"reliability": "abc123"
}
ElectricityMeterPoint
Data of a given PRM (French electricity meter point).
Fields
Name | Description |
---|---|
|
The addresses fields. |
|
circuit breaker instensity. |
|
The customer category of the PRM. |
|
The contractual status of the distributor. |
|
The ID of the meter point. |
|
if the the meter point is sensitive or not. |
|
Whether the meter point is considered smart or not. |
|
if the meter point isis_teleoperable or not. |
|
Whether the meter point is three-phase or not. |
|
The date on which the power rating of the meter was last decreased. |
|
date when power increased. |
|
last provider calendar name. |
|
Last available readings (HP/HC or BASE). |
|
The date on which the routing tariff was last modified. |
|
The kind of the meter point. |
|
number of wires in a meter point. |
|
The off-peak timeframe(s) of the day. |
|
The power of the meter point's connection. |
|
The status of the power supply. |
|
The property ID of the meter point. |
|
The calendar ID used by the provider. |
|
The calendar name/label used by the provider. |
|
segment of the meter point . |
|
|
|
The subscribed maximum power. |
Example
{
"serviceLevel": 1,
"id": "abc123",
"propertyId": "abc123",
"address": AddressType,
"isSmartMeter": true,
"meterKind": "abc123",
"lastReadings": [ElectricityReading],
"providerCalendarId": "abc123",
"providerCalendarName": "abc123",
"offPeakLabel": "abc123",
"subscribedMaxPower": "1.0",
"customerCategory": "abc123",
"isThreePhase": true,
"distributorStatus": "abc123",
"poweredStatus": "abc123",
"lastPowerDecreaseDate": "2020-01-01",
"lastRoutingTariffModifDate": "2020-01-01",
"powerDraw": "1.0",
"segment": "abc123",
"isSensitive": true,
"isTeleoperable": true,
"nbWires": 1,
"lastPowerIncreaseDate": "2020-01-01",
"lastProviderCalendarName": "abc123",
"circuitBreakerIntensity": "abc123"
}
Fields
Name | Description |
---|---|
|
Physical measure's type. |
|
Unit of the measure. |
|
List of measure values for the specified type. |
Example
{
"type": "abc123",
"unit": "abc123",
"values": [ElectricityPhysicalMeasureValue]
}
Fields
Name | Description |
---|---|
|
Time at which the measure was taken. |
|
Value of the measure. |
Example
{
"value": 1,
"measuredAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Calendar temp class (BASE/HP/HC). |
|
Calendar type (DISTRIBUTOR/PROVIDER). |
|
Amount of consumption during record period. |
|
Record consumption reliability (REAL/ESTIMATED/CORRECTED). |
|
End index value of the record. |
|
Record index reliability (REAL/ESTIMATED/SELF_READING). |
|
Start index value of the record. |
|
End date of the record. |
|
Start date of the record. |
|
Record reading date. |
|
Record processed status. |
Example
{
"consumption": 1,
"readingDate": "abc123",
"periodStartAt": "2020-01-01T00:00:00.000Z",
"periodEndAt": "2020-01-01T00:00:00.000Z",
"indexStartValue": 1,
"indexEndValue": 1,
"statusProcessed": "abc123",
"calendarType": "abc123",
"calendarTempClass": "abc123",
"consumptionReliability": "abc123",
"indexReliability": "abc123"
}
ElectricityReadingConnection
Pagination for energy readings.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ElectricityReadingEdge,
"totalCount": 1,
"edgeCount": 1
}
ElectricityReadingEdge
A Relay edge containing a ElectricityReading
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ElectricityReading,
"cursor": "abc123"
}
ElectricitySpecificAgreementType
Fields related only to the electricity agreement.
Fields
Name | Description |
---|---|
|
The datetime the agreement was entered. |
|
The datetime the agreement was terminated. |
|
Temporal classes available for this agreement. |
|
The frequency (in month periods) of the agreement. |
|
The billing name of the account associated with the agreement. |
|
The ledger used for charging. |
|
The industry consents related to supply_point. |
|
The current direct debit instruction linked to the agreement. |
|
The current payment instruction linked to the payment_schedule on agreement. |
|
Product detailed cost information, including both standing and consumption rates. |
|
The ID of the agreement. |
|
Data related to the industry consents. |
|
Whether the agreement is active right now. |
|
Whether the agreement is revoked. |
|
The next payment forecast for the agreement. |
|
The next payment or repayment for the agreement. |
|
The payment schedule instruction type linked to the most recent payment_schedule on agreement. |
|
Data related to the PRM. |
|
The product associated with the agreement. |
|
Sales channel. |
|
Sales subchannel. |
|
The status of the agreement (based on the activation process). |
|
The supply contrat number related to the agreement. |
|
Data related to the supply point. |
|
The starting date and time for the agreement. |
|
The ending date and time for the agreement. |
Example
{
"id": 1,
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true,
"status": "NEW",
"isActive": true,
"product": Product,
"billingFrequency": 1,
"billingName": "abc123",
"supplyContractNumber": "abc123",
"supplyPoint": SupplyPointType,
"industryConsentData": FraConsentData,
"consents": IndustryConsentData,
"nextPaymentOrRepayment": FraPaymentsInterface,
"chargingLedger": SupplementaryLedgerType,
"currentDirectDebitInstruction": DirectDebitInstructionType,
"currentPaymentInstruction": PaymentInstructionType,
"paymentScheduleInstructionType": "BACS_TRANSFER",
"nextPaymentForecast": PaymentForecastType,
"energySupplyRate": EnergySupplyRate,
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"prmData": AgreementPRMData,
"availableTemporalClasses": ["abc123"]
}
Fields
Name | Description |
---|---|
|
Price currency. |
|
Maximum subscribed max power (in kVA) up to which the rate applies. |
|
Minimum subscribed max power (in kVA) for which the rate applies. |
|
Price per unit (without taxes). |
|
Price per unit (with taxes). |
|
Provider calendar for which the rate applies. |
|
Unit type. |
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "abc123",
"pricePerUnit": "1.0",
"pricePerUnitWithTaxes": "1.0",
"minSubscribedMaxPower": 1,
"maxSubscribedMaxPower": 1,
"providerCalendar": "ALL_DAY"
}
EmailAttachmentType
Represents a file to attach to a email message.
Fields
Name | Description |
---|---|
|
|
|
|
|
Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"temporaryUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
The ID of the object |
|
Email message of the email event. Returns null for message's sent/received by other user's on the account. |
|
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": EmailType
}
EmailType
Represents an email communication
Fields
Name | Description |
---|---|
|
Attachments of the email message. |
|
|
|
|
|
|
|
|
|
|
|
|
|
Email recipient. |
|
Email sender. |
|
|
|
Subject line of the email message. |
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"channel": "EMAIL",
"toAddress": "abc123",
"fromEmail": "abc123",
"toNumber": "abc123",
"fromNumber": "abc123",
"templateCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"sentAt": "2020-01-01T00:00:00.000Z",
"attachments": [EmailAttachmentType],
"subject": "abc123",
"textBody": "abc123",
"htmlBody": "abc123",
"sender": "abc123",
"recipient": "abc123"
}
Fields
Name | Description |
---|---|
|
The email address to be checked. |
|
The status of verification for associated email. |
Example
{
"email": "abc123",
"status": "NOT_SENT"
}
Fields
Name | Description |
---|---|
|
The identifier of the device associated to this reading. |
|
The identifier of the market supply point associated to this reading. |
|
Reading direction is based on the utility generated or consumed by the customer. |
|
The frequency of the reading. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The identifier of the register associated to this reading. |
Example
{
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}
EmbeddedNetworkType
Represents an embedded network that holds multiple embedded properties.
Fields
Name | Description |
---|---|
|
Get details about properties in an embedded network. |
|
|
|
A unique name/code for the network |
Example
{
"id": "abc123",
"name": "abc123",
"embeddedProperties": [EmbeddedPropertyType]
}
EmbeddedPropertyType
Represents an embedded property in an embedded network.
Fields
Name | Description |
---|---|
|
|
|
|
|
The id of the physical property related to this embedded property type. |
Example
{
"id": "abc123",
"embeddedNetwork": EmbeddedNetworkType,
"propertyId": "abc123"
}
EndContributionAgreement
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.
Fields
Name | Description |
---|---|
|
The created contribution agreement. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
Energy
Describes the energy (not power) consumed (e.g. as electricity) or returned (e.g. as heat) by a system over a given span of time.
Differs from Power
in that it describes the total amount of energy transferred during a
given time frame (not a single point in time).
Fields
Name | Description |
---|---|
|
The units in which the energy is being measured. |
|
The amount of energy (not power) transmitted. |
Example
{
"value": "1.0",
"unit": "KILOWATT_HOUR"
}
EnergyCheque
An energy cheque.
Fields
Name | Description |
---|---|
|
Amount in Eurocents |
|
|
|
|
|
|
|
Number displayed on the cheque. |
|
|
|
Example
{
"number": "abc123",
"protectionFrom": "2020-01-01",
"protectionTo": "2020-01-01",
"amount": 1,
"validTo": "2020-01-01",
"status": "VALID",
"shortNumber": "abc123"
}
EnergyChequeCertificate
An energy cheque certificate.
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
Number displayed on the cheque. |
Example
{
"number": "abc123",
"protectionFrom": "2020-01-01",
"protectionTo": "2020-01-01",
"shortNumber": "abc123"
}
EnergyConsumptionRateConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": EnergyConsumptionRateConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
EnergyConsumptionRateConnectionTypeEdge
A Relay edge containing a EnergyConsumptionRateConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": EnergyConsumptionRateType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The display of the choice. |
|
The code of the choice. |
Example
{
"value": "abc123",
"text": "abc123"
}
Fields
Name | Description |
---|---|
|
Name of the field. |
|
Field object. |
Example
{
"fieldName": "abc123",
"fieldObject": EnergyLandscapeFieldInterface
}
EnergyMixDataType
Energy mix data can include the latest carbon intensity index in a region.
Fields
Name | Description |
---|---|
|
Current carbon intensity index. |
Example
{
"carbonIntensityIndex": "abc123"
}
EnergyStandingRateConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": EnergyStandingRateConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
EnergyStandingRateConnectionTypeEdge
A Relay edge containing a EnergyStandingRateConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": EnergyStandingRateType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Product variable cost that vary depending on the consumption. |
|
Product fixed cost. |
Example
{
"standingRate": SupplyProductRateType,
"consumptionRates": SupplyConsumptionRateConnectionTypeConnection
}
Example
{
"linkState": "abc123",
"linkUrl": "abc123"
}
EnqueueInboundCall
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11803: Unable to enqueue the call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The call that was enqueued. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"call": InboundCallType
}
EnrollAccountInLoyaltyProgram
Enroll an account into the loyalty program.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9213: ineligible loyalty points enrollment.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Outcome of the loyalty points campaign enrollment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"outcome": EnrollAccountInLoyaltyProgramOutcome
}
Fields
Name | Description |
---|---|
|
Whether or not this account has been enrolled in the loyalty points campaign. |
Example
{
"hasEnrolled": true
}
EnrollFanClubAccount
Try to enroll an account onto Fan Club.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-8104: Account already enrolled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Result of the Fan Club enrollment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"enrollmentOutput": EnrollFanClubAccountOutputType
}
Fields
Name | Description |
---|---|
|
Example
{
"status": "ELIGIBLE"
}
EnrollmentCancelled
Enrollment was successfully cancelled.
Fields
Name | Description |
---|---|
|
The Enrollment process that was cancelled. |
|
The message to display to the user on Enrollment initiation. |
Example
{
"message": "abc123",
"enrollmentProcess": EnrollmentProcess
}
EnrollmentInitiated
Enrollment was successfully initiated.
Fields
Name | Description |
---|---|
|
The Enrollment processes that were initiated. |
|
The message to display to the user on Enrollment initiation. |
Example
{
"enrollmentProcesses": EnrollmentProcess,
"message": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"field": "abc123",
"messages": "abc123"
}
Fields
Name | Description |
---|---|
|
Monetary currency of the statistic in ISO-4217 format. |
|
|
|
Net price per unit of the statistic if applicable. |
Example
{
"estimatedAmount": "1.0",
"costCurrency": "abc123",
"pricePerUnit": PricePerUnit
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"category": "abc123",
"subcategory": "abc123",
"description": "abc123",
"content": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"eventType": "abc123",
"category": "abc123",
"subcategory": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"description": "abc123",
"content": {"key": "value"}
}
FanClubDiscountNotification
Send a push notification of there being a high likelihood of getting a Fan Club discount.
The possible errors that can be raised are:
- KT-CT-8106: No catchments provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Boolean indicating if Fan Club notifications were triggered. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
Fields
Name | Description |
---|---|
|
The instantaneous turbine output power in kW. |
|
The turbine's rotor speed in revolutions per minute. |
|
The total amount of electricity grid-wide from all sources in megawatts. |
|
A decimal in degrees representing the direction from which the wind is blowing. 360.0 degrees indicates the wind blows from the north. Read more here: https://confluence.ecmwf.int/pages/viewpage.action?pageId=133262398 |
|
The total amount of electricity grid-wide from wind in megawatts. |
|
The proportion of electricity on the grid coming from wind. Ranges from 0.0 - 1.0. |
|
The wind speed in m/s. |
Example
{
"power": "1.0",
"windSpeed": "1.0",
"windDirection": "1.0",
"rotorSpeed": "1.0",
"windPowerOnGrid": "1.0",
"totalPowerOnGrid": "1.0",
"windPowerProportion": "1.0"
}
FanClubNonOctopusCustomerComms
The possible errors that can be raised are:
- KT-CT-8107: Invalid eligibility status.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Flag for whether Fan Club comms for non-Octopus customer were sent. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
Fields
Name | Description |
---|---|
|
The list of account numbers for the source and account user. |
|
The list of catchments that this discount source applies to. |
|
The current or 'live' status of discounts for this source. |
|
The source for the discount, e.g. 'Fan 1' for a wind turbine in UK, or an ERCOT Load Zone for US. |
|
The forecasted discount probabilities for this source. |
|
The historic discounts for this source. |
|
The location of the discount source. |
|
The name of the discount source. |
|
The list of property IDs for the source and account user. |
|
The details of Fan Club thresholds for the discount source. |
|
The wind farm that the discount source is part of. |
Example
{
"discountSource": "abc123",
"name": "abc123",
"location": "abc123",
"windFarm": "abc123",
"accountNumbers": "abc123",
"propertyIds": 1,
"catchments": "abc123",
"thresholds": Threshold,
"current": DiscountData,
"historic": DiscountData,
"forecast": DiscountForecast
}
FetchGeneratePaymentFingerprint
The possible errors that can be raised are:
- KT-CT-12101: Payment instruction not found.
- KT-CT-12102: Payment vendor not supported.
- KT-CT-12103: Missing payment metadata from vendor.
- KT-CT-12104: Unable to fetch or generate payment fingerprint.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Fetched or generated fingerprint from vendor. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Vendor name. |
Example
{
"possibleErrors": [PossibleErrorType],
"fingerprint": "abc123",
"vendor": "abc123"
}
Fields
Name | Description |
---|---|
|
The name of the GraphQL field for which the rate is limited. |
|
Whether the viewer is currently blocked from making requests to this field due to exceeding the allowed request rate. |
|
Indicates the rate limit allowed for this field (e.g. 10/m). |
|
Time to live: The time remaining before the user is unblocked from making requests to this field. |
Example
{
"field": "abc123",
"rate": "abc123",
"ttl": 1,
"isBlocked": true
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FieldSpecificRateLimitInformationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
FieldSpecificRateLimitInformationConnectionTypeEdge
A Relay edge containing a FieldSpecificRateLimitInformationConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
The item at the end of the edge |
Example
{
"node": FieldSpecificRateLimitInformation,
"cursor": "abc123"
}
Example
{
"amount": 1,
"currency": "abc123"
}
Fields
Name | Description |
---|---|
|
The ID type. Currently only 'meter_point' is supported. |
|
The ID to be checked. |
|
Returns True if the risk identifier is in the risk list. |
|
Returns the level of risk for the supplied object between |
Example
{
"identifierValue": "abc123",
"identifierType": "abc123",
"riskLevel": "1.0",
"isInRiskList": true
}
Fields
Name | Description |
---|---|
|
The unique id of the device preference schedule setting. |
|
The maximum value a preference can be set to (inclusive). |
|
The minimum value a preference can be set to (inclusive). |
|
The step size preference can be set to. |
|
The minimum time a preference can be set to (inclusive). |
|
The step amount (in minutes) a preference schedule time can be set. |
|
The maximum time a preference can be set to (inclusive). |
Example
{
"id": 1,
"timeFrom": "00:00:00.000Z",
"timeTo": "00:00:00.000Z",
"timeStep": 1,
"min": "1.0",
"max": "1.0",
"step": "1.0"
}
Fields
Name | Description |
---|---|
|
The device type of the setting. |
|
The unique id of the device preference setting. |
|
The mode of the setting. |
|
Scheduled preference settings. |
|
The unit of the min and max values in the preferences setting. |
Example
{
"id": 1,
"deviceType": "abc123",
"mode": "CHARGE",
"unit": "CELSIUS",
"scheduleSettings": FlexDevicePreferenceScheduleSettingInterface
}
Fields
Name | Description |
---|---|
|
The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid. |
|
Reports whether the mutation applied successfully. Should always be 'true'. |
Example
{
"tokensInvalidated": true,
"effectiveAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Lower confidence interval bound for forecasted power (kW). |
|
The best guess for forecasted power (kW). |
|
Upper confidence interval bound for forecasted power (kW). |
|
Projected discount based on ensemble forecast data. |
|
Timestamp for the data-point. |
Example
{
"validTime": "2020-01-01T00:00:00.000Z",
"projectedDiscount": "1.0",
"powerMedian": "1.0",
"powerLowerBound": "1.0",
"powerUpperBound": "1.0"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
Example
{
"id": 1,
"content": {"key": "value"},
"errors": [SerializerFieldErrorsType]
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FraAccountPaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
FraAccountPaymentConnectionTypeEdge
A Relay edge containing a FraAccountPaymentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": FraPaymentsInterface,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Amount of payment in pence |
|
The ID of the payment/repayment. |
|
|
|
The market name of the related supply point. |
|
The date this payment is scheduled to be debited |
|
The payment instruction that was used to make this payment. |
|
The reason of the payment. |
|
|
|
|
|
The current status of the payment. |
|
Surcharge amount generated by this payment. |
|
The transaction type of the payment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"reference": "abc123",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"idempotencyKey": "abc123",
"scheduledAt": "2020-01-01T00:00:00.000Z",
"marketName": "abc123",
"paymentInstruction": PaymentInstructionType,
"surchargeAmount": 1,
"reason": "ACCOUNT_CHARGE_PAYMENT"
}
Fields
Name | Description |
---|---|
|
Amount of payment in pence |
|
The ID of the payment/repayment. |
|
The market name of the related supply point. |
|
The date this payment is scheduled to be debited |
|
The reason of the repayment. |
|
The current status of the repayment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"marketName": "abc123",
"repaymentStatus": "REQUESTED",
"repaymentReason": "FULL_CREDIT_REFUND"
}
Fields
Name | Description |
---|---|
|
The related agreement id. |
|
The amount of the billing document. |
|
|
|
The type of the bill. |
|
The closing balance of an issued billing document. |
|
Position of the billing document in the delinquent debt tracking system. |
|
The date of the bill is covered from. |
|
The ID of the bill. |
|
The unique identifier for the billing document. Note: a pending billing document will not have an identifier yet; and not all finalized billing documents will have an identifier assigned to them, in which case this will be null. |
|
Whether the billing document has been annulled. |
|
The date the bill was sent to the customer. |
|
The market name of the related supply point. |
|
|
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the bill is covered to. |
|
The total amounts for all charges on the billing document. |
|
The total amounts for all credits on the statement. |
|
Transactions on the given ledger. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "abc123",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"isAnnulled": true,
"transactions": BillTransactionConnectionTypeConnection,
"closingBalance": 1,
"documentDebtPosition": BillingDocumentPositionType,
"representations": BillRepresentationConnectionTypeConnection,
"amount": "1.0",
"marketName": "abc123",
"agreementId": "abc123"
}
FraBillsConnection
Pagination for bills.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FraBillsEdge,
"totalCount": 1,
"edgeCount": 1
}
FraBillsEdge
A Relay edge containing a FraBills
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": FraBillingDocumentType,
"cursor": "abc123"
}
FraConsentData
Consents for French Distribution Network Operators.
Fields
Name | Description |
---|---|
|
Consent to fetch enedis curves. |
|
Consent to fetch enedis index. |
Example
{
"enedisIndex": true,
"enedisCurves": true
}
Fields
Name | Description |
---|---|
|
The url to fetch the terms and agreements. |
|
The effective date of the terms and agreements. |
|
The name of the terms and agreements. |
|
The version of the terms and agreements. |
Example
{
"name": "abc123",
"documentUrl": "abc123",
"version": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}
FractionSizeType
A fractional measurement.
Fields
Name | Description |
---|---|
|
The fractional value. |
|
Unique identifier of the object. |
|
The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"fraction": "1.0"
}
Fields
Name | Description |
---|---|
|
Returns True if the meter point ID is in the list of suspicious meter point IDs. |
|
The meter point ID. |
Example
{
"meterPointId": "abc123",
"isInSuspiciousList": true
}
FulfilmentType
Represents an amount of money that can be used to fulfil an obligation.
Fields
Name | Description |
---|---|
|
The amount of the fulfilment (in minor currency units), unsigned. |
|
The database ID of the fulfilment source, e.g. the database ID of the payment. |
|
The type of the fulfilment source, e.g. PAYMENT. |
Example
{
"sourceType": "UNKNOWN",
"sourceIdentifier": "abc123",
"amount": 1
}
FundingSourceAmountConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FundingSourceAmountConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
FundingSourceAmountConnectionTypeEdge
A Relay edge containing a FundingSourceAmountConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": FundingSourceAmountType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Amount used from a funding source in minor currency. |
|
Reason why the funding source was used. |
Example
{
"reason": "abc123",
"amount": 1
}
Fields
Name | Description |
---|---|
|
The agreement created for the activation process. |
|
The annual consumption linked to this activation process. |
|
The addresses fields. |
|
ID of the activation process. |
|
If an IBAN for activation is already stored on the activation process. |
|
The type of journey the client is in, either commissioning or change of supplier. |
|
Price level linked the activation process. |
|
The quoted product of the activation process. |
|
Requested supply start date. |
|
Status of the activation process. |
|
The stored IBAN for the activation process. |
|
The supply point linked to the agreement of the activation process. |
|
The email of the identified user. |
|
The family name of the identified user. |
|
The given name of the identified user. |
|
The mobile of the identified user. |
|
Example
{
"id": "abc123",
"agreement": AgreementType,
"status": "NEW",
"requestedSupplyStartDate": "2020-01-01",
"withdrawalPeriodEndsAt": "2020-01-01T00:00:00.000Z",
"journeyType": "COMMISSIONING",
"billingAddress": AddressType,
"quotedProduct": QuotedProduct,
"userGivenName": "abc123",
"userFamilyName": "abc123",
"userEmail": "abc123",
"userMobile": "abc123",
"isIbanStoredForSetupOfInstruction": true,
"storedIban": "abc123",
"supplyPoint": SupplyPointType,
"priceLevel": 1,
"annualConsumption": AllDayAnnualConsumptionType
}
GasConsumptionForecastType
Gas consumption forecast.
Fields
Name | Description |
---|---|
|
Estimated annual consumption. |
|
Typical gas consumption depending on the housing surface. |
Example
{
"macroForecast": MacroGasConsumptionForecastType,
"annualConsumption": AllDayAnnualConsumptionType
}
Fields
Name | Description |
---|---|
|
Consumption class identifier. |
|
Price currency. |
|
Maximum annual consumption (in kWh) up to which the rate applies. |
|
Minimum annual consumption (in kWh) for which the rate applies. |
|
Ranges from 1 to 6 depending on your geographic location. Lower means closer to the gas storage point thus cheaper. |
|
Price per unit (without taxes). |
|
Price per unit (with taxes). |
|
Unit type. |
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "abc123",
"pricePerUnit": "1.0",
"pricePerUnitWithTaxes": "1.0",
"minAnnualConsumption": 1,
"maxAnnualConsumption": 1,
"consumptionClassId": "abc123",
"priceLevel": 1
}
GasFiltersOutput
Filter measurements by gas parameters.
Fields
Name | Description |
---|---|
|
The identifier of the device associated to this reading. |
|
The identifier of the market supply point associated to this reading. |
|
The frequency of the reading. |
|
The identifier of the register associated to this reading. |
Example
{
"registerId": "abc123",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}
GasMeterPoint
Data of a given PCE (French gas meter point).
Fields
Name | Description |
---|---|
|
The addresses fields. |
|
The current Annual Reference Consumption (ARC) of the PCE, in kWh. |
|
The contractual status of the meter point. |
|
The gas nature of the PCE. |
|
The ID of the meter point. |
|
Whether the meter point is considered smart or not. |
|
The next Estimated Annual Consumption of the PCE, in kWh. |
|
The powered status of the PCE. |
|
The last price level of the PCE. |
|
The property ID of the meter point. |
|
The serial number of the PCE. |
|
The tariff option of the PCE. |
Example
{
"serial": "abc123",
"gasNature": "abc123",
"id": "abc123",
"propertyId": "abc123",
"address": AddressType,
"isSmartMeter": true,
"annualConsumption": 1,
"tariffOption": "T1",
"priceLevel": 1,
"poweredStatus": "abc123",
"nextAnnualConsumption": 1,
"contractualStatus": "abc123"
}
Fields
Name | Description |
---|---|
|
Amount of consumption during record period. |
|
Record energy qualification. |
|
End index value of the record. |
|
Start index value of the record. |
|
End date of the record. |
|
Start date of the record. |
|
Record reading date. |
|
Record reading type. |
|
Record processed status. |
Example
{
"consumption": 1,
"readingDate": "abc123",
"periodStartAt": "2020-01-01T00:00:00.000Z",
"periodEndAt": "2020-01-01T00:00:00.000Z",
"indexStartValue": 1,
"indexEndValue": 1,
"statusProcessed": "abc123",
"readingType": "abc123",
"energyQualification": "abc123"
}
GasReadingConnection
Pagination for gas readings.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": GasReadingEdge,
"totalCount": 1,
"edgeCount": 1
}
GasReadingEdge
A Relay edge containing a GasReading
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": GasReading,
"cursor": "abc123"
}
GasSpecificAgreementType
Fields related only to the gas agreement.
Fields
Name | Description |
---|---|
|
The datetime the agreement was entered. |
|
The datetime the agreement was terminated. |
|
The frequency (in month periods) of the agreement. |
|
The billing name of the account associated with the agreement. |
|
The ledger used for charging. |
|
The industry consents related to supply_point. |
|
Gas consumption class identifier. |
|
The current direct debit instruction linked to the agreement. |
|
The current payment instruction linked to the payment_schedule on agreement. |
|
Product detailed cost information, including both standing and consumption rates. |
|
The ID of the agreement. |
|
Data related to the industry consents. |
|
Whether the agreement is active right now. |
|
Whether the agreement is revoked. |
|
The next payment forecast for the agreement. |
|
The next payment or repayment for the agreement. |
|
The payment schedule instruction type linked to the most recent payment_schedule on agreement. |
|
The product associated with the agreement. |
|
Sales channel. |
|
Sales subchannel. |
|
The status of the agreement (based on the activation process). |
|
The supply contrat number related to the agreement. |
|
Data related to the supply point. |
|
The starting date and time for the agreement. |
|
The ending date and time for the agreement. |
Example
{
"id": 1,
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true,
"status": "NEW",
"isActive": true,
"product": Product,
"billingFrequency": 1,
"billingName": "abc123",
"supplyContractNumber": "abc123",
"supplyPoint": SupplyPointType,
"industryConsentData": FraConsentData,
"consents": IndustryConsentData,
"nextPaymentOrRepayment": FraPaymentsInterface,
"chargingLedger": SupplementaryLedgerType,
"currentDirectDebitInstruction": DirectDebitInstructionType,
"currentPaymentInstruction": PaymentInstructionType,
"paymentScheduleInstructionType": "BACS_TRANSFER",
"nextPaymentForecast": PaymentForecastType,
"energySupplyRate": EnergySupplyRate,
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"consumptionClassId": "abc123"
}
Fields
Name | Description |
---|---|
|
Consumption class identifier. |
|
Price currency. |
|
Maximum annual consumption (in kWh) up to which the rate applies. |
|
Minimum annual consumption (in kWh) for which the rate applies. |
|
Price per unit (without taxes). |
|
Price per unit (with taxes). |
|
Unit type. |
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "abc123",
"pricePerUnit": "1.0",
"pricePerUnitWithTaxes": "1.0",
"minAnnualConsumption": 1,
"maxAnnualConsumption": 1,
"consumptionClassId": "abc123"
}
GenerateAffiliatesAudioRecordingPreSignedUrl
Generate a pre-signed URL for uploading a audio file for use with affiliates.
Fields
Name | Description |
---|---|
|
Input fields required to generate a presigned S3 post for affiliates audio recording. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliatesAudioRecordingPreSignedUrl": AffiliateAudioRecordingPresignedPostType
}
GenerateInkPresignedUrl
The possible errors that can be raised are:
- KT-CT-7620: Channel not supported.
- KT-CT-7618: Unable to process message.
- KT-CT-7624: Error when generating the presigned URL.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Presigned post fields required to upload the file. |
|
The key for the item. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
A presigned URL for the user to upload to the quarantine bucket. |
Example
{
"possibleErrors": [PossibleErrorType],
"uploadUrl": "abc123",
"key": "abc123",
"fields": {"key": "value"}
}
GeneratePreSignedToken
Mutation to generate a pre-signed token.
The pre-signed, expiring and opaque tokens will be swapped for a limited scope JWT (Kraken Token).
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1120: The Kraken Token has expired.
- KT-CT-1131: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
|
|
|
|
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"tokenExpiryDatetime": "2020-01-01T00:00:00.000Z",
"scope": "SUBMIT_METER_READINGS"
}
GenericBackendScreen
A generic backend screen that can be used to define any type of screen.
Fields
Name | Description |
---|---|
|
The name of the screen. |
|
The refresh / polling frequency in milliseconds. |
|
Serialized JSON representation of the screen. |
Example
{
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123"
}
GetEmbeddedSecretForNewPaymentInstruction
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
Get the client secret needed to create a new stored payment instruction using an embedded form.
This mutation is specifically for saving payment methods for future use, without immediately creating a payment instruction tied to a specific ledger or account.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
GetHostedUrlForNewPaymentInstruction
Get external URL where the user can set up a payment instruction.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"url": "abc123"
}
GetOrCreateShellAccountForOpportunity
The possible errors that can be raised are:
- KT-CT-8903: Unable to update opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The account number of the newly created or existing account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123"
}
Fields
Name | Description |
---|---|
|
Currency. |
|
Gross amount. |
|
Net amount. |
|
Grant type. |
Example
{
"type": "abc123",
"netAmount": 1.0,
"grossAmount": 1.0,
"currency": "abc123"
}
Fields
Name | Description |
---|---|
|
Product available from. |
|
Product available to. |
|
Product code. |
|
Currency. |
|
Product customer name. |
|
Product description. |
|
Gross price per unit. |
|
Product ID. |
|
Product internal name. |
|
Market of the product. |
|
Product notes. |
|
Price per unit. |
|
Type of the product. |
Example
{
"id": 1,
"marketName": "abc123",
"productType": GoodsProductType,
"code": "abc123",
"internalName": "abc123",
"customerName": "abc123",
"notes": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01",
"availableTo": "2020-01-01",
"pricePerUnit": 1.0,
"grossPricePerUnit": 1.0,
"currency": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": GoodsProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
GoodsProductConnectionTypeEdge
A Relay edge containing a GoodsProductConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": GoodsProduct,
"cursor": "abc123"
}
Example
{
"code": "abc123",
"internalName": "abc123"
}
Fields
Name | Description |
---|---|
|
Client parameters of the purchase. |
|
Purchase code. |
|
Grants that apply in this purchase. |
|
Sale items in this purchase. |
|
Ledger ID associated to the purchase. Deprecated The 'ledgerId' field is deprecated. |
|
The ledger number associated to the purchase. |
|
Market name of the purchase. |
|
Market parameters of the purchase. |
Example
{
"code": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"goodsSaleItems": [GoodsSaleItem],
"goodsGrants": [GoodsGrant],
"marketName": "abc123",
"marketParams": {"key": "value"},
"clientParams": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
Code of the quote. |
|
Products of this quote. |
|
Indicates whether or not the quote is expired. |
|
ID of the quote. |
|
Date and time when the quote was created. |
|
Total net amount of the quote in cents. |
Example
{
"id": "abc123",
"code": "abc123",
"totalNetAmount": 1,
"quotedAt": "2020-01-01T00:00:00.000Z",
"goodsQuotedProducts": [GoodsQuotedProduct],
"hasQuoteExpired": true
}
Fields
Name | Description |
---|---|
|
The ID of the quote share. |
Example
{
"id": "abc123"
}
Fields
Name | Description |
---|---|
|
Currency. |
|
Net amount. |
|
Number of units. |
|
Price per unit. |
|
Product code. |
Example
{
"product": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1,
"netAmount": 1,
"currency": "abc123"
}
Fields
Name | Description |
---|---|
|
Currency. |
|
Gross amount. |
|
Net amount. |
|
Number of units. |
|
Price per unit. |
|
Product code. |
Example
{
"product": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1.0,
"netAmount": 1.0,
"grossAmount": 1.0,
"currency": "abc123"
}
GuaranteeOfOriginConfigurationType
Configuration for Guarantee of Origin term, defining percentage of energy from renewable sources.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The percentage of the guarantee of origin. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"guaranteeOfOriginPercentage": "ZERO"
}
HardshipAgreementType
Represents a Hardship Agreement for a particular Account.
Fields
Name | Description |
---|---|
|
These are internal notes detailing the hardship. |
|
|
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"hardshipType": "DEATH_IN_FAMILY",
"hardshipDetails": "abc123",
"hardshipEntryReason": "SELF_IDENTIFIED",
"paymentPlanDetails": "abc123",
"startDate": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
Whether a statement is currently held. |
|
Reason for statement being held. |
Example
{
"isHeld": true,
"reason": "abc123"
}
ImageType
A media element containing an image.
Fields
Name | Description |
---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
The horizontal alignment of the media. |
|
Unique identifier of the object. |
|
The resource URL of the media. |
|
The name of the object's type. |
|
The measurement of the element. |
Example
{
"width": ItemSizeType,
"mediaUrl": "abc123",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123"
}
Fields
Name | Description |
---|---|
|
The average number of seconds passed before an inbound call is answered. This value represents the calls received in the last 30 minutes. |
|
The average number of seconds passed before an inbound call is answered. This value represents the calls received on the previous day. |
Example
{
"yesterday": 1,
"recent": 1
}
Fields
Name | Description |
---|---|
|
If known, this is the account that a call is about. For inbound calls, we attempt to identify the account based on the phone number of the incoming call. For outbound calls, the account will be automatically set if the call was initiated from an account page. For all call types, the account can be updated, for example to correct a misidentification of an incoming call. |
|
The ID of the call. |
|
When an inbound call is received, we identify all entities linked to the phone number of the caller. |
|
Metadata related to the call, for example metrics or data passed via an interactive voice response (IVR). |
Example
{
"id": "abc123",
"account": AccountType,
"metadata": CallMetadataItemType,
"initialCallerIdentification": PhoneNumberIdentificationType
}
Fields
Name | Description |
---|---|
|
The escalation start date for the product rate override configuration. |
|
The index code for the product rate override configuration. |
Example
{
"indexCode": "abc123",
"escalationStartAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Update the consent to fetch daily consumption. |
|
Update the consent to fetch half-hourly consumption. |
Example
{
"collectDailyConsumptionData": true,
"collectHalfHourlyConsumptionData": true
}
Fields
Name | Description |
---|---|
|
The account number of the newly created account or the existing account to be re-used. |
|
Was a new account created. |
Example
{
"isNewAccount": true,
"accountNumber": "abc123"
}
Fields
Name | Description |
---|---|
|
Was a new user created. |
|
The user number of the newly created user or the existing user to be re-used. |
Example
{
"isNewUser": true,
"userNumber": "abc123"
}
InitiateHostedStandalonePayment
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.
Fields
Name | Description |
---|---|
|
The details required to refer to and complete a hosted payment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": InitiateHostedStandalonePaymentOutput
}
InitiateHostedStandalonePaymentOutput
Tokens required to collect and retrieve a standalone payment.
Fields
Name | Description |
---|---|
|
The retrieval token for this standalone payment. |
|
The url for the customer to complete the payment. |
Example
{
"retrievalToken": "abc123",
"url": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
The newly initiated live chat. If an open live chat already exists for the given account, that is returned instead. |
Example
{
"liveChat": InkLiveChat,
"clientMutationId": "abc123"
}
InitiateProductSwitch
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-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"productCode": "abc123",
"switchDate": "2020-01-01"
}
InitiateStandalonePayment
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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": InitiateStandalonePaymentOutput
}
InitiateStandalonePaymentOutput
Tokens required to collect and retrieve a standalone payment.
Fields
Name | Description |
---|---|
|
The retrieval token for this standalone payment. |
|
The secret used to collect the payment. |
Example
{
"retrievalToken": "abc123",
"secretToken": "abc123"
}
Fields
Name | Description |
---|---|
|
The icon code point. |
|
The ID of the object |
|
The ink bucket name. |
Example
{
"id": "abc123",
"name": "abc123",
"icon": "abc123"
}
Fields
Name | Description |
---|---|
All contacts for this conversation. |
|
|
The default contact for this conversation. |
Example
{
"default": InkContactChannelIdentity,
"all": InkContactChannelIdentity
}
Fields
Name | Description |
---|---|
|
The channel of the contact. |
|
The name to display to the user. |
|
The handle. |
Example
{
"channel": "EMAIL",
"handle": "abc123",
"displayName": "abc123"
}
Fields
Name | Description |
---|---|
|
The account users on the conversation. |
|
The buckets the conversation is currently in. |
|
The contact channel identities associated with this conversation. |
|
Conversation events. |
|
|
|
The status of the conversation. |
Example
{
"id": "abc123",
"status": "OPEN",
"contactChannelIdentities": InkContactChannelIdentities,
"accountUsers": [AccountUserType],
"events": InkConversationEventsConnection,
"buckets": [InkBucket]
}
Fields
Name | Description |
---|---|
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": InkConversationEventsEdge
}
InkConversationEventsEdge
A Relay edge containing a InkConversationEvents
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": InkConversationEvent,
"cursor": "abc123"
}
InkEmail
This type wraps around the Message
type for emails.
Fields
Name | Description |
---|---|
|
Attachments on the message. |
|
CC recipients on the message. |
|
The contact channel identity. |
|
The delivery status of the message. |
|
The direction of the email. |
|
The content of the message. |
|
From email address. |
|
Is this an message an email. |
|
The time the message was sent/received. |
|
The email subject. |
|
All Tags associated with a message. |
|
The addresses that the message was sent to. |
Example
{
"direction": "INBOUND",
"toHandles": ["abc123"],
"fromHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"subject": "abc123",
"displayContent": "abc123",
"attachments": InkMessageAttachment,
"cc": "abc123",
"isChannelEmail": true,
"tags": InkTag
}
InkGenericMessage
This message type is used for messages that belong to contact channels without a more granular message type.
Fields
Name | Description |
---|---|
|
The contact channel identity. |
|
The delivery status. |
|
The direction of the message. |
|
The content of the message. |
|
The identity the message was sent from. |
|
The ID of the object |
|
The time the message was sent/received at. |
|
The identity the message was sent to. |
Example
{
"id": "abc123",
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123"
}
InkLine
This type wraps around the Message
type for LINE message.
Fields
Name | Description |
---|---|
|
Attachments on the LINE message. |
|
The contact channel identity. |
|
The delivery status of the message. |
|
The direction of the message. |
|
From LINE id. |
|
Is this a LINE message. |
|
The line message content. |
|
The time the message was sent/received. |
|
All Tags associated with a message. |
|
To LINE id. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"lineMessage": LineMessage,
"isChannelLine": true,
"attachments": InkMessageAttachment,
"tags": InkTag
}
InkLiveChat
Ink live chat
Fields
Name | Description |
---|---|
|
The relay ID of the live chat. |
Example
{
"relayId": "abc123"
}
Fields
Name | Description |
---|---|
|
The url for fetching the attachment. |
|
The filename. |
|
The size in bytes. |
Example
{
"filename": "abc123",
"fetchUrl": "abc123",
"sizeInBytes": 1
}
Fields
Name | Description |
---|---|
|
Message delivery status. |
Example
{
"status": "PENDING"
}
InkNewMessage
This types is used for both the message-received and message-sent conversation events.
Fields
Name | Description |
---|---|
|
The message. |
|
The time the conversation event occurred. |
Example
{
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": InkMessage
}
Fields
Name | Description |
---|---|
|
The content of the ink note. |
|
The ID of the object |
|
The note is pinned, so that it's always visible in the conversation. |
|
The datetime at which the conversation note occurred. |
Example
{
"id": "abc123",
"content": "abc123",
"isPinned": true,
"occurredAt": "2020-01-01T00:00:00.000Z"
}
InkPost
This type wraps around the Message
type for Post.
Fields
Name | Description |
---|---|
|
The contact channel identity. |
|
The notes left when a message was uploaded. |
|
The from property id. |
|
Determine if the message is a post message. |
|
The content of the message. |
|
The to property id. |
Example
{
"fromHandle": "abc123",
"toHandle": "abc123",
"displayContent": "abc123",
"rawPlainTextContent": "abc123",
"isChannelPost": true,
"contactChannelIdentity": InkContactChannelIdentity
}
InkSMS
This type wraps around the Message
type for SMS.
Fields
Name | Description |
---|---|
|
The contact channel identity. |
|
The delivery status. |
|
The direction of the message. |
|
The content of the message. |
|
The phone number the message was sent from. |
|
Is this an SMS message. |
|
The time the message was sent/received at. |
|
All Tags associated with a message. |
|
The phone number the message was sent to. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123",
"isChannelSms": true,
"tags": InkTag
}
Example
{
"id": "abc123",
"name": "abc123"
}
InkTwilioWhatsApp
This type wraps around the Message
type for a Twilio WhatsApp message.
Fields
Name | Description |
---|---|
|
Twilio WhatsApp message contact channel identity. |
|
Message delivery status. |
|
The direction of the message. |
|
From WhatsApp number. |
|
Date when the conversation event was created. |
|
All Tags associated with a message. |
|
To WhatsApp number. |
|
The vendor id. |
|
Whatsapp message content. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"vendorId": "abc123",
"whatsappContent": WhatsAppTextMessage,
"tags": InkTag
}
InkWhatsApp
This type wraps around the Message
type for WhatsApp message.
Fields
Name | Description |
---|---|
|
Whatsapp message contact channel identity. |
|
Whatsapp message delivery status. |
|
The direction of the message. |
|
From WhatsApp phone number. |
|
Whether or not the message is a whatsapp message. |
|
Date when the conversation event was created. |
|
All Tags associated with a message. |
|
Whatsapp contact phone number. |
|
The vendor id. |
|
Whatsapp message content. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"vendorId": "abc123",
"whatsappContent": WhatsAppTextMessage,
"isChannelWhatsapp": true,
"tags": InkTag
}
Fields
Name | Description |
---|---|
|
Is field disabled. Deprecated The 'energyLandscape' field is deprecated. |
|
Display text for the field. |
|
Should the field be hidden. |
|
Maximum value of the field. |
|
Minimum value of the field. |
|
Is required. |
Example
{
"required": true,
"helpText": "abc123",
"disabled": true,
"hidden": true,
"minValue": 1,
"maxValue": 1
}
Fields
Name | Description |
---|---|
|
Deprecated The 'accumulation' field is deprecated. |
|
The duration of the measurement. |
|
The end datetime of the measurement. |
|
This type will return more granular data about the measurement. |
|
The datetime the measurement was taken. |
|
The data source of the measurement. |
|
The start datetime of the measurement. |
|
The unit of the measurement. |
|
The value of the measurement. |
Example
{
"source": "abc123",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "abc123",
"readAt": "2020-01-01T00:00:00.000Z",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"durationInSeconds": 1,
"accumulation": "1.0"
}
InvalidatePaymentInstruction
Invalidates a payment 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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"instruction": InvalidatePaymentInstructionOutput
}
InvalidatePaymentInstructionOutput
Output for invalidating an arbitrary payment instruction.
Fields
Name | Description |
---|---|
|
Example
{
"id": 1
}
InvalidatePreSignedToken
Invalidate a previously issued expiring/pre-signed token.
This mutation can be used to invalidate the token itself.
To invalidate tokens issued to a particular user, use InvalidatePreSignedTokensForUser mutation.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"token": PreSignedToken
}
InvalidatePreSignedTokensForUser
Invalidate pre-signed tokens previously issued to a particular user.
This mutation can invalidate all pre-signed tokens issued to a customer, or only tokens of a given scope.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"tokens": [PreSignedToken]
}
InvalidateRefreshToken
Invalidate a previously issued refresh token.
This mutation can be used to invalidate the token itself. To invalidate tokens issued to a particular user, use InvalidateRefreshTokensForUser.
The possible errors that can be raised are:
- KT-CT-1130: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"token": RefreshToken
}
InvalidateRefreshTokensForUser
Invalidate refresh tokens previously issued to a particular user.
This mutation will invalidate all refresh tokens issued to a customer.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"tokens": [RefreshToken]
}
InvoiceBillingDocumentConnectionTypeConnection
An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": InvoiceBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
InvoiceBillingDocumentConnectionTypeEdge
A Relay edge containing a InvoiceBillingDocumentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": InvoiceBillingDocumentType,
"cursor": "abc123"
}
InvoiceBillingDocumentType
An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.
Fields
Name | Description |
---|---|
|
Billing document that annuls this invoice. |
|
Position of the billing document in the delinquent debt tracking system. |
|
First time the invoice was issued. |
|
|
|
The invoiced amount of the billing document. |
|
The unique billing document's reference that can be used for identifying it externally. |
|
URL to the PDF of the Invoice. |
|
The total amounts for all charges on the invoice. |
|
The total amounts for all credits on the invoice. |
|
Transactions on the invoice |
Example
{
"id": 1,
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"number": "abc123",
"invoicedAmount": 1,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType
}
Fields
Name | Description |
---|---|
|
The gross total amount for the statement (in minor currency units). |
|
The net total amount for the statement (in minor currency units). |
|
The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 1,
"taxTotal": 1,
"grossTotal": 1
}
Fields
Name | Description |
---|---|
|
|
|
The type of the bill. |
|
The date of the bill is covered from. |
|
This field returns the total gross amount of the bill in pence. |
|
The ID of the bill. |
|
The unique identifier of a bill. It will usually be present on the billing document itself. Note: a bill that hasn't been issued yet will not have an identifier; and not all issued bills will have an identifier assigned to them, in which case this will be null. |
|
Whether the billing document has been annulled. |
|
The date the bill was sent to the customer. |
|
|
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the bill is covered to. |
|
The total amounts for all charges on the invoice. |
|
The total amounts for all credits on the invoice. |
|
The sum of all previous payments made that are included towards this invoice. |
|
Transactions on the given ledger. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "abc123",
"grossAmount": 1,
"isAnnulled": true,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"totalPayments": 1,
"transactions": BillTransactionConnectionTypeConnection,
"representations": BillRepresentationConnectionTypeConnection
}
JoinSupplierAcceptTermsAndConditions
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.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": JoinSupplierProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
JoinSupplierProcessConnectionTypeEdge
A Relay edge containing a JoinSupplierProcessConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": JoinSupplierProcessType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Affiliate link for the join supplier journey. |
|
The note associated with this join supplier process data. |
|
When the journey was requested. |
|
Sales channel. |
|
Sales subchannel. |
|
The supply point context data. |
Example
{
"requestedAt": "2020-01-01T00:00:00.000Z",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"affiliateLink": AffiliateLinkType,
"supplyPointContexts": SupplyPointContextDataInterface,
"note": "abc123"
}
JoinSupplierProcessType
Represents a Join Supplier process.
Fields
Name | Description |
---|---|
|
The current process data associated with the Join Supplier process. |
|
The ID or the primary key of the lifecycle process. |
|
The unique identifier of the process. |
|
The status of the process. |
|
The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"number": "abc123",
"currentProcessData": JoinSupplierProcessDataType
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
The third party that provides control over this device. |
|
Maximum state of charge (SoC) limit telemetry. |
|
|
|
|
|
The reason for the most recent failed test dispatch (if any). |
|
|
|
|
|
Example
{
"krakenflexDeviceId": "abc123",
"provider": "BYD",
"vehicleMake": "abc123",
"vehicleModel": "abc123",
"vehicleBatterySizeInKwh": "1.0",
"chargePointMake": "abc123",
"chargePointModel": "abc123",
"chargePointPowerInKw": "1.0",
"status": "abc123",
"suspended": true,
"hasToken": true,
"createdAt": "2020-01-01T00:00:00.000Z",
"stateOfChargeLimit": StateOfChargeLimit,
"testDispatchFailureReason": "NONE"
}
KrakenVersionType
Information about what version of Kraken is being executed by this service.
Fields
Name | Description |
---|---|
|
The git commit SHA that is being executed. |
|
The version number that is being executed. |
Example
{
"number": "abc123",
"SHA": "abc123"
}
LatePaymentFeesType
Represents later payment fees to be applied in a contract.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The flat fee amount for late payment. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The percentage fee for late payment. |
|
The interval in days for the percentage fee (1=daily, 7=weekly, 30=monthly, 365=yearly). |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"flatFeeAmount": "1.0",
"percentageFee": "1.0",
"percentageIntervalDays": "1.0"
}
Fields
Name | Description |
---|---|
|
List of block list hits found. |
|
Indicates if the block list validation passed. |
Example
{
"valid": true,
"blockListHits": ["abc123"]
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": LeavePropertyProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
LeavePropertyProcessConnectionTypeEdge
A Relay edge containing a LeavePropertyProcessConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": LeavePropertyProcessType,
"cursor": "abc123"
}
LeavePropertyProcessType
Represents a Leave Property process.
Fields
Name | Description |
---|---|
|
The ID or the primary key of the lifecycle process. |
|
The status of the process. |
|
The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection
}
LeaveSupplierCancelled
Output of a LeaveSupplier journey cancellation.
Fields
Name | Description |
---|---|
|
The message to display to the user on cancellation. |
Example
{
"message": "abc123"
}
LeaveSupplierInstigated
Termination was successfully initiated.
Fields
Name | Description |
---|---|
|
The ID of the newly created or existing leave supplier process. Deprecated The 'leaveSupplierProcessId' field is deprecated. |
|
The message to display to the user on termination initiation. |
|
The number of the newly created or existing leave supplier process. |
Example
{
"number": "abc123",
"leaveSupplierProcessId": "abc123",
"message": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": LeaveSupplierProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
LeaveSupplierProcessConnectionTypeEdge
A Relay edge containing a LeaveSupplierProcessConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": LeaveSupplierProcessType,
"cursor": "abc123"
}
LeaveSupplierProcessType
Represents a Leave Supplier process. Conceptually, it contains information related to supply points that are associated with a Leave Supplier journey.
Fields
Name | Description |
---|---|
|
The ID or the primary key of the lifecycle process. |
|
The unique identifier of the process. |
|
The status of the process. |
|
The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"number": "abc123",
"supplyPoints": SupplyPointConnectionTypeConnection
}
LeaveSupplierUpdated
Leave supplier was successfully updated.
Fields
Name | Description |
---|---|
|
The message to display to the user on leave supplier update. |
Example
{
"message": "abc123"
}
LedgerType
Ledgers provide the foundation of Kraken’s bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular Kraken account.
Fields
Name | Description |
---|---|
|
Whether payments can be posted onto this ledger. |
|
Whether this ledger's balance contributes to the account's balance. |
|
The charged supply agreements of the ledger. |
|
The amount owed from the customer perspective. A positive value implies the customer owes the business, while a negative amount implies the customer is in credit. |
|
The current balance on the ledger in minor units of currency. |
|
Permissions data for credit transfers involving the given ledger. |
|
True if the current direct debit instruction has been invalidated by vendor. False otherwise. |
|
The debt ledger assigned to this ledger. |
|
Deprecated The 'ledgerId' field is deprecated. |
An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time. |
|
|
The ledger type code. |
|
The display name of the ledger. |
|
The canonical name of the ledger. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The customer's preferred payment methods. |
|
Refund requests for a given ledger. |
|
Repayment requests for a given ledger. |
|
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series. |
|
Is it possible for this ledger to contain invoices. |
|
Is it possible for this ledger to contain statements. |
|
Transactions on the given ledger. |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"ledgerType": "abc123",
"balance": 1,
"amountOwedByCustomer": 1,
"affectsAccountBalance": true,
"statements": StatementBillingDocumentConnectionTypeConnection,
"invoices": InvoiceBillingDocumentConnectionTypeConnection,
"transactions": TransactionConnectionTypeConnection,
"repaymentRequests": RepaymentRequestConnectionTypeConnection,
"refundRequests": RefundRequestConnectionTypeConnection,
"acceptsPayments": true,
"paymentAdequacy": PaymentAdequacyDetailsType,
"creditTransferPermissionsData": CreditTransferPermissionsDataType,
"paymentPreferences": PaymentPreferenceConnectionTypeConnection,
"debtLedger": LedgerType,
"agreements": AgreementConnection,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true
}
Fields
Name | Description |
---|---|
|
List of JoinSupplierProcess for an account. |
|
List of LeavePropertyProcess for an account. |
|
List of LeaveSupplierProcess for an account. |
|
List of OccupyPropertyProcess for an account. |
Example
{
"leaveSupplierProcesses": LeaveSupplierProcessConnectionTypeConnection,
"joinSupplierProcesses": JoinSupplierProcessConnectionTypeConnection,
"occupyPropertyProcesses": OccupyPropertyProcessConnectionTypeConnection,
"leavePropertyProcesses": LeavePropertyProcessConnectionTypeConnection
}
LineCommonError
A base error type. Should be used for general application or lower level errors.
Fields
Name | Description |
---|---|
|
The field that for which this error should be associated. |
|
The error message to display to the user. |
Example
{
"message": "abc123",
"field": "abc123"
}
LineEmoji
A LINE specific emoji object. refs: https://developers.line.biz/en/reference/messaging-api/#text-message
Fields
Name | Description |
---|---|
|
The emoji id. |
|
The location of the emoji in the message. |
|
The length of the emoji string placeholder. |
|
The product id. |
Example
{
"index": 1,
"length": 1,
"productId": "abc123",
"emojiId": "abc123"
}
LineLinkRedirectResponse
Link Successful. Complete link process with LINE.
Fields
Name | Description |
---|---|
|
Example
{
"redirectUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
Keywords describing the sticker. |
|
Sticker package id. |
|
Sticker resource type. |
|
Sticker id. |
|
Text used to customize some stickers. |
Example
{
"packageId": "abc123",
"stickerId": "abc123",
"resourceType": "abc123",
"keywords": "abc123",
"text": "abc123"
}
Fields
Name | Description |
---|---|
|
The display content. |
|
The emojis in the message. |
Example
{
"displayContent": "abc123",
"emojis": [LineEmoji]
}
LinkAccountToBusiness
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11104: Business role already allocated.
- KT-CT-11105: Business role already allocated.
- KT-CT-11106: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The business the account was linked to. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"business": BusinessType
}
LinkActionType
An action which navigates to any URL.
Fields
Name | Description |
---|---|
|
Unique identifier of the object. |
|
The name of the action object's type. |
|
The name of the object's type. |
|
The URL to navigate to. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"url": "abc123"
}
LinkTokenNotFound
Returned when no LineAccountLink record matching the parameters exists.
Fields
Name | Description |
---|---|
|
The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}
Fields
Name | Description |
---|---|
|
The combined average montly cost for all markets based on usage. |
|
Suggested temporary adjustment to ongoing usage amount to cover debt or overpayment. |
|
Breakdown of customer's estimated or real usage per market and per month. |
|
The balance the ledger has at the time of review. |
|
The amount the customer is paying monthly at the time of the review. |
|
The date that we used to calculate the review of the ledger. |
|
The suggested monthly payment amount in minor currency following the payment adequacy review. |
|
The balance we expect the ledger to have at the end period of the review. |
Example
{
"suggestedNewMonthlyAmount": 1,
"consumption": ConsumptionBreakdownConnectionTypeConnection,
"averageMonthlyCharge": 1,
"existingMonthlyAmount": 1,
"balanceAdjustment": 1,
"currentBalance": 1,
"targetBalance": 1,
"reviewedOn": "2020-01-01"
}
LoyaltyCardType
A loyalty card.
Fields
Name | Description |
---|---|
|
|
|
The number of the loyalty card. |
|
The scheme of the loyalty card. |
|
The status of the loyalty card. |
Example
{
"id": "abc123",
"scheme": "abc123",
"number": "abc123",
"status": "abc123"
}
LoyaltyPointLedgerEntryType
A Loyalty Point ledger entry.
Fields
Name | Description |
---|---|
|
The account number associated with the entry. |
|
Equal to the |
|
Equal to the |
|
|
|
A unique idempotency key for the operation. |
|
The |
|
The date the points were added to the ledger. |
|
The reason the entry was being added. |
|
The value of the charge or credit. |
Example
{
"id": "abc123",
"ledgerType": "abc123",
"value": "abc123",
"balanceBroughtForward": "abc123",
"balanceCarriedForward": "abc123",
"reasonCode": "abc123",
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"postedAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123"
}
Fields
Name | Description |
---|---|
|
Whether the account is eligible to join the loyalty points program. |
|
The primary reason for ineligibility, if any. |
Example
{
"isEligible": true,
"primaryIneligibilityReason": "abc123"
}
MacroElectricityConsumptionForecastType
Represents typical electricity consumptions based on the type of heating
Fields
Name | Description |
---|---|
Electric heating and housing surface >100m2 or any other heating and housing surface >140m2. |
|
Electric heating and housing surface <50m2 or any other heating and housing surface <100m2. |
|
|
Electric heating and housing surface <100m2 or any other heating and housing surface <140m2. |
Example
{
"low": ElectricityAnnualConsumption,
"medium": ElectricityAnnualConsumption,
"high": ElectricityAnnualConsumption
}
MacroGasConsumptionForecastType
Represents typical gas consumptions based on the housing surface.
Fields
Name | Description |
---|---|
|
Housing surface >140m2. |
Housing surface <100m2. |
|
|
Housing surface <140m2. |
Example
{
"low": AllDayAnnualConsumptionType,
"medium": AllDayAnnualConsumptionType,
"high": AllDayAnnualConsumptionType
}
MarkPrintBatchAsProcessed
Mark a closed print batch as Processed
The possible errors that can be raised are:
- KT-CT-9011: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"printBatch": PrintBatchType
}
MarketSupplyQuoteRequestType
A quote request.
Fields
Name | Description |
---|---|
|
|
|
The code of the created quote. |
|
List of quoted supply points. |
|
|
|
List of terms and conditions applicable to the quote. |
Example
{
"acceptedAt": "2020-01-01T00:00:00.000Z",
"requestedAt": "2020-01-01T00:00:00.000Z",
"code": "abc123",
"quotedSupplyPoints": MarketSupplyQuotedSupplyPointConnectionTypeConnection,
"termsAndConditions": TermsAndConditionsConnectionTypeConnection
}
MarketSupplyQuotedProductConnectionTypeConnection
Pagination for quoted products.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MarketSupplyQuotedProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
MarketSupplyQuotedProductConnectionTypeEdge
A Relay edge containing a MarketSupplyQuotedProductConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
The item at the end of the edge |
Example
{
"node": MarketSupplyQuotedProductType,
"cursor": "abc123"
}
MarketSupplyQuotedProductType
A product quoted for a supply point.
Fields
Name | Description |
---|---|
|
A JSON object containing client parameters on the quoted product. |
|
|
|
The product associated with the quoted product. |
|
Example
{
"id": "abc123",
"wasSelected": true,
"product": SupplyProductType,
"clientParams": {"key": "value"}
}
MarketSupplyQuotedSupplyPointConnectionTypeConnection
Pagination for quoted supply points.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MarketSupplyQuotedSupplyPointConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
MarketSupplyQuotedSupplyPointConnectionTypeEdge
A Relay edge containing a MarketSupplyQuotedSupplyPointConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
The item at the end of the edge |
Example
{
"node": MarketSupplyQuotedSupplyPointType,
"cursor": "abc123"
}
MarketSupplyQuotedSupplyPointType
A supply point quoted as part of a quote request.
Fields
Name | Description |
---|---|
|
A JSON object containing client parameters on the quoted product. |
|
The ID of the quoted supply point. |
|
The identifier of the quoted supply point, if one exists. |
|
The market this supply point belongs to. |
|
Details of all products quoted for this supply point. |
|
The supply point being quoted. |
Example
{
"marketName": "abc123",
"id": "abc123",
"identifier": "abc123",
"quotedProducts": MarketSupplyQuotedProductConnectionTypeConnection,
"supplyPoint": SupplyPointType,
"clientParams": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
A list of any errors that occurred while running this mutation. |
|
A Kraken Token that can be used to authenticate to the API, masquerading as the desired user. |
Example
{
"token": "abc123",
"errors": [ErrorType]
}
Fields
Name | Description |
---|---|
|
The maximum amount available to be requested as a refund. |
|
The reason why a specific amount is the maximum available to be requested as a refund. |
|
The recommended minimum balance an account should have when asking for a refund. |
Example
{
"amount": 1,
"reasonToRecommendAmount": "MAX_AVAILABLE_AMOUNT",
"recommendedBalance": 1
}
MeasurementConnection
Pagination for measurements.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MeasurementEdge,
"totalCount": 1,
"edgeCount": 1
}
MeasurementEdge
A Relay edge containing a Measurement
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": MeasurementInterface,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
This type will return more granular data about the measurement. |
|
The datetime the measurement was taken. |
|
The data source of the measurement. |
|
The unit of the measurement. |
|
The value of the measurement. |
Example
{
"source": "abc123",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "abc123",
"readAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Statistics relating to the parent measurement node. |
|
The source information relating to the parent measurement node. |
Example
{
"utilityFilters": UtilityFiltersOutput,
"statistics": [StatisticOutput]
}
Fields
Name | Description |
---|---|
|
The channel that the message was sent through. |
|
The date/time that Kraken dispatched the message to the vendor. |
|
The date/time that the message was confirmed as having failed to send. |
Example
{
"channel": "EMAIL",
"dispatchedAt": "2020-01-01T00:00:00.000Z",
"failedAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MessageEdge,
"totalCount": 1,
"edgeCount": 1
}
MessageEdge
A Relay edge containing a Message
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Message,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The key for the metadata. |
|
The metadata value. |
Example
{
"key": "abc123",
"value": {"key": "value"}
}
MinimumContractLengthType
Represents the minimum term of a contract.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The minimum length of the contract. |
|
The type of the term. |
|
The unit of time for the contract length. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"length": 1,
"unitOfTime": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
The ISO-4217 code for the currency. |
Example
{
"amount": "1.0",
"currency": "abc123"
}
NotifiableApplicationType
Represents an application that can receive push notifications.
Fields
Name | Description |
---|---|
|
Bundle ID or package name of the app. |
|
|
|
Project ID used in push notification delivery service. (Currently: AWS Pinpoint) |
|
|
|
|
|
Human readable name for the app. |
|
|
|
Example
{
"id": "abc123",
"name": "abc123",
"bundleId": "abc123",
"service": "GCM",
"externalProvider": "PINPOINT",
"externalProjectId": "abc123",
"description": "abc123",
"pushNotificationBindings": PushNotificationBindingType
}
OCPPAuthentication
Open Charge Point Protocol (OCPP) authentication.
Take the given OCPP authentication details and trigger OCPP authentication.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4310: Unable to register OCPP authentication details.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
Example
{
"url": "abc123",
"username": "abc123"
}
ObtainKrakenJSONWebToken
The unifying approach used to get a Kraken token (JWT: JSON Web Token) with different types of input.
The currently supported inputs are: - account user email/password combination - account user API key - organization live secret key - pre-signed key - refresh token
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.
Fields
Name | Description |
---|---|
|
The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
A Unix timestamp representing the point in time at which the refresh token will expire. |
|
A token that can be used in a subsequent call to |
|
The Kraken Token. Can be used in the |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1
}
ObtainLongLivedRefreshToken
Obtain a long-lived refresh token.
This mutation is limited to authorized third-party organizations only.
Account users can only generate short-lived refresh tokens.
The short-lived refresh tokens (for account users) can be obtained from the 'refreshToken' field in 'obtainKrakenToken' mutation.
The possible errors that can be raised are:
- KT-CT-1120: The Kraken Token has expired.
- KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
- KT-CT-1132: Unauthorized.
- KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
|
|
Example
{
"possibleErrors": [PossibleErrorType],
"refreshToken": "abc123",
"refreshExpiresIn": 1
}
OccupancyPeriodType
An occupancy period for a property.
Fields
Name | Description |
---|---|
|
Account number associated with this occupancy period. |
|
Date the occupancy period is effective from. |
|
Date the occupancy period is effective to. |
|
|
|
Whether the account associated with the occupancy period is an occupier account type. |
Example
{
"id": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2020-01-01T00:00:00.000Z",
"isOccupier": true,
"accountNumber": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OccupyPropertyProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
OccupyPropertyProcessConnectionTypeEdge
A Relay edge containing a OccupyPropertyProcessConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OccupyPropertyProcessType,
"cursor": "abc123"
}
OccupyPropertyProcessType
Represents a Occupy Property process.
Fields
Name | Description |
---|---|
|
The ID or the primary key of the lifecycle process. |
|
|
|
The status of the process. |
|
The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"occupyAt": "2020-01-01T00:00:00.000Z",
"supplyPoints": SupplyPointConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
The date and time when offer group was created. |
|
The Actor who created the offer group. |
|
Identifier of the offer group. |
|
One or more Offers contained in the offer group. |
Fields
Name | Description |
---|---|
|
The date and time when offer was accepted. |
|
The Actor who created the offer. |
|
Description of the offer. |
|
Identifier of the Offer. |
|
The Quote this offer is related to. |
|
The date and time when offer was rejected. |
|
The date and time from which the offer becomes valid. |
|
The date and time until which the offer remains valid. |
Example
{
"identifier": "abc123",
"quote": QuoteType_,
"description": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"rejectedAt": "2020-01-01T00:00:00.000Z",
"createdBy": ActorType
}
OnSiteJobsAppointmentType
An appointment linked to a request
Fields
Name | Description |
---|---|
|
|
|
|
|
The external reference provided by the vendor/contractor for the appointment. |
|
|
|
|
|
The current status of the appointment. |
|
|
|
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"jobType": "abc123",
"appointmentDate": "2020-01-01",
"timeSlotStart": "00:00:00.000Z",
"timeSlotEnd": "00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z",
"status": "BOOKED",
"externalReference": "abc123"
}
Fields
Name | Description |
---|---|
|
ID for the Operations Team. |
|
Name for the Operations Team. |
Example
{
"id": "abc123",
"name": "abc123"
}
Fields
Name | Description |
---|---|
|
Lead legal contact email. |
|
Extra details about the opportunity. |
|
Lead legal name. |
|
Opportunity number. |
|
Opportunity ID. |
|
Lead legal contact phone number. |
|
Current stage in a funnel. |
Example
{
"opportunityId": "abc123",
"name": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"number": "abc123",
"stage": "abc123",
"extraDetails": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
If known, this is the account that a call is about. For inbound calls, we attempt to identify the account based on the phone number of the incoming call. For outbound calls, the account will be automatically set if the call was initiated from an account page. For all call types, the account can be updated, for example to correct a misidentification of an incoming call. |
|
The ID of the call. |
|
Metadata related to the call, for example metrics or data passed via an interactive voice response (IVR). |
Example
{
"id": "abc123",
"account": AccountType,
"metadata": CallMetadataItemType
}
Fields
Name | Description |
---|---|
|
|
|
|
|
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "abc123"
}
Fields
Name | Description |
---|---|
|
The current power of the supply point. |
|
The first name of the customer. |
|
The last name of the customer. |
|
Data related to the meter point. The possible errors that can be raised are:
|
|
Data related to the product used for costs optimisation. |
|
The recommended power. |
|
The suggested power adjustment. |
|
Identifier of the analysis. |
|
The estimated profit amount in cents. |
Example
{
"token": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"recommendedSubscribedMaxPower": 1,
"yearlyProfitAmountCents": 1.0,
"currentSubscribedMaxPower": 1,
"firstName": "abc123",
"lastName": "abc123",
"suggestedPowerAdjustment": "NONE",
"meterPoint": MeterPointInterface,
"product": Product
}
PageInfo
The Relay compliant PageInfo
type, containing data necessary to paginate this connection.
Fields
Name | Description |
---|---|
|
When paginating forwards, the cursor to continue. |
|
When paginating forwards, are there more items? |
|
When paginating backwards, are there more items? |
|
When paginating backwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123",
"endCursor": "abc123"
}
PauseDunning
Pause the dunning process for an account.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11301: Account not in a dunning process for the given path name.
- KT-CT-11302: No active dunning process found.
- KT-CT-11303: Multiple active dunning processes found.
- KT-CT-11304: Dunning pause process failed verifying the dates.
- KT-CT-11305: Pausing the dunning process failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the pause has been successfully created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pauseCreated": true
}
Payment
A payment from the customer to the supplier.
Fields
Name | Description |
---|---|
|
Unique identifier of the account the transaction belongs to. |
|
Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
|
The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
|
The date time when the transaction is created. |
|
Returns True if the transaction is linked with a statement. |
|
|
|
Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
|
Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
|
Deprecated. Deprecated The 'isCredit' field is deprecated. |
|
Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
|
Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
|
Whether a payment has been reversed due to a late failure.Sometimes a payment is marked cleared, only for Kraken to be notified days/weeks later that the payment has failed. |
|
|
|
Returns the note field value for the transaction, which contains additional info. |
|
The transaction type of the payment. |
|
|
|
Returns the reason. |
|
Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
|
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123",
"isLateFailedPayment": true,
"paymentTransactionType": "DD_FIRST_COLLECTION"
}
PaymentAdequacyDetailsType
Payment adequacy adjusts fixed payment schedules to maintain a healthy ledger balance over a year.
Fields
Name | Description |
---|---|
|
This ledger will be exempt from default Payment Adequacy. This may mean that it is completely exempt, or handled with special rules. |
Example
{
"isCurrentlyExempt": true
}
Fields
Name | Description |
---|---|
|
Fingerprint. |
|
Returns True if the fingerprint exists, Fasle otherwise. |
|
Returns True if the fingerprint is risk-listed, Fasle otherwise. |
Example
{
"fingerprint": "abc123",
"isFound": true,
"isRiskListed": true
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentForecastConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PaymentForecastConnectionTypeEdge
A Relay edge containing a PaymentForecastConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentForecastType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
The payment method used for the forecasted payment. |
|
Example
{
"paymentNumber": 1,
"date": "2020-01-01",
"amount": 1,
"method": "BACS_TRANSFER"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PaymentInstructionConnectionTypeEdge
A Relay edge containing a PaymentInstructionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentInstructionType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The account user who is an owner of this payment instruction. |
|
The business who is an owner of this payment instruction. |
Example
{
"accountUser": AccountUserType,
"business": BusinessType
}
PaymentInstructionType
Payment Instructions
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A masked reference to a recurring payment method. |
|
The owners of the financial account this instruction represents. |
|
|
|
|
|
The supplementary ledger for this payment instruction. |
|
|
|
Example
{
"id": "abc123",
"status": "abc123",
"sortCode": "abc123",
"iban": "abc123",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"supplementaryLedger": SupplementaryLedgerType,
"bankCode": "abc123",
"accountType": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendor": "abc123",
"cardNumber": "abc123",
"cardType": "abc123",
"maskedAccountIdentifier": "abc123",
"owners": [PaymentInstructionOwnerType]
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPlanConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PaymentPlanConnectionTypeEdge
A Relay edge containing a PaymentPlanConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentPlanType,
"cursor": "abc123"
}
PaymentPlanPaymentType
An object that represents a planned payment for a payment plan.
Example
{
"payableDate": "2020-01-01",
"amount": 1,
"paymentType": "abc123"
}
PaymentPlanType
An object that represents a payment plan.
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
The ledger number for this payment plan or None if one does not exist. |
|
The next planned payment for this payment plan. |
|
|
|
|
|
|
|
|
|
The display name of the strategy used for this payment plan or None if one does not exist. |
|
Example
{
"id": "abc123",
"account": AccountType,
"initialScheduleType": "abc123",
"strategyName": "abc123",
"status": "abc123",
"offeredAt": "2020-01-01T00:00:00.000Z",
"offerExpiresAt": "2020-01-01T00:00:00.000Z",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"payments": PaymentPlanPaymentType,
"nextPayment": PaymentPlanPaymentType,
"strategyDisplayName": "abc123",
"ledgerNumber": "abc123"
}
PaymentPreferenceConnectionTypeConnection
Pagination object for PaymentPreferenceUnion
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPreferenceConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PaymentPreferenceConnectionTypeEdge
A Relay edge containing a PaymentPreferenceConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentPreferenceUnion,
"cursor": "abc123"
}
PaymentRequestConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PaymentRequestConnectionTypeEdge
A Relay edge containing a PaymentRequestConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentRequestType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The amount the customer is expected to pay in minor currency. |
|
The date the payment is expected to be made. |
|
The amount that was funded by each funding source. |
|
The status of the payment. |
|
The total amount of the payment in minor currency. |
Example
{
"expectedPaymentDate": "2020-01-01",
"paymentStatus": "abc123",
"totalAmount": 1,
"customerAmount": 1,
"fundingSourceAmounts": FundingSourceAmountConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
A list of payment requests for a given ledger. |
Example
{
"paymentRequest": PaymentRequestConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
URL to the PDF of the payment schedule. The possible errors that can be raised are:
|
Example
{
"temporaryUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentScheduleConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PaymentScheduleConnectionTypeEdge
A Relay edge containing a PaymentScheduleConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentScheduleType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The arguments of the delay configuration. |
|
The code of the delay configuration. |
Example
{
"code": "abc123",
"args": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
A human-readable description of the value. |
|
Direction of payment day. |
Example
{
"direction": "OF_MONTH",
"description": "abc123"
}
PaymentScheduleType
An object that represents when we have agreed to take payments from a payment instruction.
Fields
Name | Description |
---|---|
|
The delay configuration for this payment schedule. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Details of the payment_day value. |
|
The frequency of the payment schedule. |
|
|
|
|
|
The reason the payment schedule was created. |
|
The method of payment for the schedule. Deprecated The 'scheduleType' field is deprecated. |
|
The supplementary ledger for this payment schedule, if it is on one. |
|
The sum of the payment adequacy contributions on the payment schedule that are expected to be taken before the debt repayment is complete. |
|
|
|
Example
{
"id": "abc123",
"supplementaryLedger": SupplementaryLedgerType,
"validFrom": "2020-01-01",
"validTo": "2020-01-01",
"reason": "GENERAL_ACCOUNT_PAYMENT",
"paymentHolidayReason": "abc123",
"paymentDay": 1,
"paymentFrequency": "Weekly",
"paymentFrequencyMultiplier": 1,
"paymentAmount": 1,
"paymentAdequacyAdjustment": 1,
"paymentAdequacyAdjustmentExpiryDate": "2020-01-01",
"isVariablePaymentAmount": true,
"totalDebtAmount": 1,
"isPaymentHoliday": true,
"scheduleType": "BACS_TRANSFER",
"paymentDayDetails": PaymentSchedulePaymentDayDetailsType,
"delayConfiguration": PaymentScheduleDelayConfigurationType
}
PaysByDirectDebitType
Represents a restriction for if an account should pay only by direct debit in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}
Fields
Name | Description |
---|---|
|
Energy consumption (in kWh) during off-peak hours accumulated over a year. |
|
Energy consumption (in kWh) during peak hours accumulated over a year. |
Example
{
"peak": 1,
"offPeak": 1
}
PerformBoostCharge
Initiate a boost charge for an electric vehicle (EV).
This will start charging the EV and will not stop until the battery reaches 100% charged.
If it is not possible to initiate a boost charge, a KT-CT-4357 error will be returned.
It may have a boostChargeRefusalReasons
extension which lists the reasons why the boost
charge was refused. Possible reasons include:
BC_DEVICE_NOT_YET_LIVE
(device is not yet live)BC_DEVICE_RETIRED
(device is retired)BC_DEVICE_SUSPENDED
(device is suspended)BC_DEVICE_DISCONNECTED
(device is disconnected)BC_DEVICE_NOT_AT_HOME
(device is not at home)BC_BOOST_CHARGE_IN_PROGRESS
(boost charge already in progress)BC_DEVICE_FULLY_CHARGED
(device is already fully charged)
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4356: A boost charge cannot currently be performed.
- KT-CT-4357: Unable to trigger boost charge.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
PerformTestCharge
Initiate a test charge of an electric vehicle (EV).
This is to ensure that the EV or EVSE (charge point) can be controlled remotely and successfully charged for a short period.
If it is not possible to initiate a test charge, a KT-CT-4355 error will be returned. It may have a
testChargeRefusalReasons
extension which lists the reasons why the test charge was refused. Possible reasons
include:
TC_DEVICE_LIVE
(device is already live)TC_DEVICE_ONBOARDING_IN_PROGRESS
(test dispatch already in progress)TC_DEVICE_RETIRED
(device is retired)TC_DEVICE_SUSPENDED
(device is suspended)TC_DEVICE_DISCONNECTED
(device is disconnected)TC_DEVICE_ALREADY_CHARGING
(device is already charging)TC_DEVICE_AWAY_FROM_HOME
(device is away from home)TC_DEVICE_NO_LOCATION_CONFIGURED
(device has no location configured)TC_DEVICE_LOCATION_UNABLE_TO_IDENTIFY
(unable to identify device location)TC_DEVICE_LOCATION_MISSING
(device location is missing)
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4362: Device not ready for test charge.
- KT-CT-4355: Unable to trigger charge.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
Fields
Name | Description |
---|---|
|
|
|
The type of the bill. |
|
The closing balance of an issued billing document. |
|
Position of the billing document in the delinquent debt tracking system. |
|
The date of the constituent bill covered from. |
|
The ID of the constituent bill. |
|
The unique identifier for the billing document. Note: a pending billing document will not have an identifier yet; and not all finalized billing documents will have an identifier assigned to them, in which case this will be null. |
|
Whether the billing document has been annulled. |
|
The date the bill was sent to the customer. |
|
|
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the constituent bill covered to. |
|
The total amounts for all charges on the billing document. |
|
The total amounts for all credits on the statement. |
|
Transactions on the given ledger. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "abc123",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"isAnnulled": true,
"transactions": BillTransactionConnectionTypeConnection,
"closingBalance": 1,
"documentDebtPosition": BillingDocumentPositionType,
"representations": BillRepresentationConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
All accounts that are linked to this phone number. A maximum of 26 results are returned. Results are ordered by most likely first. |
|
Our best guess for which account a call with this phone number would be about. |
|
All account users that are linked to this phone number. A maximum of 26 results are returned. Results are ordered by most likely first. |
|
Our best guess for which account user would be calling from this phone number. |
Example
{
"accountBestMatch": AccountType,
"accountAllMatches": AccountConnectionTypeConnection,
"accountUserBestMatch": AccountUserType,
"accountUserAllMatches": AccountUserConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
The action to perform when the button is pressed. |
|
The button style. |
|
Unique identifier of the object. |
|
Title text of the button. |
|
The name of the object's type. |
Example
{
"buttonStyle": "PRIMARY",
"title": "abc123",
"buttonAction": ActionType,
"id": "abc123",
"typename": "abc123"
}
Fields
Name | Description |
---|---|
|
Whether the viewer has been blocked due to spending all its allowed points. |
|
The maximum number of points the viewer gets for requests per hour. |
|
The remaining points for the viewer in one hour time limit. |
|
Time To Live: UNIX timestamp when the viewer will get a new allowance of points. |
|
The points used so far in one hour time limit. |
Example
{
"limit": 1,
"remainingPoints": 1,
"usedPoints": 1,
"ttl": 1,
"isBlocked": true
}
PointsSizeType
A measurement in points.
Fields
Name | Description |
---|---|
|
Unique identifier of the object. |
|
The points value. |
|
The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"points": 1
}
PortfolioConnectionTypeConnection
Paginator of Operations Team
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PortfolioConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PortfolioConnectionTypeEdge
A Relay edge containing a PortfolioConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PortfolioType,
"cursor": "abc123"
}
PortfolioType
An object that represents a portfolio.
Fields
Name | Description |
---|---|
|
The accounts associated with this portfolio. |
|
The ancestors of the given portfolio. |
|
|
|
The brand code associated with the portfolio. |
|
|
|
|
|
The depth of the portfolio in the hierarchy. |
|
The descendants of the given portfolio. |
|
|
|
The lead account for this portfolio. |
|
The name of the portfolio. |
|
|
|
Operations team for this portfolio. |
|
The parent portfolio of the given portfolio, if any. |
|
Example
{
"id": "abc123",
"number": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"billingName": "abc123",
"collectiveBilling": true,
"operationsTeam": OperationsTeamType,
"leadAccountNumber": "abc123",
"brand": "abc123",
"name": "abc123",
"depth": 1,
"parent": PortfolioType,
"ancestors": PortfolioConnectionTypeConnection,
"descendants": PortfolioConnectionTypeConnection,
"accounts": AccountConnectionTypeConnection
}
PortfolioUserRoleType
The role a user has in association with one portfolio.
Fields
Name | Description |
---|---|
|
|
|
Portfolio object. |
|
The portfolio role. |
|
Example
{
"id": "abc123",
"user": AccountUserType,
"role": RoleString,
"portfolio": PortfolioType
}
PossibleErrorType
The GraphQL error type for displaying information about GraphQL errors that might be raised from the API.
Fields
Name | Description |
---|---|
|
The error code that might be returned from the query/mutation. |
|
The error description that might be returned from the query/mutation. |
|
The error message that might be returned from the query/mutation. |
|
The error type that might be returned from the query/mutation. |
Example
{
"message": "abc123",
"code": "abc123",
"type": "abc123",
"description": "abc123"
}
PossibleErrorsOutputType
Information and possible errors of the requested query/mutation.
Fields
Name | Description |
---|---|
|
Whether the possible authentication errors are included. |
|
Name of the query/mutation whose possible errors are returned. |
|
List of the errors the query/mutation is susceptible of raising. |
|
Type of the query (query or mutation). |
Example
{
"name": "abc123",
"type": "query",
"authErrors": true,
"possibleErrors": [PossibleErrorType]
}
PostCredit
The possible errors that can be raised are:
- KT-CT-5316: Invalid data.
- KT-CT-5311: The credit reason with the requested code is deprecated.
- KT-CT-5312: The credit reason with the requested code does not exist.
- KT-CT-5313: An error occurred whilst posting the credit.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Posted account credit. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"credit": Credit
}
Fields
Name | Description |
---|---|
|
|
|
The type of the bill. |
|
The date of the bill is covered from. |
|
The gross amount of the historical bill. |
|
The ID of the bill. |
|
The unique identifier of a historical bill. It will usually be present on the billing document itself. |
|
The date the bill was sent to the customer. |
|
The params associated with the historical bill. |
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the bill is covered to. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "abc123",
"params": {"key": "value"},
"grossAmount": 1
}
PreSignedToken
A pre-signed, expiring and opaque tokens that can be swapped for a limited scope JWT (Kraken Token).
Fields
Name | Description |
---|---|
|
|
|
|
|
The scope that the token will grant to the account user. |
Example
{
"key": "abc123",
"scope": "SUBMIT_METER_READINGS",
"isValid": true
}
PreferredInstruction
Represents the preference of the user to be charged using a specific payment instruction.
Fields
Name | Description |
---|---|
|
The start time of the payment preference. |
|
The payment instruction preferred by the user. |
|
The status of the payment preference. |
Example
{
"forPaymentsAfter": "abc123",
"status": "abc123",
"paymentMethod": PaymentInstructionType
}
Fields
Name | Description |
---|---|
|
The account number of the newly created account or the existing account to be re-used. |
|
Was a new account created. |
|
Was a new user created. |
|
The ID of the newly created or existing account user. |
Example
{
"isNewAccount": true,
"accountNumber": "abc123",
"isNewUser": true,
"userId": "abc123"
}
PriceForStream
Rate group prices for a product.
Fields
Name | Description |
---|---|
|
The characteristic mapping for the price. |
|
The price per unit. |
|
The scheme labels for the price. |
Example
{
"characteristicMapping": {"key": "value"},
"schemeLabels": {"key": "value"},
"price": "1.0"
}
Fields
Name | Description |
---|---|
|
|
|
Unit that monetary amount relates to eg. 27 cents per kwh. |
Example
{
"amount": "1.0",
"unit": "KILOWATT_HOURS"
}
PrintAttachmentType
Represents a print attachment
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"s3Bucket": "abc123",
"s3Key": "abc123",
"temporaryUrl": "abc123"
}
PrintBatchType
Represents print batch details
Fields
Name | Description |
---|---|
|
|
|
Messages in a print batch. |
|
The status of the print batch. |
Example
{
"id": "abc123",
"status": "OPEN",
"messages": PrintMessageTypeConnection
}
Fields
Name | Description |
---|---|
|
|
|
The ID of the object |
|
Print message of the print event. |
|
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": PrintMessageType
}
PrintMessageType
Represents a print communication.
Fields
Name | Description |
---|---|
|
|
|
Attachments of the message. |
|
Comms that are marked as high priority. |
|
The ID of the object |
|
Example
{
"id": "abc123",
"templateCode": "abc123",
"account": AccountType,
"attachments": [PrintAttachmentType],
"highPriority": true
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PrintMessageTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
PrintMessageTypeEdge
A Relay edge containing a PrintMessageType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PrintMessageType,
"cursor": "abc123"
}
Product
A product.
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
All consumption rates applicable to this product. |
|
This will be shown to customers during sign-up |
|
This name will be shown to customers during sign-up |
|
This is when end-dated products expire |
|
|
|
Use this field to temporarily make a product unavailable |
|
Whether the product has fixed or indexed rates. |
|
|
|
These are internal notes to explain why this product exists |
|
Contractual perks displayed to the client. |
|
List of reinsurance items associated with the product. |
|
All standing rates applicable to this product. |
Tags associated to this product. |
|
|
Duration of agreements using this product in months |
|
Example
{
"code": "abc123",
"notes": "abc123",
"fullName": "abc123",
"displayName": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01T00:00:00.000Z",
"availableTo": "2020-01-01T00:00:00.000Z",
"isHidden": true,
"term": 1,
"endsAt": "2020-01-01T00:00:00.000Z",
"marketName": "abc123",
"availabilityStatus": "PUBLIC",
"termsContractType": "abc123",
"perks": ProductPerks,
"standingRates": EnergyStandingRateConnectionTypeConnection,
"consumptionRates": EnergyConsumptionRateConnectionTypeConnection,
"reinsurances": [Reinsurance],
"isVariable": true,
"tags": ProductTagConnectionTypeConnection
}
ProductConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ProductConnectionTypeEdge
A Relay edge containing a ProductConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Product,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The discount percentage applied to the offer. |
|
The percentage of green energy provided by the offer. |
|
The guarantee that the client will not be cut & that they are not committed. |
Example
{
"discountInPercent": 1,
"greenEnergyInPercent": 1,
"noCutsNoCommitment": true
}
ProductRateOverrideConfigurationType
Configuration for Product Rate Override Configuration term.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
The indexation options for the product rate override configuration. |
|
Whether the term is variable. |
|
The schedules for the product rate override configuration. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"indexationOptions": IndexationOptionsType,
"schedules": [ProductRateOverrideScheduleType]
}
ProductRateOverrideItemType
Item for Product Rate Override Configuration term.
Fields
Name | Description |
---|---|
|
The price per unit for the product rate override item. |
|
The product code for the product rate override item. |
|
The rate band for the product rate override item. |
Example
{
"productCode": "abc123",
"rateBand": "abc123",
"pricePerUnit": "1.0"
}
ProductRateOverrideScheduleType
Schedule for Product Rate Override Configuration term.
Fields
Name | Description |
---|---|
|
The effective from date for the product rate override schedule. |
|
The items for the product rate override schedule. |
Example
{
"items": [ProductRateOverrideItemType],
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
|
|
Price per unit. |
|
The temporal class of the product rate. |
|
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "AUD_CENTS",
"pricePerUnit": 1.0,
"temporalClass": "abc123"
}
ProductTag
A product tag.
Example
{
"code": "abc123",
"displayName": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ProductTagConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ProductTagConnectionTypeEdge
A Relay edge containing a ProductTagConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ProductTag,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
URL to the PDF of the proof of residence. The possible errors that can be raised are:
|
Example
{
"temporaryUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
|
ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
|
Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
|
UK dependent localities, or neighbourhoods or boroughs in some other locations. |
|
City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
|
A personal name. |
|
The name of a business or organisation. |
|
Postal code (ZIP code in the US). |
|
Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
|
The 'street address' component. This value can (and often will) contain newline characters when appropriate. In some cases, data may appear in this field instead of the
below fields; e.g. a UK post town name may appear here
instead of in the If |
|
The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123"
}
Fields
Name | Description |
---|---|
|
The matched property. |
|
A score representing the degree of confidence for a match. |
Example
{
"score": "1.0",
"property": PropertyType
}
Fields
Name | Description |
---|---|
|
The address of the property, formatted into a single string. |
|
Coordinates for the property, useful for displaying the property on a map. |
|
The embedded network this property belongs to, if any. |
|
|
|
An optional label for the property. |
|
Measurements at a property |
|
Time periods during which the property is associated with an account. Useful to display information about house-moves, as performing a move out of a property will set the end date for the occupancy period. |
|
The postcode of this property. |
|
Property rich address. |
|
List of address lines. |
|
The supply points linked to the property. |
Example
{
"id": "abc123",
"address": "abc123",
"richAddress": PropertyRichAddressType,
"splitAddress": ["abc123"],
"label": "abc123",
"occupancyPeriods": [OccupancyPeriodType],
"coordinates": CoordinatesType,
"embeddedNetwork": EmbeddedNetworkType,
"measurements": MeasurementConnection,
"postcode": "abc123",
"supplyPoints": SupplyPointConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
OAuth 2.0 URI for the provider. |
Example
{
"oauthUri": "abc123"
}
ProviderVirtualKeyDetailsType
Details of a public key that can be added to devices for end-to-end authentication or encryption.
E.g. for Tesla the user visits a URL and the name can be used to show what the key is called. https://github.com/teslamotors/vehicle-command#distributing-your-public-key
Fields
Name | Description |
---|---|
|
Friendly human-readable name for the virtual key. |
|
URI for the virtual key. |
Example
{
"virtualKeyName": "abc123",
"virtualKeyUri": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ProvisionalTransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
ProvisionalTransactionConnectionTypeEdge
A Relay edge containing a ProvisionalTransactionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ProvisionalTransactionType,
"cursor": "abc123"
}
ProvisionalTransactionType
A provisional transaction represents some debit or credit to or from a customer's account which we cannot yet finalise for some reason, but which is still useful to keep a note of, and display to the customer. Provisional transactions are purely to give guidance in the absence of finalised information. We therefore only return provisional transactions that have not been finalised. When a transaction is finalised, it is available through the transactions
field.
Fields
Name | Description |
---|---|
|
The amount in pence for this provisional transaction. It will be negative for charges, positive for credits. |
|
The date at which the charge should be applied to the account. |
|
|
|
A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"title": "abc123",
"amount": 1,
"date": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
The cost for the charge added during a charging session. |
|
The end time of a charging session. |
|
The energy added during a charging session. |
|
Location of the charging session. |
|
URL of the operator image. |
|
The start time of a charging session. |
|
The change in state of charge during a charging session. The value will be between 0 and 100, if not null. |
|
The final state of charge after a charging session. The value will be between 0 and 100, if not null. |
PublishTransactionalMessagingExternalTrigger
Publish an externally defined transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-5421: Account user not found.
- KT-CT-9901: Invalid trigger type code.
- KT-CT-9905: Top-level context fields are missing.
- KT-CT-9906: Template variables do not match the defined schema.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The trigger that has been published. |
Example
{
"possibleErrors": [PossibleErrorType],
"trigger": Trigger
}
PublishTransactionalMessagingTrigger
Publish a trigger within the transactional messaging service.
The possible errors that can be raised are:
- KT-CT-9901: Invalid trigger type code.
- KT-CT-9902: Invalid trigger type params.
- KT-CT-9903: Trigger type cannot be published externally.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The trigger that has been published. |
Example
{
"possibleErrors": [PossibleErrorType],
"trigger": Trigger
}
PushNotificationBindingType
Represents a pairing of a single app installation to an account user.
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"messages": SMSMessageType,
"user": AccountUserType,
"token": "abc123",
"application": NotifiableApplicationType,
"registeredAt": "2020-01-01T00:00:00.000Z",
"expiresAt": "2020-01-01T00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The complexity of the query. |
Example
{
"complexityValue": 1
}
Fields
Name | Description |
---|---|
|
The cost for quoting this product. |
|
The date and time when the quote component was created. |
|
Identifier of the Quote. |
|
Identifier of the Product Component. |
|
The input data used for quoting this product component. |
Example
{
"identifier": "abc123",
"productComponentIdentifier": "abc123",
"costs": {"key": "value"},
"quotingParamsInputData": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z"
}
QuoteRequest
This type will be used for querying the quote request.
Fields
Name | Description |
---|---|
|
The quote request code. |
|
Quoted supply points. |
Example
{
"code": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"quotedSupplyPoints": QuotedSupplyPointResultConnectionTypeConnection
}
QuoteRequestType
Quote request
Fields
Name | Description |
---|---|
|
Example
{
"code": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}
Fields
Name | Description |
---|---|
|
The date and time when the quote was created. |
|
The Actor who created the Quote. |
|
Identifier of the Quote. |
|
The product offering identifier this Quote is related to. |
|
Quote components of this quote. |
Example
{
"identifier": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"productOfferingIdentifier": "abc123",
"quoteComponents": [QuoteComponentType],
"createdBy": ActorType
}
Fields
Name | Description |
---|---|
|
The annual amount for the subscription. |
|
The cost for the subscription. |
|
The client specific parameters of the quoted product. Deprecated The 'clientParams' field is deprecated. |
|
Consumption rates. |
|
The cost for the subscription. |
|
The cost for the subscription. |
|
The quoted product id. |
|
The market specific parameters of the quoted product. |
|
The monthly amount for the subscription. |
|
The related product to this quoted product. |
|
The related quoted supply point. |
|
Standing rate. |
|
The cost for the subscription. |
|
If the quoted product was selected. |
Example
{
"id": 1,
"product": Product,
"wasSelected": true,
"clientParams": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"marketParams": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"subscriptionCost": ProductRateType,
"baseCost": ProductRateType,
"hpCost": ProductRateType,
"hcCost": ProductRateType,
"standingRate": SupplyProductRateInterface,
"consumptionRates": [SupplyConsumptionRateType],
"quotedSupplyPoint": QuotedSupplyPointType,
"monthlyAmount": 1.0,
"annualAmount": 1.0
}
QuotedProductConnectionTypeConnection
Paginator of Quoted Products.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": QuotedProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
QuotedProductConnectionTypeEdge
A Relay edge containing a QuotedProductConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": QuotedProduct,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Energy consumption forecast. |
|
Quoted products for supply point. |
|
The quoted supply point to which the quote applies. |
|
The supply point to which the quote applies. |
Example
{
"supplyPoint": SupplyPointType,
"quotedSupplyPoint": QuotedSupplyPointType,
"quotedProducts": QuotedProductConnectionTypeConnection,
"consumptionForecast": EnergyConsumptionForecastType
}
QuotedSupplyPointResultConnectionTypeConnection
Paginator of QuotedSupplyPointResult.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": QuotedSupplyPointResultConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
QuotedSupplyPointResultConnectionTypeEdge
A Relay edge containing a QuotedSupplyPointResultConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": QuotedSupplyPointResult,
"cursor": "abc123"
}
QuotedSupplyPointType
Quoted supply point
Fields
Name | Description |
---|---|
|
|
|
The related quote request. |
Example
{
"id": "abc123",
"quoteRequest": QuoteRequestType
}
RateGroupEligibilityType
Represents a rate group eligibility term of in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}
RateGroupPrices
Rate group prices for a product.
Fields
Name | Description |
---|---|
|
The prices for the rate group. |
|
The rate group code. |
Example
{
"rateGroup": "abc123",
"prices": PriceForStream
}
Fields
Name | Description |
---|---|
|
The exclusive end of this reading's interval. |
|
The inclusive start of this reading's interval. |
|
The quality of this reading if applicable. |
|
The source of this reading if applicable. |
|
This reading's units. |
|
The recorded value for this reading. |
Example
{
"value": "1.0",
"units": "abc123",
"intervalStart": "2020-01-01T00:00:00.000Z",
"intervalEnd": "2020-01-01T00:00:00.000Z",
"source": "abc123",
"quality": "abc123"
}
ReadingsConnection
Pagination for utility usage readings.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ReadingsEdge,
"totalCount": 1,
"edgeCount": 1
}
ReadingsEdge
A Relay edge containing a Readings
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "abc123"
}
ReauthenticateDevice
Re-authenticate a device. The authentication details provided must be for the same device as was previously authenticated.
The possible errors that can be raised are:
- KT-CT-4313: Could not find KrakenFlex device.
- KT-CT-4314: Unable to get provider details.
- KT-CT-4315: Unable to re-authenticate device.
- KT-CT-4363: No capable devices found.
- KT-CT-4364: Multiple devices found.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
RecordDepositAgreementAccepted
Record the customer's acceptance of a deposit agreement.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"isRecorded": true
}
Fields
Name | Description |
---|---|
|
The action to perform when the button is pressed. |
|
The button style. |
|
Unique identifier of the object. |
|
Title text of the button. |
|
The name of the object's type. |
|
Colour style of button eg. filled, outlined, text_only. |
Example
{
"buttonStyle": "PRIMARY",
"title": "abc123",
"buttonAction": ActionType,
"id": "abc123",
"typename": "abc123",
"variant": "FILLED"
}
RedeemLoyaltyPointsForAccountCredit
Redeem 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.
Fields
Name | Description |
---|---|
|
The number of loyalty points that were redeemed. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 1
}
RedeemReferralClaimCode
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.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total payment amount given to the referring account in the smallest unit. of the client's currency. If you filter the referrals by |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ReferralConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1,
"referringUserTotalPaymentAmount": 1
}
ReferralConnectionTypeEdge
A Relay edge containing a ReferralConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ReferralType,
"cursor": "abc123"
}
ReferralSchemeType
A referral scheme is a way for one account to earn a reward for referring another. This is achieved by the referred account using a url (provided by the referring account) to sign up.
Fields
Name | Description |
---|---|
|
Whether the current account is eligible to be referred under this scheme. |
|
The unique code for the scheme. |
|
The reward amount received by the referrer and the referee combined. |
|
True if the the scheme has limit of uses, and if the usage is at capacity. |
|
The number of loyalty points to be awarded to the referrer in addition to the reward amount. |
|
Max number of times this referral code can be credited to a given account. |
|
A referral url for display purposes. |
|
A fully qualified url give people to create accounts referred by this scheme. |
|
The reward amount received by the referred party. |
|
The family name of the person making the referral. Deprecated The 'referrerFamilyName' field is deprecated. |
|
The given name of the person making the referral. |
|
The reward amount received by the referrer. |
|
Scheme type of the referral scheme. |
Example
{
"referralUrl": "abc123",
"referralDisplayUrl": "abc123",
"referrerRewardAmount": 1,
"referredRewardAmount": 1,
"combinedRewardAmount": 1,
"loyaltyPointsBonus": 1,
"canBeReferred": true,
"code": "abc123",
"referrerGivenName": "abc123",
"referrerFamilyName": "abc123",
"schemeType": "abc123",
"maxRecurrence": 1,
"isUsageAtCapacity": true
}
Fields
Name | Description |
---|---|
|
A business scheme type |
|
A domestic scheme type |
|
A friends and family scheme type Deprecated The 'friendsAndFamily' field is deprecated. |
Example
{
"domestic": ReferralSchemeType,
"business": ReferralSchemeType,
"friendsAndFamily": ReferralSchemeType
}
ReferralType
Details of an account referral
Fields
Name | Description |
---|---|
|
The referral code. |
|
The payment amount in the smallest unit of the clients currency received by the referrer and the referee combined. |
|
|
|
The date when the payment was made. |
|
The status of the payment. |
|
The date the referred user joined. |
|
The name of the referred user. |
|
Payment amount given to the referred account in the smallest unit of the client's currency. |
|
Payment amount given to the referring account in the clients fractional currency unit. |
|
The type of reward scheme. |
Example
{
"id": "abc123",
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"referredUserName": "abc123",
"paymentStatus": "abc123",
"referredUserJoinDate": "2020-01-01T00:00:00.000Z",
"referredUserPaymentAmount": 1,
"referringUserPaymentAmount": 1,
"combinedPaymentAmount": 1
}
RefreshToken
An opaque token that can be used to renew a Kraken Token.
Fields
Name | Description |
---|---|
|
The datetime when the token will expire. |
|
|
|
Example
{
"key": "abc123",
"expiryDt": "2020-01-01T00:00:00.000Z",
"isValid": true
}
Refund
A refund to the customer from the energy supplier.
Fields
Name | Description |
---|---|
|
Unique identifier of the account the transaction belongs to. |
|
Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
|
The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
|
The date time when the transaction is created. |
|
Returns True if the transaction is linked with a statement. |
|
|
|
Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
|
Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
|
Deprecated. Deprecated The 'isCredit' field is deprecated. |
|
Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
|
Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
|
|
|
Returns the note field value for the transaction, which contains additional info. |
|
|
|
Returns the reason. |
|
Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
|
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123"
}
RefundPayment
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-3929: The payment is not in a refundable state.
- KT-CT-3933: Refund amount greater than payment amount.
- KT-CT-3937: Payment not eligible for refund.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The repayment for the requested refund. |
Example
{
"possibleErrors": [PossibleErrorType],
"repayment": AccountRepaymentType
}
Fields
Name | Description |
---|---|
|
The amount of money requested. |
|
The payment which is being refunded. |
|
Internal code for the reason the refund is being requested. |
|
The ID of the refund request. |
|
The current status of the refund request. |
Example
{
"requestId": "abc123",
"amount": 1,
"payment": AccountPaymentType,
"reasonCode": "abc123",
"status": "REQUESTED"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RefundRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
RefundRequestConnectionTypeEdge
A Relay edge containing a RefundRequestConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": RefundPaymentRequestType,
"cursor": "abc123"
}
RegenerateSecretKey
Regenerate the user's API key.
Fields
Name | Description |
---|---|
|
The generated key value, which is only ever available once (here). |
|
The currently authenticated user. |
Example
{
"key": "abc123",
"viewer": AccountUserType
}
RegisterOpportunityFlowStatusEvent
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}
Fields
Name | Description |
---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"pushNotificationBinding": PushNotificationBindingType
}
Reinsurance
A reinsurance item with a tag and a text.
Fields
Name | Description |
---|---|
|
Tag identifier of the reinsurance. |
|
Value of the reinsurance. |
Example
{
"tag": "AWARD",
"text": "abc123"
}
Fields
Name | Description |
---|---|
|
The name of the team responsible for completing the reminder. |
|
The username of the user responsible for completing the reminder. |
|
Reminder content. |
|
The date and time the account reminder was created. |
|
When the reminder is due. |
|
The unique ID of the reminder. |
|
If the reminder is managed by Kraken. |
|
The reminder type name. |
|
Reopen ink conversation. |
Example
{
"id": 1,
"reminderTypeName": "abc123",
"isKrakenManaged": true,
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z",
"assigneeUsername": "abc123",
"assigneeTeamName": "abc123",
"reopenInkConversation": true,
"createdAt": "2020-01-01T00:00:00.000Z"
}
RemoveCampaignFromAccount
The possible errors that can be raised are:
- KT-CT-7424: Failed to remove campaign from account.
- KT-CT-7426: The account is not part of the given campaign.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the campaign was successfully removed from the account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignRemoved": true
}
RemoveCampaignItems
The possible errors that can be raised are:
- KT-CT-11501: Voice campaign not found.
- KT-CT-11502: Cannot remove items from multiple campaigns at once.
- KT-CT-11505: Voice campaign item not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignItems": [VoiceCampaignItemType]
}
RemoveItemsFromRiskList
Remove existing items from risk list.
The possible errors that can be raised are:
- KT-CT-12106: Risk list item removal failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
List of successfully removed risk identifiers. |
Example
{
"possibleErrors": [PossibleErrorType],
"riskIdentifiers": [RiskListItemType]
}
Fields
Name | Description |
---|---|
|
The repayment intervention outcome. |
|
The repayment intervention reason. |
Example
{
"outcome": "abc123",
"reason": "abc123"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RepaymentRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
RepaymentRequestConnectionTypeEdge
A Relay edge containing a RepaymentRequestConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": RepaymentRequestType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The amount of money requested. |
|
The payment instruction, if any, associated with the repayment request. |
|
The method by which the money will be transferred to the customer. |
|
Classifier code for repayment reason. |
|
The ID of the repayment request. |
|
The current status of the repayment request. |
Example
{
"requestId": "abc123",
"amount": 1,
"reasonCode": "abc123",
"method": "BANK_TRANSFER",
"instruction": PaymentInstructionType,
"status": "REQUESTED"
}
RequestDoubleOptIn
Request a double opt in for a consent.
This mutation will create a consent with a value of PENDING and publish a double opt-in requested transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-9019: Invalid input.
- KT-CT-9018: Account not found.
- KT-CT-1111: Unauthorized.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9023: Consent already accepted.
- KT-CT-1199: Too many requests.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The consent that was created or updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
RequestElectricityMeasures
Requests and creates electricity measures for the specified PRM.
The possible errors that can be raised are:
- KT-FR-4510: Invalid PRM.
- KT-FR-8914: Industry consent missing.
- KT-FR-4710: Unable to fetch consumption.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
List of electricity measures. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"measures": [ElectricityMeasure]
}
Fields
Name | Description |
---|---|
|
The email that requested a password reset email. |
Example
{
"email": "abc123"
}
RequestPrintedBill
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the request was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
RequestQuote
Request a quote for a list of supply points.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4140: ID must be a valid integer or a string.
- KT-CT-4719: No supply point found for identifier provided.
- KT-FR-4525: Provider calendar is missing for one of the electricity supply points.
- KT-FR-4613: Unable to request quote.
- KT-FR-4615: Unable to request quote.
- KT-FR-4619: Unexpected error while generating quote.
- KT-FR-4624: Unknown Agreement.
- KT-FR-4629: Could not find any supply points to quote.
- KT-FR-4634: Unable to change the subscribed max power.
- KT-FR-4635: Subscribed max power should be between 1 and 36.
- KT-FR-7712: Invalid affiliate session.
- KT-FR-7713: Authenticated organizations should not use affiliate sessions.
- KT-FR-4626: Audio recording not found.
- KT-FR-7711: Missing affiliate session.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Quote request identifier (if the quote request succeeds). |
|
Quoted supply points. |
Example
{
"possibleErrors": [PossibleErrorType],
"quoteRequestCode": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"quotedSupplyPoints": QuotedSupplyPointResultConnectionTypeConnection
}
Fields
Name | Description |
---|---|
|
Whether the account can request a refund. |
|
The reason why a refund cannot be requested. |
Example
{
"canRequestRefund": true,
"reason": "abc123"
}
RequestRepaymentOutputType
Output for creating a repayment request.
Fields
Name | Description |
---|---|
|
The ID of the repayment request. |
|
The current status of the repayment request. |
Example
{
"requestId": "abc123",
"status": "REQUESTED"
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"errors": [SerializerFieldErrorsType],
"clientMutationId": "abc123"
}
Fields
Name | Description |
---|---|
|
A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
|
A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
|
True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
|
The ID of the user whose password was changed. |
Example
{
"userId": "abc123",
"passwordUpdated": true,
"failureReasons": ["abc123"],
"failureCodes": ["abc123"]
}
ResumeDeviceControl
Resume control of a device after having been away from home.
This is so that the device can be charged again according to the set preferences.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4359: Unable to resume device control.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
RevokeAgreement
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-1501: Agreement not found.
- KT-CT-1502: Billed agreements cannot be revoked.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Account responsible for the revoked agreement. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
RewardType
A reward is based on a scheme that an account has applied for in order to be
eligible for a discount. Examples can include signup, promo, or partner codes that
were applied to an account.
Fields
Name | Description |
---|---|
|
The referral code. |
|
|
|
The date when the payment was made. |
|
The status of the reward payment. |
|
Reward amount given to the account in the smallest unit of the clients currency. |
|
The type of reward scheme. |
Example
{
"id": "abc123",
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"rewardAmount": 1,
"paymentStatus": "Pending"
}
RichAddressType
A postal address.
This data model is based on the structure used by Google's libaddressinput library—so you can use it, or other libraries that use its data model and reference data, to accept input.
All fields can be blank, except for country
which must
always be supplied.
Fields
Name | Description |
---|---|
|
Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
|
ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
|
Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
|
UK dependent localities, or neighbourhoods or boroughs in some other locations. |
|
City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
|
A personal name. |
|
The name of a business or organisation. |
|
Postal code (ZIP code in the US). |
|
Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
|
The 'street address' component. This value can (and often will) contain newline characters when appropriate. In some cases, data may appear in this field instead of the
below fields; e.g. a UK post town name may appear here
instead of in the If |
|
The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123"
}
RiskListItemType
Represents the result of importing/removing risk identifiers into the risk list with detailed information.
Fields
Name | Description |
---|---|
|
The unique identifier of the edited risk identifier. |
Example
{
"riskIdentifierId": "abc123"
}
RunMeterPointPMAXAnalysis
Check whether meter points are eligible to be supplied by us.
The possible errors that can be raised are:
- KT-FR-8914: Industry consent missing.
- KT-FR-8912: PMAX can't be computed for this supply point.
- KT-FR-4510: Invalid PRM.
- KT-FR-4113: Invalid name.
- KT-FR-4913: Unknown product.
- KT-FR-4535: Segment invalid.
- KT-FR-4533: Non communicating PRM.
- KT-FR-4534: Sensitive PRM.
- KT-FR-4536: PRM customer non PART.
- KT-FR-4537: PRM not powered.
- KT-FR-4538: PRM not single-phased.
- KT-FR-8919: Power history missing.
- KT-FR-8913: PMAX Analysis failed.
- KT-FR-8920: Data API error.
- KT-FR-8921: Recent power decrease.
- KT-FR-8922: Recent power increase.
- KT-FR-8923: Insufficient fresh data.
- KT-FR-8924: Insufficient winter data.
- KT-FR-8925: Too many zeros.
- KT-FR-8926: Timeout reached.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Data related to the pmax analysis. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pmaxAnalysis": PMAXAnalysisType
}
Fields
Name | Description |
---|---|
|
|
|
The ID of the object |
|
SMS message of the SMS event. |
|
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": SMSMessageType
}
SMSMessageType
Represents a SMS communication.
Fields
Name | Description |
---|---|
|
|
|
Attachments of the message. |
|
|
|
SMS recipient. |
|
SMS sender. |
|
|
|
SMS body. |
Example
{
"id": "abc123",
"sentAt": "2020-01-01T00:00:00.000Z",
"account": AccountType,
"attachments": [AttachmentType],
"sender": "abc123",
"recipient": "abc123",
"textBody": "abc123"
}
ScheduleQuoteFollowUp
Schedule a quote follow up message 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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the message was scheduled successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
Fields
Name | Description |
---|---|
|
Whether the scheduled transaction is a 'charge' or a 'credit'. |
|
Additional data that is consumed and associated with the scheduled transaction. |
|
Optional short note about the scheduled transaction for customer display. |
|
The gross amount of the scheduled transaction. |
|
Optional short note about the scheduled transaction for internal use. |
|
The ledger the scheduled transaction is for. |
|
Any extra data that is associated with scheduled transaction. |
|
The net amount of the scheduled transaction. |
|
The datetime after which the scheduled transaction can be added to the ledger. |
|
The reason why the scheduled transaction is added to the account. |
|
The tax amount of the scheduled transaction. |
|
The tax rate of the scheduled transaction. |
Example
{
"ledgerNumber": "abc123",
"action": "abc123",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"salesTaxRate": "1.0",
"reason": "abc123",
"ancillaryData": {"key": "value"},
"metadata": {"key": "value"},
"internalNote": "abc123",
"displayNote": "abc123",
"postedAfter": "2020-01-01T00:00:00.000Z"
}
ScreenActionType
An action which calls another backend screen via its screen id.
Fields
Name | Description |
---|---|
|
Whether to allow returning to the original caller screen. |
|
Unique identifier of the object. |
|
Map of the parameters (key-value pairs) to pass to the next backend screen. |
|
The ID of the screen to navigate to. |
|
The name of the action object's type. |
|
The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"typeName": "abc123",
"screenId": "abc123",
"params": BackendScreenParam,
"allowBack": true
}
SectionType
A section containing a list of cards or carousel items
Fields
Name | Description |
---|---|
|
The content of the section. |
|
Unique identifier of the object. |
|
The order of the section. |
|
The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"content": SectionContent,
"order": 1
}
SelectChargePointMake
Options for selecting a charge point's make from a list of options.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "abc123",
"options": SmartFlexListItemInterface,
"selectedOptionId": "abc123"
}
SelectChargePointMakeForSmartFlexOnboarding
Complete the select charge point make step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
The make of the charge point, e.g. myenergi. |
|
A unique identifier for this list item. |
Example
{
"id": "abc123",
"chargePointMake": ChargePointVariantType
}
SelectChargePointVariant
Options for selecting a charge point's variant from a list of options.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "abc123",
"options": SmartFlexListItemInterface,
"selectedOptionId": "abc123"
}
SelectChargePointVariantForSmartFlexOnboarding
Complete the select charge point variant step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
The model variant of the charge point, e.g. Zappi. |
|
A unique identifier for this list item. |
Example
{
"id": "abc123",
"chargePointVariant": ChargePointVariantType
}
SelectDeviceType
A type where the user must select the type of device to onboard.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "abc123",
"options": SmartFlexListItemInterface,
"selectedOptionId": "abc123"
}
SelectDeviceTypeForSmartFlexOnboarding
Select the type of device to start the onboarding process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
A unique identifier for this list item. |
|
The device type, e.g. Electric Vehicle. |
Example
{
"id": "abc123",
"label": "abc123"
}
SelectProducts
Mark chosen quoted products for quoted supply points on quote request as selected.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4634: Quoted product with given id not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4635: Missing a quoted product for at least one quoted supply point on the quote request.
- KT-CT-4636: Quoted product not linked to a product.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether we successfully marked the chosen quoted products as selected. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
SelectUserVehicle
Options for selecting a user's vehicle from a list of options.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "abc123",
"options": SmartFlexListItemInterface,
"selectedOptionId": "abc123"
}
SelectUserVehicleForSmartFlexOnboarding
Complete the select user vehicle step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
A unique identifier for this list item. |
|
The selected electric vehicle when multiple vehicles were available. Deprecated The 'userVehicle' field is deprecated. |
|
A vehicle associated with the user's OEM account. |
Example
{
"id": "abc123",
"userVehicle": ElectricVehicleType,
"vehicle": VehicleInformationType
}
SelectVehicleMake
Options for selecting a vehicle's make from a list of options.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "abc123",
"options": SmartFlexListItemInterface,
"selectedOptionId": "abc123"
}
SelectVehicleMakeForSmartFlexOnboarding
Complete the select vehicle make step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
A unique identifier for this list item. |
|
The make of the electric vehicle make, e.g. Tesla. |
Example
{
"id": "abc123",
"vehicleMake": ElectricVehicleType
}
SelectVehicleVariant
Options for selecting a vehicle's variant from a list of options.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "abc123",
"options": SmartFlexListItemInterface,
"selectedOptionId": "abc123"
}
SelectVehicleVariantForSmartFlexOnboarding
Complete the select vehicle variant step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
A unique identifier for this list item. |
|
The model variant of the electric vehicle, e.g. Model Y. |
Example
{
"id": "abc123",
"vehicleVariant": ElectricVehicleType
}
SelfReading
Gather customer's self readings data and call Enedis TIA webservice.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-FR-4510: Invalid PRM.
- KT-FR-4513: A technical error has occurred.
- KT-FR-4514: The requested date is not allowed.
- KT-FR-4515: The provided readings are inconsistent.
- KT-FR-4516: The PRM is being modified by another user.
- KT-FR-4517: Unknown error.
- KT-FR-4518: Readings were already provided today.
- KT-FR-4624: Unknown Agreement.
- KT-FR-4712: Invalid meter readings data.
- KT-FR-4713: Invalid data. Reading date cannot be in the future.
- KT-FR-4912: No active agreement found.
- KT-FR-4539: Smart meter is not supported.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The agreement's id. |
|
The market name. |
|
The customer's meter point id. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The datetime of the reading. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreementId": 1,
"meterPointId": "abc123",
"readingDate": "2020-01-01",
"marketName": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
The live chat. |
|
The ID of the Ink Live Chat message that was created. |
Example
{
"liveChat": InkLiveChat,
"messageRelayId": "abc123",
"clientMutationId": "abc123"
}
SendPMAXSummaryEmail
Send the PMAX summary email to the customer.
The possible errors that can be raised are:
- KT-FR-8911: PMAX Analysis already sended.
- KT-FR-8910: PMAX Analysis not found.
- KT-FR-8915: Email consent missing.
- KT-CT-4122: Invalid email.
- KT-FR-8917: Failed to send email.
- KT-FR-8918: Can't send email for this analysis.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Data related to the pmax analysis. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pmaxAnalysis": PMAXAnalysisType
}
SendQuoteSummary
Trigger the sending of a quote summary to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-4632: Invalid recipient information.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the triggering of the quote summary was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}
SendVerificationEmail
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
If the verification email was sent. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationStatus": true
}
Example
{
"message": "abc123",
"code": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
Example
{
"field": "abc123",
"errors": [ErrorTypeUnion]
}
SetActivationProcessSwitchReadings
Set an activation process' switch readings, from its agreement ID.
The possible errors that can be raised are:
- KT-FR-4712: Invalid meter readings data.
- KT-FR-4713: Invalid data. Reading date cannot be in the future.
- KT-FR-4912: No active agreement found.
- KT-FR-6912: The activation process provided does not exists.
- KT-FR-6913: The activation process is not in a checkoutable status.
- KT-FR-6914: The activation process does not belong to the logged user account.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
The activation process id. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"activationProcessId": "abc123"
}
SetLoyaltyPointsUser
Set the Loyalty Points user for the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9214: Couldn't assign user loyalty points role.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
ID of the new Loyalty Points user. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "abc123"
}
SetOpportunityOutcome
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Success message for now. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "abc123"
}
SetPaymentPreference
Choose how automatic payments will be collected.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3967: Payment method is not valid.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}
SetUpDirectDebitInstruction
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-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
SetVehicleChargingPreferences
Allow customers to set/update their vehicle's charging preferences.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4321: Serializer validation error.
- KT-CT-4353: An error occurred while trying to update your charging preferences.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
ShareGoodsQuote
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Goods quote shared. |
Example
{
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}
SmartFlexChargePoint
Information about a charge point that has been registered with Kraken Flex.
Fields
Name | Description |
---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
This contains more detail about the variant of the charge point model. |
|
The user's preferences for charging using this charge point. |
|
History of charging sessions for a SmartFlex device. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The make of the charge point, e.g. myenergi. |
|
The model of the charge point, e.g. Zappi. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
Information about the current status of this device. |
|
This contains more detail about the variant of the vehicle model. |
Example
{
"id": "abc123",
"name": "abc123",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "abc123",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "abc123",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"chargingSessions": DeviceChargingSessionConnection,
"make": "abc123",
"model": "abc123",
"vehicleVariant": ElectricVehicleModelType,
"chargePointVariant": ChargePointVariantModelType,
"chargingPreferences": SmartFlexVehicleChargingPreferences
}
SmartFlexChargePointStatus
The current status of a registered charge point.
Fields
Name | Description |
---|---|
|
The current status of the device. |
|
The current state of this SmartFlex device state machine. |
|
Whether control of the device is currently disabled. |
|
Information about the limits for the SoC. |
|
The reason for the most recent failed test dispatch (if any). |
Example
{
"current": "ONBOARDING",
"isSuspended": true,
"currentState": "AUTHENTICATION_PENDING",
"stateOfChargeLimit": StateOfChargeLimit,
"testDispatchFailureReason": "NONE"
}
Fields
Name | Description |
---|---|
|
Possible cause of the charging error. |
Example
{
"cause": "SOC_LIMIT_REACHED"
}
Fields
Name | Description |
---|---|
|
The cost for the charge added during a charging session. |
|
The charging session dispatch. |
|
The end time of a charging session. |
|
The energy added during a charging session. |
|
Charging problem(s) encountered during the session due to an error or truncation. |
|
The start time of a charging session. |
|
The change in state of charge during a charging session. The value will be between 0 and 100, if not null. |
|
The final state of charge after a charging session. The value will be between 0 and 100, if not null. |
|
The target type for a user's preferences. |
|
The type of charge, i.e. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z",
"stateOfChargeChange": "1.0",
"stateOfChargeFinal": "1.0",
"energyAdded": Energy,
"cost": Money,
"type": "SMART",
"targetType": "ABSOLUTE_STATE_OF_CHARGE",
"dispatches": [SmartFlexDispatch],
"problems": [SmartFlexChargingProblem]
}
Fields
Name | Description |
---|---|
|
The state of charge (in percent) that was possible, given the truncation. |
|
The state of charge (in percent) that could have been achieved, if not for truncation of the charging session. |
|
The cause for the truncation of a charging session. |
Example
{
"truncationCause": "DISCONNECTED",
"originalAchievableStateOfCharge": "1.0",
"achievableStateOfCharge": "1.0"
}
SmartFlexDevice
Information about a device that has been registered for Smart Flex.
Fields
Name | Description |
---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
Information about the current status of this device. |
Example
{
"id": "abc123",
"name": "abc123",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "abc123",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "abc123",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface
}
SmartFlexDeviceAlert
Information about an alert relevant to a device registered for Smart Flex.
Fields
Name | Description |
---|---|
|
A device alert message. |
|
When a device alert message is published. |
Example
{
"message": "abc123",
"publishedAt": "2020-01-01T00:00:00.000Z"
}
SmartFlexDevicePreferenceSchedule
A schedule entry for device preferences specifying target values for a specific day and time.
For information about valid value ranges, time constraints, and step increments,
query the device's preferenceSettings
field which provides bounds and validation rules.
Fields
Name | Description |
---|---|
|
Day of week schedule applies to. |
|
Maximum value for the schedule. Usage depends on the targetType - e.g., maximum charge for EVs. For valid bounds and step increments, see the device's |
|
Minimum value for the schedule when applicable. Usage depends on the targetType - e.g., minimum temperature for heat pumps. May be null for device types that don't require a lower bound. For valid bounds and step increments, see the device's |
|
Time of day the preference applies. |
|
Upper limit value for the schedule when applicable.Usage depends on the targetType - e.g., charge level to never be exceeded for V2G EVs.May be null for device types that don't require an upper bound. |
Example
{
"dayOfWeek": "MONDAY",
"time": "00:00:00.000Z",
"min": 1.0,
"max": 1.0,
"upperLimit": 1.0
}
Fields
Name | Description |
---|---|
|
The status of the device's grid export capability. |
|
The device's preference mode. |
|
The schedules of the device's preference. |
|
The target type of the preference. |
|
The unit of the preference schedules' min and max values. |
Example
{
"targetType": "ABSOLUTE_STATE_OF_CHARGE",
"unit": "CELSIUS",
"mode": "CHARGE",
"schedules": [SmartFlexDevicePreferenceSchedule],
"gridExport": "ENABLED"
}
SmartFlexDeviceStatus
Information about the current status of a device registered for Smart Flex.
Fields
Name | Description |
---|---|
|
The current status of the device. |
|
The current state of this SmartFlex device state machine. |
|
Whether control of the device is currently disabled. |
Example
{
"current": "ONBOARDING",
"isSuspended": true,
"currentState": "AUTHENTICATION_PENDING"
}
Fields
Name | Description |
---|---|
|
Import supply point ID. |
|
SmartFlex device ID. |
Example
{
"importSupplyPointId": "abc123",
"smartFlexDeviceId": "abc123"
}
Fields
Name | Description |
---|---|
|
The end time of the dispatch. |
|
The energy added in kWh of the dispatch. |
|
The start time of the dispatch. |
|
The type of charge. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z",
"type": "SMART",
"energyAddedKwh": "1.0"
}
SmartFlexOnboardingDeviceRegistration
A type that returns True if the device(s) were successfully registered.
Fields
Name | Description |
---|---|
|
Returns true if the device(s) were successfully registered. |
|
A unique identifier for this onboarding step. |
Example
{
"id": "abc123",
"deviceRegistered": true
}
Fields
Name | Description |
---|---|
|
A Backend Screen that renders the SmartFlex onboarding wizard. |
|
The completed steps for all onboarding wizards that are currently in progress. Note: - The last step is the most recent one. - If an onboarding journey is completed, it will not be included in this list. |
|
The next step of the SmartFlex onboarding wizard. Returns |
|
The onboarding wizard's selected device type to be onboarded. |
|
The onboarding wizard's display name extracted from the wizard's selected device attributes. |
|
A unique identifier for this SmartFlex onboarding wizard. |
|
Determines whether the wizard's onboarding journey can be resumed. |
Example
{
"id": "abc123",
"resumable": SmartFlexResumable,
"deviceType": "BATTERIES",
"displayName": "abc123",
"backendScreen": BackendScreenType,
"currentStep": SmartFlexOnboardingStepInterface,
"completedSteps": SmartFlexOnboardingStepInterface
}
Fields
Name | Description |
---|---|
|
A boolean to determine whether the wizard's onboarding journey can be resumed. |
|
Reasons why a wizard cannot be resumed. |
Example
{
"isResumable": true,
"resumableReasons": ["abc123"]
}
SmartFlexVehicle
Information about a vehicle that has been registered with Kraken Flex.
Fields
Name | Description |
---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
This contains more detail about the variant of the charge point model. |
|
The user's preferences for charging this vehicle. Deprecated The 'chargingPreferences' field is deprecated. |
|
History of charging sessions for a SmartFlex device. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The make of the vehicle, e.g. Tesla. |
|
The model of the vehicle, e.g. Model 3. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
Information about the current status of this device. |
|
This contains more detail about the variant of the vehicle model. |
Example
{
"id": "abc123",
"name": "abc123",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "abc123",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "abc123",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"chargingSessions": DeviceChargingSessionConnection,
"make": "abc123",
"model": "abc123",
"vehicleVariant": ElectricVehicleModelType,
"chargePointVariant": ChargePointVariantModelType,
"chargingPreferences": SmartFlexVehicleChargingPreferences
}
SmartFlexVehicleChargingPreferences
The user's preferences for charging, e.g. target SoC (State of Charge).
Fields
Name | Description |
---|---|
|
The maximum SoC (percentage). |
|
The minimum SoC (percentage). |
|
The target SoC to achieve on a weekday (percentage). |
|
The time at which the target SoC should be achieved on a weekday. |
|
The target SoC to achieve on a weekend (percentage). |
|
The time at which the target SoC should be achieved on a weekend. |
Example
{
"weekdayTargetTime": "00:00:00.000Z",
"weekdayTargetSoc": 1,
"weekendTargetTime": "00:00:00.000Z",
"weekendTargetSoc": 1,
"minimumSoc": 1,
"maximumSoc": 1
}
SmartFlexVehicleStatus
The current status of a registered vehicle.
Fields
Name | Description |
---|---|
|
The current status of the device. |
|
The current state of this SmartFlex device state machine. |
|
Whether control of the device is currently disabled. |
|
Information about the limits for the SoC. |
|
The reason for the most recent failed test dispatch (if any). |
Example
{
"current": "ONBOARDING",
"isSuspended": true,
"currentState": "AUTHENTICATION_PENDING",
"stateOfChargeLimit": StateOfChargeLimit,
"testDispatchFailureReason": "NONE"
}
Fields
Name | Description |
---|---|
|
|
|
Date of the payment the source fund request is for. |
|
|
|
|
|
|
|
|
|
|
|
|
|
Status of the source fund request. |
|
Example
{
"sourceLedger": SupplementaryLedgerType,
"targetLedger": SupplementaryLedgerType,
"paymentReason": "ACCOUNT_CHARGE_PAYMENT",
"requestedAmount": 1,
"status": "REQUESTED",
"requestedByAccountUser": AccountUserType,
"sourcedAmount": 1,
"sourcedAt": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z",
"expectedPaymentDate": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SourceFundRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
SourceFundRequestConnectionTypeEdge
A Relay edge containing a SourceFundRequestConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SourceFundRequest,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Fund source request eligibility outcome. |
|
Payment date the fund sourcing is supposed to apply to. |
|
ID of a charging ledger tested for source fund request. Deprecated The 'ledgerId' field is deprecated. |
|
Number of a charging ledger tested for source fund request. |
Example
{
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"eligibilityOutcome": "OK",
"expectedPaymentDate": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Fund source request eligibility outcome that prevails at account level. |
|
Wether at least one source fund request is possible for the given account. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SourceFundRequestEligibilityConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1,
"hasAnyEligibleLedger": true,
"globalEligibilityOutcome": "OK"
}
SourceFundRequestEligibilityConnectionTypeEdge
A Relay edge containing a SourceFundRequestEligibilityConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SourceFundRequestEligibility,
"cursor": "abc123"
}
SpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services.
Fields
Name | Description |
---|---|
|
The date and time the special circumstance record was created. |
|
|
|
|
|
Example
{
"id": "abc123",
"summary": "abc123",
"internalCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}
SpecialCircumstancesType
Information about the special circumstances that relate to a user.
Fields
Name | Description |
---|---|
|
Whether the user has consented for their data to be given to the appropriate industry or regulatory bodies. We typically only ask for this once, so this field can be used to decide whether to ask the user for their initial consent. |
|
Example
{
"isSharingConsentGiven": true,
"records": [SpecialCircumstanceRecordUnion]
}
StartCustomerVerification
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The newly created verification process. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}
StartSmartFlexOnboarding
Create a wizard for onboarding a device with SmartFlex.
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
StartTestChargeForSmartFlexOnboarding
Attempt to start a test charge.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}
Fields
Name | Description |
---|---|
|
Whether or not target SoC exceeds upper SoC limit. |
|
Time of the latest SoC limit reading. |
|
Maximum level of charge allowed by the battery relative to its capacity (in percent). |
Example
{
"upperSocLimit": 1,
"timestamp": "abc123",
"isLimitViolated": true
}
StatementBillingDocumentConnectionTypeConnection
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": StatementBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
StatementBillingDocumentConnectionTypeEdge
A Relay edge containing a StatementBillingDocumentConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": StatementBillingDocumentType,
"cursor": "abc123"
}
StatementBillingDocumentType
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
Name | Description |
---|---|
|
Billing document that annuls this statement. |
|
Position of the billing document in the delinquent debt tracking system. |
|
The earliest charge date of the statement. |
|
The end of the statement's period. |
|
The date and time the statement was sent to the customer. |
|
|
|
The unique reference of the statement that can be used for identifying the statement externally. |
|
The latest charge date of the statement. |
|
The date due for payment for the statement. |
|
URL to the PDF of the statement. |
|
The start of the statement's period. |
|
The total amounts for all charges on the statement. |
|
The total amounts for all credits on the statement. |
|
Transactions on the statement |
Example
{
"id": 1,
"identifier": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"firstIssuedAt": "2020-01-01T00:00:00.000Z",
"earliestChargeAt": "2020-01-01T00:00:00.000Z",
"latestChargeAt": "2020-01-01T00:00:00.000Z",
"paymentDueDate": "2020-01-01",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType
}
Fields
Name | Description |
---|---|
|
The gross total amount for the statement (in minor currency units). |
|
The net total amount for the statement (in minor currency units). |
|
The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 1,
"taxTotal": 1,
"grossTotal": 1
}
Fields
Name | Description |
---|---|
|
|
|
The type of the bill. |
|
This field returns the closing balance of an issued statement. |
|
The last day of consumption that this statement includes. |
|
The first day of consumption that this statement includes. |
|
The date of the constituent bill covered from. |
|
Retrieve the held status of a account statement. |
|
The ID of the constituent bill. |
|
Whether the bill originated in Kraken or externally. |
|
The date the bill was sent to the customer. |
|
This field returns the opening balance of a statement. |
|
The date the bill is due to be paid. |
|
How many charges have been reversed after the close date. |
|
Current status of the associated statement. |
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
Email recipient address. |
|
The date of the constituent bill covered to. |
|
The total amounts for all charges on the statement. |
|
The total amounts for all credits on the statement. |
|
Transactions on the bill. |
|
Email recipient user ID. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"closingBalance": 1,
"openingBalance": 1,
"isExternalBill": true,
"transactions": TransactionConnectionTypeConnection,
"userId": 1,
"toAddress": "abc123",
"paymentDueDate": "2020-01-01",
"consumptionStartDate": "2020-01-01",
"consumptionEndDate": "2020-01-01",
"reversalsAfterClose": "ALL",
"status": "OPEN",
"heldStatus": HeldStatus,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType
}
Fields
Name | Description |
---|---|
|
Monetary cost of the statistic (excluding tax), if applicable. |
|
Monetary cost of the statistic (including tax), if applicable. |
|
Description of the statistic for the parent node. |
|
Display label of the statistic for the parent node. |
|
The type of statistic being measured for the parent node. |
|
Consumption / generation value of the statistic, if applicable. |
Example
{
"type": "STANDING_CHARGE_COST",
"label": "abc123",
"description": "abc123",
"costExclTax": EstimatedMoneyType,
"costInclTax": EstimatedMoneyType,
"value": "1.0"
}
StopAutomatedPayments
Choose how automatic payments will be collected.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}
StoreDirectDebitPaymentMethodDetails
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "abc123"
}
StorePaymentInstruction
Store a new payment instruction created through the embedded process.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The stored payment instruction. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}
SubmitCustomerFeedback
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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
SubmitRepaymentRequest
Mutation for executing the repayment request use case.
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-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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The newly created repayment request. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentRequest": RequestRepaymentOutputType
}
SupplementaryLedgerType
Ledgers provide the foundation of Kraken’s bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular Kraken account.
Fields
Name | Description |
---|---|
|
The current final balance of the ledger in pence. |
|
Deprecated The 'ledgerId' field is deprecated. |
|
|
|
The display name of the ledger. |
|
The canonical name of the ledger. |
|
The current outstanding balance (calculated the french way) on the ledger in eurocents. |
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"id": "abc123",
"name": "abc123",
"ledgerType": "abc123",
"number": "abc123",
"currentBalance": 1,
"paymentAdequacy": PaymentAdequacyDetailsType,
"outstandingBalance": 1
}
SupplyConsumptionRateConnectionTypeConnection
Paginator of consumption rates.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyConsumptionRateConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
SupplyConsumptionRateConnectionTypeEdge
A Relay edge containing a SupplyConsumptionRateConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SupplyConsumptionRateType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Price currency. |
|
Time slot where the energy is being used. |
|
Price per unit (without taxes). |
|
Price per unit (with taxes). |
|
List of time slots. |
|
Unit type. |
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "abc123",
"pricePerUnit": "1.0",
"pricePerUnitWithTaxes": "1.0",
"energyUseTimeSlot": "ALL_DAY",
"timeSlots": [TimeSlotPeriod]
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyContractConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
SupplyContractConnectionTypeEdge
A Relay edge containing a SupplyContractConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SupplyContractType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The activation process linked to the supply contract if available. |
|
Agreements contained in the contract. |
|
|
|
Beginning of the contract (first valid from from related agreements). |
|
End of the contract if all related agreements are terminated (the last valid to from related agreements). If the contract is still active, this field will be null. |
Example
{
"number": "abc123",
"agreements": AgreementConnectionTypeConnection,
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"activationProcess": ActivationProcessInterface
}
Fields
Name | Description |
---|---|
|
|
|
Should this period be billed? False for accepted erroneous gains. |
|
|
|
Example
{
"id": "abc123",
"supplyStartAt": "2020-01-01T00:00:00.000Z",
"supplyEndAt": "2020-01-01T00:00:00.000Z",
"isBillable": true
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyPointConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
SupplyPointConnectionTypeEdge
A Relay edge containing a SupplyPointConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SupplyPointType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
Supply point external identifier. |
|
Supply point market name. |
|
Requested supply start date. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123",
"requestedSupplyStartDate": "2020-01-01"
}
Fields
Name | Description |
---|---|
|
Potential eligibility/technical errors. |
|
A predicate that indicates whether the supply point is eligible. |
|
A predicate that indicates whether this is the supply point's first commissioning. |
|
The journey type. |
|
Data related to the supply point. |
Example
{
"isEligible": true,
"journeyType": "COMMISSIONING",
"isFirstCommissioning": true,
"errors": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"supplyPoint": SupplyPointType
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyPointEligibilityResultConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
SupplyPointEligibilityResultConnectionTypeEdge
A Relay edge containing a SupplyPointEligibilityResultConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SupplyPointEligibilityResult,
"cursor": "abc123"
}
SupplyPointType
Represents a SupplyPoint.
Fields
Name | Description |
---|---|
|
The external identifier of the supply point. |
|
The ID of the supply point. |
|
The latest supply periods for the supply point. |
|
The market this supply point belongs to. |
|
Data related to the meter point. |
|
The supply point's property |
|
Get readings from this supply point. |
Example
{
"id": "abc123",
"marketName": "abc123",
"externalIdentifier": "abc123",
"property": PropertyType,
"readings": ReadingsConnection,
"meterPoint": MeterPointInterface,
"lastSupplyPeriod": SupplyPeriodType
}
Fields
Name | Description |
---|---|
|
Price currency. |
|
Price per unit (without taxes). |
|
Price per unit (with taxes). |
|
Unit type. |
Example
{
"unitType": "DAYS_ON_SUPPLY",
"currency": "abc123",
"pricePerUnit": "1.0",
"pricePerUnitWithTaxes": "1.0"
}
SupplyProductType
GraphQL type for a supply product.
Fields
Name | Description |
---|---|
|
The product availability status. |
|
The date and time the product is available from. |
|
The date and time the product is available to. |
|
The brand code of the product. |
|
The product code. |
|
The product description. |
|
The product description. |
|
The date the product ends. |
|
The product title. |
|
|
|
Whether the product is hidden. |
|
The name of the market the product belongs to. |
|
The product notes. |
|
The product parameters. |
|
Tags associated with the product. |
|
The product term in months. |
|
Active terms and conditions for a market supply product. |
|
The product contract type. |
Example
{
"id": "abc123",
"code": "abc123",
"notes": "abc123",
"fullName": "abc123",
"displayName": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01T00:00:00.000Z",
"availableTo": "2020-01-01T00:00:00.000Z",
"isHidden": true,
"term": 1,
"endsAt": "2020-01-01T00:00:00.000Z",
"brandCode": "abc123",
"marketName": "abc123",
"availabilityStatus": "EVERYONE",
"termsContractType": "abc123",
"termsAndConditionsTypes": TermsAndConditionsType,
"params": {"key": "value"},
"tags": "abc123"
}
SuspendDeviceControl
Suspend control of a device while away from home, e.g. on holiday.
This is to prevent charging during that period.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4358: Unable to suspend device control.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}
SwitchAccountToVariablePaymentSchedule
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3921: Account not found.
- KT-CT-3922: Ledger not found for the account.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
New payment schedule. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
SwitchProduct
Applies the quoted products to the given account's matching agreements.
The possible errors that can be raised are:
- KT-FR-4114: Account not found.
- KT-FR-4115: QuotedProduct not found.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
The agreement with the new product. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"newAgreement": AgreementType
}
Fields
Name | Description |
---|---|
|
URL to the PDF of the tariff grid. The possible errors that can be raised are:
|
Example
{
"temporaryUrl": "abc123"
}
Fields
Name | Description |
---|---|
|
The error message if the task failed. |
|
The result of the task. |
|
The status of the task. |
Example
{
"status": "STARTED",
"result": {"key": "value"},
"error": "abc123"
}
TemporarySpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services. These circumstances have an end date, after which they will not longer apply. Having young children is an example of this in the UK.
Fields
Name | Description |
---|---|
|
The date and time the special circumstance record was created. |
|
|
|
|
|
|
|
Example
{
"id": "abc123",
"summary": "abc123",
"internalCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"expiryDate": "2020-01-01"
}
TerminateCreditTransferPermission
Mutation to terminate a credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3825: Credit transfer permission not found.
- KT-CT-3827: The ledger is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"validTo": "2020-01-01T00:00:00.000Z"
}
TerminationFeeType
Represents the termination term of a contract.
Fields
Name | Description |
---|---|
|
The amount of the termination fee. |
|
The description of the term. |
|
The display name of the term. |
|
The type of termination fee. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"amount": "1.0",
"feeType": TerminationFeeType
}
TermsAndConditionsConnectionTypeConnection
Pagination for terms and conditions.
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TermsAndConditionsConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
TermsAndConditionsConnectionTypeEdge
A Relay edge containing a TermsAndConditionsConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": TermsAndConditionsType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
|
|
|
|
The html of the terms and conditions document rendered as a JSON string. |
|
The markdown text of the terms and conditions. |
|
|
|
|
|
Example
{
"name": "abc123",
"pdfUrl": "abc123",
"brandCode": "abc123",
"markdown": "abc123",
"html": "abc123",
"version": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}
TeslaModifyScopes
A step which indicates that the Tesla permission scopes need to be granted by the user in order to register their vehicle.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
Returns the URI to update the permission scopes. |
|
The redirect URI to return to after updating the permission scopes. |
Example
{
"id": "abc123",
"modifyScopesUri": "abc123",
"redirectUri": "abc123"
}
TeslaRegistrationFailed
A step which indicates that the Tesla registration failed and the user must re-grant permission scopes to register their vehicle.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
Returns:- |
Example
{
"id": "abc123",
"modifyScopesSelected": true
}
TeslaSetupVirtualKey
A step which indicates that the user must add the given URI as a virtual key in their Tesla account.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
The name of the key to add. |
|
The URI to add as a virtual key in the user's Tesla account. |
Example
{
"id": "abc123",
"key": "abc123",
"uri": "abc123"
}
TestCharge
A step which indicates if we're able to test charge the user's vehicle(s).
Fields
Name | Description |
---|---|
|
Returns the error raised from a failed test charge. |
|
A unique identifier for this onboarding step. |
|
Returns |
|
Returns |
|
Returns the dispatch status of test charge. Deprecated The 'status' field is deprecated. |
Example
{
"id": "abc123",
"error": TestChargeError,
"isReady": true,
"status": "TRIGGERED",
"isStarted": true
}
TestChargeError
Errors can be of two kinds (assuming the user is querying this type with message
,
reasons
, errorType
, and descriptions
fields):
If we were unable to start a test charge, the response will be:
{ "message": "TestChargeRefused", "reasons": [Returns a list of values from `TestChargeRefusalReason`], "errorType": "UNABLE_TO_INITIATE_TEST_CHARGE", "descriptions": [Returns a list of descriptions for the refusal reasons] }
Where
descriptions
can be: -DEVICE_LIVE
: "device is already live" -DEVICE_ONBOARDING_IN_PROGRESS
: "test dispatch already in progress" -DEVICE_RETIRED
: "device is retired" -DEVICE_SUSPENDED
: "device is suspended" -DEVICE_DISCONNECTED
: "device is disconnected" -DEVICE_ALREADY_CHARGING
: "device is already charging" -DEVICE_AWAY_FROM_HOME
: "device is away from home" -DEVICE_NO_LOCATION_CONFIGURED
: "device has no location configured" -DEVICE_LOCATION_UNABLE_TO_IDENTIFY
: "unable to identify device location" -DEVICE_LOCATION_MISSING
: "device location is missing"If an error occurred during a test charge, the response will be:
{ "message": "Test dispatch failed", "reasons": [Returns a list of values from `TestDispatchAssessmentFailureReason`], "errorType": "UNABLE_TO_COMPLETE_TEST_CHARGE", "descriptions": [Returns a list of descriptions for the refusal reasons] }
Where
descriptions
can be: -ASSESSMENTS_FAILED
: "Both power-based and charge status-based assessments failed" -NOT_AT_HOME
: "Device location not at home" -UNKNOWN
: "Unknown failure" -UNABLE_TO_COMMUNICATE
: "Unable to communicate with device" -DEVICE_DISCONNECTED
: "Device disconnected" -SOC_LIMIT_REACHED
: "State of charge limit reached" -ERROR
: "Could not fetch the test charge failure reason" -NONE
: "No failure reason"
Fields
Name | Description |
---|---|
|
A list of error descriptions for a failed test charge attempt. |
|
The type of test charge error. |
|
A human readable error message. |
|
A list of reasons for a failed test charge attempt. |
|
A list of refusal reasons from the failed test charge attempt. Deprecated The 'refusalReasons' field is deprecated. |
Example
{
"message": "abc123",
"refusalReasons": "DEVICE_LIVE",
"errorType": "UNABLE_TO_INITIATE_TEST_CHARGE",
"reasons": ["abc123"],
"descriptions": ["abc123"]
}
TextType
A block of text.
Fields
Name | Description |
---|---|
|
Unique identifier of the object. |
|
The text alignment. |
|
The text style, i.e. header, body. |
|
The name of the object's type. |
|
The text content. |
Example
{
"value": "abc123",
"textStyle": "TITLE1",
"textAlignment": "START",
"id": "abc123",
"typename": "abc123"
}
ThirdPartyCompleteDeviceRegistration
Complete the registration of a device.
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- KT-CT-4322: Unable to complete registration error.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The response showing account validity and optional tariff information. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": ThirdPartyCompleteDeviceRegistrationType
}
Fields
Name | Description |
---|---|
|
If the account is valid. |
|
If a switch to the required tariff is in progress. |
|
The tariff the account is on, if the switch is complete. |
Example
{
"isAccountValid": true,
"isTariffSwitchInProgress": true,
"tariff": ThirdPartyTariffsType
}
ThirdPartyOrganizationType
Type for the third party organization.
Fields
Name | Description |
---|---|
|
|
|
Holds information about the permissions of the current viewer. |
Example
{
"name": "abc123",
"permissions": [ThirdPartyPermission]
}
ThirdPartyPermission
Holds information about a specific permission.
Fields
Name | Description |
---|---|
|
The short name of the permission |
Example
{
"permission": "abc123"
}
Fields
Name | Description |
---|---|
|
Day(s) of the week of the tariff interval. |
|
Local 24hr end time of the tariff interval (format hh:mm). |
|
Local 24hr start time of the tariff interval (format hh:mm). |
|
The type of tariff this is (e.g. peak or offPeak). |
Example
{
"startTime": "abc123",
"endTime": "abc123",
"daysOfWeek": "abc123",
"tariffType": "abc123"
}
Fields
Name | Description |
---|---|
|
Currency according to the ISO 4217 standard. |
|
Price per kWh in the given currency. |
|
The type of tariff this is (e.g. peak or offPeak). |
Example
{
"currency": "abc123",
"price": "1.0",
"type": "abc123"
}
Fields
Name | Description |
---|---|
|
Tariff intervals of the charging location. |
|
Tariff rates of the charging location. |
Example
{
"tariffs": ThirdPartyTariffType,
"tariffIntervals": ThirdPartyTariffIntervalType
}
Fields
Name | Description |
---|---|
|
The discount that is rewarded when the power crosses the corresponding threshold. Ranges from 0.0 - 1.0. |
|
The power (kW) that must be surpassed to achieve the corresponding discount. |
|
The wind speed (m/s) that corresponds to the power cut-off for this threshold. |
Example
{
"power": "1.0",
"discount": "1.0",
"windSpeed": "1.0"
}
TimeOfUseOverrideType
Represents a time-of-use override to be applied in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
Name | Description |
---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}
Fields
Name | Description |
---|---|
|
End of the time slot (exclusive). |
|
Beginning of the time slot (inclusive). |
Example
{
"startAt": "00:00:00.000Z",
"endAt": "00:00:00.000Z"
}
Fields
Name | Description |
---|---|
|
The gross amount (in minor currency units). |
|
The net amount (in minor currency units). |
|
The amount of tax (in minor currency units). |
Example
{
"net": 1,
"tax": 1,
"gross": 1
}
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
TransactionConnectionTypeEdge
A Relay edge containing a TransactionConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": TransactionType,
"cursor": "abc123"
}
TransferLedgerBalance
Trigger balance transfer between accounts.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-9701: Balance transfer to same account is not allowed.
- KT-CT-9702: Balance transfer is not support for debit account with Zero balance.
- KT-CT-9703: Balance transfer is not supported for debit account.
- KT-CT-9704: Balance transfer amount should be non-zero.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Balance transfer details. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"balanceTransfer": AccountBalanceTransferType
}
TransferLoyaltyPointsBetweenUsers
Transfer Loyalty Points between users.
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.
Fields
Name | Description |
---|---|
|
The number of loyalty points that were transferred. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 1
}
Fields
Name | Description |
---|---|
|
The date/time that the trigger was created. |
|
The ID of the trigger. |
|
The messages created in response to this trigger. |
|
The current processing status of this trigger. |
|
The trigger type code for this trigger. |
Example
{
"id": "abc123",
"triggerTypeCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"messages": MessageConnection,
"processingStatus": "UNPROCESSED"
}
UnenrollAccountFromLoyaltyProgram
Unenroll an account from the loyalty program.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9220: Ineligible loyalty points unenrollment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Outcome of the loyalty points campaign enrollment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"outcome": UnenrollAccountFromLoyaltyProgramOutcome
}
Fields
Name | Description |
---|---|
|
Indicates whether the account has been unenrolled from the loyalty points campaign. |
Example
{
"hasUnenrolled": true
}
UpdateAPIException
The possible errors that can be raised are:
- KT-CT-7804: No fields present in the input for updating the APIException.
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-7809: Update results in no changes to API Exception.
- KT-CT-7805: Too many tags associated with this API Exception.
- KT-CT-7806: Cannot create duplicate tags for the same API exception.
- KT-CT-7801: Received an invalid operationsTeamId.
- KT-CT-7811: Received an invalid assignedUserId.
- KT-CT-7812: Support user is inactive.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The updated APIException. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
UpdateAPIExceptionNote
The possible errors that can be raised are:
- KT-CT-7807: Received an invalid apiExceptionNoteId.
- KT-CT-7808: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The updates APIExceptionNote. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}
UpdateAccountBillingAddress
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.
Fields
Name | Description |
---|---|
|
The updated account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
UpdateAccountBillingEmail
Update the billing email for the input account number to the received email value.
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.
Fields
Name | Description |
---|---|
|
Account that was changed. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
UpdateAccountConsents
Update the consents for an account using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9018: Account not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Consents linked to this account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consents": ConsentType
}
UpdateAccountReference
Update a reference for a particular account and namespace.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
UpdateAccountUserCommsPreferencesMutationPayload
Update the account user comms preferences.
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"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"
}
UpdateAccountUserConsents
Update the consents from an account user using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-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.
Fields
Name | Description |
---|---|
|
All the consents for an account user. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}
Fields
Name | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"errors": [ErrorType],
"clientMutationId": "abc123"
}
UpdateActivePurchase
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.
Fields
Name | Description |
---|---|
|
Goods purchase updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
UpdateAffiliateLink
Update an affiliate link of an existing sales agent.
The possible errors that can be raised are:
- KT-CT-7711: Invalid data.
- KT-CT-7713: Invalid data.
- KT-CT-7714: Invalid data.
- KT-CT-7715: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The updated affiliate link. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateLink": AffiliateLinkType
}
UpdateAffiliateOrganisation
Update an affiliate organisation.
The possible errors that can be raised are:
- KT-CT-7717: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The updated affiliate organisation. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateOrganisation": AffiliateOrganisationType
}
UpdateAgreementPeriod
Update the period of an agreement.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-1501: Agreement not found.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1504: Account does not match with the agreement.
- KT-CT-1505: Unable to edit agreement.
- KT-CT-1506: Agreement period is not within the supply and property period.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Account responsible for the update agreement. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}
UpdateAutoTopUpAmount
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The new schedule created. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
UpdateCollectionProcessRecordToActive
Update the Collection Process Record from raised status to active
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11202: No External reference provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the collection process was successfully updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
}
UpdateCollectionProcessRecordToActiveOutputType
Output for updating a Collection process Record to Active.
Fields
Name | Description |
---|---|
|
The number of the collection process record. |
|
The current status of the collection process record. |
Example
{
"number": "abc123",
"status": "PENDING"
}
UpdateCollectionProcessRecordToComplete
Update the Collection Process Record from raised status to complete
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11203: No Completion reason provided.
- KT-CT-11204: No Completion details provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the collection process was successfully updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
}
UpdateCollectionProcessRecordToCompleteOutputType
Output for updating a Collection process Record to Complete.
Fields
Name | Description |
---|---|
|
The number of the collection process record. |
|
The current status of the repayment request. |
Example
{
"number": "abc123",
"status": "PENDING"
}
UpdateCommsDeliveryPreference
Update the comms delivery preference for the input account number to the received commsDeliveryPreference value.
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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
UpdateDCAProceeding
The possible errors that can be raised are:
- KT-CT-11610: unable to edit the debt collection proceeding.
- KT-CT-11604: Active debt collection proceeding does not exist for account.
- KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the update has been applied. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
}
UpdateIndustryConsentData
Updates industry consent data.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-4719: No supply point found for identifier provided.
- KT-FR-4524: Invalid input provided to update industry consent data.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Consents for French Distribution Network Operators. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consentData": IndustryConsentData
}
UpdateLeadAssignment
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}
UpdateLeadDetails
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-8914: Stage not found.
- KT-CT-8915: Stages are not in the same funnel.
- KT-CT-8916: Current stage mismatch.
- KT-CT-8917: Stage transition not allowed.
- KT-CT-8918: Stage precondition not met.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
|
|
Confirmed tags. |
Example
{
"tags": InkTag,
"clientMutationId": "abc123"
}
UpdateMetadata
Update existing 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.
Fields
Name | Description |
---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}
UpdateOpportunityAssignment
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8903: Unable to update opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedOpportunityData": {"key": "value"}
}
UpdateOpportunityExtraDetails
The possible errors that can be raised are:
- KT-CT-8903: Unable to update opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
The opportunity's extra details to be added or updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"extraDetails": {"key": "value"}
}
UpdateOpportunityStage
The possible errors that can be raised are:
- KT-CT-8903: Unable to update opportunity.
- KT-CT-8910: Received opportunity current stage is not valid.
- KT-CT-8914: Stage not found.
- KT-CT-8915: Stages are not in the same funnel.
- KT-CT-8916: Current stage mismatch.
- KT-CT-8917: Stage transition not allowed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Placeholder success message for now. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "abc123"
}
UpdatePassword
Update user's password.
Note this is different from the ResetPassword mutation, which is used to reset a password when the user has forgotten it. This mutation is used to update the password when the user is already authenticated and wants to change their password.
Ideally, this mutation would simply receive a "new_password" and use the current password update usecase, but, until we're ready for a breaking change, we'll need to use the Django form to also validate the old password and two new passwords.
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.
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 |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
UpdateProductPricesOutput
Rate group prices for a product.
Fields
Name | Description |
---|---|
|
The rate group prices. |
Example
{
"prices": RateGroupPrices
}
UpdateSiteworksRequest
The possible errors that can be raised are:
- KT-CT-4231: Unauthorized.
- KT-CT-4232: Status passed is not valid.
- KT-CT-4233: Request does not exist.
- KT-CT-4234: Terminated Request cannot be updated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The siteworks request after the update. |
Example
{
"possibleErrors": [PossibleErrorType],
"siteworksRequest": CoreSiteworksRequestType
}
UpdateUserMutation
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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}
Fields
Name | Description |
---|---|
|
Present for completed dispatches, otherwise |
|
Present for planned dispatches, otherwise |
Example
{
"source": "abc123",
"location": "abc123"
}
Fields
Name | Description |
---|---|
|
Energy in kWh (import has a negative value). |
|
This field has been replaced by Deprecated The 'deltaKwh' field is deprecated. |
|
The end time of the dispatch. |
|
This field has been replaced by Deprecated The 'endDt' field is deprecated. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The start time of the dispatch. |
|
This field has been replaced by Deprecated The 'startDt' field is deprecated. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z",
"startDt": "abc123",
"endDt": "abc123",
"deltaKwh": 1,
"delta": "1.0",
"meta": UpsideDispatchMetaType
}
UserActionReason
A type that returns a user action that needs to be completed for the device to be successfully registered.
Fields
Name | Description |
---|---|
|
Description of the required user action. |
|
An optional uri that, if provided, can navigate the user to where they can resolve this required action. |
|
Reference key to the required user action. |
Example
{
"userAction": "abc123",
"description": "abc123",
"uri": "abc123"
}
UserActionRequired
A type that returns user actions that need to be completed for the device to be successfully registered
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
List of actions the user must resolve in order for the device to be registered. |
Example
{
"id": "abc123",
"userActions": [UserActionReason]
}
Fields
Name | Description |
---|---|
|
The email address can be used for a new user account. |
Example
{
"isAvailable": true
}
UserManagedPayment
Represents the preference of the user to pay himself, instead of get charged.
Fields
Name | Description |
---|---|
|
The start time of the payment preference. |
Example
{
"forPaymentsAfter": "abc123"
}
Fields
Name | Description |
---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Example
{
"vehicleId": "abc123",
"information": VehicleInformationType
}
ValidateEmail
Validate whether a user's email is a valid email via the Kickbox API.
Fields
Name | Description |
---|---|
|
Whether the email is valid or not. |
Example
{
"isValid": true
}
ValidatePhone
Validate whether a user's phone number is a valid phone number.
Fields
Name | Description |
---|---|
|
Whether the phone number is valid or not. |
Example
{
"isValid": true
}
VaryContractTermsOutput
Output type for varying contract terms.
Fields
Name | Description |
---|---|
|
The contract with the varied terms. |
Example
{
"contract": Contract
}
Fields
Name | Description |
---|---|
|
The maximum state of charge (soc) %, if available. |
|
The minimum state of charge (soc) %, if available. |
|
|
|
|
|
|
|
Example
{
"weekdayTargetTime": "abc123",
"weekdayTargetSoc": 1,
"weekendTargetTime": "abc123",
"weekendTargetSoc": 1,
"minimumSocPercentage": 1,
"maximumSocPercentage": 1
}
Fields
Name | Description |
---|---|
|
|
|
The (user chosen) display name of the vehicle, if available. |
|
The model name of the vehicle, if available (e.g. i3s 120). |
|
|
|
The year of the vehicle model, if available. |
Example
{
"vin": "abc123",
"brand": "abc123",
"model": "abc123",
"year": 1,
"displayName": "abc123"
}
Fields
Name | Description |
---|---|
|
Verification process status. |
|
Verification type. |
|
Customer with pending verification. |
Example
{
"userNumber": "abc123",
"status": "abc123",
"type": "abc123"
}
VerifyCustomer
Verify a customer using the provided code and verification 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.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The currently authenticated user. |
Example
{
"possibleErrors": [PossibleErrorType],
"user": AccountUserType
}
VerifyEmail
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Whether the email is verified. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"isVerified": true
}
VerifyIdentity
The possible errors that can be raised are:
- KT-CT-1145: Account/user details do not match.
- KT-CT-1113: Disabled GraphQL field requested.
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. |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
VoiceCampaignConnectionTypeConnection
Paginator of Voice Campaigns
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoiceCampaignConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
VoiceCampaignConnectionTypeEdge
A Relay edge containing a VoiceCampaignConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": VoiceCampaignType,
"cursor": "abc123"
}
VoiceCampaignItemConnectionTypeConnection
Paginator of Campaign Items
Fields
Name | Description |
---|---|
|
Number of nodes in the edge. |
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoiceCampaignItemConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}
VoiceCampaignItemConnectionTypeEdge
A Relay edge containing a VoiceCampaignItemConnectionType
and its cursor.
Fields
Name | Description |
---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": VoiceCampaignItemType,
"cursor": "abc123"
}
Fields
Name | Description |
---|---|
|
The account ID associated with the item. If the phone number for the item is not set, the account ID will be used to determine the phone number to call. |
|
Together with |
|
Together with |
|
The ID of the campaign item. |
|
Metadata about the item. This enables items to be filtered based on additional information such as location. It is a dictionary of key-value pairs, with both keys and values being strings. |
|
The phone number of the campaign item. This is used to determine the phone number to call when the item is processed. If it is not set, the account ID will be used instead to call the phone number associated with the account. |
|
The status of the campaign item that determines what actions can be taken on it.
|
Example
{
"id": "abc123",
"phoneNumber": "abc123",
"status": "UNASSIGNED",
"callWindowStart": "2020-01-01T00:00:00.000Z",
"callWindowEnd": "2020-01-01T00:00:00.000Z",
"accountId": "abc123",
"metadata": {"key": "value"}
}
Fields
Name | Description |
---|---|
|
The items that are part of the campaign. These are the items that contain information about what phone numbers or accounts to call while this campaign is active. |
|
The type of campaign, e.g. preview or predictive. |
|
If appropriate, a custom number to use as the caller id for calls from this campaign. |
|
Additional information to describe the purpose of the campaign. |
|
The ID of the campaign. |
|
The name of the campaign. This is used to identify the campaign in the system, and must be unique. |
|
Flag to indicate whether not to create a duplicate record when uploading campaign items that already exist for a given account number and/or phone number |
|
The status of the campaign. Indicates whether calls can be made for items in the campaign or not. |
The call tags that can be used within this campaign. |
Example
{
"id": "abc123",
"name": "abc123",
"description": "abc123",
"customOutboundPhoneNumber": "abc123",
"tags": CallTagConnectionTypeConnection,
"status": "ACTIVE",
"campaignType": "PREVIEW",
"campaignItems": VoiceCampaignItemConnectionTypeConnection,
"preventDuplicateRecords": true
}
WaitForLiveIntegration
Indicates a step where the integration is pending activation.
Progress to the next onboarding step is blocked until the integration becomes active.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
|
Returns |
Example
{
"id": "abc123",
"isLive": true
}
WaitForTransition
A generic step that can be used to hold an onboarding wizard until the device has transitioned from one onboarding state to another.
Generally, this step should be completed via a KF AMI event handler after the device has been registered and transitioned to the desired state.
Fields
Name | Description |
---|---|
|
A unique identifier for this onboarding step. |
Example
{
"id": "abc123"
}
Fields
Name | Description |
---|---|
|
Serial number. |
|
Meter point reference. |
|
The frequency of the reading. |
Example
{
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingFrequencyType": "RAW_INTERVAL"
}
Fields
Name | Description |
---|---|
|
Whatsapp text message body. |
Example
{
"body": "abc123"
}
WithdrawDunning
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11301: Account not in a dunning process for the given path name.
- KT-CT-11302: No active dunning process found.
- KT-CT-11303: Multiple active dunning processes found.
- KT-CT-11306: Withdrawing the dunning process failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
Name | Description |
---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the dunning process was withdrawn successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"withdrawSuccessful": true
}
Fields
Name | Description |
---|---|
|
The identifier of the work schedule (also known as the 'slug'). |
|
Whether the work schedule is currently open. |
|
Whether today is a public holiday, according to the work schedule. |
|
Name of the work schedule. |
|
The reason the Work Schedule is open or closed. |
Example
{
"identifier": "abc123",
"name": "abc123",
"isOpen": true,
"isPublicHoliday": true,
"openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
}
Authentication Server
Fields
Name | Description |
---|---|
|
The client ID of the application. |
|
The name of the application. |
Example
{
"name": "abc123",
"clientId": "abc123"
}
CreateMfaDevice
Create a multi-factor authentication (MFA) device for user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1153: Unable to create MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Email address to send the MFA code by default. |
|
Phone number to send the MFA code by default. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}
DeleteMfaDevice
Delete a multi-factor authentication (MFA) device for the authenticated user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1154: Unable to delete MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
Name | Description |
---|---|
|
Flag to indicate if the MFA device has been successfully deleted. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}
KrakenVersionType
Information about what version of Kraken is being executed by this service.
Fields
Name | Description |
---|---|
|
The git commit SHA that is being executed. |
|
The version number that is being executed. |
Example
{
"number": "abc123",
"SHA": "abc123"
}
Fields
Name | Description |
---|---|
|
The type of MFA device. |
|
Whether the MFA device is confirmed or not. |
Example
{
"deviceType": "abc123",
"isConfirmed": true
}
PossibleError
Representation of a graphQL error.
Example
{
"code": "abc123",
"type": "abc123",
"message": "abc123",
"description": "abc123"
}
PossibleErrorType
The GraphQL error type for displaying information about GraphQL errors that might be raised from the API.
Fields
Name | Description |
---|---|
|
The error code that might be returned from the query/mutation. |
|
The error description that might be returned from the query/mutation. |
|
The error message that might be returned from the query/mutation. |
|
The error type that might be returned from the query/mutation. |
Example
{
"message": "abc123",
"code": "abc123",
"type": "abc123",
"description": "abc123"
}
ValidateMfaDevice
Validate multi-factor authentication (MFA) devices 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.
Fields
Name | Description |
---|---|
|
Flag to indicate if the device has been verified, so it can be used for MFA. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}