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 |
|---|---|
|
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": "next-environmental-partner-either-toward",
"status": "SCHEDULED",
"apiType": "GRAPHQL",
"startsAt": "body-it-picture-itself-these",
"endsAt": "evidence-sell-discuss-forward-quickly"
}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": 25,
"edgeCount": 61
}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": "ask-particularly-then-individual-data"
}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": "45411127",
"correlationId": "52072314",
"operationName": "whose-bed-election-himself-quickly",
"inputData": {"key": "value"},
"response": {"key": "value"},
"context": {"key": "value"},
"createdAt": "1981-01-14T11:48:01.747378+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": 66,
"edgeCount": 54
}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": "would-music-begin-Democrat-most"
}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": "91742800",
"eventType": "which-low-billion-local-wife",
"category": "individual-wife-growth-garden-card",
"description": "start-heart-why-increase-stuff",
"context": {"key": "value"},
"createdAt": "2009-11-22T11:52:13.254252+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": "95690936",
"body": "management-wish-employee-behind-born",
"createdAt": "2017-04-19T07:22:37.765580+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": "32839915",
"externalIdentifier": "58075581",
"createdAt": "1990-01-15T18:34:43.702840+00:00",
"channel": "everything-look-industry-order-range",
"category": "ACCOUNT",
"accountNumber": "A-F288A8BC",
"userId": 92576194,
"customerContact": "push-care-job-ball-adult",
"supplyPointIdentifier": "23476507",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"apiCalls": [APICallType],
"events": [APIExceptionEventType],
"tags": "MOVE_IN",
"notes": [APIExceptionNoteType],
"operationsTeam": OperationsTeamType,
"context": {"key": "value"},
"keyDate": "2019-10-07",
"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
}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": 82,
"edgeCount": 62
}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": "former-carry-fear-live-woman"
}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": "wall-really-off-responsibility-war",
"salesSubchannel": "low-sell-quite-camera-hope",
"dateOfSale": "2024-08-06",
"coolingOffEndDate": "2021-03-16",
"isMigrated": true,
"migrationSource": "stage-bed-tend-Republican-exactly",
"preferredSsd": "1981-03-03"
}Fields
| Name | Description |
|---|---|
|
Debit details. |
|
Credit details. |
|
Balance transfer ID. |
|
The reason for the balance transfer. |
Example
{
"id": "81982379",
"accountCharge": AccountChargeType,
"accountCredit": AccountCreditType,
"reason": "feeling-trip-approach-discover-majority"
}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": 70,
"edgeCount": 100
}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": "page-north-us-its-walk"
}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": "2002-05-15",
"name": "hour-friend-mother-move-throw",
"slug": "morning-face-truth-support-what",
"expiryDate": "2011-10-20",
"startDate": "2019-09-20"
}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-11-04T08:58:47.413639+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": "95216079",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"reason": "wrong-prepare-spend-phone-raise",
"note": "wide-imagine-soon-challenge-close",
"displayNote": "scene-claim-charge-well-information",
"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": 95,
"edgeCount": 95
}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": "small-you-significant-mission-structure"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"data": {"key": "value"},
"updatedAt": "1974-05-23T00:44:16.758408+00:00"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "79793241",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"note": "entire-sing-happen-meet-add",
"reason": "research-sort-rise-more-political",
"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": 69,
"edgeCount": 66
}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": "key-go-anything-oil-its"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
The ID of the object |
|
Is the file ready for use / downloadable? |
|
Is the file uploaded to S3? |
|
Example
{
"id": "75036293",
"filename": "daughter-again-mouth-more-even",
"category": "relate-fact-east-interesting-present",
"isUploaded": true,
"isReady": true,
"fetchUrl": "similar-customer-mean-total-man",
"sizeInBytes": 89
}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": 6,
"edgeCount": 93
}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": "next-fact-accept-project-adult"
}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": 37,
"totalMonetaryAmount": 12
}Example
{
"body": "development-raise-indicate-maybe-thing",
"isPinned": true,
"createdAt": "2012-05-26T16:31:50.308191+00:00",
"unpinAt": "1990-08-07T18:41:00.820262+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": 86,
"edgeCount": 59
}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": "ago-bring-piece-water-quite"
}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": "89965811",
"amount": 1,
"paymentDate": "2008-12-15",
"reference": "future-clear-small-wife-thousand",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"paymentInstruction": PaymentInstructionType,
"surchargeAmount": 89
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Example
{
"namespace": "use-meeting-small-commercial-movement",
"value": "go-through-behind-appear-relate",
"createdAt": "1972-11-06T12:47:54.095531+00:00",
"updatedAt": "2022-09-08T17:43:34.756099+00:00",
"account": AccountType
}Fields
| Name | Description |
|---|---|
|
Reminder content. |
|
When the reminder is due. |
|
The reminder type. |
Example
{
"reminderType": "AD_HOC",
"content": "appear-major-range-Mr-throw",
"dueAt": "1983-10-30T06:40:07.750147+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": 59,
"edgeCount": 54
}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": "nothing-street-drive-significant-design"
}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": 97,
"edgeCount": 10
}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": "professional-yourself-how-financial-nearly"
}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": "13516454",
"amount": 1,
"paymentDate": "1978-02-26",
"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"
}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 |
|
All properties linked to the account - past, present and future. |
|
Fetch annual statements for the account. |
|
Applications by this account to become our customer. More recent applications will be listed first. |
|
Assistance agreements for account. |
|
The current account balance. |
|
Fetch a specific issued bill (invoice/statement) for the account. |
|
The billing address of the account. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The billing email of the account. |
|
The billing name of the account. |
|
Information about the account's billing cycle. |
|
The billing sub name of the account. |
|
Fetch issued bills (invoices/statements) for the account. |
|
The brand of the account. |
|
Business info related to a business account. |
|
The company type of a business account. Deprecated The 'businessType' field is deprecated. |
|
The campaigns associated with an account. |
|
Data about whether or not an account can modify their payments. |
|
Whether the account can request a credit refund. |
|
The method the account has specified they prefer we contact them. |
|
Deprecated The 'communicationDeliveryPreference' field is deprecated. |
|
The complaints associated with an account. |
|
Consents linked to this account. |
|
Contribution agreements for account. |
|
The datetime that the account was originally created. |
|
Debt collection proceedings for account. |
|
The direct debit instructions of the account |
|
The document accessibility preference of the account. |
|
The latest balance of the electricity MaLo ledger. |
|
The account events that were recorded for the account. |
|
Files attached to this account. |
|
The latest balance of the gas MaLo ledger. |
|
|
|
True if there is an active Hardship Agreement for this account. False otherwise. |
|
Ledgers provide the foundation of bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular customer account. |
|
Retrieve all market supply agreements under this account. Note that when |
|
The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount. |
|
Metadata associated with the account. |
|
Notes for the account. |
|
A code that uniquely identifies the account. |
|
The current account overdue balance. |
|
Files attached to this account. |
|
Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports |
|
A list displaying the payment forecast for an account. The list starts from today's date (inclusive). Deprecated The 'paymentForecast' field is deprecated. |
|
The payment instructions of the account. |
|
The payment plans that have been created for this account. |
|
The schedules that describe how we would expect to take payments for an account on a given month. |
|
The payments made into an account from a payment instruction. |
|
The portfolio this account is linked to. |
|
The language that the account preferred for communications. |
|
Properties linked to the account now and in the future. |
|
Fetch a specific property linked to the 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. |
|
List of billing address lines. |
|
The current status of the account. |
|
Fetch transactions that have taken place on the account. |
|
Unique reference number from a 3rd party enrolment. |
|
Example
{
"id": "59350206",
"number": "size-write-popular-single-choose",
"status": "PENDING",
"paymentSchedules": PaymentScheduleConnectionTypeConnection,
"users": AccountUserType,
"complaints": ComplaintConnectionTypeConnection,
"brand": "line-minute-on-summer-job",
"balance": 73,
"overdueBalance": 94,
"urn": "miss-tough-camera-black-explain",
"billingName": "go-long-pass-part-image",
"billingSubName": "knowledge-reveal-wind-drop-TV",
"billingEmail": "street-spring-body-front-century",
"billingAddress": "protect-worker-central-court-why",
"billingAddressLine1": "some-budget-today-art-much",
"billingAddressLine2": "him-art-modern-black-science",
"billingAddressLine3": "choice-rise-art-compare-listen",
"billingAddressLine4": "out-skill-air-view-alone",
"billingAddressLine5": "too-fly-defense-factor-think",
"billingAddressPostcode": "hot-hair-father-reach-rule",
"billingCountryCode": "suddenly-develop-ball-can-term",
"billingDeliveryPointIdentifier": "64997767",
"splitBillingAddress": ["direction-care-woman-media-much"],
"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": 84,
"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": "cut-seek-owner-window-ability",
"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": "1970-09-05T18:43:10.980772+00:00",
"preferredLanguageForComms": "she-state-feeling-believe-service",
"consents": ConsentType,
"reminders": AccountReminderConnectionTypeConnection,
"properties": [PropertyType],
"marketSupplyAgreements": AgreementConnection,
"canModifyPayments": CanModifyPaymentsType,
"projectedBalance": 23,
"shouldReviewPayments": true,
"recommendedBalanceAdjustment": 90,
"electricityAgreements": [ElectricityAgreementType],
"gasAgreements": [GasAgreementType],
"warmHomeDiscount": WarmHomeDiscount,
"eligibilityForWarmHomeDiscount": WarmHomeDiscountEligibility,
"billingPostcode": "drop-memory-tree-pretty-program",
"canRenewTariff": true,
"trackerTariffDailyPricing": TrackerTariffDailyPricing,
"paymentAdequacy": PaymentAdequacyType,
"smets2Interest": "PRIORITY",
"smets2RefusalReason": "SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME",
"greenAccomplishments": GreenAccomplishmentsType,
"canChangePayments": true,
"cotReadingWindowDays": 46,
"canBeWithdrawn": true,
"currentEstimatedSsd": "1976-11-16",
"earliestPossibleSsd": "1977-06-02",
"latestPossibleSsd": "2009-07-08",
"operationsTeam": OperationsTeamType,
"canInputMeterReadingsViaIvr": true,
"hasActiveDunningProcess": true,
"hasActiveCollectionsProceedings": true,
"isEligibleForElectricityReadingIncentive": true,
"isEligibleForGasReadingIncentive": true,
"isInBlockingMigration": true
}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": 243.84,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED",
"smsOptInLastChangeDate": "2011-02-26T08:29:04.889825+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": 71,
"edgeCount": 60
}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": "final-expect-nothing-individual-every"
}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": "real-town-truth-true-under",
"value": "perhaps-main-can-will-lawyer",
"isSensitive": true
}AccountUserPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
|
The short name of the permission. |
Example
{
"permission": "difference-blue-usually-against-recent"
}AccountUserRoleType
The role a user has in association with one account.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
The account role. |
|
Example
{
"id": "72452803",
"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. |
|
|
|
Whether this user is active. |
|
Designates whether this user is deceased. |
|
True if user is linked to an account with an active hardship agreement. |
|
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": "35093408",
"number": "page-moment-professional-they-attorney",
"accounts": AccountInterface,
"givenName": "Michael",
"familyName": "Johnston",
"email": "enjoy-idea-development-condition-situation",
"mobile": "item-fire-reduce-organization-effort",
"landline": "relationship-community-base-past-other",
"title": "work-join-side-know-American",
"pronouns": "glass-I-world-if-someone",
"isDeceased": true,
"liveSecretKey": "share-per-actually-matter-eye",
"createdAt": "1986-11-27T08:40:41.082061+00:00",
"portfolios": PortfolioConnectionTypeConnection,
"address": RichAddressType,
"dateOfBirth": "1997-03-25",
"label": "cost-sign-group-which-upon",
"isActive": true,
"details": [AccountUserDetailType],
"permissions": [AccountUserPermission],
"displayName": "agency-station-medical-data-without",
"firstName": "bar-civil-someone-would-yeah",
"lastName": "mind-matter-forward-want-high",
"fullName": "number-represent-ahead-option-through",
"preferredName": "should-hard-sit-station-attorney",
"portfolioId": "92961295",
"portfolioIds": ["71075088"],
"businesses": BusinessConnectionTypeConnection,
"specialCircumstances": SpecialCircumstancesType,
"preferences": AccountUserCommsPreferences,
"landlinePhoneNumber": "sound-property-east-laugh-pull",
"alternativePhoneNumbers": ["eye-cause-behavior-address-stock"],
"hasFamilyIssues": true,
"isInHardship": true,
"accountUserRoles": [AccountUserRoleType],
"portfolioUserRoles": [PortfolioUserRoleType],
"consents": ConsentType,
"paymentMethods": PaymentInstructionConnectionTypeConnection,
"holdMusicChoices": [TrackOptionType],
"isOptedInToWof": true
}Fields
| Name | Description |
|---|---|
|
Username of the Actor. |
Example
{
"username": "time-stage-knowledge-at-from"
}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
}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": "37502027"
}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]
}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": "another-chance-only-leave-as",
"postcode": "market-character-then-between-something",
"countryCode": "light-history-discover-action-beautiful",
"line2": "all-much-drop-cultural-story",
"line3": "use-market-medical-ever-account",
"line4": "democratic-health-now-indicate-phone",
"line5": "including-drop-travel-energy-already"
}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": "peace-similar-test-food-record",
"bucket": "speak-over-population-level-condition",
"fields": {"key": "value"},
"preSignedUrl": "paper-piece-husband-property-explain"
}AffiliateLinkType
Affiliate link for the organization.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Affiliate Organisation. |
|
|
|
Example
{
"id": "18090352",
"organisation": AffiliateOrganisationType,
"subdomain": "large-could-dinner-wish-effect",
"trainingStatus": "NOT_APPLICABLE",
"isBusiness": true,
"contactName": "serious-difference-but-forward-only",
"contactEmail": "report-shoulder-several-add-material",
"landingUrl": "prepare-remain-owner-economy-sound"
}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": "92891708",
"name": "owner-challenge-might-pick-good",
"contactEmail": "brother-commercial-during-down-garden",
"canRenewTariffs": true,
"defaultAccountType": "BUSINESS",
"allowAlternativePaymentMethods": true,
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"canUseIvrSupportApi": true,
"skipMeterPointAddressValidation": true,
"salesChannel": "DIRECT",
"salesChannelCode": "take-place-write-order-rich",
"isFieldSalesOnlyProduct": true
}AffiliateSessionType
A tracked session for the affiliate link.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
Affiliate Link. |
|
|
|
Example
{
"id": "36811690",
"ipAddress": "accept-main-past-difference-bill",
"userAgent": "call-senior-situation-area-spring",
"queryParams": {"key": "value"},
"link": AffiliateLinkType
}Fields
| Name | Description |
|---|---|
|
The datetime when the agreement was agreed. |
|
The earliest date that can legally be set as the last day of supply for this agreement, based on minimum term and notice period. |
|
The annual consumption given by the customer in kWh. |
|
The estimated monthly bill in €. |
|
|
|
Whether the agreement is active. |
|
Whether the agreement is affected by the price brakes. |
|
Whether the agreement is revoked. |
|
Whether the agreement is terminated. |
|
The monthly standing charge in €. Deprecated The 'monthlyStandingCharge' field is deprecated. |
|
The net monthly standing charge in €. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
A list of gross rate information which is relevant to the standing charge (€/month). |
|
Quarter hourly unit rate forecast for today and tomorrow. Note that this is only available for dynamic electricity agreements. |
|
A list of the gross rate information which is relevant to the unit rate (ct/kWh). Deprecated The 'unitRateGrossRateInformation' field is deprecated. |
|
The unit rate information. |
|
The unit rate per kWh in €. Deprecated The 'unitRatePerKwh' field is deprecated. |
|
The datetime when the agreement is valid from. |
|
The datetime when the agreement is valid to. |
Example
{
"id": "92630305"
}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": 99,
"edgeCount": 64
}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": "high-agree-reality-whose-allow"
}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": 12683591,
"transactionType": "CREDIT",
"transactionAmount": 2,
"allocationAmount": 30,
"allocationReason": "partner-western-these-song-decade"
}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": 78,
"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": "93390141",
"repaymentIntervention": RepaymentInterventionType
}AlreadyLinkedError
Returned when an account already has a LINE account linked to it.
Fields
| Name | Description |
|---|---|
|
The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}AmendPayment
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-3970: The account cannot amend payments.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}AnimationType
A media element containing an animation, such as a Lottie.
Fields
| Name | Description |
|---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
The horizontal alignment of the media. |
|
Unique identifier of the object. |
|
The resource URL of the media. |
|
The name of the object's type. |
|
The measurement of the element. |
Example
{
"width": ItemSizeType,
"mediaUrl": "anyone-home-each-best-project",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "start-member-position-total-put",
"id": "39458841",
"typename": "choice-bag-final-reveal-tend"
}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": 70,
"edgeCount": 79
}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": "last-give-evidence-cup-thus"
}AnnualStatementType
Annual statements that are sent to the account. They summarize important information about usage and tariffs.
Example
{
"periodStartsAt": "1983-06-07T01:31:08.845792+00:00",
"periodEndsAt": "2014-06-15T05:17:39.584935+00:00",
"id": "46217489",
"pdfUrl": "response-maintain-than-last-dark"
}AnnulOrder
Annul an order before a supply start date exists and send confirmation email to the customer.
The possible errors that can be raised are:
- KT-CT-4923: Unauthorized.
- KT-CT-4922: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Whether the order annulment was successful. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"orderAnnulled": true
}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": 38807782,
"annulledBillingDocumentId": 97534862,
"firstIssued": "2017-01-13T15:07:04.534303+00:00",
"pdfUrl": "late-traditional-front-often-name"
}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": 24,
"edgeCount": 3
}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": "throughout-huge-himself-important-chance"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Post town |
|
County |
|
|
|
|
|
|
|
|
|
|
|
The location accuracy level in meters |
|
|
|
|
|
A list of outcomes associated with the app session. |
|
|
|
|
|
|
|
|
|
|
|
Example
{
"startedAt": "1981-09-06T01:46:23.025021+00:00",
"stoppedAt": "1980-12-29T11:30:45.207976+00:00",
"addressLine1": "notice-call-feeling-reason-continue",
"addressLine2": "deal-already-offer-deal-old",
"addressLine3": "ago-make-offer-wife-nice",
"addressLine4": "act-leader-government-Democrat-seat",
"addressLine5": "pay-claim-movie-kid-woman",
"id": "324af9e3-2583-476b-b4c4-14ca3819c1f9",
"link": AffiliateLinkType,
"isArchived": true,
"postcode": "teach-why-several-nearly-wide",
"account": AccountType,
"locationAt": "2003-10-13T03:48:34.291592+00:00",
"locationHorizontalAccuracy": 18,
"locationLatitude": "1.0",
"locationLongitude": "1.0",
"salesMode": "DOOR",
"type": AppSessionType,
"createdAt": "1972-05-03T05:42:35.416347+00:00",
"updatedAt": "1998-02-02T20:13:34.432420+00:00",
"outcomes": [OutcomeType]
}ApproveRepayment
The possible errors that can be raised are:
- KT-CT-3934: Repayment request already approved.
- KT-CT-3935: Repayment request cannot be paid.
- KT-CT-3959: Unauthorized.
- KT-CT-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": "capital-somebody-smile-person-improve",
"isPaused": true
}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": "63630955"
}Fields
| Name | Description |
|---|---|
|
The ID of the assigned user. |
|
The username of the assigned user. |
Example
{
"id": "62402283",
"username": "speak-stay-film-fire-many"
}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": "risk-pattern-though-usually-performance",
"activeFrom": "2013-01-21",
"activeTo": "1992-01-06"
}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": "could-watch-participant-current-style",
"itemId": "17022082"
}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": "53178208",
"filename": "something-year-decision-event-human",
"temporaryUrl": "involve-peace-road-skill-behavior"
}Fields
| Name | Description |
|---|---|
|
The app session associated with this audio recording. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "954f4ece-cd8a-4535-b472-4710e7736fa5",
"appSession": AppSessionType,
"contentType": "talk-class-nearly-line-son",
"duration": 530.54,
"fileSize": 98,
"startedAt": "2003-11-24T13:11:22.438085+00:00",
"stoppedAt": "1997-08-25T09:35:20.282537+00:00",
"s3Bucket": "site-director-black-try-partner",
"s3Key": "myself-behind-practice-dog-stage",
"createdAt": "2006-10-10T15:31:25.582804+00:00",
"updatedAt": "1984-11-16T05:18:30.212333+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": "13848833",
"redirectUri": "rich-piece-sea-physical-admit",
"authorizationUri": "especially-information-three-focus-on"
}Fields
| Name | Description |
|---|---|
|
The client ID of the application. |
|
The name of the application. |
Example
{
"name": "change-land-its-impact-per",
"clientId": "22430197"
}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": 48,
"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": "sell-culture-raise-war-glass",
"id": "14971543",
"typename": "western-behavior-ability-environment-place",
"eventId": "82295487",
"params": BackendScreenParam
}BackendScreenParam
A key-value pair (both Strings) which is passed as a parameter to a screen.
Example
{
"key": "thing-court-alone-sport-site",
"value": "experience-prevent-quality-wide-hold"
}Fields
| Name | Description |
|---|---|
|
Indicates whether the provided bank details are valid. |
|
Provides additional information about validation result. |
Example
{
"areValid": true,
"message": "become-choice-throw-health-fly"
}Fields
| Name | Description |
|---|---|
|
Get the account holder name of the client's bank account. |
|
Get the name of the client's bank. |
|
Get the BIC/SWIFT code for the client's bank account. |
|
Get the IBAN of the client's bank account. |
|
Get the payment reference the customer should use to transfer monies. The possible errors that can be raised are:
|
Example
{
"accountHolder": "hand-grow-check-reflect-positive",
"iban": "rather-their-newspaper-me-follow",
"bic": "performance-really-example-country-north",
"bankName": "wait-fill-say-soon-it",
"paymentReference": BankTransferReference
}Fields
| Name | Description |
|---|---|
|
Get bank transfer payment reference for customer, based on the ledger they transfer monies for. |
Example
{
"reference": "simple-care-a-skin-than"
}Fields
| Name | Description |
|---|---|
|
The meter id this reading belongs to. |
|
|
|
|
|
|
|
|
|
Example
{
"value": "firm-trade-property-up-process",
"readAt": "2021-11-03T00:27:05.600436+00:00",
"registerObisCode": "reduce-cold-talk-those-score",
"typeOfRead": "set-until-protect-to-account",
"origin": "campaign-from-south-character-nor",
"meterId": 59188653
}Fields
| Name | Description |
|---|---|
|
The maximum state of charge (soc) %. |
|
The minimum state of charge (soc) %. |
Example
{
"minimumSocPercentage": 19,
"maximumSocPercentage": 82
}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": "28007591",
"deviceType": "BATTERIES",
"provider": "BYD",
"params": BatteryParamsType,
"deviceStatus": DeviceStatusType,
"chargingPreferences": BatteryChargingPreferencesType
}Fields
| Name | Description |
|---|---|
|
ID of the battery variant. |
Example
{
"variantId": "65879188"
}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": "31643970",
"model": "decide-between-anything-administration-behavior",
"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": "visit-teach-simply-per-very",
"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": "why-significant-culture-current-way",
"displayName": "yourself-put-before-floor-east",
"description": "share-sometimes-kind-also-maybe",
"identifier": "24291072",
"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": "guy-policy-fall-middle-better",
"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": "institution-rest-by-performance-end",
"validFrom": "1999-06-06T03:26:08.685807+00:00",
"validTo": "1985-03-31T05:41:01.890700+00:00",
"supplyPointIdentifier": "33484478"
}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": "71913517",
"postedDate": "1973-06-10",
"createdAt": "1995-10-22T21:16:14.379257+00:00",
"amounts": TransactionAmountType,
"title": "cultural-then-series-still-investment",
"note": "name-miss-result-decide-service",
"reasonCode": "everything-resource-not-production-factor",
"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": 62,
"edgeCount": 73
}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": "ball-discussion-government-door-memory"
}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": "51189540",
"postedDate": "1998-11-10",
"createdAt": "1985-06-09T04:02:23.555886+00:00",
"amounts": TransactionAmountType,
"title": "program-hour-stuff-hotel-forward",
"note": "science-everyone-short-whole-culture",
"reasonCode": "not-affect-option-example-already"
}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": "apply-green-hard-single-when",
"displayName": "who-child-different-suddenly-others",
"description": "foot-group-particularly-certain-purpose",
"identifier": "92542813",
"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": "75134617",
"postedDate": "1973-03-03",
"createdAt": "2025-12-23T22:39:16.345976+00:00",
"amounts": TransactionAmountType,
"title": "economy-establish-value-whom-analysis",
"note": "fish-improve-especially-right-president",
"reasonCode": "away-pick-office-produce-avoid"
}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": "81699776",
"postedDate": "2014-01-25",
"createdAt": "2012-02-15T02:25:59.290453+00:00",
"amounts": TransactionAmountType,
"title": "budget-music-big-artist-girl",
"note": "game-student-campaign-few-medical",
"reasonCode": "other-buy-activity-hour-range"
}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": 43,
"edgeCount": 46
}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": "yet-democratic-just-offer-majority"
}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": "stay-data-brother-half-lot",
"version": 15,
"temporaryUrl": "fund-put-set-few-away",
"temporaryUrlExpiresAt": "1997-11-12T15:26:35.107602+00:00",
"filename": "science-federal-security-message-message"
}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": 6,
"edgeCount": 59
}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": "ahead-quickly-fast-pass-red"
}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": 71,
"edgeCount": 46
}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": "somebody-social-week-high-about"
}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": "list-official-hospital-chair-without",
"temporaryUrlExpiresAt": "2013-11-25T02:15:13.242993+00:00",
"filename": "special-strong-near-least-rise"
}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": "call-manager-I-another-part",
"displayName": "anything-behind-significant-side-guess",
"description": "picture-dinner-product-market-represent",
"identifier": "63192988",
"isVariable": true,
"frequency": "again-big-add-fight-oil",
"periodStartDay": 26,
"periodStartMonth": 96,
"multiplier": 2
}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": "2007-06-22",
"expectedAmount": 36,
"remainingAmount": 11,
"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": 25,
"periodLength": "MONTHLY",
"periodLengthMultiplier": 70,
"isFixed": true,
"currentBillingPeriodStartDate": "2017-05-24",
"currentBillingPeriodEndDate": "1988-01-13",
"nextBillingDate": "2022-04-07"
}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": "10126696",
"repaymentIntervention": RepaymentInterventionType
}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": 25,
"edgeCount": 68
}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": "choose-ever-per-member-teacher"
}Fields
| Name | Description |
|---|---|
|
The key of the business detail. |
|
The value of the business detail. |
Example
{
"key": "form-official-quite-newspaper-really",
"value": "level-cut-clear-happen-over"
}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": "63810576",
"segment": SegmentType,
"startAt": "2011-06-28T04:37:41.197014+00:00",
"endAt": "2008-02-09T14:49:02.296099+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": "47602616",
"name": "seven-me-you-century-scientist",
"number": "establish-explain-cup-writer-me",
"businessType": "SOLE_TRADER",
"sectors": None,
"details": [BusinessDetailType],
"billingAddress": RichAddressType,
"legalAddress": RichAddressType,
"linkedAccountNumber": "A-879897F6",
"linkedAccountNumbers": "14778033",
"segmentName": "care-foot-walk-cell-former",
"paymentMethods": PaymentInstructionConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
The key of the call metadata item. |
|
The value of the call metadata item. |
Example
{
"key": "partner-environmental-cell-case-store",
"value": "work-ball-door-Democrat-window"
}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": 26,
"edgeCount": 95
}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": "truth-western-decade-realize-modern"
}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": "32335459",
"name": "win-while-another-blue-mouth",
"isActive": true
}Fields
| Name | Description |
|---|---|
|
Whether or not the account can amend payments. |
|
Whether or not the account can cancel payments. |
Example
{
"canAmendPayments": true,
"canCancelPayments": true
}CancelContract
Cancelling a contract for a given supply point and send confirmation email to the customer.
Fields
| Name | Description |
|---|---|
|
Whether the contract cancellation was successful. |
|
The last day of supply. |
Example
{
"cancelledContract": true,
"lastDayOfSupply": "1998-10-03"
}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": "38326702",
"status": "REQUESTED"
}CancelSmartFlexOnboarding
Cancel onboarding of a device with SmartFlex.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}CardComponentType
A card containing a list of items
Fields
| Name | Description |
|---|---|
|
Whether the element is hidden from view. |
|
Accessible description of the element. |
|
Unique identifier of the object. |
|
The list of components. |
|
The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "size-return-first-tend-story",
"id": "67170578",
"typename": "interesting-report-difficult-body-add",
"items": CardItemType
}Fields
| Name | Description |
|---|---|
|
The list of cards. |
|
Unique identifier of the object. |
|
The name of the object's type. |
Example
{
"id": "57084105",
"typename": "enough-create-push-church-green",
"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": "13323393",
"internalName": "point-can-lay-figure-option",
"customerName": "star-after-rock-community-lot",
"customerDescription": "offer-difficult-current-authority-common",
"code": "learn-sort-protect-be-apply",
"marketName": "check-home-perhaps-crime-office",
"sourceProductType": "SUPPLY",
"tags": [TagType]
}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": "month-perform-hear-would-occur",
"displayName": "phone-form-detail-sing-consumer",
"description": "again-choose-watch-increase-teacher",
"identifier": "82535869",
"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": "such-toward-stand-help-station",
"name": "personal-religious-trip-firm-hotel",
"description": "finally-plan-there-try-body",
"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 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": "60392522",
"postedDate": "2009-07-08",
"createdAt": "2016-01-21T21:30:47.449561+00:00",
"accountNumber": "A-89EC8C74",
"amount": 42,
"amounts": TransactionAmountType,
"balanceCarriedForward": 72,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "evening-while-turn-society-behavior",
"billingDocumentIdentifier": "51504790",
"statementId": "84705563",
"isReversed": true,
"hasStatement": true,
"note": "clear-its-name-factor-owner",
"reasonCode": "word-recognize-why-follow-what",
"consumption": Consumption,
"detail": ChargeDetail,
"isExport": true
}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": 89503087,
"model": "other-fight-ground-boy-girl",
"powerInKw": "1.0",
"amperage": 78,
"isIntegrationLive": true,
"integrationStatus": "INTERNAL_TESTING"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"make": "pass-past-small-just-thing",
"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": "whole-foreign-argue-pull-face",
"display": "listen-both-perhaps-look-concern",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "else-character-number-set-country"
}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": 31,
"edgeCount": 68
}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": "store-TV-small-yes-probably"
}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": "2008-06-05",
"periodEnd": "1990-03-13",
"charge": 21
}CheckResultType
GraphQL type for check result.
Fields
| Name | Description |
|---|---|
|
Additional context about the check. |
|
Name of the check. |
|
Status of the check. |
Example
{
"name": "anyone-moment-story-story-spring",
"status": "PASSED",
"context": "edge-amount-sound-nice-evidence"
}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": "indeed-those-half-other-space",
"id": "67530394",
"typename": "whom-set-fine-share-note",
"accessibilityHidden": true,
"accessibilityLabel": "reach-heart-wear-early-way"
}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": "unit-seek-door-seek-exactly",
"displayName": "back-research-will-their-say",
"description": "reason-picture-wind-painting-news",
"identifier": "48242754",
"isVariable": true,
"amount": 90,
"reason": "anything-final-hope-money-toward",
"interestPolicy": "speak-job-today-everybody-front"
}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": "1988-12-11"
}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
}Fields
| Name | Description |
|---|---|
|
The description of the collection. |
|
The fields of the collection. |
|
The name of the collection. |
|
The order of the collection. |
Example
{
"name": "wife-marriage-trial-number-employee",
"description": "difficult-lose-pattern-policy-nation",
"order": 59,
"fields": [FunnelField]
}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": "world-behind-agent-crime-affect",
"isPaused": true,
"isComplete": true,
"isActive": true,
"completionType": "western-next-water-analysis-small",
"associatedItems": [CollectionProcessRecordAssociatedItemType],
"pausedDays": 30
}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": "player-soon-herself-wall-election",
"reason": "night-interview-where-husband-use",
"pausedAt": "1995-09-18T22:20:07.920572+00:00",
"resumedAt": "2013-12-03T16:00:25.381961+00:00",
"resumedReason": "several-defense-shoulder-imagine-responsibility"
}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": "magazine-past-office-nice-far",
"itemReference": "partner-clear-somebody-try-rise",
"occurredAt": "2006-03-27T18:11:24.533164+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": "40675022",
"billType": "STATEMENT",
"fromDate": "2006-04-02",
"toDate": "1972-09-25",
"temporaryUrl": "item-concern-whatever-federal-role",
"issuedDate": "2018-02-25",
"attachments": BillingAttachmentConnectionTypeConnection,
"constituents": ConstituentConnection
}Fields
| Name | Description |
|---|---|
|
Information about the current state of the rate limiting for rate limited fields at the time of the request. |
|
Information about points-allowance rate limit for viewer. |
Example
{
"pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation,
"fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection
}CommenceDCAProceeding
The possible errors that can be raised are:
- KT-CT-11606: Debt Collection Agency cannot use campaign.
- KT-CT-11601: Cannot start collection proceeding, proceeding for this account already exists.
- KT-CT-11602: Could not find DCA with that name.
- KT-CT-11607: Invalid ledger number for debt collection proceeding.
- KT-CT-11608: Ledger does not belong to account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the commencement could be applied. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
}Fields
| Name | Description |
|---|---|
|
|
|
The datetime the agreement was entered. |
|
The datetime the agreement was terminated. |
|
|
|
Whether the agreement is currently active. |
|
Whether the agreement is revoked. |
|
The product associated with the agreement. |
|
The agreement's supply point. |
|
|
|
|
|
Example
{
"id": "92461615",
"validFrom": "2013-04-12T11:18:20.159978+00:00",
"validTo": "1988-09-06T03:35:41.498572+00:00",
"agreedAt": "1994-07-06T05:45:01.771053+00:00",
"terminatedAt": "1990-02-27T04:10:25.815441+00:00",
"supplyPoint": SupplyPointType,
"product": SupplyProductType,
"isActive": true,
"agreedFrom": "2023-11-03T21:48:54.867633+00:00",
"agreedTo": "1992-11-27T22:55:22.927379+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": 28,
"edgeCount": 5
}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": "story-great-us-avoid-identify"
}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": 10,
"edgeCount": 95
}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": "fear-form-when-return-feeling"
}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": "factor-such-final-professional-woman",
"actionTaken": "body-morning-play-control-them",
"status": "challenge-country-piece-when-for",
"createdAt": "2000-01-19T10:04:19.486684+00:00",
"mobile": "song-current-cultural-admit-the",
"email": "work-identify-provide-middle-suddenly",
"landline": "store-window-soldier-garden-crime",
"preferredCommunicationMethod": "light-study-remain-buy-cover",
"summary": "age-simply-strong-memory-water"
}Fields
| Name | Description |
|---|---|
|
Complaint Assignee. |
|
Complaint contacts. |
|
Complaint creation date. |
|
|
|
Complaint resolution date. |
|
Complaint subtype. |
|
Complaint type. |
Example
{
"id": "90017347",
"contacts": ComplaintContactConnectionTypeConnection,
"type": "information-nation-three-several-southern",
"subtype": "beyond-lead-behavior-like-thing",
"creationDate": "2011-04-14",
"resolutionDate": "1980-03-26",
"assigneeId": "87095849"
}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
}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": "cell-myself-together-record-hold",
"id": "39862504",
"typename": "hand-stage-among-may-pattern",
"name": "according-item-anything-too-him",
"refreshFrequency": 58,
"screenData": "force-art-foot-education-help",
"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
}Fields
| Name | Description |
|---|---|
|
The code of the consent type. |
|
The value to update the consent to. |
Example
{
"code": "road-out-production-training-build",
"value": "start-ability-shake-do-prevent"
}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": "image-husband-option-paper-source",
"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": "enter-discussion-side-maybe-message",
"description": "good-find-probably-suddenly-card",
"name": "provide-between-us-remain-alone",
"defaultValue": "ACCEPTED"
}ConstituentConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConstituentEdge,
"totalCount": 65,
"edgeCount": 68
}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": "wish-simple-name-center-doctor"
}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-07-19",
"endDate": "1987-10-10",
"quantity": "1.0",
"unit": "kWh",
"usageCost": 21,
"supplyCharge": 55
}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": 8,
"edgeCount": 96
}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": "kind-test-think-drive-western"
}Fields
| Name | Description |
|---|---|
|
Charges grouped per displayed period. |
|
Name of the market the charges are for. |
Example
{
"marketName": "born-try-range-ready-church",
"charges": ChargesBreakdownConnectionTypeConnection
}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": "84977520",
"title": "understand-front-matter-southern-inside",
"party": ContractParty,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "2018-03-17T18:30:58.993361+00:00",
"validTo": "2020-02-22T14:50:01.346229+00:00",
"signedAt": "2019-11-20T16:33:54.865128+00:00",
"cancelledAt": "2013-11-23T06:34:09.488341+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": "not-organization-professor-page-dark",
"status": "IN_PROGRESS",
"contractDetails": ContractDetails,
"journeyType": "CONTRACT_CREATION",
"requestedAt": "1995-08-21T08:49:14.810688+00:00",
"orderReference": "not-mission-tough-beautiful-more",
"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": "71928264",
"title": "interest-mean-serve-season-region",
"party": ContractParty,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "1984-06-13T06:51:46.372047+00:00",
"validTo": "2000-10-09T04:52:14.300979+00:00",
"signedAt": "1970-12-15T23:53:57.282979+00:00",
"cancelledAt": "1991-01-06T03:58:24.781621+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": "happy-cup-line-practice-against",
"displayName": "own-machine-important-at-all",
"description": "real-able-catch-common-use",
"identifier": "13243130",
"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": "person-arrive-stand-certainly-force"
}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": 82,
"effectiveFrom": "1985-05-05T05:42:23.359646+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": "resource-social-under-great-issue",
"displayName": "thank-class-site-administration-far",
"description": "line-several-evening-about-language",
"identifier": "14703603",
"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": "picture-summer-character-sport-range",
"marketName": "language-business-stand-enough-each",
"validFrom": "2022-07-22T21:19:26.148517+00:00",
"validTo": "2010-05-04T04:15:20.507744+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": "64940257",
"contributionScheme": ContributionSchemeType,
"interval": "MONTHLY",
"activeFrom": "2020-10-27T23:35:58.201326+00:00",
"activeTo": "2009-12-02T23:05:40.560241+00:00",
"amount": 47,
"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": 11,
"edgeCount": 100
}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": "purpose-attack-authority-continue-tree"
}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": "87346369",
"agreement": ContributionAgreementType,
"fulfilledAt": "2005-09-20T12:36:25.985197+00:00",
"periodFrom": "2000-03-18T09:21:51.381257+00:00",
"periodTo": "1981-03-18T19:44:26.919466+00:00"
}ContributionSchemeType
A single Contribution Scheme.
Fields
| Name | Description |
|---|---|
|
Is this scheme currently accepting contributions? |
|
|
|
|
|
|
|
Are contributions to this scheme taxable? |
Example
{
"id": "67651019",
"code": "talk-lawyer-near-series-draw",
"displayName": "history-discover-day-system-discuss",
"taxable": true,
"acceptingContributions": true
}Example
{
"latitude": 982.71,
"longitude": 106.77
}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": "7d5888da-532d-4fb1-add7-bd2b7c6a7db1",
"jobType": "religious-current-well-along-baby",
"appointmentDate": "2004-10-11",
"timeSlotStart": "06:17:35.374357",
"timeSlotEnd": "00:27:16.815536",
"createdAt": "2018-12-15T18:07:49.535657+00:00",
"status": "PENDING",
"externalReference": "chair-summer-them-occur-rise"
}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": 53,
"edgeCount": 9
}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": "himself-guy-pattern-trouble-crime"
}CoreSiteworksRequestType
A Siteworks Request
Fields
| Name | Description |
|---|---|
|
List of appointments linked to this request. |
|
|
|
|
|
|
|
List of supply points on request. |
|
|
|
Example
{
"id": "889f7490-e38d-4c34-86cd-09fe835244e5",
"status": "shake-student-something-data-claim",
"reason": "level-treat-teach-however-single",
"createdAt": "1992-02-05T05:31:05.111982+00:00",
"lastStatusUpdateAt": "1990-07-08T08:37:19.187611+00:00",
"appointments": [CoreSiteworksAppointmentType],
"marketSupplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Consumption in kWh. |
|
Cost in pence (excl. tax). |
|
Cost in pence (incl. tax). |
Example
{
"costOfChargeId": "63130299",
"krakenflexDeviceId": "40596492",
"reportDate": "2022-08-19",
"isSmartCharge": true,
"totalConsumption": 600.88,
"totalCostExclTax": 878.41,
"totalCostInclTax": 304.6
}CreateAPICall
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created APICall. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiCall": APICallType
}CreateAPIException
The possible errors that can be raised are:
- KT-CT-7801: Received an invalid operationsTeamId.
- KT-CT-7802: The external identifier already exists.
- KT-CT-7805: Too many tags associated with this API Exception.
- KT-CT-7806: Cannot create duplicate tags for the same API exception.
- KT-CT-7811: Received an invalid assignedUserId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created APIException. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}CreateAPIExceptionEvent
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created APIExceptionEvent. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiExceptionEvent": APIExceptionEventType
}CreateAPIExceptionNote
The possible errors that can be raised are:
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created APIExceptionNote. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}CreateAccountCharge
Add charges to an account.
The possible errors that can be raised are:
- KT-CT-5211: The charge reason with the requested code is deprecated.
- KT-CT-5212: The charge reason with the requested code does not exist.
- KT-CT-5213: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountCharge": AccountChargeType
}CreateAccountCredit
Add credits to an account.
The possible errors that can be raised are:
- KT-CT-5315: Invalid data.
- KT-CT-5314: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountCredit": AccountCreditType
}CreateAccountNote
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4180: Account note must be a valid string.
- KT-CT-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
}CreateAffiliateLink
Create an affiliate link for a new sales agent.
The possible errors that can be raised are:
- KT-CT-7711: Invalid data.
- KT-CT-7713: Invalid data.
- KT-CT-7714: Invalid data.
- KT-CT-7715: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created affiliate link. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateLink": AffiliateLinkType
}CreateAffiliateOrganisation
Create an affiliate organisation.
The possible errors that can be raised are:
- KT-CT-7716: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created affiliate organisation. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateOrganisation": AffiliateOrganisationType
}CreateAffiliateSession
Create a session for an affiliate link.
Fields
| Name | Description |
|---|---|
|
The created affiliate session. |
Example
{
"affiliateSession": AffiliateSessionType
}CreateAudioRecording
The possible errors that can be raised are:
- KT-CT-7720: Invalid S3 key format.
- KT-CT-7721: Link not found.
- KT-CT-7722: Invalid input for audio recording upload.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created audio recording. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"audioRecording": AudioRecordingType
}CreateBusiness
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11108: Invalid data.
- KT-CT-11109: Invalid data.
- KT-CT-11110: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created business. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"business": BusinessType
}CreateCallMetadata
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11806: Call metadata item key cannot be an empty string.
- KT-CT-11807: A call metadata item with this key already exists for this call.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The call metadata was attached to. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"call": CallInterface
}CreateCampaignItems
The possible errors that can be raised are:
- KT-CT-11501: Voice campaign not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-11503: One or more campaign items are invalid and cannot be created.
- KT-CT-11504: The batch of campaign items is too large.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The identifier for this batch of items to assist in tracking and logging. |
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignItems": [VoiceCampaignItemType],
"batchIdentifier": "52449375"
}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": "91711859"
}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": "2024-06-20T23:37:58.090941+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": 26
}CreateElectricityMeterReadings
The possible errors that can be raised are:
- KT-DE-6414: Invalid data.
- KT-DE-6411: Meter has no MaLo.
- KT-DE-6412: Meter reading submission failed.
- KT-DE-6413: An internal error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"readingDate": "1992-08-22",
"numberOfReadingsCreated": 33
}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
}CreateGasMeterReadings
The possible errors that can be raised are:
- KT-DE-6414: Invalid data.
- KT-DE-6411: Meter has no MaLo.
- KT-DE-6412: Meter reading submission failed.
- KT-DE-6413: An internal error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"readingDate": "2007-05-19",
"numberOfReadingsCreated": 24
}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": "68794775"
}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": "74332512"
}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-8932: Lead contact details missing legal contact.
- 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": "those-ground-worker-site-feel"
}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
}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": "meet-authority-edge-couple-fish",
"devicePhone": "apply-analysis-simple-indicate-few",
"totpSecret": "former-yourself-his-pick-through"
}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
}Example
{
"content": "meet-into-price-analysis-deep",
"id": "65219529"
}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": "80628808",
"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-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-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
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": "hear-soldier-yourself-stop-hot",
"dateOfCreation": "1998-01-24T14:20:35.655097+00:00",
"stage": "operation-per-difference-hit-in",
"funnelCode": "now-practice-action-begin-better"
}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": "budget-source-sound-leader-cut"
}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": "their-almost-research-foreign-buy",
"dateOfCreation": "2009-04-01T14:27:45.702447+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
}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": 3
}CreateProductOutput
Output type for creating a product.
Fields
| Name | Description |
|---|---|
|
The created product. |
Example
{
"product": SupplyProductType
}CreateQuoteForAccount
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
- KT-CT-4616: Unable to create a quote.
- KT-CT-4631: Unable to quote for the chosen market.
- KT-CT-4645: No supply point found belonging to the account for the provided identifier.
- KT-CT-4924: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Returns a quote request. |
Example
{
"possibleErrors": [PossibleErrorType],
"quoteRequest": MarketSupplyQuoteRequestType
}Fields
| Name | Description |
|---|---|
|
The session id of the affiliate. |
|
Code of the quote request that was generated. |
|
Details about the quoted electricity supply point. |
|
Details about the quoted gas supply point. |
|
The date and time when this quote was requested. |
Example
{
"code": "2d06e802-a232-4045-9504-44c5cbed623c",
"requestedAt": "2002-11-30T04:35:11.590229+00:00",
"affiliateSessionId": "78814934",
"electricitySupplyPoint": QuotedSupplyPointType,
"gasSupplyPoint": QuotedSupplyPointType
}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": 69
}CreateReminder
The possible errors that can be raised are:
- KT-CT-1401: Invalid data.
- KT-CT-1402: Unable to create account reminder.
- KT-CT-1403: Missing user or team assignee.
- KT-CT-1404: This reminder type is deprecated.
- KT-CT-1405: Both user and team assignee provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Account reminder. |
Example
{
"possibleErrors": [PossibleErrorType],
"reminder": Reminder
}CreateScheduledTransactions
Mutation to create scheduled transactions.
The possible errors that can be raised are:
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3830: Invalid action.
- KT-CT-3831: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"scheduledTransactions": [ScheduledTransactionType]
}CreateShellAccountPayload
Create a shell account (a billable account with no property/energy supply).
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Day to fixed bill on if 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-71B4023D",
"givenName": "Elizabeth",
"familyName": "Davis",
"billingName": "couple-create-force-kid-growth",
"email": "option-establish-call-conference-cup",
"mobile": "hold-reveal-spend-keep-owner",
"landline": "central-yet-station-only-class",
"brand": "six-experience-language-focus-prevent",
"dateOfBirth": "1988-03-10",
"billingAddressLine1": "past-next-challenge-result-agent",
"billingAddressLine2": "think-court-after-finish-policy",
"billingAddressLine3": "social-heart-like-most-record",
"billingAddressLine4": "least-him-music-surface-expert",
"billingAddressLine5": "affect-success-state-bag-threat",
"billingPostcode": "modern-try-group-by-beyond",
"billingRichAddress": "TV-party-team-hair-state",
"billingPeriodLength": "they-as-agree-live-board",
"billingPeriodMultiplier": 72,
"billingPeriodDay": 35,
"billingPeriodMonth": 93,
"isBusinessAccount": true,
"companyName": "result-game-night-teacher-scene",
"companyNumber": "environment-yet-conference-mouth-teacher",
"businessType": "method-miss-maybe-must-maybe",
"password": "citizen-single-bar-these-production",
"passwordUpdateToken": "purpose-those-particularly-worker-whether",
"urn": "line-line-thank-front-practice",
"errors": [ErrorType],
"account": AccountInterface,
"clientMutationId": "49961007"
}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": "one-herself-front-enough-then",
"productCode": "blue-debate-very-page-price",
"name": "billion-what-century-money-break",
"description": "call-wait-mother-particularly-direction",
"unit": "work-fund-happen-resource-left",
"periodSize": "pretty-network-statement-nation-life",
"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": "55513499",
"postedDate": "2025-05-02",
"createdAt": "2023-01-19T06:04:12.605411+00:00",
"accountNumber": "A-A7DC2AA6",
"amount": 69,
"amounts": TransactionAmountType,
"balanceCarriedForward": 100,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "lot-baby-including-wind-such",
"billingDocumentIdentifier": "55245151",
"statementId": "39854376",
"isReversed": true,
"hasStatement": true,
"note": "full-claim-process-member-already",
"reasonCode": "kind-may-her-become-usually"
}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": "animal-collection-work-look-officer",
"display": "measure-while-role-station-last",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "Democrat-nearly-choice-my-order"
}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": "pressure-walk-for-to-address",
"accountNumber": "A-11658B3F",
"validFrom": "1976-05-24T23:47:22.934538+00:00",
"validTo": "2023-06-24T18:23:17.305796+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": "teacher-instead-similar-whole-practice",
"accountNumber": "A-5EE25710",
"validFrom": "2012-06-03T10:31:52.000962+00:00",
"validTo": "1980-02-01T23:42:44.247480+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": ["group-effect-us-support-world"]
}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": 41,
"edgeCount": 6
}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": "push-address-claim-us-reflect"
}Fields
| Name | Description |
|---|---|
|
The unique identifier for the customer feedback form. |
|
The name of the customer feedback form. |
Example
{
"id": "64747886",
"name": "expert-while-marriage-commercial-over"
}Fields
| Name | Description |
|---|---|
|
|
|
The value attached to the source |
|
The datetime the feedback was submitted |
Example
{
"id": "76471597",
"rawScore": 45,
"submittedAt": "1984-04-05T07:25:25.286421+00:00"
}Fields
| Name | Description |
|---|---|
|
The account number. |
|
The ledger identifier. |
Example
{
"accountNumber": "A-A52F8860",
"ledgerNumber": "those-choose-those-give-every"
}Fields
| Name | Description |
|---|---|
|
The account number. |
|
The agency. |
|
The campaign. |
|
Whether the commencement could be applied. |
|
The ledger identifier. |
Example
{
"commencementStatus": true,
"accountNumber": "A-F5449B84",
"ledgerNumber": "research-would-good-operation-television",
"agency": "result-me-use-shake-though",
"campaign": "expert-best-respond-reduce-ok"
}Fields
| Name | Description |
|---|---|
|
The account number. |
|
Whether the update has been applied. |
Example
{
"commencementStatus": true,
"accountNumber": "A-CC884020"
}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": "96931009",
"typename": "agency-mouth-into-argue-save",
"dashboardItems": SectionType,
"serialisedDashboardItems": "purpose-cost-watch-mission-policy"
}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": "1990-04-27T00:24:10.163069+00:00",
"endCursor": "1997-08-01T01:59:28.991905+00:00",
"hasPreviousPage": true,
"hasNextPage": true
}DeauthenticateDevice
De-authenticate a registered device.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4350: Unable to de-authenticate device.
- KT-CT-4352: This device cannot currently be de-authenticated.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": DeviceDetailsType
}DeauthenticateFlexDevice
De-authenticate a registered device by device id.
The possible errors that can be raised are:
- KT-CT-4350: Unable to de-authenticate device.
- KT-CT-4352: This device cannot currently be de-authenticated.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": DeviceDetailsType
}Example
{
"name": "one-often-yard-business-floor",
"code": "minute-else-thing-poor-modern",
"isActive": true
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Example
{
"code": "painting-dream-build-big-model",
"displayName": "cup-create-worker-art-Republican",
"deprecatedAt": "1972-05-17T04:05:36.328235+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": "VULNERABLE_CUSTOMER",
"amount": 37,
"startedAt": "2022-01-10T03:14:33.164235+00:00",
"stoppedAt": "2015-12-11T13:43:13.120529+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": "2005-06-23T20:42:07.464506+00:00",
"value": "1.0"
}DecimalType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"decimalValue": "1.0"
}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": 95,
"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": "speech-catch-trial-information-front",
"id": "70491347",
"typename": "evening-child-chance-sell-pull",
"url": "newspaper-worker-recognize-fight-current"
}Fields
| Name | Description |
|---|---|
|
Annual standing charge in €. |
|
Specifies whether this tariff is green. GetAG considers a tariff as green if - it consists completely of renewables or combined heat and power (CHP), or - it consists of at most 50% CHP and the remainder is at least 50% renewables. |
|
Monthly standing charge in €. |
|
The start of the offer period of this tariff. |
|
The end of the offer period of this tariff. |
|
The name of the tariff. |
|
Total estimated annual bill in €. |
|
Total estimated monthly bill in €. |
|
Unit rate per kWh in €. |
|
The start of the validity period of this tariff. |
|
The end of the validity period of this tariff. |
Example
{
"tariffName": "enough-happen-hundred-stage-between",
"totalEstimatedAnnualBill": "1.0",
"totalEstimatedMonthlyBill": "1.0",
"annualStandingCharge": "1.0",
"monthlyStandingCharge": "1.0",
"unitRatePerKwh": "1.0",
"isGreen": true,
"offeredFrom": "2025-02-01",
"offeredTo": "2007-10-13",
"validFrom": "1979-12-22",
"validTo": "1977-08-31"
}Fields
| Name | Description |
|---|---|
|
The name of the default electricity supplier. |
|
The BDEW-assigned ID of the default supplier. |
|
Some of the tariffs that the default supplier offers. |
Example
{
"supplierName": "section-Republican-somebody-quality-no",
"supplierNumber": "animal-miss-role-economic-election",
"tariffs": DefaultElectricitySupplierTariffType
}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": "seven-again-career-happen-those",
"displayName": "again-fall-quite-long-bill",
"description": "society-sign-sound-suddenly-college",
"identifier": "54513639",
"isVariable": true,
"days": 10,
"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": "magazine-for-both-commercial-ahead"
}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": "campaign-response-different-personal-director",
"depositAmount": 57,
"acceptedAt": "2012-09-17T05:36:16.517777+00:00",
"fulfilledAt": "2015-11-10T17:29:42.926838+00:00",
"collectionDate": "1973-06-20",
"dueDate": "1971-07-20",
"returnStrategy": "wrong-piece-describe-adult-even",
"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": "2024-01-24",
"amount": 53,
"status": "doctor-whom-according-agency-option"
}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": "71867606",
"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": "2003-10-08T08:29:21.947470+00:00"
}Fields
| Name | Description |
|---|---|
|
The type of device. |
|
|
|
The third party that provides control over this device. |
Example
{
"krakenflexDeviceId": "18754303",
"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": "97137878"
}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": ["growth-rich-think-major-would"]
}Fields
| Name | Description |
|---|---|
|
Timestamp of the reading. |
|
Value of the reading. |
Example
{
"value": 719.68,
"timestamp": "2000-12-19T09:56:58.140431+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": 888.79,
"maxExportInKw": 760.22,
"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": 39,
"edgeCount": 45
}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": "voice-book-southern-inside-tree"
}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": 80,
"edgeCount": 79
}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": "teach-card-wear-rest-remain"
}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": "23374482",
"status": "at-common-open-movement-power",
"sortCode": "where-popular-open-add-at",
"iban": "rate-issue-inside-when-team",
"accountHolder": "human-act-look-early-possible",
"instructionType": "manager-character-radio-bank-week",
"cardPaymentNetwork": "treat-member-how-issue-single",
"cardExpiryMonth": 45,
"cardExpiryYear": 88,
"lastFourDigitsOfAccountNumber": "A-06BBFCAA",
"maskedAccountIdentifier": "91044184",
"maskedIban": "staff-treatment-fight-letter-stage",
"owners": [PaymentInstructionOwnerType]
}Fields
| Name | Description |
|---|---|
|
The discount as a decimal between 0 and 1. |
|
This type will return additional market specific information. For example, some markets support wind direction, fan speed, wind speed, etc. while others do not. |
|
Timestamp for the discount. |
Example
{
"startAt": "2013-01-19T22:36:32.254136+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-05-13T17:27:01.060647+00:00",
"data": ForecastData
}Fields
| Name | Description |
|---|---|
|
This field is replacing |
|
|
|
|
|
Shows the availability status of an integration. |
|
|
|
|
|
|
|
|
|
Example
{
"vehicleId": 72472614,
"model": "baby-crime-husband-someone-consider",
"year": 18,
"availableFrom": 17,
"availableTo": 43,
"batterySize": "1.0",
"supportedProviders": ["anything-gas-choice-future-member"],
"isIntegrationLive": true,
"integrationStatus": "INTERNAL_TESTING"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"make": "billion-friend-again-poor-read",
"models": [ElectricVehicleModelType]
}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": "18390780",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "29257685",
"deviceId": "28485474"
}ElectricityMeterConnectionTypeConnection
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": ElectricityMeterConnectionTypeEdge,
"totalCount": 91,
"edgeCount": 47
}ElectricityMeterConnectionTypeEdge
A Relay edge containing a ElectricityMeterConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ElectricityMeterType,
"cursor": "dream-popular-paper-imagine-decade"
}Fields
| Name | Description |
|---|---|
|
All registers relevant for billing for the meter. |
Example
{
"registers": [ElectricityRegisterForReadingType]
}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": 26,
"edgeCount": 65
}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": ElectricityMeterReadingType,
"cursor": "time-answer-heavy-old-require"
}Fields
| Name | Description |
|---|---|
|
The datetime when the meter was active from. |
|
The datetime when the meter stops being active. This should be null if it is still active. |
|
The conversion factor/Wandlerfaktor of the meter. |
|
The meter ID. |
|
The MeLo number associated with the meter. |
|
The metering direction of the meter. |
|
The meter number. |
|
The reading transmission type of the meter. |
|
The tariff count of the meter. |
Example
{
"id": "90215675",
"serialNumber": "line-out-article-form-head",
"requiresAccess": true,
"isDigital": true,
"installationDate": "2019-02-11",
"lastInspectionDate": "1986-10-27",
"createdAt": "1983-05-12T14:52:54.462013+00:00",
"updatedAt": "1972-03-25T01:34:17.575745+00:00",
"activeFrom": "1978-04-25",
"activeTo": "1992-04-02",
"meterPoint": ElectricityMeterPointType,
"location": "other-television-age-along-image",
"currentRating": 65,
"makeAndType": "manager-single-pass-piece-season",
"meterType": "CHECK",
"certificationDate": "2018-10-10",
"certifiedUntil": "2017-06-19",
"retrievalMethod": "people-owner-against-media-world",
"importMeter": ElectricityMeterType,
"exportMeters": ElectricityMeterTypeConnection,
"prepayLedgers": PrepayLedgersType,
"smartImportElectricityMeter": SmartMeterDeviceType,
"smartExportElectricityMeter": SmartMeterDeviceType,
"consumptionUnits": "reason-later-least-less-first",
"requiresCotFinalReading": true,
"fuelType": "likely-cut-plant-industry-enough",
"consumption": ConsumptionConnection,
"nodeId": "22968901",
"readings": ElectricityMeterReadingConnectionTypeConnection,
"registers": [ElectricityMeterRegisterType],
"hasAndAllowsHhReadings": true,
"smartDevices": [SmartMeterDeviceType],
"isTradPrepay": true,
"isReadyForTopup": true,
"isRts": true
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"totalNetworkChargesPerYear": "1.0",
"gridBillingChargeAnnual": "1.0",
"gridMeterOperationChargeAnnual": "1.0",
"gridMeterReadingChargeAnnual": "1.0",
"gridStandingChargeAnnual": "1.0",
"kwkChargeAnnual": "1.0",
"breakdownChargeAnnual": "1.0",
"eegChargeAnnual": "1.0",
"gridConcessionChargeAnnual": "1.0",
"gridConcessionChargeAnnualNt": "1.0",
"offshoreChargeAnnual": "1.0",
"section19ChargeAnnual": "1.0",
"gridUnitRateHtChargeAnnual": "1.0",
"gridUnitRateNtChargeAnnual": "1.0"
}Fields
| Name | Description |
|---|---|
|
The date from when the register is active. |
|
The date until when the register is active. |
|
The number of decimal places on the register. |
|
The number of digits on the register. |
|
The OBIS code of the register. |
|
The readings for a given register, in reverse order (latest first). This field is a connection type. Connections are used to implement cursor based pagination. This field requires the |
|
Example
{
"obisCode": "smile-turn-responsibility-I-recent",
"digits": 18,
"decimalPlaces": 89,
"activeFrom": "2019-05-02",
"activeTo": "2020-01-01",
"readings": RegisterReadingConnectionTypeConnection,
"registerType": "fly-outside-see-future-per"
}Fields
| Name | Description |
|---|---|
|
The meter id this reading belongs to. |
|
|
|
|
|
|
|
|
|
|
|
Example
{
"value": "face-continue-this-sport-behavior",
"readAt": "1975-12-26T02:33:59.337880+00:00",
"registerObisCode": "agent-let-prove-care-never",
"typeOfRead": "with-machine-education-by-before",
"origin": "economy-official-over-bit-forward",
"meterId": 27018015,
"registerType": "world-once-firm-statement-let"
}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": "48486729",
"filename": "respond-lawyer-thank-by-court",
"temporaryUrl": "responsibility-once-employee-rather-wear"
}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": "30114640",
"eventType": "interest-recently-at-visit-nice",
"occurredAt": "2013-06-19T00:13:34.329411+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": "22197693",
"createdAt": "2000-08-20T07:52:15.294857+00:00",
"sentAt": "1982-09-27T11:38:32.356618+00:00",
"templateCode": "price-purpose-meet-group-author",
"toAddress": "everyone-ability-choice-responsibility-image",
"fromEmail": "imagine-figure-street-serious-bag",
"subject": "unit-investment-data-easy-anything",
"attachments": [EmailAttachmentType],
"textBody": "both-sort-establish-serve-cover",
"htmlBody": "we-last-front-young-voice",
"toNumber": "deep-anything-me-right-appear",
"fromNumber": "window-significant-authority-magazine-important",
"channel": "house-PM-maybe-court-because",
"sender": "fill-assume-relationship-half-trouble",
"recipient": "think-analysis-participant-team-benefit"
}Fields
| Name | Description |
|---|---|
|
The email address to be checked. |
|
The status of verification for associated email. |
Example
{
"email": "when-network-notice-term-her",
"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": "41056580",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "14825392",
"deviceId": "59309277"
}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": "84530625",
"name": "specific-hundred-difficult-economy-recognize",
"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": "83856908",
"embeddedNetwork": EmbeddedNetworkType,
"propertyId": "80259442"
}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"
}EnergyMixDataType
Energy mix data can include the latest carbon intensity index in a region.
Fields
| Name | Description |
|---|---|
|
Current carbon intensity index. |
Example
{
"carbonIntensityIndex": "treat-available-eat-company-unit"
}Example
{
"linkState": "give-crime-town-establish-morning",
"linkUrl": "young-institution-sell-easy-against"
}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": "strategy-certain-to-about-often",
"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": "station-strong-security-scene-raise"
}EpexDayAheadPriceConnectionTypeConnection
Connection type for EPEX Day Ahead prices in Germany.
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": EpexDayAheadPriceConnectionTypeEdge,
"totalCount": 58,
"edgeCount": 46
}EpexDayAheadPriceConnectionTypeEdge
A Relay edge containing a EpexDayAheadPriceConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": EpexDayAheadPriceType,
"cursor": "rest-good-training-fish-process"
}EpexDayAheadPriceType
EPEX Day Ahead electricity price data for Germany.
Fields
| Name | Description |
|---|---|
|
End datetime of the price period (exclusive). |
|
Start datetime of the price period (inclusive). |
|
Unit of the price value (EUR/MWh). |
|
Price value in EUR/MWh. |
Example
{
"periodStart": "1992-08-04T20:57:40.985229+00:00",
"periodEnd": "1975-10-23T08:10:14.623504+00:00",
"value": "1.0",
"unit": "different-special-brother-age-other"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"field": "over-within-themselves-produce-mouth",
"messages": "nice-force-keep-treat-born"
}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": "that-sound-important-power-discuss",
"pricePerUnit": PricePerUnit
}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": 4,
"edgeCount": 94
}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": "science-foot-scene-list-them"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "25077888",
"eventType": "similar-figure-himself-memory-boy",
"occurredAt": "2017-08-27T01:53:57.793340+00:00",
"category": "assume-structure-life-say-do",
"subcategory": "tree-executive-worker-key-meeting",
"description": "fish-recognize-force-your-nearly",
"content": {"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": ExternalAccountEventConnectionTypeEdge,
"totalCount": 76,
"edgeCount": 78
}ExternalAccountEventConnectionTypeEdge
A Relay edge containing a ExternalAccountEventConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ExternalAccountEvent,
"cursor": "nor-rate-fear-wall-type"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "29541316",
"eventType": "bar-able-kitchen-cover-deal",
"category": "former-fall-most-onto-night",
"subcategory": "staff-suffer-central-section-something",
"occurredAt": "1973-08-29T16:45:10.642307+00:00",
"description": "new-true-suggest-popular-type",
"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": "67012349"
}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": "chair-event-person-its-health",
"description": "foreign-world-recently-admit-you",
"value": "public-offer-media-common-character"
}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": "bad-clearly-girl-ability-major",
"name": "conference-accept-state-exactly-entire",
"location": "hot-fast-if-close-democratic",
"windFarm": "year-surface-me-notice-try",
"accountNumbers": "hand-stop-ahead-maybe-often",
"propertyIds": 64,
"catchments": "writer-similar-road-speech-marriage",
"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": "interview-hear-culture-often-PM",
"vendor": "seat-anyone-indeed-keep-capital"
}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": "ten-across-authority-center-international",
"rate": "across-born-visit-mouth-process",
"ttl": 75,
"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": 69,
"edgeCount": 59
}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": "company-someone-nearly-local-purpose"
}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": "66567333",
"identifierType": "scene-know-lot-doctor-couple",
"riskLevel": "1.0",
"isInRiskList": true
}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": 10598434,
"timeFrom": "01:47:02.541746",
"timeTo": "07:21:25.116182",
"timeStep": 33,
"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": 48346719,
"deviceType": "design-brother-sell-evidence-space",
"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": "tree-get-book-people-money",
"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": "standard-political-section-mind-coach"
}FloatType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"floatValue": 275.0
}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": "2023-07-30T15:41:38.675820+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": "1979-03-16T11:31:45.257457+00:00",
"projectedDiscount": "1.0",
"powerMedian": "1.0",
"powerLowerBound": "1.0",
"powerUpperBound": "1.0"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
Example
{
"id": 14194464,
"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": "76983288",
"typename": "relationship-on-fast-will-per",
"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": "88344859",
"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": "48951256",
"amount": 26
}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": 98,
"edgeCount": 52
}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": "also-Mrs-citizen-management-continue"
}Fields
| Name | Description |
|---|---|
|
Amount used from a funding source in minor currency. |
|
Reason why the funding source was used. |
Example
{
"reason": "activity-artist-news-right-player",
"amount": 77
}Fields
| Name | Description |
|---|---|
|
The code of the field. |
|
Whether the field is deprecated. |
|
The type of the field. |
|
The name of the field. |
|
The order of the field in the collection. |
|
The choices for the field if applicable. |
Example
{
"code": "building-walk-might-card-throw",
"name": "job-gun-seem-space-attention",
"fieldType": "STR",
"textChoices": ["situation-everyone-find-weight-through"],
"deprecated": true,
"orderInCollection": 80
}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": "84321389",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "40947194",
"deviceId": "78673036"
}GasMeterConnectionTypeConnection
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": GasMeterConnectionTypeEdge,
"totalCount": 31,
"edgeCount": 8
}GasMeterConnectionTypeEdge
A Relay edge containing a GasMeterConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": GasMeterType,
"cursor": "environmental-heavy-candidate-simply-rich"
}Fields
| Name | Description |
|---|---|
|
All registers relevant for billing for the meter. |
Example
{
"registers": [GasRegisterForReadingType]
}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": 68,
"edgeCount": 100
}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": GasMeterReadingType,
"cursor": "ok-focus-music-remember-win"
}Fields
| Name | Description |
|---|---|
|
The datetime when the meter was active from. |
|
The datetime when the meter stops being active. This should be null if it is still active. |
|
The meter ID. |
|
The MeLo number associated with the meter. |
|
The metering direction of the meter. |
|
The meter number. |
|
The reading transmission type of the meter. |
|
The tariff count of the meter. |
Example
{
"id": "37490799",
"serialNumber": "right-child-maybe-behind-time",
"requiresAccess": true,
"isDigital": true,
"installationDate": "2004-02-13",
"lastInspectionDate": "2011-03-23",
"createdAt": "1999-10-13T00:25:17.476639+00:00",
"updatedAt": "1981-09-28T14:27:03.451431+00:00",
"activeFrom": "2015-04-30",
"activeTo": "2006-07-25",
"meterPoint": GasMeterPointType,
"manufacturerCode": "none-actually-look-late-citizen",
"modelName": "party-admit-official-officer-write",
"manufacturedYear": 71,
"meterType": "describe-process-fill-class-wife",
"imperial": true,
"units": 21,
"location": "science-heart-somebody-professor-draw",
"mechanism": "CR",
"correction": 184.59,
"locationDescription": "important-human-maybe-husband-computer",
"readingFactor": "1.0",
"instructions": "degree-he-situation-moment-happy",
"pulseValue": "1.0",
"linkCode": "instead-teach-gas-position-some",
"collarFitted": "he-police-create-including-opportunity",
"bypassFitted": "close-newspaper-knowledge-style-address",
"measuringCapacity": "1.0",
"status": "LI",
"operationalStatusDate": "2011-12-03",
"owner": "store-collection-drug-station-rule",
"currentMeterAssetManager": "relate-how-loss-yes-source",
"prepayLedgers": PrepayLedgersType,
"smartGasMeter": SmartMeterDeviceType,
"consumptionUnits": "her-nothing-job-art-sport",
"requiresCotFinalReading": true,
"fuelType": "charge-give-situation-write-significant",
"consumption": ConsumptionConnection,
"nodeId": "83924205",
"readings": GasMeterReadingConnectionTypeConnection,
"registers": [GasMeterRegisterType],
"hasAndAllowsHhReadings": true,
"smartDevices": [SmartMeterDeviceType],
"isTradPrepay": true,
"isReadyForTopup": true
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"totalNetworkChargesPerYear": "1.0",
"gridBillingChargeAnnual": "1.0",
"gridMeterOperationChargeAnnual": "1.0",
"gridMeterReadingChargeAnnual": "1.0",
"gridStandingChargeAnnual": "1.0",
"gridConcessionChargePerKwh": "1.0",
"gridPowerChargeAnnual": "1.0",
"gridUnitRateChargeAnnual": "1.0",
"accountingFee": "1.0"
}Fields
| Name | Description |
|---|---|
|
The date from when the register is active. |
|
The date until when the register is active. |
|
The number of decimal places on the register. |
|
The number of digits on the register. |
|
The OBIS code of the register. |
|
The readings for a given register, in reverse order (latest first). This field is a connection type. Connections are used to implement cursor based pagination. This field requires the |
Example
{
"obisCode": "race-increase-nothing-suffer-resource",
"digits": 84,
"decimalPlaces": 1,
"activeFrom": "1981-09-01",
"activeTo": "2019-01-27",
"readings": RegisterReadingConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
The meter id this reading belongs to. |
|
|
|
|
|
|
|
|
|
Example
{
"value": "go-wall-number-mouth-ever",
"readAt": "2023-06-02T14:54:26.958618+00:00",
"registerObisCode": "over-charge-cold-price-partner",
"typeOfRead": "easy-entire-operation-first-herself",
"origin": "more-election-sit-plant-these",
"meterId": 47274544
}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": "yet-out-yard-current-through",
"key": "finally-focus-movement-head-factor",
"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
}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": "meet-painting-we-form-between",
"tokenExpiryDatetime": "1973-10-19T07:47:20.116431+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": "begin-somebody-manager-risk-west",
"refreshFrequency": 76,
"screenData": "with-yard-itself-forget-fast"
}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": "television-center-party-note-senior"
}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": "much-establish-along-organization-team"
}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": "beat-safe-remain-many-town"
}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-4B5B0979"
}Fields
| Name | Description |
|---|---|
|
Currency. |
|
Gross amount. |
|
Net amount. |
|
Grant type. |
Example
{
"type": "yet-college-center-know-between",
"netAmount": 82.55,
"grossAmount": 434.77,
"currency": "fly-east-late-road-anyone"
}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": 69511001,
"marketName": "child-Democrat-opportunity-commercial-later",
"productType": GoodsProductType,
"code": "environmental-lead-personal-popular-me",
"internalName": "bad-save-simple-my-old",
"customerName": "couple-business-allow-tell-garden",
"notes": "travel-prove-beyond-point-many",
"description": "word-billion-place-though-account",
"availableFrom": "1973-01-25",
"availableTo": "2000-02-01",
"pricePerUnit": 540.52,
"grossPricePerUnit": 265.27,
"currency": "tonight-me-might-factor-room"
}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": 36,
"edgeCount": 61
}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": "ground-box-thousand-interesting-few"
}Example
{
"code": "seat-dark-check-ask-market",
"internalName": "including-else-firm-himself-TV"
}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": "recent-understand-into-third-save",
"ledgerId": "62417344",
"ledgerNumber": "wait-society-yard-such-business",
"goodsSaleItems": [GoodsSaleItem],
"goodsGrants": [GoodsGrant],
"marketName": "meet-allow-raise-conference-toward",
"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": "42059275",
"code": "either-continue-develop-economic-realize",
"totalNetAmount": 39,
"quotedAt": "2011-02-07T20:27:48.300266+00:00",
"goodsQuotedProducts": [GoodsQuotedProduct],
"hasQuoteExpired": true
}Fields
| Name | Description |
|---|---|
|
The ID of the quote share. |
Example
{
"id": "93979053"
}Fields
| Name | Description |
|---|---|
|
Currency. |
|
Net amount. |
|
Number of units. |
|
Price per unit. |
|
Product code. |
Example
{
"product": "their-money-represent-in-appear",
"numberOfUnits": 52,
"pricePerUnit": 92,
"netAmount": 93,
"currency": "century-compare-attack-discussion-day"
}Fields
| Name | Description |
|---|---|
|
Currency. |
|
Gross amount. |
|
Net amount. |
|
Number of units. |
|
Price per unit. |
|
Product code. |
Example
{
"product": "ready-for-professor-money-nature",
"numberOfUnits": 93,
"pricePerUnit": 703.71,
"netAmount": 1.85,
"grossAmount": 149.95,
"currency": "see-hundred-director-yeah-admit"
}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]
}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"
}Fields
| Name | Description |
|---|---|
|
The date when the VAT rate starts being active from. |
|
The rate after the VAT rate is applied to the net rate. |
|
The date until which the VAT rate is active (exclusive). |
|
The VAT rate percentage. |
Example
{
"date": "2011-06-06",
"vatRate": "1.0",
"grossRate": "1.0",
"rateValidToDate": "1999-05-14"
}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": "23564698",
"internalName": "brother-trial-group-forget-speak",
"customerName": "executive-former-outside-table-attention",
"customerDescription": "experience-turn-room-age-least",
"minCardinality": 33,
"maxCardinality": 5,
"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": "impact-discuss-change-where-reality",
"displayName": "series-store-what-believe-end",
"description": "still-Democrat-determine-itself-management",
"identifier": "77998445",
"isVariable": true,
"guaranteeOfOriginPercentage": "ZERO"
}HardshipAgreementType
Represents a Hardship Agreement for a particular Account.
Fields
| Name | Description |
|---|---|
|
These are internal notes detailing the hardship. |
|
|
|
|
|
|
|
|
|
Example
{
"id": "77302184",
"hardshipType": "DEATH_IN_FAMILY",
"hardshipDetails": "suffer-her-medical-continue-can",
"hardshipEntryReason": "SELF_IDENTIFIED",
"paymentPlanDetails": "evidence-begin-after-course-himself",
"startDate": "1980-10-31"
}Fields
| Name | Description |
|---|---|
|
Whether a statement is currently held. |
|
Reason for statement being held. |
Example
{
"isHeld": true,
"reason": "always-agree-take-threat-issue"
}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": "month-this-scene-site-guess",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "weight-forward-bank-read-number",
"id": "57692897",
"typename": "send-real-factor-figure-participant"
}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": 98,
"edgeCount": 55
}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": "step-stuff-under-program-small"
}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": 55,
"recent": 5
}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": "64871063",
"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": "store-break-career-role-strategy",
"escalationStartAt": "2013-12-08T03:13:40.170996+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-DFE43E89"
}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": "treat-break-explain-coach-partner"
}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": "staff-half-quickly-entire-certainly",
"url": "relate-never-poor-seek-choice"
}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": "recently-southern-PM-what-media",
"switchDate": "2014-03-13"
}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": "increase-we-look-future-box",
"secretToken": "my-catch-serve-particular-whether"
}Fields
| Name | Description |
|---|---|
|
The icon code point. |
|
The ID of the object |
|
The ink bucket name. |
Example
{
"id": "64749574",
"name": "usually-always-road-boy-measure",
"icon": "quality-people-media-address-mother"
}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": "front-and-over-hold-front",
"displayName": "Mrs-forward-exist-however-what"
}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": "28181077",
"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": "nor-fact-require-forward-something"
}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": ["politics-begin-father-family-similar"],
"fromHandle": "late-camera-film-affect-according",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1987-12-04T19:46:56.378161+00:00",
"subject": "great-lot-international-worry-produce",
"displayContent": "understand-hand-home-stage-laugh",
"attachments": InkMessageAttachment,
"cc": "sign-window-sign-this-be",
"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": "23438775",
"direction": "INBOUND",
"fromHandle": "hour-eat-certain-figure-property",
"toHandle": "head-able-wind-huge-wife",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1981-05-05T09:22:46.895867+00:00",
"displayContent": "business-rich-task-west-situation"
}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": "capital-traditional-despite-prepare-author",
"toHandle": "eat-claim-find-respond-store",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1993-06-30T03:18:50.757470+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": "92653389"
}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": "65220155",
"direction": "INBOUND",
"fromHandle": "paper-decade-throw-ever-appear",
"toHandle": "floor-fine-attack-push-customer",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1989-01-14T05:16:09.101967+00:00",
"displayContent": "exactly-push-phone-cut-against"
}Fields
| Name | Description |
|---|---|
|
The url for fetching the attachment. |
|
The filename. |
|
The size in bytes. |
Example
{
"filename": "nearly-enough-future-large-whatever",
"fetchUrl": "politics-benefit-movement-table-idea",
"sizeInBytes": 63
}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": "win-value-clearly-responsibility-maintain",
"accountType": "possible-soldier-move-who-how",
"buckets": ["game-gun-oil-save-seek"],
"conversationId": 39528083,
"hourOccurredAt": 12,
"hoursWaiting": 56,
"isAssignedToUserBucket": true,
"isFirstFromContact": true,
"isNewThread": true,
"opsTeam": "or-north-southern-whom-join",
"recentlyReceivedAutoReplies": "sit-nothing-sure-too-central",
"replyToCommsSms": "rich-general-record-wind-expect",
"weekDayOccurredAt": 84
}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": "2021-03-17T05:56:24.468397+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": "97564630",
"content": "north-agreement-treat-to-film",
"isPinned": true,
"occurredAt": "1978-05-26T03:53:54.938150+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": "husband-job-raise-author-bar",
"toHandle": "glass-range-may-ability-forget",
"displayContent": "own-stuff-talk-us-meeting",
"rawPlainTextContent": "their-again-opportunity-image-live",
"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": "happy-tend-painting-bill-player",
"toHandle": "use-crime-four-treat-young",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1972-12-05T05:24:14.329102+00:00",
"displayContent": "toward-eight-simple-at-can",
"isChannelSms": true,
"tags": InkTag
}Fields
| Name | Description |
|---|---|
|
|
|
The entries in the storyline. |
|
When the storyline was generated. |
|
The ID of the object |
|
|
|
|
|
|
|
Example
{
"id": "31157790",
"topic": "street-entire-general-part-official",
"summary": "onto-board-address-sing-order",
"generatedAt": "1986-02-22T07:59:56.697951+00:00",
"neuralinkRequestId": "44ef507e-6eb8-461b-97f3-cb660fbf2d87",
"createdAt": "1989-08-08T20:13:00.053426+00:00",
"updatedAt": "2000-08-29T21:10:07.644985+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": "20352793",
"entryType": "contain-red-occur-nearly-which",
"occurredAt": "2016-12-26T02:23:55.480315+00:00",
"content": "rest-believe-ready-similar-religious",
"url": "person-cut-sense-picture-event",
"contentId": 71246582
}Example
{
"id": "95971099",
"name": "now-high-stock-professor-mean"
}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": "continue-couple-unit-see-law",
"toHandle": "fact-peace-life-tree-identify",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1997-05-17T16:52:32.347510+00:00",
"vendorId": "81813300",
"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": "responsibility-air-teach-blood-visit",
"toHandle": "happy-personal-store-need-five",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "1983-07-27T16:03:47.715208+00:00",
"vendorId": "82193354",
"whatsappContent": WhatsAppTextMessage,
"isChannelWhatsapp": true,
"tags": InkTag
}Fields
| Name | Description |
|---|---|
|
The integer value of the characteristic. |
Example
{
"integerValue": 92
}IntegerType
Graphene type object to represent integer values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"integerValue": 37
}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": "attorney-oil-everybody-need-relate",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "body-down-even-across-stage",
"readAt": "1997-02-28T04:58:31.682798+00:00",
"startAt": "2016-07-29T04:16:18.797995+00:00",
"endAt": "1973-07-18T21:28:02.338450+00:00",
"durationInSeconds": 50,
"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": 43927321
}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": "must-customer-common-film-on"
}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": 40,
"edgeCount": 57
}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": "good-break-method-clearly-person"
}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. |
|
Start date of billing period. |
|
End date of billing period. |
|
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": 81237001,
"firstIssued": "1994-11-13T20:12:14.660544+00:00",
"pdfUrl": "magazine-raise-dream-fill-learn",
"annulledBy": AnnulmentBillingDocumentType,
"number": "author-outside-stay-environmental-catch",
"invoicedAmount": 78,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType,
"paymentDueDate": "1984-07-25"
}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": 71,
"taxTotal": 41,
"grossTotal": 4
}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": "26860922",
"billType": "STATEMENT",
"fromDate": "1972-09-01",
"toDate": "2015-03-08",
"temporaryUrl": "range-must-whatever-our-card",
"issuedDate": "2000-06-29",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "36941963",
"grossAmount": 94,
"isAnnulled": true,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"totalPayments": 49,
"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"}
}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": 29,
"edgeCount": 22
}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": "room-field-spring-traditional-go"
}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": "1996-07-25T14:52:50.031202+00:00",
"salesChannel": "clearly-should-defense-western-major",
"salesSubchannel": "site-include-though-hit-exist",
"affiliateLink": AffiliateLinkType,
"supplyPointContexts": SupplyPointContextDataInterface,
"note": "debate-note-reach-what-spring"
}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": "48224856",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"number": "light-daughter-administration-court-score",
"currentProcessData": JoinSupplierProcessDataType
}Fields
| Name | Description |
|---|---|
|
The unique identifier for the sales record. |
|
The opportunity code associated with the sales record. |
Example
{
"identifier": "46462193",
"opportunityNumber": "move-step-participant-professor-better"
}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": "70062240",
"provider": "BYD",
"vehicleMake": "anything-too-woman-big-politics",
"vehicleModel": "answer-actually-deal-imagine-art",
"vehicleBatterySizeInKwh": "1.0",
"chargePointMake": "activity-along-beautiful-suffer-whose",
"chargePointModel": "half-shake-member-staff-center",
"chargePointPowerInKw": "1.0",
"status": "power-strong-know-one-avoid",
"suspended": true,
"hasToken": true,
"createdAt": "2004-12-29T07:33:45.744553+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": "23987188",
"salesChannel": "material-success-describe-just-case",
"affiliateOrganisationName": "purpose-white-when-true-great"
}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": "central-themselves-appear-effect-ability",
"SHA": "walk-shake-all-reality-leave"
}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": "increase-smile-voice-cover-represent",
"displayName": "himself-daughter-teach-until-night",
"description": "day-go-certain-machine-anything",
"identifier": "20275177",
"isVariable": true,
"flatFeeAmount": "1.0",
"percentageFee": "1.0",
"percentageIntervalDays": "1.0",
"interestPolicyName": "president-explain-what-yes-senior"
}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": "kind-left-guess-central-have",
"nationalId": "39226076",
"leadType": "realize-yard-bad-us-least",
"salesFunnel": SalesFunnel,
"stage": SalesFunnelStage,
"salesChannel": SalesChannelType,
"assignedToOrganization": AffiliateOrganisationType,
"assignedToUsername": "she-particularly-forward-risk-audience",
"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": ["seek-pay-involve-meeting-official"]
}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": "Roger",
"familyName": "Williams",
"email": "career-price-part-responsibility-stuff",
"phoneNumber": "exist-attack-last-be-wife",
"roles": "LEGAL_CONTACT"
}Fields
| Name | Description |
|---|---|
|
The ID of the lead. Deprecated The 'leadId' field is deprecated. |
|
The number of the lead. |
Example
{
"leadId": "80739310",
"number": "political-heavy-eye-would-real"
}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": "23477342",
"givenName": "Beth",
"familyName": "Taylor",
"billingName": "beat-bring-mission-can-agency",
"billingAddress": AddressOutput,
"billingRichAddress": RichAddressType,
"email": "physical-arrive-information-minute-want",
"phoneNumber": "family-including-item-performance-lawyer",
"number": "and-same-nor-ball-offer",
"stage": "option-final-trip-effect-candidate",
"extraDetails": {"key": "value"},
"brand": "soon-chance-later-reach-career",
"salesChannel": "our-pass-think-resource-international",
"assignedToTeam": "reflect-play-but-serve-quality",
"assignedToUser": "hit-political-apply-east-affect",
"nationalId": "48324468",
"leadType": "game-range-necessary-politics-environmental",
"consents": [ConsentOutput],
"accountNumber": "A-19D5F913"
}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": "authority-then-question-ago-though"
}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": "safe-begin-son-pick-industry",
"bucket": "card-build-strategy-person-interview",
"preSignedUrl": "suffer-create-especially-level-raise",
"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": 78,
"edgeCount": 25
}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": "protect-few-wall-remain-better"
}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": "38510445",
"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": "size-computer-walk-chance-drop"
}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": "52282154",
"leaveSupplierProcessId": "52264036",
"message": "fire-capital-common-help-consider"
}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": 72,
"edgeCount": 6
}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": "score-public-two-dog-ahead"
}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": "34744097",
"status": "PENDING",
"number": "who-you-real-thus-stay",
"supplyPoints": SupplyPointConnectionTypeConnection
}LeaveSupplierUpdated
Leave supplier was successfully updated.
Fields
| Name | Description |
|---|---|
|
The message to display to the user on leave supplier update. |
Example
{
"message": "something-four-site-authority-popular"
}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": "15055896",
"name": "political-his-sound-trade-young",
"number": "chair-arm-job-Democrat-contain",
"ledgerType": "threat-drug-everybody-may-police",
"balance": 70,
"amountOwedByCustomer": 18,
"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": "cut-here-head-reality-material",
"version": 39,
"maxVersion": 87,
"previousOffering": "32142556",
"status": "DRAFT",
"activatedAt": "1973-04-07T16:03:44.075964+00:00"
}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": "store-technology-nation-film-discussion",
"field": "support-call-why-sound-represent"
}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": 46,
"length": 99,
"productId": "95815932",
"emojiId": "92400012"
}LineLinkRedirectResponse
Link Successful. Complete link process with LINE.
Fields
| Name | Description |
|---|---|
|
Example
{
"redirectUrl": "never-force-try-detail-her"
}Fields
| Name | Description |
|---|---|
|
Keywords describing the sticker. |
|
Sticker package id. |
|
Sticker resource type. |
|
Sticker id. |
|
Text used to customize some stickers. |
Example
{
"packageId": "53567248",
"stickerId": "92952094",
"resourceType": "seem-we-economy-minute-read",
"keywords": "commercial-executive-mean-audience-than",
"text": "eat-student-clear-through-write"
}Fields
| Name | Description |
|---|---|
|
The display content. |
|
The emojis in the message. |
Example
{
"displayContent": "for-television-discuss-participant-reason",
"emojis": [LineEmoji]
}Fields
| Name | Description |
|---|---|
|
Example
{
"message": "woman-add-movement-range-cause"
}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": "job-rest-resource-return-condition",
"id": "98006876",
"typename": "style-ever-their-majority-bank",
"url": "speech-single-radio-series-father"
}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": 17,
"consumption": ConsumptionBreakdownConnectionTypeConnection,
"averageMonthlyCharge": 58,
"existingMonthlyAmount": 83,
"balanceAdjustment": 60,
"currentBalance": 35,
"targetBalance": 1,
"reviewedOn": "1985-10-06"
}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": "10313650",
"scheme": "rock-week-treatment-attorney-seem",
"number": "music-present-less-movement-film",
"status": "direction-office-money-say-firm"
}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": "12631907",
"ledgerType": "mind-probably-fly-would-old",
"value": "impact-employee-glass-size-white",
"balanceBroughtForward": "realize-wait-street-still-around",
"balanceCarriedForward": "name-week-must-fly-middle",
"reasonCode": "rise-time-of-chance-technology",
"idempotencyKey": "1580d52d-32d3-4289-b837-344c938c58a8",
"postedAt": "1987-03-06T20:40:48.916499+00:00",
"accountNumber": "A-F3678561"
}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": "wear-cup-along-item-though"
}Fields
| Name | Description |
|---|---|
|
|
|
Whether the MaLo's supply point can currently be annulled. |
|
Whether the MaLo's supply point can currently be cancelled. |
|
Whether the MaLo's supply point can currently be revoked. |
|
Whether the MaLo's supply point can currently be specially cancelled. |
|
The first day on which we supply this MaLo. Also known as the supply start date. This is the first day of the currently active supply period, a future supply period, or a past supply period. The date is returned in the local timezone. Null if no supply period is available. |
|
|
|
The last day (inclusive) on which we supply this MaLo. Also known as the supply end date. This is the last day of the currently active supply period, a future supply period, or a past supply period. The date is returned in the local timezone. Null if there is no supply period or if the supply period is open-ended. |
|
The MaLo number. |
|
The MeLo number. |
|
The currently active meter. |
|
The reference consumption related to energy price brake. |
|
|
|
The status of the current supply lifecycle. If no current supply lifecycle is available, we will return last one. The possible errors that can be raised are:
|
|
ID of the supply point. |
|
The supply start date, either of the currently active supply period, a future supply period, or a past supply period. The date is returned in the local timezone. Null if no supply period is available. Deprecated The 'supplyStartDate' field is deprecated. |
Example
{
"id": "32007357",
"status": "necessary-number-production-staff-number",
"maloNumber": "carry-knowledge-continue-service-future",
"meloNumber": "piece-appear-travel-court-risk",
"meter": Meter,
"agreements": [Agreement],
"supplyStartDate": "2001-09-26",
"firstDayOfSupply": "2020-11-06",
"lastDayOfSupply": "1974-09-15",
"supplyPointId": "27884413",
"canBeAnnulled": true,
"canBeRevoked": true,
"canBeCancelled": true,
"canBeSpeciallyCancelled": true,
"referenceConsumption": 27,
"supplyLifecycleStatus": "A00_STARTED"
}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": "1976-11-24T01:03:05.144747+00:00",
"requestedAt": "2006-02-24T14:38:19.626413+00:00",
"code": "time-value-billion-power-lay",
"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": 45,
"edgeCount": 2
}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": "wife-surface-none-respond-bag"
}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": "47375153",
"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": 72,
"edgeCount": 98
}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": "now-item-himself-task-low"
}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": "final-major-hour-ground-subject",
"id": "39559146",
"identifier": "78138766",
"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": "Democrat-agree-item-now-able",
"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": 45,
"reasonToRecommendAmount": "MAX_AVAILABLE_AMOUNT",
"recommendedBalance": 69
}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": 67,
"edgeCount": 89
}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": "perform-body-however-mother-including"
}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": "notice-nearly-per-law-various",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "matter-road-vote-material-dinner",
"readAt": "2014-11-30T18:38:04.368231+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": "2001-04-05T18:10:32.455561+00:00",
"failedAt": "2024-11-14T00:27:23.179682+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": 77,
"edgeCount": 97
}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": "her-show-few-open-rule"
}Fields
| Name | Description |
|---|---|
|
The key for the metadata. |
|
The metadata value. |
Example
{
"key": "mind-yeah-benefit-policy-arm",
"value": {"key": "value"}
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Whether the meter should receive smart meter data. |
|
A tokenized url for submitting meter readings. |
Example
{
"id": "65578114",
"serialNumber": "mean-natural-head-either-campaign",
"consumptionUnits": "writer-audience-short-vote-hard",
"requiresCotFinalReading": true,
"fuelType": "scientist-major-history-on-friend",
"consumption": ConsumptionConnection
}MeterReadingEstimationReadingConnection
Paginator for estimations of meter 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": MeterReadingEstimationReadingEdge,
"totalCount": 44,
"edgeCount": 33
}MeterReadingEstimationReadingEdge
A Relay edge containing a MeterReadingEstimationReading and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": MeterReadingEstimationReadingType,
"cursor": "tough-hand-artist-low-where"
}Fields
| Name | Description |
|---|---|
|
The algorithm used for the estimation. |
|
The end date of the reading interval. |
|
The start date of the reading interval. |
|
Denotes if the reading was estimated. |
|
The value of the reading. |
Example
{
"intervalStart": "2012-05-21T13:19:51.802969+00:00",
"intervalEnd": "1970-05-07T01:47:08.395650+00:00",
"value": "1.0",
"isNewlyEstimated": true,
"estimatedByAlgorithm": "plan-bank-cost-west-hear"
}Fields
| Name | Description |
|---|---|
|
The type of MFA device. |
|
Whether the MFA device is confirmed or not. |
Example
{
"deviceType": "win-strong-save-he-investment",
"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": "himself-various-stock-southern-it",
"displayName": "concern-walk-both-during-chance",
"description": "hair-fact-simple-fish-day",
"identifier": "19615493",
"isVariable": true,
"length": 90,
"unitOfTime": "light-be-maintain-give-believe"
}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": 9,
"endYear": 83
}Fields
| Name | Description |
|---|---|
|
|
|
The ISO-4217 code for the currency. |
Example
{
"amount": "1.0",
"currency": "particularly-entire-level-money-hot"
}MoveOut
Cancelling a contract because of a Move Out for a given supply point and send confirmation email to the customer.
Fields
| Name | Description |
|---|---|
|
Whether the contract cancellation was successful. |
|
The last day of supply. |
Example
{
"cancelledContract": true,
"lastDayOfSupply": "2015-12-08"
}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": "born-from-by-modern-just"
}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": "16665893",
"name": "reduce-lead-son-energy-class",
"bundleId": "67082631",
"service": "GCM",
"externalProvider": "PINPOINT",
"externalProjectId": "66184131",
"description": "goal-customer-best-tonight-other",
"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": "safe-bring-listen-church-discover",
"username": "together-tough-thing-land-second"
}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
{
"text": "option-place-environmental-hit-sea",
"createdAt": "2018-08-08T08:51:43.685919+00:00",
"name": "as-television-enough-action-community",
"pdfUrl": "building-work-cell-bad-current",
"brandCode": "measure-general-weight-why-hear",
"markdown": "teacher-film-good-wife-western",
"html": "identify-woman-value-paper-forget",
"version": "rich-watch-matter-never-plan",
"effectiveFrom": "2021-02-20T09:57:20.531015+00:00"
}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": "short-arm-you-course-rise",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "significant-value-movement-PM-meet",
"refreshExpiresIn": 1
}ObtainLongLivedRefreshToken
Obtain a long-lived refresh token.
This mutation is limited to authorized third-party organizations only.
Account users can only generate short-lived refresh tokens.
The short-lived refresh tokens (for account users) can be obtained from the 'refreshToken' field in 'obtainKrakenToken' mutation.
The possible errors that can be raised are:
- KT-CT-1120: The Kraken Token has expired.
- KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
- KT-CT-1132: Unauthorized.
- KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
|
|
Example
{
"possibleErrors": [PossibleErrorType],
"refreshToken": "into-partner-example-stand-want",
"refreshExpiresIn": 41
}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": "89809440",
"effectiveFrom": "1987-01-25T12:04:16.991529+00:00",
"effectiveTo": "2006-08-16T09:13:28.975562+00:00",
"isOccupier": true,
"accountNumber": "A-3FCA0DE5"
}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": 80,
"edgeCount": 99
}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": "despite-her-people-bar-case"
}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": "82566679",
"status": "PENDING",
"occupyAt": "2009-06-03T19:09:17.358335+00:00",
"supplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
The date and time when Offer Group was created. |
|
The Actor who created the Offer Group. |
|
Identifier of the Offer Group. |
|
One or more Offers contained in the Offer Group. |
Fields
| Name | Description |
|---|---|
|
The date and time when Offer was accepted. |
|
The Actor who created the Offer. |
|
Description of the Offer. |
|
Identifier of the Offer. |
|
The Quote this Offer is related to. |
|
The date and time when Offer was rejected. |
|
The date and time from which the Offer becomes valid. |
|
The date and time until which the Offer remains valid. |
Example
{
"identifier": "34924102",
"quote": QuoteType_,
"description": "economic-simple-too-remember-international",
"validFrom": "1996-04-03T09:32:45.472081+00:00",
"validTo": "2015-10-25T14:25:51.343283+00:00",
"acceptedAt": "2008-11-03T03:22:04.597519+00:00",
"rejectedAt": "1997-09-22T17:48:24.404772+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": "69778566",
"minimumQuantity": 58,
"maximumQuantity": 57,
"initialQuantity": 28,
"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": "35927552",
"internalName": "board-PM-pattern-quality-now",
"customerName": "early-American-my-of-with",
"customerDescription": "who-final-tough-save-step",
"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": 46,
"edgeCount": 93
}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": "wrong-special-job-turn-manager"
}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": "mean-wall-bank-data-into",
"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": 98,
"edgeCount": 17
}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": "hit-southern-they-environmental-success"
}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": "1973-12-22T01:28:04.254763+00:00",
"endDatetime": "2006-04-20T22:34:28.365099+00:00",
"slotId": "715913ad-c203-434c-815f-cdc7276d3415"
}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": "dd9b191e-6725-47e8-a0f3-36972bc8a58b",
"externalJobType": "especially-break-case-west-true",
"startAt": "1988-06-25T21:31:57.472513+00:00",
"endAt": "1991-01-01T15:47:38.525388+00:00",
"externalReference": "camera-view-today-site-national",
"jobDetails": {"key": "value"},
"jobNotes": {"key": "value"},
"comments": "evening-year-medical-rule-learn",
"cancellationSubCategory": "successful-these-vote-building-effort",
"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": 40,
"edgeCount": 40
}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": "before-on-region-sell-fund"
}OnSiteJobsAssetType
An On-Site Jobs Asset
Fields
| Name | Description |
|---|---|
|
|
|
|
|
The fuel type of the asset. |
|
The kind of the asset. |
|
The status of the asset. |
|
Example
{
"externalIdentifier": "51725553",
"additionalDetails": {"key": "value"},
"supplyPointIdentifier": "82856868",
"status": "EXISTING",
"kind": "METER",
"category": "TRADITIONAL",
"subCategory": "CREDIT",
"fuelType": "ELECTRICITY"
}OnSiteJobsCheckResultsType
Check results for creating On-Site Jobs requests and appointments.
Fields
| Name | Description |
|---|---|
|
Results of appointment checks. |
|
Whether an appointment can be created (overall appointment check is PASS/WARNING). |
|
Whether a request can be created (overall request check is PASS/WARNING). |
|
Whether any of the appointment checks have warnings. |
|
Whether any of the request checks have warnings. |
|
Results of request checks. |
Example
{
"requestCheckResults": [CheckResultType],
"appointmentCheckResults": [CheckResultType],
"canCreateRequest": true,
"canCreateAppointment": true,
"hasRequestWarnings": true,
"hasAppointmentWarnings": true
}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": "36096075",
"name": "radio-voice-fund-tend-describe"
}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": 36
}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": "sit-might-him-society-involve"
}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": "discover-create-with-scientist-effort",
"workflowStatus": "PENDING"
}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": 73,
"edgeCount": 23
}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": "every-defense-key-least-thank"
}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": "e3b5d388-12c8-4d38-8887-dc5f61bc6792",
"reason": "trip-century-individual-half-science",
"subReason": "same-far-director-personal-hot",
"isEmergency": true,
"externalReference": "tonight-fine-her-city-a",
"agent": "risk-have-believe-nothing-according",
"comment": "now-very-catch-half-standard",
"account": "that-discussion-admit-particularly-her",
"marketSupplyPoints": SupplyPointConnectionTypeConnection,
"property": PropertyType,
"status": "APPROVAL_PENDING",
"overallActionsStatus": "PENDING",
"requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
"assets": OnSiteJobsAssetConnectionTypeConnection,
"appointments": OnSiteJobsAppointmentConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
ID for the Operations Team. |
|
Name for the Operations Team. |
Example
{
"id": 26987975,
"name": "southern-sit-PM-arrive-if",
"teamName": "decision-bit-million-worry-several",
"isOffline": true,
"isAcceptingCalls": true,
"location": "operation-quickly-say-service-a",
"leader": OperationsTeamLeaderType
}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": 63,
"edgeCount": 96
}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": "responsibility-never-individual-eye-question"
}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. |
|
Notes for the opportunity. |
|
Opportunity number. |
|
Offer group ID. |
|
Opportunity address. |
|
Opportunity ID. Deprecated The 'opportunityId' field is deprecated. |
|
Opportunity rich address. |
|
Lead legal contact phone number. |
|
Product offering ID. |
|
Sales channel. |
|
Current stage in a funnel. |
Example
{
"opportunityId": "20819325",
"leadNumber": "black-example-short-foot-but",
"leadType": "born-outside-body-use-recognize",
"name": "college-leader-soon-local-commercial",
"email": "thank-truth-former-hair-story",
"phoneNumber": "interest-reveal-party-despite-step",
"number": "whom-environment-oil-manager-decide",
"funnel": SalesFunnel,
"stage": "adult-improve-especially-seem-for",
"extraDetails": {"key": "value"},
"opportunityAddress": AddressOutput,
"opportunityRichAddress": RichAddressType,
"salesChannel": "know-inside-hard-once-herself",
"assignedToTeam": "president-his-east-push-few",
"assignedToUser": "agreement-now-learn-same-easy",
"productOfferingId": "54618397",
"offerGroupId": "52753571",
"consents": [ConsentOutput],
"notes": "if-work-score-lose-water"
}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": "20664904",
"productIdentifier": "77711335",
"productCode": "soon-worker-heart-watch-institution",
"productCharacteristics": {"key": "value"},
"market": "computer-thought-check-both-born"
}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": "deep-clearly-tend-everything-though"
}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": "1985-10-06T12:11:55.856289+00:00",
"end": "1997-09-10T21:40:30.549830+00:00"
}OrderLineDurationType
Represents a period defined by duration in seconds.
Fields
| Name | Description |
|---|---|
|
The duration in seconds. |
Example
{
"duration": 48.46
}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": "three-kind-thank-phone-east",
"resourceIdentifier": "46833555"
}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": "50188961",
"customer": OrderCustomerType,
"lines": [OrderLineType],
"orderedAt": "1987-09-15T10:13:58.673635+00:00",
"terms": TermInterface,
"sale": SalesRecordType,
"source": "represent-time-more-dinner-side"
}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": "41278743",
"account": AccountType,
"metadata": CallMetadataItemType
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "level-animal-change-fire-federal"
}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": "decision-there-think-more-scene",
"endCursor": "tonight-chance-perform-when-remember"
}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. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessPaused": PauseCollectionProcessOutput
}Fields
| Name | Description |
|---|---|
|
Pause records on the collection process. |
Example
{
"pauseRecords": [CollectionProcessPauseStatusRecord]
}PauseDunning
Pause the dunning process for an account.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11301: Account not in a dunning process for the given path name.
- KT-CT-11302: No active dunning process found.
- KT-CT-11303: Multiple active dunning processes found.
- KT-CT-11304: Dunning pause process failed verifying the dates.
- KT-CT-11305: Pausing the dunning process failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the pause has been successfully created. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pauseCreated": true
}Payment
A payment from the customer to the supplier.
Fields
| Name | Description |
|---|---|
|
Unique identifier of the account the transaction belongs to. |
|
Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
|
The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
|
The date time when the transaction is created. |
|
Returns True if the transaction is linked with a statement. |
|
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. |
|
Whether a payment has been reversed due to a late failure.Sometimes a payment is marked cleared, only for Kraken to be notified days/weeks later that the payment has failed. |
|
|
|
Returns the note field value for the transaction, which contains additional info. |
|
The transaction type of the payment. |
|
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": "33882727",
"postedDate": "2014-04-15",
"createdAt": "1972-10-06T14:15:50.249083+00:00",
"accountNumber": "A-BB92B122",
"amount": 23,
"amounts": TransactionAmountType,
"balanceCarriedForward": 40,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "heavy-individual-design-myself-him",
"billingDocumentIdentifier": "15570168",
"statementId": "89202930",
"isReversed": true,
"hasStatement": true,
"note": "impact-type-choice-road-wind",
"reasonCode": "deep-argue-itself-usually-until",
"isLateFailedPayment": true,
"paymentTransactionType": "DD_FIRST_COLLECTION"
}PaymentAdequacyDetailsType
Payment adequacy adjusts fixed payment schedules to maintain a healthy ledger balance over a year.
Fields
| Name | Description |
|---|---|
|
This ledger will be exempt from default Payment Adequacy. This may mean that it is completely exempt, or handled with special rules. |
Example
{
"isCurrentlyExempt": true
}Fields
| Name | Description |
|---|---|
|
Fingerprint. |
|
Returns True if the fingerprint exists, Fasle otherwise. |
|
Returns True if the fingerprint is risk-listed, Fasle otherwise. |
Example
{
"fingerprint": "television-eye-usually-appear-not",
"isFound": true,
"isRiskListed": true
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentForecastConnectionTypeEdge,
"totalCount": 85,
"edgeCount": 87
}PaymentForecastConnectionTypeEdge
A Relay edge containing a PaymentForecastConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentForecastType,
"cursor": "share-board-by-represent-standard"
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
The payment method used for the forecasted payment. |
|
Example
{
"paymentNumber": 59,
"date": "2002-10-11",
"amount": 48,
"method": "BACS_TRANSFER"
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 60
}PaymentInstructionConnectionTypeEdge
A Relay edge containing a PaymentInstructionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentInstructionType,
"cursor": "social-describe-guy-this-which"
}Fields
| Name | Description |
|---|---|
|
The account user who is an owner of this payment instruction. |
|
The business who is an owner of this payment instruction. |
Example
{
"accountUser": AccountUserType,
"business": BusinessType
}PaymentInstructionType
Payment Instructions
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A masked reference to a recurring payment method. |
|
The owners of the financial account this instruction represents. |
|
|
|
|
|
The supplementary ledger for this payment instruction. |
|
|
|
Example
{
"id": "51917745",
"status": "morning-positive-too-north-single",
"sortCode": "statement-difference-down-risk-ready",
"iban": "case-nothing-food-protect-throughout",
"accountHolder": "attention-change-perhaps-painting-factor",
"instructionType": "race-those-player-bad-take",
"cardPaymentNetwork": "yes-TV-strong-region-scientist",
"cardExpiryMonth": 87,
"cardExpiryYear": 14,
"supplementaryLedger": SupplementaryLedgerType,
"bankCode": "author-game-song-system-crime",
"accountType": "stage-determine-argue-no-detail",
"validFrom": "1989-07-01T21:59:22.672071+00:00",
"vendor": "the-deep-them-of-southern",
"cardNumber": "practice-know-job-medical-effort",
"cardType": "evidence-many-arrive-admit-deal",
"maskedAccountIdentifier": "40663533",
"owners": [PaymentInstructionOwnerType]
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPlanConnectionTypeEdge,
"totalCount": 86,
"edgeCount": 9
}PaymentPlanConnectionTypeEdge
A Relay edge containing a PaymentPlanConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentPlanType,
"cursor": "describe-own-community-state-manager"
}PaymentPlanPaymentType
An object that represents a planned payment for a payment plan.
Example
{
"payableDate": "1988-01-24",
"amount": 59,
"paymentType": "early-with-than-whole-whom"
}PaymentPlanType
An object that represents a payment plan.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
The ledger number for this payment plan or None if one does not exist. |
|
The next planned payment for this payment plan. |
|
|
|
|
|
|
|
|
|
The display name of the strategy used for this payment plan or None if one does not exist. |
|
|
|
Example
{
"id": "19367549",
"account": AccountType,
"initialScheduleType": "six-in-human-land-fine",
"strategyName": "prepare-central-project-approach-job",
"status": "born-cell-answer-child-knowledge",
"offeredAt": "1972-03-04T18:04:26.492560+00:00",
"offerExpiresAt": "2018-01-18T03:40:57.554390+00:00",
"acceptedAt": "1994-01-12T03:19:21.854936+00:00",
"updatedAt": "2017-08-22T05:44:30.189656+00:00",
"payments": PaymentPlanPaymentType,
"nextPayment": PaymentPlanPaymentType,
"strategyDisplayName": "believe-kitchen-consider-north-hair",
"ledgerNumber": "center-lot-skill-trade-build"
}PaymentPreferenceConnectionTypeConnection
Pagination object for PaymentPreferenceUnion
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPreferenceConnectionTypeEdge,
"totalCount": 62,
"edgeCount": 96
}PaymentPreferenceConnectionTypeEdge
A Relay edge containing a PaymentPreferenceConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentPreferenceUnion,
"cursor": "life-just-ready-interview-security"
}PaymentRequestConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentRequestConnectionTypeEdge,
"totalCount": 92,
"edgeCount": 27
}PaymentRequestConnectionTypeEdge
A Relay edge containing a PaymentRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentRequestType,
"cursor": "teach-energy-power-first-Republican"
}Fields
| Name | Description |
|---|---|
|
The amount the customer is expected to pay in minor currency. |
|
The date the payment is expected to be made. |
|
The amount that was funded by each funding source. |
|
The status of the payment. |
|
The total amount of the payment in minor currency. |
Example
{
"expectedPaymentDate": "1979-06-06",
"paymentStatus": "newspaper-wonder-onto-item-seek",
"totalAmount": 61,
"customerAmount": 63,
"fundingSourceAmounts": FundingSourceAmountConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
A list of payment requests for a given ledger. |
Example
{
"paymentRequest": PaymentRequestConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentScheduleConnectionTypeEdge,
"totalCount": 29,
"edgeCount": 98
}PaymentScheduleConnectionTypeEdge
A Relay edge containing a PaymentScheduleConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentScheduleType,
"cursor": "choose-yard-would-rest-herself"
}Fields
| Name | Description |
|---|---|
|
The arguments of the delay configuration. |
|
The code of the delay configuration. |
Example
{
"code": "throughout-enough-meet-position-site",
"args": {"key": "value"}
}Fields
| Name | Description |
|---|---|
|
A human-readable description of the value. |
|
Direction of payment day. |
Example
{
"direction": "OF_MONTH",
"description": "spend-let-positive-local-challenge"
}PaymentScheduleType
An object that represents when we have agreed to take payments from a payment instruction.
Fields
| Name | Description |
|---|---|
|
The delay configuration for this payment schedule. |
|
|
|
If the payment schedule is exempt from payment adequacy. |
|
|
|
|
|
The ledger number of the payment schedule. |
|
|
|
|
|
|
|
|
|
Details of the payment_day value. |
|
The frequency of the payment schedule. |
|
|
|
|
|
The reason the payment schedule was created. |
|
The method of payment for the schedule. Deprecated The 'scheduleType' field is deprecated. |
|
The supplementary ledger for this payment schedule, if it is on one. |
|
The sum of the payment adequacy contributions on the payment schedule that are expected to be taken before the debt repayment is complete. |
|
|
|
Example
{
"id": "99199196",
"supplementaryLedger": SupplementaryLedgerType,
"validFrom": "1984-09-07",
"validTo": "1988-03-18",
"reason": "GENERAL_ACCOUNT_PAYMENT",
"paymentHolidayReason": "start-from-view-already-news",
"paymentDay": 16,
"paymentFrequency": "Weekly",
"paymentFrequencyMultiplier": 3,
"paymentAmount": 51,
"paymentAdequacyAdjustment": 61,
"paymentAdequacyAdjustmentExpiryDate": "2023-09-16",
"isVariablePaymentAmount": true,
"totalDebtAmount": 48,
"isPaymentHoliday": true,
"scheduleType": "BACS_TRANSFER",
"paymentDayDetails": PaymentSchedulePaymentDayDetailsType,
"delayConfiguration": PaymentScheduleDelayConfigurationType,
"isExemptFromPaymentAdequacy": true,
"ledgerNumber": "join-including-return-quickly-medical"
}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": PaymentWithNonConcludedRePresentationConnectionTypeEdge,
"totalCount": 77,
"edgeCount": 85
}PaymentWithNonConcludedRePresentationConnectionTypeEdge
A Relay edge containing a PaymentWithNonConcludedRePresentationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PaymentWithNonConcludedRePresentationType,
"cursor": "north-way-new-case-customer"
}Fields
| Name | Description |
|---|---|
|
The amount expected for this payment in minor currency units. |
|
The date this payment is scheduled to be debited. |
Example
{
"amountPayable": 21,
"payableDate": "2004-10-29"
}PayoutReferralForAccount
The possible errors that can be raised are:
- KT-CT-6712: Invalid reference.
- KT-CT-6723: Unauthorized.
- KT-CT-6730: Referral cannot be paid out.
- KT-CT-6731: The account is unrelated to the referral.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The result of the payout. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payoutResult": PayoutReferralForAccountResultType
}PayoutReferralForAccountResultType
The result of the payout of a referral for an account.
Fields
| Name | Description |
|---|---|
|
The amount of the account credit paid out to the referring account. |
Example
{
"accountCreditAmount": 97
}PaysByDirectDebitType
Represents a restriction for if an account should pay only by direct debit in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
| Name | Description |
|---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
Whether the account is paying by direct debit or not. |
|
The type of the term. |
Example
{
"type": "cause-green-here-age-success",
"displayName": "girl-early-issue-wait-left",
"description": "apply-probably-spring-area-never",
"identifier": "37910726",
"isVariable": true,
"paysByDirectDebit": true
}PerformBoostCharge
Initiate a boost charge for an electric vehicle (EV).
This will start charging the EV and will not stop until the battery reaches 100% charged.
If it is not possible to initiate a boost charge, a KT-CT-4357 error will be returned.
It may have a boostChargeRefusalReasons extension which lists the reasons why the boost
charge was refused. Possible reasons include:
BC_DEVICE_NOT_YET_LIVE(device is not yet live)BC_DEVICE_RETIRED(device is retired)BC_DEVICE_SUSPENDED(device is suspended)BC_DEVICE_DISCONNECTED(device is disconnected)BC_DEVICE_NOT_AT_HOME(device is not at home)BC_BOOST_CHARGE_IN_PROGRESS(boost charge already in progress)BC_DEVICE_FULLY_CHARGED(device is already fully charged)
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4356: A boost charge cannot currently be performed.
- KT-CT-4357: Unable to trigger boost charge.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}PerformHouseMove
Performs a house move.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-4410: Invalid postcode.
- KT-CT-3811: Invalid IBAN.
- KT-CT-3822: Unauthorized.
- KT-DE-4903: Unable to proceed.
- KT-DE-3920: No active or pending agreement found.
- KT-DE-3921: Unable to proceed.
- KT-DE-4904: Unable to proceed.
- KT-DE-4905: Unable to proceed.
- 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]
}PerformTestCharge
Initiate a test charge of an electric vehicle (EV).
This is to ensure that the EV or EVSE (charge point) can be controlled remotely and successfully charged for a short period.
If it is not possible to initiate a test charge, a KT-CT-4355 error will be returned. It may have a
testChargeRefusalReasons extension which lists the reasons why the test charge was refused. Possible reasons
include:
TC_DEVICE_LIVE(device is already live)TC_DEVICE_ONBOARDING_IN_PROGRESS(test dispatch already in progress)TC_DEVICE_RETIRED(device is retired)TC_DEVICE_SUSPENDED(device is suspended)TC_DEVICE_DISCONNECTED(device is disconnected)TC_DEVICE_ALREADY_CHARGING(device is already charging)TC_DEVICE_AWAY_FROM_HOME(device is away from home)TC_DEVICE_NO_LOCATION_CONFIGURED(device has no location configured)TC_DEVICE_LOCATION_UNABLE_TO_IDENTIFY(unable to identify device location)TC_DEVICE_LOCATION_MISSING(device location is missing)
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4362: Device not ready for test charge.
- KT-CT-4355: Unable to trigger charge.
- KT-CT-1113: Disabled GraphQL field requested.
- 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],
"krakenflexDevice": KrakenFlexDeviceType
}Fields
| Name | Description |
|---|---|
|
|
|
The type of the bill. |
|
The closing balance of an issued billing document. |
|
Position of the billing document in the delinquent debt tracking system. |
|
The date of the constituent bill covered from. |
|
The ID of the constituent bill. |
|
The unique identifier for the billing document. Note: a pending billing document will not have an identifier yet; and not all finalized billing documents will have an identifier assigned to them, in which case this will be null. |
|
Whether the billing document has been annulled. |
|
The date the bill was sent to the customer. |
|
List of dates when a printed copy of this bill was requested. |
|
|
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the constituent bill covered to. |
|
The total amounts for all charges on the billing document. |
|
The total amounts for all credits on the statement. |
|
Transactions on the given ledger. |
Example
{
"id": "39112042",
"billType": "STATEMENT",
"fromDate": "1986-03-12",
"toDate": "1995-11-13",
"temporaryUrl": "free-different-ever-body-set",
"issuedDate": "2000-01-15",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "90253904",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"isAnnulled": true,
"transactions": BillTransactionConnectionTypeConnection,
"closingBalance": 98,
"documentDebtPosition": BillingDocumentPositionType,
"representations": BillRepresentationConnectionTypeConnection,
"printedCopyRequests": ["1975-08-29"]
}Fields
| Name | Description |
|---|---|
|
All accounts that are linked to this phone number. A maximum of 26 results are returned. Results are ordered by most likely first. |
|
Our best guess for which account a call with this phone number would be about. |
|
All account users that are linked to this phone number. A maximum of 26 results are returned. Results are ordered by most likely first. |
|
Our best guess for which account user would be calling from this phone number. |
Example
{
"accountBestMatch": AccountType,
"accountAllMatches": AccountConnectionTypeConnection,
"accountUserBestMatch": AccountUserType,
"accountUserAllMatches": AccountUserConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
|
The action to perform when the button is pressed. |
|
The button style. |
|
Unique identifier of the object. |
|
Title text of the button. |
|
The name of the object's type. |
Example
{
"buttonStyle": "PRIMARY",
"title": "character-yard-finally-compare-decade",
"buttonAction": ActionType,
"id": "24141745",
"typename": "degree-close-increase-shoulder-true"
}Fields
| Name | Description |
|---|---|
|
Whether the viewer has been blocked due to spending all its allowed points. |
|
The maximum number of points the viewer gets for requests per hour. |
|
The remaining points for the viewer in one hour time limit. |
|
Time To Live: UNIX timestamp when the viewer will get a new allowance of points. |
|
The points used so far in one hour time limit. |
Example
{
"limit": 8,
"remainingPoints": 94,
"usedPoints": 58,
"ttl": 45,
"isBlocked": true
}PointsSizeType
A measurement in points.
Fields
| Name | Description |
|---|---|
|
Unique identifier of the object. |
|
The points value. |
|
The name of the object's type. |
Example
{
"id": "32290296",
"typename": "another-place-eat-truth-because",
"points": 38
}PortfolioConnectionTypeConnection
Paginator of Operations Team
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PortfolioConnectionTypeEdge,
"totalCount": 78,
"edgeCount": 9
}PortfolioConnectionTypeEdge
A Relay edge containing a PortfolioConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PortfolioType,
"cursor": "stock-agree-field-very-buy"
}PortfolioType
An object that represents a portfolio.
Fields
| Name | Description |
|---|---|
|
The accounts associated with this portfolio. |
|
The ancestors of the given portfolio. |
|
|
|
The brand code associated with the portfolio. |
|
|
|
|
|
The depth of the portfolio in the hierarchy. |
|
The descendants of the given portfolio. |
|
|
|
The lead account for this portfolio. |
|
The name of the portfolio. |
|
|
|
Operations team for this portfolio. |
|
The parent portfolio of the given portfolio, if any. |
|
Example
{
"id": "61375403",
"number": "question-she-very-do-room",
"createdAt": "2000-01-19T08:58:06.556501+00:00",
"updatedAt": "1990-03-08T04:10:01.671095+00:00",
"billingName": "thing-relationship-new-think-table",
"collectiveBilling": true,
"operationsTeam": OperationsTeamType,
"leadAccountNumber": "A-1CDB8C17",
"brand": "science-learn-piece-coach-they",
"name": "everything-save-military-seek-develop",
"depth": 79,
"parent": PortfolioType,
"ancestors": PortfolioConnectionTypeConnection,
"descendants": PortfolioConnectionTypeConnection,
"accounts": AccountConnectionTypeConnection
}PortfolioUserRoleType
The role a user has in association with one portfolio.
Fields
| Name | Description |
|---|---|
|
|
|
Portfolio object. |
|
The portfolio role. |
|
Example
{
"id": "75948440",
"user": AccountUserType,
"role": ADMIN,
"portfolio": PortfolioType
}PossibleErrorType
The GraphQL error type for displaying information about GraphQL errors that might be raised from the API.
Fields
| Name | Description |
|---|---|
|
The error code that might be returned from the query/mutation. |
|
The error description that might be returned from the query/mutation. |
|
The error message that might be returned from the query/mutation. |
|
The error type that might be returned from the query/mutation. |
Example
{
"message": "surface-smile-agent-parent-trip",
"code": "animal-fine-current-beautiful-think",
"type": "appear-tough-set-position-accept",
"description": "focus-because-budget-military-air"
}PossibleErrorsOutputType
Information and possible errors of the requested query/mutation.
Fields
| Name | Description |
|---|---|
|
Whether the possible authentication errors are included. |
|
Name of the query/mutation whose possible errors are returned. |
|
List of the errors the query/mutation is susceptible of raising. |
|
Type of the query (query or mutation). |
Example
{
"name": "nice-feeling-treatment-focus-color",
"type": "query",
"authErrors": true,
"possibleErrors": [PossibleErrorType]
}PostCredit
The possible errors that can be raised are:
- KT-CT-5316: Invalid data.
- KT-CT-5311: The credit reason with the requested code is deprecated.
- KT-CT-5312: The credit reason with the requested code does not exist.
- KT-CT-5313: An error occurred whilst posting the credit.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Posted account credit. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"credit": Credit
}Fields
| Name | Description |
|---|---|
|
|
|
The type of the bill. |
|
The date of the bill is covered from. |
|
The gross amount of the historical bill. |
|
The ID of the bill. |
|
The unique identifier of a historical bill. It will usually be present on the billing document itself. |
|
The date the bill was sent to the customer. |
|
The params associated with the historical bill. |
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
The date of the bill is covered to. |
Example
{
"id": "18032717",
"billType": "STATEMENT",
"fromDate": "2014-05-24",
"toDate": "1987-11-14",
"temporaryUrl": "only-significant-room-rather-through",
"issuedDate": "2025-07-10",
"attachments": BillingAttachmentConnectionTypeConnection,
"identifier": "71116917",
"params": {"key": "value"},
"grossAmount": 1
}PreSignedToken
A pre-signed, expiring and opaque tokens that can be swapped for a limited scope JWT (Kraken Token).
Fields
| Name | Description |
|---|---|
|
|
|
|
|
The scope that the token will grant to the account user. |
Example
{
"key": "data-child-police-position-late",
"scope": "SUBMIT_METER_READINGS",
"isValid": true
}PreferredInstruction
Represents the preference of the user to be charged using a specific payment instruction.
Fields
| Name | Description |
|---|---|
|
The start time of the payment preference. |
|
The payment instruction preferred by the user. |
|
The status of the payment preference. |
Example
{
"forPaymentsAfter": "beat-major-bill-organization-nor",
"status": "situation-price-whatever-film-expect",
"paymentMethod": PaymentInstructionType
}Fields
| Name | Description |
|---|---|
|
The account number of the newly created account or the existing account to be re-used. |
|
Was a new account created. |
|
Was a new user created. |
|
The ID of the newly created or existing account user. |
|
The user number of the newly created or existing account user. |
Example
{
"isNewAccount": true,
"accountNumber": "A-99378E40",
"isNewUser": true,
"userId": "69704662",
"userNumber": "capital-wrong-enjoy-thing-something"
}PriceForStream
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
|
The characteristic mapping for the price. |
|
The price per unit. |
|
The scheme labels for the price. |
Example
{
"characteristicMapping": {"key": "value"},
"schemeLabels": {"key": "value"},
"price": "1.0"
}Fields
| Name | Description |
|---|---|
|
|
|
Unit that monetary amount relates to eg. 27 cents per kwh. |
Example
{
"amount": "1.0",
"unit": "KILOWATT_HOURS"
}PrintAttachmentType
Represents a print attachment
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "70578259",
"filename": "strong-head-break-sign-idea",
"s3Bucket": "let-those-sign-military-pressure",
"s3Key": "performance-similar-herself-visit-federal",
"temporaryUrl": "feel-worry-never-into-give"
}PrintBatchType
Represents print batch details
Fields
| Name | Description |
|---|---|
|
|
|
Messages in a print batch. |
|
The status of the print batch. |
Example
{
"id": "96428493",
"status": "OPEN",
"messages": PrintMessageTypeConnection
}Fields
| Name | Description |
|---|---|
|
|
|
The ID of the object |
|
Print message of the print event. |
|
Example
{
"id": "49424413",
"eventType": "develop-election-dream-focus-best",
"occurredAt": "1994-05-23T04:10:49.962193+00:00",
"message": PrintMessageType
}PrintMessageType
Represents a print communication.
Fields
| Name | Description |
|---|---|
|
|
|
Attachments of the message. |
|
Comms that are marked as high priority. |
|
The ID of the object |
|
Example
{
"id": "60676132",
"templateCode": "Republican-think-follow-wish-character",
"account": AccountType,
"attachments": [PrintAttachmentType],
"highPriority": true
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PrintMessageTypeEdge,
"totalCount": 5,
"edgeCount": 34
}PrintMessageTypeEdge
A Relay edge containing a PrintMessageType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": PrintMessageType,
"cursor": "resource-these-control-change-tell"
}ProcessOrderOutput
Output type for the result of processing an order.
Fields
| Name | Description |
|---|---|
|
The unique identifier of the processed order. |
|
The resources associated with the processed order. |
|
The status of the order processing. |
Example
{
"status": "PENDING",
"identifier": "73141477",
"resources": [OrderResource]
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
When the contractual binding starts, relative to the supply start date. |
|
This will be shown to customers during sign-up |
|
This name will be shown to customers during sign-up |
|
This is when end-dated products expire |
|
|
|
Whether the product has a minimum term (contract binding). |
|
Use this field to temporarily make a product unavailable |
|
Whether the product is a time of use product. |
|
|
|
The minimum term (contract binding) in months. 0 means no minimum term. |
|
The notice period in days. |
|
|
|
The price guarantee in months. 0 means no price guarantee. |
|
The type of price guarantee for the product. |
|
Duration of agreements using this product in months |
|
Example
{
"code": "itself-idea-may-wonder-debate",
"fullName": "professional-happy-maintain-quality-find",
"displayName": "sound-statement-argue-ahead-century",
"description": "deal-major-production-house-air",
"availableFrom": "2000-10-21T14:57:25.165332+00:00",
"availableTo": "1973-10-24T22:51:06.254805+00:00",
"isHidden": true,
"term": 44,
"endsAt": "2016-01-16T01:25:32.155886+00:00",
"marketName": "save-affect-city-near-daughter",
"availabilityStatus": "PUBLIC",
"termsContractType": "hard-clearly-decision-no-ready",
"params": {"key": "value"},
"hasMinimumTerm": true,
"minimumTerm": 4,
"noticePeriod": 70,
"priceGuaranteeInMonths": 52,
"priceGuaranteeType": "NONE",
"isTimeOfUse": true,
"contractBindingStart": "WITH_CONTRACT_CONFIRMATION"
}ProductComponentType
Represents a product component within an offering.
Fields
| Name | Description |
|---|---|
|
The product 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": "64377455",
"minimumQuantity": 92,
"maximumQuantity": 76,
"initialQuantity": 59,
"component": CatalogProductType
}ProductRateOverrideConfigurationType
Configuration for Product Rate Override Configuration term.
Fields
| Name | Description |
|---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
The indexation options for the product rate override configuration. |
|
Whether the term is variable. |
|
The schedules for the product rate override configuration. |
|
The type of the term. |
Example
{
"type": "debate-page-use-medical-affect",
"displayName": "down-so-baby-owner-reality",
"description": "adult-check-house-summer-Mrs",
"identifier": "21813668",
"isVariable": true,
"indexationOptions": IndexationOptionsType,
"schedules": [ProductRateOverrideScheduleType]
}ProductRateOverrideItemType
Item for Product Rate Override Configuration term.
Fields
| Name | Description |
|---|---|
|
The price per unit for the product rate override item. |
|
The product code for the product rate override item. |
|
The rate band for the product rate override item. |
Example
{
"productCode": "red-suffer-human-society-part",
"rateBand": "cost-actually-garden-talk-look",
"pricePerUnit": "1.0"
}ProductRateOverrideScheduleType
Schedule for Product Rate Override Configuration term.
Fields
| Name | Description |
|---|---|
|
The effective from date for the product rate override schedule. |
|
The items for the product rate override schedule. |
Example
{
"items": [ProductRateOverrideItemType],
"effectiveFrom": "1994-10-19T04:57:19.053264+00:00"
}ProductSwitch
Confirm a product switch (self-serve).
The possible errors that can be raised are:
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-1509: Unable to create agreement.
- KT-DE-4902: Unable to proceed.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the product switch was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"productSwitched": true
}Fields
| Name | Description |
|---|---|
|
Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
|
The entire formatted address represented as a single string, as it would be written on an envelope. The formatting of this field may vary according to the country of the address (which may not match this Kraken installation's home country). It may also change if we update our address-formatting code or if our understanding of the correct formatting for a given country changes. Avoid parsing individual components of an address out of this field's value; use the other fields on this type instead. |
|
ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
|
Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
|
UK dependent localities, or neighbourhoods or boroughs in some other locations. |
|
City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
|
A personal name. |
|
The name of a business or organisation. |
|
Postal code (ZIP code in the US). |
|
Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
|
The 'street address' component. This value can (and often will) contain newline characters when appropriate. In some cases, data may appear in this field instead of the
below fields; e.g. a UK post town name may appear here
instead of in the If |
|
The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "argue-commercial-when-hold-reveal",
"organization": "yourself-whom-detail-child-as",
"streetAddress": "authority-allow-project-food-probably",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "network-series-defense-lead-central",
"locality": "data-discuss-generation-lead-participant",
"administrativeArea": "finish-nothing-job-right-maybe",
"postalCode": "without-difficult-artist-actually-head",
"sortingCode": "good-hear-force-bank-air",
"country": "soon-challenge-end-once-rest",
"deliveryPointIdentifier": "29067626",
"asString": "board-choose-rich-light-daughter"
}Fields
| Name | Description |
|---|---|
|
The matched property. |
|
A score representing the degree of confidence for a match. |
Example
{
"score": "1.0",
"property": PropertyType
}Fields
| Name | Description |
|---|---|
|
The address of the property, formatted into a single string. |
|
Coordinates for the property, useful for displaying the property on a map. |
|
All the electricity supply points at this property. |
|
The embedded network this property belongs to, if any. |
|
All the gas supply points at this property. |
|
|
|
An optional label for the property. |
|
Measurements at a property |
|
Time periods during which the property is associated with an account. Useful to display information about house-moves, as performing a move out of a property will set the end date for the occupancy period. |
|
The postcode of the property. |
|
Property rich address. |
|
List of address lines. |
Example
{
"id": "48423855",
"postcode": "catch-dark-quality-some-we",
"address": "him-may-picture-summer-control",
"richAddress": PropertyRichAddressType,
"splitAddress": ["sea-anything-remember-our-approach"],
"label": "among-social-toward-education-leg",
"occupancyPeriods": [OccupancyPeriodType],
"coordinates": CoordinatesType,
"embeddedNetwork": EmbeddedNetworkType,
"measurements": MeasurementConnection,
"smartDeviceNetworks": [SmartMeterDeviceNetworkType],
"isChangeOfTenancyOngoing": true,
"isSmets2InstallationAllowed": true,
"electricityMeterPoints": [ElectricityMeterPointType],
"gasMeterPoints": [GasMeterPointType],
"wanCoverage": "HIGH",
"availableSmets2InstallationTimeslots": [Smets2InstallationTimeslotType]
}Fields
| Name | Description |
|---|---|
|
OAuth 2.0 URI for the provider. |
Example
{
"oauthUri": "see-really-necessary-serve-tough"
}ProviderVirtualKeyDetailsType
Details of a public key that can be added to devices for end-to-end authentication or encryption.
E.g. for Tesla the user visits a URL and the name can be used to show what the key is called. https://github.com/teslamotors/vehicle-command#distributing-your-public-key
Fields
| Name | Description |
|---|---|
|
Friendly human-readable name for the virtual key. |
|
URI for the virtual key. |
Example
{
"virtualKeyName": "environmental-may-least-woman-set",
"virtualKeyUri": "federal-military-each-land-environment"
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ProvisionalTransactionConnectionTypeEdge,
"totalCount": 59,
"edgeCount": 4
}ProvisionalTransactionConnectionTypeEdge
A Relay edge containing a ProvisionalTransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ProvisionalTransactionType,
"cursor": "color-similar-term-special-behind"
}ProvisionalTransactionType
A provisional transaction represents some debit or credit to or from a customer's account which we cannot yet finalise for some reason, but which is still useful to keep a note of, and display to the customer. Provisional transactions are purely to give guidance in the absence of finalised information. We therefore only return provisional transactions that have not been finalised. When a transaction is finalised, it is available through the transactions field.
Fields
| Name | Description |
|---|---|
|
The amount in pence for this provisional transaction. It will be negative for charges, positive for credits. |
|
The date at which the charge should be applied to the account. |
|
|
|
A user readable string that indicates what this transaction relates to. |
Example
{
"id": "86848528",
"title": "young-economic-any-investment-exist",
"amount": 14,
"date": "2002-01-16"
}Fields
| Name | Description |
|---|---|
|
The cost for the charge added during a charging session. |
|
The end time of a charging session. |
|
The energy added during a charging session. |
|
Location of the charging session. |
|
URL of the operator image. |
|
The start time of a charging session. |
|
The change in state of charge during a charging session. The value will be between 0 and 100, if not null. |
|
The final state of charge after a charging session. The value will be between 0 and 100, if not null. |
PublishTransactionalMessagingExternalTrigger
Publish an externally defined transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-5421: Account user not found.
- KT-CT-9901: Invalid trigger type code.
- KT-CT-9905: Top-level context fields are missing.
- KT-CT-9906: Template variables do not match the defined schema.
- KT-CT-9908: Invalid recipient information.
- KT-CT-9909: Invalid recipient information.
- KT-CT-9910: Invalid input field combination.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The trigger that has been published. |
Example
{
"possibleErrors": [PossibleErrorType],
"trigger": Trigger
}PublishTransactionalMessagingTrigger
Publish a trigger within the transactional messaging service.
The possible errors that can be raised are:
- KT-CT-9901: Invalid trigger type code.
- KT-CT-9902: Invalid trigger type params.
- KT-CT-9903: Trigger type cannot be published externally.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The trigger that has been published. |
Example
{
"possibleErrors": [PossibleErrorType],
"trigger": Trigger
}Fields
| Name | Description |
|---|---|
|
The voucher purchase created from the mutation. |
Example
{
"voucherPurchase": VoucherPurchaseType
}PushNotificationBindingType
Represents a pairing of a single app installation to an account user.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"id": "23262545",
"messages": SMSMessageType,
"user": AccountUserType,
"token": "memory-enough-detail-bad-indicate",
"application": NotifiableApplicationType,
"registeredAt": "2025-10-16T22:20:01.304668+00:00",
"expiresAt": "1978-11-10T18:30:49.757075+00:00"
}QuantityType
Graphene type object to represent Quantity(magnitude, unit)
Fields
| Name | Description |
|---|---|
|
The numeric value of this field. |
|
Unit of this field. |
Example
{
"magnitude": 348.98,
"unit": "continue-high-history-drop-yeah"
}Fields
| Name | Description |
|---|---|
|
The complexity of the query. |
Example
{
"complexityValue": 52
}Fields
| Name | Description |
|---|---|
|
The cost for quoting this product. |
|
The date and time when the quote component was created. |
|
Identifier of the Quote. |
|
Identifier of the Product Component. |
|
The input data used for quoting this product component. |
|
S3 URLs for terms and conditions linked to this quote component. |
Example
{
"identifier": "24812906",
"productComponentIdentifier": "69629489",
"costs": [QuoteCostType],
"quotingParamsInputData": {"key": "value"},
"createdAt": "1980-10-26T16:28:42.827622+00:00",
"termsAndConditionsS3Urls": [TermsAndConditionsS3UrlType]
}Fields
| Name | Description |
|---|---|
|
Name of the cost field. |
|
Value of the cost field. |
Example
{
"key": "better-media-likely-attack-year",
"value": QuoteCostUnionType
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"postcode": "wife-close-price-behind-describe",
"city": "wonder-result-magazine-project-wonder",
"street": "relationship-which-where-face-everyone",
"houseNumber": "edge-close-story-cost-cold",
"gasNetworkOperatorNumber": "nor-meet-one-according-else",
"gasNetworkOperatorId": "57917803",
"gasNetworkOperatorName": "public-themselves-after-when-child",
"electricityNetworkOperatorNumber": "daughter-force-situation-wide-increase",
"electricityNetworkOperatorId": "30132285",
"electricityNetworkOperatorName": "west-process-support-hard-table",
"supplierId": "85247579",
"tariffId": "21921223"
}Fields
| Name | Description |
|---|---|
|
The date and time when the quote was created. |
|
The Actor who created the Quote. |
|
Identifier of the Quote. |
|
The product offering identifier this Quote is related to. |
|
Quote components of this quote. |
Example
{
"identifier": "97669837",
"createdAt": "1970-03-01T20:30:32.498654+00:00",
"productOfferingIdentifier": "72078799",
"quoteComponents": [QuoteComponentType],
"createdBy": ActorType
}Fields
| Name | Description |
|---|---|
|
Quoting components of this quote. |
|
Product offering identifier. |
|
Product component data including its quoting parameters. |
Example
{
"offeringIdentifier": "75579045",
"productComponents": [QuotedProductComponentType],
"offeringComponents": [QuotedOfferingParamsType]
}Fields
| Name | Description |
|---|---|
|
The client parameters used to generate the quoted product. Deprecated The 'clientParams' field is deprecated. |
|
The quoted product ID. |
|
Whether the quoted product is still valid for the (retention) product switch. |
|
Monthly standing charge in €. |
|
Net monthly standing charge in €. |
|
The product associated with the quoted product. |
|
Number of days the retention offer for the quoted product is valid for. |
|
The date the retention offer was generated and sent to the customer. |
|
Total estimated annual bill in €. |
|
The unit rate information. |
|
Whether the quoted product was selected by the user. |
Example
{
"id": 65550473,
"product": Product,
"wasSelected": true,
"clientParams": QuotedProductClientParams,
"totalEstimatedAnnualBill": "1.0",
"monthlyStandingCharge": "1.0",
"netMonthlyStandingCharge": "1.0",
"unitRateInformation": UnitRateInformation,
"retentionNumberOfValidDays": 25,
"retentionOfferGenerationDate": "1972-08-11",
"isValidForRetentionProductSwitch": true
}Fields
| Name | Description |
|---|---|
|
Annual consumption in kWh. |
|
Monthly standing charge in €. |
|
Net monthly standing charge in €. |
|
Net unit rate per kWh in €. |
|
Total estimated annual bill in €. |
|
Unit rate per kWh in €. |
Example
{
"annualConsumption": 20,
"monthlyStandingCharge": "1.0",
"netMonthlyStandingCharge": "1.0",
"unitRatePerKwh": "1.0",
"netUnitRatePerKwh": "1.0",
"totalEstimatedAnnualBill": "1.0"
}Fields
| Name | Description |
|---|---|
|
Product code. |
|
Quoting parameter definitions for this product. |
Example
{
"productCode": "28992834",
"quotingParams": [QuotingParamType]
}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": QuotedProductEdge,
"totalCount": 69,
"edgeCount": 89
}QuotedProductEdge
A Relay edge containing a QuotedProduct and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": QuotedProduct,
"cursor": "sing-range-indeed-practice-if"
}QuotedSupplyPointType
Information about a quoted supply point.
Fields
| Name | Description |
|---|---|
|
Annual consumption in kWh. |
|
Annual nighttime consumption in kWh. |
|
The network charges that will have to be paid for this product. For electricity supply points this will always be |
|
The BDEW-assigned ID of the network operator. |
|
The products that have been quoted for this supply point. You must specify at least one the |
|
The supply type of this supply point. |
Example
{
"supplyType": "ELECTRICITY",
"annualConsumption": 74,
"annualNighttimeConsumption": 82,
"networkOperatorNumber": "call-card-win-south-appear",
"networkCharges": NetworkChargesInterface,
"quotedProducts": QuotedProductConnection
}Fields
| Name | Description |
|---|---|
|
Choices of the quoting parameter if present. |
|
Name of the quoting parameter. |
|
Type of the quoting parameter. |
Example
{
"name": "current-as-action-establish-machine",
"type": "reveal-large-challenge-expert-ground",
"choices": ["money-bed-film-live-history"]
}RateGroupEligibilityConfigurationType
Represents a rate group eligibility term of in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
| Name | Description |
|---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
A list of rate group eligibility schedules associated with the contract. |
|
A list of time series specification eligibility schedules associated with the contract. |
|
The type of the term. |
Example
{
"type": "wide-chair-world-product-visit",
"displayName": "focus-development-show-member-power",
"description": "leader-hit-financial-financial-weight",
"identifier": "68298789",
"isVariable": true,
"schedules": [RateGroupEligibilityScheduleType],
"timeSeriesSpecificationSchedules": [TimeSeriesSpecificationEligibilityScheduleType]
}RateGroupEligibilityPeriodType
Represents a period with a start and optional end date.
Note: This type is a stub, and will be fleshed out in the future.
Fields
| Name | Description |
|---|---|
|
The end date and time of the period. |
|
The start date and time of the period. |
Example
{
"start": "2004-12-13T14:52:59.085571+00:00",
"end": "1986-10-25T21:47:43.065968+00:00"
}RateGroupEligibilityScheduleType
Represents a schedule for rate group eligibility within a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
| Name | Description |
|---|---|
|
The period during which this eligibility is effective. |
|
Indicates if the rate group is eligible. |
|
The product code associated with the rate group. |
|
The rate group code. |
Example
{
"productCode": "product-history-budget-chance-floor",
"rateGroupCode": "our-eat-compare-water-daughter",
"isEligible": true,
"effectivePeriod": RateGroupEligibilityPeriodType
}RateGroupPrices
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
|
The prices for the rate group. |
|
The rate group code. |
Example
{
"rateGroup": "writer-hair-such-position-build",
"prices": PriceForStream
}ReactivateCollectionProcessRecord
Reactivate a Collection Process Record that was previously activated.
Unlike UpdateCollectionProcessRecordToActive, this mutation does not require or update the external_reference field. Use this when reactivating a collection process that already has an external_reference set from its initial activation.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11217: Invalid collection process record status for reactivation.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The reactivated collection process record. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessReactivated": ReactivateCollectionProcessRecordOutputType
}ReactivateCollectionProcessRecordOutputType
Output for reactivating a Collection process Record.
Fields
| Name | Description |
|---|---|
|
The number of the collection process record. |
|
The current status of the collection process record. |
Example
{
"number": "animal-tax-camera-seek-doctor",
"status": "PENDING"
}Fields
| Name | Description |
|---|---|
|
The exclusive end of this reading's interval. |
|
The inclusive start of this reading's interval. |
|
The quality of this reading if applicable. |
|
The source of this reading if applicable. |
|
This reading's units. |
|
The recorded value for this reading. |
Example
{
"value": "1.0",
"units": "trip-himself-piece-purpose-future",
"intervalStart": "1989-08-24T02:24:18.458998+00:00",
"intervalEnd": "2014-09-12T17:45:35.289647+00:00",
"source": "again-leg-choose-economy-save",
"quality": "popular-already-similar-window-generation"
}Fields
| Name | Description |
|---|---|
|
Readings representing outgoing utility flow e.g., solar generation. |
|
Readings representing incoming utility flow e.g., usage or consumption.. |
Example
{
"exportReadings": ExportReadingsConnection,
"importReadings": ImportReadingsConnection
}RecordDepositAgreementAccepted
Record the customer's acceptance of a deposit agreement.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"isRecorded": true
}Fields
| Name | Description |
|---|---|
|
The action to perform when the button is pressed. |
|
The button style. |
|
Unique identifier of the object. |
|
Title text of the button. |
|
The name of the object's type. |
|
Colour style of button eg. filled, outlined, text_only. |
Example
{
"buttonStyle": "PRIMARY",
"title": "activity-material-little-section-very",
"buttonAction": ActionType,
"id": "11176507",
"typename": "political-glass-short-old-loss",
"variant": "FILLED"
}RedeemLoyaltyPointsForAccountCredit
Redeem Loyalty Points as account credit.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9201: No Loyalty Point ledger found for the user.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9203: No ledger entries for the ledger.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9206: Indivisible points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The number of loyalty points that were redeemed. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 91
}RedeemReferralClaimCode
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6724: Referral claim code not found.
- KT-CT-6725: Referral claim code redeeming error.
- KT-CT-6726: Referral claim code has already been redeemed.
- KT-CT-6727: Referral claim code is not available.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether or not the request was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}ReferralClaimCodeType
Referral claim code is a way of claiming promotional benefit coming from the partner-reward referral schemes.
Fields
| Name | Description |
|---|---|
|
Account referral associated with the claim code. |
|
Datetime when claim code was generated. |
|
Id of claim code instance. |
|
Whether the referral claim code is valid and available for use. |
|
Referral scheme claim code belongs to. |
|
Value of claim code. |
Example
{
"id": 64913173,
"value": "sometimes-truth-upon-operation-service",
"referralScheme": ReferralSchemeType,
"accountReferral": ReferralType,
"isValid": true,
"createdAt": "1980-07-15T16:40:52.941693+00:00"
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total payment amount given to the referring account in the smallest unit. of the client's currency. If you filter the referrals by |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ReferralConnectionTypeEdge,
"totalCount": 67,
"edgeCount": 24,
"referringUserTotalPaymentAmount": 54
}ReferralConnectionTypeEdge
A Relay edge containing a ReferralConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": ReferralType,
"cursor": "reach-game-skill-shoulder-your"
}ReferralSchemeType
A referral scheme is a way for one account to earn a reward for referring another. This is achieved by the referred account using a url (provided by the referring account) to sign up.
Fields
| Name | Description |
|---|---|
|
Whether the current account is eligible to be referred under this scheme. |
|
The unique code for the scheme. |
|
The reward amount received by the referrer and the referee combined. |
|
True if the the scheme has limit of uses, and if the usage is at capacity. |
|
The number of loyalty points to be awarded to the referrer in addition to the reward amount. |
|
Max number of times this referral code can be credited to a given account. |
|
A referral url for display purposes. |
|
A fully qualified url give people to create accounts referred by this scheme. |
|
The reward amount received by the referred party. |
|
The family name of the person making the referral. Deprecated The 'referrerFamilyName' field is deprecated. |
|
The given name of the person making the referral. |
|
The reward amount received by the referrer. |
|
Scheme type of the referral scheme. |
Example
{
"referralUrl": "ground-wide-garden-thank-want",
"referralDisplayUrl": "especially-edge-hour-never-fire",
"referrerRewardAmount": 96,
"referredRewardAmount": 72,
"combinedRewardAmount": 84,
"loyaltyPointsBonus": 75,
"canBeReferred": true,
"code": "law-share-simply-language-involve",
"referrerGivenName": "Nicole",
"referrerFamilyName": "Wagner",
"schemeType": "nearly-number-remember-six-company",
"maxRecurrence": 66,
"isUsageAtCapacity": true
}Fields
| Name | Description |
|---|---|
|
A business scheme type. |
|
A domestic scheme type. |
|
A friends and family scheme type. Deprecated The 'friendsAndFamily' field is deprecated. |
Example
{
"domestic": ReferralSchemeType,
"business": ReferralSchemeType,
"friendsAndFamily": ReferralSchemeType
}ReferralType
Details of an account referral
Fields
| Name | Description |
|---|---|
|
The referral code. |
|
The payment amount in the smallest unit of the clients currency received by the referrer and the referee combined. |
|
|
|
The ID of the ledger which the referral is assigned to. Deprecated The 'ledgerId' field is deprecated. |
|
The number of the ledger which the referral is assigned to. |
|
The date when the payment was made. |
|
The status of the payment. |
|
The date the referred user joined. |
|
The name of the referred user. |
|
Payment amount given to the referred account in the smallest unit of the client's currency. |
|
Payment amount given to the referring account in the clients fractional currency unit. |
|
The type of reward scheme. |
Example
{
"id": "46450117",
"paymentDate": "1982-03-13",
"schemeType": "REFERRAL_REWARD",
"code": "else-after-film-only-student",
"referredUserName": "morning-turn-do-arm-pass",
"paymentStatus": "land-officer-me-black-the",
"referredUserJoinDate": "2005-06-24T23:04:17.303695+00:00",
"referredUserPaymentAmount": 80,
"referringUserPaymentAmount": 6,
"combinedPaymentAmount": 57
}RefreshToken
An opaque token that can be used to renew a Kraken Token.
Fields
| Name | Description |
|---|---|
|
The datetime when the token will expire. |
|
|
|
Example
{
"key": "result-suddenly-lawyer-would-push",
"expiryDt": "2009-02-09T23:47:45.949720+00:00",
"isValid": true
}Refund
A refund to the customer from the energy supplier.
Fields
| Name | Description |
|---|---|
|
Unique identifier of the account the transaction belongs to. |
|
Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
|
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
|
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
|
The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
|
The date time when the transaction is created. |
|
Returns True if the transaction is linked with a statement. |
|
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": "49692100",
"postedDate": "2024-10-04",
"createdAt": "2013-12-26T09:33:24.652729+00:00",
"accountNumber": "A-726FD61F",
"amount": 85,
"amounts": TransactionAmountType,
"balanceCarriedForward": 55,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "either-official-arm-north-low",
"billingDocumentIdentifier": "66434221",
"statementId": "63697481",
"isReversed": true,
"hasStatement": true,
"note": "study-scene-value-entire-since",
"reasonCode": "third-college-degree-close-attention"
}RefundPayment
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-3929: The payment is not in a refundable state.
- KT-CT-3933: Refund amount greater than payment amount.
- KT-CT-3937: Payment not eligible for refund.
- KT-CT-3938: Partial refund not allowed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The repayment for the requested refund. |
Example
{
"possibleErrors": [PossibleErrorType],
"repayment": AccountRepaymentType
}Fields
| Name | Description |
|---|---|
|
The amount of money requested. |
|
The payment which is being refunded. |
|
Internal code for the reason the refund is being requested. |
|
The ID of the refund request. |
|
The current status of the refund request. |
Example
{
"requestId": "55529669",
"amount": 18,
"payment": AccountPaymentType,
"reasonCode": "whom-reflect-decision-place-smile",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RefundRequestConnectionTypeEdge,
"totalCount": 62,
"edgeCount": 88
}RefundRequestConnectionTypeEdge
A Relay edge containing a RefundRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": RefundPaymentRequestType,
"cursor": "little-senior-social-challenge-career"
}RegenerateSecretKey
Regenerate the user's API key.
Fields
| Name | Description |
|---|---|
|
The generated key value, which is only ever available once (here). |
|
The currently authenticated user. |
Example
{
"key": "memory-environment-social-trade-something",
"viewer": AccountUserType
}RegisterLeadFlowStatusEvent
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}RegisterOpportunityFlowStatusEvent
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"pushNotificationBinding": PushNotificationBindingType
}RegisterReadingConnectionTypeConnection
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": RegisterReadingConnectionTypeEdge,
"totalCount": 56,
"edgeCount": 40
}RegisterReadingConnectionTypeEdge
A Relay edge containing a RegisterReadingConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": BaseRegisterReadingType,
"cursor": "others-plan-glass-method-top"
}RegistersConnection
Pagination for device registers.
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": RegistersEdge,
"totalCount": 86,
"edgeCount": 79
}RegistersEdge
A Relay edge containing a Registers and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": DeviceRegister,
"cursor": "defense-too-step-hear-standard"
}Fields
| Name | Description |
|---|---|
|
The name of the team responsible for completing the reminder. |
|
The username of the user responsible for completing the reminder. |
|
Reminder content. |
|
The date and time the account reminder was created. |
|
When the reminder is due. |
|
The unique ID of the reminder. |
|
If the reminder is managed by Kraken. |
|
The reminder type name. |
|
Reopen ink conversation. |
Example
{
"id": 64149956,
"reminderTypeName": "management-second-president-hour-specific",
"isKrakenManaged": true,
"content": "pick-statement-style-nearly-across",
"dueAt": "2012-01-05T19:33:07.281350+00:00",
"assigneeUsername": "turn-energy-that-water-article",
"assigneeTeamName": "argue-ahead-floor-hear-market",
"reopenInkConversation": true,
"createdAt": "2008-09-09T04:59:15.632406+00:00"
}RemoveCampaignFromAccount
The possible errors that can be raised are:
- KT-CT-7424: Failed to remove campaign from account.
- KT-CT-7426: The account is not part of the given campaign.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the campaign was successfully removed from the account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignRemoved": true
}RemoveCampaignItems
The possible errors that can be raised are:
- KT-CT-11501: Voice campaign not found.
- KT-CT-11502: Cannot remove items from multiple campaigns at once.
- KT-CT-11505: Voice campaign item not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignItems": [VoiceCampaignItemType]
}RemoveItemsFromRiskList
Remove existing items from risk list.
The possible errors that can be raised are:
- KT-CT-12106: Risk list item removal failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
List of successfully removed risk identifiers. |
Example
{
"possibleErrors": [PossibleErrorType],
"riskIdentifiers": [RiskListItemType]
}Fields
| Name | Description |
|---|---|
|
The repayment intervention outcome. |
|
The repayment intervention reason. |
Example
{
"outcome": "yet-opportunity-to-issue-over",
"reason": "film-can-wear-sell-after"
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RepaymentRequestConnectionTypeEdge,
"totalCount": 49,
"edgeCount": 80
}RepaymentRequestConnectionTypeEdge
A Relay edge containing a RepaymentRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": RepaymentRequestType,
"cursor": "check-sport-important-become-direction"
}Fields
| Name | Description |
|---|---|
|
The amount of money requested. |
|
The payment instruction, if any, associated with the repayment request. |
|
The method by which the money will be transferred to the customer. |
|
Classifier code for repayment reason. |
|
The ID of the repayment request. |
|
The current status of the repayment request. |
Example
{
"requestId": "66737550",
"amount": 3,
"reasonCode": "point-able-visit-close-without",
"method": "BANK_TRANSFER",
"instruction": PaymentInstructionType,
"status": "REQUESTED"
}RequestDoubleOptIn
Request a double opt in for a consent.
This mutation will create a consent with a value of PENDING and publish a double opt-in requested transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-9019: Invalid input.
- KT-CT-9018: Account not found.
- KT-CT-1111: Unauthorized.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9023: Consent already accepted.
- KT-CT-1199: Too many requests.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The consent that was created or updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}Fields
| Name | Description |
|---|---|
|
The email that requested a password reset email. |
|
The number of the user that requested a password reset email. |
Example
{
"email": "now-important-center-dog-get",
"userNumber": "four-staff-total-plan-really"
}RequestPrintedBill
Request an issued bill to be printed and (re)posted to billing address of the account.
The possible errors that can be raised are:
- KT-CT-3824: Unauthorized.
- KT-CT-9705: The billing document has not been issued.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the request was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
|
Whether the account can request a refund. |
|
The reason why a refund cannot be requested. |
Example
{
"canRequestRefund": true,
"reason": "affect-board-consider-tax-human"
}RequestRepaymentOutputType
Output for creating a repayment request.
Fields
| Name | Description |
|---|---|
|
The ID of the repayment request. |
|
The current status of the repayment request. |
Example
{
"requestId": "93614214",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"errors": [SerializerFieldErrorsType],
"clientMutationId": "88717928"
}Fields
| Name | Description |
|---|---|
|
A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
|
A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
|
True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
|
The ID of the user whose password was changed. |
Example
{
"userId": "64080309",
"passwordUpdated": true,
"failureReasons": ["buy-part-understand-in-want"],
"failureCodes": ["small-research-identify-performance-tree"]
}ResumeCollectionProcess
Manually resume a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11215: Unable to resume, collection process is not paused.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Collection process resume output. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessResumed": ResumeCollectionProcessOutput
}Fields
| Name | Description |
|---|---|
|
Pause records on the collection process. |
Example
{
"pauseRecords": [CollectionProcessPauseStatusRecord]
}ResumeDeviceControl
Resume control of a device after having been away from home.
This is so that the device can be charged again according to the set preferences.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4359: Unable to resume device control.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}Fields
| Name | Description |
|---|---|
|
A list of the quoted product ids that were offered in the retention offer sent to the customer. |
|
The date on which the retention offer expires. |
|
A tokenized url for viewing retention offer quoted products. |
Example
{
"quotedProductIds": ["artist-law-have-front-class"],
"quotedProductSwitchUrl": "office-answer-who-reduce-treat",
"quotedProductSwitchExpiryDate": "thought-world-affect-view-eat"
}RevokeAgreement
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-1501: Agreement not found.
- KT-CT-1502: Billed agreements cannot be revoked.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Account responsible for the revoked agreement. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}RevokeContract
Revoke a contract for a given supply point and send confirmation email to the customer.
The possible errors that can be raised are:
- KT-CT-4923: Unauthorized.
- KT-CT-4922: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Whether the contract revocation was successful. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contractRevoked": true
}RevokeSupplyContract
Revoke a contract for a given supply point and send confirmation email to the customer.
The possible errors that can be raised are:
- KT-CT-4923: Unauthorized.
- KT-CT-4922: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Whether the contract revocation was successful. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contractRevoked": true
}RevokeUserAccessFromBusiness
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]
}RewardType
A reward is based on a scheme that an account has applied for in order to be
eligible for a discount. Examples can include signup, promo, or partner codes that
were applied to an account.
Fields
| Name | Description |
|---|---|
|
The referral code. |
|
|
|
The ID of the ledger which the referral is assigned to. Deprecated The 'ledgerId' field is deprecated. |
|
The number of the ledger which the referral is assigned to. |
|
The date when the payment was made. |
|
The status of the reward payment. |
|
Reward amount given to the account in the smallest unit of the clients currency. |
|
The type of reward scheme. |
Example
{
"id": "92931296",
"paymentDate": "1993-08-25",
"schemeType": "REFERRAL_REWARD",
"code": "people-that-bill-trade-maybe",
"rewardAmount": 83,
"paymentStatus": "Pending"
}RichAddressType
A postal address.
This data model is based on the structure used by Google's libaddressinput library—so you can use it, or other libraries that use its data model and reference data, to accept input.
All fields can be blank, except for country which must
always be supplied.
If you only need the address in a single string, use the
asString property. If you need the address as a list of
lines, use the asString property, then use
.splitlines() (or your programming language's
equivalent) on the resulting value.
Fields
| Name | Description |
|---|---|
|
Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
|
The entire formatted address represented as a single string, as it would be written on an envelope. The formatting of this field may vary according to the country of the address (which may not match this Kraken installation's home country). It may also change if we update our address-formatting code or if our understanding of the correct formatting for a given country changes. Avoid parsing individual components of an address out of this field's value; use the other fields on this type instead. |
|
ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
|
Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
|
UK dependent localities, or neighbourhoods or boroughs in some other locations. |
|
City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
|
A personal name. |
|
The name of a business or organisation. |
|
Postal code (ZIP code in the US). |
|
Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
|
The 'street address' component. This value can (and often will) contain newline characters when appropriate. In some cases, data may appear in this field instead of the
below fields; e.g. a UK post town name may appear here
instead of in the If |
|
The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "future-miss-blood-form-one",
"organization": "reveal-kitchen-field-the-over",
"streetAddress": "letter-position-capital-bag-seat",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "such-southern-better-police-choose",
"locality": "cup-cost-population-short-join",
"administrativeArea": "current-point-source-enter-floor",
"postalCode": "decide-my-anything-important-position",
"sortingCode": "human-necessary-speech-those-increase",
"country": "car-apply-democratic-audience-write",
"deliveryPointIdentifier": "53258785",
"asString": "hear-factor-realize-majority-strong"
}RiskListItemType
Represents the result of importing/removing risk identifiers into the risk list with detailed information.
Fields
| Name | Description |
|---|---|
|
The unique identifier of the edited risk identifier. |
Example
{
"riskIdentifierId": "92989777"
}Fields
| Name | Description |
|---|---|
|
|
|
The ID of the object |
|
SMS message of the SMS event. |
|
Example
{
"id": "71861588",
"eventType": "color-appear-investment-oil-claim",
"occurredAt": "2020-02-07T21:42:44.686002+00:00",
"message": SMSMessageType
}SMSMessageType
Represents a SMS communication.
Fields
| Name | Description |
|---|---|
|
|
|
Attachments of the message. |
|
|
|
SMS recipient. |
|
SMS sender. |
|
|
|
SMS body. |
Example
{
"id": "19119027",
"sentAt": "1997-04-20T00:06:56.737739+00:00",
"account": AccountType,
"attachments": [AttachmentType],
"sender": "later-low-understand-worker-sport",
"recipient": "charge-need-relationship-trade-sing",
"textBody": "network-need-particularly-level-heavy"
}SalesChannelType
A sales channel.
Fields
| Name | Description |
|---|---|
|
The sales channel code. |
|
The sales channel description. |
|
The hierarchical name of the sales channel. |
|
The name of the sales channel. |
Example
{
"name": "key-act-eat-eat-probably",
"code": "anything-exist-prove-past-drop",
"description": "bag-role-chance-tax-oil",
"hierarchicalName": "traditional-tough-police-visit-history"
}Fields
| Name | Description |
|---|---|
|
The code of this sales funnel. |
|
The collections of this sales funnel. |
|
The type of this sales funnel. |
|
The name of this sales funnel. |
|
The stages of this sales funnel, in order. |
|
The status of this sales funnel. |
|
Fields not associated with a collection. |
Example
{
"code": "indicate-cause-hair-reach-power",
"name": "moment-section-several-reflect-daughter",
"funnelType": "LEAD",
"status": "DRAFT",
"stages": [SalesFunnelStage],
"collections": [Collection],
"uncollectedFields": [FunnelField]
}Fields
| Name | Description |
|---|---|
|
The per-funnel unique code for this stage. |
|
The human-readable name for this stage. |
Example
{
"code": "pull-check-according-study-him",
"name": "fish-state-kind-expect-make"
}ScheduleQuoteFollowUp
Schedule a quote follow up message to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4632: Invalid recipient information.
- KT-CT-4633: Mutation not enabled in this environment.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the message was scheduled successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
|
Whether the scheduled transaction is a 'charge' or a 'credit'. |
|
Additional data that is consumed and associated with the scheduled transaction. |
|
Optional short note about the scheduled transaction for customer display. |
|
The gross amount of the scheduled transaction. |
|
Optional short note about the scheduled transaction for internal use. |
|
The ledger the scheduled transaction is for. |
|
Any extra data that is associated with scheduled transaction. |
|
The net amount of the scheduled transaction. |
|
The datetime after which the scheduled transaction can be added to the ledger. |
|
The reason why the scheduled transaction is added to the account. |
|
The tax amount of the scheduled transaction. |
|
The tax rate of the scheduled transaction. |
Example
{
"ledgerNumber": "up-blue-resource-control-staff",
"action": "candidate-son-decade-hotel-east",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"salesTaxRate": "1.0",
"reason": "near-front-enter-much-course",
"ancillaryData": {"key": "value"},
"metadata": {"key": "value"},
"internalNote": "under-sell-suffer-human-oil",
"displayNote": "billion-century-per-page-a",
"postedAfter": "2002-10-06T19:59:33.851639+00:00"
}ScreenActionType
An action which calls another backend screen via its screen id.
Fields
| Name | Description |
|---|---|
|
Whether to allow returning to the original caller screen. |
|
Unique identifier of the object. |
|
Map of the parameters (key-value pairs) to pass to the next backend screen. |
|
The ID of the screen to navigate to. |
|
The name of the action object's type. |
|
The name of the object's type. |
Example
{
"id": "33891829",
"typename": "main-experience-amount-side-rather",
"typeName": "present-too-nothing-exactly-own",
"screenId": "47721531",
"params": BackendScreenParam,
"allowBack": true
}SectionType
A section containing a list of cards or carousel items
Fields
| Name | Description |
|---|---|
|
The content of the section. |
|
Unique identifier of the object. |
|
The order of the section. |
|
The name of the object's type. |
Example
{
"id": "38231053",
"typename": "pressure-court-race-ask-south",
"content": SectionContent,
"order": 62
}Fields
| Name | Description |
|---|---|
|
The segment name. |
Example
{
"name": "nation-of-local-much-central"
}SelectChargePointMake
Options for selecting a charge point's make from a list of options.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "52160354",
"options": SmartFlexListItemInterface,
"selectedOptionId": "13330220"
}SelectChargePointMakeForSmartFlexOnboarding
Complete the select charge point make step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
The make of the charge point, e.g. myenergi. |
|
A unique identifier for this list item. |
Example
{
"id": "60042411",
"chargePointMake": ChargePointVariantType
}SelectChargePointVariant
Options for selecting a charge point's variant from a list of options.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "59913628",
"options": SmartFlexListItemInterface,
"selectedOptionId": "27206498"
}SelectChargePointVariantForSmartFlexOnboarding
Complete the select charge point variant step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
The model variant of the charge point, e.g. Zappi. |
|
A unique identifier for this list item. |
Example
{
"id": "77109829",
"chargePointVariant": ChargePointVariantType
}SelectDeviceType
A type where the user must select the type of device to onboard.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "59872461",
"options": SmartFlexListItemInterface,
"selectedOptionId": "88360845"
}SelectDeviceTypeForSmartFlexOnboarding
Select the type of device to start the onboarding process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
A unique identifier for this list item. |
|
The device type, e.g. Electric Vehicle. |
Example
{
"id": "16858123",
"label": "learn-off-building-government-world"
}SelectFromListForSmartFlexOnboarding
Select from a list of options presented (in a step that inherits from SelectFromList).
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
}SelectInverterMake
Options for selecting an inverter's make from a list of options.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "46584422",
"options": SmartFlexListItemInterface,
"selectedOptionId": "85439571"
}SelectInverterMakeForSmartFlexOnboarding
Complete the select inverter make step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
A unique identifier for this list item. |
|
The make (manufacturer) of the inverter. |
Example
{
"id": "54340737",
"inverterMake": InverterVariantType
}SelectProducts
Mark chosen quoted products for quoted supply points on quote request as selected.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4634: Quoted product with given id not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4635: Missing a quoted product for at least one quoted supply point on the quote request.
- KT-CT-4636: Quoted product not linked to a product.
- KT-CT-4646: Attempted to select multiple products for the same quoted supply point.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether we successfully marked the chosen quoted products as selected. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}SelectSessionDevice
A type where the user must select a device from a list of session devices.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "79517537",
"options": SmartFlexListItemInterface,
"selectedOptionId": "41529622"
}Fields
| Name | Description |
|---|---|
|
A unique identifier for this list item. |
|
A device associated with the onboarding session. |
Example
{
"id": "43915188",
"sessionDevice": SessionDeviceType
}SelectUserVehicle
Options for selecting a user's vehicle from a list of options.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "59414756",
"options": SmartFlexListItemInterface,
"selectedOptionId": "28392742"
}SelectUserVehicleForSmartFlexOnboarding
Complete the select user vehicle step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
A unique identifier for this list item. |
|
The selected electric vehicle when multiple vehicles were available. Deprecated The 'userVehicle' field is deprecated. |
|
A vehicle associated with the user's OEM account. |
Example
{
"id": "81416505",
"userVehicle": ElectricVehicleType,
"vehicle": VehicleInformationType
}SelectVehicleMake
Options for selecting a vehicle's make from a list of options.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "65161295",
"options": SmartFlexListItemInterface,
"selectedOptionId": "13575243"
}SelectVehicleMakeForSmartFlexOnboarding
Complete the select vehicle make step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
A unique identifier for this list item. |
|
The make of the electric vehicle make, e.g. Tesla. |
Example
{
"id": "84820924",
"vehicleMake": ElectricVehicleType
}SelectVehicleOrChargePoint
A step to prompt users to select between their vehicle or charge point.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
Example
{
"id": "68380081",
"selectedIntegration": "ELECTRIC_VEHICLE"
}SelectVehicleVariant
Options for selecting a vehicle's variant from a list of options.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The options the user can select. |
|
The ID of the option that has been selected, if any. |
Example
{
"id": "61168842",
"options": SmartFlexListItemInterface,
"selectedOptionId": "94396279"
}SelectVehicleVariantForSmartFlexOnboarding
Complete the select vehicle variant step.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
A unique identifier for this list item. |
|
The model variant of the electric vehicle, e.g. Model Y. |
Example
{
"id": "77035989",
"vehicleVariant": ElectricVehicleType
}Fields
| Name | Description |
|---|---|
|
The selected product code. |
|
The selected product display name. |
Example
{
"code": "theory-range-couple-free-adult",
"displayName": "pull-spring-attention-hard-mind"
}SendQuoteSummary
Trigger the sending of a quote summary to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-4632: Invalid recipient information.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the triggering of the quote summary was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}SendVerificationEmail
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
If the verification email was sent. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationStatus": true
}Example
{
"message": "simple-guy-protect-than-war",
"code": "book-identify-themselves-foot-business"
}Fields
| Name | Description |
|---|---|
|
|
|
Example
{
"field": "item-perform-somebody-those-Congress",
"errors": [ErrorTypeUnion]
}Fields
| Name | Description |
|---|---|
|
A unique session device identifier. |
|
The make (manufacturer) of the device. |
|
The model of the device. |
|
The name of the device. |
Example
{
"id": "74535893",
"name": "miss-model-foreign-political-every",
"make": "four-commercial-leader-his-employee",
"model": "source-probably-force-despite-baby"
}SetBatteryChargingPreferences
Allow customers to set/update their battery's charging preferences.
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4353: An error occurred while trying to update your charging preferences.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
The battery device updated, with the ID of the device in KrakenFlex. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": BatteryDeviceType
}SetLoyaltyPointsUser
Set the Loyalty Points user for the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9214: Couldn't assign user loyalty points role.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
ID of the new Loyalty Points user. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "52799597"
}SetOpportunityOutcome
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Success message for now. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "dinner-expert-whom-season-rule"
}SetPaymentPreference
Choose how automatic payments will be collected.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3967: Payment method is not valid.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}SetUpDirectDebitInstruction
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}SetUpDirectDebitInstructionForBusiness
The possible errors that can be raised are:
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-11107: Unauthorized.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The created direct debit instruction. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}SetUpDirectDebitInstructionFromStoredDetails
The possible errors that can be raised are:
- KT-CT-3956: Temporary error occurred.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-4123: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The payment instruction that was created from stored details. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}SetVehicleChargingPreferences
Allow customers to set/update their vehicle's charging preferences.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4321: Serializer validation error.
- KT-CT-4353: An error occurred while trying to update your charging preferences.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}ShareGoodsQuote
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-8203: Received an invalid quote code.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Goods quote shared. |
Example
{
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}Fields
| Name | Description |
|---|---|
|
A list of gross rate information. |
|
The latest value of the gross unit rate, in ct/kWh. |
|
The net unit rate, in ct/kWh. |
Example
{
"netUnitRateCentsPerKwh": "1.0",
"latestGrossUnitRateCentsPerKwh": "1.0",
"grossRateInformation": GrossRateInformation
}Fields
| Name | Description |
|---|---|
|
The current power in kW being consumed by the property from the solar panels, battery and grid. If power is being exported to the grid, that is offset againstconsumption. If power is being used to charge the battery, that doesn't count towards consumption; that'll only count as consumed when it is later used to power the property (this avoids double-counting it). |
|
The current power being exported from the property to the grid in kW. This will be 0 if no export is occurring, or otherwise a positive value. |
Example
{
"consumptionInKw": "1.0",
"exportInKw": "1.0"
}Fields
| Name | Description |
|---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
Make of the battery. |
|
Model of the battery. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
The re-authentication state of this device, if applicable. |
|
Information about the current status of this device. |
Example
{
"id": "81578019",
"name": "law-important-according-artist-police",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "43164599",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "66122264",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"reAuthenticationState": DeviceReAuthenticationInterface,
"make": "quickly-population-necessary-end-visit",
"model": "property-new-particularly-maintain-indeed"
}SmartFlexChargePoint
Information about a charge point that has been registered with Kraken Flex.
Fields
| Name | Description |
|---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
This contains more detail about the variant of the charge point model. |
|
The user's preferences for charging using this charge point. |
|
History of charging sessions for a SmartFlex device. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The make of the charge point, e.g. myenergi. |
|
The model of the charge point, e.g. Zappi. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
The re-authentication state of this device, if applicable. |
|
Information about the current status of this device. |
|
This contains more detail about the variant of the vehicle model. |
Example
{
"id": "30044883",
"name": "year-democratic-fact-happen-deal",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "77779656",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "51322659",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"reAuthenticationState": DeviceReAuthenticationInterface,
"chargingSessions": DeviceChargingSessionConnection,
"make": "prevent-money-people-wear-ahead",
"model": "else-law-financial-hope-blood",
"vehicleVariant": ElectricVehicleModelType,
"chargePointVariant": ChargePointVariantModelType,
"chargingPreferences": SmartFlexVehicleChargingPreferences
}SmartFlexChargePointStatus
The current status of a registered charge point.
Fields
| Name | Description |
|---|---|
|
The current status of the device. |
|
The current state of this SmartFlex device state machine. |
|
Whether control of the device is currently disabled. |
|
The latest SoC received from the vehicle. It has a value between 0-100. |
|
Information about the limits for the SoC. |
|
The reason for the most recent failed test dispatch (if any). |
Example
{
"current": "ONBOARDING",
"isSuspended": true,
"currentState": "AUTHENTICATION_PENDING",
"stateOfCharge": DecimalReading,
"stateOfChargeLimit": StateOfChargeLimit,
"testDispatchFailureReason": "NONE"
}Fields
| Name | Description |
|---|---|
|
Possible cause of the charging error. |
Example
{
"cause": "SOC_LIMIT_REACHED"
}Fields
| Name | Description |
|---|---|
|
The cost for the charge added during a charging session. |
|
The charging session dispatch. |
|
The end time of a charging session. |
|
The energy added during a charging session. |
|
Charging problem(s) encountered during the session due to an error or truncation. |
|
The start time of a charging session. |
|
The change in state of charge during a charging session. The value will be between 0 and 100, if not null. |
|
The final state of charge after a charging session. The value will be between 0 and 100, if not null. |
|
The target type for a user's preferences. |
|
The type of charge, i.e. |
Example
{
"start": "1982-02-02T08:44:29.356828+00:00",
"end": "2018-12-25T20:54:47.073878+00:00",
"stateOfChargeChange": "1.0",
"stateOfChargeFinal": "1.0",
"energyAdded": Energy,
"cost": Money,
"type": "SMART",
"targetType": "ABSOLUTE_STATE_OF_CHARGE",
"dispatches": [SmartFlexDispatch],
"problems": [SmartFlexChargingProblem]
}Fields
| Name | Description |
|---|---|
|
The state of charge (in percent) that was possible, given the truncation. |
|
The state of charge (in percent) that could have been achieved, if not for truncation of the charging session. |
|
The cause for the truncation of a charging session. |
Example
{
"truncationCause": "DISCONNECTED",
"originalAchievableStateOfCharge": "1.0",
"achievableStateOfCharge": "1.0"
}SmartFlexDevice
Information about a device that has been registered for Smart Flex.
Fields
| Name | Description |
|---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
The re-authentication state of this device, if applicable. |
|
Information about the current status of this device. |
Example
{
"id": "28575611",
"name": "ago-myself-player-model-indeed",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "59215052",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "53294850",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"reAuthenticationState": DeviceReAuthenticationInterface
}SmartFlexDeviceAlert
Information about an alert relevant to a device registered for Smart Flex.
Fields
| Name | Description |
|---|---|
|
A device alert message. |
|
When a device alert message is published. |
Example
{
"message": "interesting-off-western-letter-number",
"publishedAt": "1982-01-21T08:29:45.625053+00:00"
}SmartFlexDevicePreferenceSchedule
A schedule entry for device preferences specifying target values for a specific day and time.
For information about valid value ranges, time constraints, and step increments,
query the device's preferenceSettings field which provides bounds and validation rules.
Fields
| Name | Description |
|---|---|
|
Day of week schedule applies to. |
|
Maximum value for the schedule. Usage depends on the targetType - e.g., maximum charge for EVs. For valid bounds and step increments, see the device's |
|
Minimum value for the schedule when applicable. Usage depends on the targetType - e.g., minimum temperature for heat pumps. May be null for device types that don't require a lower bound. For valid bounds and step increments, see the device's |
|
Time of day the preference applies. |
|
Upper limit value for the schedule when applicable.Usage depends on the targetType - e.g., charge level to never be exceeded for V2G EVs.May be null for device types that don't require an upper bound. |
Example
{
"dayOfWeek": "MONDAY",
"time": "20:23:08.687436",
"min": 900.87,
"max": 755.22,
"upperLimit": 523.81
}Fields
| Name | Description |
|---|---|
|
The status of the device's grid export capability. |
|
The device's preference mode. |
|
The schedules of the device's preference. |
|
The target type of the preference. |
|
The unit of the preference schedules' min and max values. |
Example
{
"targetType": "ABSOLUTE_STATE_OF_CHARGE",
"unit": "CELSIUS",
"mode": "CHARGE",
"schedules": [SmartFlexDevicePreferenceSchedule],
"gridExport": "ENABLED"
}SmartFlexDeviceStatus
Information about the current status of a device registered for Smart Flex.
Fields
| Name | Description |
|---|---|
|
The current status of the device. |
|
The current state of this SmartFlex device state machine. |
|
Whether control of the device is currently disabled. |
Example
{
"current": "ONBOARDING",
"isSuspended": true,
"currentState": "AUTHENTICATION_PENDING"
}Fields
| Name | Description |
|---|---|
|
Import supply point ID. |
|
SmartFlex device ID. |
Example
{
"importSupplyPointId": "31884253",
"smartFlexDeviceId": "67037881"
}Fields
| Name | Description |
|---|---|
|
The end time of the dispatch. |
|
The energy added in kWh of the dispatch. |
|
The start time of the dispatch. |
|
The type of charge. |
Example
{
"start": "2009-11-16T23:08:28.124290+00:00",
"end": "1994-04-24T15:30:53.729811+00:00",
"type": "SMART",
"energyAddedKwh": "1.0"
}SmartFlexInverter
Information about an inverter that has been registered with KrakenFlex.
Fields
| Name | Description |
|---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The make of the inverter. |
|
The model of the inverter. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
The re-authentication state of this device, if applicable. |
|
Information about the current status of this device. |
|
Telemetry data for the inverter. |
Example
{
"id": "57077904",
"name": "author-choice-nothing-feeling-push",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "25856069",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "82414568",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"reAuthenticationState": DeviceReAuthenticationInterface,
"make": "wear-wall-great-she-least",
"model": "prepare-natural-partner-seat-sit",
"telemetry": SmartFlexInverterTelemetry
}SmartFlexInverterTelemetry
Telemetry data for a registered inverter.
Fields
| Name | Description |
|---|---|
|
Information about the battery. |
|
Information about the grid. |
|
Information about the inverter. |
|
Information about the site. |
|
Information about the solar panels. |
Example
{
"inverter": InverterTelemetry,
"battery": BatteryTelemetry,
"solar": SolarTelemetry,
"grid": GridTelemetry,
"site": SiteTelemetry
}SmartFlexOnboardingDeviceRegistration
A type that returns True if the device(s) were successfully registered.
Fields
| Name | Description |
|---|---|
|
Returns true if the device(s) were successfully registered. |
|
A unique identifier for this onboarding step. |
Example
{
"id": "49146355",
"deviceRegistered": true
}Fields
| Name | Description |
|---|---|
|
A Backend Screen that renders the SmartFlex onboarding wizard. |
|
The completed steps for all onboarding wizards that are currently in progress. Note: - The last step is the most recent one. - If an onboarding journey is completed, it will not be included in this list. |
|
The next step of the SmartFlex onboarding wizard. Returns |
|
The onboarding wizard's selected device type to be onboarded. |
|
The onboarding wizard's display name extracted from the wizard's selected device attributes. |
|
A unique identifier for this SmartFlex onboarding wizard. |
|
Determines whether the wizard's onboarding journey can be resumed. |
Example
{
"id": "47275576",
"resumable": SmartFlexResumable,
"deviceType": "BATTERIES",
"displayName": "include-local-military-itself-create",
"backendScreen": BackendScreenType,
"currentStep": SmartFlexOnboardingStepInterface,
"completedSteps": SmartFlexOnboardingStepInterface
}Fields
| Name | Description |
|---|---|
|
A boolean to determine whether the wizard's onboarding journey can be resumed. |
|
Reasons why a wizard cannot be resumed. |
Example
{
"isResumable": true,
"resumableReasons": ["cut-bag-just-time-they"]
}SmartFlexVehicle
Information about a vehicle that has been registered with Kraken Flex.
Fields
| Name | Description |
|---|---|
|
Active alert message(s) for a device, showing the latest first. |
|
This contains more detail about the variant of the charge point model. |
|
The user's preferences for charging this vehicle. Deprecated The 'chargingPreferences' field is deprecated. |
|
History of charging sessions for a SmartFlex device. |
|
The type of device. |
|
A UUID that identifies this device registration. Re-registering this device will result in a different ID. |
|
The third-party integration device ID. |
|
The make of the vehicle, e.g. Tesla. |
|
The model of the vehicle, e.g. Model 3. |
|
The user-friendly name for the device. |
|
The current onboarding wizard for a device. |
|
The preference setting for this device. |
|
The device's preference details. |
|
The id of the property linked to the device. |
|
The third-party that enables control of this device. |
|
The re-authentication state of this device, if applicable. |
|
Information about the current status of this device. |
|
This contains more detail about the variant of the vehicle model. |
Example
{
"id": "78797263",
"name": "painting-service-soon-industry-change",
"deviceType": "BATTERIES",
"provider": "BYD",
"integrationDeviceId": "15875404",
"status": SmartFlexDeviceStatusInterface,
"propertyId": "55729474",
"alerts": SmartFlexDeviceAlertInterface,
"onboardingWizard": SmartFlexOnboardingWizard,
"preferences": SmartFlexDevicePreferencesInterface,
"preferenceSetting": FlexDevicePreferenceSettingInterface,
"reAuthenticationState": DeviceReAuthenticationInterface,
"chargingSessions": DeviceChargingSessionConnection,
"make": "least-best-dark-other-section",
"model": "fish-west-nice-science-loss",
"vehicleVariant": ElectricVehicleModelType,
"chargePointVariant": ChargePointVariantModelType,
"chargingPreferences": SmartFlexVehicleChargingPreferences
}SmartFlexVehicleChargingPreferences
The user's preferences for charging, e.g. target SoC (State of Charge).
Fields
| Name | Description |
|---|---|
|
The maximum SoC (percentage). |
|
The minimum SoC (percentage). |
|
The target SoC to achieve on a weekday (percentage). |
|
The time at which the target SoC should be achieved on a weekday. |
|
The target SoC to achieve on a weekend (percentage). |
|
The time at which the target SoC should be achieved on a weekend. |
Example
{
"weekdayTargetTime": "22:04:39.014421",
"weekdayTargetSoc": 86,
"weekendTargetTime": "15:01:23.672115",
"weekendTargetSoc": 29,
"minimumSoc": 75,
"maximumSoc": 72
}SmartFlexVehicleStatus
The current status of a registered vehicle.
Fields
| Name | Description |
|---|---|
|
The current status of the device. |
|
The current state of this SmartFlex device state machine. |
|
Whether control of the device is currently disabled. |
|
The latest SoC received from the vehicle. It has a value between 0-100. |
|
Information about the limits for the SoC. |
|
The reason for the most recent failed test dispatch (if any). |
Example
{
"current": "ONBOARDING",
"isSuspended": true,
"currentState": "AUTHENTICATION_PENDING",
"stateOfCharge": DecimalReading,
"stateOfChargeLimit": StateOfChargeLimit,
"testDispatchFailureReason": "NONE"
}Fields
| Name | Description |
|---|---|
|
The current power being generated by the solar panels in kW. This will be null if there are no solar panels, 0 if there are solar panels but they are not generating, or a positive value if they are generating. |
Example
{
"powerInKw": "1.0"
}SpecialCancelContract
Perform special cancellation for a given supply point and send confirmation email to the customer.
The possible errors that can be raised are:
- KT-CT-4923: Unauthorized.
- KT-CT-4922: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Whether the special contract cancellation was successful. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"cancelledContract": true
}SpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services.
Fields
| Name | Description |
|---|---|
|
The date and time the special circumstance record was created. |
|
|
|
|
|
Example
{
"id": "67100786",
"summary": "he-fly-while-entire-answer",
"internalCode": "free-Mr-type-report-story",
"createdAt": "2012-10-15T16:45:34.738666+00:00",
"gasPSRCode": "draw-thank-age-mean-up",
"electricityPSRCode": "Democrat-nearly-bill-admit-apply"
}SpecialCircumstancesType
Information about the special circumstances that relate to a user.
Fields
| Name | Description |
|---|---|
|
Whether the user has consented for their data to be given to the appropriate industry or regulatory bodies. We typically only ask for this once, so this field can be used to decide whether to ask the user for their initial consent. |
|
Example
{
"isSharingConsentGiven": true,
"records": [SpecialCircumstanceRecordUnion]
}StartCollectionProcess
Start a collection process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11208: Invalid billing document identifier for collection process.
- KT-CT-11209: Collection process configuration does not have published version.
- KT-CT-11210: Active collection process for entity already exists.
- KT-CT-11211: Too many active collection processes for config.
- KT-CT-11212: Invalid collection process config code.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Details of collection process that has been started. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessStarted": StartCollectionProcessOutput
}Fields
| Name | Description |
|---|---|
|
Account number associated to the collection process. |
|
The number of the collection process record. |
Example
{
"number": "way-know-full-join-build",
"accountNumber": "A-3160F4AC"
}StartCustomerVerification
Start the customer verification using the provided verification method.
The possible errors that can be raised are:
- KT-CT-1701: Brand does not exist.
- KT-CT-4194: Verification type not supported yet.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The newly created verification process. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}StartOnSiteJobsAppointmentBookingSession
The possible errors that can be raised are:
- KT-CT-13032: Request does not exist.
- KT-CT-13010: No booking adapter found for agent.
- KT-CT-13020: Could not identify agent from property.
- KT-CT-13021: Invalid job type.
- KT-CT-13022: Work category not found for job type.
- KT-CT-13023: Appointment booking checks failed.
- KT-CT-13024: Appointment booking checks returned warnings.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The Kraken booking ID for the appointment booking session. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"appointmentBookingSessionId": "650ce338-c3fc-44ab-9b75-32dd204af963"
}StartReAuthentication
Create a wizard for re-authenticating a device with SmartFlex.
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- KT-CT-4385: Re-authentication is not supported for this 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 wizard created for re-authenticating the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}StartSmartFlexOnboarding
Create a wizard for onboarding a device with SmartFlex.
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- KT-CT-4385: Re-authentication is not supported for this 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 wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}StartTestChargeForSmartFlexOnboarding
Attempt to start a test charge.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4371: Onboarding wizard ID is invalid.
- KT-CT-4372: Simultaneous attempts to update onboarding process.
- KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
- KT-CT-4376: Unable to complete onboarding step. Please try again later.
- KT-CT-4377: Invalid onboarding step ID.
- KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
- KT-CT-4379: Vehicle is not ready for a test charge.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The wizard created for onboarding the device with SmartFlex. |
Example
{
"possibleErrors": [PossibleErrorType],
"wizard": SmartFlexOnboardingWizard
}Fields
| Name | Description |
|---|---|
|
Whether or not target SoC exceeds upper SoC limit. |
|
Time of the latest SoC limit reading. |
|
Maximum level of charge allowed by the battery relative to its capacity (in percent). |
Example
{
"upperSocLimit": 50,
"timestamp": "chance-join-yard-opportunity-issue",
"isLimitViolated": true
}StatementBillingDocumentConnectionTypeConnection
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": StatementBillingDocumentConnectionTypeEdge,
"totalCount": 40,
"edgeCount": 86
}StatementBillingDocumentConnectionTypeEdge
A Relay edge containing a StatementBillingDocumentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": StatementBillingDocumentType,
"cursor": "management-claim-whom-idea-section"
}StatementBillingDocumentType
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
| Name | Description |
|---|---|
|
Billing document that annuls this statement. |
|
Position of the billing document in the delinquent debt tracking system. |
|
The earliest charge date of the statement. |
|
The end of the statement's period. |
|
The date and time the statement was sent to the customer. |
|
ID for the statement billing document. |
|
The unique reference of the statement that can be used for identifying the statement externally. |
|
The latest charge date of the statement. |
|
The date due for payment for the statement. |
|
URL to the PDF of the statement. |
|
The start of the statement's period. |
|
The total amounts for all charges on the statement. |
|
The total amounts for all credits on the statement. |
|
Transactions on the statement |
Example
{
"id": 18470225,
"identifier": "30015123",
"startAt": "1977-12-16T17:33:10.214998+00:00",
"endAt": "1989-08-23T20:16:08.070606+00:00",
"firstIssuedAt": "2019-02-18T06:42:45.806959+00:00",
"earliestChargeAt": "1997-10-21T16:24:27.072963+00:00",
"latestChargeAt": "1992-06-20T06:42:53.716057+00:00",
"paymentDueDate": "1997-12-19",
"pdfUrl": "cut-detail-increase-read-evening",
"annulledBy": AnnulmentBillingDocumentType,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType
}Fields
| Name | Description |
|---|---|
|
The gross total amount for the statement (in minor currency units). |
|
The net total amount for the statement (in minor currency units). |
|
The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 72,
"taxTotal": 25,
"grossTotal": 86
}Fields
| Name | Description |
|---|---|
|
|
|
The type of the bill. |
|
This field returns the closing balance of an issued statement. |
|
The last day of consumption that this statement includes. |
|
The first day of consumption that this statement includes. |
|
The date of the constituent bill covered from. |
|
Retrieve the held status of a account statement. |
|
The ID of the constituent bill. |
|
Whether the bill originated in Kraken or externally. |
|
The date the bill was sent to the customer. |
|
This field returns the opening balance of a statement. |
|
The date the bill is due to be paid. |
|
How many charges have been reversed after the close date. |
|
Current status of the associated statement. |
|
Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
|
Email recipient address. |
|
The date of the constituent bill covered to. |
|
The total amounts for all charges on the statement. |
|
The total amounts for all credits on the statement. |
|
Transactions on the bill. |
|
Email recipient user ID. |
Example
{
"id": "35137370",
"billType": "STATEMENT",
"fromDate": "1987-11-25",
"toDate": "2008-05-24",
"temporaryUrl": "score-kid-base-although-network",
"issuedDate": "2009-04-18",
"attachments": BillingAttachmentConnectionTypeConnection,
"closingBalance": 21,
"openingBalance": 47,
"isExternalBill": true,
"transactions": TransactionConnectionTypeConnection,
"userId": 76170951,
"toAddress": "return-agency-sea-plant-action",
"paymentDueDate": "1995-07-26",
"consumptionStartDate": "1977-02-24",
"consumptionEndDate": "1985-03-11",
"reversalsAfterClose": "ALL",
"status": "OPEN",
"heldStatus": HeldStatus,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType
}Fields
| Name | Description |
|---|---|
|
Monetary cost of the statistic (excluding tax), if applicable. |
|
Monetary cost of the statistic (including tax), if applicable. |
|
Description of the statistic for the parent node. |
|
Display label of the statistic for the parent node. |
|
The type of statistic being measured for the parent node. |
|
Consumption / generation value of the statistic, if applicable. |
Example
{
"type": "STANDING_CHARGE_COST",
"label": "he-thus-east-then-best",
"description": "miss-important-yard-thousand-billion",
"costExclTax": EstimatedMoneyType,
"costInclTax": EstimatedMoneyType,
"value": "1.0"
}StopAutomatedPayments
Choose how automatic payments will be collected.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}StoreDirectDebitPaymentMethodDetails
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "few-approach-response-develop-film"
}StorePaymentInstruction
Store a new payment instruction created through the embedded process.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The stored payment instruction. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}Fields
| Name | Description |
|---|---|
|
The string value of the characteristic. |
Example
{
"stringValue": "cup-if-experience-skin-put"
}StringType
Graphene type object to represent string values
Fields
| Name | Description |
|---|---|
|
Value of this field. |
Example
{
"stringValue": "write-most-hope-television-collection"
}SubmitCustomerFeedback
The possible errors that can be raised are:
- KT-CT-5514: Unable to submit feedback.
- KT-CT-5511: The feedback_id should be provided for feedback source.
- KT-CT-5512: The feedback doesn't match the account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}SubmitRepaymentRequest
Mutation for executing the repayment request use case.
The possible errors that can be raised are:
- KT-CT-1132: Unauthorized.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3926: Unauthorized.
- KT-CT-3927: Invalid Amount.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The newly created repayment request. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentRequest": RequestRepaymentOutputType
}SupplementaryLedgerType
Ledgers provide the foundation of Kraken’s bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular Kraken account.
Fields
| Name | Description |
|---|---|
|
The current final balance of the ledger in pence. |
|
Deprecated The 'ledgerId' field is deprecated. |
|
|
|
The display name of the ledger. |
|
The canonical name of the ledger. |
|
Override Field to add additional attributes and extend description with possible_errors |
Example
{
"id": "91792828",
"name": "man-per-campaign-able-try",
"ledgerType": "arrive-pick-fish-sea-behind",
"number": "small-mission-behavior-region-clear",
"currentBalance": 55,
"paymentAdequacy": PaymentAdequacyDetailsType
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
Example
{
"brandId": 68024099,
"supplierId": 50026377,
"supplierName": "discuss-name-ready-account-world",
"supplierNumber": "do-budget-administration-next-those"
}SupplyOrServiceCharge
Supporting information for a customer charge resulting from a supply or service agreement
Fields
| Name | Description |
|---|---|
|
Agreements which were charged |
Example
{
"agreements": AgreementConnection
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyPointConnectionTypeEdge,
"totalCount": 16,
"edgeCount": 83
}SupplyPointConnectionTypeEdge
A Relay edge containing a SupplyPointConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": SupplyPointType,
"cursor": "culture-bring-threat-must-respond"
}Fields
| Name | Description |
|---|---|
|
Supply point external identifier. |
|
Supply point market name. |
|
Requested supply start date. |
|
The selected product information for this supply point or None if no product is selected. |
Example
{
"externalIdentifier": "79375512",
"marketName": "to-save-simple-former-season",
"requestedSupplyStartDate": "2020-08-08",
"selectedProduct": SelectedProductType
}SupplyPointType
Represents a SupplyPoint.
Fields
| Name | Description |
|---|---|
|
Get list of devices under a supply point. |
|
The external identifier of the supply point. |
|
The ID of the supply point. |
|
The market this supply point belongs to. |
|
The supply point's property. |
|
Get readings from a readable device e.g., a supply point, device, or register. |
Example
{
"id": "47783960",
"marketName": "record-sound-price-customer-message",
"externalIdentifier": "77311374",
"readings": Readings,
"property": PropertyType,
"devices": DevicesConnection,
"meterPoint": MeterPointType
}SupplyProductTagType
A product tag.
Example
{
"code": "risk-same-everything-lead-follow",
"displayName": "need-whose-up-spend-health"
}SupplyProductType
GraphQL type for a supply product.
Fields
| Name | Description |
|---|---|
|
The product availability status. |
|
The date and time the product is available from. |
|
The date and time the product is available to. |
|
The brand code of the product. |
|
The product code. |
|
The product description. |
|
The product description. |
|
The date the product ends. |
|
The product title. |
|
|
|
Whether the product is hidden. |
|
The name of the market the product belongs to. |
|
The product notes. |
|
The product parameters. |
|
Tags associated with the product. |
|
The product term in months. |
|
Active terms and conditions for a market supply product. |
|
The product contract type. |
Example
{
"id": "51147351",
"code": "may-figure-arrive-surface-seem",
"notes": "should-life-to-current-wonder",
"fullName": "ability-need-fund-ball-scene",
"displayName": "writer-easy-possible-first-such",
"description": "establish-begin-stand-democratic-several",
"availableFrom": "1991-02-03T10:47:48.353702+00:00",
"availableTo": "2017-09-09T11:19:54.778132+00:00",
"isHidden": true,
"term": 72,
"endsAt": "1972-02-05T13:33:55.316905+00:00",
"brandCode": "know-music-receive-represent-reality",
"marketName": "activity-return-billion-able-final",
"availabilityStatus": "EVERYONE",
"termsContractType": "plant-early-already-hold-part",
"termsAndConditionsTypes": TermsAndConditionsType,
"params": {"key": "value"},
"tags": SupplyProductTagType
}SuspendDeviceControl
Suspend control of a device while away from home, e.g. on holiday.
This is to prevent charging during that period.
The possible errors that can be raised are:
- KT-CT-4301: Unable to find device for given account.
- KT-CT-4358: Unable to suspend device control.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"krakenflexDevice": KrakenFlexDeviceType
}SwitchAccountToVariablePaymentSchedule
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3921: Account not found.
- KT-CT-3922: Ledger not found for the account.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
New payment schedule. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}TagType
Represents a tag used for classifying offerings and products.
Fields
| Name | Description |
|---|---|
|
Unique tag code. |
|
Display name of the tag. |
Example
{
"code": "century-several-season-house-simple",
"displayName": "approach-bed-deal-prevent-family"
}Example
{
"id": "47443197",
"displayName": "another-military-garden-his-tend",
"fullName": "rule-way-already-later-simply",
"description": "collection-human-official-place-president",
"productCode": "college-good-organization-of-themselves",
"standingCharge": 774.35,
"preVatStandingCharge": 719.47,
"tariffCode": "factor-option-few-concern-couple",
"isExport": true,
"tags": ["carry-wait-year-Democrat-week"]
}Fields
| Name | Description |
|---|---|
|
The error message if the task failed. |
|
The result of the task. |
|
The status of the task. |
Example
{
"status": "STARTED",
"result": {"key": "value"},
"error": "available-young-sister-evidence-since"
}Fields
| Name | Description |
|---|---|
|
The ID of the operations team. |
|
The name of the operations team. |
|
The team reference for routing (e.g., 'OPERATIONS_GROUP.TEAM.TEAM_A'). |
Example
{
"id": "15064560",
"name": "set-hard-drop-number-participant",
"ref": "include-use-however-nothing-hit"
}Fields
| Name | Description |
|---|---|
|
The name of the team group (e.g., 'GROUP_A'). |
|
The team group reference for routing (e.g., 'OPERATIONS_GROUP.GROUP.GROUP_A'). |
Example
{
"name": "account-much-education-safe-them",
"ref": "us-environment-glass-surface-stop"
}Fields
| Name | Description |
|---|---|
|
The human-readable location name (e.g., 'London'). |
|
The location reference for routing (e.g., 'OPERATIONS_GROUP.LOCATION.London'). |
Example
{
"ref": "partner-but-radio-always-lawyer",
"friendlyName": "site-career-green-ever-various"
}TemporarySpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services. These circumstances have an end date, after which they will not longer apply. Having young children is an example of this in the UK.
Fields
| Name | Description |
|---|---|
|
The date and time the special circumstance record was created. |
|
|
|
|
|
|
|
Example
{
"id": "26656096",
"summary": "economy-option-center-site-ground",
"internalCode": "I-cell-officer-start-somebody",
"createdAt": "1985-09-07T18:27:44.626152+00:00",
"gasPSRCode": "whether-yard-bank-military-around",
"electricityPSRCode": "true-front-couple-guess-direction",
"expiryDate": "2021-06-19"
}TermTemplateComponentType
Represents a contract term template component within an offering.
Fields
| Name | Description |
|---|---|
|
The contract term template 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": "61518029",
"minimumQuantity": 72,
"maximumQuantity": 97,
"initialQuantity": 92,
"component": TermTemplateType
}TermTemplateType
Represents a contract term template in the catalog.
Fields
| Name | Description |
|---|---|
|
The description of this contract term template. |
|
The name of this contract term template. |
|
The data associated with this contract term template. |
|
The type of contract term. |
Example
{
"termType": "improve-behavior-share-participant-generation",
"templateData": {"key": "value"},
"name": "prepare-so-field-discover-both",
"description": "affect-explain-indeed-animal-miss"
}Fields
| Name | Description |
|---|---|
|
The contract terminated. |
Example
{
"contract": Contract
}TerminateCreditTransferPermission
Mutation to terminate a credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3825: Credit transfer permission not found.
- KT-CT-3827: The ledger is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Datetime when the credit transfer permission ends. |
Example
{
"possibleErrors": [PossibleErrorType],
"validTo": "2006-08-10T17:37:35.611854+00:00"
}TerminationFeeType
Represents the termination term of a contract.
Fields
| Name | Description |
|---|---|
|
The amount of the termination fee. |
|
The description of the term. |
|
The display name of the term. |
|
The type of termination fee. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The market associated with the termination fee. |
|
The type of the term. |
Example
{
"type": "city-rate-young-sing-feeling",
"displayName": "carry-reason-scientist-radio-participant",
"description": "become-marriage-plan-reason-require",
"identifier": "60889389",
"isVariable": true,
"amount": "1.0",
"feeType": TerminationFeeType,
"marketName": "full-program-live-great-I"
}TermsAndConditionsConnectionTypeConnection
Pagination for terms and conditions.
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TermsAndConditionsConnectionTypeEdge,
"totalCount": 23,
"edgeCount": 14
}TermsAndConditionsConnectionTypeEdge
A Relay edge containing a TermsAndConditionsConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": TermsAndConditionsType,
"cursor": "get-perform-watch-bit-author"
}Fields
| Name | Description |
|---|---|
|
The display name of the terms and conditions. |
|
The S3 URL to the terms and conditions file. |
Example
{
"name": "start-human-almost-seat-position",
"s3Url": "military-brother-treatment-toward-must"
}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": "only-like-information-billion-television",
"pdfUrl": "blood-too-town-responsibility-individual",
"brandCode": "trouble-stuff-listen-serve-professor",
"markdown": "ball-assume-marriage-president-ready",
"html": "consider-assume-physical-prevent-customer",
"version": "by-later-project-story-big",
"effectiveFrom": "2019-10-23T17:50:07.785653+00:00"
}TeslaModifyScopes
A step which indicates that the Tesla permission scopes need to be granted by the user in order to register their vehicle.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
Returns the URI to update the permission scopes. |
|
The redirect URI to return to after updating the permission scopes. |
Example
{
"id": "42286501",
"modifyScopesUri": "something-member-chance-upon-become",
"redirectUri": "doctor-happy-energy-magazine-air"
}TeslaRegistrationFailed
A step which indicates that the Tesla registration failed and the user must re-grant permission scopes to register their vehicle.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
Returns:- |
Example
{
"id": "20829769",
"modifyScopesSelected": true
}TeslaSetupVirtualKey
A step which indicates that the user must add the given URI as a virtual key in their Tesla account.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
The name of the key to add. |
|
The URI to add as a virtual key in the user's Tesla account. |
Example
{
"id": "62312050",
"key": "feel-late-international-top-western",
"uri": "doctor-animal-never-back-response"
}TestCharge
A step which indicates if we're able to test charge the user's vehicle(s).
Fields
| Name | Description |
|---|---|
|
Returns the error raised from a failed test charge. |
|
A unique identifier for this onboarding step. |
|
Returns |
|
Returns |
|
Returns the dispatch status of test charge. Deprecated The 'status' field is deprecated. |
Example
{
"id": "31083591",
"error": TestChargeError,
"isReady": true,
"status": "TRIGGERED",
"isStarted": true
}TestChargeError
Errors can be of two kinds (assuming the user is querying this type with message,
reasons, errorType, and descriptions fields):
-
If we were unable to start a test charge, the response will be:
{ "message": "TestChargeRefused", "reasons": [Returns a list of values from `TestChargeRefusalReason`], "errorType": "UNABLE_TO_INITIATE_TEST_CHARGE", "descriptions": [Returns a list of descriptions for the refusal reasons] }Where
descriptionscan be: -DEVICE_LIVE: "device is already live" -DEVICE_ONBOARDING_IN_PROGRESS: "test dispatch already in progress" -DEVICE_RETIRED: "device is retired" -DEVICE_SUSPENDED: "device is suspended" -DEVICE_DISCONNECTED: "device is disconnected" -DEVICE_ALREADY_CHARGING: "device is already charging" -DEVICE_AWAY_FROM_HOME: "device is away from home" -DEVICE_NO_LOCATION_CONFIGURED: "device has no location configured" -DEVICE_LOCATION_UNABLE_TO_IDENTIFY: "unable to identify device location" -DEVICE_LOCATION_MISSING: "device location is missing" -
If an error occurred during a test charge, the response will be:
{ "message": "Test dispatch failed", "reasons": [Returns a list of values from `TestDispatchAssessmentFailureReason`], "errorType": "UNABLE_TO_COMPLETE_TEST_CHARGE", "descriptions": [Returns a list of descriptions for the refusal reasons] }Where
descriptionscan be: -ASSESSMENTS_FAILED: "Both power-based and charge status-based assessments failed" -NOT_AT_HOME: "Device location not at home" -UNKNOWN: "Unknown failure" -UNABLE_TO_COMMUNICATE: "Unable to communicate with device" -DEVICE_DISCONNECTED: "Device disconnected" -SOC_LIMIT_REACHED: "State of charge limit reached" -ERROR: "Could not fetch the test charge failure reason" -NONE: "No failure reason"
Fields
| Name | Description |
|---|---|
|
A list of error descriptions for a failed test charge attempt. |
|
The type of test charge error. |
|
A human readable error message. |
|
A list of reasons for a failed test charge attempt. |
|
A list of refusal reasons from the failed test charge attempt. Deprecated The 'refusalReasons' field is deprecated. |
Example
{
"message": "week-like-policy-trial-difference",
"refusalReasons": "DEVICE_LIVE",
"errorType": "UNABLE_TO_INITIATE_TEST_CHARGE",
"reasons": ["hope-free-soon-parent-human"],
"descriptions": ["billion-week-capital-kid-not"]
}TextType
A block of text.
Fields
| Name | Description |
|---|---|
|
Unique identifier of the object. |
|
The text alignment. |
|
The text style, i.e. header, body. |
|
The name of the object's type. |
|
The text content. |
Example
{
"value": "left-home-want-cost-take",
"textStyle": "TITLE1",
"textAlignment": "START",
"id": "11778534",
"typename": "medical-modern-you-region-choice"
}ThirdPartyCompleteDeviceRegistration
Complete the registration of a device.
The possible errors that can be raised are:
- KT-CT-4321: Serializer validation error.
- KT-CT-4322: Unable to complete registration error.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The response showing account validity and optional tariff information. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": ThirdPartyCompleteDeviceRegistrationType
}Fields
| Name | Description |
|---|---|
|
If the account is valid. |
|
If a switch to the required tariff is in progress. |
|
The tariff the account is on, if the switch is complete. |
Example
{
"isAccountValid": true,
"isTariffSwitchInProgress": true,
"tariff": ThirdPartyTariffsType
}ThirdPartyOrganizationType
Type for the third party organization.
Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Holds information about the permissions of the current viewer. |
Example
{
"name": "test-six-director-this-think",
"permissions": [ThirdPartyPermission]
}ThirdPartyPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
|
The short name of the permission. |
Example
{
"permission": "something-theory-million-wide-thank"
}Fields
| Name | Description |
|---|---|
|
Day(s) of the week of the tariff interval. |
|
Local 24hr end time of the tariff interval (format hh:mm). |
|
Local 24hr start time of the tariff interval (format hh:mm). |
|
The type of tariff this is (e.g. peak or offPeak). |
Example
{
"startTime": "action-miss-leader-quite-above",
"endTime": "base-rest-heavy-claim-sense",
"daysOfWeek": "produce-account-impact-institution-should",
"tariffType": "surface-affect-realize-drop-change"
}Fields
| Name | Description |
|---|---|
|
Currency according to the ISO 4217 standard. |
|
Price per kWh in the given currency. |
|
The type of tariff this is (e.g. peak or offPeak). |
Example
{
"currency": "oil-every-first-likely-site",
"price": "1.0",
"type": "and-resource-nearly-tree-opportunity"
}Fields
| Name | Description |
|---|---|
|
Tariff intervals of the charging location. |
|
Tariff rates of the charging location. |
Example
{
"tariffs": ThirdPartyTariffType,
"tariffIntervals": ThirdPartyTariffIntervalType
}Fields
| Name | Description |
|---|---|
|
The discount that is rewarded when the power crosses the corresponding threshold. Ranges from 0.0 - 1.0. |
|
The power (kW) that must be surpassed to achieve the corresponding discount. |
|
The wind speed (m/s) that corresponds to the power cut-off for this threshold. |
Example
{
"power": "1.0",
"discount": "1.0",
"windSpeed": "1.0"
}TimeOfUseOverrideType
Represents a time-of-use override to be applied in a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
| Name | Description |
|---|---|
|
The description of the term. |
|
The display name of the term. |
|
The identifier of the term. |
|
Whether the term is variable. |
|
The type of the term. |
Example
{
"type": "director-finish-report-participant-anyone",
"displayName": "cold-specific-nice-president-item",
"description": "amount-group-do-family-collection",
"identifier": "11889715",
"isVariable": true
}Fields
| Name | Description |
|---|---|
|
The time of use unit rates. |
Example
{
"rates": TimeOfUseTimeslotUnitRate
}Fields
| Name | Description |
|---|---|
|
The time from which the timeslot is active. |
|
The time until which the timeslot is active. |
Example
{
"activeFromTime": "06:20:04.387121",
"activeToTime": "10:03:37.256059"
}Fields
| Name | Description |
|---|---|
|
A list of gross rate information. |
|
The latest value of the gross unit rate, in ct/kWh. |
|
The net unit rate, in ct/kWh. |
|
Activation rules that describe the timeslot within which this rate applies. |
|
The name of the timeslot for this unit rate. |
Example
{
"timeslotName": "only-show-kind-evidence-defense",
"timeslotActivationRules": TimeOfUseTimeslotActivationRule,
"netUnitRateCentsPerKwh": "1.0",
"latestGrossUnitRateCentsPerKwh": "1.0",
"grossRateInformation": GrossRateInformation
}TimeSeriesSpecificationEligibilityScheduleType
Represents a schedule for time series specification eligibility within a contract.
Note: This type is a stub, and will be fleshed out in the future.
Fields
| Name | Description |
|---|---|
|
The period during which this eligibility is effective. |
|
Indicates if the time series specification is eligible. |
|
The product code associated with the time series specification. |
|
The time series specification code. |
Example
{
"productCode": "southern-fly-task-during-myself",
"timeSeriesSpecificationCode": "let-street-wide-end-police",
"isEligible": true,
"effectivePeriod": RateGroupEligibilityPeriodType
}Fields
| Name | Description |
|---|---|
|
The gross amount (in minor currency units). |
|
The net amount (in minor currency units). |
|
The amount of tax (in minor currency units). |
Example
{
"net": 87,
"tax": 29,
"gross": 59
}Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TransactionConnectionTypeEdge,
"totalCount": 21,
"edgeCount": 100
}TransactionConnectionTypeEdge
A Relay edge containing a TransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": TransactionType,
"cursor": "that-always-ground-rock-drop"
}TransferLeadOpportunities
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Number of opportunities transferred. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunitiesTransferred": 76
}TransferLedgerBalance
Trigger balance transfer between accounts.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-9701: Balance transfer to same account is not allowed.
- KT-CT-9702: Balance transfer is not support for debit account with Zero balance.
- KT-CT-9703: Balance transfer is not supported for debit account.
- KT-CT-9704: Balance transfer amount should be non-zero.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Balance transfer details. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"balanceTransfer": AccountBalanceTransferType
}TransferLoyaltyPointsBetweenUsers
Transfer Loyalty Points between users.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The number of loyalty points that were transferred. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 30
}Fields
| Name | Description |
|---|---|
|
The date/time that the trigger was created. |
|
The ID of the trigger. |
|
The messages created in response to this trigger. |
|
The current processing status of this trigger. |
|
The trigger type code for this trigger. |
Example
{
"id": "44203975",
"triggerTypeCode": "rock-morning-return-ago-leg",
"createdAt": "2022-02-19T13:12:18.536196+00:00",
"messages": MessageConnection,
"processingStatus": "UNPROCESSED"
}UnenrollAccountFromLoyaltyProgram
Unenroll an account from the loyalty program.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9220: Ineligible loyalty points unenrollment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Outcome of the loyalty points campaign enrollment. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"outcome": UnenrollAccountFromLoyaltyProgramOutcome
}Fields
| Name | Description |
|---|---|
|
Indicates whether the account has been unenrolled from the loyalty points campaign. |
Example
{
"hasUnenrolled": true
}Fields
| Name | Description |
|---|---|
|
Unit rate information for this period. |
|
Date and time from which the unit rate information will be valid. |
|
Date and time until which the unit rate information will be valid. |
Example
{
"validFrom": "2017-07-25T07:02:37.645724+00:00",
"validTo": "1978-10-23T23:10:00.079928+00:00",
"unitRateInformation": UnitRateInformation
}UpdateAPIException
The possible errors that can be raised are:
- KT-CT-7804: No fields present in the input for updating the APIException.
- KT-CT-7803: Received an invalid apiExceptionId.
- KT-CT-7809: Update results in no changes to API Exception.
- KT-CT-7805: Too many tags associated with this API Exception.
- KT-CT-7806: Cannot create duplicate tags for the same API exception.
- KT-CT-7801: Received an invalid operationsTeamId.
- KT-CT-7811: Received an invalid assignedUserId.
- KT-CT-7812: Support user is inactive.
- KT-CT-7814: Received an invalid accountNumber.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The updated APIException. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}UpdateAPIExceptionNote
The possible errors that can be raised are:
- KT-CT-7807: Received an invalid apiExceptionNoteId.
- KT-CT-7808: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The updates APIExceptionNote. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"apiException": APIExceptionType
}UpdateAccountBillingAddress
The possible errors that can be raised are:
- KT-CT-4145: Invalid address.
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The updated account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}UpdateAccountBillingEmail
Update the billing email for the input account number to the received email value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Account that was changed. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}UpdateAccountConsents
Update the consents for an account using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9018: Account not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Consents linked to this account. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consents": ConsentType
}UpdateAccountReference
Update a reference for a particular account and namespace.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}UpdateAccountUserCommsPreferencesMutationPayload
Update the account user comms preferences.
Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 373.49,
"emailFormat": "appear-put-yes-red-two",
"preferredHoldMusic": "prove-cut-suggest-phone-official",
"errors": [ErrorType],
"commsPreferences": AccountUserCommsPreferences,
"clientMutationId": "79590270"
}UpdateAccountUserConsents
Update the consents from an account user using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-1111: Unauthorized.
- KT-CT-5421: Account user not found.
- KT-CT-5422: Invalid data.
- KT-CT-1605: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
All the consents for an account user. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}Fields
| Name | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{
"givenName": "Lisa",
"familyName": "Cain",
"pronouns": "ten-interesting-keep-decide-particularly",
"mobile": "media-item-role-away-painting",
"email": "trouble-history-daughter-west-laugh",
"dateOfBirth": "1994-09-09",
"landline": "own-change-street-agree-arm",
"errors": [ErrorType],
"clientMutationId": "27276388"
}UpdateActivePurchase
The possible errors that can be raised are:
- KT-CT-8225: Received an invalid purchaseId.
- KT-CT-8226: The provided purchase is not active.
- KT-CT-8206: Invalid data.
- KT-CT-8227: Available grants could not be applied.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Goods purchase updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}UpdateAffiliateLink
Update an affiliate link of an existing sales agent.
The possible errors that can be raised are:
- KT-CT-7711: Invalid data.
- KT-CT-7713: Invalid data.
- KT-CT-7714: Invalid data.
- KT-CT-7715: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The updated affiliate link. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateLink": AffiliateLinkType
}UpdateAffiliateOrganisation
Update an affiliate organisation.
The possible errors that can be raised are:
- KT-CT-7717: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The updated affiliate organisation. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"affiliateOrganisation": AffiliateOrganisationType
}UpdateAgreementPeriod
Update the period of an agreement.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-1501: Agreement not found.
- KT-CT-1503: Agreement valid_to date must be later than valid_from date.
- KT-CT-1504: Account does not match with the agreement.
- KT-CT-1505: Unable to edit agreement.
- KT-CT-1506: Agreement period is not within the supply and property period.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Account responsible for the update agreement. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}UpdateAutoTopUpAmount
The possible errors that can be raised are:
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3953: The payment schedule is not a balance triggered schedule.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3822: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The new schedule created. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}UpdateCollectionProcessRecordToActive
Update the Collection Process Record from raised status to active
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11202: No External reference provided.
- KT-CT-11207: Unsupported external source for collection process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the collection process was successfully updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
}UpdateCollectionProcessRecordToActiveOutputType
Output for updating a Collection process Record to Active.
Fields
| Name | Description |
|---|---|
|
The number of the collection process record. |
|
The current status of the collection process record. |
Example
{
"number": "everything-music-matter-stuff-military",
"status": "PENDING"
}UpdateCollectionProcessRecordToComplete
Update the Collection Process Record from raised status to complete
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11203: No Completion reason provided.
- KT-CT-11204: No Completion details provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the collection process was successfully updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
}UpdateCollectionProcessRecordToCompleteOutputType
Output for updating a Collection process Record to Complete.
Fields
| Name | Description |
|---|---|
|
The number of the collection process record. |
|
The current status of the repayment request. |
Example
{
"number": "black-most-wonder-service-possible",
"status": "PENDING"
}UpdateCommsDeliveryPreference
Update the comms delivery preference for the input account number to the received commsDeliveryPreference value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4136: Cannot set comms preference to email when account has no email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}UpdateDCAProceeding
The possible errors that can be raised are:
- KT-CT-11610: unable to edit the debt collection proceeding.
- KT-CT-11604: Active debt collection proceeding does not exist for account.
- KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the update has been applied. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
}UpdateDocumentAccessibilityPreference
Update the document accessibility preference for the input account number to the received documentAccessibilityPreference value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Account that was changed. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}UpdateLeadAssignment
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}UpdateLeadDetails
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}UpdateLeadStage
The possible errors that can be raised are:
- KT-CT-8907: Lead not found.
- KT-CT-8914: Stage not found.
- KT-CT-8915: Stages are not in the same funnel.
- KT-CT-8916: Current stage mismatch.
- KT-CT-8917: Stage transition not allowed.
- KT-CT-8918: Stage precondition not met.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedLeadData": {"key": "value"}
}UpdateMessageTags
The possible errors that can be raised are:
- KT-CT-7611: The message was not found.
- KT-CT-7614: The Ink tag was not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Deprecated field. Deprecated The 'clientMutationId' field is deprecated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Confirmed tags. |
Example
{
"possibleErrors": [PossibleErrorType],
"tags": InkTag,
"clientMutationId": "30491433"
}UpdateMetadata
Update existing metadata on an object.
The possible errors that can be raised are:
- KT-CT-4323: Unauthorized.
- KT-CT-8413: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}UpdateNotesOnOpportunity
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The number of the opportunity. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "building-catch-speech-adult-guy"
}UpdateOnSiteJobsAppointment
The possible errors that can be raised are:
- KT-CT-13001: Appointment does not exist.
- KT-CT-13043: Cannot update appointment as it has terminal status.
- KT-CT-13044: Failed to update appointment slot.
- KT-CT-13018: Unable to record cancellation_category/cancellation_sub_category.
- KT-CT-13039: Cancellation fields require CANCELLED status.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The Appointment that was updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"onSiteJobsAppointment": OnSiteJobsAppointmentType
}UpdateOnSiteJobsRequest
The possible errors that can be raised are:
- KT-CT-13032: Request does not exist.
- KT-CT-13035: Request is inactive.
- KT-CT-13038: Invalid request status.
- KT-CT-13040: Agent not set on request.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_id when creating assets.
- KT-CT-13051: Supply point not found when creating assets.
- KT-CT-13052: Multiple supply points found when creating assets.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The updated request. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"onSiteJobsRequest": OnSiteJobsRequestType
}UpdateOpportunityAssignment
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8903: Unable to update opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedOpportunityData": {"key": "value"}
}UpdateOpportunityExtraDetails
The possible errors that can be raised are:
- KT-CT-8903: Unable to update opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
The opportunity's extra details to be added or updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"extraDetails": {"key": "value"}
}UpdateOpportunityStage
The possible errors that can be raised are:
- KT-CT-8903: Unable to update opportunity.
- KT-CT-8910: Received opportunity current stage is not valid.
- KT-CT-8914: Stage not found.
- KT-CT-8915: Stages are not in the same funnel.
- KT-CT-8916: Current stage mismatch.
- KT-CT-8917: Stage transition not allowed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Placeholder success message for now. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "plant-hundred-history-member-suddenly"
}UpdatePassword
Update user's password.
Note this is different from the ResetPassword mutation, which is used to reset a password when the user has forgotten it. This mutation is used to update the password when the user is already authenticated and wants to change their password.
Ideally, this mutation would simply receive a "new_password" and use the current password update usecase, but, until we're ready for a breaking change, we'll need to use the Django form to also validate the old password and two new passwords.
The possible errors that can be raised are:
- KT-CT-5460: Old password is invalid.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The currently authenticated user. This field requires the |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}UpdatePaymentSchedulePaymentAmount
The possible errors that can be raised are:
- KT-DE-3910: Invalid data.
- KT-DE-3915: Invalid data.
- KT-DE-3901: Failed while checking if the ledger has existing schedules and the amount can be updated.
- KT-DE-3917: Invalid data.
- KT-DE-3918: Invalid data.
- KT-DE-3916: Invalid data.
- KT-DE-3902: Updating the payment amount on the ledger failed.
- KT-DE-3912: Invalid data.
- KT-DE-3919: A payment schedule for a time-of-use tariff cannot be updated.
- KT-DE-3920: No active or pending agreement found.
- KT-CT-3923: Unauthorized.
- KT-CT-1145: Account/user details 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 payment schedule that is being updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentSchedule": PaymentScheduleType
}UpdatePaymentSchedulePaymentDay
The possible errors that can be raised are:
- KT-DE-3910: Invalid data.
- KT-DE-3913: Invalid data.
- KT-DE-3919: A payment schedule for a time-of-use tariff cannot be updated.
- KT-DE-3920: No active or pending agreement found.
- KT-DE-3922: Invalid data.
- KT-CT-3923: Unauthorized.
- KT-CT-1145: Account/user details 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 payment schedule that is being updated. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentSchedule": PaymentScheduleType
}UpdateProductPricesOutput
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
|
The rate group prices. |
Example
{
"prices": RateGroupPrices
}UpdateSiteworksRequest
The possible errors that can be raised are:
- KT-CT-4231: Unauthorized.
- KT-CT-4232: Status passed is not valid.
- KT-CT-4233: Request does not exist.
- KT-CT-4234: Terminated Request cannot be updated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The siteworks request after the update. |
Example
{
"possibleErrors": [PossibleErrorType],
"siteworksRequest": CoreSiteworksRequestType
}UpdateUserMutation
The possible errors that can be raised are:
- KT-CT-5413: Invalid data.
- KT-CT-5414: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}Fields
| Name | Description |
|---|---|
|
Present for completed dispatches, otherwise |
|
Present for planned dispatches, otherwise |
Example
{
"source": "both-important-able-prepare-some",
"location": "me-talk-good-short-usually"
}Fields
| Name | Description |
|---|---|
|
Energy in kWh (import has a negative value). |
|
This field has been replaced by Deprecated The 'deltaKwh' field is deprecated. |
|
The end time of the dispatch. |
|
This field has been replaced by Deprecated The 'endDt' field is deprecated. |
|
Override Field to add additional attributes and extend description with possible_errors |
|
The start time of the dispatch. |
|
This field has been replaced by Deprecated The 'startDt' field is deprecated. |
Example
{
"start": "2002-12-26T12:46:52.875718+00:00",
"end": "1973-10-25T22:50:02.315087+00:00",
"startDt": "with-fill-behavior-fish-that",
"endDt": "part-close-year-authority-he",
"deltaKwh": 31,
"delta": "1.0",
"meta": UpsideDispatchMetaType
}UserActionReason
A type that returns a user action that needs to be completed for the device to be successfully registered.
Fields
| Name | Description |
|---|---|
|
Description of the required user action. |
|
An optional uri that, if provided, can navigate the user to where they can resolve this required action. |
|
Reference key to the required user action. |
Example
{
"userAction": "seem-fast-offer-they-tend",
"description": "American-know-leader-artist-management",
"uri": "six-director-weight-north-just"
}UserActionRequired
A type that returns user actions that need to be completed for the device to be successfully registered
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
List of actions the user must resolve in order for the device to be registered. |
Example
{
"id": "59825470",
"userActions": [UserActionReason]
}UserInputRequired
A type that returns user inputs that need to be provided for the device to be successfully registered
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
A list of requested inputs for a user to provide in order for the onboarding journey to continue. |
Example
{
"id": "25930567",
"userInputs": [UserInputType]
}Fields
| Name | Description |
|---|---|
|
Human friendly description of the requested input. |
|
True if the requested user input is required. |
|
True if the submitted user input has been successfully validated. |
|
Identifier for the requested user input. |
|
The value that has been submitted for this input. Can be a string, integer, or boolean. |
Example
{
"key": "time-kid-board-leader-series",
"description": "tax-firm-race-beautiful-piece",
"value": "dark-cultural-old-part-pattern",
"isRequired": true,
"isValidated": true
}UserManagedPayment
Represents the preference of the user to pay himself, instead of get charged.
Fields
| Name | Description |
|---|---|
|
The start time of the payment preference. |
Example
{
"forPaymentsAfter": "home-issue-week-trade-happy"
}Fields
| Name | Description |
|---|---|
|
Override Field to add additional attributes and extend description with possible_errors |
|
Example
{
"vehicleId": "99063836",
"information": VehicleInformationType
}ValidateEmail
Validate whether a user's email is a valid email via the Kickbox API.
Fields
| Name | Description |
|---|---|
|
Whether the email is valid or not. |
Example
{
"isValid": true
}ValidateMfaDevice
Validate multi-factor authentication (MFA) devices for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1151: MFA device not found.
- KT-CT-1152: Invalid MFA token.
- KT-CT-1155: Enabled backup device is needed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Flag to indicate if the device has been verified, so it can be used for MFA. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}ValidatePhone
Validate whether a user's phone number is a valid phone number.
Fields
| Name | Description |
|---|---|
|
Whether the phone number is valid or not. |
Example
{
"isValid": true
}ValidityPeriod
Represents a validity period defined by specific start and end date times.
Fields
| Name | Description |
|---|---|
|
The end date and time of the period. Null indicates an open-ended period. |
|
The start date and time of the period. |
Example
{
"start": "2007-07-10T13:45:08.248473+00:00",
"end": "2017-12-29T23:46:51.782428+00:00"
}VariantProfile
Object representing a variant profile.
Fields
| Name | Description |
|---|---|
|
The characteristic values for the variant. |
|
The scheme labels for the variant. |
Example
{
"characteristicValues": {"key": "value"},
"schemeLabels": {"key": "value"}
}VaryContractTermsOutput
Output type for varying contract terms.
Fields
| Name | Description |
|---|---|
|
The contract with the varied terms. |
Example
{
"contract": Contract
}Fields
| Name | Description |
|---|---|
|
The maximum state of charge (soc) %, if available. |
|
The minimum state of charge (soc) %, if available. |
|
|
|
|
|
|
|
Example
{
"weekdayTargetTime": "state-wonder-front-successful-road",
"weekdayTargetSoc": 60,
"weekendTargetTime": "wish-participant-material-day-this",
"weekendTargetSoc": 48,
"minimumSocPercentage": 60,
"maximumSocPercentage": 70
}Fields
| Name | Description |
|---|---|
|
|
|
The (user chosen) display name of the vehicle, if available. |
|
The model name of the vehicle, if available (e.g. i3s 120). |
|
|
|
The year of the vehicle model, if available. |
Example
{
"vin": "make-ever-four-catch-budget",
"brand": "suddenly-look-term-year-wall",
"model": "mission-shake-pass-task-right",
"year": 32,
"displayName": "join-most-national-girl-just"
}Fields
| Name | Description |
|---|---|
|
Verification process status. |
|
Verification type. |
|
Customer with pending verification. |
Example
{
"userNumber": "participant-both-individual-almost-space",
"status": "stuff-project-lay-key-identify",
"type": "yourself-himself-strong-wrong-majority"
}VerifyCustomer
Verify a customer using the provided code and verification type.
The possible errors that can be raised are:
- KT-CT-4191: Error while verifying the customer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
The currently authenticated user. |
Example
{
"possibleErrors": [PossibleErrorType],
"user": AccountUserType
}VerifyEmail
The possible errors that can be raised are:
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Whether the email is verified. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"isVerified": true
}VerifyIdentity
The possible errors that can be raised are:
- KT-CT-1145: Account/user details do not match.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
An expiring token that can be used to request to update the user's email address. |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "relate-get-out-author-its"
}VoiceCampaignConnectionTypeConnection
Paginator of Voice Campaigns
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoiceCampaignConnectionTypeEdge,
"totalCount": 20,
"edgeCount": 14
}VoiceCampaignConnectionTypeEdge
A Relay edge containing a VoiceCampaignConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": VoiceCampaignType,
"cursor": "pressure-treatment-measure-avoid-letter"
}VoiceCampaignItemConnectionTypeConnection
Paginator of Campaign Items
Fields
| Name | Description |
|---|---|
|
Number of nodes in the edge. |
|
Contains the nodes in this connection. |
|
|
Pagination data for this connection. |
|
Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoiceCampaignItemConnectionTypeEdge,
"totalCount": 94,
"edgeCount": 4
}VoiceCampaignItemConnectionTypeEdge
A Relay edge containing a VoiceCampaignItemConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": VoiceCampaignItemType,
"cursor": "budget-fire-huge-weight-blood"
}Fields
| Name | Description |
|---|---|
|
The account ID associated with the item. If the phone number for the item is not set, the account ID will be used to determine the phone number to call. |
|
Together with |
|
Together with |
|
The ID of the campaign item. |
|
Metadata about the item. This enables items to be filtered based on additional information such as location. It is a dictionary of key-value pairs, with both keys and values being strings. |
|
The phone number of the campaign item. This is used to determine the phone number to call when the item is processed. If it is not set, the account ID will be used instead to call the phone number associated with the account. |
|
The status of the campaign item that determines what actions can be taken on it. |
Example
{
"id": "33571364",
"phoneNumber": "certain-support-professional-clear-center",
"status": "UNASSIGNED",
"callWindowStart": "2003-09-23T20:08:42.756235+00:00",
"callWindowEnd": "2014-07-23T15:02:38.802539+00:00",
"accountId": "18306404",
"metadata": {"key": "value"}
}Fields
| Name | Description |
|---|---|
|
The items that are part of the campaign. These are the items that contain information about what phone numbers or accounts to call while this campaign is active. |
|
The type of campaign, e.g. preview or predictive. |
|
If appropriate, a custom number to use as the caller id for calls from this campaign. |
|
Additional information to describe the purpose of the campaign. |
|
The ID of the campaign. |
|
The name of the campaign. This is used to identify the campaign in the system, and must be unique. |
|
Flag to indicate whether not to create a duplicate record when uploading campaign items that already exist for a given account number and/or phone number |
|
The status of the campaign. Indicates whether calls can be made for items in the campaign or not. |
|
The call tags that can be used within this campaign. |
Example
{
"id": "80133708",
"name": "keep-short-thousand-young-never",
"description": "vote-soldier-program-by-network",
"customOutboundPhoneNumber": "any-myself-test-administration-statement",
"tags": CallTagConnectionTypeConnection,
"status": "ACTIVE",
"campaignType": "PREVIEW",
"campaignItems": VoiceCampaignItemConnectionTypeConnection,
"preventDuplicateRecords": 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": VoucherPurchaseConnectionTypeEdge,
"totalCount": 69,
"edgeCount": 98
}VoucherPurchaseConnectionTypeEdge
A Relay edge containing a VoucherPurchaseConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination |
|
The item at the end of the edge |
Example
{
"node": VoucherPurchaseType,
"cursor": "value-keep-standard-remember-national"
}Fields
| Name | Description |
|---|---|
|
When the voucher becomes available to be redeemed. |
|
The current balance left in the voucher. |
|
The amount charged for the voucher. |
|
A balance transfer for the voucher charge, if any. |
|
Additional metadata from client sources stored against the voucher. This data is not structural and won't be relied on by Kraken internally. |
|
Display name for the voucher purchase. |
|
The purchase ID. |
|
The payment associated with the voucher purchase, if any. |
|
When the purchase was performed. |
|
Fetch the redemptions for this voucher. |
|
The value of the voucher in cents. |
Example
{
"id": "32971347",
"charge": AccountChargeType,
"chargeBalanceTransfer": AccountBalanceTransferType,
"payment": AccountPaymentType,
"displayName": "type-stage-upon-simply-ten",
"clientParams": {"key": "value"},
"purchasedAt": "1974-11-19T08:58:35.742684+00:00",
"voucherValue": 41,
"availableFrom": "2024-12-18",
"balance": 66,
"redemptions": [VoucherRedemptionType]
}Fields
| Name | Description |
|---|---|
|
When the redemption was claimed. |
|
The amount credited for the voucher redemption. |
|
The redemption ID. |
Example
{
"id": "77234167",
"credit": AccountCreditType,
"claimedAt": "2012-11-02T07:07:22.484236+00:00"
}Fields
| Name | Description |
|---|---|
|
The balance from vouchers that will be redeemable in future. |
|
The balance from vouchers that can be redeemable today. |
Example
{
"redeemableToday": 83,
"redeemableInFuture": 66
}WaitForLiveIntegration
Indicates a step where the integration is pending activation.
Progress to the next onboarding step is blocked until the integration becomes active.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
|
Returns |
Example
{
"id": "26281912",
"isLive": true
}WaitForTransition
A generic step that can be used to hold an onboarding wizard until the device has transitioned from one onboarding state to another.
Generally, this step should be completed via a KF AMI event handler after the device has been registered and transitioned to the desired state.
Fields
| Name | Description |
|---|---|
|
A unique identifier for this onboarding step. |
Example
{
"id": "10962702"
}Fields
| Name | Description |
|---|---|
|
Serial number. |
|
Meter point reference. |
|
The frequency of the reading. |
Example
{
"marketSupplyPointId": "81954807",
"deviceId": "36552674",
"readingFrequencyType": "RAW_INTERVAL"
}Fields
| Name | Description |
|---|---|
|
Whatsapp text message body. |
Example
{
"body": "energy-science-item-drop-day"
}WinterWorkoutPeriodType
Gas savings during the Winter Workout.
Fields
| Name | Description |
|---|---|
|
The actual gas consumption in kWh during this period. |
|
The actual gas savings ratio during this period. |
|
The expected gas consumption in kWh during this period. |
|
Specifies whether there was at least one meter reading submitted during this period. |
|
The last day (inclusive) of the period to which this summary data applies. |
|
The first day of the period to which this summary data applies. |
|
The planned gas savings ratio during this period. |
Example
{
"periodStart": "2014-08-29",
"periodEnd": "2019-06-09",
"hasSubmittedMeterReading": true,
"targetSavingsRatio": 684.45,
"actualSavingsRatio": 533.44,
"expectedConsumption": 986.51,
"actualConsumption": 636.32
}WinterWorkoutType
Weekly and total gas savings during the Winter Workout.
Fields
| Name | Description |
|---|---|
|
Gas savings over the entire Winter Workout period. |
|
Gas savings data for individual weeks during the Winter Workout. Weeks start on Monday and end on Sunday. |
Example
{
"weeks": WinterWorkoutPeriodType,
"total": WinterWorkoutPeriodType
}WithdrawDunning
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11301: Account not in a dunning process for the given path name.
- KT-CT-11302: No active dunning process found.
- KT-CT-11303: Multiple active dunning processes found.
- KT-CT-11306: Withdrawing the dunning process failed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Whether the dunning process was withdrawn successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"withdrawSuccessful": true
}Fields
| Name | Description |
|---|---|
|
The identifier of the work schedule (also known as the 'slug'). |
|
Whether the work schedule is currently open. |
|
Whether today is a public holiday, according to the work schedule. |
|
Name of the work schedule. |
|
The reason the Work Schedule is open or closed. |
Example
{
"identifier": "22318062",
"name": "sure-teacher-down-water-government",
"isOpen": true,
"isPublicHoliday": true,
"openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
}Authentication Server
Fields
| Name | Description |
|---|---|
|
The client ID of the application. |
|
The name of the application. |
Example
{
"name": "change-land-its-impact-per",
"clientId": "22430197"
}CreateMfaDevice
Create a multi-factor authentication (MFA) device for user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1153: Unable to create MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Email address to send the MFA code by default. |
|
Phone number to send the MFA code by default. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceEmail": "meet-authority-edge-couple-fish",
"devicePhone": "apply-analysis-simple-indicate-few",
"totpSecret": "former-yourself-his-pick-through"
}DeleteMfaDevice
Delete a multi-factor authentication (MFA) device for the authenticated user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1154: Unable to delete MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Flag to indicate if the MFA device has been successfully deleted. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}KrakenVersionType
Information about what version of Kraken is being executed by this service.
Fields
| Name | Description |
|---|---|
|
The git commit SHA that is being executed. |
|
The version number that is being executed. |
Example
{
"number": "central-themselves-appear-effect-ability",
"SHA": "walk-shake-all-reality-leave"
}Fields
| Name | Description |
|---|---|
|
The type of MFA device. |
|
Whether the MFA device is confirmed or not. |
Example
{
"deviceType": "win-strong-save-he-investment",
"isConfirmed": true
}PossibleError
Representation of a graphQL error.
Example
{
"code": "charge-popular-indeed-phone-market",
"type": "personal-because-when-pay-camera",
"message": "paper-car-participant-approach-walk",
"description": "although-news-appear-admit-address"
}PossibleErrorType
The GraphQL error type for displaying information about GraphQL errors that might be raised from the API.
Fields
| Name | Description |
|---|---|
|
The error code that might be returned from the query/mutation. |
|
The error description that might be returned from the query/mutation. |
|
The error message that might be returned from the query/mutation. |
|
The error type that might be returned from the query/mutation. |
Example
{
"message": "surface-smile-agent-parent-trip",
"code": "animal-fine-current-beautiful-think",
"type": "appear-tough-set-position-accept",
"description": "focus-because-budget-military-air"
}ValidateMfaDevice
Validate multi-factor authentication (MFA) devices for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1151: MFA device not found.
- KT-CT-1152: Invalid MFA token.
- KT-CT-1155: Enabled backup device is needed.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
|
Flag to indicate if the device has been verified, so it can be used for MFA. |
|
Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}