Objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
API Site
Fields
| Name | Description |
|---|---|
|
Code name of the sensor. |
|
User determined name for a sensor. |
|
Whether or not a sensor is enabled. |
|
Sensor type (NTC). |
Example
{
"code": "house-thus-consumer-despite-develop",
"displayName": "job-from-whole-smile-others",
"type": "ZIGBEE",
"enabled": true
}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": "again-this-Democrat-plan-somebody",
"status": "SCHEDULED",
"apiType": "GRAPHQL",
"startsAt": "fast-camera-shoulder-back-clear",
"endsAt": "should-letter-part-mother-value"
}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": 94,
"edgeCount": 100
}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": "senior-able-them-generation-industry"
}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": "60023739",
"correlationId": "90443943",
"operationName": "wonder-remain-mean-statement-watch",
"inputData": {"key": "value"},
"response": {"key": "value"},
"context": {"key": "value"},
"createdAt": "2014-08-19T12:52:22.656314+00:00"
}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": 27,
"edgeCount": 68
}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": "give-admit-despite-lot-say"
}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": "74828223",
"eventType": "experience-structure-seek-which-truth",
"category": "fill-total-control-realize-network",
"description": "evening-situation-spring-animal-though",
"context": {"key": "value"},
"createdAt": "2016-03-14T02:24:53.517002+00:00"
}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": "38187112",
"body": "itself-risk-size-seat-sign",
"createdAt": "1995-08-13T16:04:33.946570+00:00"
}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": "48583035",
"externalIdentifier": "84321623",
"createdAt": "1980-03-03T14:35:39.797926+00:00",
"channel": "help-nothing-air-though-only",
"category": "ACCOUNT",
"accountNumber": "A-772E48FF",
"userId": 32907776,
"customerContact": "plant-section-five-act-film",
"supplyPointIdentifier": "78927940",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"apiCalls": [APICallType],
"events": [APIExceptionEventType],
"tags": "MOVE_IN",
"notes": [APIExceptionNoteType],
"operationsTeam": OperationsTeamType,
"context": {"key": "value"},
"keyDate": "2010-01-10",
"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
}AcceptTermsAndConditions
Record the terms have been accepted and progress the workflow.
Fields
| Name | Description |
|---|---|
|
Version of terms and conditions that were accepted. |
Example
{
"acceptedVersion": "plant-long-now-agree-city"
}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": 69,
"edgeCount": 49
}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": "once-news-every-with-whatever"
}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": "wrong-be-shoulder-above-difficult",
"salesSubchannel": "significant-research-would-social-woman",
"dateOfSale": "2012-11-27",
"coolingOffEndDate": "2025-10-02",
"isMigrated": true,
"migrationSource": "song-effort-true-car-travel",
"preferredSsd": "1991-02-02"
}Fields
| Name | Description |
|---|---|
|
Debit details. |
|
Credit details. |
|
Balance transfer ID. |
|
The reason for the balance transfer. |
Example
{
"id": "86906311",
"accountCharge": AccountChargeType,
"accountCredit": AccountCreditType,
"reason": "parent-say-chance-one-dark"
}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": 37,
"edgeCount": 82
}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": "close-court-call-or-later"
}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": "1975-02-13",
"name": "summer-customer-candidate-control-job",
"slug": "kind-whose-believe-case-subject",
"expiryDate": "1976-10-12",
"startDate": "2002-12-21"
}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": "2010-05-28T19:10:21.680087+00:00"
}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. |
|
JSON metadata containing unstructured data about the account charge. |
|
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": "33602386",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"reason": "assume-economy-law-miss-upon",
"note": "section-throw-evening-walk-treat",
"displayNote": "sit-think-start-necessary-series",
"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": 19,
"edgeCount": 56
}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": "your-within-especially-option-condition"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"data": {"key": "value"},
"updatedAt": "2007-04-02T06:14:10.236960+00:00"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "69851540",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"note": "model-lose-edge-military-first",
"reason": "lawyer-particular-field-right-tree",
"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": 71,
"edgeCount": 87
}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": "country-later-early-rate-better"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
The ID of the object |
|
Is the file ready for use / downloadable? |
|
Is the file uploaded to S3? |
|
Example
{
"id": "52305790",
"filename": "whom-card-big-industry-budget",
"category": "bit-put-less-least-against",
"isUploaded": true,
"isReady": true,
"fetchUrl": "medical-control-local-other-single",
"sizeInBytes": 81
}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": 9,
"edgeCount": 9
}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": "important-government-enjoy-southern-their"
}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": 90,
"totalMonetaryAmount": 1
}Example
{
"body": "impact-article-today-beat-national",
"isPinned": true,
"createdAt": "1995-08-28T00:05:08.666226+00:00",
"unpinAt": "1975-01-20T08:53:09.974454+00:00"
}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": 77,
"edgeCount": 19
}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": "note-including-develop-office-pick"
}Fields
| Name | Description |
|---|---|
|
Amount of payment in the currency's minor unit |
|
|
|
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": "41738910",
"amount": 1,
"paymentDate": "1975-07-18",
"reference": "even-west-ability-American-information",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"paymentInstruction": PaymentInstructionType,
"surchargeAmount": 58
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Example
{
"namespace": "crime-drive-both-difference-civil",
"value": "despite-per-and-change-heart",
"createdAt": "2021-10-17T14:11:47.647404+00:00",
"updatedAt": "2024-11-21T06:01:33.059561+00:00",
"account": AccountType
}Fields
| Name | Description |
|---|---|
|
Reminder content. |
|
When the reminder is due. |
|
The reminder type. |
Example
{
"reminderType": "AD_HOC",
"content": "wide-myself-make-lose-perform",
"dueAt": "1997-05-04T06:14:40.501267+00:00"
}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": 7,
"edgeCount": 51
}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": "pressure-company-about-lot-establish"
}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": 39,
"edgeCount": 75
}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": "talk-ever-difficult-per-member"
}Fields
| Name | Description |
|---|---|
|
Amount of payment in the currency's minor unit |
|
|
|
The date this payment is scheduled to be debited |
|
The current status of the repayment. |
Example
{
"id": "37853766",
"amount": 1,
"paymentDate": "1995-01-15",
"status": "REQUESTED"
}AccountSearchItemType
A single account search hit
Fields
| Name | Description |
|---|---|
|
The account found. |
|
How well the account matched the search terms. |
Example
{
"account": AccountType,
"score": "1.0"
}AccountType
The account object can be one of several attached to a Portfolio (which usually has an AccountUser which is used to authenticate access to the Portfolio's accounts). Typically a person has a single account attached to a portfolio and properties on the same account will appear on the same bill. Where separate bills are desired, multiple accounts are created and added to the same portfolio of accounts.
Fields
| Name | Description |
|---|---|
|
The type of account. |
|
List of active hardship agreements for the user when is_in_hardship 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 |
|
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 postcode of the billing address. |
|
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. |
|
Whether an account can be withdrawn. |
|
Whether an account can change their payment schedule. |
|
Whether on not the meter readings can be input via IVR. |
|
Data about whether or not an account can modify their payments. |
|
Whether the account is eligible for tariff renewal. |
|
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 complaints associated with an account. |
|
Consents linked to this account. |
|
Contribution agreements for account. |
|
The number of days around a move out a final meter reading can be given for. |
|
The datetime that the account was originally created. |
|
The current estimated supply start day on an account. |
|
Debt collection proceedings for account. |
|
The direct debit instructions of the account |
|
The document accessibility preference of the account. |
|
The earliest possible supply start day on an account. |
|
The electricity agreements belonging to the account. |
|
Whether the account is eligible to apply for Warm Home Discount as part of the Scottish Broader Group. |
|
The account events that were recorded for the account. |
|
Files attached to this account. |
|
The gas agreements belonging to the account. |
|
The green benefits achieved over the lifetime of an account. |
|
Whether or not the account has active collections proceedings. |
|
Whether or not the account has an active Dunning process. |
|
|
|
Whether or not an account is eligible for an electricity reading incentive. Deprecated The 'isEligibleForElectricityReadingIncentive' field is deprecated. |
|
Whether or not an account is eligible for a gas reading incentive. Deprecated The 'isEligibleForGasReadingIncentive' field is deprecated. |
|
Whether or not the account is a part of a migration for which we want to switch supplier without customer actions. |
|
True if there is an active Hardship Agreement for this account. False otherwise. |
|
The latest possible supply start day on an account. |
|
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. |
|
Notes for the account. |
|
A code that uniquely identifies the account. |
|
The operations team that the account belongs to. |
|
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 |
|
Results of the latest review of the account's payments. |
|
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. |
|
Expected balance in a year's time. |
|
Properties linked to the account now and in the future. |
|
|
|
Top up payment amount in pence that we recommend for an account. |
|
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. |
|
Whether the account's payment should be adjusted. |
|
The interest of an account in procuring smart meters. |
|
The reason why the account holder is not interested in having a smart meter installed. |
|
List of billing address lines. |
|
The current status of the account. |
|
Only relevant for Kraken instances that support daily tracker tariffs. Returns null if not applicable. |
|
Fetch transactions that have taken place on the account. |
|
Unique reference number from a 3rd party enrolment. |
|
|
|
Get details about warm home discount applications and records. |
Example
{
"id": "15564220",
"number": "health-director-in-arm-get",
"status": "PENDING",
"paymentSchedules": PaymentScheduleConnectionTypeConnection,
"users": AccountUserType,
"complaints": ComplaintConnectionTypeConnection,
"brand": "stop-sort-ten-seek-measure",
"balance": 47,
"overdueBalance": 59,
"urn": "standard-floor-write-stock-thousand",
"billingName": "reach-development-well-either-because",
"billingSubName": "music-sense-matter-today-appear",
"billingEmail": "send-major-play-concern-option",
"billingAddress": "dark-decade-pick-responsibility-cut",
"billingAddressLine1": "result-story-series-need-economy",
"billingAddressLine2": "once-safe-sign-within-degree",
"billingAddressLine3": "boy-leave-sound-nation-resource",
"billingAddressLine4": "kitchen-parent-recognize-forget-manager",
"billingAddressLine5": "stand-without-include-particular-lay",
"billingAddressPostcode": "he-interview-no-nearly-recently",
"billingCountryCode": "treatment-skill-tree-glass-six",
"billingDeliveryPointIdentifier": "54419821",
"splitBillingAddress": ["cell-fly-book-result-suddenly"],
"address": RichAddressType,
"portfolio": PortfolioType,
"ledgers": [LedgerType],
"metadata": [Metadata],
"canRequestRefund": true,
"requestRefundEligibility": RequestRefundEligibilityType,
"payments": AccountPaymentConnectionTypeConnection,
"repayments": AccountRepaymentConnectionTypeConnection,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"paymentForecast": [PaymentForecastType],
"paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
"referrals": ReferralConnectionTypeConnection,
"referralsCreated": 17,
"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": "identify-size-with-value-sort",
"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": "2000-02-04T18:35:24.474902+00:00",
"preferredLanguageForComms": "line-either-fund-information-issue",
"consents": ConsentType,
"reminders": AccountReminderConnectionTypeConnection,
"properties": [PropertyType],
"marketSupplyAgreements": AgreementConnection,
"canModifyPayments": CanModifyPaymentsType,
"allProperties": [PropertyType],
"property": PropertyType,
"electricityBalance": "mouth-most-along-statement-keep",
"gasBalance": "exist-hotel-perhaps-history-then"
}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 the user is opted in to life support call. |
|
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. |
|
The date the SMS opt-in was last changed. |
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"emailFormat": "TEXT",
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 462.29,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED",
"smsOptInLastChangeDate": "2005-10-29T02:27:38.145863+00:00",
"isOptedInToLifeSupportCall": 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": AccountUserConnectionTypeEdge,
"totalCount": 53,
"edgeCount": 32
}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": "truth-strategy-we-me-recent"
}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": "owner-get-find-follow-win",
"value": "mention-street-provide-reach-money",
"isSensitive": true
}AccountUserPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
|
The short name of the permission. |
Example
{
"permission": "air-official-television-wait-few"
}AccountUserRoleType
The role a user has in association with one account.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
The account role. |
|
Example
{
"id": "20043473",
"user": AccountUserType,
"account": AccountType,
"role": ADMIN
}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. |
|
This user's address. |
|
List of alternative phone numbers for the account user. |
|
List of businesses that the user has access to through their granted roles. |
|
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. |
|
List of hold music options. |
|
|
|
Whether this user is active. |
|
Designates whether this user is deceased. |
|
True if user is linked to an account with an active hardship agreement. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
A free text field to help identifying the customer (e.g. for a job title). |
|
|
|
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": "73730416",
"number": "ok-deal-situation-approach-speech",
"accounts": AccountInterface,
"givenName": "Brandon",
"familyName": "Huynh",
"email": "share-whatever-phone-that-detail",
"mobile": "conference-moment-information-blood-star",
"landline": "reflect-world-fire-onto-whatever",
"title": "cost-go-arrive-pattern-central",
"pronouns": "bill-including-successful-agency-group",
"isDeceased": true,
"liveSecretKey": "executive-decide-ago-probably-him",
"createdAt": "2016-04-10T17:00:19.861952+00:00",
"permissions": [AccountUserPermission],
"displayName": "school-father-appear-degree-shoulder",
"firstName": "beautiful-have-true-during-summer",
"lastName": "bad-maintain-need-at-very",
"fullName": "age-section-test-land-unit",
"preferredName": "address-shake-look-commercial-enough",
"isActive": true,
"address": RichAddressType,
"portfolioId": "44166542",
"portfolioIds": ["45755116"],
"portfolios": PortfolioConnectionTypeConnection,
"businesses": BusinessConnectionTypeConnection,
"specialCircumstances": SpecialCircumstancesType,
"preferences": AccountUserCommsPreferences,
"dateOfBirth": "1970-08-06",
"label": "you-home-in-budget-big",
"landlinePhoneNumber": "red-available-thousand-adult-act",
"alternativePhoneNumbers": ["present-spring-describe-else-door"],
"hasFamilyIssues": true,
"isInHardship": true,
"accountUserRoles": [AccountUserRoleType],
"portfolioUserRoles": [PortfolioUserRoleType],
"details": [AccountUserDetailType],
"consents": ConsentType,
"paymentMethods": PaymentInstructionConnectionTypeConnection
}AccountWithStatusInfoType
An object holding a subset of account.
Fields
| Name | Description |
|---|---|
|
The active payment method for the account. |
|
The current balance of the account. |
|
Data about whether or not an account can modify their payments. |
|
Retrieve all market supply agreements under this account. Note that when |
|
|
|
Properties linked to the account now and in the future. |
|
The current status of the account. |
Example
{
"number": "five-hand-alone-bring-cold",
"status": "PENDING",
"properties": [PropertyType],
"marketSupplyAgreements": AgreementConnection,
"canModifyPayments": CanModifyPaymentsType,
"balance": 70,
"activePaymentMethod": "economic-part-husband-smile-young"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
The reason the appointment was cancelled (category). |
|
The reason the appointment was cancelled (sub-category). |
|
|
|
|
|
|
|
Is the appointment switching from a traditional (not SMETS1) meter to a smart meter? |
|
|
|
The current status of the Siteworks application. |
|
|
|
|
|
The category of work the appointment has been booked for. |
Example
{
"id": "567c670c-67f0-497a-9526-6058354ea615",
"appointmentDate": "2024-04-05",
"timeSlotStart": "06:18:10.842176",
"timeSlotEnd": "08:33:09.634160",
"createdAt": "2017-12-19T13:17:49.052753+00:00",
"agent": "GENERIC_AGENT",
"workCategory": "EXCHANGE",
"status": "PENDING",
"date": "1996-12-22",
"isTradToSmartExchange": true,
"requestId": "56306540",
"agentReference": "center-music-anything-own-relate",
"cancellationCategory": "CANCELLED_BY_CUSTOMER",
"cancellationSubCategory": "billion-think-president-truth-life"
}Fields
| Name | Description |
|---|---|
|
Address line 1 of the associated property of the COS loss process. |
|
Address line 2 of the associated property of the COS loss process. |
|
Address line 3 of the associated property of the COS loss process. |
|
The fuel type of the meter associated with the COS loss process. |
|
The id of the 'Change Of Supplier Loss' process. |
|
A flag for whether or not the meter point has an open ET associated with it. |
|
Postcode of the associated property of the COS loss process. |
|
The date the supply ends. |
Example
{
"cosLossProcessId": 47475062,
"cosLossProcessFuelType": "ELECTRICITY",
"addressLine1": "painting-just-couple-learn-watch",
"addressLine2": "long-seven-care-guess-model",
"addressLine3": "strong-stay-amount-seven-certain",
"postcode": "agree-effort-enjoy-big-learn",
"supplyEndDate": "1991-07-03",
"hasOpenErroneousTransfer": true
}Fields
| Name | Description |
|---|---|
|
The time the data was reported. |
|
The latest reported activity of the heat pump. |
Example
{
"value": "PRE_HEATING",
"timestamp": "2011-12-30T20:21:22.559028+00:00"
}Fields
| Name | Description |
|---|---|
|
Username of the Actor. |
Example
{
"username": "trade-training-method-personal-one"
}Fields
| Name | Description |
|---|---|
|
The contract actualized. |
Example
{
"contract": Contract
}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
}AddCreditToSmartMeter
Add credit to a smart prepayment meter.
Fields
| Name | Description |
|---|---|
|
Top-up amount in pence to add to smart meter. |
Example
{
"amount": 40
}AddEvPublicChargingToken
Add an EV Public Charging token.
The possible errors that can be raised are:
- KT-CT-5817: External Account not found.
- KT-CT-5812: Token with this value already exists within this period.
- 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": Token
}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]
}AddNoteToInkConversation
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Deprecated field. Deprecated The 'clientMutationId' field is deprecated. |
|
The ink conversation note. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"note": InkNote,
"clientMutationId": "96431884"
}AddPortfolioReference
Add a reference to an existing portfolio.
The possible errors that can be raised are:
- KT-CT-9403: Received an invalid portfolioId.
- KT-CT-9410: Conflicting portfolio reference.
- KT-CT-9408: Invalid portfolio number format.
- KT-CT-9409: Invalid portfolio reference.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}AddProperty
Add a property to an account.
The possible errors that can be raised are:
- KT-CT-6623: Unauthorized.
- KT-CT-6629: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The property that was added to the account. |
Example
{
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}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
}AddStorylineToInkConversation
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The storyline that was added to the conversation. |
Example
{
"possibleErrors": [PossibleErrorType],
"storyline": InkStoryline
}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]
}Example
{
"mpan": "wish-prevent-stay-three-once",
"profileClass": "heavy-next-step-push-edge"
}Fields
| Name | Description |
|---|---|
|
Example
{
"mprn": "of-everything-education-wall-senior"
}AddressConnectionTypeConnection
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": AddressConnectionTypeEdge,
"totalCount": 23,
"edgeCount": 30
}AddressConnectionTypeEdge
A Relay edge containing a AddressConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AddressType,
"cursor": "wish-successful-explain-stock-almost"
}Fields
| Name | Description |
|---|---|
|
List of energised electricity meter points associated with the address. |
|
List of gas meter points associated with the address. |
Example
{
"electricityMeterPoints": [ElectricMeterTechnicalDetails],
"gasMeterPoints": [GasMeterTechnicalDetails]
}Fields
| Name | Description |
|---|---|
|
Country code of billing address. |
|
Line 1 of address. |
|
Line 2 of address. |
|
Line 3 of address. |
|
Line 4 of address. |
|
Line 5 of address. |
|
Postcode of billing address. |
Example
{
"line1": "school-knowledge-military-theory-suddenly",
"postcode": "answer-style-perhaps-win-score",
"countryCode": "consumer-magazine-without-benefit-image",
"line2": "hour-reach-huge-full-night",
"line3": "husband-recent-serve-stand-I",
"line4": "early-relate-commercial-up-director",
"line5": "question-cold-use-help-student"
}Fields
| Name | Description |
|---|---|
|
A unique ID per address using part of the address with spaces removed. |
|
The type of address (domestic, business or unknown). |
|
The complete and human-legible address in a single string. |
|
|
|
|
|
The ID of the Grid Supply Point Group that the address belongs to. |
|
|
|
The identifier for a property. The house number consists of the part of line 1 of the address that is not the street name. This includes sub-building names, building names, deliver point aliases and building numbers. For example, the house number for the property 'Flat 12 100 Example St' would be 'Flat 12 100'. |
|
Line 1 of the address. This is generally the house number and street name. |
|
Line 2 of the address. This is generally the area or village. |
|
Line 3 of the address. This is generally the area or village. |
|
Line 4 of the address. This is generally the city. |
|
Line 5 of the address. This is generally the county. |
|
|
|
The street name for a property. The street name consists of the part of line 1 of the address that is not the house number. For example, the house number for the property 'Flat 12 100 Example St' would be 'Example St'. |
Example
{
"addressKey": "within-low-possible-little-conference",
"addressType": "DOMESTIC",
"display": "argue-require-chance-air-record",
"gspGroupId": "86442549",
"line1": "five-central-only-explain-teacher",
"line2": "another-popular-able-eat-brother",
"line3": "less-itself-certain-hand-officer",
"line4": "strong-the-usually-prevent-discuss",
"line5": "join-also-individual-where-music",
"postcode": "effort-late-today-collection-save",
"houseNumber": "month-far-develop-or-him",
"streetName": "growth-play-together-during-they",
"hasPrepaidMeters": true,
"gasMeterPoints": [AddressAPIGasMeterPointType],
"electricityMeterPoints": [AddressAPIElectricityMeterPointType]
}AddressUPRNTypeConnection
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": AddressUPRNTypeEdge,
"totalCount": 81,
"edgeCount": 55
}AddressUPRNTypeEdge
A Relay edge containing a AddressUPRNType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": UniqueRELAddressType,
"cursor": "population-my-window-certain-head"
}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": "guess-few-she-huge-write",
"bucket": "peace-it-simply-wrong-view",
"fields": {"key": "value"},
"preSignedUrl": "good-student-effort-until-newspaper"
}AffiliateLinkType
Affiliate link for the organization.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Affiliate Organisation. |
|
|
|
Example
{
"id": "23893279",
"organisation": AffiliateOrganisationType,
"subdomain": "trip-relate-get-keep-policy",
"trainingStatus": "NOT_APPLICABLE",
"isBusiness": true,
"contactName": "writer-financial-maintain-left-paper",
"contactEmail": "off-affect-discussion-stay-my",
"landingUrl": "attention-dinner-white-author-role"
}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": "63196699",
"name": "different-father-face-crime-human",
"contactEmail": "indicate-environmental-teach-section-time",
"canRenewTariffs": true,
"defaultAccountType": "BUSINESS",
"allowAlternativePaymentMethods": true,
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"canUseIvrSupportApi": true,
"skipMeterPointAddressValidation": true,
"salesChannel": "DEFAULT_SUPPLY",
"salesChannelCode": "health-Republican-force-her-table",
"isFieldSalesOnlyProduct": true
}AffiliateSessionType
A tracked session for the affiliate link.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
Affiliate Link. |
|
|
|
Example
{
"id": "51311088",
"ipAddress": "nature-owner-simple-sea-white",
"userAgent": "mind-less-military-agent-account",
"queryParams": {"key": "value"},
"link": AffiliateLinkType
}Fields
| Name | Description |
|---|---|
|
The price multiplier/coefficient used to calculate the unit rate. |
|
The peak offset for the unit rate. |
|
The maximum value/cap for the unit rate. |
Example
{
"priceCap": 151.3,
"peakOffset": 649.35,
"gspCoefficient": 726.84
}Fields
| Name | Description |
|---|---|
|
Example
{
"id": 53899939,
"product": Product,
"monthlyStandingCharge": "1.0",
"netMonthlyStandingCharge": "1.0",
"standingChargeGrossRateInformation": [GrossRateInformation],
"unitRatePerKwh": "1.0",
"unitRateGrossRateInformation": [GrossRateInformation],
"unitRateInformation": UnitRateInformation,
"estimatedMonthlyBillInEuros": "1.0",
"estimatedAnnualConsumption": 3,
"validFrom": "2003-04-14T13:07:57.135159+00:00",
"validTo": "2019-05-29T02:16:58.706126+00:00",
"agreedAt": "2016-04-06T01:16:57.477433+00:00",
"isRevoked": true,
"isActive": true,
"isTerminated": true,
"isAffectedByPriceBrake": true,
"earliestCancellationDate": "2012-10-12",
"unitRateForecast": [UnitRateForecastType]
}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": 95,
"edgeCount": 19
}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": "interesting-indicate-lay-onto-against"
}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": 10483677,
"transactionType": "CREDIT",
"transactionAmount": 92,
"allocationAmount": 94,
"allocationReason": "success-edge-popular-girl-field"
}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": 79,
"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": "27636051",
"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
}AmendUnbilledElectricityReading
Amend unbilled electricity reading.
Fields
| Name | Description |
|---|---|
|
Example
{
"readingAmended": true
}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": "discussion-how-sense-worker-child",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "arm-by-this-better-feel",
"id": "62089940",
"typename": "soldier-law-foreign-walk-yard"
}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": 94,
"edgeCount": 77
}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": "bag-least-traditional-pretty-call"
}AnnualStatementType
Annual statements that are sent to the account. They summarize important information about usage and tariffs.
Example
{
"periodStartsAt": "1979-01-26T09:07:38.916416+00:00",
"periodEndsAt": "2000-12-15T08:28:08.063030+00:00",
"id": "45915219",
"pdfUrl": "maybe-hour-actually-religious-whatever"
}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. |
|
ID for the annulment billing document. |
|
URL to the PDF of the annulment. |
Example
{
"id": 98494253,
"annulledBillingDocumentId": 88974165,
"firstIssued": "1986-05-08T08:56:33.900752+00:00",
"pdfUrl": "figure-many-anyone-significant-impact"
}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": 100,
"edgeCount": 31
}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": "agreement-knowledge-head-step-brother"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Post town |
|
County |
|
|
|
|
|
|
|
|
|
|
|
The location accuracy level in meters |
|
|
|
|
|
A list of outcomes associated with the app session. |
|
|
|
|
|
|
|
|
|
|
|
Example
{
"startedAt": "1990-09-19T11:25:18.345010+00:00",
"stoppedAt": "1994-06-08T20:03:57.079014+00:00",
"addressLine1": "worry-hard-month-quickly-speech",
"addressLine2": "yourself-color-understand-hand-want",
"addressLine3": "staff-computer-energy-may-table",
"addressLine4": "under-trouble-wish-modern-film",
"addressLine5": "read-heavy-treatment-write-just",
"id": "a142b2f5-21c1-40e9-a21a-6b7d9f465a0c",
"link": AffiliateLinkType,
"isArchived": true,
"postcode": "charge-claim-those-various-eye",
"account": AccountType,
"locationAt": "2006-05-08T23:03:25.269272+00:00",
"locationHorizontalAccuracy": 57,
"locationLatitude": "1.0",
"locationLongitude": "1.0",
"salesMode": "DOOR",
"type": AppSessionType,
"createdAt": "1995-03-17T04:29:02.696018+00:00",
"updatedAt": "2021-04-09T09:25:38.269561+00:00",
"outcomes": [OutcomeType]
}Example
{
"value": "1.0",
"validFrom": "2006-02-03T08:24:35.650499+00:00",
"validTo": "2003-11-20T05:15:19.479941+00:00"
}ApplicableRateConnectionTypeConnection
Dovetailing rates applicable for an account / meter point combination over a given time period.
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": ApplicableRateConnectionTypeEdge,
"totalCount": 91,
"edgeCount": 34
}ApplicableRateConnectionTypeEdge
A Relay edge containing a ApplicableRateConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ApplicableRate,
"cursor": "before-read-region-security-director"
}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-3973: Repayment request is not in a state to be approved.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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": "join-level-animal-mind-voice",
"isPaused": true
}AssignDiscountCode
The possible errors that can be raised are:
- KT-GB-5911: We have assigned all electric blanket discount codes.
- KT-GB-5912: Account already has a discount code assigned.
- KT-GB-5913: An error occurred assigning a discount code.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
The assigned discount code. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"discountCode": "a-own-upon-necessary-watch"
}AssignInkBucket
The possible errors that can be raised are:
- KT-CT-7612: The Ink conversation was not found.
- KT-CT-7613: The Ink bucket was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The bucket that the conversation will be assigned to. |
|
Deprecated field. Deprecated The 'clientMutationId' field is deprecated. |
|
The conversation that will be assigned to the bucket. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation,
"bucket": InkBucket,
"clientMutationId": "13508668"
}Fields
| Name | Description |
|---|---|
|
The ID of the assigned user. |
|
The username of the assigned user. |
Example
{
"id": "15309004",
"username": "determine-about-apply-reduce-time"
}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": "price-ground-agree-nothing-whatever",
"activeFrom": "1975-06-30",
"activeTo": "1978-06-11"
}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-11216: Invalid extra_details for associated item type.
- 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": "type-visit-clearly-measure-my",
"itemId": "31472843"
}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": "71781621",
"filename": "bill-question-rather-receive-form",
"temporaryUrl": "soon-couple-body-degree-politics"
}Fields
| Name | Description |
|---|---|
|
The app session associated with this audio recording. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "d5835b85-a009-43dc-8a14-035b943584b9",
"appSession": AppSessionType,
"contentType": "center-learn-begin-right-central",
"duration": 264.42,
"fileSize": 64,
"startedAt": "1977-06-08T21:41:42.162888+00:00",
"stoppedAt": "1999-12-26T18:19:48.567426+00:00",
"s3Bucket": "region-their-bed-someone-enter",
"s3Key": "player-need-affect-on-without",
"createdAt": "1982-09-02T18:44:02.019896+00:00",
"updatedAt": "2025-10-02T12:10:48.836620+00:00"
}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": "49354270",
"redirectUri": "data-want-compare-far-surface",
"authorizationUri": "cost-for-itself-southern-half"
}Fields
| Name | Description |
|---|---|
|
The client ID of the application. |
|
The name of the application. |
Example
{
"name": "war-focus-contain-success-these",
"clientId": "11709886"
}AutoTopupConfigConnectionTypeConnection
GraphQL output type for querying nodes of auto top-up configs.
Using this class instead of AutoTopupConfigType directly allows for pagination.
Fields
| Name | Description |
|---|---|
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": AutoTopupConfigConnectionTypeEdge
}AutoTopupConfigConnectionTypeEdge
A Relay edge containing a AutoTopupConfigConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AutoTopupConfigType,
"cursor": "speak-could-strong-no-develop"
}AutoTopupConfigType
GraphQL output type for querying auto top-up configs.
Fields
| Name | Description |
|---|---|
|
The account number, e.g.: 'A-A1B2C3D4'. |
|
Alphanumber code identifying the device, e.g.: 'A1-BC-D2-00-01-23-EF-4G'. |
|
The date and time when the config became effective. |
|
The date and time when the config stopped being effective. |
|
|
|
Auto top-up amount in the lowest currency unit. i.e. USA cents / GBP pence / etc. |
Example
{
"id": "86722294",
"accountNumber": "A-A315C3D5",
"deviceId": "15632841",
"topupAmount": 3,
"effectiveFrom": "2020-12-11T17:03:21.940550+00:00",
"effectiveTo": "1981-05-08T08:30:11.540344+00:00"
}AutoTopupTriggerConnectionTypeConnection
GraphQL output type for querying nodes of auto top-up trigger events.
Using this class instead of AutoTopupTriggerType directly allows for pagination.
Fields
| Name | Description |
|---|---|
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": AutoTopupTriggerConnectionTypeEdge
}AutoTopupTriggerConnectionTypeEdge
A Relay edge containing a AutoTopupTriggerConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": AutoTopupTriggerType,
"cursor": "understand-always-environmental-field-involve"
}AutoTopupTriggerType
GraphQL output type for querying auto top-up trigger events.
Fields
| Name | Description |
|---|---|
|
Integer ID of the related AutoTopupConfig, e.g. '123'. |
|
DateTime when the trigger event was created, e.g. '2024-01-01T00:00:00+00:00'. |
|
Reason auto top-up trigger event failed, if any. |
|
|
|
Source of the auto top-up trigger event. |
|
Status of the auto top-up trigger event. |
|
DateTime when auto topup was triggered, e.g. '2024-01-01T00:00:00+00:00'. |
|
DateTime when the trigger event was last updated, e.g. '2024-01-01T00:00:00+00:00'. |
Example
{
"id": "13855915",
"autoTopupConfigId": "93870519",
"triggeredAt": "2008-01-08T11:58:45.636809+00:00",
"status": "INITIATED",
"source": "LOW_CREDIT_BALANCE",
"failureReason": "NO_IMPORT_METER",
"createdAt": "2001-10-06T14:37:51.113206+00:00",
"updatedAt": "1990-01-18T15:03:40.506741+00:00"
}Fields
| Name | Description |
|---|---|
|
Spin information for an electricity agreement. |
|
Spin information for a gas agreement. |
Example
{
"electricity": SupplyTypeSpecificSpinsType,
"gas": SupplyTypeSpecificSpinsType
}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-9219: Loyalty points user not found.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-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": 100,
"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": "once-own-entire-rule-place",
"id": "91775394",
"typename": "forward-force-necessary-usually-quickly",
"eventId": "91463759",
"params": BackendScreenParam
}BackendScreenParam
A key-value pair (both Strings) which is passed as a parameter to a screen.
Example
{
"key": "by-win-along-during-available",
"value": "available-thing-source-back-happy"
}Fields
| Name | Description |
|---|---|
|
Whether the balance forecast is available for the given account. |
|
The reason why the balance forecast is unavailable for the given account. |
Example
{
"isAvailable": true,
"unavailabilityReason": "NO_BILL_ISSUED_IN_LAST_60_DAYS"
}Fields
| Name | Description |
|---|---|
|
The reason why the balance forecast is unavailable for the given account. |
|
Whether the balance forecast is available for the given account. Deprecated The 'isAvailable' field is deprecated. |
Example
{
"isAvailable": true,
"availability": BalanceForecastAvailabilityType
}Fields
| Name | Description |
|---|---|
|
Indicates whether the provided bank details are valid. |
|
Provides additional information about validation result. |
Example
{
"areValid": true,
"message": "eye-mind-consider-hand-reveal"
}Fields
| Name | Description |
|---|---|
|
The maximum state of charge (soc) %. |
|
The minimum state of charge (soc) %. |
Example
{
"minimumSocPercentage": 97,
"maximumSocPercentage": 86
}Fields
| Name | Description |
|---|---|
|
The charging preferences of the battery (e.g. min / max state of charge %). |
|
The current status of the battery (e.g. connected, state of charge, power). |
|
Batteries. |
|
ID of the device in KrakenFlex. |
|
Device specific parameters. |
|
Battery integration provider (make). |
Example
{
"krakenflexDeviceId": "25290912",
"deviceType": "BATTERIES",
"provider": "BYD",
"params": BatteryParamsType,
"deviceStatus": DeviceStatusType,
"chargingPreferences": BatteryChargingPreferencesType
}Fields
| Name | Description |
|---|---|
|
ID of the battery variant. |
Example
{
"variantId": "43135728"
}Fields
| Name | Description |
|---|---|
|
Whether the battery is currently connected (online/offline). |
|
The current power being used to charge the battery, or discharging from the battery, in kW. A negative value indicates this power is being used to charge the battery; a positive value indicates power is being discharged from the battery. |
|
The current state of charge (SoC) of the battery (0-100). |
Example
{
"connectionStatus": "ONLINE",
"powerInKw": "1.0",
"stateOfCharge": "1.0"
}Fields
| Name | Description |
|---|---|
|
Usable capacity in kWh. |
|
Coupling type (AC/DC). |
|
Whether a variant is deprecated. |
|
Whether an integration/make is live, i.e. available. |
|
Max import/export power in kW. |
|
Model name of the battery. |
|
ID of the battery variant. |
Example
{
"variantId": "36733362",
"model": "participant-wind-security-feeling-think",
"couplingType": "AC",
"batteryCapacityInKwh": "1.0",
"maxPowerInKw": "1.0",
"isIntegrationLive": true,
"isDeprecated": true
}Fields
| Name | Description |
|---|---|
|
Make of the home battery. |
|
List of home battery models per make. |
Example
{
"make": "day-table-issue-become-notice",
"models": [BatteryVariantModelsType]
}BespokeRateConfigurationType
The BespokeRateConfiguration 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 schedules for the bespoke rate configuration. |
|
The type of the term. |
Example
{
"type": "meeting-music-best-begin-situation",
"displayName": "mean-attack-change-base-own",
"description": "paper-bar-paper-event-writer",
"identifier": "17966394",
"isVariable": true,
"schedules": [BespokeRateScheduleType]
}BespokeRateItemType
Item for the BespokeRateConfiguration term.
Fields
| Name | Description |
|---|---|
|
The price per unit for the bespoke rate item. |
|
The rate specification code for the bespoke rate item. |
|
The variant profile for the bespoke rate item. |
Example
{
"pricePerUnit": "1.0",
"rateSpecificationCode": "hit-keep-large-do-thank",
"variantProfile": VariantProfile
}BespokeRateScheduleType
Schedule for the BespokeRateConfiguration term.
Fields
| Name | Description |
|---|---|
|
The items for the bespoke rate schedule. |
|
The product code for the bespoke rate schedule. |
|
The external identifier of the supply point this schedule targets. |
|
The datetime the schedule of bespoke rates is valid from. |
|
The datetime the schedule of bespoke rates is valid to. |
Example
{
"items": [BespokeRateItemType],
"productCode": "catch-if-after-official-understand",
"validFrom": "2009-01-17T03:28:15.863460+00:00",
"validTo": "1981-07-21T13:18:52.111404+00:00",
"supplyPointIdentifier": "24280417"
}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. |
|
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. |
|
Supporting information about this charge (if any is available). |
|
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": "97001612",
"postedDate": "1992-04-25",
"createdAt": "2004-09-11T00:13:34.798859+00:00",
"amounts": TransactionAmountType,
"title": "over-next-her-since-situation",
"note": "key-language-travel-again-entire",
"reasonCode": "under-available-region-start-ground",
"consumption": Consumption,
"detail": ChargeDetail
}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": 98,
"edgeCount": 12
}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": "role-well-stock-real-in"
}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": "81185575",
"postedDate": "2007-08-05",
"createdAt": "2006-11-08T14:14:17.990524+00:00",
"amounts": TransactionAmountType,
"title": "military-Mr-society-very-training",
"note": "box-and-blood-weight-culture",
"reasonCode": "agree-bad-challenge-however-thing"
}BillDueDateType
Represents bill due dates 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": "local-article-our-or-such",
"displayName": "stand-federal-fear-work-present",
"description": "produce-outside-involve-run-scene",
"identifier": "83408633",
"isVariable": true
}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": "30383714",
"postedDate": "2020-07-16",
"createdAt": "1979-10-02T17:19:10.809905+00:00",
"amounts": TransactionAmountType,
"title": "poor-standard-near-road-guess",
"note": "voice-discussion-investment-blood-state",
"reasonCode": "minute-cold-month-popular-staff"
}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": "19538293",
"postedDate": "2024-08-07",
"createdAt": "1986-10-20T14:15:49.930882+00:00",
"amounts": TransactionAmountType,
"title": "state-thank-what-budget-never",
"note": "personal-common-address-while-learn",
"reasonCode": "money-change-result-road-say"
}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": 82,
"edgeCount": 91
}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": "of-appear-enjoy-involve-I"
}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": "out-thing-them-then-degree",
"version": 83,
"temporaryUrl": "drive-couple-manager-star-couple",
"temporaryUrlExpiresAt": "2022-06-29T23:20:48.913304+00:00",
"filename": "store-take-back-material-seven"
}BillToLatestSmartMeterSnapshot
Bill an account with a smart meter to the most recent midnight snapshot reading.
Fields
| Name | Description |
|---|---|
|
The date that has been billed up to. |
|
The balance after attempting to bill. |
Example
{
"billedToDate": "2005-05-29",
"currentBalance": "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": BillTransactionConnectionTypeEdge,
"totalCount": 93,
"edgeCount": 99
}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": "inside-field-manager-ask-responsibility"
}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": 36,
"edgeCount": 8
}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": "son-owner-house-decision-would"
}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": "leave-course-upon-important-standard",
"temporaryUrlExpiresAt": "2022-05-05T08:56:46.622594+00:00",
"filename": "arrive-think-song-new-degree"
}BillingDocumentIssuanceFrequencyType
Represents billing document issuance frequency to be applied during a contract.
Fields
| Name | Description |
|---|---|
|
The description of the term. |
|
The display name of the term. |
|
Billing frequency. |
|
The identifier of the term. |
|
Whether the term can be amended after creation. |
|
Multiplier applied to the frequency. |
|
Start day of the billing period. |
|
Start month of the billing period. |
|
The type of the term. |
Example
{
"type": "reality-fly-nature-give-culture",
"displayName": "actually-prepare-sport-enter-value",
"description": "address-himself-present-keep-recent",
"identifier": "83881086",
"isVariable": true,
"frequency": "candidate-within-truth-ready-would",
"periodStartDay": 3,
"periodStartMonth": 70,
"multiplier": 45
}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": "2011-09-13",
"expectedAmount": 41,
"remainingAmount": 41,
"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": 34,
"periodLength": "MONTHLY",
"periodLengthMultiplier": 58,
"isFixed": true,
"currentBillingPeriodStartDate": "2016-10-24",
"currentBillingPeriodEndDate": "2005-08-26",
"nextBillingDate": "1997-04-20"
}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": "81301827",
"repaymentIntervention": RepaymentInterventionType
}BulkUpdateSensorDisplayName
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- 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. |
|
A mapping of transaction ids for each sensor. |
Example
{
"possibleErrors": [PossibleErrorType],
"transactionIds": [SensorUpdateTransactionId]
}BulkUpdateZoneDisplayNames
The possible errors that can be raised are:
- KT-CT-4384: Error trying to update heat pump zone names.
- 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 transaction ID for each zone based on the zone code. |
Example
{
"possibleErrors": [PossibleErrorType],
"transactionIds": ZoneDisplayNameUpdates
}BusinessConnectionTypeConnection
Paginator of Businesses
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": BusinessConnectionTypeEdge,
"totalCount": 23,
"edgeCount": 15
}BusinessConnectionTypeEdge
A Relay edge containing a BusinessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": BusinessType,
"cursor": "writer-customer-result-vote-Mrs"
}Fields
| Name | Description |
|---|---|
|
The key of the business detail. |
|
The value of the business detail. |
Example
{
"key": "cover-particular-Democrat-whole-shake",
"value": "parent-future-conference-where-personal"
}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": "26615069",
"segment": SegmentType,
"startAt": "2024-02-27T23:29:10.537822+00:00",
"endAt": "2025-05-20T05:54:28.254559+00:00"
}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 sectors the business operates in. |
|
The segment this business is assigned to. |
Example
{
"id": "77137800",
"name": "specific-any-itself-unit-instead",
"number": "everyone-between-organization-young-newspaper",
"businessType": "SOLE_TRADER",
"sectors": None,
"details": [BusinessDetailType],
"billingAddress": RichAddressType,
"legalAddress": RichAddressType,
"linkedAccountNumber": "A-C19D1ADB",
"linkedAccountNumbers": "12849529",
"segmentName": "skin-draw-region-forget-that",
"paymentMethods": PaymentInstructionConnectionTypeConnection
}CFCampaignEventConnectionTypeConnection
Paginator of Customer Flexibility Campaign Events
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": CFCampaignEventConnectionTypeEdge,
"totalCount": 30,
"edgeCount": 83
}CFCampaignEventConnectionTypeEdge
A Relay edge containing a CFCampaignEventConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": CFCampaignEventType,
"cursor": "act-though-believe-four-sense"
}Fields
| Name | Description |
|---|---|
|
The unique code for the event. |
|
The end time of the campaign event. |
|
Indicates if the customer is participating in this specific event. |
|
The name of the event. |
|
The start time of the campaign event. |
Example
{
"name": "us-much-western-as-miss",
"code": "fish-media-major-ground-event",
"startAt": "1982-10-05T10:24:40.316437+00:00",
"endAt": "1988-05-15T05:15:49.668940+00:00",
"isEventParticipant": true
}CalculateDepositAmount
Calculates and records the security deposit amount. Returns the deposit amount and key.
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 |
|---|---|
|
Security deposit amount in pence. |
|
unique key of the record inserted in DepositAmount model. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"depositAmount": 69,
"key": "attorney-notice-rich-type-trip"
}Fields
| Name | Description |
|---|---|
|
The key of the call metadata item. |
|
The value of the call metadata item. |
Example
{
"key": "simple-point-enough-cause-consumer",
"value": "model-road-nearly-husband-where"
}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": 59,
"edgeCount": 84
}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": "sport-everybody-concern-age-kid"
}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": "72316755",
"name": "social-watch-anything-see-upon",
"isActive": true
}Example
{
"name": "than-box-get-later-year",
"slug": "option-dream-property-game-beat",
"expiryDate": "1995-01-26"
}Fields
| Name | Description |
|---|---|
|
Whether or not the account can amend payments. |
|
Whether or not the account can cancel payments. |
Example
{
"canAmendPayments": true,
"canCancelPayments": true
}CancelEnrolment
Mutation for an account to cancel enrolment to a supplier.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-GB-4136: Account cannot be withdrawn.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The number of the account whose enrolment was cancelled. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "A-C7A132AE"
}Fields
| Name | Description |
|---|---|
|
Whether or not the account's enrollment can be delayed. |
|
Whether or not the account's enrollment can be cancelled. |
|
Whether or not the account can skip the SSD payment. |
|
A best estimate of when the account should come on supply. |
|
The earliest possible Supply Start Date (SSD) for the account. |
|
The latest possible Supply Start Date (SSD) for the account. |
Example
{
"canBeDelayed": true,
"canBeWithdrawn": true,
"currentEstimatedSsd": "2013-08-10",
"earliestPossibleSsd": "1987-06-19",
"latestPossibleSsd": "1999-02-16",
"canSkipSsdPayment": true
}CancelOnSiteJobsAppointment
The possible errors that can be raised are:
- KT-CT-13001: Appointment does not exist.
- KT-CT-13017: Appointment cancellation not supported.
- KT-CT-13018: Unable to record cancellation_category/cancellation_sub_category.
- KT-CT-13019: Vendor not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The Appointment that was cancelled. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}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": "70864349",
"status": "REQUESTED"
}CancelSiteworksAppointment
Allows account users and organisations to cancel siteworks appointment.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"siteworksAppointment": ActiveAppointmentType
}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": "whom-nothing-thus-avoid-community",
"id": "35618673",
"typename": "decade-at-husband-sign-material",
"items": CardItemType
}Fields
| Name | Description |
|---|---|
|
The list of cards. |
|
Unique identifier of the object. |
|
The name of the object's type. |
Example
{
"id": "95412016",
"typename": "know-what-line-include-own",
"cards": CardComponentType
}CatalogProductType
Represents a product in the catalog.
Fields
| Name | Description |
|---|---|
|
Unique identifier of the component. |
|
Customer-facing description of the product. |
|
Customer-facing name of the product. |
|
Unique identifier of the product. |
|
Internal name of the product. |
|
The market the product is associated with. |
|
The type of product. |
|
Tags associated with this product for classification. |
Example
{
"identifier": "40970126",
"internalName": "station-area-military-join-use",
"customerName": "ability-doctor-light-energy-treatment",
"customerDescription": "at-democratic-sign-campaign-third",
"code": "nation-ten-write-top-rest",
"marketName": "animal-environmental-huge-imagine-along",
"sourceProductType": "SUPPLY",
"tags": [TagType]
}Fields
| Name | Description |
|---|---|
|
The description for each kind of Constantine. |
|
The name describing which kind of Constantine this Constantine is. |
|
The first time this Constantine was caught. |
|
How many prize entries catching this Constantine is worth. |
|
How rare this kind of Constantine is expressed as en enum associated to a percentage value. |
|
The slug for this kind of Constantine. |
|
The amount of times this Constantine has been caught. |
Example
{
"displayName": "month-factor-name-none-together",
"slug": "record-give-message-step-suggest",
"rarity": "Popular",
"description": "fight-unit-trip-visit-social",
"prizeEntries": 1,
"totalCaught": 17,
"firstCaught": "2021-06-08T02:49:55.456379+00:00"
}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. |
|
List of characteristic overrides. |
|
The type of the term. |
Example
{
"type": "himself-believe-than-end-just",
"displayName": "protect-leader-else-between-ago",
"description": "practice-mind-magazine-detail-personal",
"identifier": "22745634",
"isVariable": true,
"overrides": CharacteristicOverrideType
}CharacteristicOverrideType
An override for a specific characteristic.
Fields
| Name | Description |
|---|---|
|
The characteristic being overridden. |
|
The value to override the characteristic with. |
Example
{
"characteristic": CharacteristicType,
"overrideValue": CharacteristicValueType
}CharacteristicType
A characteristic associated with a product.
Fields
| Name | Description |
|---|---|
|
The code of the characteristic. |
|
The description of the characteristic. |
|
The name of the characteristic. |
|
The possible values for the characteristic (can be strings or integers). |
Example
{
"code": "threat-person-doctor-think-skill",
"name": "create-discover-dark-including-before",
"description": "letter-a-professor-federal-bit",
"values": CharacteristicValueType
}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. |
|
Supporting information about this charge (if any is available). |
|
Returns True if the transaction is linked with a statement. |
|
Unique identifier for the transaction. |
|
Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
|
Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
|
Deprecated. Deprecated The 'isCredit' field is deprecated. |
|
Whether the charge is for export electricity. |
|
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. |
|
Date when the transaction was posted to the account. |
|
Returns the reason. |
|
Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
|
Human-readable title describing the transaction. |
Example
{
"id": "74446052",
"postedDate": "1985-11-09",
"createdAt": "1973-10-07T13:41:19.019469+00:00",
"accountNumber": "A-7C96B9C9",
"amount": 42,
"amounts": TransactionAmountType,
"balanceCarriedForward": 33,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "something-kind-form-them-support",
"billingDocumentIdentifier": "41274205",
"statementId": "34370406",
"isReversed": true,
"hasStatement": true,
"note": "increase-rich-edge-else-two",
"reasonCode": "human-toward-certain-dream-consider",
"consumption": Consumption,
"detail": ChargeDetail
}Example
{
"id": "57104154",
"uid": "64858229",
"nameOnCard": "garden-able-during-road-sea"
}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": 67783312,
"model": "marriage-option-than-tell-pattern",
"powerInKw": "1.0",
"amperage": 20,
"isIntegrationLive": true,
"integrationStatus": "INTERNAL_TESTING"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"make": "series-identify-oil-dark-money",
"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": "among-option-audience-us-clearly",
"display": "budget-late-may-argue-end",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "entire-do-early-store-political"
}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": 45,
"edgeCount": 52
}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": "drive-loss-light-recognize-responsibility"
}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": "2024-06-22",
"periodEnd": "2012-12-07",
"charge": 94
}Fields
| Name | Description |
|---|---|
|
Example
{
"totalDonatedAmount": 48
}Fields
| Name | Description |
|---|---|
|
Is opted in to donate to charity. |
|
Amount to donate each month. |
Example
{
"monthlyAmount": "ONE",
"isOptedIn": true
}CheckBusinessCreditRisk
Returns a payment multiplier as a measure of risk. The payment multiplier is the number of advance payments we require from a business as security deposit. It is hardcoded except for Limited companies (=LTDs). For LTDs the payment multiplier depends on the credit score.
Fields
| Name | Description |
|---|---|
|
PaymentMultiplier to determine deposit amount. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentMultiplier": 70
}CheckDeviceConnection
Triggers an asynchronous request to check the connection of a device.
As this is an asynchronous operation, the mutation does not return the result of the request. Instead, the request reference is returned, which can be used to track the status of the request. If it's an organisation, the organisation will receive an update on the request via the agent services.
Fields
| Name | Description |
|---|---|
|
The reference of the request in Kraken. |
Example
{
"requestReference": "street-whatever-design-task-else"
}ClaimOctoplusReward
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
- KT-GB-9313: Not enough Octopoints.
- KT-GB-9314: Reward could not be processed.
- KT-GB-9315: Reward of this type unavailable.
- KT-GB-9316: Account is not Octoplus-enrolled.
- 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 ID of the claimed reward. |
Example
{
"possibleErrors": [PossibleErrorType],
"rewardId": "65053105"
}ClaimShoptopusVoucher
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
- KT-GB-9313: Not enough Octopoints.
- KT-GB-9314: Reward could not be processed.
- KT-GB-9315: Reward of this type unavailable.
- KT-GB-9316: Account is not Octoplus-enrolled.
- KT-GB-9319: This feature is not currently available.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The Reward Voucher code. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"code": "program-list-room-cut-bill"
}Fields
| Name | Description |
|---|---|
|
|
|
The current temperature of the room in Celsius. |
|
The target temperature of the room in Celsius. |
Example
{
"climateControlEnabled": true,
"targetClimateControlTemperature": "1.0",
"currentClimateControlTemperature": "1.0"
}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": "speech-miss-position-office-benefit",
"id": "70435384",
"typename": "program-significant-yet-stand-discussion",
"accessibilityHidden": true,
"accessibilityLabel": "cup-close-beautiful-people-bar"
}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
}CloseInkLiveChatConversation
The possible errors that can be raised are:
- KT-CT-7616: Not yet implemented.
- KT-CT-7643: The Live Chat was not found.
- KT-CT-7644: Ink Live Chat conversation not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The live chat conversation. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation
}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
}CollateralRequiredType
Represents required collaterals to be applied in a contract.
Fields
| Name | Description |
|---|---|
|
Amount set up as collateral as condition for account creation. |
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Type of interest policy of required collateral. |
|
Whether the term is variable. |
|
Reason for setting up required collateral. |
|
The type of the term. |
Example
{
"type": "way-laugh-item-smile-worry",
"displayName": "interesting-blood-thousand-purpose-about",
"description": "statement-identify-painting-if-there",
"identifier": "35768089",
"isVariable": true,
"amount": 34,
"reason": "water-teacher-white-guy-moment",
"interestPolicy": "drive-action-mouth-once-change"
}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-5713: Payment instruction is not usable.
- 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": "2013-11-20"
}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 active status of the collection process. |
|
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": "they-always-agreement-loss-summer",
"isPaused": true,
"isComplete": true,
"isActive": true,
"completionType": "area-him-pick-indeed-front",
"associatedItems": [CollectionProcessRecordAssociatedItemType],
"pausedDays": 10
}CollectionProcessPauseStatusRecord
Collection process pause record
Fields
| Name | Description |
|---|---|
|
Collection process pause name. |
|
Start of pause period. |
|
Reason for pausing. |
|
End of pause period. |
|
Reason for ending pause period. |
Example
{
"name": "marriage-test-operation-large-question",
"reason": "certainly-contain-girl-least-determine",
"pausedAt": "2007-10-26T06:03:11.474418+00:00",
"resumedAt": "1986-04-06T15:17:54.304952+00:00",
"resumedReason": "response-management-product-down-push"
}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": "every-continue-know-hope-significant",
"itemReference": "station-unit-ago-meet-election",
"occurredAt": "2016-03-04T17:52:52.357566+00:00",
"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": "67498935",
"billType": "STATEMENT",
"fromDate": "2020-09-18",
"toDate": "1998-02-17",
"temporaryUrl": "only-fall-base-century-lay",
"issuedDate": "1987-06-07",
"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
}CommissionMeter
The possible errors that can be raised are:
- KT-GB-4021: Invalid MPxN.
- KT-GB-4022: MPxN not recognised.
- KT-GB-4023: Error sending the request to commission the device.
- 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 id of the SMETS Commission Request in Kraken. |
Example
{
"possibleErrors": [PossibleErrorType],
"requestReference": "bag-activity-base-responsibility-help"
}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": "43727817",
"validFrom": "1995-09-01T18:10:44.661699+00:00",
"validTo": "2003-11-18T17:32:50.434463+00:00",
"agreedAt": "2016-12-29T09:07:37.975201+00:00",
"terminatedAt": "1977-06-03T12:56:47.528082+00:00",
"supplyPoint": SupplyPointType,
"product": SupplyProductType,
"isActive": true,
"agreedFrom": "1998-08-29T07:26:49.808175+00:00",
"agreedTo": "1990-10-11T11:58:48.372546+00:00",
"isRevoked": true
}ComplaintConnectionTypeConnection
Paginator of Complaint 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": ComplaintConnectionTypeEdge,
"totalCount": 93,
"edgeCount": 7
}ComplaintConnectionTypeEdge
A Relay edge containing a ComplaintConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ComplaintType,
"cursor": "town-old-tend-foot-amount"
}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": 51,
"edgeCount": 71
}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": "win-admit-process-blue-father"
}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": "short-realize-sometimes-painting-surface",
"actionTaken": "agent-game-stand-section-student",
"status": "down-wife-draw-somebody-fight",
"createdAt": "2004-02-06T13:59:22.668176+00:00",
"mobile": "up-in-kitchen-green-argue",
"email": "prove-enter-against-into-half",
"landline": "leave-month-ground-process-those",
"preferredCommunicationMethod": "perhaps-husband-moment-talk-author",
"summary": "although-possible-doctor-material-child"
}Fields
| Name | Description |
|---|---|
|
Complaint Assignee. |
|
Complaint contacts. |
|
Complaint creation date. |
|
|
|
Complaint resolution date. |
|
Complaint subtype. |
|
Complaint type. |
Example
{
"id": "64930284",
"contacts": ComplaintContactConnectionTypeConnection,
"type": "should-behavior-per-audience-than",
"subtype": "however-yourself-site-this-term",
"creationDate": "1978-04-05",
"resolutionDate": "2015-09-04",
"assigneeId": "98083224"
}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
}CompleteEnrollment
Mutation to complete enrollment for a property missing meter point details.
This mutation is used to provide missing meter point information (MPAN/MPRN) for accounts that couldn't be fully registered during the initial sign-up process.
This mutation can only be used for properties with at most one electricity meter point and one gas meter point.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-6622: Unauthorized.
- KT-GB-4138: Unable to complete enrollment for account.
- KT-GB-4139: Unable to complete enrollment.
- KT-GB-4140: MPAN number is required for enrollment.
- KT-GB-4141: MPRN number is required for enrollment.
- KT-GB-4142: Prepay meter could not be enrolled.
- KT-GB-4143: MPAN not required to complete enrollment.
- KT-GB-4144: MPRN not required to complete enrollment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The number of the account whose enrollment was completed. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "A-0236178D"
}CompleteSelectVehicleOrChargePointForSmartFlexOnboarding
Complete the select vehicle or charge point 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
}CompleteStandalonePayment
Completes an initiated standalone payment.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-3974: Unauthorized.
- KT-CT-3975: Unable to complete standalone payment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The completed standalone payment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": CompleteStandalonePaymentOutput
}CompleteStandalonePaymentOutput
Result of the complete standalone payment operation.
Fields
| Name | Description |
|---|---|
|
The status of the standalone payment. |
Example
{
"status": "CLEARED"
}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
}CompleteUserInputRequiredForSmartFlexOnboarding
Complete the UserInputRequired 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": "minute-me-animal-religious-among",
"id": "95587251",
"typename": "as-these-law-land-role",
"name": "common-thought-class-option-vote",
"refreshFrequency": 90,
"screenData": "partner-among-house-trip-himself",
"items": ItemType
}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
}ConfirmSiteworksAppointmentSlot
The possible errors that can be raised are:
- KT-GB-4219: Property does not exist.
- KT-GB-4220: No account currently active at property.
- KT-GB-4221: Could not confirm duplicate property.
- KT-GB-4228: Cannot currently book appointments for legacy prepay meters.
- KT-GB-4229: A smart meter exchange appointment for this date already exists.
- KT-GB-4210: Bookings not supported for agent appointed at property.
- KT-GB-4211: Timeslot no longer available.
- KT-GB-4212: Missing or invalid data for account or property.
- KT-GB-4234: Booking service currently unavailable.
- KT-GB-4217: Unknown agent carrying out the appointment.
- KT-GB-4240: Job type entry is not enabled.
- KT-GB-4239: Job type value is not supported by the agent appointed at property.
- 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],
"siteworksAppointment": ActiveAppointmentType
}Fields
| Name | Description |
|---|---|
|
The code of the consent type. |
|
The value to update the consent to. |
Example
{
"code": "individual-nature-effort-arm-morning",
"value": "guess-a-return-word-decade"
}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": "term-because-avoid-mother-seem",
"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": "design-radio-occur-compare-painting",
"description": "a-century-media-perform-it",
"name": "hair-consider-important-build-nothing",
"defaultValue": "ACCEPTED"
}Fields
| Name | Description |
|---|---|
|
The description for each kind of Constantine. |
|
The name describing which kind of Constantine this Constantine is. |
|
If the user has caught this Constantine in the cache period. |
|
How many prize entries catching this Constantine is worth. |
|
How rare this kind of Constantine is expressed as en enum associated to a percentage value. |
|
The slug for this kind of Constantine. |
|
Unique Identifier for the Constantine. |
Example
{
"displayName": "adult-low-despite-site-control",
"slug": "everything-build-phone-her-least",
"rarity": "Popular",
"description": "research-whether-their-order-education",
"prizeEntries": 96,
"spawnId": "27706561",
"isCaught": true
}Fields
| Name | Description |
|---|---|
|
The datetime of when the list of Constantines will expire. |
|
A List of Constantines. |
Example
{
"constantines": [ConstantineSpawn],
"cacheExpiry": "1996-06-23T11:36:39.825090+00:00"
}Fields
| Name | Description |
|---|---|
|
The description for each kind of Constantine. |
|
The name describing which kind of Constantine this Constantine is. |
|
How many prize entries catching this Constantine is worth. |
|
How rare this kind of Constantine is expressed as en enum associated to a percentage value. |
|
The slug for this kind of Constantine. |
Example
{
"displayName": "order-especially-little-year-better",
"slug": "send-two-suddenly-hard-raise",
"rarity": "Popular",
"description": "bring-well-example-reason-service",
"prizeEntries": 14
}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": 21,
"edgeCount": 19
}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": "age-decide-reason-arm-develop"
}Fields
| Name | Description |
|---|---|
|
End date of the consumption period. |
|
Amount of energy or resource consumed. |
|
Start date of the consumption period. |
|
Supply charge amount in minor currency units. |
|
|
|
Cost for the consumption usage in minor currency units. |
Example
{
"startDate": "1990-03-22",
"endDate": "1996-04-25",
"quantity": "1.0",
"unit": "kWh",
"usageCost": 69,
"supplyCharge": 39
}Fields
| Name | Description |
|---|---|
|
Unique identifier of the source of the usage. |
|
Human readable name of what the usage is for. |
|
Monthly usage in pence. First month is January. |
Example
{
"sourceName": "of-no-behind-hospital-television",
"sourceId": "83892695",
"usage": [81]
}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": 74,
"edgeCount": 49
}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": "man-state-lead-nature-soldier"
}Fields
| Name | Description |
|---|---|
|
Charges grouped per displayed period. |
|
Name of the market the charges are for. |
Example
{
"marketName": "total-its-herself-total-three",
"charges": ChargesBreakdownConnectionTypeConnection
}ConsumptionConnection
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": ConsumptionEdge,
"totalCount": 97,
"edgeCount": 51
}Example
{
"day": "1.0",
"night": "1.0"
}ConsumptionEdge
A Relay edge containing a Consumption and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ConsumptionType,
"cursor": "process-create-care-call-cultural"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Example
{
"elecAnnualConsumptionStandard": 49,
"elecAnnualConsumptionDay": 17,
"elecAnnualConsumptionNight": 91,
"gasAnnualConsumption": 76
}Fields
| Name | Description |
|---|---|
|
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 |
Example
{
"low": ConsumptionEstimate,
"medium": ConsumptionEstimate,
"high": ConsumptionEstimate
}ConsumptionType
Energy consumption between two points in time.
Example
{
"value": "1.0",
"startAt": "2006-02-24T13:25:42.189779+00:00",
"endAt": "2021-07-03T13:36:00.381449+00:00"
}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": "19598701",
"title": "clear-require-expect-one-together",
"party": ContractParty,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "1997-09-24T10:25:26.456021+00:00",
"validTo": "1972-03-06T05:53:53.412196+00:00",
"signedAt": "1971-01-16T04:46:50.383678+00:00",
"cancelledAt": "2006-09-09T01:22:56.359721+00:00",
"lifecycle": ContractVersion,
"terms": TermInterface
}ContractCreationContext
Represents a version of a contract with its effective date.
Fields
| Name | Description |
|---|---|
|
The confirmed validity period for the associated contract. |
|
The requested validity period for the associated contract. |
Example
{
"requestedValidityPeriod": ValidityPeriod,
"confirmedValidityPeriod": ValidityPeriod
}ContractCreationJourneyType
Represents a Contract Creation Journey.
Fields
| Name | Description |
|---|---|
|
The context data for the contract creation journey. |
|
The details of the associated contract. |
|
The type of the contract journey. |
|
The number of the contract journey. |
|
The order reference associated with the contract journey. |
|
The date and time when the contract journey was requested. |
|
The status of the contract journey. |
Example
{
"number": "financial-away-subject-series-same",
"status": "IN_PROGRESS",
"contractDetails": ContractDetails,
"journeyType": "CONTRACT_CREATION",
"requestedAt": "2018-11-05T02:27:50.657433+00:00",
"orderReference": "sometimes-fish-daughter-traditional-bag",
"context": ContractCreationContext
}ContractDetails
Details of a contract excluding terms.
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. |
|
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": "62961439",
"title": "artist-middle-available-say-science",
"party": ContractParty,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "1973-06-21T05:58:50.017832+00:00",
"validTo": "1986-11-30T01:34:09.513717+00:00",
"signedAt": "1999-06-10T00:07:52.649057+00:00",
"cancelledAt": "1978-01-02T08:33:14.891005+00:00",
"lifecycle": ContractVersion
}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": "ability-expect-still-can-answer",
"displayName": "save-almost-guy-name-official",
"description": "go-teach-lot-floor-sit",
"identifier": "42299694",
"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": "total-civil-state-lot-serve"
}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": 21,
"effectiveFrom": "2017-02-15T19:17:21.347752+00:00"
}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 periods for the contracted volume configuration. |
|
The type of the term. |
Example
{
"type": "push-feeling-fine-relate-a",
"displayName": "first-detail-will-gun-agency",
"description": "actually-drop-interesting-door-daughter",
"identifier": "39824739",
"isVariable": true,
"periods": [ContractedVolumePeriodType]
}Fields
| Name | Description |
|---|---|
|
The market name the contracted volume applies to. |
|
The unit for the commodity provided by the contracted volume. |
|
The datetime the period the contracted volume is valid from. |
|
The datetime the period the contracted volume is valid to. |
|
The decimal value of the quantity provided by the contracted volume. |
Example
{
"value": "1.0",
"unit": "ball-large-school-public-nice",
"marketName": "not-goal-deal-boy-story",
"validFrom": "1989-04-30T07:52:53.421854+00:00",
"validTo": "1995-07-30T05:33:11.442831+00:00"
}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": "44905442",
"contributionScheme": ContributionSchemeType,
"interval": "MONTHLY",
"activeFrom": "2011-08-27T06:25:04.973634+00:00",
"activeTo": "1979-06-07T12:22:48.923186+00:00",
"amount": 68,
"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": 52,
"edgeCount": 60
}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": "subject-type-bit-turn-there"
}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": "62531438",
"agreement": ContributionAgreementType,
"fulfilledAt": "2018-04-18T15:09:59.060234+00:00",
"periodFrom": "1983-07-08T08:47:20.643543+00:00",
"periodTo": "2014-11-04T02:48:59.684641+00:00"
}ContributionSchemeType
A single Contribution Scheme.
Fields
| Name | Description |
|---|---|
|
Is this scheme currently accepting contributions? |
|
|
|
|
|
|
|
Are contributions to this scheme taxable? |
Example
{
"id": "78397508",
"code": "surface-protect-population-see-technology",
"displayName": "discover-fact-major-oil-four",
"taxable": true,
"acceptingContributions": true
}Fields
| Name | Description |
|---|---|
|
The EUID of the controller. |
Example
{
"euid": "77116002"
}Fields
| Name | Description |
|---|---|
|
Controller configuration. |
|
Controller configuration. |
|
List of zones with their configuration and schedules. |
Example
{
"controller": ControllerConfiguration,
"zones": [ZoneInformation],
"heatPump": HeatPumpConfiguration
}Fields
| Name | Description |
|---|---|
|
The controller attached to the account. |
|
The model of the heat pump. |
|
The location at which the device exists. |
|
When the controller was provisioned (at this location for this account). |
Example
{
"controller": Controller,
"heatPumpModel": "moment-someone-fine-herself-within",
"location": Location,
"provisionedAt": "1980-01-24T20:55:46.787894+00:00"
}Fields
| Name | Description |
|---|---|
|
8 character password used to access the access point mode webpage. |
|
Whether or not the controller is currently connected. |
|
Controller firmware options for ESP and EFR chips. |
|
Timezone the controller is in. |
|
When the controller was last reset. |
|
Current state of the controller. |
Example
{
"firmwareConfiguration": FirmwareConfiguration,
"state": "NORMAL_MODE",
"accessPointPassword": "sea-middle-century-instead-fact",
"heatPumpTimezone": "most-consumer-her-last-I",
"connected": true,
"lastReset": "2014-03-01T06:14:58.496860+00:00"
}Fields
| Name | Description |
|---|---|
|
The status and telemetry information of a sensor. |
|
The status and telemetry information of a zone. |
Example
{
"sensors": [SensorStatus],
"zones": [ZoneStatus]
}Example
{
"latitude": 728.45,
"longitude": 621.42
}CoreSiteworksAppointmentType
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": "6635773e-ff8e-4944-8497-b77471bf6b96",
"jobType": "theory-forward-pattern-organization-production",
"appointmentDate": "1979-03-30",
"timeSlotStart": "07:12:40.110632",
"timeSlotEnd": "18:30:25.282298",
"createdAt": "2009-09-19T20:41:41.965579+00:00",
"status": "PENDING",
"externalReference": "lead-summer-stay-leave-not"
}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": 10,
"edgeCount": 43
}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": "firm-thus-either-surface-thing"
}CoreSiteworksRequestType
A Siteworks Request
Fields
| Name | Description |
|---|---|
|
List of appointments linked to this request. |
|
|
|
|
|
|
|
List of supply points on request. |
|
|
|
Example
{
"id": "214e64e0-61c6-463f-b3ef-e2bb706cd060",
"status": "leg-beyond-could-adult-she",
"reason": "growth-within-college-statement-each",
"createdAt": "1994-06-18T09:11:37.871277+00:00",
"lastStatusUpdateAt": "2004-07-19T17:43:43.148665+00:00",
"appointments": [CoreSiteworksAppointmentType],
"marketSupplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Consumption in kWh. |
|
Cost in pence (excl. tax). |
|
Cost in pence (incl. tax). |
Example
{
"costOfChargeId": "94666358",
"krakenflexDeviceId": "66748828",
"reportDate": "2023-03-16",
"isSmartCharge": true,
"totalConsumption": 194.14,
"totalCostExclTax": 914.94,
"totalCostInclTax": 360.67
}CostOfUsageConnectionTypeConnection
Dovetailing usage and cost for an account / meter combination over a given time period.
Fields
| Name | Description |
|---|---|
|
Overall cost of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Overall usage of nodes in the edge. |
Example
{
"pageInfo": PageInfo,
"edges": CostOfUsageConnectionTypeEdge,
"cost": 86,
"usageKwh": "1.0"
}CostOfUsageConnectionTypeEdge
A Relay edge containing a CostOfUsageConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": IntervalCostOfUsageType,
"cursor": "idea-will-few-community-soldier"
}Fields
| Name | Description |
|---|---|
|
Whether cost of usage can be displayed for a user. |
|
Cost of usage for given period. |
|
Energy product direction, e.g. IMPORT or EXPORT. |
Example
{
"costEnabled": true,
"direction": "let-prepare-paper-change-wish",
"details": CostOfUsageConnectionTypeConnection
}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
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"postRequest": UploadPostRequest,
"clientMutationId": "30000411"
}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-4196: Unpin at date provided is in the past.
- KT-CT-4195: Unpin at date provided for an unpinned note.
- 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
}CreateAcquisitionQuoteRequestForProducts
The possible errors that can be raised are:
- KT-GB-4625: Unable to create quote request.
- 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. |
|
Returns a quote request for the requested product codes. Does not persist the quote. |
Example
{
"possibleErrors": [PossibleErrorType],
"quoteRequest": QuoteRequestBase
}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
}CreateAutoTopupConfig
Create a new auto topup config for SPAYG meter.
Fields
| Name | Description |
|---|---|
|
The created auto top-up config. |
Example
{
"autoTopupConfig": AutoTopupConfigType
}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": "43618375"
}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
}CreateContractOutput
Output type for creating a contract.
Fields
| Name | Description |
|---|---|
|
Unique identifier for the created contract. |
Example
{
"identifier": "83077868"
}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": "2023-06-20T07:42:12.652359+00:00"
}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": 64
}CreateDirectDebitInstruction
The possible errors that can be raised are:
- KT-CT-3940: Invalid data.
- KT-CT-3923: 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],
"directDebitInstruction": DirectDebitInstructionType
}CreateElectricJuiceAgreement
Create an Electric Juice agreement for an account.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"agreement": Agreement
}CreateElectricJuiceCharge
Create an Electric Juice charge and associated line items.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"accountCharge": AccountChargeType
}CreateElectricJuiceChargeCard
Create a new Electric Juice charge card for an account.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"chargeCard": ChargeCardType
}CreateElectricJuiceCredit
Add a credit to an Electric Juice Network ledger.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"accountCredit": AccountCreditType
}CreateEvPublicChargingAgreement
Create an EV Public Charging agreement.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-5811: Active agreement 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. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreement": Agreement
}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-11810: Caller is blocked.
- 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
}CreateInkInboundMessage
Register an Ink inbound message.
The possible errors that can be raised are:
- KT-CT-7622: Attachment bucket is invalid.
- KT-CT-7623: Attachment path is invalid.
- KT-CT-7621: Attachment not found.
- KT-CT-7618: Unable to process message.
- KT-CT-7625: Invalid email address.
- KT-CT-7630: Message with this message ID has already been processed.
- KT-CT-7632: The text content of the Ink Inbound Generic Message is too long.
- KT-CT-7620: Channel not supported.
- KT-CT-7627: The 'email' object is missing from the payload.
- KT-CT-7628: The 'generic' object is missing from the payload.
- KT-CT-7629: The 'post' object is missing from the payload.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Deprecated field. Deprecated The 'clientMutationId' field is deprecated. |
|
The Ink message that was created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": InkMessage,
"clientMutationId": "72483394"
}CreateInkLiveChatMessage
The possible errors that can be raised are:
- KT-CT-7616: Not yet implemented.
- KT-CT-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7642: No account user was found for the given fromHandle.
- KT-CT-7641: Live Chat message with this message ID has already been processed.
- KT-CT-7645: The user is not authorized to access this Live Chat.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The live chat conversation. |
|
The ID of the Ink Live Chat message that was created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation,
"messageRelayId": "68236152"
}CreateLead
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8930: Unable to parse address.
- KT-CT-8928: The funnel is not active and cannot be used to create this entity.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-9017: Consent type not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The unique number of the lead. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"leadNumber": "quality-determine-agree-trial-paper"
}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
}Fields
| Name | Description |
|---|---|
|
Deprecated The 'id' field is deprecated. |
|
Example
{
"readingErrors": [SerializerFieldErrorsType],
"id": "71584012"
}CreateMfaDevice
Create a multi-factor authentication (MFA) device for user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1151: MFA device not found.
- KT-CT-1153: Unable to create MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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": "rise-condition-team-international-future",
"devicePhone": "customer-miss-certain-question-agree",
"totpSecret": "area-from-certainly-decide-question"
}CreateNewAgreementFromProductSwitchProcess
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4924: Unauthorized.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-1510: Product switch process not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The new agreement created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}CreateOctoplusRewardContactLink
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
- KT-GB-9319: This feature is not currently available.
- KT-GB-9323: Could not create contact link.
- 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 URL of the customer contact form link. |
Example
{
"possibleErrors": [PossibleErrorType],
"url": "art-federal-soon-source-party"
}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": CreateOfferGroupType
}Fields
| Name | Description |
|---|---|
|
Identifier of the Offer Group. |
|
One or more Offers contained in the Offer Group. |
Example
{
"identifier": "46472919",
"offers": [OfferType]
}CreateOnSiteJobsAppointment
The possible errors that can be raised are:
- KT-CT-13030: Booking session not found.
- KT-CT-13025: Booking session has expired.
- KT-CT-13033: Slot not found.
- KT-CT-13028: Agent not found.
- KT-CT-13019: Vendor not found.
- KT-CT-13034: Appointment already exists for this request.
- KT-CT-13035: Request is inactive.
- KT-CT-13032: Request does not exist.
- KT-CT-13036: Booking service currently unavailable.
- KT-CT-13037: Appointment reference not provided by booking service.
- KT-CT-13031: Timeslot is no longer available.
- KT-CT-13027: Booking system error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created On-Site Jobs appointment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}CreateOnSiteJobsAppointmentWithoutBooking
The possible errors that can be raised are:
- KT-CT-13032: Request does not exist.
- KT-CT-13002: Supply point not found.
- KT-CT-13035: Request is inactive.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13034: Appointment already exists for this request.
- KT-CT-13021: Invalid job type.
- KT-CT-13018: Unable to record cancellation_category/cancellation_sub_category.
- KT-CT-13039: Cancellation fields require CANCELLED status.
- KT-CT-13027: Booking system error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created Appointment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}CreateOnSiteJobsRequest
The possible errors that can be raised are:
- KT-CT-13002: Supply point not found.
- KT-CT-13003: Supply points must belong to the same account.
- KT-CT-13004: No account found for the given supply points.
- KT-CT-13005: Supply points must belong to the same property.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-13028: Agent not found.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13007: At least one of the request checks failed.
- KT-CT-13008: At least one of the request checks has warnings.
- KT-CT-13009: On site jobs Request already exists.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13011: Appointment with the given external reference and agent already exists for a different request.
- KT-CT-13012: Viewer is not allowed to create a request.
- KT-CT-13013: Reporter post init error.
- KT-CT-13014: Request reason is not supported.
- KT-CT-13015: Request sub_reason is not supported.
- KT-CT-13041: User is not allowed to override request/appointment checks.
- KT-CT-13042: Multiple supply points not supported by this booking adapter.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13047: Multiple supply points found.
- KT-CT-13048: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_ids.
- KT-CT-13049: Neither supply_point_identifier_to_market_name_mapping nor supply_point_internal_ids provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created request. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"onSiteJobsRequest": OnSiteJobsRequestType
}CreateOpportunityAndLead
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-8930: Unable to parse address.
- KT-CT-8907: Lead not found.
- KT-CT-8901: Unable to create lead.
- KT-CT-8902: Unable to create lead.
- KT-CT-4121: Invalid phone number.
- KT-CT-9017: Consent type not found.
- 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": "health-industry-former-city-husband",
"dateOfCreation": "2016-02-10T07:36:25.528082+00:00",
"stage": "clear-away-save-range-article",
"funnelCode": "raise-audience-effect-start-fund"
}Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the operation was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"result": "their-up-the-would-while"
}CreateOpportunityForLead
The possible errors that can be raised are:
- KT-CT-8912: Funnel not found.
- KT-CT-8919: Funnel initial stage not set.
- KT-CT-8907: Lead not found.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-8924: Unable to create opportunity.
- KT-CT-8925: Unable to create opportunity.
- KT-CT-8926: Unable to create opportunity.
- KT-CT-8928: The funnel is not active and cannot be used to create this entity.
- KT-CT-8930: Unable to parse address.
- KT-CT-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 unique number of the opportunity. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "chance-health-though-detail-born",
"dateOfCreation": "1973-08-01T22:01:08.885515+00:00"
}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
}CreateOrUpdateSiteworksAppointment
Create a new job or update the status of an existing one.
The possible errors that can be raised are:
- KT-CT-1112: 'Authorization' header not provided.
- KT-CT-4231: Unauthorized.
- KT-GB-4230: Invalid data.
- KT-GB-4224: Error processing siteworks appointment.
- 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],
"result": CreateOrUpdateSiteworksAppointmentOutput
}Example
{
"appointmentCreated": true,
"appointmentUpdated": true
}CreatePaymentSchedule
Mutation for creating an Payment Schedule instance using the authenticated user.
The possible errors that can be raised are:
- KT-GB-3917: Unable to create 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. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentSchedule": PaymentScheduleType
}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": 93
}CreateProductOutput
Output type for creating a product.
Fields
| Name | Description |
|---|---|
|
The created product. |
Example
{
"product": SupplyProductType
}CreateProductRates
Create one or more product rates for a product.
The possible errors that can be raised are:
- KT-GB-9514: No available product found.
- KT-GB-9518: Invalid input data for product rate(s).
- KT-GB-9519: Unable to create product rate(s).
- 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. |
|
Successfully created rate(s) for the specified product. |
Example
{
"possibleErrors": [PossibleErrorType],
"productRates": [ProductRateType]
}CreateProvisioningClaim
Create an AWS provisioning claim certificate.
Fields
| Name | Description |
|---|---|
|
The temporary provisioning certification. |
Example
{
"tempProvisioningClaimCert": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}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
}Fields
| Name | Description |
|---|---|
|
|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"errors": [SerializerFieldErrorsType],
"quote": QuoteType
}CreateQuoteRequestForProducts
The possible errors that can be raised are:
- KT-GB-4624: 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. |
|
Returns a quote request for the requested product codes. Does not persist the quote. |
Example
{
"possibleErrors": [PossibleErrorType],
"quoteRequest": QuoteRequestBase
}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": 96
}CreateRefundRequest
Mutation for creating an refund request for an account.
The possible errors that can be raised are:
- KT-GB-4127: Unable to send refund request confirmation email.
- KT-GB-4121: Unable to process refund 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. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"refundRequest": RefundRequestType
}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
}Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"quoteRequest": QuoteRequest
}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 billing_period_length set. |
|
For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY. |
|
Month to start billing from if billing_period_length 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. |
|
|
|
This must be a string-ified version of the JSON representation of RichAddressInput type. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"portfolioNumber": "P-1F95DE51",
"givenName": "Wayne",
"familyName": "Macias",
"billingName": "let-concern-police-far-skin",
"email": "minute-sometimes-finally-partner-region",
"mobile": "new-recently-heart-hour-base",
"landline": "civil-else-room-bit-draw",
"brand": "bar-wrong-several-opportunity-light",
"dateOfBirth": "1989-09-14",
"billingAddressLine1": "short-bad-establish-fine-age",
"billingAddressLine2": "music-process-investment-style-least",
"billingAddressLine3": "experience-forget-usually-I-manage",
"billingAddressLine4": "red-specific-program-hour-dream",
"billingAddressLine5": "exactly-some-see-anyone-matter",
"billingPostcode": "manage-tend-offer-several-across",
"billingRichAddress": "quality-left-and-book-gun",
"billingPeriodLength": "station-reason-its-low-election",
"billingPeriodMultiplier": 27,
"billingPeriodDay": 20,
"billingPeriodMonth": 44,
"isBusinessAccount": true,
"companyName": "south-world-include-however-choose",
"companyNumber": "whole-idea-you-western-understand",
"businessType": "concern-than-receive-gas-read",
"password": "rich-nature-stop-trip-board",
"passwordUpdateToken": "statement-relate-contain-get-production",
"urn": "good-world-and-specific-case",
"errors": [ErrorType],
"account": AccountInterface,
"clientMutationId": "95869637"
}Fields
| Name | Description |
|---|---|
|
Example
{
"eventCreated": true
}CreateSiteworksEventExternal
Makes it possible to create Sitework events by external third parties.
This mutation uses the external JWT authorization method.
The possible errors that can be raised are:
- KT-GB-4222: The provided 'siteworksRequestId' is not a valid UUID.
- KT-GB-4223: Siteworks request not found. Check the provided 'siteworksRequestId' is correct.
- 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],
"eventCreated": true
}CreateSnap
The possible errors that can be raised are:
- KT-GB-9316: Account is not Octoplus-enrolled.
- KT-GB-9325: Invalid constantine slug.
- KT-GB-9326: Invalid spawn ID.
- KT-GB-9319: This feature is not currently available.
- KT-GB-9327: Snap failed to create.
- 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. |
|
Returns true if snap was successfully created. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}CreateSupplyPointMetadata
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 |
|---|---|
|
The created metadata. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}CreateTimeSeriesPrices
Time series information and existing variants based on the prices created.
Fields
| Name | Description |
|---|---|
|
The time series code. |
|
The time series description. |
|
The time series meta information. |
|
The time series display name. |
|
The time series period size value. |
|
The product code associated to the time series. |
|
The time series unit value. |
|
The existing time series variants based on the prices created. |
Example
{
"code": "save-father-style-within-situation",
"productCode": "school-ten-commercial-long-live",
"name": "could-look-mention-industry-first",
"description": "happen-near-represent-win-matter",
"unit": "practice-understand-certainly-through-economy",
"periodSize": "benefit-whose-cost-grow-four",
"meta": {"key": "value"},
"variants": VariantProfile
}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. |
|
Unique identifier for the transaction. |
|
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. |
|
Date when the transaction was posted to the account. |
|
Returns the reason. |
|
Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
|
Human-readable title describing the transaction. |
Example
{
"id": "18211010",
"postedDate": "2012-06-10",
"createdAt": "1992-12-13T17:33:15.119856+00:00",
"accountNumber": "A-F899D16A",
"amount": 57,
"amounts": TransactionAmountType,
"balanceCarriedForward": 44,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "respond-exist-institution-simply-action",
"billingDocumentIdentifier": "66261303",
"statementId": "30683296",
"isReversed": true,
"hasStatement": true,
"note": "least-follow-a-pick-group",
"reasonCode": "impact-seek-on-however-environmental"
}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": "no-land-matter-often-project",
"display": "like-front-morning-least-according",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "brother-strategy-firm-approach-century"
}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": "director-type-news-third-time",
"accountNumber": "A-71300F0D",
"validFrom": "1987-02-09T09:51:27.914907+00:00",
"validTo": "1999-03-01T16:25:50.525213+00:00"
}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": "her-rest-for-into-upon",
"accountNumber": "A-A80E6C0D",
"validFrom": "1993-02-18T07:01:20.486783+00:00",
"validTo": "2014-12-27T04:30:46.948707+00:00"
}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]
}Fields
| Name | Description |
|---|---|
|
The current eligibility status for a deposit return. |
|
The reasons why the account is currently ineligible for a deposit return. |
Example
{
"isEligible": true,
"reasonsForIneligibility": ["explain-as-cultural-rate-just"]
}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": 72,
"edgeCount": 88
}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": "here-threat-walk-score-natural"
}Fields
| Name | Description |
|---|---|
|
The unique identifier for the customer feedback form. |
|
The name of the customer feedback form. |
Example
{
"id": "49038771",
"name": "sense-beat-on-billion-fire"
}Fields
| Name | Description |
|---|---|
|
|
|
The value attached to the source |
|
The datetime the feedback was submitted |
Example
{
"id": "25702173",
"rawScore": 63,
"submittedAt": "1989-12-10T04:20:34.223475+00:00"
}Fields
| Name | Description |
|---|---|
|
The account number. |
|
The ledger identifier. |
Example
{
"accountNumber": "A-10C16260",
"ledgerNumber": "education-social-author-difference-six"
}Fields
| Name | Description |
|---|---|
|
The account number. |
|
The agency. |
|
The campaign. |
|
Whether the commencement could be applied. |
|
The ledger identifier. |
Example
{
"commencementStatus": true,
"accountNumber": "A-819DF533",
"ledgerNumber": "bank-blood-food-two-here",
"agency": "everything-something-everybody-girl-deal",
"campaign": "deep-beat-democratic-head-sister"
}Fields
| Name | Description |
|---|---|
|
The account number. |
|
Whether the update has been applied. |
Example
{
"commencementStatus": true,
"accountNumber": "A-9F66E93E"
}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": "89314160",
"typename": "baby-old-according-success-glass",
"dashboardItems": SectionType,
"serialisedDashboardItems": "quality-week-add-instead-whom"
}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": "1989-03-20T18:15:59.102860+00:00",
"endCursor": "1994-07-25T15:34:40.151539+00:00",
"hasPreviousPage": true,
"hasNextPage": true
}Fields
| Name | Description |
|---|---|
|
|
|
Is EPG applied to the unit rate. |
|
|
|
|
|
|
|
|
|
Whether the tariff is for exporting energy. |
|
|
|
Is EPG applied to the unit rate. |
|
|
|
|
|
|
|
|
|
|
|
Tags associated with the tariff. |
|
Describes a particular tariff by combining the product code, number of rates, available from date and GSP code. |
Example
{
"id": "16073964",
"displayName": "design-approach-several-specific-yeah",
"fullName": "develop-able-outside-boy-remember",
"description": "point-detail-religious-artist-for",
"productCode": "fight-participant-board-everything-popular",
"standingCharge": 665.61,
"preVatStandingCharge": 949.29,
"tariffCode": "draw-grow-toward-year-pull",
"isExport": true,
"tags": ["black-require-suggest-how-realize"],
"dayRate": 428.6,
"dayRateEpgApplied": true,
"nightRate": 843.62,
"nightRateEpgApplied": true,
"preVatDayRate": 641.14,
"preVatNightRate": 330.51
}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": "new-within-without-hit-Republican",
"code": "leader-of-week-oil-painting",
"isActive": true
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Example
{
"code": "another-upon-wall-itself-campaign",
"displayName": "memory-position-later-green-tree",
"deprecatedAt": "2007-03-16T22:51:38.967286+00:00",
"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": "ON_SUPPLY_GAS",
"amount": 18,
"startedAt": "2021-04-21T00:49:17.804677+00:00",
"stoppedAt": "2023-03-06T00:50:15.797210+00:00",
"stopReason": "BANKRUPT",
"collectionCampaign": DebtCollectionCampaignType
}DecimalReading
A reading with a decimal value taken at a specific time.
Fields
| Name | Description |
|---|---|
|
The timestamp when the reading was taken. |
|
The decimal value of the reading. |
Example
{
"timestamp": "2023-10-27T09:20:56.841567+00:00",
"value": "1.0"
}DecimalType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"decimalValue": "1.0"
}DecommissionSmartDevice
The possible errors that can be raised are:
- KT-GB-4024: The provided device ID does not match any devices known by Kraken.
- KT-GB-4050: Smart meter not found.
- KT-GB-4025: Error sending the request to decommission the device.
- 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 reference of the Decommission Request in Kraken. |
Example
{
"possibleErrors": [PossibleErrorType],
"requestReference": "song-enjoy-side-daughter-democratic"
}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": 7,
"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": "see-success-house-word-edge",
"id": "79248051",
"typename": "happy-agreement-plant-since-speech",
"url": "behavior-food-hundred-most-join"
}DefaultElectricJuicePaymentInstructionType
Payment Instructions
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "74127764",
"instructionType": "window-close-attorney-research-system",
"cardPaymentNetwork": "course-ahead-move-admit-whatever",
"cardExpiryMonth": 39,
"cardExpiryYear": 70,
"validFrom": "1977-11-21T11:55:47.723254+00:00",
"vendor": "section-close-whom-until-no",
"cardNumber": "marriage-minute-house-tend-fire",
"cardType": "claim-technology-dog-newspaper-place"
}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 |
|---|---|
|
Number of days to delay based on delay strategy. |
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
Defines the method for calculating the delay period. |
|
The type of the term. |
Example
{
"type": "onto-accept-every-watch-tonight",
"displayName": "performance-land-plan-growth-try",
"description": "when-soon-once-be-individual",
"identifier": "76422125",
"isVariable": true,
"days": 2,
"strategy": "FIXED"
}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": "cup-adult-believe-play-sometimes"
}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
}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.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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
}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 |
|---|---|
|
The timestamp at which the customer accepted the deposit agreement. |
|
The date on which a payment is requested for deposit collection (defaults to current date, if not specified in the deposit policy). |
|
The current eligibility status for a deposit return. |
|
The deposit agreement amount. |
|
The deposit agreement key (unique). |
|
The date by which the deposit agreement must be fulfilled (defaults to 31-12-9999 i.e. deposit is never late, if not specified in the deposit policy). |
|
The timestamp at which the deposit agreement was fulfilled. |
|
The return strategy used to return the deposit. |
Example
{
"depositKey": "success-similar-week-big-occur",
"depositAmount": 62,
"acceptedAt": "1982-01-26T09:52:37.593567+00:00",
"fulfilledAt": "2019-10-02T15:16:01.646954+00:00",
"collectionDate": "2009-01-29",
"dueDate": "1980-12-29",
"returnStrategy": "industry-change-walk-and-she",
"currentEligibilityStatus": CurrentEligibilityStatusOutput
}Fields
| Name | Description |
|---|---|
|
The amount to be returned in this installment. |
|
The date by which the deposit return installment is due. |
|
The status of this return installment. |
Example
{
"dueDate": "1985-11-08",
"amount": 93,
"status": "factor-series-result-open-information"
}DeprovisionHeatingController
De-provision a heating controller device.
The possible errors that can be raised are:
- KT-CT-4307: Error deprovisioning an Octopus heat pump.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
The message to display to the user upon successful device de-provisioning. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "anyone-score-under-break-bill"
}Fields
| Name | Description |
|---|---|
|
The id of the device. |
|
Get readings from a readable device e.g., a supply point, device, or register. |
|
The registers associated with this device. |
Example
{
"readings": Readings,
"deviceIdentifier": "30323608",
"registers": RegistersConnection
}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": "1983-12-24T02:08:15.095144+00:00"
}Fields
| Name | Description |
|---|---|
|
The type of device. |
|
|
|
The third party that provides control over this device. |
Example
{
"krakenflexDeviceId": "83413545",
"provider": "BYD",
"deviceType": "BATTERIES"
}DeviceReAuthentication
Information about a device's re-authentication eligibility and status.
Fields
| Name | Description |
|---|---|
|
|
Example
{
"isEligible": true
}Fields
| Name | Description |
|---|---|
|
Get readings from a readable device e.g., a supply point, device, or register. |
|
The id of the register. |
Example
{
"readings": Readings,
"registerIdentifier": "65215655"
}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": ["finish-town-treatment-side-discover"]
}Fields
| Name | Description |
|---|---|
|
Timestamp of the reading. |
|
Value of the reading. |
Example
{
"value": 847.31,
"timestamp": "2016-03-20T16:58:15.881079+00:00"
}Fields
| Name | Description |
|---|---|
|
Device charging power in kilowatts (kW) - negative for import, positive for export. |
|
Energy stored in the device in kilowatt-hours (kWh). |
|
State of charge of the battery in % (may not be a whole number). |
Example
{
"activePowerInKw": DeviceStatusReadingType,
"energyInKwh": DeviceStatusReadingType,
"socPercentage": DeviceStatusReadingType
}Fields
| Name | Description |
|---|---|
|
The maximum export power of the device in kilowatts. |
|
The maximum import power of the device in kilowatts. |
|
Whether device is connected. |
|
Device status telemetry readings. |
|
The lifecycle status of the device. Deprecated The 'status' field is deprecated. |
|
Whether control of the device has been temporarily suspended. |
Example
{
"status": "ONBOARDING",
"suspended": true,
"maxImportInKw": 23.33,
"maxExportInKw": 789.8,
"pluggedIn": true,
"readings": DeviceStatusReadingsType
}DevicesConnection
Pagination for devices.
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": DevicesEdge,
"totalCount": 50,
"edgeCount": 32
}DevicesEdge
A Relay edge containing a Devices and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Device,
"cursor": "prepare-page-reveal-fear-few"
}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": 39,
"edgeCount": 48
}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": "base-might-some-much-provide"
}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": "29995355",
"status": "window-kid-Mr-author-professor",
"sortCode": "month-wife-peace-sister-board",
"iban": "report-project-grow-mouth-along",
"accountHolder": "gun-our-sound-often-pull",
"instructionType": "place-the-lead-break-mouth",
"cardPaymentNetwork": "establish-war-write-rate-instead",
"cardExpiryMonth": 65,
"cardExpiryYear": 17,
"lastFourDigitsOfAccountNumber": "A-067809DB",
"maskedAccountIdentifier": "11649742",
"maskedIban": "sure-note-if-sound-everyone",
"owners": [PaymentInstructionOwnerType]
}Fields
| Name | Description |
|---|---|
|
|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"paymentSchedule": PaymentScheduleType,
"errors": [ErrorType]
}DisableAutoTopup
Disable auto topup for SPAYG meter.
Fields
| Name | Description |
|---|---|
|
Boolean indicating if the auto top-up was successfully disabled. |
Example
{
"success": true
}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": "1988-01-13T07:59:38.062045+00:00",
"discount": "1.0",
"metaData": FanClubMetadataOutput
}Fields
| Name | Description |
|---|---|
|
The start time that the ensemble forecast simulation. |
|
Discount forecast data-points. |
Example
{
"baseTime": "1975-08-23T16:14:59.405833+00:00",
"data": ForecastData
}Fields
| Name | Description |
|---|---|
|
Example
{
"earliestPossibleDirectDebitPaymentDate": "1986-02-20"
}Fields
| Name | Description |
|---|---|
|
ECS Calculated Annual Consumption (kWh). |
|
Date on which Annual Consumption is effective from. |
|
ECS Calculated Annual Consumption Quality Indicator. |
|
Meter Data Reader effective from date. |
|
Meter Data Reader MPID. |
|
Connection type. |
|
Connection type effective from date. |
|
Connection type end date. |
|
Consumer Type. |
|
Current supplier as supplied via CSS messages. |
|
Current supply start date via CSS messages. |
|
Customer Direct Contract Data Service DIP Identifier. |
|
Identifies where such a relationship exists for a Data Service. |
|
Customer Direct Contract Data Service MPID. |
|
Customer Direct Contract Metering Service DIP Identifier. |
|
Identifies where such a relationship exists for a Metering Service. |
|
Customer Direct Contract Metering Service MPID. |
|
Data Aggregator appointment effective from date. |
|
Data Aggregator MPID. |
|
Data Collector appointment effective from date. |
|
Data Collector MPID. |
|
Data Service DIP Identifier. |
|
Data Service effective from date. |
|
Data Service MPID. |
|
Data Communications Company Service Flag. |
|
Data Communications Company Service Flag effective from date. |
|
Disconnection effective from date. |
|
Distributor DIP Identifier. |
|
Distributor MPID. |
|
Domestic Consumer Indicator supplied via CSS messages. Deprecated The 'domesticConsumerIndicator' field is deprecated. |
|
Domestic Consumer Indicator supplied via CSS messages. |
|
DUoS Tariff ID. |
|
Duos Tariff ID effective from date. |
|
Energisation status. |
|
Energisation status effective from date. |
|
Energy direction. |
|
Energy direction effective from date. |
|
Energy direction end date. |
|
Indicates if a Green Deal is currently active for this MPAN. |
|
Grid Supply Point Group effective from date. |
|
Grid Supply Point Group Id. |
|
In Home Display Install status. |
|
In Home Display Install status effective from date. |
|
Line Loss Factor Class. |
|
Line Loss Factor Class effective from date. |
|
MPAN Market Segment. |
|
MPAN Market Segment effective from date. |
|
Measurement Class. |
|
Measurement Class effective from date. |
|
Meter Operator appointment effective from date. |
|
Meter Operator MPID. |
|
Meter Time-switch Class. |
|
Meter Time-switch Class effective from date. |
|
Metered Indicator. |
|
Metered Indicator effective from date. |
|
Metered Indicator end date. |
|
Metering Service DIP identifier. |
|
Metering Service effective from date. |
|
Metering Service effective to date. |
|
Metering Service MPID. |
|
List of meter details. |
|
Indicates whether the MPAN is Legacy, MHHS or Reversed. |
|
MHHS indicator effective from date. |
|
MPAN. |
|
Profile Class. |
|
Profile Class effective from date. |
|
Relationship Status Indicator. |
|
RMP State. |
|
RMP State effective from date. |
|
Smart Metering Equipment Technical Specification version. |
|
Smart Metering System Operator effective from date. |
|
Smart Metering System Operator MPID. |
|
Standard Settlement Configuration. |
|
Standard Settlement Configuration effective from date. |
|
Supplier DIP identifier. |
|
Effective from date of the current supplier. |
|
Supplier MPID. |
|
MPAN trading status. |
|
MPAN trading status effective from date. |
Example
{
"mpan": "perhaps-listen-think-few-run",
"distributorMpid": "55375195",
"tradingStatus": "more-other-road-until-time",
"tradingStatusEfd": "1972-02-15",
"gspGroupId": "76798921",
"gspGroupEfd": "2003-06-08",
"lineLossFactor": "describe-water-social-again-many",
"lineLossFactorEfd": "1982-11-10",
"dccServiceFlag": "add-point-write-sport-nothing",
"dccServiceFlagEfd": "2001-04-26",
"greenDealInEffect": "participant-reflect-see-store-edge",
"supplierMpid": "86056861",
"supplierEfd": "1979-07-06",
"energisationStatus": "about-shake-visit-such-Democrat",
"energisationStatusEfd": "2010-03-20",
"profileClass": 15,
"profileClassEfd": "1991-05-16",
"standardSettlementConfiguration": "any-live-practice-production-left",
"standardSettlementConfigurationEfd": "1987-08-29",
"meterTimeswitchClass": 19,
"meterTimeswitchClassEfd": "2021-02-05",
"measurementClass": "draw-family-treat-off-future",
"measurementClassEfd": "2022-02-08",
"dataAggregatorMpid": "27001469",
"dataAggregatorEfd": "2020-10-29",
"dataCollectorMpid": "12331395",
"dataCollectorEfd": "2009-05-01",
"meterOperatorMpid": "71792069",
"meterOperatorEfd": "2010-06-25",
"smsoMpid": "28099911",
"smsoEfd": "2003-03-11",
"ihdStatus": "everyone-during-firm-skill-pick",
"ihdStatusEfd": "1998-08-02",
"smetsVersion": "let-try-use-some-floor",
"meteredIndicator": true,
"meteredIndicatorEfd": "2020-05-29",
"meteredIndicatorEtd": "2001-06-29",
"consumerType": "future-main-newspaper-scientist-degree",
"domesticConsumerIndicator": true,
"domesticPremisesIndicator": true,
"relationshipStatusIndicator": "man-military-record-institution-leg",
"rmpState": "kid-note-and-left-method",
"rmpStateEfd": "2009-06-02",
"cssSupplierMpid": "76267576",
"cssSupplyStartDate": "2013-09-13",
"energyDirection": "hotel-shoulder-throughout-accept-one",
"energyDirectionEfd": "2012-02-17",
"energyDirectionEtd": "2018-10-17",
"connectionType": "fall-coach-surface-prepare-number",
"connectionTypeEfd": "1981-02-11",
"connectionTypeEtd": "2024-12-06",
"meters": [ElectricMeterTechnicalSubDetails],
"mhhsIndicator": "meet-little-finish-career-street",
"mhhsIndicatorEfd": "1975-11-28",
"distributorDipId": "27655193",
"disconnectionEfd": "2019-07-22",
"supplierDipId": "51799767",
"meteringServiceMpid": "88494637",
"meteringServiceDipId": "14028369",
"meteringServiceEfd": "2002-12-21",
"meteringServiceEtd": "2008-03-22",
"annualConsumption": "1.0",
"annualConsumptionEfd": "1998-12-28",
"annualConsumptionQualityIndicator": "thus-set-science-here-point",
"assignedMdrMpid": "88440153",
"assignedMdrEfd": "1991-08-10",
"customerDirectContractDsExists": true,
"customerDirectContractDsMpid": "55331497",
"customerDirectContractDsDipId": "18695078",
"customerDirectContractMsExists": true,
"customerDirectContractMsMpid": "71208996",
"customerDirectContractMsDipId": "64702314",
"dataServiceMpid": "18848694",
"dataServiceEfd": "1982-05-28",
"dataServiceDipId": "40915250",
"duosTariffId": "49195376",
"duosTariffIdEfd": "1981-07-13",
"marketSegmentIndicator": "song-offer-wife-who-finish",
"marketSegmentIndicatorEfd": "1989-12-08"
}Fields
| Name | Description |
|---|---|
|
ESME ID. |
|
Installing Supplier DIP ID, 10 characters. |
|
Installing Supplier MPID. |
|
Meter Asset Provider DIP ID, 10 characters. |
|
Meter Asset Provider MPID. |
|
Meter Install Date. |
|
Meter location. |
|
Meter manufacturer. |
|
Meter Serial Number. |
|
Meter Type. |
|
Number of register digits. |
Example
{
"installingSupplierMpid": "24118405",
"meterSerialNumber": "turn-medical-safe-its-play",
"meterType": "notice-after-along-board-suggest",
"meterInstallDate": "2006-01-11",
"mapMpid": "19441690",
"esmeId": "78643960",
"meterLocation": "inside-everyone-three-fact-job",
"registerDigits": 42,
"installingSupplierDipId": "50782750",
"mapDipId": "92068473",
"meterManufacturer": "serve-why-former-even-audience"
}Fields
| Name | Description |
|---|---|
|
This field is replacing |
|
|
|
|
|
Shows the availability status of an integration. |
|
|
|
|
|
|
|
|
|
Example
{
"vehicleId": 59566427,
"model": "treat-my-hit-state-section",
"year": 63,
"availableFrom": 42,
"availableTo": 92,
"batterySize": "1.0",
"supportedProviders": ["per-ready-better-record-project"],
"isIntegrationLive": true,
"integrationStatus": "INTERNAL_TESTING"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"make": "color-management-sister-simple-food",
"models": [ElectricVehicleModelType]
}ElectricityAgentContractType
An organization who manages a given meterpoint.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Example
{
"contractType": "MOP",
"effectiveFrom": "1999-11-12",
"agentId": "42346052",
"contractStatus": "ACCEPTED"
}Fields
| Name | Description |
|---|---|
|
|
|
The datetime the agreement was entered. |
|
The datetime the agreement was terminated. |
|
Bespoke rates that apply to this agreement. |
|
Bespoke standing charges that apply to this agreement. |
|
The ID of the agreement. |
|
Whether the agreement is revoked. |
|
A collection of charges and associated consumption data. |
|
|
|
List of contracted standing charge uplifts applicable during this agreement's duration. This is only applicable to business accounts where we may pay commission to a third-party intermediary. |
|
|
|
List of contracted unit rate uplifts applicable during this agreement's duration. This is only applicable to business accounts where we may pay commission to a third-party intermediary. |
|
The start datetime of the agreement. |
|
The end datetime of the agreement. |
Example
{
"id": 85123361,
"validFrom": "1977-04-23T06:14:20.215922+00:00",
"validTo": "1991-03-29T03:45:03.381162+00:00",
"agreedFrom": "1986-04-30T00:34:14.055719+00:00",
"agreedTo": "1987-02-01T07:50:44.575577+00:00",
"account": AccountType,
"meterPoint": ElectricityMeterPointType,
"tariff": ElectricityTariffType,
"isRevoked": true,
"lineItems": LineItemConnection,
"unitRateUplifts": [ElectricityContractUnitRateUplift],
"standingChargeUplifts": [ElectricityContractStandingChargeUplift],
"bespokeRates": [ElectricityBespokeRate],
"bespokeStandingCharges": [ElectricityBespokeStandingCharge]
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"value": "1.0",
"paymentMethod": "DIRECT_DEBIT",
"rateType": "STANDARD"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"value": "1.0",
"paymentMethod": "DIRECT_DEBIT"
}Example
{
"day": 54,
"night": 49,
"isEstimate": true
}Example
{
"consumption": 29,
"isEstimate": true
}Example
{
"day": 99,
"night": 22,
"offPeak": 25,
"isEstimate": true
}Fields
| Name | Description |
|---|---|
|
The estimated Electricity Annual Consumption measured in kWh. |
|
The date from which the EAC is calculated. |
|
A flag stating if the meterpoint has ever had an erroneous transfer of supplier. |
|
The date the meterpoint switched to the current supplier. |
|
The current supplier for the meterpoint. |
Example
{
"eac": 83.61,
"eacEffectiveFromDate": "2010-04-24",
"supplierName": "development-onto-child-executive-skin",
"supplierEffectiveFromDate": "1980-09-01",
"hasErroneousTransfer": true
}Fields
| Name | Description |
|---|---|
|
The amount to add to the standing charge when billing, in pence per day. |
|
When this contract is valid from. |
|
When this contract is valid until. |
Example
{
"validFrom": "2021-01-24T09:05:07.277419+00:00",
"validTo": "2002-03-26T18:26:39.429725+00:00",
"standingChargeUplift": "1.0"
}Fields
| Name | Description |
|---|---|
|
The amount to add to the unit rate when billing, in pence/kWh. |
|
When this contract is valid from. |
|
When this contract is valid until. |
Example
{
"validFrom": "2004-12-01T23:50:18.499501+00:00",
"validTo": "1971-01-01T17:10:13.658591+00:00",
"unitRateUplift": "1.0"
}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": "39887198",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "88875449",
"deviceId": "54223096"
}Fields
| Name | Description |
|---|---|
|
Meter point REL address details. |
|
Meter point technical details. |
Example
{
"technicalDetails": ElectricMeterTechnicalDetails,
"relAddress": UniqueRELAddressType
}Fields
| Name | Description |
|---|---|
|
|
|
Line 1 of the address returned from the search. |
|
Line 2 of the address returned from the search. |
|
List of meterpoints associated with the address. Only returned if address_has_more_than_one_electricity_meter_point is True. |
|
The postcode of the address returned from the search. |
Example
{
"addressHasMoreThanOneElectricityMeterPoint": true,
"electricityMeterPoints": ["she-mission-debate-management-direction"],
"addressLine1": "information-prevent-fall-information-believe",
"addressLine2": "follow-fine-statement-same-character",
"postcode": "series-although-than-usually-stage"
}ElectricityMeterPointType
An electricity meterpoint is a collection of meters. Meters can be changed over time, so it is convenient to keep an invariant reference. Sometimes there are multiple active meters on a meterpoint at a time (eg ECO10), but expect that to be an edge case.
Fields
| Name | Description |
|---|---|
|
A list of agents responsible for management of the meterpoint. |
|
A list of electricity agreements belonging to an account that is linked to the viewer. Filters out expired agreements by default. |
|
Whether it is possible to renew the meter point's tariff. |
|
The current MPID for this meter point. |
|
|
|
|
|
Indicates whether the electricity meter point is an import or an export meter point. |
|
|
|
Details of an ongoing enrolment process. |
|
The distribution network the grid supply point falls under. |
|
|
|
|
|
|
|
|
|
|
|
Whether the meter point is due to renew their tariff. |
|
Whether the meter point is MHHS enabled. |
|
The ID of the meter point in Junifer. Deprecated The 'juniferMeterPointId' field is deprecated. |
|
|
|
Line loss factor class |
|
The current market segment of the meter point. |
|
|
|
|
|
|
|
Meter timeswitch code |
|
|
|
|
|
The profile class of the electricity meter point. |
|
|
|
|
|
|
|
|
|
Smart Metering System Operator |
|
|
|
Standard settlement configuration |
|
|
|
|
|
|
|
|
|
A list of unbilled electricity readings for the meterpoint. |
Example
{
"id": "92031045",
"supplyEndDate": "1990-04-29",
"mpan": "especially-money-individual-give-game",
"ssc": "stock-entire-develop-minute-speech",
"energisationStatus": "different-majority-into-close-responsibility",
"dccServiceFlag": "up-no-entire-on-population",
"statusUpdatedAt": "1973-07-19T02:25:46.802211+00:00",
"oldSupplierId": "92246126",
"newSupplierId": "22472874",
"smartStartDate": "1984-02-26",
"requiresEnrolment": true,
"targetSsd": "1975-05-25",
"requiresWithdrawal": true,
"hasOpenOpeningReadDispute": true,
"hasOpenClosingReadDispute": true,
"profileClass": 44,
"llf": "management-sister-hundred-decide-for",
"mtc": 52,
"measurementClass": "conference-small-method-continue-serious",
"lastValidatedReadingDate": "1975-07-10",
"smsOperator": "way-wait-everything-white-painting",
"smsOperatorEffectiveFrom": "1972-10-07",
"ihdStatus": "significant-town-page-day-smile",
"ihdEffectiveFrom": "2001-06-19",
"dccEffectiveFrom": "1998-03-21",
"meters": [ElectricityMeterType],
"status": "form-property-thousand-she-hundred",
"enrolment": EnrolmentType,
"gspGroupId": "67515306",
"agentContracts": [ElectricityAgentContractType],
"juniferMeterPointId": 11303535,
"agreements": [ElectricityAgreementType],
"smartTariffOnboarding": SmartTariffOnboardingType,
"unbilledReadings": [ElectricityMeterReadingType],
"currentSupplierMpid": "29390158",
"direction": "IMPORT",
"isDueTariffRenewal": true,
"canRenewTariff": true,
"isMhhsEnabled": true,
"marketSegment": "throw-table-audience-final-deep"
}ElectricityMeterReadingConnectionTypeConnection
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": ElectricityMeterReadingConnectionTypeEdge,
"totalCount": 40,
"edgeCount": 16
}ElectricityMeterReadingConnectionTypeEdge
A Relay edge containing a ElectricityMeterReadingConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ElectricityRegisterReadingType,
"cursor": "price-right-in-technology-without"
}ElectricityMeterReadingType
A electricity meter reading. A reading can in fact contain multiple values for each register (for example for ECO7). They are collected under a common read_at datetime and have a common fuel type.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
What 'kind' of reading this is based on how it was taken. |
|
|
|
Example
{
"id": "51575786",
"readAt": "1985-06-22T20:34:02.704439+00:00",
"readingSource": "everyone-total-fish-now-response",
"registers": [RegisterReading],
"source": "manager-fish-memory-forget-factor",
"readingType": "oil-organization-bill-show-compare"
}ElectricityMeterRegisterType
Electricity registers measure consumption.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "77726378",
"identifier": "71601151",
"digits": 73,
"decimalPlaces": 57,
"name": "authority-day-dark-however-together",
"expectedReadingRanges": [20],
"timePatternRegime": "necessary-build-maybe-successful-protect",
"unitRateType": "yet-feeling-itself-space-in",
"eac": "1.0",
"multiplier": 164.69
}ElectricityMeterType
An electricity meter is a collection of registers which store readings. Eco7 meters are an example of a meter with multiple registers (for day and night).
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Energy consumption recorded by the meter. |
|
The units of consumption for a smart meter. |
|
|
|
|
|
|
|
The type of fuel this meter uses. |
|
Returns if the meter has and allows half hourly readings. |
|
|
|
|
|
|
|
|
|
Returns if the meter is ready for top up. |
|
Returns if the meter is an RTS meter. |
|
Returns if the meter is a traditional prepay meter. |
|
|
|
|
|
|
|
|
|
|
|
This lets us get around the fact that we already use the field id as a primary key. We will migrate the id field over to be this id eventually. |
|
|
|
|
|
|
|
Whether this meter requires a final change of tenancy (COT) reading. |
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": 33326974,
"number": "quality-hit-policy-artist-short",
"activeFrom": "2000-12-29T04:04:09.186985+00:00",
"activeTo": "1984-07-28T17:21:07.268583+00:00",
"meteringDirection": "hold-such-hour-born-so",
"readingTransmissionType": "capital-skill-large-care-human",
"tariffCount": "instead-office-state-age-avoid",
"meloNumber": "Congress-best-modern-necessary-week",
"conversionFactor": "likely-risk-animal-add-write"
}Fields
| Name | Description |
|---|---|
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": ElectricityMeterTypeEdge
}ElectricityMeterTypeEdge
A Relay edge containing a ElectricityMeterType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ElectricityMeterType,
"cursor": "somebody-indeed-situation-that-perform"
}Fields
| Name | Description |
|---|---|
|
Estimated cost in pence of the product over a year based on the quoted usage. |
|
Electricity tariff information label (TIL) provides standardised information between suppliers about a tariff. The type of ElectricityProductTariffInformationLabel depends on the rateType of the ElectricitySupplyPoint. |
|
The ID of the quoted product. |
|
|
|
Estimated cost in pence of the product per month based on the quoted usage. |
|
Energy product quoted. |
Example
{
"id": 87365903,
"label": "nice-administration-ground-employee-learn",
"product": EnergyProductType,
"annualAmount": 35,
"monthlyAmount": 21,
"electricityTariffInformationLabel": ElectricityProductTariffInformationLabel
}Fields
| Name | Description |
|---|---|
|
Current active agreement on this supply point. |
|
Annual consumption of the supply point. The type of ElectricityConsumption depends on the rateType. |
|
CO2 saving based on annual consumption for a given supplier. |
|
The Mpan of the suply point. |
|
A list of quoted products and the corresponding tariff information. |
|
Rate type. |
|
Trees saved given the CO2 saving. |
Example
{
"mpan": "pattern-growth-magazine-around-rate",
"agreement": ElectricityAgreementType,
"annualConsumption": ElectricityConsumption,
"quotedProducts": ElectricityQuotedProduct,
"rateType": "STANDARD",
"co2SavingInKgFromConsumption": 79,
"treesSavedFromConsumption": 71
}Fields
| Name | Description |
|---|---|
|
The formatted supply address including postcode. The possible errors that can be raised are:
|
|
The grid supply point. |
|
The valid Saving Sessions MPAN. |
Example
{
"address": "page-window-check-meeting-hit",
"mpan": "third-through-exist-great-pretty",
"gspGroupId": "41949406"
}EmailAttachmentType
Represents a file to attach to a email message.
Fields
| Name | Description |
|---|---|
|
The filename of the attachment. |
|
The ID of the attachment. |
|
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": "80073986",
"filename": "sign-go-those-power-within",
"temporaryUrl": "machine-their-what-majority-eat"
}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": "83897596",
"eventType": "few-everyone-specific-miss-seat",
"occurredAt": "2021-06-22T23:51:41.254715+00:00",
"message": EmailType
}EmailType
Represents an email communication
Fields
| Name | Description |
|---|---|
|
Attachments of the email message. |
|
|
|
The date and time the email was created. |
|
The address the email was sent from. |
|
|
|
HTML body of the email message. |
|
The ID of the email. |
|
Email recipient. |
|
Email sender. |
|
The date and time the email was sent. |
|
Subject line of the email message. |
|
The email template code. |
|
Text body of the email message. |
|
The email address of the recipient. |
|
Example
{
"id": "36599035",
"createdAt": "1971-10-19T02:14:24.904629+00:00",
"sentAt": "1989-04-21T17:28:12.642591+00:00",
"templateCode": "thought-address-thousand-participant-machine",
"toAddress": "herself-animal-claim-today-than",
"fromEmail": "good-himself-recognize-only-son",
"subject": "goal-certainly-north-policy-yet",
"attachments": [EmailAttachmentType],
"textBody": "class-of-watch-away-smile",
"htmlBody": "civil-notice-out-site-rather",
"toNumber": "two-southern-prevent-street-manage",
"fromNumber": "case-wish-sport-evening-argue",
"channel": "big-hard-radio-voice-well",
"sender": "space-draw-bill-keep-newspaper",
"recipient": "green-only-ahead-decision-pretty"
}Fields
| Name | Description |
|---|---|
|
The email address to be checked. |
|
The status of verification for associated email. |
Example
{
"email": "first-affect-would-measure-management",
"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": "94072689",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "32102791",
"deviceId": "69240044"
}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": "60680510",
"name": "him-send-blue-consider-month",
"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": "31912924",
"embeddedNetwork": EmbeddedNetworkType,
"propertyId": "50602904"
}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"
}Fields
| Name | Description |
|---|---|
|
Do we have the calculations needed for estimating heatpump for this account? |
|
Do we have the calculations needed for estimating solar panels for this account? |
|
The current bill of the account in pounds. |
|
The assumed electricity rate for an electric vehicle. |
|
The energy IQ score. |
|
Does the calculation for the account include an electric vehicle? |
|
Does the calculation for the account include a heatpump? |
|
Does the calculation for the account include solar panels? |
|
Is this estimation for the account what they actually have (heatpump, ev, solar). |
|
The new estimated bill for the account in pounds. |
Example
{
"enqScore": 68,
"currentBill": 72.8,
"newBill": 50.5,
"hasEv": true,
"hasSolar": true,
"hasHeatpump": true,
"elecCarRate": 486.59,
"isCurrentRecord": true,
"canAddSolar": true,
"canAddHeatpump": true
}EnergyMixDataType
Energy mix data can include the latest carbon intensity index in a region.
Fields
| Name | Description |
|---|---|
|
Current carbon intensity index. |
Example
{
"carbonIntensityIndex": "treatment-although-behavior-remain-less"
}EnergyProductConnectionTypeConnection
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": EnergyProductConnectionTypeEdge,
"totalCount": 4,
"edgeCount": 90
}EnergyProductConnectionTypeEdge
A Relay edge containing a EnergyProductConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": EnergyProductType,
"cursor": "cause-career-just-three-most"
}EnergyProductType
An EnergyProduct models a group of tariffs for both electricity and gas.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
This will be shown to customers during sign-up |
|
Whether the product is an import or export product. |
|
This name will be shown to customers during sign-up |
|
This is when end-dated products expire |
|
The exit fee applied per fuel if the agreement is ended early. Total value is determined by exit fee type, i.e. this value is either a flat cost or cost per year/month remaining on the agreement. |
|
Determines how the exit fee is calculated. |
|
|
|
|
|
Does the product have EPG applied on the unit rates. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Whether to hide this product from the direct registration journey |
|
|
|
|
|
|
|
|
|
These are internal notes to explain why this product exists |
|
Tags associated with the product. |
|
A list of tariffs per product for a given postcode. |
|
Duration of agreements using this product in months |
Example
{
"id": "76059112",
"fullName": "dinner-against-hundred-political-huge",
"displayName": "these-each-style-treat-table",
"description": "window-according-foreign-discuss-notice",
"availableFrom": "1977-04-23T12:20:21.572654+00:00",
"availableTo": "2005-12-11T05:55:48.019602+00:00",
"isHidden": true,
"code": "security-street-impact-drop-well",
"direction": "IMPORT",
"notes": "interest-power-several-form-area",
"isVariable": true,
"isGreen": true,
"isBusiness": true,
"isChargedHalfHourly": true,
"isPrepay": true,
"isDefault": true,
"isOccupier": true,
"term": 1,
"endsAt": "1985-02-10T13:02:02.082897+00:00",
"tariffs": EnergyTariffConnectionTypeConnection,
"isAvailable": true,
"isUnavailable": true,
"isFixed": true,
"isDomestic": true,
"includesEpgReduction": true,
"exitFees": 9,
"exitFeesType": "kind-debate-Mrs-song-while",
"tags": ["wear-visit-environmental-design-upon"]
}EnergyTariffConnectionTypeConnection
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": EnergyTariffConnectionTypeEdge,
"totalCount": 5,
"edgeCount": 32
}EnergyTariffConnectionTypeEdge
A Relay edge containing a EnergyTariffConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": EnergyTariffType,
"cursor": "particularly-identify-couple-new-personal"
}Example
{
"linkState": "indeed-Mr-take-commercial-discussion",
"linkUrl": "finish-feel-water-serve-decision"
}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": "meet-ready-remain-room-put",
"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": "teacher-born-return-adult-rise"
}Fields
| Name | Description |
|---|---|
|
The outcome of the Octoplus enrolment. |
Example
{
"octoplus": OctoplusEnrolmentOutcome
}EnrolmentType
Details of an ongoing enrolment process.
Fields
| Name | Description |
|---|---|
|
The last company to supply this meter point. |
|
The enrolment status on a meter point. |
|
Target date for supply to start. |
|
Date the switch started. |
Example
{
"switchStartDate": "1991-06-07",
"supplyStartDate": "1988-07-06",
"previousSupplier": "administration-herself-free-simple-cause",
"status": "OBJECTION_RECEIVED"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"field": "able-gas-worry-property-court",
"messages": "involve-two-big-there-society"
}EstimateElectricityMeterReading
The possible errors that can be raised are:
- KT-GB-11013: Register not found.
- KT-GB-11014: The meter and meter point do not belong to the given register.
- KT-GB-11015: The specified register does not have any recorded readings.
- KT-GB-11016: Unable to estimate meter reading.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The meter reading estimate. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"estimate": MeterReadingEstimateType
}EstimateGasMeterReading
The possible errors that can be raised are:
- KT-GB-11013: Register not found.
- KT-GB-11014: The meter and meter point do not belong to the given register.
- KT-GB-11015: The specified register does not have any recorded readings.
- KT-GB-11016: Unable to estimate meter reading.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The meter reading estimate. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"estimate": MeterReadingEstimateType
}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": "focus-best-sense-health-community",
"pricePerUnit": PricePerUnit
}ExpireEvPublicChargingToken
Expire an EV Public Charging token.
The possible errors that can be raised are:
- KT-CT-5817: External Account not found.
- KT-CT-5818: Invalid data.
- KT-CT-5819: Token not found.
- KT-CT-5820: Multiple tokens 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],
"token": Token
}ExportReadingsConnection
Pagination for readings representing outgoing utility flow e.g., solar generation.
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": ExportReadingsEdge,
"totalCount": 67,
"edgeCount": 58
}ExportReadingsEdge
A Relay edge containing a ExportReadings and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "indeed-international-year-hand-record"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "97159263",
"eventType": "voice-arrive-what-sure-dream",
"occurredAt": "2019-12-17T01:53:53.551235+00:00",
"category": "unit-fund-pattern-value-again",
"subcategory": "money-art-tell-bill-cold",
"description": "heavy-financial-provide-together-fear",
"content": {"key": "value"}
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "85096395",
"eventType": "treat-simple-include-if-represent",
"category": "population-take-receive-hit-require",
"subcategory": "focus-the-cover-short-seat",
"occurredAt": "1995-05-04T01:18:51.476078+00:00",
"description": "employee-pretty-despite-identify-box",
"content": {"key": "value"}
}ExternalSalesInfoType
GraphQL type representing external sales information.
This type is used to represent sales records that originate from external systems or processes outside of Kraken's direct tracking mechanisms.
Fields
| Name | Description |
|---|---|
|
The unique identifier for the sales record. |
Example
{
"salesRecordIdentifier": "54731157"
}Fields
| Name | Description |
|---|---|
|
Description of the extra for the parent node. |
|
Display label of the extra for the parent node. |
|
Value of the extra. |
Example
{
"label": "want-raise-prepare-good-four",
"description": "building-table-tonight-production-agree",
"value": "couple-media-social-have-two"
}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": "mission-ever-debate-animal-see",
"name": "medical-economy-line-already-early",
"location": "kid-news-simply-dream-two",
"windFarm": "successful-south-next-life-scene",
"accountNumbers": "wrong-carry-other-population-rich",
"propertyIds": 62,
"catchments": "safe-do-everybody-shoulder-perform",
"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": "man-turn-town-bit-anything",
"vendor": "painting-manage-Congress-plant-late"
}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": FieldSalesVisitConnectionTypeEdge,
"totalCount": 35,
"edgeCount": 36
}FieldSalesVisitConnectionTypeEdge
A Relay edge containing a FieldSalesVisitConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": FieldSalesVisitType,
"cursor": "with-serious-message-gas-reflect"
}FieldSalesVisitOutcomeType
The specific outcome of a field sales visit at an address.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "chance-author-street-should-prepare"
}FieldSalesVisitType
A field sales visit at an address.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Post town |
|
County |
|
Affiliate Link. |
|
|
|
Field Sales Outcomes. |
|
|
|
Example
{
"startedAt": "1988-05-20T23:51:39.703257+00:00",
"stoppedAt": "2017-02-02T05:33:31.631713+00:00",
"addressLine1": "receive-represent-act-example-contain",
"addressLine2": "clear-industry-music-dinner-animal",
"addressLine3": "bring-evidence-management-take-strong",
"addressLine4": "within-attorney-increase-key-somebody",
"addressLine5": "health-build-newspaper-yourself-thus",
"outcome": "SWITCHED",
"affiliateLink": AffiliateLinkType,
"outcomes": [FieldSalesVisitOutcomeType]
}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": "growth-heavy-computer-however-will",
"rate": "media-red-financial-until-control",
"ttl": 18,
"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": 17,
"edgeCount": 35
}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": "single-give-second-appear-product"
}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": "64664704",
"identifierType": "thank-back-particular-way-life",
"riskLevel": "1.0",
"isInRiskList": true
}Fields
| Name | Description |
|---|---|
|
EFR32 firmware version (Emergency Firmware Recovery). |
|
ESP32 firmware version (EFI System Partition). |
|
The EUI of the controller being queried. |
Example
{
"esp32": "former-your-later-set-them",
"efr32": "goal-science-anyone-it-garden",
"eui": "probably-perhaps-at-help-political"
}FitAcceptSchedule
FiT customers need to be able to accept their FiT schedules. There are a number of conditions that need to be met for a schedule: - It must have been sent - It must not have been accepted - It must not be in the future
The possible errors that can be raised are:
- KT-GB-6813: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The accepted schedule. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"fitSchedule": FitScheduleType
}Fields
| Name | Description |
|---|---|
|
The FiT installation associated with the provided FiT id. |
Example
{
"installation": InstallationType
}FitCreateMeterReadings
The possible errors that can be raised are:
- KT-GB-6812: 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],
"readingsSubmitted": true
}Fields
| Name | Description |
|---|---|
|
ID of the meter. |
|
Any installation capacities linked to the meter. |
|
The maximum read volume expected for the current datetime, including any extra tolerance allowed. |
|
MPAN of the meter point linked to the meter. |
|
|
|
Serial number of the meter. |
|
The type of meter. |
Example
{
"serialNumber": "floor-develop-wait-here-point",
"id": "77209569",
"type": "yard-some-computer-skill-unit",
"readings": FitReadingConnectionTypeConnection,
"installationCapacities": [InstallationCapacityType],
"maxExpectedRead": "1.0",
"mpan": "professional-total-official-expect-study"
}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": FitReadingConnectionTypeEdge,
"totalCount": 21,
"edgeCount": 51
}FitReadingConnectionTypeEdge
A Relay edge containing a FitReadingConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": FitReadingType,
"cursor": "kind-soon-market-question-eye"
}Example
{
"value": "1.0",
"readAt": "1998-09-22T11:16:12.689829+00:00",
"isBiennial": true
}Fields
| Name | Description |
|---|---|
|
Datetime the schedule was accepted. |
|
Unique Identifier of the schedule. |
|
Datetime the schedule was sent. |
|
URLs for any schedule PDFs. URLs are temporary and will expire in approximately one hour. They are intended for redirection purposes only; they are not persistent in any form (eg. in emails or a web page body). |
Example
{
"scheduleId": "34d269e0-1f8f-4c1d-be85-29f7d9fa62ee",
"sentAt": "2006-12-06T02:17:04.230253+00:00",
"acceptedAt": "1993-03-13T04:31:01.327780+00:00",
"temporaryDownloadUrls": ["information-increase-position-hard-serve"]
}Fields
| Name | Description |
|---|---|
|
The maximum value this constraint allows. |
|
The minimum value this constraint allows. |
Example
{
"min": "1.0",
"max": "1.0"
}Fields
| Name | Description |
|---|---|
|
The unique id of the device preference schedule setting. |
|
The maximum value a preference can be set to (inclusive). |
|
The constraint applied to the max value. |
|
The minimum value a preference can be set to (inclusive). |
|
The constraint applied to the min value. |
|
The step size preference can be set to. |
|
The constraint applied to the target value. |
|
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": 44155301,
"timeFrom": "12:38:53.922161",
"timeTo": "19:45:43.435285",
"timeStep": 9,
"min": "1.0",
"max": "1.0",
"step": "1.0",
"minConstraint": PreferenceConstraint,
"maxConstraint": PreferenceConstraint,
"targetConstraint": PreferenceConstraint
}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": 96135515,
"deviceType": "peace-own-writer-instead-very",
"mode": "CHARGE",
"unit": "CELSIUS",
"scheduleSettings": FlexDevicePreferenceScheduleSettingInterface
}FlexSupportedDevices
A list of supported makes and models for a given device type.
Fields
| Name | Description |
|---|---|
|
The type of device. |
|
List of supported brands or manufacturer. |
Example
{
"deviceType": "BATTERIES",
"supportedMakes": FlexSupportedMake
}FlexSupportedMake
A brand or manufacturer of the device and its associated models.
If models is empty, all models for this make are supported.
Fields
| Name | Description |
|---|---|
|
Brand or manufacturer of the device. |
|
List of supported models for the device make. If empty, all models are supported. |
Example
{
"make": "dark-way-fill-father-front",
"models": FlexSupportedModel
}FlexSupportedModel
A supported model for a given make.
If model year range is null, all years are supported.
Fields
| Name | Description |
|---|---|
|
Model name of the device. |
|
Model years supported. If null, all model years are supported. |
Example
{
"modelYearRange": ModelYearRange,
"modelName": "professional-issue-boy-foreign-summer"
}FloatType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"floatValue": 968.41
}Fields
| Name | Description |
|---|---|
|
The minimum and maximum temperatures which may be selected, dictated by the device. |
|
The flow temperature currently selected by the user. |
Example
{
"allowableRange": TemperatureRange,
"currentTemperature": Temperature
}Fields
| Name | Description |
|---|---|
|
The type of account. |
|
|
|
|
|
|
|
The payment method for the product. |
|
Example
{
"activeFrom": "1977-03-28T23:03:06.554845+00:00",
"activeTo": "2018-02-05T10:21:43.441988+00:00",
"accountType": "BUSINESS",
"paymentMethod": "DIRECT_DEBIT",
"renewalProducts": [RenewalProductType],
"createdAt": "1970-10-20T23:32:24.383234+00:00"
}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": "2019-09-29T13:28:26.208960+00:00"
}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": "1971-11-11T20:48:36.824205+00:00",
"projectedDiscount": "1.0",
"powerMedian": "1.0",
"powerLowerBound": "1.0",
"powerUpperBound": "1.0"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
Example
{
"id": 53621202,
"content": {"key": "value"},
"errors": [SerializerFieldErrorsType]
}FractionSizeType
A fractional measurement.
Fields
| Name | Description |
|---|---|
|
The fractional value. |
|
Unique identifier of the object. |
|
The name of the object's type. |
Example
{
"id": "94236468",
"typename": "consumer-thought-ever-hear-total",
"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": "41269608",
"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": "97656146",
"amount": 65
}Fields
| Name | Description |
|---|---|
|
The time the data was reported. |
|
The latest reported mode of the heat pump. |
Example
{
"value": "HEATING",
"timestamp": "1975-02-15T22:39:40.411382+00:00"
}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": 82,
"edgeCount": 96
}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": "class-particular-almost-thank-likely"
}Fields
| Name | Description |
|---|---|
|
Amount used from a funding source in minor currency. |
|
Reason why the funding source was used. |
Example
{
"reason": "memory-everybody-safe-religious-deal",
"amount": 67
}GasAgentContractType
An organization who manages a given meterpoint.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Example
{
"contractType": "MAM",
"agentId": "76507809",
"contractStatus": "ACCEPTED",
"effectiveFrom": "2011-08-12"
}Fields
| Name | Description |
|---|---|
|
|
|
The datetime the agreement was entered. |
|
The datetime the agreement was terminated. |
|
Bespoke rates that apply to this agreement. |
|
Bespoke standing charges that apply to this agreement. |
|
The ID of the agreement. |
|
Whether the agreement is revoked. |
|
A collection of charges and associated consumption data. |
|
|
|
List of contracted standing charge uplifts applicable during this agreement's duration. This is only applicable to business accounts where we may pay commission to a third-party intermediary. |
|
|
|
List of contracted unit rate uplifts applicable during this agreement's duration. This is only applicable to business accounts where we may pay commission to a third-party intermediary. |
|
The start datetime of the agreement. |
|
The end datetime of the agreement. |
Example
{
"id": 73485986,
"validFrom": "1976-12-02T03:48:17.720743+00:00",
"validTo": "2011-02-04T01:17:09.246624+00:00",
"agreedFrom": "1989-06-06T10:33:16.922897+00:00",
"agreedTo": "1981-10-23T00:16:02.643234+00:00",
"account": AccountType,
"meterPoint": GasMeterPointType,
"tariff": GasTariffType,
"isRevoked": true,
"lineItems": LineItemConnection,
"unitRateUplifts": [GasContractUnitRateUplift],
"standingChargeUplifts": [GasContractStandingChargeUplift],
"bespokeRates": [GasBespokeRate],
"bespokeStandingCharges": [GasBespokeStandingCharge]
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"value": "1.0",
"paymentMethod": "DIRECT_DEBIT"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"value": "1.0",
"paymentMethod": "DIRECT_DEBIT"
}Example
{
"consumption": 86,
"isEstimate": true
}Fields
| Name | Description |
|---|---|
|
The estimated Annual Quantity measured in kWh. |
|
The date from which the AQ is calculated. |
|
The date the meterpoint switched to the current supplier. |
|
The current supplier for the meterpoint. |
Example
{
"aq": 30,
"supplierName": "decade-floor-institution-stand-push",
"supplierEffectiveFromDate": "1998-01-09",
"aqEffectiveFromDate": "1974-06-18"
}Fields
| Name | Description |
|---|---|
|
The amount to add to the standing charge when billing, in pence per day. |
|
When this contract is valid from. |
|
When this contract is valid until. |
Example
{
"validFrom": "2001-06-08T20:21:53.897800+00:00",
"validTo": "1983-12-19T15:30:58.434993+00:00",
"standingChargeUplift": "1.0"
}Fields
| Name | Description |
|---|---|
|
The amount to add to the unit rate when billing, in pence/kWh. |
|
When this contract is valid from. |
|
When this contract is valid until. |
Example
{
"validFrom": "2009-02-01T23:30:22.790541+00:00",
"validTo": "1998-04-03T00:23:04.542949+00:00",
"unitRateUplift": "1.0"
}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": "54539250",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "21639450",
"deviceId": "32338932"
}Fields
| Name | Description |
|---|---|
|
Meter point REL address details. |
|
Meter point technical details. |
Example
{
"technicalDetails": GasMeterTechnicalDetails,
"relAddress": UniqueRELAddressType
}GasMeterPointType
A gas meterpoint is a collection of meters. Meters are changed over time, so it is convenient to keep an invariant reference. We would not expect there to be multiple active meters at a time on a gas meterpoint.
Fields
| Name | Description |
|---|---|
|
A list of agents responsible for management of the meterpoint. |
|
A list of gas agreements belonging to an account that is linked to the viewer. Filters out expired agreements by default. |
|
Whether it is possible to renew the meter point's tariff. |
|
|
|
Rolling SOQ |
|
Rolling SOQ |
|
The current MPID for this meter point. |
|
|
|
Details of an ongoing enrolment process. |
|
|
|
|
|
|
|
AQ fixed for year |
|
SOQ fixed for year |
|
|
|
|
|
|
|
|
|
|
|
Whether the meter point is due to renew their tariff. |
|
Local distribution zone - Distribution charges are based upon this |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A list of unbilled gas readings for the meterpoint. |
|
Industry status code |
Example
{
"id": "49757679",
"supplyEndDate": "2000-01-08",
"mprn": "stage-should-check-check-their",
"statusUpdatedAt": "1997-08-18T11:29:53.724822+00:00",
"oldSupplierId": "73260397",
"newSupplierId": "21645788",
"smartStartDate": "2015-09-14",
"requiresEnrolment": true,
"targetSsd": "2019-10-13",
"requiresWithdrawal": true,
"hasOpenOpeningReadDispute": true,
"hasOpenClosingReadDispute": true,
"marketSectorCode": "D",
"marketCategory": "SSP",
"meterOwnershipType": "T",
"confirmationReference": 77,
"nominationType": "bank-never-take-your-increase",
"supplyClass": 8,
"nominationShipperReference": "describe-administration-do-occur-media",
"xoserveStatus": "final-manage-idea-recent-last",
"exitCapacityChargeRate": "1.0",
"ldzCapacityChargeRate": "1.0",
"ldzCommodityChargeRate": "1.0",
"ldzCustomerChargeRate": "1.0",
"ntsExitCommodityChargeRate": "1.0",
"mrfType": "professional-score-lead-side-world",
"meterReadBatchFrequency": "third-region-phone-dinner-bank",
"formulaYearSmpSoq": 14,
"formulaYearSmpAq": 26,
"currentDmSoq": 42,
"currentNdmSoq": 20,
"exitZone": "pass-art-personal-employee-budget",
"ldz": "feel-word-forward-participant-father",
"supplyPointCategory": "scientist-successful-contain-factor-government",
"endUserCategory": 14,
"eucIdentifier": "30391203",
"igtIdentifier": "43132414",
"igtCheckedAt": "2004-03-09T17:13:24.672801+00:00",
"meters": [GasMeterType],
"status": "official-daughter-research-attention-watch",
"enrolment": EnrolmentType,
"agentContracts": [GasAgentContractType],
"agreements": [GasAgreementType],
"unbilledReadings": [GasMeterReadingType],
"currentSupplierMpid": "98099212",
"isDueTariffRenewal": true,
"canRenewTariff": true
}GasMeterReadingConnectionTypeConnection
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": GasMeterReadingConnectionTypeEdge,
"totalCount": 71,
"edgeCount": 45
}GasMeterReadingConnectionTypeEdge
A Relay edge containing a GasMeterReadingConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": GasRegisterReadingType,
"cursor": "at-west-ball-enter-toward"
}GasMeterReadingType
A gas meter reading. The reading value is under the register collection to be consistent with electricity readings. We expect a single register and reading value for gas.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
What 'kind' of reading this is based on how it was taken. |
|
|
|
Example
{
"id": "57384974",
"readAt": "2009-08-23T21:02:11.362172+00:00",
"readingSource": "general-receive-to-responsibility-choice",
"registers": [RegisterReading],
"source": "page-threat-fire-magazine-care",
"readingType": "school-economy-race-remember-billion"
}GasMeterRegisterType
Gas registers measure consumption.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "37349146",
"identifier": "60263442",
"digits": 93,
"decimalPlaces": 90,
"name": "everybody-rather-happy-society-will",
"expectedReadingRanges": [5],
"unitRateType": "fly-box-hundred-green-minute"
}Fields
| Name | Description |
|---|---|
|
A unique three-character code used to identify the current supplier. |
|
A datetime indicating the date on which the Supplier became the supplier of the RMP. |
|
Daily Metered current annual offtake quantity (AQ) of a Supply Meter Point. Value in kWh. |
|
Unique Identifier for the Gas Transporter Organisation, can also be used to identify the geographical area. |
|
Unique reference code for the Local Distribution Zone (LDZ). |
|
A code that specifies if the site is used for domestic or industrial/commercial purposes. D = Domestic, I = Industrial and Commercial. |
|
The amount of gas that can be passed through the meter in a given time period. This is the manufacturer's maximum value. |
|
The coded value of the description of the Meter Mechanism, an identifier for the type of equipment fitted, e.g. credit or prepayment meter. |
|
The number of dials on the meter installed at the Supply Meter Point. |
|
The manufacturer's meter serial number as held on the physical meter currently installed on the supply point. |
|
The current annual offtake quantity (AQ) of a Supply Meter Point. Value in kWh. |
|
Meter Point Reference Number (MPRN). A unique identifier for the point at which a meter is, has been or will be connected to the Gas Network. |
|
Non-Daily Metered current annual offtake quantity (AQ) of a Supply Meter Point. Value in kWh. |
|
A datetime indicating the date on which a subsequent Supplier will become the supplier of the RMP. |
|
Specification ID of the smart meter. |
Example
{
"mprn": "whether-goal-democratic-politics-seek",
"currentSupplierId": "17153649",
"currentSupplierRegEffectiveDate": "agency-choose-they-machine-try",
"pendingSupplierRegEffectiveDate": "land-blood-expect-four-with",
"dmq": "1.0",
"gasTransportId": "12474968",
"ldzId": "81003531",
"meterCapacity": "itself-wife-late-senior-interest",
"meterMechanismCode": "movie-trade-interest-whole-pull",
"meterNumberOfDials": "around-man-himself-material-material",
"meterSerialNumber": "area-next-standard-see-yes",
"mpaq": "1.0",
"marketSectorCode": "result-adult-goal-much-thank",
"ndmq": "1.0",
"smartEquipmentTechnicalCode": "rock-difficult-recognize-develop-physical"
}GasMeterType
A gas meter has a register which holds readings. We would expect this to be a one-to-one relationship between meter and register.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Energy consumption recorded by the meter. |
|
The units of consumption for a smart meter. |
|
|
|
|
|
|
|
The type of fuel this meter uses. |
|
Returns if the meter has and allows half hourly readings. |
|
|
|
|
|
|
|
|
|
|
|
Returns if the meter is ready for top up. |
|
Returns if the meter is a traditional prepay meter. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This lets us get around the fact that we already use the field id as a primary key. We will migrate the id field over to be this id eventually. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Whether this meter requires a final change of tenancy (COT) reading. |
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": 95676016,
"number": "beat-effect-or-between-with",
"activeFrom": "2011-07-07T13:52:55.357013+00:00",
"activeTo": "2013-07-21T17:31:40.809350+00:00",
"meteringDirection": "central-who-there-range-provide",
"readingTransmissionType": "home-campaign-including-heart-anything",
"tariffCount": "defense-night-property-often-piece",
"meloNumber": "already-material-grow-continue-actually"
}Fields
| Name | Description |
|---|---|
|
Estimated cost in pence of the product over a year based on the quoted usage. |
|
Gas tariff information label (TIL) provides standardised information between suppliers about a tariff. |
|
The ID of the quoted product. |
|
|
|
Estimated cost in pence of the product per month based on the quoted usage. |
|
Energy product quoted. |
Example
{
"id": 49484824,
"label": "measure-Congress-since-around-building",
"product": EnergyProductType,
"annualAmount": 46,
"monthlyAmount": 81,
"gasTariffInformationLabel": ProductTariffInformationLabelStandard
}Fields
| Name | Description |
|---|---|
|
Current active agreement on this supply point. |
|
Annual consumption of the supply point. |
|
The Mprn of the suply point. |
|
A list of quoted products and the corresponding tariff information. |
|
Gas has only STANDARD rate type. |
Example
{
"mprn": "economic-show-back-safe-establish",
"agreement": GasAgreementType,
"annualConsumption": GasConsumption,
"quotedProducts": GasQuotedProduct,
"rateType": "keep-network-either-while-yes"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Whether the tariff is for exporting energy. |
|
|
|
|
|
|
|
|
|
Tags associated with the tariff. |
|
Describes a particular tariff by combining the product code, number of rates, available from date and GSP code. |
|
|
|
Is EPG applied to the unit rate. |
Example
{
"id": "49174684",
"displayName": "word-occur-trouble-relate-again",
"fullName": "account-believe-story-particularly-manage",
"description": "military-find-pick-want-program",
"productCode": "sport-style-best-major-need",
"standingCharge": 41.14,
"preVatStandingCharge": 597.78,
"tariffCode": "worker-in-all-part-oil",
"isExport": true,
"tags": ["trade-suddenly-positive-candidate-that"],
"unitRate": 595.78,
"unitRateEpgApplied": true,
"preVatUnitRate": 896.54
}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": "dog-catch-network-behind-others",
"pdfUrl": "spring-pay-drive-recent-into",
"brandCode": "building-bad-real-throw-truth",
"markdown": "piece-detail-Congress-activity-court",
"html": "but-choose-personal-water-stock",
"version": "mean-maybe-relate-probably-deep",
"effectiveFrom": "1996-03-20T21:37:47.528768+00:00"
}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": "character-seat-back-month-dark",
"key": "soldier-state-scientist-team-paper",
"fields": {"key": "value"}
}GenerateLeadsFileAttachmentsPreSignedUrl
Generate a pre-signed URL for uploading a leads attachment file.
Fields
| Name | Description |
|---|---|
|
Input fields required to generate a presigned S3 post for leads file attachment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"leadsFileAttachmentPreSignedUrl": LeadsFileAttachmentPresignedPostType
}GeneratePaymentAllocationNumber
Generate a PAN (Payment Allocation Number) for a smart meter. This can be used to add credit to the meter in a shop, if the meter is in prepayment mode.
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
The Payment Allocation Number routes payments made via a PSP (Payment Service Provider) to this device. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pan": "beautiful-step-true-mouth-main"
}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": "evidence-fight-direction-pretty-people",
"tokenExpiryDatetime": "2024-01-28T18:35:21.776162+00:00",
"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": "scene-usually-name-power-get",
"refreshFrequency": 89,
"screenData": "president-marriage-fire-above-quite"
}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": "production-Republican-history-standard-Mr"
}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": "material-fear-cold-case-they"
}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": "instead-particular-body-executive-our"
}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": "A-8E1C9FFB"
}Fields
| Name | Description |
|---|---|
|
All available sets of constantine. |
|
Total amount of prize entries. |
Example
{
"sets": [SnapSetType],
"totalPrizeEntries": 33
}Fields
| Name | Description |
|---|---|
|
Currency. |
|
Gross amount. |
|
Net amount. |
|
Grant type. |
Example
{
"type": "five-agreement-level-indicate-happen",
"netAmount": 632.13,
"grossAmount": 199.19,
"currency": "set-say-station-large-artist"
}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": 14423765,
"marketName": "available-on-analysis-area-general",
"productType": GoodsProductType,
"code": "space-morning-worker-one-something",
"internalName": "take-face-bit-increase-anything",
"customerName": "sing-high-put-away-car",
"notes": "smile-agreement-when-expect-pressure",
"description": "million-trade-simple-present-bank",
"availableFrom": "1986-12-30",
"availableTo": "2021-11-29",
"pricePerUnit": 728.23,
"grossPricePerUnit": 465.58,
"currency": "military-position-possible-audience-sense"
}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": 49,
"edgeCount": 70
}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": "authority-suddenly-write-analysis-anyone"
}Example
{
"code": "glass-tough-middle-study-these",
"internalName": "story-because-authority-recent-fish"
}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": "present-one-ever-push-and",
"ledgerId": "36590236",
"ledgerNumber": "standard-bad-ever-treat-imagine",
"goodsSaleItems": [GoodsSaleItem],
"goodsGrants": [GoodsGrant],
"marketName": "hair-group-culture-perform-discover",
"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": "27485983",
"code": "bag-pay-including-hotel-until",
"totalNetAmount": 57,
"quotedAt": "2004-01-12T15:45:09.466334+00:00",
"goodsQuotedProducts": [GoodsQuotedProduct],
"hasQuoteExpired": true
}Fields
| Name | Description |
|---|---|
|
The ID of the quote share. |
Example
{
"id": "25613479"
}Fields
| Name | Description |
|---|---|
|
Currency. |
|
Net amount. |
|
Number of units. |
|
Price per unit. |
|
Product code. |
Example
{
"product": "decision-public-establish-enjoy-far",
"numberOfUnits": 32,
"pricePerUnit": 97,
"netAmount": 51,
"currency": "big-consider-health-letter-yard"
}Fields
| Name | Description |
|---|---|
|
Currency. |
|
Gross amount. |
|
Net amount. |
|
Number of units. |
|
Price per unit. |
|
Product code. |
Example
{
"product": "live-unit-fine-subject-discussion",
"numberOfUnits": 64,
"pricePerUnit": 136.76,
"netAmount": 907.95,
"grossAmount": 997.21,
"currency": "star-deep-prepare-through-although"
}GrantUserAccessToBusiness
The possible errors that can be raised are:
- KT-CT-5463: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-13501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Example
{
"savedTrees": 10,
"savedCo2InKgs": 88
}GreennessForecastPeriod
A greenness forecast entry for a single period of time.
Fields
| Name | Description |
|---|---|
|
The greenness index LOW/MEDIUM/HIGH (higher is greener) to map to a localised value. |
|
The greenness score 0-100 (higher is greener). |
|
Indicates that this is one of the best periods in the forecast (there may be more than one). This may not consider the entire forecast and can be ignored or calculated client-side from the score. |
|
The start of the forecast period (inclusive). |
|
The end of the forecast period (exclusive). |
Example
{
"validFrom": "2001-09-02T23:56:28.751996+00:00",
"validTo": "1985-03-29T22:21:25.983904+00:00",
"greennessScore": 83,
"greennessIndex": "LOW",
"highlightFlag": true
}Fields
| Name | Description |
|---|---|
|
The current power being imported from or exported to the grid in kW. A negative value indicates power is being imported from the grid; a positive value indicates power is being exported to the grid. |
Example
{
"powerInKw": "1.0"
}GroupType
Represents a group of components presented as a choice.
Fields
| Name | Description |
|---|---|
|
Customer-facing description of the group. |
|
Customer-facing name for the group. |
|
Unique identifier of the group. |
|
Internal name for the group. |
|
Maximum number of components that can be selected from this group. |
|
Minimum number of components that must be selected from this group. |
|
Nested offering components within this group. |
|
Product components within this group. |
Example
{
"identifier": "15023381",
"internalName": "require-group-population-game-culture",
"customerName": "available-line-we-market-seem",
"customerDescription": "office-language-not-space-oil",
"minCardinality": 5,
"maxCardinality": 89,
"productComponents": [ProductComponentType],
"offeringComponents": [OfferingComponentType]
}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": "resource-star-central-media-agree",
"displayName": "majority-write-move-whether-cell",
"description": "manager-structure-ready-town-place",
"identifier": "54267624",
"isVariable": true,
"guaranteeOfOriginPercentage": "ZERO"
}Fields
| Name | Description |
|---|---|
|
Information on how agile unit rates have been calculated. The possible errors that can be raised are:
|
|
|
|
|
|
|
|
|
|
Whether the tariff is for exporting energy. |
|
|
|
|
|
|
|
Tags associated with the tariff. |
|
Describes a particular tariff by combining the product code, number of rates, available from date and GSP code. |
|
Example
{
"id": "74315045",
"displayName": "service-evidence-ask-coach-tough",
"fullName": "law-practice-course-summer-bar",
"description": "charge-official-answer-road-cut",
"productCode": "at-such-scientist-there-story",
"standingCharge": 186.81,
"preVatStandingCharge": 956.63,
"tariffCode": "way-same-ability-must-fast",
"isExport": true,
"tags": ["thing-bar-win-candidate-grow"],
"unitRates": [UnitRate],
"agileCalculationInfo": AgileCalculationInfo
}HardshipAgreementType
Represents a Hardship Agreement for a particular Account.
Fields
| Name | Description |
|---|---|
|
These are internal notes detailing the hardship. |
|
|
|
|
|
|
|
|
|
Example
{
"id": "70113004",
"hardshipType": "DEATH_IN_FAMILY",
"hardshipDetails": "easy-newspaper-late-degree-do",
"hardshipEntryReason": "SELF_IDENTIFIED",
"paymentPlanDetails": "recently-sit-career-cultural-red",
"startDate": "2003-05-08"
}Fields
| Name | Description |
|---|---|
|
Any fault codes present on the device. |
|
The hardware version. |
|
Whether the system has a hot water cylinder (tank) which is compatible with heat pumps. |
|
The flow temperature set for heating. |
|
The last time the heat pump metrics were reset to zero. |
|
Whether the system has a manifold set up. |
|
The maximum temperature which the hot water can be set to. |
|
The minimum temperature which the hot water can be set to. |
|
The heat pump model (eg. COSY). |
|
The serial number of the heat pump. |
|
The current weather compensation settings. |
Example
{
"serialNumber": "action-even-finally-father-put",
"model": "range-dark-assume-environment-current",
"hardwareVersion": "to-later-weight-citizen-eye",
"faultCodes": ["left-take-right-simple-evidence"],
"weatherCompensation": WeatherCompensationConfiguration,
"heatingFlowTemperature": FlowTemperatureConfiguration,
"manifoldEnabled": true,
"hasHeatPumpCompatibleCylinder": true,
"maxWaterSetpoint": 715.96,
"minWaterSetpoint": 89.57,
"latestCounterReset": "2009-04-10T09:23:25.518521+00:00"
}Fields
| Name | Description |
|---|---|
|
Always HEAT_PUMPS. Deprecated The 'deviceType' field is deprecated. |
|
|
|
Override Field to add additional attributes and extend description with possible_errors |
|
The third party that provides control of this heat pump. |
Example
{
"krakenflexDeviceId": "72169503",
"deviceType": "BATTERIES",
"provider": "BYD",
"params": HeatPumpParamsType
}Fields
| Name | Description |
|---|---|
|
The end datetime of the node. |
|
The field to show energy input. |
|
The field to show energy output. |
|
The field to show outdoor temperature. |
|
The start datetime of the node. |
Example
{
"startAt": "1993-02-18T12:22:31.040912+00:00",
"endAt": "1999-09-15T21:33:45.326209+00:00",
"energyInput": Energy,
"energyOutput": Energy,
"outdoorTemperature": Temperature
}Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Whether the heat pump is currently connected to the provider. |
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"isConnected": true,
"climateControlStatus": ClimateControlDetailsType,
"waterTemperatureStatus": WaterTemperatureDetailsType
}Fields
| Name | Description |
|---|---|
|
The coefficient of performance (COP) of the heat pump. |
|
The field to show energy input. |
|
The field to show energy output. |
Example
{
"heatPumpId": "41201035",
"model": "let-professional-similar-choose-probably",
"powerInKw": "1.0",
"isDeprecated": true
}Fields
| Name | Description |
|---|---|
|
The make (manufacturer) of the device. |
Example
{
"make": "offer-try-data-leader-pull"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"make": "raise-method-interesting-while-during",
"models": [HeatPumpVariantModelsType]
}Fields
| Name | Description |
|---|---|
|
Whether a statement is currently held. |
|
Reason for statement being held. |
Example
{
"isHeld": true,
"reason": "growth-yard-herself-long-arm"
}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": "others-or-former-start-think",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "end-of-couple-tree-free",
"id": "44201083",
"typename": "quickly-own-of-member-safe"
}ImportReadingsConnection
Pagination for readings representing incoming utility flow e.g., usage or consumption..
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": ImportReadingsEdge,
"totalCount": 32,
"edgeCount": 22
}ImportReadingsEdge
A Relay edge containing a ImportReadings and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "animal-follow-third-professional-off"
}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": 60,
"recent": 67
}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": "98904153",
"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": "network-campaign-bank-some-class",
"escalationStartAt": "1996-06-05T22:36:00.390968+00:00"
}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": "A-8D896318"
}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": "speech-man-soon-ability-wind"
}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": "picture-almost-rock-stand-support",
"url": "surface-oil-senior-thank-medical"
}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": "charge-though-entire-real-north",
"switchDate": "1992-03-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": "pull-clear-rate-task-every",
"secretToken": "watch-recently-around-resource-including"
}InitiateUnauthenticatedStandalonePayment
Initiate an unauthenticated standalone payment and return the client secret required to complete it.
Fields
| Name | Description |
|---|---|
|
The payment's retrieval and secret tokens. |
Example
{
"payment": InitiateUnauthenticatedStandalonePaymentOutput
}Fields
| Name | Description |
|---|---|
|
The retrieval token for this standalone payment. |
|
The secret used to collect the payment. |
Example
{
"retrievalToken": "word-interesting-right-then-within",
"secretToken": "our-question-eight-say-across"
}Fields
| Name | Description |
|---|---|
|
The icon code point. |
|
The ID of the object |
|
The ink bucket name. |
Example
{
"id": "64650643",
"name": "sister-send-game-necessary-billion",
"icon": "will-security-performance-civil-resource"
}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": "thousand-material-somebody-any-recently",
"displayName": "single-after-onto-new-wish"
}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": "18263703",
"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": "beat-husband-rich-either-better"
}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": ["fund-very-my-item-something"],
"fromHandle": "range-teacher-window-purpose-real",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2008-07-29T17:24:21.472917+00:00",
"subject": "pull-police-seat-worker-worry",
"displayContent": "hotel-however-this-drive-lay",
"attachments": InkMessageAttachment,
"cc": "show-maybe-institution-week-none",
"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": "71814076",
"direction": "INBOUND",
"fromHandle": "show-tough-next-manage-minute",
"toHandle": "finish-such-show-name-great",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1972-06-16T19:37:32.160755+00:00",
"displayContent": "message-young-too-realize-media"
}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": "bad-here-career-career-glass",
"toHandle": "kind-likely-good-worker-more",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1989-04-02T16:28:23.699824+00:00",
"lineMessage": LineMessage,
"isChannelLine": true,
"attachments": InkMessageAttachment,
"tags": InkTag
}InkLiveChatConversation
Ink live chat
Fields
| Name | Description |
|---|---|
|
The relay ID of the live chat conversation. |
Example
{
"relayId": "20304220"
}InkLiveChatMessage
This type wraps around the Message type for a Live Chat message.
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": "61667853",
"direction": "INBOUND",
"fromHandle": "successful-interesting-follow-lot-appear",
"toHandle": "newspaper-because-provide-sea-arm",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1971-01-06T09:05:19.841514+00:00",
"displayContent": "city-during-office-seek-all"
}Fields
| Name | Description |
|---|---|
|
The url for fetching the attachment. |
|
The filename. |
|
The size in bytes. |
Example
{
"filename": "call-late-morning-run-actually",
"fetchUrl": "peace-middle-stand-style-term",
"sizeInBytes": 31
}Fields
| Name | Description |
|---|---|
|
The type of the account linked to the conversation of the message. |
|
The list of accounts related to the message. |
|
The list of the buckets the message is in. |
|
The id of the conversation the message belongs to. |
|
The hour at which the message arrived in Ink. |
|
The number of hours the customer has been waiting for a response to their previous message. |
|
Whether the conversation that the message belongs to is assigned to a user bucket. |
|
Whether the message is the first one sent by the contact. |
|
Whether the message starts a new thread in its conversation. |
|
The operation team that handles the message. |
|
The codes of the auto replies that have been sent to the contact in the last 6 months. |
|
The body of the latest comms SMS message sent to the customer, if the message is an sms. |
|
The week day at which the message arrived in Ink. |
Example
{
"accounts": "rich-war-wide-institution-daughter",
"accountType": "third-public-resource-house-hospital",
"buckets": ["six-try-fact-arm-conference"],
"conversationId": 91786871,
"hourOccurredAt": 60,
"hoursWaiting": 44,
"isAssignedToUserBucket": true,
"isFirstFromContact": true,
"isNewThread": true,
"opsTeam": "sister-plant-every-which-official",
"recentlyReceivedAutoReplies": "party-able-early-consumer-boy",
"replyToCommsSms": "respond-add-agreement-feel-not",
"weekDayOccurredAt": 89
}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": "1970-04-10T15:06:32.221613+00:00",
"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": "14963468",
"content": "tell-north-age-quite-lose",
"isPinned": true,
"occurredAt": "2009-06-08T11:36:40.337404+00:00"
}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": "owner-wait-impact-he-arm",
"toHandle": "beat-TV-yeah-heart-certain",
"displayContent": "customer-serve-who-loss-organization",
"rawPlainTextContent": "operation-computer-sit-coach-east",
"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": "probably-education-stuff-month-this",
"toHandle": "hundred-the-society-that-office",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2002-01-12T01:45:51.796657+00:00",
"displayContent": "campaign-old-ok-part-sport",
"isChannelSms": true,
"tags": InkTag
}Fields
| Name | Description |
|---|---|
|
|
|
The entries in the storyline. |
|
When the storyline was generated. |
|
The ID of the object |
|
|
|
|
|
|
|
Example
{
"id": "50523805",
"topic": "herself-method-size-environmental-clearly",
"summary": "significant-term-government-save-address",
"generatedAt": "2001-02-17T10:23:34.203230+00:00",
"neuralinkRequestId": "0a479200-2665-43ce-82e0-50be661e8a2a",
"createdAt": "1973-01-27T06:31:34.676434+00:00",
"updatedAt": "2002-02-20T02:18:43.833532+00:00",
"entries": InkStorylineEntry
}Fields
| Name | Description |
|---|---|
|
The content of the storyline entry. |
|
The optional related object ID of the entry. |
|
The type of the storyline entry. |
|
The ID of the object |
|
The time the storyline entry occurred. |
|
Optional URL related to the storyline entry. |
Example
{
"id": "44787783",
"entryType": "hundred-realize-start-worry-baby",
"occurredAt": "1998-06-13T04:43:42.064505+00:00",
"content": "most-American-population-case-stage",
"url": "increase-life-young-huge-company",
"contentId": 93502513
}Example
{
"id": "35037443",
"name": "federal-sound-reach-he-event"
}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": "instead-surface-take-fly-south",
"toHandle": "big-service-decade-hit-health",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2006-01-27T07:12:55.794933+00:00",
"vendorId": "10291603",
"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": "discover-job-spend-these-report",
"toHandle": "strategy-economy-head-while-base",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2009-10-04T05:34:00.217656+00:00",
"vendorId": "50085016",
"whatsappContent": WhatsAppTextMessage,
"isChannelWhatsapp": true,
"tags": InkTag
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
Example
{
"declaredNetCapacity": "1.0",
"extensionReference": "teacher-available-positive-although-approach",
"installedCapacity": "1.0"
}Fields
| Name | Description |
|---|---|
|
FIT ID of the installation. |
|
Date fit terms were agreed to. |
|
Meter inspection date. |
|
Details of any meters attached to the installation. |
|
Address of the property linked to the installation. |
|
Installation technology type. |
Example
{
"fitId": "25701362",
"fitTermsAgreedAt": "1991-10-07T04:52:53.191749+00:00",
"inspectionAt": "1984-11-13T13:37:39.088980+00:00",
"meters": [FitMeterType],
"propertyAddress": PropertyAddressType,
"technologyType": "ANAEROBIC_DIGESTION"
}Fields
| Name | Description |
|---|---|
|
The integer value of the characteristic. |
Example
{
"integerValue": 69
}IntegerType
Graphene type object to represent integer values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"integerValue": 46
}IntervalCostOfUsageType
Usage and cost between two points in time.
Fields
| Name | Description |
|---|---|
|
Cost per time interval. |
|
Interval end datetime. |
|
Interval start datetime. |
|
Usage per time interval. |
Example
{
"startAt": "1982-05-21T13:36:10.391644+00:00",
"endAt": "1994-03-28T21:13:49.372973+00:00",
"cost": 34,
"usageKwh": "1.0"
}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": "central-special-daughter-PM-speak",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "wonder-two-level-among-candidate",
"readAt": "1992-12-28T15:32:48.319281+00:00",
"startAt": "1974-02-18T10:15:53.108721+00:00",
"endAt": "2022-07-30T03:31:00.013359+00:00",
"durationInSeconds": 78,
"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": 97897438
}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]
}Fields
| Name | Description |
|---|---|
|
Whether the inverter is currently connected (online/offline). |
|
The current power flowing through the inverter in kW. A negative value indicates that power is being drawn in to charge the battery; a positive value indicates power is being exported to the property (and, possibly, the grid) from the battery and/or solar panels. |
Example
{
"connectionStatus": "ONLINE",
"powerInKw": "1.0"
}Fields
| Name | Description |
|---|---|
|
The make (manufacturer) of the device. |
Example
{
"make": "reach-until-child-enough-she"
}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": 94,
"edgeCount": 61
}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": "dream-gas-but-mission-above"
}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. |
|
Unique identifier for the invoice billing document. |
|
The invoiced amount of the billing document. |
|
The unique billing document's reference that can be used for identifying it externally. |
|
The date due for payment for the invoice. |
|
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": 92746456,
"firstIssued": "2024-09-21T03:07:59.287859+00:00",
"pdfUrl": "surface-daughter-decade-offer-with",
"annulledBy": AnnulmentBillingDocumentType,
"number": "more-sing-behind-new-reason",
"invoicedAmount": 40,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType,
"paymentDueDate": "2021-12-19",
"billingFrom": "1990-11-18T09:47:30.849764+00:00",
"billingTo": "1986-08-08T19:30:37.234840+00:00"
}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": 54,
"taxTotal": 75,
"grossTotal": 16
}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": "88842400",
"billType": "STATEMENT",
"fromDate": "2013-09-01",
"toDate": "2009-12-29",
"temporaryUrl": "travel-identify-easy-form-true",
"issuedDate": "1995-02-10",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "87123813",
"grossAmount": 45,
"isAnnulled": true,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"totalPayments": 1,
"transactions": BillTransactionConnectionTypeConnection,
"representations": BillRepresentationConnectionTypeConnection
}ItemProfileType
Represents the characteristics and configuration of an ordered item.
Fields
| Name | Description |
|---|---|
|
The characteristic values for this item profile. |
Example
{
"characteristics": {"key": "value"}
}JoinConsumerDevice
The possible errors that can be raised are:
- KT-GB-4053: Fuel type should not be specified for Alt HAN device.
- KT-GB-4031: Error sending the request to join the device to the CHF.
- 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 reference of the join PPMID, IHD, CAD or Alt HAN request in Kraken. |
Example
{
"possibleErrors": [PossibleErrorType],
"requestReference": "color-either-choice-clearly-serve"
}JoinDeviceToNetwork
Send a request to the DCC to join a smart device to a HAN (Home Area Network).
The possible errors that can be raised are:
- KT-GB-4019: This device type is not currently supported.
- KT-GB-4020: Error sending the request to join the device to the Home Area Network.
- KT-GB-4057: MPxN is required for the specified device type.
- 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],
"requestReference": "interesting-education-various-choice-eye"
}JoinOctoplusCampaign
Sign an account up to Octoplus.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-GB-9310: Account ineligible for joining Octoplus.
- KT-GB-9311: Error joining campaign.
- KT-GB-9312: Account already signed up to Octoplus.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Outcome of the Octoplus enrollment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Returns mutation success. Deprecated The 'success' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true,
"outcome": EnrolmentOutcome
}JoinSavingSessionsCampaign
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-GB-5110: Campaign not found.
- KT-GB-5111: Meter point not found.
- KT-GB-5112: Error joining campaign.
- 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": SavingSessionsAccountReturnType
}JoinSavingSessionsEvent
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-GB-5114: Saving Sessions event not found.
- KT-GB-5116: Account is not part of a Saving Sessions campaign.
- KT-GB-5117: Account ineligible to join Saving Sessions event.
- KT-GB-5115: Error joining event.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The event codes that the account has joined. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"joinedEventCodes": ["affect-future-now-financial-month"]
}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": 8,
"edgeCount": 69
}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": "executive-measure-research-imagine-a"
}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": "1970-03-20T08:09:49.676844+00:00",
"salesChannel": "while-candidate-truth-section-citizen",
"salesSubchannel": "once-song-take-what-indicate",
"affiliateLink": AffiliateLinkType,
"supplyPointContexts": SupplyPointContextDataInterface,
"note": "property-their-after-sport-nature"
}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": "75904158",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"number": "wait-enough-suffer-common-turn",
"currentProcessData": JoinSupplierProcessDataType
}Fields
| Name | Description |
|---|---|
|
The unique identifier for the sales record. |
|
The opportunity code associated with the sales record. |
Example
{
"identifier": "93089835",
"opportunityNumber": "whole-five-interest-rate-learn"
}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": "80591775",
"provider": "BYD",
"vehicleMake": "product-step-work-not-teach",
"vehicleModel": "instead-beat-region-director-whose",
"vehicleBatterySizeInKwh": "1.0",
"chargePointMake": "decision-my-away-act-issue",
"chargePointModel": "only-sea-rest-bring-it",
"chargePointPowerInKw": "1.0",
"status": "music-effort-year-into-moment",
"suspended": true,
"hasToken": true,
"createdAt": "1985-03-06T16:14:24.175066+00:00",
"stateOfChargeLimit": StateOfChargeLimit,
"testDispatchFailureReason": "NONE"
}Fields
| Name | Description |
|---|---|
|
The name of the affiliate organisation associated with the sales record. |
|
The unique identifier for the sales record. |
|
The sales channel associated with the sales record. |
Example
{
"identifier": "63628095",
"salesChannel": "keep-national-three-who-stock",
"affiliateOrganisationName": "leave-represent-describe-treat-recognize"
}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": "learn-new-alone-door-bill",
"SHA": "to-garden-law-suddenly-himself"
}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. |
|
The interest policy to use for late payment fee calculations. |
|
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": "everyone-treat-area-him-too",
"displayName": "fear-son-plant-describe-dark",
"description": "sense-executive-popular-result-leader",
"identifier": "81635516",
"isVariable": true,
"flatFeeAmount": "1.0",
"percentageFee": "1.0",
"percentageIntervalDays": "1.0",
"interestPolicyName": "country-its-actually-according-my"
}Fields
| Name | Description |
|---|---|
|
Affiliate organization assigned to this lead. |
|
The username of the user the lead is assigned to. |
|
List of consents for the lead. |
|
The contacts for the lead. |
|
The type of the lead. |
|
National Identifier of the lead. |
|
Lead number. |
|
List of opportunities for the lead. |
|
The sales channel that this lead was captured by. |
|
The sales funnel this lead is in. |
|
The current stage of the sales funnel that this lead is in. |
Example
{
"number": "better-ago-nice-third-response",
"nationalId": "45208318",
"leadType": "treat-product-process-study-through",
"salesFunnel": SalesFunnel,
"stage": SalesFunnelStage,
"salesChannel": SalesChannelType,
"assignedToOrganization": AffiliateOrganisationType,
"assignedToUsername": "body-true-likely-owner-close",
"consents": [ConsentOutput],
"opportunities": [OpportunityOutput],
"contacts": [LeadContactDetailsType]
}Fields
| Name | Description |
|---|---|
|
List of block list hits found. |
|
Indicates if the block list validation passed. |
Example
{
"valid": true,
"blockListHits": ["miss-buy-firm-will-recent"]
}Fields
| Name | Description |
|---|---|
|
The email address of the contact. |
|
The family name of the contact. |
|
The given name of the contact. |
|
The phone number of the contact. |
|
The roles of the contact. |
Example
{
"givenName": "Pamela",
"familyName": "Johnson",
"email": "cold-effort-community-protect-very",
"phoneNumber": "medical-theory-garden-western-remain",
"roles": "LEGAL_CONTACT"
}Fields
| Name | Description |
|---|---|
|
The ID of the lead. Deprecated The 'leadId' field is deprecated. |
|
The number of the lead. |
Example
{
"leadId": "13474800",
"number": "character-spend-key-break-again"
}Fields
| Name | Description |
|---|---|
|
Lead's linked account number. |
|
Team assigned to this lead. |
|
User assigned to this lead. |
|
Lead billing address. |
|
Lead billing name. |
|
Lead billing rich address. |
|
Lead brand. |
|
List of consents for the lead. |
|
Lead legal contact email. |
|
Extra details about the lead. |
|
Lead legal family name. |
|
Lead legal given name. |
|
Lead ID. |
|
The type of the lead. |
|
National Identifier of the lead. |
|
Lead number. |
|
Lead legal contact phone number. |
|
Lead sales channel. |
|
Current stage in a funnel. |
Example
{
"leadId": "10635418",
"givenName": "Carlos",
"familyName": "Williams",
"billingName": "smile-sell-hotel-son-play",
"billingAddress": AddressOutput,
"billingRichAddress": RichAddressType,
"email": "still-away-degree-fund-manager",
"phoneNumber": "possible-middle-trial-carry-assume",
"number": "season-look-sound-recently-themselves",
"stage": "democratic-technology-ago-man-ask",
"extraDetails": {"key": "value"},
"brand": "whether-religious-room-couple-speak",
"salesChannel": "course-become-account-move-social",
"assignedToTeam": "every-time-father-no-author",
"assignedToUser": "pull-a-long-plan-wall",
"nationalId": "39084693",
"leadType": "night-that-health-speech-candidate",
"consents": [ConsentOutput],
"accountNumber": "A-500C2D27"
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
LeadsEdge
A Relay edge containing a Leads and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": Lead,
"cursor": "officer-responsibility-himself-now-once"
}LeadsFileAttachmentPresignedPostType
Metadata returned when generating a pre-signed post URL for a leads file attachment.
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": "how-property-probably-defense-debate",
"bucket": "word-population-forget-cell-move",
"preSignedUrl": "hear-way-new-ahead-discussion",
"fields": {"key": "value"}
}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": 26,
"edgeCount": 94
}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": "right-see-brother-require-front"
}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": "34155194",
"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": "chance-plan-religious-team-finally"
}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": "29983239",
"leaveSupplierProcessId": "25555722",
"message": "energy-rock-never-open-mention"
}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": 98,
"edgeCount": 14
}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": "can-speak-scene-act-their"
}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": "40223221",
"status": "PENDING",
"number": "wish-whose-choose-law-whole",
"supplyPoints": SupplyPointConnectionTypeConnection
}LeaveSupplierUpdated
Leave supplier was successfully updated.
Fields
| Name | Description |
|---|---|
|
The message to display to the user on leave supplier update. |
Example
{
"message": "also-identify-character-return-house"
}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 method at a point in time. The possible errors that can be raised are:
|
|
The customer's preferred payment methods. |
|
Payments with non-concluded re-presentation. |
|
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. |
|
The usable payment instructions for this ledger. |
Example
{
"id": "28770146",
"name": "late-land-share-partner-would",
"number": "leave-part-industry-whatever-dream",
"ledgerType": "fear-quality-same-recently-lay",
"balance": 86,
"amountOwedByCustomer": 32,
"affectsAccountBalance": true,
"statements": StatementBillingDocumentConnectionTypeConnection,
"invoices": InvoiceBillingDocumentConnectionTypeConnection,
"transactions": TransactionConnectionTypeConnection,
"repaymentRequests": RepaymentRequestConnectionTypeConnection,
"refundRequests": RefundRequestConnectionTypeConnection,
"acceptsPayments": true,
"paymentAdequacy": PaymentAdequacyDetailsType,
"creditTransferPermissionsData": CreditTransferPermissionsDataType,
"paymentPreferences": PaymentPreferenceConnectionTypeConnection,
"paymentPreferenceAtTime": PaymentPreferenceUnion,
"debtLedger": LedgerType,
"agreements": AgreementConnection,
"usablePaymentInstructions": PaymentInstructionConnectionTypeConnection,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true,
"paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}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
}LifecycleType
Represents the lifecycle of an offering.
Fields
| Name | Description |
|---|---|
|
DateTime when the offering was activated. |
|
Unique lifecycle code. |
|
Maximum version number reached. |
|
Identifier of the previous version of this offering. |
|
Current status of the offering. |
|
Current version of the offering. |
Example
{
"code": "help-Republican-fear-nor-perhaps",
"version": 99,
"maxVersion": 74,
"previousOffering": "20457046",
"status": "DRAFT",
"activatedAt": "1999-04-05T15:17:24.350703+00:00"
}LifetimeTelemetry
A container for some basic metrics to show how the heating system has performed over its lifetime.
Note that "its lifetime" may not be the actual life of the heat pump, but may have been reset when it was last provisioned.
Fields
| Name | Description |
|---|---|
|
The electrical energy drawn by the heat pump over its lifetime. |
|
The heat energy emitted by the heat pump over its lifetime. |
|
When these measurements were taken. |
|
The average lifetime coefficient of performance up to the time of measurement. |
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": "hotel-join-blood-themselves-between",
"field": "west-try-enter-over-fund"
}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": 66,
"length": 2,
"productId": "88554791",
"emojiId": "33984563"
}LineItemConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": LineItemEdge
}LineItemEdge
A Relay edge containing a LineItem and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": LineItemType,
"cursor": "wide-above-even-manager-move"
}LineItemType
A record of spend on consumption between two points in time.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"startAt": "1974-03-24T06:04:17.429255+00:00",
"endAt": "1996-04-07T23:34:24.969099+00:00",
"netAmount": "1.0",
"numberOfUnits": "1.0",
"itemType": "today-first-physical-vote-bed",
"settlementUnit": "about-morning-article-theory-program"
}LineLinkRedirectResponse
Link Successful. Complete link process with LINE.
Fields
| Name | Description |
|---|---|
|
Example
{
"redirectUrl": "least-start-idea-wife-produce"
}Fields
| Name | Description |
|---|---|
|
Keywords describing the sticker. |
|
Sticker package id. |
|
Sticker resource type. |
|
Sticker id. |
|
Text used to customize some stickers. |
Example
{
"packageId": "69424007",
"stickerId": "86311233",
"resourceType": "growth-author-degree-doctor-while",
"keywords": "painting-born-these-view-help",
"text": "walk-prove-show-growth-interesting"
}Fields
| Name | Description |
|---|---|
|
The display content. |
|
The emojis in the message. |
Example
{
"displayContent": "research-instead-fund-build-citizen",
"emojis": [LineEmoji]
}Fields
| Name | Description |
|---|---|
|
Example
{
"message": "art-within-list-middle-city"
}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": "describe-firm-him-east-system",
"id": "41739924",
"typename": "white-upon-question-whom-middle",
"url": "very-truth-middle-house-spring"
}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": 78,
"consumption": ConsumptionBreakdownConnectionTypeConnection,
"averageMonthlyCharge": 72,
"existingMonthlyAmount": 35,
"balanceAdjustment": 65,
"currentBalance": 88,
"targetBalance": 14,
"reviewedOn": "1998-05-23"
}Fields
| Name | Description |
|---|---|
|
How much balance we expect the account to have at this time of year. |
|
Breakdown of customer's usage per source and per month. |
|
The suggested monthly payment amount in pence following the payment adequacy review. |
|
The date that we used to calculate the review of the account. |
|
How much balance we expect the account to have at this time of year. |
Example
{
"recommendedPayment": PaymentBreakdown,
"currentBalance": 34,
"targetBalance": 30,
"estimatedConsumption": [ConsumptionBreakdown],
"reviewedOn": "1999-01-20"
}LiveTelemetry
A container for some basic metrics relevant to the current state of the heating system.
Fields
| Name | Description |
|---|---|
|
The coefficient of performance at the time of measurement. |
|
The rate of heat flow from the heat pump at a given time. |
|
The temperature outdoors. |
|
The power being drawn by the heat pump at a given time. |
|
When these measurements were taken. |
Example
{
"readAt": "1976-09-24T22:23:57.834983+00:00",
"coefficientOfPerformance": "1.0",
"powerInput": Power,
"heatOutput": Power,
"outdoorTemperature": Temperature
}Fields
| Name | Description |
|---|---|
|
The property ID of the location. |
Example
{
"propertyId": "82285882"
}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": "35470696",
"scheme": "test-TV-ability-decision-human",
"number": "arm-hold-push-share-ever",
"status": "of-though-fish-easy-single"
}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": "31167043",
"ledgerType": "traditional-test-beat-fight-exist",
"value": "seem-carry-pay-book-pick",
"balanceBroughtForward": "worry-energy-sing-movement-parent",
"balanceCarriedForward": "story-right-happen-fine-mean",
"reasonCode": "remain-second-table-social-go",
"idempotencyKey": "5ca40243-9a43-4b3e-9d7b-f04eee0eab32",
"postedAt": "1999-04-01T02:25:03.884001+00:00",
"accountNumber": "A-E863A740"
}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": "worker-even-establish-set-question"
}Fields
| Name | Description |
|---|---|
|
Identifier for meter point. |
|
List of available products for the meter point. |
Example
{
"mpxn": "measure-fill-pressure-ever-car",
"products": [EnergyProductType]
}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": "1971-09-24T05:01:27.732621+00:00",
"requestedAt": "1974-03-27T02:51:00.208576+00:00",
"code": "anything-pattern-place-price-according",
"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": 86,
"edgeCount": 75
}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": "treatment-father-building-prepare-much"
}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": "92844628",
"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": 76,
"edgeCount": 81
}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": "spring-ground-control-tend-first"
}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": "green-set-management-require-difficult",
"id": "39627732",
"identifier": "97241671",
"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": "hundred-floor-west-analysis-another",
"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": 59,
"reasonToRecommendAmount": "MAX_AVAILABLE_AMOUNT",
"recommendedBalance": 70
}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": 73,
"edgeCount": 27
}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": "special-approach-entire-box-successful"
}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": "Mr-purpose-red-recently-crime",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "thing-run-prevent-glass-star",
"readAt": "2001-08-29T09:03:27.884434+00:00"
}Fields
| Name | Description |
|---|---|
|
Extras relating to the parent measurement node. |
|
Statistics relating to the parent measurement node. |
|
The source information relating to the parent measurement node. |
Example
{
"utilityFilters": UtilityFiltersOutput,
"statistics": [StatisticOutput],
"extras": [ExtrasOutput]
}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": "1989-03-25T02:22:04.192779+00:00",
"failedAt": "1978-04-18T12:31:44.356683+00:00"
}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": 46,
"edgeCount": 2
}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": "employee-form-continue-red-involve"
}Fields
| Name | Description |
|---|---|
|
The key for the metadata. |
|
The metadata value. |
Example
{
"key": "practice-various-feel-answer-third",
"value": {"key": "value"}
}Fields
| Name | Description |
|---|---|
|
The consumption during the estimation range. |
|
The consumption during the estimation range in the meter's units, e.g. volumetric for a gas estimate. |
|
The estimated meter reading value. |
Example
{
"readingValue": "1.0",
"consumptionInKwh": "1.0",
"consumptionInMeterUnits": "1.0"
}Fields
| Name | Description |
|---|---|
|
The type of MFA device. |
|
Whether the MFA device is confirmed or not. |
Example
{
"deviceType": "listen-player-ahead-agent-wide",
"isConfirmed": true
}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": "its-short-road-expert-describe",
"displayName": "hear-guy-if-together-resource",
"description": "save-tax-national-maybe-tend",
"identifier": "10853830",
"isVariable": true,
"length": 56,
"unitOfTime": "admit-according-chair-star-plan"
}ModelYearRange
Range of model years supported for a device model.
If end year is null, all years after start year are supported.
Fields
| Name | Description |
|---|---|
|
Latest year model is supported. If null, all years after start year are supported. |
|
Earliest year model is supported. |
Example
{
"startYear": 98,
"endYear": 48
}Fields
| Name | Description |
|---|---|
|
|
|
The ISO-4217 code for the currency. |
Example
{
"amount": "1.0",
"currency": "without-worry-build-each-person"
}Fields
| Name | Description |
|---|---|
|
All inferred routing attributes for team, location, and team groups (e.g., ['OPERATIONS_GROUP.TEAM.Team_A', 'OPERATIONS_GROUP.LOCATION.London', 'OPERATIONS_GROUP.GROUP_B']). Recommended for IVR usage. |
|
Location routing information for the selected team. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The next operations team assigned in round-robin sequence. |
|
All operations team groups that the selected team belongs to. |
Example
{
"possibleErrors": [PossibleErrorType],
"team": Team,
"location": TeamLocation,
"teamGroups": TeamGroup,
"allInferredRoutingAttributes": "suffer-city-federal-night-force"
}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": "45004099",
"name": "prepare-several-bank-good-speech",
"bundleId": "27912923",
"service": "GCM",
"externalProvider": "PINPOINT",
"externalProjectId": "41993196",
"description": "before-behind-early-ability-blue",
"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": "include-prove-large-entire-book",
"username": "fine-determine-me-can-appear"
}Fields
| Name | Description |
|---|---|
|
The amount of the payment in pence. |
|
The payment's id. |
|
Whether or not the payment can be amended. |
|
Whether or not the payment has been cancelled. |
|
The date that the payment was/will be made. |
Example
{
"id": "86271626",
"amount": 52,
"paymentDate": "2017-11-06",
"isAmendable": true,
"isCancelled": true
}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": "only-degree-then-toward-scene",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "later-rule-around-lot-sing",
"refreshExpiresIn": 34
}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": "campaign-leader-purpose-year-each",
"refreshExpiresIn": 90
}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": "73288385",
"effectiveFrom": "2001-01-29T22:52:27.360016+00:00",
"effectiveTo": "2006-05-10T15:10:09.931060+00:00",
"isOccupier": true,
"accountNumber": "A-9427B3B5"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
A Kraken Token that can be used to call the 'occupy' mutation for the account. |
|
Example
{
"account": "job-such-authority-read-subject",
"address": "audience-data-before-imagine-region",
"date": "rise-create-close-through-decision",
"propertyId": 84263101,
"occupyToken": "which-interview-charge-rate-guy"
}Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"account": AccountInterface
}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": 51,
"edgeCount": 68
}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": "still-coach-radio-military-address"
}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": "75646156",
"status": "PENDING",
"occupyAt": "2007-10-13T08:46:43.144781+00:00",
"supplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
The Device ID of the communication hub associated with the property of the Cared-For account, which must also have an Octopus Mini device installed. |
|
The first line of the address of the property associated with the Cared-For account. |
|
The ID of the property the Mini will be onboarded in. |
Example
{
"chfDeviceId": "47429382",
"propertyAddressLine1": "while-of-big-adult-society",
"propertyId": "97207956"
}Fields
| Name | Description |
|---|---|
|
The Device ID of the smart meter associated with the property of the Cared-For account, which must also have an Octopus Mini device installed. |
|
The first line of the address of the property associated with the Cared-For account. |
Example
{
"meterDeviceId": "61500602",
"propertyAddressLine1": "best-hear-south-mention-receive"
}Fields
| Name | Description |
|---|---|
|
The current enrollment status of the account. |
|
Describes whether or not the request user is the nominated user for this account. |
|
Describes whether or not this account is enrolled in the Octoplus campaign. Deprecated The 'isOctoplusEnrolled' field is deprecated. |
|
Information about an account's eligibility for joining the Octoplus campaign. |
|
URL for the octoplus snap page if account is eligible. |
|
Describes if the account should use v2. |
Example
{
"isOctoplusEnrolled": true,
"enrollmentStatus": "ENROLLED",
"isLoyaltyPointsUser": true,
"octoplusEligibility": OctoplusEligibilityType,
"octoplusSnapWebUrl": OctoplusSnapWebUrlType,
"shouldUseV2": true
}Fields
| Name | Description |
|---|---|
|
Returns the accounts eligible meters for Octoplus. |
|
Describes why an account is ineligible for Octoplus. Will be null if the account is eligible. Deprecated The 'ineligibilityReason' field is deprecated. |
|
Returns multiple reasons for why an account is ineligible for Octoplus. Will be empty if the account is eligible. |
|
Describes whether or not this account is eligible to join the Octoplus campaign. |
Example
{
"isEligible": true,
"ineligibilityReason": "OCTOPLUS_DISABLED",
"ineligibilityReasons": "OCTOPLUS_DISABLED",
"eligibleMeters": Meter
}Fields
| Name | Description |
|---|---|
|
Whether or not this account has been enrolled in the Octoplus campaign. |
Example
{
"hasEnrolled": true
}Fields
| Name | Description |
|---|---|
|
Describes whether or not the Octoplus campaign should be shown in clients. |
|
Describes whether or not Octoplus partner offer list should be shown in clients. |
|
Describes whether or not Octoplus partner offers should be shown in clients. |
|
Describes whether or not Octoplus rewards should be shown in clients. |
|
Describes whether or not Octoplus Shoptopus offers should be shown in clients. |
|
Describes whether or not the new Octopoints system should be shown in clients. |
Example
{
"shouldClientDisplayOctopointsV2": true,
"shouldClientDisplayOctoplus": true,
"shouldClientDisplayOctoplusRewards": true,
"shouldClientDisplayOctoplusPartnerOffers": true,
"shouldClientDisplayOctoplusShoptopusOffers": true,
"shouldClientDisplayOctoplusPartnerOfferList": true
}Fields
| Name | Description |
|---|---|
|
The FAQ answer field. |
|
The FAQ question field. |
Example
{
"question": "prevent-fact-quite-scene-left",
"answer": "play-ever-theory-other-focus"
}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": OctoplusOfferGroupConnectionTypeEdge,
"totalCount": 42,
"edgeCount": 65
}OctoplusOfferGroupConnectionTypeEdge
A Relay edge containing a OctoplusOfferGroupConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OctoplusOfferGroupType,
"cursor": "activity-floor-himself-PM-girl"
}Fields
| Name | Description |
|---|---|
|
The mobile banner url. |
Example
{
"bannerMobile": "fact-machine-no-of-accept"
}Fields
| Name | Description |
|---|---|
|
The type of offer group. |
|
Unique identifier of the Offer Group. |
|
The image urls for this offer. |
|
The name describing offer group. |
|
Example
{
"id": 42996349,
"name": "policy-art-scientist-apply-clear",
"groupType": "about-build-rise-similar-science",
"imageUrls": OctoplusOfferGroupImageUrlsType,
"octoplusOffers": OctoplusOfferType
}Fields
| Name | Description |
|---|---|
|
The banner image url. |
|
The mobile banner url. |
|
The logo url. |
|
The mobile logo url. Deprecated The 'logoMobile' field is deprecated. |
Example
{
"banner": "itself-compare-including-administration-price",
"bannerMobile": "between-again-rate-federal-tell",
"logo": "hundred-yet-power-sense-public",
"logoMobile": "executive-election-population-feeling-down"
}Fields
| Name | Description |
|---|---|
|
The available sites url for this offer. |
|
The category of the offer. |
|
Describes whether the user should be able to claim this offer, and the reason if not. |
|
The datetime at which the user should no longer be able to claim this offer. |
|
The short description of the offer. |
|
The faqs for this offer. |
|
The image urls for this offer. |
|
The long description of the offer. |
|
The name of the offer to be displayed to the user. |
|
The name of the reward partner. |
|
The partner site url for this offer. |
|
The points cost of claiming this offer. |
|
The price tag for this offer. |
|
The slug to be used as the offer identifier. |
|
The terms and conditions to display to the user. |
|
The instructions for the user as to how to use their claimed reward. |
Example
{
"slug": "hand-particularly-someone-necessary-detail",
"name": "music-become-speak-describe-ten",
"description": "weight-provide-note-call-guy",
"longDescription": "world-free-reason-sometimes-collection",
"partnerName": "art-present-surface-water-realize",
"priceTag": "bar-life-control-require-child",
"pointsCost": 28,
"availableSitesUrl": "smile-usually-particularly-role-special",
"partnerSiteUrl": "guess-summer-their-officer-school",
"imageUrls": OctoplusOfferImageUrlsType,
"termsAndConditions": "indicate-his-long-under-something",
"faqs": [OctoplusOfferFAQsType],
"usageInstructions": "later-stay-body-television-main",
"category": "good-general-late-grow-card",
"claimAbility": OctoplusRewardClaimAbilityType,
"claimBy": "1982-03-18T15:42:53.657336+00:00"
}Fields
| Name | Description |
|---|---|
|
Describes whether the user should be able to claim this offer. |
|
Describes why a user cannot claim this offer. |
Example
{
"canClaimOffer": true,
"cannotClaimReason": "OUT_OF_STOCK"
}Fields
| Name | Description |
|---|---|
|
The account number associated with this reward. |
|
The datetime at which the reward was initially claimed. |
|
The unique id of the reward. |
|
The offer claimed as part of this reward. |
|
The display name of the offer. Deprecated The 'offerName' field is deprecated. |
|
The human-readable identifier for the offer. Deprecated The 'offerSlug' field is deprecated. |
|
The name of the reward partner. Deprecated The 'partnerName' field is deprecated. |
|
The price tag for the offer. Deprecated The 'priceTag' field is deprecated. |
|
The current status of the reward. |
|
The instructions for how to use the reward. Deprecated The 'usageInstructions' field is deprecated. |
|
The voucher associated with this reward. |
Example
{
"id": 90558090,
"accountNumber": "A-C64AE06D",
"offer": OctoplusOfferType,
"offerSlug": "place-rate-theory-five-then",
"offerName": "determine-if-new-son-standard",
"priceTag": "nice-study-everything-heart-side",
"partnerName": "focus-social-mission-walk-yard",
"usageInstructions": "author-year-between-tonight-question",
"vouchers": [VoucherType],
"claimedAt": "2008-05-03T13:28:11.030730+00:00",
"status": "PENDING"
}Fields
| Name | Description |
|---|---|
|
Domain for the snap web url, ex. 'octopus.energy'. |
|
Path for the snap web url, ex. 'snap/webview'. |
|
URL for the octoplus snap page if account is eligible. Eg. 'https://octopus.energy/snap/webview?abcd=efg'. |
Example
{
"url": "receive-specific-dinner-few-computer",
"domain": "professor-music-cut-keep-assume",
"path": "beautiful-subject-bag-girl-treat"
}Fields
| Name | Description |
|---|---|
|
The barcode value/code. |
|
The type of barcode to render. |
|
The value to be encoded in the rendered barcode. |
|
The voucher code. |
|
The datetime at which the voucher will no longer be useable. |
|
The type of voucher. |
Example
{
"code": "case-home-various-wife-art",
"type": "about-people-third-financial-large",
"barcode": "decide-hour-design-wind-card",
"barcodeValue": "American-receive-authority-Democrat-camera",
"barcodeFormat": "popular-admit-now-face-item",
"expiresAt": "1992-12-10T11:38:45.665687+00:00"
}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": "71144679",
"quote": QuoteType_,
"description": "person-although-this-visit-college",
"validFrom": "1982-03-20T00:30:19.029957+00:00",
"validTo": "1985-05-13T11:16:54.519087+00:00",
"acceptedAt": "1988-08-21T16:24:03.365932+00:00",
"rejectedAt": "1978-06-20T14:18:36.865121+00:00",
"createdBy": ActorType
}OfferingComponentType
Represents a nested offering component within an offering.
Fields
| Name | Description |
|---|---|
|
The offering associated with this component. |
|
Unique identifier of the component. |
|
Initial/default quantity for this component. |
|
Maximum quantity of this component that can be selected. |
|
Minimum quantity of this component that can be selected. |
Example
{
"identifier": "21474694",
"minimumQuantity": 30,
"maximumQuantity": 16,
"initialQuantity": 53,
"component": OfferingType
}OfferingType
Represents a product offering in the catalog.
Fields
| Name | Description |
|---|---|
|
Customer-facing description of the offering. |
|
Customer-facing name of the offering. |
|
Groups of components with cardinality constraints. |
|
Unique identifier of the offering. |
|
Internal name used to identify the offering. |
|
Whether this offering is currently active. |
|
Whether this offering can be amended (only DRAFT offerings). |
|
Whether this offering is in draft status. |
|
Whether this offering has expired. |
|
Whether this is the first draft version (version 1, not yet activated). |
|
Whether this is the latest version of the offering. |
|
Whether this offering can be sold stand-alone. |
|
Lifecycle information for this offering. |
|
Nested offering components included in this offering. |
|
Product components included in this offering. |
|
Tags associated with this offering. |
|
Contract term template components included in this offering. |
Example
{
"identifier": "29156261",
"internalName": "building-explain-change-small-product",
"customerName": "response-send-perhaps-case-baby",
"customerDescription": "wrong-tough-Congress-ever-service",
"isSellable": true,
"lifecycle": LifecycleType,
"tags": [TagType],
"productComponents": [ProductComponentType],
"offeringComponents": [OfferingComponentType],
"termTemplateComponents": [TermTemplateComponentType],
"groups": [GroupType],
"isAmendable": true,
"isExpired": true,
"isActive": true,
"isDraft": true,
"isLatestVersion": true,
"isFirstDraft": 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": OnSiteJobsAppointmentActionConnectionTypeEdge,
"totalCount": 60,
"edgeCount": 100
}OnSiteJobsAppointmentActionConnectionTypeEdge
A Relay edge containing a OnSiteJobsAppointmentActionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OnSiteJobsAppointmentActionType,
"cursor": "film-data-keep-I-remember"
}OnSiteJobsAppointmentActionType
An action linked to an On-Site Jobs Appointment.
Fields
| Name | Description |
|---|---|
|
The appointment stage at which this action is triggered. |
|
The name of the workflow. |
|
The current status of the workflow. |
Example
{
"actionTriggerStage": "POST_APPOINTMENT_BOOKING",
"workflowName": "right-sing-herself-field-Republican",
"workflowStatus": "SKIPPED"
}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": OnSiteJobsAppointmentConnectionTypeEdge,
"totalCount": 79,
"edgeCount": 42
}OnSiteJobsAppointmentConnectionTypeEdge
A Relay edge containing a OnSiteJobsAppointmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OnSiteJobsAppointmentType,
"cursor": "space-if-policy-discuss-itself"
}Fields
| Name | Description |
|---|---|
|
Indicates whether all available appointment slots have been fetched. This is only relevant for booking adapters that support async timeslot fetching. For sync, it will always be True. If false, empty list of slots will be returned. |
|
List of available appointment slots. |
Example
{
"slots": OnSiteJobsAppointmentSlotType,
"isComplete": true
}Fields
| Name | Description |
|---|---|
|
The end datetime of the appointment slot. |
|
The unique identifier for this appointment slot. |
|
The start datetime of the appointment slot. |
Example
{
"startDatetime": "2012-06-12T01:12:45.885578+00:00",
"endDatetime": "1978-02-11T04:16:49.537605+00:00",
"slotId": "0fd687ad-ac21-4a64-908d-30f29e6e368d"
}Fields
| Name | Description |
|---|---|
|
The agent assigned to the appointment. |
|
A list of actions triggered by this appointment, across stages. |
|
A list of assets attached to this request. |
|
|
The cancellation category for this appointment. |
|
|
|
|
|
The communication strategy for this appointment. |
|
|
|
|
|
|
|
|
|
|
|
|
|
The work category for this appointment. |
|
|
|
The current status of the appointment. |
Example
{
"id": "707791a6-addb-4097-b8f9-cf2407d46b56",
"externalJobType": "American-reality-edge-body-movement",
"startAt": "1996-05-30T13:52:26.376292+00:00",
"endAt": "1979-11-26T19:30:21.923828+00:00",
"externalReference": "cell-executive-just-campaign-break",
"jobDetails": {"key": "value"},
"jobNotes": {"key": "value"},
"comments": "reduce-manager-ask-argue-available",
"cancellationSubCategory": "staff-sure-not-lawyer-smile",
"krakenWorkCategory": "EXCHANGE",
"agent": "GENERIC_AGENT",
"status": "PENDING",
"commsStrategy": "SEND_ALL",
"cancellationCategory": "CANCELLED_BY_CUSTOMER",
"appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
"assets": OnSiteJobsAssetConnectionTypeConnection
}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": OnSiteJobsAssetConnectionTypeEdge,
"totalCount": 24,
"edgeCount": 64
}OnSiteJobsAssetConnectionTypeEdge
A Relay edge containing a OnSiteJobsAssetConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OnSiteJobsAssetType,
"cursor": "amount-get-hotel-activity-pattern"
}OnSiteJobsAssetType
An On-Site Jobs Asset
Fields
| Name | Description |
|---|---|
|
|
|
The category of the asset. |
|
|
|
The fuel type of the asset. |
|
The kind of the asset. |
|
The status of the asset. |
|
The sub category of the asset. |
|
Example
{
"externalIdentifier": "22015184",
"additionalDetails": {"key": "value"},
"supplyPointIdentifier": "90739221",
"status": "EXISTING",
"kind": "METER",
"fuelType": "ELECTRICITY"
}OnSiteJobsJobTypeType
Represents a job type available for on-site jobs requests.
Fields
| Name | Description |
|---|---|
|
The unique identifier for the job type. |
|
The human-readable name of the job type. |
Example
{
"id": "29261172",
"name": "report-interview-reflect-stay-hard"
}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": OnSiteJobsRequestActionConnectionTypeEdge,
"totalCount": 74,
"edgeCount": 6
}OnSiteJobsRequestActionConnectionTypeEdge
A Relay edge containing a OnSiteJobsRequestActionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OnSiteJobsRequestActionType,
"cursor": "remember-cover-team-all-many"
}OnSiteJobsRequestActionType
An action linked to an On Site Jobs Request.
Fields
| Name | Description |
|---|---|
|
The request stage at which this action is triggered. |
|
The name of the workflow. |
|
The current status of the workflow. |
Example
{
"actionTriggerStage": "POST_REQUEST_COMPLETION",
"workflowName": "well-next-person-security-model",
"workflowStatus": "SKIPPED"
}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": OnSiteJobsRequestConnectionTypeEdge,
"totalCount": 99,
"edgeCount": 74
}OnSiteJobsRequestConnectionTypeEdge
A Relay edge containing a OnSiteJobsRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OnSiteJobsRequestType,
"cursor": "present-list-south-police-figure"
}OnSiteJobsRequestType
An On Site Jobs Request
Fields
| Name | Description |
|---|---|
|
Request account. |
|
|
|
A list of appointments associated to this request. |
|
A list of assets attached to this request. |
|
|
|
|
|
|
|
|
|
|
List of supply points on request. |
|
The overall priority status of all actions linked to the request and its appointments. |
|
Request property. |
|
|
|
A list of actions attached directly to this request. |
|
Request status. |
|
Example
{
"id": "9c877b71-edeb-4d48-8168-91fc6edf9075",
"reason": "behind-glass-situation-if-size",
"subReason": "stage-might-a-box-third",
"isEmergency": true,
"externalReference": "garden-fly-world-seven-already",
"agent": "surface-whose-feeling-plan-low",
"comment": "heavy-north-still-nice-interesting",
"account": "cell-light-police-company-shake",
"marketSupplyPoints": SupplyPointConnectionTypeConnection,
"property": PropertyType,
"status": "APPROVAL_PENDING",
"overallActionsStatus": "SKIPPED",
"requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
"assets": OnSiteJobsAssetConnectionTypeConnection,
"appointments": OnSiteJobsAppointmentConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
The short name (first name) of the support user. |
Example
{
"shortName": "realize-head-off-interest-case"
}OperationsTeamType
An extension of the GBR OperationsTeamType with OEGB-specific fields.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
The leader of the operations team. |
|
The location of the operations team. |
|
|
|
Example
{
"id": "89714750",
"name": "reason-defense-military-art-sea"
}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": OpportunitiesEdge,
"totalCount": 55,
"edgeCount": 87
}OpportunitiesEdge
A Relay edge containing a Opportunities and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": OpportunityOutput,
"cursor": "green-still-stay-develop-ability"
}Fields
| Name | Description |
|---|---|
|
Team assigned to this opportunity. |
|
User assigned to this opportunity. |
|
List of consents for the opportunity. |
|
Lead legal contact email. |
|
Extra details about the opportunity. |
|
The sales funnel this opportunity is in. |
|
Lead number. |
|
Lead type. |
|
Lead legal name. |
|
Opportunity number. |
|
Offer group ID. |
|
Opportunity address. |
|
Opportunity ID. |
|
Opportunity rich address. |
|
Lead legal contact phone number. |
|
Product offering ID. |
|
Sales channel. |
|
Current stage in a funnel. |
Example
{
"opportunityId": "82702263",
"leadNumber": "talk-seven-require-force-industry",
"leadType": "character-listen-nature-put-large",
"name": "administration-success-reach-relate-yourself",
"email": "administration-music-law-fish-own",
"phoneNumber": "conference-appear-drop-spend-staff",
"number": "most-role-coach-use-without",
"funnel": SalesFunnel,
"stage": "more-individual-agent-task-sign",
"extraDetails": {"key": "value"},
"opportunityAddress": AddressOutput,
"opportunityRichAddress": RichAddressType,
"salesChannel": "his-no-along-collection-difference",
"assignedToTeam": "beyond-until-raise-suddenly-close",
"assignedToUser": "health-theory-game-black-day",
"productOfferingId": "30244023",
"offerGroupId": "15648954",
"consents": [ConsentOutput]
}Fields
| Name | Description |
|---|---|
|
The market for the Product. |
|
The characteristics of the product. |
|
The code of the Product. |
|
The UUID for the Product. |
|
The UUID for the Product Offering. |
Example
{
"productOfferingIdentifier": "90865400",
"productIdentifier": "48927145",
"productCode": "compare-choose-final-example-response",
"productCharacteristics": {"key": "value"},
"market": "worry-positive-get-test-like"
}OptInToCharityDonation
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-GB-11903: Could not opt in to charity donation.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Amount that will be donated each month. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"amount": "ONE"
}OptOutOfCharityDonation
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-GB-11902: Could not opt out of charity donation.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Has the account opted out of donating to charity. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"isOptedOut": true
}OrderDetailsType
Represents the details of an Order.
Fields
| Name | Description |
|---|---|
|
The order details. The possible errors that can be raised are:
|
|
The resources associated with the order. The possible errors that can be raised are:
|
|
The current status of the order. The possible errors that can be raised are:
|
Example
{
"order": OrderType,
"status": "PENDING",
"resources": [OrderResource]
}OrderItemType
Represents an item being ordered.
Fields
| Name | Description |
|---|---|
|
The code identifying the item. |
|
Market-specific data for the item. |
|
The profile containing characteristics of the item. |
Example
{
"profile": ItemProfileType,
"marketData": {"key": "value"},
"code": "tree-worker-him-people-must"
}OrderLineDateRangeType
Represents a period defined by specific start and end dates.
Fields
| Name | Description |
|---|---|
|
The end date and time of the period. Null indicates an infinite/rolling period. |
|
The start date and time of the period. |
Example
{
"start": "2011-01-15T14:49:03.329860+00:00",
"end": "2016-02-28T12:18:12.921192+00:00"
}OrderLineDurationType
Represents a period defined by duration in seconds.
Fields
| Name | Description |
|---|---|
|
The duration in seconds. |
Example
{
"duration": 134.48
}OrderLineType
Represents a line item in an order.
Fields
| Name | Description |
|---|---|
|
The item being ordered. |
|
The period for which this order line is valid. Can be a range or a duration. |
|
The target customer for this order line. |
|
The terms applicable to this order line. |
Example
{
"item": OrderItemType,
"period": OrderLinePeriodType,
"target": AccountType,
"terms": TermInterface
}OrderResource
Represents a resource associated with an order.
Fields
| Name | Description |
|---|---|
|
The unique identifier of the resource. |
|
The type of the resource. |
Example
{
"resourceType": "cost-seem-spend-series-right",
"resourceIdentifier": "95964748"
}OrderType
Represents an order in the system.
Fields
| Name | Description |
|---|---|
|
The customer who placed the order. |
|
Unique identifier for the order. |
|
The order lines in this order. |
|
The date and time when the order was placed. |
|
The sales record associated with this order, if any. |
|
The source offering that generated this order. |
|
The terms applicable to this order. |
Example
{
"identifier": "45472094",
"customer": OrderCustomerType,
"lines": [OrderLineType],
"orderedAt": "2002-07-15T22:38:36.191167+00:00",
"terms": TermInterface,
"sale": SalesRecordType,
"source": "wait-talk-give-course-ever"
}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": "60581035",
"account": AccountType,
"metadata": CallMetadataItemType
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "so-Mrs-trip-director-professor"
}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": "cost-close-they-factor-guess",
"endCursor": "must-according-recently-put-yeah"
}PauseCollectionProcess
Manually pause a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11214: Invalid pause length for collection process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Collection process pause output. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |